Abrufen einer Heraufstufung nach ID

  • Artikel

Gilt für

  • Partner Center

Geeignete Rollen

  • Globaler Administrator
  • Administrator-Agent

Hinweis

Die neuen Commerce-Umgebungen für lizenzbasierte Dienste enthalten zahlreiche neue Funktionen und stehen allen Cloud Solution Providern (CSP) zur Verfügung. Weitere Informationen finden Sie in der Übersicht über neue Commerce-Erfahrungen.

Partner können eine einzelne Werbeaktion für eine bestimmte Promotions-ID und ein Land/eine Region erhalten. Diese Methode gibt die Herauf- und Heraufsufungsdaten zurück, wobei die Anfangs- und Enddaten der Heraufsufung ignoriert werden. Diese Methode wird hauptsächlich für Abstimmungszwecke verwendet, um Heraufsufungsdetails auch nach Ablauf der Aktion abzurufen.

Voraussetzungen

  • Anmeldeinformationen, wie unter Partner Center-Authentifizierung beschrieben. Dieses Szenario unterstützt die Authentifizierung mit eigenständigen App- und App+Benutzeranmeldeinformationen.

  • Die Heraufsufungs-ID ist ein durch Trennzeichen getrennter Satz von Zeichenfolgen, die eine bestimmte Heraufufung darstellen.

  • Das Land steht für die Kunden-/Regionsaktionen zur Verfügung. Das Land wird durch einen Ländercode mit zwei Zeichen dargestellt.

REST-Anforderung

Anforderungssyntax

Methode Anforderungs-URI
GET {baseURL}/v1/productpromotions/{promotion-id}?country={country-code HTTP/1.1

URI-Parameter

Verwenden Sie die folgenden Abfrageparameter, um verfügbare Werbeaktionen zurückzugeben.

Name Type Erforderlich Beschreibung
Promotion-ID string J Eine Zeichenfolge, die die abzurufende Heraufsufung definiert.
country string J Ein länderspezifischer Code mit zwei Buchstaben, der bestimmt, für welche Kundenländer/Regionen-Werbeaktionen verfügbar sind.

Anforderungsheader

Weitere Informationen finden Sie unter Partner Center-REST-Header.

Anforderungstext

Keine

Werbeeinschränkungen

Werbeeinschränkungen werden jetzt von dieser API zurückgegeben. Beispiele finden Sie in der nachstehenden Antwort. Wenn eine Aktion Berechtigungseinschränkungen aufweist, werden details in der Antwort zurückgegeben. Diese Daten können verwendet werden, um zu verstehen, ob Ihr Kunde für den Rabatt qualifiziert ist.

Einschränkungskategorie Einschränkungswert Einschränkungstyp Beschreibung
SeatConstraints MinSeats Abonnementmenge Mindestsitze, die für den Kunden erforderlich sind, um für die Promo berechtigt zu sein.
SeatConstraints MaxSeats Abonnementmenge Die maximal zulässigen Plätze können angewendet werden.
AssetOwnershipLimits MinAssets LifetimeRedemptionCount Die mindeste Anzahl der Aktionen, die für einen Kunden angewendet werden können, in der Regel 0.
AssetOwnershipLimits MaxAssets LifetimeRedemptionCount Die maximale Anzahl von Aktionen, die für den Kunden beantragt werden können.The maximum number of times the promo can be applied for customer.
EligibilityConstraints isApplicable FirstPurchase Kennzeichen, das angibt, ob dies der erste Kauf der Produkt-SKU sein muss, um die Werbeaktion zu erhalten.
ProductOwnershipConstraints bigId N/V Angegebene Angebote, die der Kunde bereits besitzen muss, um für die Promo (Produkt-SKU) berechtigt zu sein.

Beispiel für eine Anfrage

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-Antwort

Bei erfolgreicher Ausführung gibt die Methode eine einzelne Heraufsufung zurück.

Erfolgs- und Fehlercodes der Antwort

Jede Antwort enthält einen HTTP-Statuscode, der Erfolg oder Fehler und weitere Debuginformationen angibt. Verwenden Sie ein Netzwerkablaufverfolgungstool, um diesen Code, fehlertyp und andere Parameter zu lesen. Die vollständige Liste findest du unter Partner-API: REST-Fehlercodes.

Beispielantwort

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"
                }
            ]
        ]
    }
}