Abrufen von Promotionen

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 Liste aktiver neuer Commerce-Werbeaktionen für einen bestimmten Markt (Land/Region) und ein bestimmtes Segment abrufen. Diese Methode gibt die verfügbaren aktuellen Werbeaktionen basierend auf den verfügbaren Anfangs- und Endterminen der Werbeaktionen zurück.

Voraussetzungen

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

• Segment stellt den Kundentyp dar, für den die Werbeaktionen aktiviert sind. Derzeit wird nur kommerzielle Unterstützung unterstützt.

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

REST-Anforderung

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

Anforderungssyntax

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

URI-Parameter

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

Name	Type	Erforderlich	Beschreibung
Segment	string	J	Eine Zeichenfolge, die bestimmt, welche Werbeaktionen für ein bestimmtes Segment verfügbar sind.
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

Beispiel für eine Anfrage

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

Wenn die Methode erfolgreich verläuft, wird eine Liste mit Werbeaktionen zurückgegeben.

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 weitere 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, 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"
    }
}