ID でプロモーションを取得する

[アーティクル]
12/29/2023

適用対象

パートナーセンター

適切なロール

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

Note

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

パートナーは、特定のプロモーション ID と国/地域に対して 1 つのプロモーションを取得できます。このメソッドは、昇格の開始日と終了日を無視して、昇格データを返します。この方法は、主に調整のために使用され、プロモーションの有効期限が切れた後でもプロモーションの詳細を取得します。

前提条件

パートナーセンターの認証に関するページで説明している資格情報。このシナリオでは、スタンドアロンの App と App+User の両方の資格情報を使用した認証がサポートされています。
昇格 ID は、特定の昇格を表す文字列の区切られたセットです。
国は、顧客の国/地域のプロモーションが利用可能であることを表します。 Country は、2 文字の国コードで表されます。

REST 要求

要求の構文

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

URI パラメーター

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

名前	タイプ	Required	説明
promotion-id	string	年	取得する昇格を定義する文字列。
country	string	年	利用可能な顧客の国/地域プロモーションを決定する 2 文字の国コード。

要求ヘッダー

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

要求本文

なし

プロモーションの制約

これで、この API によってプロモーション制約が返されるようになりました。以下の応答の例を参照してください。昇格に適格性の制約がある場合は、応答で詳細が返されます。このデータを使用して、顧客が割引の対象かどうかを把握できます。

制約カテゴリ	制約値	制約の種類	説明
SeatConstraints	MinSeats	SubscriptionQuantity	お客様がプロモーションの対象となるのに必要な最小シート。
SeatConstraints	MaxSeats	SubscriptionQuantity	プロモーションを適用できる最大シート数。
AssetOwnershipLimits	MinAssets	LifetimeRedemptionCount	プロモーションを顧客に適用できる最小回数 (通常は 0)。
AssetOwnershipLimits	MaxAssets	LifetimeRedemptionCount	プロモーションを顧客に適用できる最大回数。
EligibilityConstraints	isApplicable	FirstPurchase	これがプロモーションを受け取るために顧客が製品 SKU を最初に購入する必要があるかどうかを示すフラグ。
ProductOwnershipConstraints	bigId	該当なし	指定されたオファーは、顧客がプロモーション (製品 SKU) の対象となるために既に所有している必要があります。

要求の例

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

成功した場合、このメソッドは 1 つの昇格を返します。

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

各応答には、成功または失敗とより多くのデバッグ情報を示す 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, 24 Apr 2023 20:42:26 GMT

 
{
    "id": "39NFJQT1SNC7:0001:39NFJQT1Q5KM",
    "name": "TEST Promotion May 2023 - Microsoft 365 F3",
    "description": "TEST Promotion May 2023 - Microsoft 365 F3",
    "startDate": "2023-05-03T00:00:00+00:00",
    "endDate": "9999-01-01T00:00:00+00:00",
    "properties": {
        "isAutoApplicable": true
    },
    "requiredProducts": [
        {
            "productId": "CFQ7TTC0LH05",
            "skuId": "0001",
            "term": {
                "duration": "P1Y",
                "billingCycle": "Annual"
            },
            "pricingPolicies": [
                {
                    "policyType": "PercentDiscount",
                    "value": "0.5"
                }
            ]
        }
    ],
    "promotionConstraints": { 
        "seatConstraints": [
            {
                "minSeats": 10,
                "maxSeats": 100,
                "type": "SubscriptionQuantity"
            }
        ],
        "assetOwnershipLimits": [
            {
                "minAssets": 0,
                "maxAssets": 3,
                "type": "LifetimeRedemptionCount"
            }
        ],
        "eligibilityConstraints": [
            {
                "isApplicable": true,
                "type": "FirstPurchase"
            }
        ],
        "productOwnershipConstraints": [
            [
                {
                    "bigId": "CFQ7TTC0MBMD/0002"
                }
            ]
        ]
    }
}

Share via