マージンの取得

適用対象: パートナー センター

対象のロール: グローバル管理者 | 管理エージェント

CSP プログラムのパートナーとして、GetMargins API を呼び出して、ISV パブリッシャーによって拡張されたプライベート オファーの余白の一覧を取得できます。

前提条件

パートナー センターの認証に関するページで説明している資格情報。 このシナリオでは、スタンドアロンの App と App+User の両方の資格情報を使用した認証がサポートされています。

REST 要求

[GET] /v1/margins

要求の構文

認証方法	要求 URI
GET	{baseURL}/v1/margins HTTP/1.1

要求ヘッダー

詳細については、「パートナー センター REST ヘッダー」を参照してください。

リクエストの本文

なし

要求の例

GET https://api.partnercenter.microsoft.com/v1/margins HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
MS-CorrelationId: 81b08ffe-4cf8-49cd-82db-5c2fb0a8e132
X-Locale: en-US

REST 応答

成功した場合、この要求はプライベート オファーのマージンの一覧を返します。 ISV パブリッシャーは、オファーの元の価格に適用される固定率割引として、またはオファーの元の価格をオーバーライドするカスタム価格としてプライベート オファーのマージンを構成できます。 どちらの余白の種類も GetMargins API 応答で返されます。

応答の各行項目には、開始日と終了日が含まれます。 プライベート オファーのマージンは、これら 2 つの期間内に行われた購入にのみ適用されます。 その期間外に行われた購入は、プライベート オファーの利益を得ることはできません。

応答の成功とエラーのコード

各応答には、成功または失敗とより多くのデバッグ情報を示す HTTP 状態コードが付属しています。 ネットワーク トレース ツールを使用して、このコード、エラーの種類、その他のパラメーターを読み取ります。 完全な一覧については、エラー コードに関するページを参照してください。

応答例

パーセンテージベースのプライベート オファーのマージン

この例では、ISV 発行元は、オファーの元の価格からの固定率割引としてプライベート オファーのマージンを構成しました。 割引は、"percentageMargin" プロパティに表示されます。 このプライベート オファーは特定の SKU に対して拡張されるため、SKU 名や SKU ID などの SKU 情報が指定されます。 ISV 発行元がすべての SKU のプライベート オファーを拡張することを選択した場合、この情報は指定されません。

Response

HTTP/1.1 200 OK
Content-Type: application/json
MS-CorrelationId: 81b08ffe-4cf8-49cd-82db-5c2fb0a8e132
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
{
"pageSize": 1,
"totalSize": 1,
"results": [
{
      "id": "1aa125798b04_01a14813-f6d1-494a-ace1-b84525cf3db4",
      "type": "Percentage",
      "productId": "DZH318Z0HJ49",
      "publisherName": "Test Publisher Name",
      "productTitle": "Test Offer Beta",
      "skuTitle": "Test Offer Beta SKU 1",
      "skuId": "0001",
      "productType": "SaaS",
      "marginPercentage": 10.0,
      "startDate": "2022-02-24T18:38:02.8104364Z",
      "endDate": "2022-04-30T23:59:59Z",
      "status": "live",
      "statusDate": "2022-02-24T18:38:02.8104364Z"
}
]
}

カスタム価格プライベート オファーのマージン

この例では、ISV 発行元は、SaaS ソリューションの元の価格をカスタム メーターでオーバーライドするカスタム価格としてプライベート オファーのマージンを構成しました。 前の例のように marginPercentage プロパティの代わりに、この品目にはカスタム価格の詳細を含む priceConfiguration プロパティが含まれています。

この例の pricingModel は、"定額" モデルとして一覧表示されています。つまり、期間ごとに設定された金額を支払います。 ISV がユーザーごとに設定された金額を請求している場合、pricingModel は "ユーザーごと" と言います。

