通过

目录资源

  • 项目

目录资源允许管理 Microsoft 商家中心商店中的目录 (MMC) 。 有关使用目录资源的信息，请参阅 管理目录。 有关演示如何添加、删除和获取目录的示例，请参阅 代码示例。

基 URI

下面是将模板追加到的基 URI。

https://content.api.bingads.microsoft.com/shopping/v9.1/bmc/

模板

若要创建用于管理目录的终结点，请将相应的模板追加到基 URI。

模板 HTTP 谓词 说明 资源
{mmcMerchantId}/catalogs POST 使用 将目录添加到存储区。 若要添加目录，其名称必须唯一。 最多可以向一个商店添加 100 个目录。

设置为 {mmcMerchantId} MMC 存储 ID。		 请求： 目录
响应： 目录
{mmcMerchantId}/catalogs/{catalogId} PUT 使用 更新存储中的目录。 可以更新的唯一字段是 name 和 isPublishingEnabled 字段，必须同时指定这两个字段。

设置为 {mmcMerchantId} MMC 存储 ID。		 请求： 目录
响应： 目录
{mmcMerchantId}/catalogs/{catalogId} DELETE 使用 从存储区中删除目录。

设置为 {mmcMerchantId} MMC 存储 ID。

设置为 {catalogId} 目录的 ID。		 请求：不适用
响应：不适用
{mmcMerchantId}/catalogs/{catalogId} GET 使用 从存储中获取目录。

设置为 {mmcMerchantId} MMC 存储 ID。

设置为 {catalogId} 目录的 ID。		 请求：不适用
响应： 目录
{mmcMerchantId}/catalogs GET 使用 从存储中获取目录列表。

设置为 {mmcMerchantId} MMC 存储 ID。		 请求：不适用
响应： 目录

查询参数

终结点可能包括以下查询参数。

参数 说明
alt 可选。 使用 指定请求和响应中使用的内容类型。 可能的值为 json 和 xml。 默认值为 json。

标题

下面是请求和响应标头。

头 说明
AuthenticationToken 请求标头。

将此标头设置为 OAuth 身份验证令牌。 有关获取令牌的信息，请参阅 对凭据进行身份验证。
Content-Location 响应标头。

标识目录插入到的存储的 URL。 此标头包含在 Insert 请求的响应中。
CustomerAccountId 请求标头。

代表标头中指定的客户管理的任何帐户的帐户 CustomerId ID。 指定哪个帐户并不重要。 仅当代表客户管理帐户时，才指定此标头。
CustomerId 请求标头。

你管理的商店的客户的客户 ID。 仅当代表客户管理应用商店时，才指定此标头。 如果设置此标头，还必须设置 CustomerAccountId 标头。
DeveloperToken 请求标头。

客户端应用程序的开发人员访问令牌。 每个请求都必须包含此标头。 有关获取令牌的信息，请参阅 是否有 Microsoft Advertising 凭据和开发人员令牌？
位置 响应标头。

标识目录插入到的存储的 URL。 此标头包含在 Insert 请求的响应中。
WebRequestActivityId 响应标头。

包含有关请求的详细信息的日志条目的 ID。 如果发生错误，应始终捕获此 ID。 如果无法确定和解决问题，请包含此 ID 以及你向支持团队提供的其他信息。

请求和响应对象

下面是 API 使用的请求和响应对象。

每个 对象定义使用的 JSON 键名称和 XML 元素名称，具体取决于为请求指定的内容类型。

Object 说明
目录 定义目录。
目录 定义目录列表。

目录

定义目录。

名称 值 类型 XML 元素名称
Id 唯一标识存储区中的目录的 ID。

此字段是只读的;不要设置此字段。		 无符号 Long <Id>
isDefault 一个布尔值，该值确定目录是否为应用商店的默认目录。 如果目录是应用商店的默认目录，则为 true ;否则为 false。

创建商店时，如果未指定其他目录，则会获取产品写入到的默认目录。

此字段是只读的;不要设置此字段。		 布尔值 <is_default>
isPublishingEnabled 一个布尔值，确定 Microsoft 是否可以从目录中发布产品。 如果 Microsoft 可能从目录中发布产品，则设置为 true ;否则，将其设置为 false。

可以更新此字段。

在将应用程序部署到生产环境之前，还可以使用此字段对其进行测试。 通过将此字段设置为 false，可以进行 产品资源 调用，而无需更改或发布生产数据。		 布尔值 <is_publishing_enabled>
市场 目录中产品发布到的市场。

注意： 还不是每个人都有此功能。 如果你没有，别担心 ，它即将推出！

