marketplace-sdk-reference

用途

本资料是 Sitecore Marketplace SDK（v0.4）的 API 参考指南，用于回答关于该 SDK 的 API 方法、类型、查询、变更和订阅等相关问题。它面向需要了解和使用 Sitecore Marketplace SDK 进行开发的用户。

回答方式

按照资料要求，回答问题时首先查阅提供的参考文件；若参考文件未覆盖，则使用 WebFetch 访问 https://developers.sitecore.com/marketplace/sdk 获取最新文档。回答中始终提供 TypeScript 代码示例，并始终指明 API 所属的包（client、xmc 或 ai）。

SDK 架构

SDK 包含三个包：

• @sitecore-marketplace-sdk/client（必需）：核心客户端，提供 ClientSDK、查询、变更、订阅和类型定义。完整 API 参考见 client-api.md。
• @sitecore-marketplace-sdk/xmc：XM Cloud API，涵盖 Sites、Pages、Authoring、Content Transfer、Search 和 Agent。完整 API 参考见 xmc-api.md。
• @sitecore-marketplace-sdk/ai：AI Skills API，用于 Brand Review。完整 API 参考见 ai-api.md。

常见用法

客户端初始化示例：

import { ClientSDK } from "@sitecore-marketplace-sdk/client";

const client = await ClientSDK.init({
  target: window.parent,
});

常见模式包括：

• 查询：返回 { data, unsubscribe? }

const { data } = await client.query("queryName", params);

• 变更：

const { data } = await client.mutate("mutationName", params);

• 订阅：使用 query() 并设置 subscribe: true

const { unsubscribe } = await client.query("queryName", {
  subscribe: true,
  onSuccess: (data) => console.log(data),
});
unsubscribe?.();

参考文件

• Client API —— 核心客户端的查询、变更、订阅和类型
• XM Cloud API —— XM Cloud API 参考
• AI API —— AI Skills API 参考

限制

资料未提供 SDK 的收费、价格、平台支持范围或具体使用效果等信息，相关内容暂未提供。