获取价目表
适用于：
- 合作伙伴 API
本文介绍如何获取给定市场和视图的价目表。 此方法支持按月获取历史记录的筛选器。
必备条件
- Partner API authentication（合作伙伴 API 身份验证）中所述的凭据。 此方案仅支持应用程序用户身份验证。 尚不支持仅应用程序。 遇到 http 错误：400 的合作伙伴应参阅 合作伙伴 API 身份验证 文档。
- 此 API 目前仅支持合作伙伴必须处于以下角色之一的用户访问权限：全局管理员、管理员代理或销售代理。
详细信息
- 当前仅返回 Azure 计划消耗和预留的数据，基于许可的 (新的商业体验) 和市场产品。
- 当前 定价 包括当前月份提供的所有计量和产品，截至调用 API 的日期。 以前的月份包括给定月份可用的所有计量和产品。
- 消费计量价格仅以美元为单位，合作伙伴将使用外汇汇率 API 来计算本地货币成本。
- 消耗计量价格估计为零售价格。 合作伙伴折扣可通过 合作伙伴赚取的信用额度获得。
- 预留计量价格包括云解决方案提供商合作伙伴折扣。 可在可从合作伙伴中心“定价和产品/服务”页面下载的预留共享服务中找到预留的估计零售价格。
- 有关 Azure 计划定价的详细信息，请参阅 Azure 计划定价文档。
- 合作伙伴定价和外汇汇率 API 不属于 合作伙伴中心 SDK。
- 此方法将价目表作为文件流返回。 文件流是.csv文件或 zip 压缩版本的.csv。 下面提供了有关如何请求压缩文件的详细信息。
REST 请求
请求语法
| 方法 | 请求 URI |
|---|---|
| GET | https://api.partner.microsoft.com/v1.0/sales/pricesheets(Market=“{market}”，PricesheetView='{view}') /$value |
URI 所需的参数
使用以下路径参数请求所需市场和价目表类型。
| 名称 | 类型 | 必须 | 说明 |
|---|---|---|---|
| 市场 | 字符串 | 是 | 请求市场的两个字母国家/地区代码 |
| PricesheetView | 字符串 | 是 | 要请求的价目表类型，可以是azure_consumption、azure_reservations、updatedlicensebased、市场或软件。 |
注意
updatedlicensebased PriceSheetView 目前仅适用于属于 M365/D365 新商业体验技术预览版的合作伙伴。
注意
从 2022 年 4 月 1 日起，软件价目表将通过 API 提供。
URI 筛选器参数
使用以下筛选器参数。
| 名称 | 类型 | 必须 | 描述 |
|---|---|---|---|
| 时间线 | 字符串 | 否 | 默认为当前（如果未传递）。 可能的值为历史记录、当前值和将来值。 |
| 月份 | 字符串 | 否 | 仅当请求历史记录时，必须遵循 YYYYMM 才能请求价目表。 |
注意
市场不支持将来的定价。 从 2022 年 4 月 1 日起，合作伙伴将能够通过 API 查看软件价目表历史记录，从 2022 年 3 月开始。
请求标头
- 有关详细信息，请参阅 合作伙伴 REST 标头。
除了上述标头外，还可以将定价文件作为压缩方式检索，以减少带宽和下载时间。 默认情况下，不会压缩文件。 若要获取文件的压缩版本，可以包含以下标头值。 意识到压缩的工作表仅在 2020 年 4 月起可用，2020 年 4 月之前的所有工作表仅可用，但未压缩。
| 标头 | 值类型 | Value | 说明 |
|---|---|---|---|
| Accept-Encoding | 字符串 | 紧缩 | 可选。 如果未压缩省略的文件流。 |
请求示例
GET https://api.partner.microsoft.com/v1.0/sales/pricesheets(Market='ad',PricesheetView='azure_consumption')/$value?timeline=history&month=201909 HTTP/1.1
Authorization: Bearer
Host: api.partner.microsoft.com
新商务的请求示例
注意
updatedlicensebased PriceSheetView 目前仅适用于属于 M365/D365 新商业体验技术预览版的合作伙伴。
GET https://api.partner.microsoft.com/v1.0/sales/pricesheets(Market='US',PricesheetView='updatedlicensebased')/$value?timeline=history&month=202101 HTTP/1.1
Authorization: Bearer
Accept-Encoding: deflate
Host: api.partner.microsoft.com
REST 响应
如果成功，此方法将价目表作为文件流返回。 文件流是.csv文件或 zip 压缩版本的.csv。
新商务的响应示例
注意
updatedlicensebased PriceSheetView 目前仅适用于属于 M365/D365 新商业体验技术预览版的合作伙伴。
HTTP/1.1 200 OK
Cache-Control: private
Content-Length: 42180180
Content-Type: application/octet-stream
Content-Disposition: attachment; filename=sheets.csv
Request-ID: 9f8bed52-e4df-4d0c-9ca6-929a187b0731
Date: Wed, 02 Feb 2021 03:41:20 GMT
"ProductTitle","ProductId","SkuId","SkuTitle","Publisher","SkuDescription","UnitOfMeasure","TermDuration","BillingPlan","Market","Currency","UnitPrice","PricingTierRangeMin","PricingTierRangeMax","EffectiveStartDate","EffectiveEndDate","Tags","ERP Price“
"Advanced Communications","CFQ7TTC0HDK0","0001","Advanced Communications","Microsoft Corporation","Advanced meetings, calling, workflow integration, and management tools for IT.","","P1Y","Annual","US","USD","115.2","","","2/1/2019 12:00:00 AM","2/4/2021 8:35:31 PM","License","144"
======= Truncated ==============
响应的成功和错误代码
每个响应都带有一个 HTTP 状态代码，用于指示成功或失败以及其他调试信息。 请使用网络跟踪工具来读取此代码、错误类型和其他参数。 有关完整列表，请参阅错误代码。