获取产品/服务矩阵
本文介绍如何获取给定月份的产品/服务矩阵。 产品/服务矩阵包括产品和 SKU 的属性和购买规则。 此方法支持按月获取历史记录的筛选器。
先决条件
- Partner API authentication(合作伙伴 API 身份验证)中所述的凭据。 此方案仅支持应用程序用户身份验证。 尚不支持仅应用程序。 遇到 http 错误:400 的 合作伙伴应参阅合作伙伴 API 身份验证 文档。
- 此 API 目前仅支持合作伙伴必须处于以下角色之一的用户访问权限:管理员代理或销售代理。
详细信息
- 当前仅返回基于更新的新商业许可证产品的数据。
- 当前定价包括截至调用 API 的日期的当前月份提供的产品。 之前的月份包括所选月份的最后一天的日期。
- 此方法以文件流的形式返回数据。 文件流是.csv文件或 zip 压缩版本的.csv。 有关如何请求压缩文件的详细信息,请参阅以下内容。
REST 请求
请求语法
方法 | 请求 URI |
---|---|
GET | https://api.partner.microsoft.com/v1.0/sales/offermatrix(Month='{date}')/$value |
URI 筛选器参数
使用以下筛选器参数。
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
Month | string | 否 | 必须遵循 YYYYMM 才能请求价目表。 |
请求标头
- 有关详细信息,请参阅 Partner REST headers(合作伙伴 REST 标头)。
除了这些标头,还可以将定价文件检索为压缩的带宽和下载时间。 默认情况下,不会压缩文件。 若要获取文件的压缩版本,可以包括以下标头值。 意识到压缩工作表仅在 2020 年 4 月起可用,2020 年 4 月之前的所有工作表仅可用,因为未压缩。
头文件 | 值类型 | 值 | 说明 |
---|---|---|---|
Accept-Encoding | string | deflate | 可选。 如果省略,则不会压缩文件流。 |
请求示例
GET https://api.partner.microsoft.com/v1.0/sales/offermatrix(Month='202101')/$value HTTP/1.1
Authorization: Bearer
Accept-Encoding: deflate
Host: api.partner.microsoft.com
REST 响应
如果成功,此方法将产品/服务矩阵作为文件流返回。 文件流是.csv文件或 zip 压缩版本的.csv。
响应的成功和错误代码
每个响应都带有一个 HTTP 状态代码,用于指示成功或失败以及其他调试信息。 请使用网络跟踪工具来读取此代码、错误类型和其他参数。 有关完整列表,请参阅错误代码。
响应示例
HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 42180180
Content-Type: application/octet-stream
Content-Disposition: attachment; filename=updatedoffice.csv
Request-ID: 9f8bed52-e4df-4d0c-9ca6-929a187b0731
Date: Wed, 02 Feb 2021 03:41:20 GMT
"ProductTitle","ProductId","SkuId","SkuTitle","ProvisioningId","ProvisioningString","MinLicenses","MaxLicenses","AssetOwnershipLimit","AssetOwnershipLimitType","ProductSkuPreRequisites","ProductSkuConversion","Description","AllowedCountries"
"Microsoft 365 Business Basic","CFQ7TTC0LH18","0001","Microsoft 365 Business Basic","3b555118-da6a-4418-894f-7df1e2096870","O365_BUSINESS_ESSENTIALS","1","300","2","ConcurrentCount","","CFQ7TTC0LDPB/0001,CFQ7TTC0LF8Q/0001","Best for businesses that need professional...","AD;AE;AF;AG;AI;AL;AM;AO..."
======= Truncated ==============