状态资源

项目
11/13/2024

通过“状态”资源，可以获取已上传到指定目录的产品/服务的状态。将产品/服务上传到目录后，它们将经历验证和编辑评审过程。此过程最多可能需要 36 小时。只有在完成评审过程后，产品/服务才会包含在报告中。

有关该过程工作原理的概述，请参阅如何获取产品/服务的状态？

有关演示如何获取目录状态和下载报表的代码示例，请参阅下载目录状态报告。

基 URI

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

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

模板

若要创建用于获取目录中产品/服务状态的终结点，请将相应的模板追加到基 URI。

注意

{bmcMerchantId}/catalogs/{catalogId}/status 已弃用，我们不建议使用它。

模板	HTTP 谓词	说明	资源
`{bmcMerchantId}/catalogs/{catalogId}/status`	GET	使用获取通过或失败验证和编辑评审的上传产品/服务的数量。设置为 `{bmcMerchantId}` MMC 存储 ID。设置为 `{catalogId}` 目录的 ID。	请求：不适用响应：状态

查询参数

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

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

标题

下面是请求和响应标头。

头	说明
接受	请求标头。<p>下载报表时包含此标头。必须将此标头设置为 `application/x-zip-compressed`。
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 名称为 <catalogStatus>。

名称	值	类型	XML 元素名称
catalogId	要报告的目录的 ID。	ulong	<catalog_id>
publishedCount	通过验证和编辑评审的产品/服务的数量。	ulong	<published_count>
rejectedCount	验证和编辑评审失败的产品/服务的数量。此计数指示报表正文中的行数， (请参阅报表格式) 。	ulong	<rejected_count>
rejectionReportUrl	用于下载报表的 URL。仅当大于零时 `rejectedCount` ，对象才包括此字段。报表已压缩，必须先解压缩，然后才能阅读。	string	<catalog_id>

HTTP 状态代码

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

状态代码	说明
200	成功。
400	错误请求。查询参数值无效，或者报表 URL (看到拒绝ReportUrl) 不再有效。
401	未经授权。用户的凭据无效。
404	未找到。状态对于指定的目录不可用，或者目录或商店 ID 无效。
500	服务器错误。

报表格式

下载的报告文件包含在 Zip 压缩文件夹中， (*.zip) 。必须先解压缩文件夹及其内容，然后才能读取报表。报表是一个名为 MerchantCatalogReport.csv 的逗号分隔文件。

报表分为标题部分和报表正文部分。第一行包含以下标题节的列名称。

列名称	说明
目录名称	目录的名称。
目录 ID	目录的 ID。
应用商店 ID	包含目录的存储的 ID。
上传时间	请勿使用。如果存在此字段，请忽略它。

第二行包含标头数据。

第三行为空。

第四行包含以下报表正文的列名称，从第五行开始。

列名称	说明
项目 ID	未通过验证或编辑评审的产品/服务的 offerId 。报表将包含唯一 ID。
邮件	报告的错误。
类型	错误的类型。可能的值为 Error 或 Warning。
值	如果错误是由无效值引起的，则导致错误的数据值。
产品/服务代码片段	产品/服务数据子集的分号分隔列表。格式为 title;productType;链接;imageLink;price;salePrice;saleStartDate;saleEndDate。并非所有错误都将包括所有组件。

有关报表的示例，请参阅示例报表。

通过