"purchase" 配列には、期間ごとの価格の詳細が含まれています。 この例の ISV では、"月単位" 期間のみが構成されていますが、"purchase" 配列には "年間" 期間を含めることもできます。 特定の期間の購入構成内で、includedMeterQuantities は、価格に含まれる各カスタム メーターの金額を示します。 ISV パブリッシャーは顧客市場ごとに異なる価格ポイントを構成できるため、marketSetPrices 配列には、プライベート オファーが利用できる各市場のカスタム価格と通貨が含まれます。 この例では、GB (英国) 市場の顧客の 448.75262 GPB の定額には、1 か月あたり 20 個のデバイスと 30,000 件の電子メールが含まれています。

"consumption" 配列には、各カスタム メーターの超過料金情報が含まれています。 ISV の製品にカスタム メーターがない場合、この配列は空になります。 従量課金配列には、"includedMeterQuantities" に一覧表示されている各カスタム メーターの行項目が含まれていることに注目してください。 この例では、1 か月あたり 20 台を超えるデバイスを使用する場合は、1 か月あたり 1 台の追加デバイスにつき 0.44729 GBP が追加されます。 30,000 を超えるメールを使用する場合は、1 か月あたり 100 件の追加メールにつき 0.38765 GBP を支払います。

Response

HTTP/1.1 200 OK
Content-Type: application/json
MS-CorrelationId: 81b08ffe-4cf8-49cd-82db-5c2fb0a8e132
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
{
"pageSize": 1,
"totalSize": 1,
"results": [
{
      "id": "15680381dbad_fe3f0bc2-6372-48af-bbec-2df83918dbf2",
      "type": "CustomPrice",
      "productId": "DZH318Z0BDGN",
      "publisherName": "Test Publisher Name",
      "productTitle": "Test Offer Gamma",
      "skuTitle": "Test Offer Gamma SKU 1",
      "skuId": "0001",
      "productType": "SaaS",
      "priceConfiguration": {
        "pricingModel": "Flat rate",
        "purchase": [
          {
            "termDuration": "Monthly",
            "includedMeterQuantities": [
              "20 device",
              "30000 email"
            ],
            "startDate": "2022-01-31T17:49:25.1346812Z",
            "endDate": "2028-08-31T23:59:59Z",
            "marketSetPrices": [
              {
                "markets": [
                  "GB"
                ],
                "currency": "GBP",
                "customPrice": 447.29387
              },
              {
                "markets": [
                  "BG",
                  "FI",
                  "IT",
                  "RO"
                ],
                "currency": "GBP",
                "customPrice": 448.75262
              }
            ]
          }
        ],
        "consumption": [
          {
            "meterType": "device",
            "unitofMeasure": "per 1 device",
            "startDate": "2022-01-01T00:00:00Z",
            "endDate": "2028-08-31T23:59:59Z",
            "marketSetPrices": [
              {
                "markets": [
                  "GB"
                ],
                "currency": "GBP",
                "customPrice": 0.44729
              },
              {
                "markets": [
                  "BG",
                  "FI",
                  "IT",
                  "RO"
                ],
                "currency": "GBP",
                "customPrice": 0.44875
              }
            ]
          },
          {
            "meterType": "email",
            "unitofMeasure": "per 100 emails",
            "startDate": "2022-01-01T00:00:00Z",
            "endDate": "2028-08-31T23:59:59Z",
            "marketSetPrices": [
              {
                "markets": [
                  "GB"
                ],
                "currency": "GBP",
                "customPrice": 0.38765
              },
              {
                "markets": [
                  "BG",
                  "FI",
                  "IT",
                  "RO"
                ],
                "currency": "GBP",
                "customPrice": 0.38892
              }
            ]
          }
        ]
      },
      "startDate": "2022-01-31T17:49:25.1346812Z",
      "endDate": "2028-08-31T23:59:59Z",
      "status": "live",
      "statusDate": "2022-01-31T17:49:25.1346812Z"
    }
  ]
}

上記の例では、次のようになります。