将可消费产品报告为已完成。

  • 项目

使用 Microsoft Store 收集 API 中的此方法，以面向给定客户将可消费产品报告为已完成。 在用户可以重新购买可消费产品前，你的应用或服务必须面向该用户将可消费产品报告为已完成。

若要使用此方法来将可消费产品报告为已完成，可采用以下两种方式：

  • 提供消费品的项目 ID（如查询产品的 itemId 参数中返回所示）和你提供的唯一跟踪 ID。 如果将同一跟踪 ID 用于多次尝试，那么即使该项目已经使用过，也仍然会返回相同的结果。 如果你不确定消耗请求是否成功，你的服务应重新提交具有同一跟踪 ID 的消耗请求。 跟踪 ID 始终与该消耗请求关联并且可以无限期地重新提交。
  • 提供产品 ID（如查询产品的 productId 参数中返回所示）和从以下请求正文部分中的 transactionId 参数的描述中所列的源之一获取的事务 ID。

Microsoft.StoreServices 库通过 StoreServicesClient.CollectionsConsumeAsync API 提供此方法的功能。

先决条件

若要使用此方法，你需要：

  • 受众 URI 值为 https://onestore.microsoft.com 的 Azure AD 访问令牌。
  • 表示你要为其将可消费产品报告为已完成的用户身份的 Microsoft Store ID 密钥。

有关详细信息，请参阅管理来自服务的产品授权。

请求

请求语法

方法 请求 URI
POST https://collections.mp.microsoft.com/v6.0/collections/consume

请求头

标头 类型 说明
授权 字符串 必需。 Azure AD 访问令牌的格式为 Bearertoken<>。
主机 string 必须设置为值 collections.mp.microsoft.com。
Content-Length 数值 请求正文的长度。
Content-Type 字符串 指定请求和响应类型。 当前，唯一受支持的值为 application/json。

请求正文

参数 类型 说明 必须
受益人 UserIdentity 正在使用此项目的用户。 有关详细信息，请参阅下表。 是
itemId string 查询产品返回的 itemId 值。 将此参数与 trackingId 一起使用 否
trackingId guid 由开发人员提供的唯一跟踪 ID。 将此参数与 itemId 一起使用。 否
productId string 查询产品返回的 productId 值。 将此参数与 transactionId 一起使用 否
transactionId guid 从以下源之一获取的事务 ID 值。 将此参数与 productId 一起使用。 否

UserIdentity 对象包含以下参数。

参数 类型 说明 必须
IdentityType string 指定字符串值 b2b。 是
identityValue string 表示你要为其将可消费产品报告为已完成的用户身份的 Microsoft Store ID 密钥。 是
localTicketReference string 已返回响应的请求标识符。 建议你使用与 Microsoft Store ID 密钥中的 userIdclaim 相同的值。 是

请求示例

以下示例使用 itemId 和 trackingId。

POST https://collections.mp.microsoft.com/v6.0/collections/consume HTTP/1.1
Authorization: Bearer eyJ0eXAiOiJKV1…..
Host: collections.mp.microsoft.com
Content-Length: 2050
Content-Type: application/json

{
    "beneficiary": {
        "localTicketReference": "testreference",
        "identityValue": "eyJ0eXAiOi…..",
        "identityType": "b2b"
    },
    "itemId": "44c26106-4979-457b-af34-609ae97a084f",
    "trackingId": "44db79ca-e31d-49e9-8896-fa5c7f892b40"
}

以下示例使用 productId 和 transactionId。

POST https://collections.mp.microsoft.com/v6.0/collections/consume HTTP/1.1
Authorization: Bearer eyJ0eXAiOiJKV1……
Content-Length: 1880
Content-Type: application/json
Host: collections.md.mp.microsoft.com

{
    "beneficiary" : {
        "localTicketReference" : "testReference",
        "identityValue" : "eyJ0eXAiOiJ…..",
        "identitytype" : "b2b"
    },
    "productId" : "9NBLGGH5WVP6",
    "transactionId" : "08a14c7c-1892-49fc-9135-190ca4f10490"
}

响应

如果已成功执行消耗，将不返回任何内容。

响应示例

HTTP/1.1 204 No Content
Content-Length: 0
MS-CorrelationId: 386f733d-bc66-4bf9-9b6f-a1ad417f97f0
MS-RequestId: e488cd0a-9fb6-4c2c-bb77-e5100d3c15b1
MS-CV: 5.1
MS-ServerId: 030011326
Date: Tue, 22 Sep 2015 20:40:55 GMT

错误代码

代码 错误 内部错误代码 说明
401 未授权 AuthenticationTokenInvalid Azure AD 访问令牌无效。 在某些情况下，ServiceError 的详细信息包含更多信息，例如令牌到期或 appid 声明丢失的时间。
401 未授权 PartnerAadTicketRequired 在授权标头中，Azure AD 访问令牌不会 传递到服务。
401 未授权 InconsistentClientId 请求正文的 Microsoft Store ID 密钥中的 clientId 声明与授权标头的 Azure AD 访问令牌中的 appid 声明不匹配。