通过

ProductStatuses 资源

  • 项目

注意

Microsoft Store 资源仅对封闭 Beta 版参与者可用。 有关参与封闭 beta 或开放 beta 计划的信息，请联系你的客户经理。

在 beta 版期间，所有 Store 编程元素和文档都可能会更改。

使用 ProductStatuses 资源获取商店中产品/服务的状态。

基 URI

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

https://content.api.ads.microsoft.com/v9.1/bmc

例如，若要获取商店中产品/服务状态的摘要视图，请使用以下终结点：

https://content.api.ads.microsoft.com/v9.1/bmc/stores/{merchantId}/productstatusessummary

模板

这些是追加到 基 URI 以创建 HTTP 终结点的模板。

/stores/{merchantId}/productstatusessummary

HTTP 谓词 说明 资源
获取 获取商店中产品/服务状态的摘要视图。 该服务返回应用商店中已批准、已批准和过期的产品/服务的数量。 将 设置为 {merchantId} 要从中获取状态的存储的 ID。

从产品/服务的状态更改到在摘要视图中反映的时间，最多可能需要两个小时。		 请求：不适用
响应： ProductStatusesSummary

/stores/{merchantId}/productstatuses

HTTP 谓词 说明 资源
获取 获取商店中产品/服务状态的详细信息视图。 仅针对状态为“已批准”或“警告”的产品返回详细信息。 设置为 {merchantId} 要从中获取状态的存储的 ID。

max-results 查询参数确定服务返回的产品/服务数。 若要分页查看所有产品/服务，请使用 继续标记 查询参数。		 请求：不适用
响应： ProductStatuses

查询参数

请求可能包括以下查询参数：

参数 说明
max-results 可选。 使用 指定要在列表请求中返回的最大项数，例如 /stores/{merchantId}/productstatuses。 可以指定的最大值为 250。 默认值为 25。
continuation-token 可选。 使用 分页浏览商店的产品状态列表。 令牌标识要返回的产品状态的下一页。 不要在第一个 List 请求中指定此参数。 如果存储区包含的产品数超过请求的数量， (看到 max-results 查询参数) ，则响应将包括 nextPageToken 字段。 在下一个请求中，将 继续标记 设置为 中的 nextPageToken标记值。

标题

下面是请求和响应标头。

头 说明
AuthenticationToken 请求标头。

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

所有 POST 请求都必须指定此标头，并且必须将其设置为 application/json。
CustomerAccountId 请求标头。

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

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

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

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

请求和响应对象

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

Object 说明
错误 定义错误。
ErrorResponse 定义顶级错误对象。
ProductStatus 定义产品/服务的状态。
ProductStatuses 定义有问题的产品/服务的列表。
ProductStatusesSummary 定义商店中产品/服务状态的摘要视图。
ProductStatusItemLevelIssue 定义产品/服务的问题。

错误

定义错误。

名称 值 类型
code 请求失败的原因。 String
消息 错误说明。 String

ErrorResponse

定义顶级错误对象。

名称 值 类型
错误 处理请求时发生的错误的列表。 Error[]

ProductStatus

定义产品/服务的状态。

名称 值 类型
creationDate 产品/服务的创建日期和时间。 日期时间
expirationDate 产品/服务设置为过期的日期和时间。 日期时间
itemLevelIssues 产品/服务的问题列表。 ProductStatusItemLevelIssue[]
lastUpdateDate 上次更新产品/服务的日期和时间。 日期时间
productId 产品的 ID。 String
status 产品的批准状态。 可能的值是：
  • 反对
  • 警告
不提供未批准的产品。 警告指示产品存在你应该解决的问题，但它们不会阻止产品/服务提供。 应修复问题并重新提交产品/服务。		 String
title 产品标题 String

ProductStatuses

定义有问题的产品/服务的列表。

名称 值 类型
nextPageToken 如果有更多产品/服务可供获取，则用于将 延续令牌 查询参数设置为 的令牌。 String
resources 有问题的产品/服务列表。 max-results 查询参数确定列表中产品/服务的最大数量;返回的实际数字可能更少。 ProductStatus[]

ProductStatusesSummary

定义商店中产品/服务状态的摘要视图。 如果存储刚刚创建，则所有值都将为零。

名称 值 类型
批准 商店中已批准的产品总数。 整数
反对 商店中因错误而被拒批的产品总数。 整数
到期 商店中在未来 72 小时内过期的产品总数。 整数
merchantId 产品所位于的商店的 ID。 无符号 long
等待 待审核的产品总数。 整数

ProductStatusItemLevelIssue

定义产品/服务的问题。

名称 值 类型
attributeName 导致问题的产品/服务属性的名称。 并非所有问题都标识属性。 例如，如果问题由多个属性引起，则 对象不包含此字段。 String
code 标识问题的错误代码。 例如，TitleTooLongErr。 String
说明 说明 属性的问题。 String
servability 一个 值，该值指示问题是否阻止产品/服务提供服务。 可能的值是：
  • 反对
  • 不受影响
如果已取消批准，则产品/服务将不提供服务。		 String

HTTP 状态代码

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

状态代码 说明
200 成功。
400 错误请求。 很可能请求指定无效的查询参数或参数值。
401 未经授权。 用户的凭据无效。
404 未找到。 找不到请求的存储。
500 服务器错误。

错误代码

请求可能会返回以下错误代码。

错误代码 说明
ContinuationTokenInvalidErr 继续标记查询参数值无效。 请确保使用 ProductStatuses 对象的 nextPageToken 字段中的值设置 参数。