以下是可以指定的可能市场。
  • 阿尔巴尼亚、阿尔巴尼亚 (sq-AL)
  • 圭亚那，法国 (fr-AD)
  • 阿根廷、西班牙语 (es-AR)
  • Aruba、英语 (en-AW)
  • 澳大利亚、英语 (en-AU)
  • 奥地利，德国 (de-AT)
  • 巴哈马、英语 (en-BS)
  • 孟加拉国、英语 (en-BD)
  • 比利时、荷兰语 (nl-BE)
  • 比利时、法语 (fr-BE)
  • 玻利维亚、西班牙语 (es-BO)
  • 波斯尼亚-黑塞哥维那，波斯尼亚 (bs-BA)
  • 巴西、葡萄牙语 (pt-BR)
  • 文莱、英语 (en-BN)
  • 保加利亚、保加利亚 (bg-BG)
  • 加拿大、英语 (en-CA)
  • 加拿大、法国 (fr-CA)
  • 开曼群岛，英语 (en-KY)
  • 智利、西班牙语 (es-CL)
  • 哥伦比亚、西班牙语 (es-CO)
  • 哥斯达黎加、西班牙语 (es-CR)
  • 克罗地亚、克罗地亚 (hr-HR)
  • 塞浦路斯，英语 (en-CY)
  • 塞浦路斯，希腊语 (el-CY)
  • 捷克共和国、捷克 (cs-CZ)
  • 丹麦、丹麦 (da-DK)
  • 多米尼加，英语 (en-DM)
  • 多米尼加共和国、西班牙语 (es-DO)
  • 厄瓜多尔、西班牙语 (es-EC)
  • 萨尔瓦多，西班牙语 (es-SV)
  • 爱沙尼亚、爱沙尼亚 (et-EE)
  • 斐济、英语 (en-FJ)
  • 芬兰、芬兰 (fi-FI)
  • 法国、英语 (en-FR)
  • 法国、法国 (fr-FR)
  • 法属圭亚那，法国 (fr-GF)
  • 法属波利尼西亚、法国 (fr-PF)
  • 德国、英语 (en-DE)
  • 德国，德国 (de-DE)
  • 希腊、英语 (en-GR)
  • 希腊、希腊 (el-GR)
  • 关岛，英语 (en-GU)
  • 危地马拉，西班牙语 (es-GT)
  • 圭亚那、英语 (en-GY)
  • 海地，法国 (fr-HT)
  • 洪都拉斯，西班牙语 (es-HN)
  • 香港特别行政区，繁体中文 (zh-HK)
  • 匈牙利、英语 (en-HU)
  • 匈牙利、匈牙利 (胡)
  • 冰岛、冰岛 (is-IS)
  • 印度、英语 (en-IN)
  • 印度尼西亚、英语 (en-ID)
  • 爱尔兰、英语 (en-IE)
  • 意大利、英语 (en-IT)
  • 意大利、意大利 (it-IT)
  • 日本、日本 (ja-JP)
  • 拉脱维亚，拉脱维亚 (lv-LV)
  • 列支敦斯登，德国 (de-LI)
  • 立陶宛、立陶宛 (lt-LT)
  • 卢森堡，法国 (fr-LU)
  • 卢森堡，德国 (de-LU)
  • 马来西亚、英语 (en-MY)
  • 马尔代夫，英语 (en-MV)
  • 马耳他、马耳他 (mt-MT)
  • 马提尼克，法国 (fr-MQ)
  • 墨西哥、西班牙语 (es-MX)
  • 摩纳哥，法国 (fr-MC)
  • 蒙古语、英语 (en-MN)
  • 黑山、英语 (en-ME)
  • 黑山，塞尔维亚 (sr-ME)
  • 蒙特塞拉特，英语 (en-MS)
  • 尼泊尔、英语 (en-NP)
  • 荷兰、荷兰 (nl-NL)
  • 荷兰、英语 (el-NL)
  • 新喀里多尼亚，法国 (fr-NC)
  • 新西兰、英语 (en-NZ)
  • 北马其顿、马其顿 (mk-MK)
  • 挪威、挪威 (nb-NO)
  • 巴拿马，西班牙语 (es-PA)
  • 巴布亚新几内亚、英语 (en-PG)
  • 巴拉圭、西班牙语 (es-PY)
  • 秘鲁、西班牙语 (es-PE)
  • 菲利普内斯，英语 (en-PH)
  • 波兰、波兰 (pl-PL)
  • 葡萄牙、葡萄牙语 (pt-PT)
  • 波多黎各、西班牙语 (es-PR)
  • 罗马尼亚、罗马尼亚 (ro-RO)
  • 圣马力诺，英语 (en-SM)
  • 圣马力诺，意大利 (it-SM)
  • 塞尔维亚、英语 (en-RS)
  • 塞尔维亚、塞尔维亚 (sr-RS)
  • 新加坡、英语 (en-SG)
  • 斯洛伐克、英语 (en-SK)
  • 斯洛伐克、斯洛伐克 (sk-SK)
  • 斯洛文尼亚、斯洛文尼亚 (sl-SI)
  • 南非、英语 (en-ZA)
  • 西班牙、英语 (en-ES)
  • 西班牙、西班牙语 (es-ES)
  • 斯里兰卡、英语 (en-LK)
  • 瑞典、英语 (en-SE)
  • 瑞典、瑞典 (sv-SE)
  • 瑞士、德国 (de-CH)
  • 瑞士、法国 (fr-CH)
  • 台湾，繁体中文 (zh-TW)
  • 泰国、英语 (en-TH)
  • 特立尼达和多巴哥，英语 (en-TT)
  • Türkiye，土耳其语 (tr-TR)
  • 英国、英语 (en-GB)
  • 美国、英语 (en-US)
  • 美国、西班牙语 (es-US)
  • 乌拉圭、西班牙语 (es-UY)
  • 梵蒂冈城，意大利 (它-VA)
  • 委内瑞拉、西班牙语 (es-VE)
  • 越南、英语 (en-VN)
添加到目录的所有产品必须指定相同的市场 (查看 contentLanguage 和 targetCountry) 。

将目录添加到存储区后，不能更新此字段。

在上面的列表中，de-DE 是指定的市场值;不要在市场字符串中包含 (德国) 。		 String <市场>
名字 目录的名称。 名称最多可以包含 70 个字符。

可以更新此字段。		 String <名字>

目录

定义目录列表。

名称 值 类型 XML 元素名称
目录 存储中的目录列表。 Catalog[] <目录>

HTTP 状态代码

请求可能会返回以下 HTTP 状态代码。

状态代码 说明
200 成功。
201 已成功添加目录。
204 已成功删除目录。
400 错误请求。 查询参数值无效或请求正文中的某些内容无效。
401 未经授权。 用户的凭据无效。
404 未找到。
500 服务器错误。