创建加载项
在 Microsoft Store 提交 API 中使用此方法,为注册到合作伙伴中心帐户的应用创建加载项(也称为应用内产品或 IAP)。
注意
此方法无需任何提交即可创建加载项。 若要创建加载项提交,请参阅管理加载项提交中的方法。
必备条件
若要使用此方法,首先需要执行以下操作:
- 如果尚未开始操作,请先完成 Microsoft Store 提交 API 的所有先决条件。
- 获取 Azure AD 访问令牌,以供在此方法的请求标头中使用。 获取访问令牌后,在它到期前,你有 60 分钟的使用时间。 该令牌到期后,可以获取新的令牌。
请求
此方法具有以下语法。 请参阅以下部分,获取标头和请求正文的使用示例和描述。
方法 | 请求 URI |
---|---|
POST | https://manage.devcenter.microsoft.com/v1.0/my/inappproducts |
请求头
标头 | 类型 | 说明 |
---|---|---|
授权 | 字符串 | 必需。 Azure AD 访问令牌的格式为 Bearer<token>。 |
请求正文
请求正文具有以下参数。
参数 | 类型 | 描述 | 必须 |
---|---|---|---|
applicationIds | array | 包含应用(与此加载项相关联)的应用商店 ID 的数组。 只有一个项在此数组中受支持。 | 是 |
productId | string | 加载项的产品 ID。 这是一个标识符,可在代码中用于引用加载项。 有关详细信息,请参阅设置你的产品类型和产品 ID。 | 是 |
productType | string | 加载项的产品类型。 支持以下值:Durable 和 Consumable。 | 是 |
请求示例
以下示例演示了如何为应用创建新易耗型加载项。
POST https://manage.devcenter.microsoft.com/v1.0/my/inappproducts HTTP/1.1
Authorization: Bearer eyJ0eXAiOiJKV1Q...
Content-Type: application/json
{
"applicationIds": [ "9NBLGGH4R315" ],
"productId": "my-new-add-on",
"productType": "Consumable",
}
响应
以下示例演示了成功调用此方法的 JSON 响应正文。 有关响应正文中这些值的更多详细信息,请参阅加载项资源。
{
"applications": {
"value": [
{
"id": "9NBLGGH4R315",
"resourceLocation": "applications/9NBLGGH4R315"
}
],
"totalCount": 1
},
"id": "9NBLGGH4TNMP",
"productId": "my-new-add-on",
"productType": "Consumable",
}
错误代码
如果无法成功完成请求,该响应中会包含以下 HTTP 错误代码之一。
错误代码 | 说明 |
---|---|
400 | 请求无效。 |
409 | 由于加载项的当前状态,或者加载项使用的合作伙伴中心功能当前不受 Microsoft Store 提交 API 支持,所以无法创建加载项。 |