プロモーションの取得

[アーティクル]
01/10/2024

適用対象

パートナーセンター

適切なロール

全体管理者
管理エージェント

Note

ライセンスベースのサービスの新しいコマースエクスペリエンスには、多くの新機能が含まれており、すべてのクラウドソリューションプロバイダー (CSP) で利用できます。詳細については、新しいコマースエクスペリエンスの概要を参照してください。

パートナーは、特定の市場 (国/地域) とセグメントに対してアクティブな新しいコマースプロモーションの一覧を取得できます。このメソッドは、利用可能な開始日と終了日に基づいて、利用可能な現在のプロモーションを返します。

前提条件

パートナーセンターの認証に関するページで説明している資格情報。このシナリオでは、スタンドアロンの App と App+User の両方の資格情報を使用した認証がサポートされています。
セグメントは、プロモーションが有効になっている顧客の種類を表します。現在、商用のみをサポートしています。
国は、顧客の国/地域のプロモーションが利用可能であることを表します。 Country は、2 文字の国コードで表されます。

REST 要求

[GET] /v1/productpromotions?country={country-code}>segment={segment}

要求の構文

認証方法	要求 URI
GET	{baseURL}/v1/productpromotions?country={country-code}>segment={segment} HTTP/1.1

URI パラメーター

使用可能なプロモーションを返すには、次のクエリパラメーターを使用します。

名前	タイプ	Required	説明
セグメント	string	年	特定のセグメントで使用できる昇格を決定する文字列。
country	string	年	利用可能な顧客の国/地域プロモーションを決定する 2 文字の国コード。

要求ヘッダー

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

要求本文

なし

要求の例

GET https://api.partnercenter.microsoft.com/v1/productpromotions?country=US&segment=commercial 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 応答

成功した場合、このメソッドはプロモーションの一覧を返します。

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

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

応答の例

HTTP/1.1 200 OK
Content-Length: 138
Content-Type: application/json
MS-CorrelationId: 81b08ffe-4cf8-49cd-82db-5c2fb0a8e132
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
Date: Fri, 26 Feb 2021 20:42:26 GMT


{
    "totalCount": 2,
    "items": [
        {
            "id": "39NFJQT1PJQB:0001:39NFJQT1Q5KN",
            "name": "Visio Plan 1",
            "description": "Visio Plan 1",
            "startDate": "2021-09-23T00:00:00+00:00",
            "endDate": "2021-10-14T23:59:59+00:00",
            "properties": {
                "isAutoApplicable": true
            },
            "requiredProducts": [
                {
                    "productId": "CFQ7TTC0HD33",
                    "skuId": "0003",
                    "term": {
                        "duration": "P1Y",
                        "billingCycle": "Annual"
                    },
                    "pricingPolicies": [
                        {
                            "policyType": "PercentDiscount",
                            "value": "0.05"
                        }
                    ]
                }
            ]
        },
        {
            "id": "39NFJQT1PJQC:0001:39NFJQT1Q5KM",
            "name": "Vision Plan 1",
            "description": "Vision Plan 1",
            "startDate": "2021-09-23T00:00:00+00:00",
            "endDate": "2021-10-14T23:59:59+00:00",
            "properties": {
                "isAutoApplicable": true
            },
            "requiredProducts": [
                {
                    "productId": "CFQ7TTC0HD33",
                    "skuId": "0003",
                    "term": {
                        "duration": "P1Y",
                        "billingCycle": "Monthly"
                    },
                    "pricingPolicies": [
                        {
                            "policyType": "PercentDiscount",
                            "value": "0.167"
                        }
                    ]
                }
            ]
        }
    ],
    "attributes": {
        "objectType": "Collection"
    }
}

次の方法で共有