オファー マトリックスを取得する
この記事では、特定の月のオファー マトリックスを取得する方法について説明します。 オファー マトリックスには、製品と SKU のプロパティと購入ルールが含まれています。 このメソッドは、月ごとの履歴を取得するフィルターをサポートしています。
前提条件
- パートナー API 認証に関するページで説明している資格情報。 このシナリオでは、アプリケーション ユーザー認証のみがサポートされます。 まだアプリケーションのみはサポートされていません。 http エラー:400 が発生するパートナーは、Partner API 認証ドキュメントを参照してください。
- 現在、この API では、パートナーが管理者エージェントまたは Sales Agent のいずれかのロールに含まれている必要があるユーザー アクセスのみがサポートされています。
詳細
- Current は、更新された新しいコマース ライセンス ベースの製品についてのみデータを返します。
- 現在の価格には、現在の月から API が呼び出された日まで利用可能な製品が含まれます。 前月には、選択した月の最終日の日付が含まれます。
- このメソッドは、データをファイル ストリームとして返します。 ファイル ストリームは、.csvの.csv ファイルまたは zip 圧縮バージョンです。 圧縮ファイルを要求する方法の詳細については、以下を参照してください。
REST 要求
要求の構文
| 認証方法 | 要求 URI |
|---|---|
| GET | https://api.partner.microsoft.com/v1.0/sales/offermatrix(Month='{date}')/$value |
URI フィルター パラメーター
次のフィルター パラメーターを使用します。
| 名前 | タイプ | Required | 説明 |
|---|---|---|---|
| Month | string | いいえ | 要求される価格シートの YYYYMM に従う必要があります。 |
要求ヘッダー
- 詳細については、パートナー REST ヘッダーに関するページを参照してください。
これらのヘッダーに加えて、価格ファイルは圧縮された帯域幅とダウンロード時間として取得できます。 既定では、ファイルは圧縮されません。 圧縮バージョンのファイルを取得するには、次のヘッダー値を含めることができます。 圧縮シートは 2020 年 4 月以降のみ利用可能であり、2020 年 4 月より前のすべてのシートは圧縮されていない場合にのみ使用できます。
| ヘッダー | ［値の種類］ | Value | 説明 |
|---|---|---|---|
| エンコードの承諾 | 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の.csv ファイルまたは zip 圧縮バージョンです。
応答の成功とエラーのコード
各応答には、成功または失敗を示す 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 ==============