価格シートを取得する
この記事では、特定の市場とビューの価格シートを取得する方法について説明します。 このメソッドは、月ごとの履歴を取得するフィルターをサポートしています。
前提条件
- パートナー API 認証に関するページで説明している資格情報。 このシナリオでは、アプリケーション ユーザー認証のみがサポートされます。 まだアプリケーションのみはサポートされていません。 http エラー:400 が発生するパートナーは、Partner API 認証ドキュメントを参照してください。
- 現在、この API では、パートナーが管理者エージェントまたはセールス エージェントのいずれかのロールに含まれている必要があるユーザー アクセスのみがサポートされています。
詳細
- 現在は、Azure プランの使用量と予約、ライセンスベース (新しいコマース エクスペリエンス)、Marketplace 製品についてのみデータが返されます。
- 現在の価格には、現在の月から API が呼び出された日まで利用可能なすべてのメーターと製品が含まれます。 前月には、特定の月に利用可能なすべてのメーターと製品が含まれます。
- 従量課金制の価格は米国ドルのみで、パートナーは外国為替レート API を使用して現地通貨コストを計算します。
- 従量課金制の価格は、推定小売価格です。 パートナー割引は、パートナー獲得クレジットで利用できます。
- 予約メーターの価格には、CSP パートナーの割引が含まれます。 予約の推定小売価格は、パートナー センターの [価格とオファー] ページからダウンロードできる予約共有サービスで確認できます。
- Azure プランの価格の詳細については、 Azure プランの価格に関するドキュメントを参照してください。
- パートナーの価格と外国為替レート API は、 Partner Center SDK の一部ではありません。
- このメソッドは、価格表をファイル ストリームとして返します。 ファイル ストリームは、.csvの.csv ファイルまたは zip 圧縮バージョンです。 圧縮ファイルを要求する方法の詳細については、以下を参照してください。
REST 要求
要求の構文
| 認証方法 | 要求 URI |
|---|---|
| GET | https://api.partner.microsoft.com/v1.0/sales/pricesheets(Market='{market}',PricesheetView='{view}')/$value |
URI に必要なパラメーター
必要な価格シートの市場と種類を要求するには、次のパス パラメーターを使用します。
| 名前 | タイプ | Required | 説明 |
|---|---|---|---|
| マーケット | string | はい | 要求されている市場の 2 文字の国/地域コード |
| PricesheetView | string | はい | 要求される価格シートの種類。azure_consumption、azure_reservations、updatedlicensebased、licensebasedbeta (変更インジケーター列を含む)、マーケットプレース、またはソフトウェアを指定できます。 |
Note
updatedlicensebased PriceSheetView は現在、Microsoft 365/Microsoft Dynamics 365新しいコマース エクスペリエンスのテクニカル プレビューに参加しているパートナーのみが利用できます。
Note
販売終了ライセンスベースの価格シートは、現時点ではパートナー センター UX 経由でのみダウンロードできます。
URI フィルター パラメーター
次のフィルター パラメーターを使用します。
| 名前 | タイプ | Required | 説明 |
|---|---|---|---|
| タイムライン | string | いいえ | 既定値は、渡されない場合は current です。 指定できる値は履歴、現在、将来です。 |
| Month | string | いいえ | 履歴が要求された場合にのみ必要です。要求される価格シートの YYYYMM に従う必要があります。 |
Note
Marketplace では、今後の価格はサポートされていません。 2022 年 4 月 1 日以降、パートナーは 2022 年 3 月の履歴から API を使用してソフトウェア価格表の履歴を表示できるようになります。
要求ヘッダー
- 詳細については、「 Partner REST ヘッダー」を参照してください。
上記のヘッダーに加えて、価格ファイルは圧縮された帯域幅とダウンロード時間の短縮として取得できます。 既定では、ファイルは圧縮されません。 ファイルの圧縮バージョンを取得するには、次のヘッダー値を含めることができます。 圧縮シートは 2020 年 4 月以降のみ利用可能であり、2020 年 4 月より前のすべてのシートは圧縮されていない場合にのみ使用できます。
| ヘッダー | Value タイプ | Value | 説明 |
|---|---|---|---|
| エンコードの承諾 | string | deflate | 省略可能。 省略されたファイル ストリームが圧縮されていない場合。 |
要求の例
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
新しいコマースの要求例
Note
updatedlicensebased PriceSheetView は現在、Microsoft 365/Microsoft Dynamics 365新しいコマース エクスペリエンスのテクニカル プレビューに参加しているパートナーのみが利用できます。
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の.csv ファイルまたは zip 圧縮バージョンです。
新しいコマースの応答の例
Note
updatedlicensebased PriceSheetView は現在、Microsoft 365/Microsoft Dynamics 365新しいコマース エクスペリエンスのテクニカル プレビューに参加しているパートナーのみが利用できます。
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 状態コードが付属しています。 ネットワーク トレース ツールを使用して、このコード、エラーの種類、およびその他のパラメーターを読み取ります。 完全な一覧については、エラー コードに関するページを参照してください。
新しいコマース ライセンスベースの将来の価格表に対して予想される変更がない場合、将来の価格表は返されません。 更新されたライセンスベースの PriceSheetView に対して要求されたタイムラインに将来を渡すと、パートナーには次の API 応答コードが表示されます: 404 Not Found。