Hämta kampanjer

Artikel
09/28/2024

Gäller för

Partnercenter

Lämpliga roller

Administratörsagent

Kommentar

De nya handelsupplevelserna för licensbaserade tjänster innehåller många nya funktioner och är tillgängliga för alla Molnlösningsleverantör (CSP:er). Mer information finns i översikten över nya handelsupplevelser.

Partner kan få en lista över aktiva nya handelskampanjer för en viss marknad (land/region) och segment. Den här metoden returnerar tillgängliga aktuella kampanjer baserat på tillgängliga start- och slutdatum för kampanjer.

Förutsättningar

Autentiseringsuppgifter enligt beskrivningen i Partnercenter-autentisering. Det här scenariot stöder autentisering med både fristående app- och App+User-autentiseringsuppgifter.
Segmentet representerar den typ av kund som kampanjerna är aktiverade för. Stöder för närvarande endast kommersiella.
Land representerar de kampanjer för kundens land/region som är tillgängliga för. Landet representeras av en landskod med två tecken.

REST-begäran

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

Syntax för begäran

Metod	URI för förfrågan
GET	{baseURL}/v1/productpromotions?country={country-code}&segment={segment} HTTP/1.1

URI-parameter

Använd följande frågeparametrar för att returnera tillgängliga kampanjer.

Namn	Typ	Obligatoriskt	Beskrivning
segment	sträng	Y	En sträng som avgör vilka kampanjer som är tillgängliga för ett visst segment.
land	sträng	Y	En landskod med två bokstäver som avgör vilka kampanjer för kundens land/region som är tillgängliga för.

Begärandehuvuden

Mer information finns i REST-huvuden för Partnercenter.

Begärandetext

Ingen

Exempel på begäran

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: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US

REST-svar

Om det lyckas returnerar den här metoden en lista över kampanjer.

Svarsframgång och felkoder

Varje svar levereras med en HTTP-statuskod som anger lyckad eller misslyckad och mer felsökningsinformation. Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och fler parametrar. Den fullständiga listan finns i Felkoder.

Svarsexempel

HTTP/1.1 200 OK
Content-Length: 138
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
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"
    }
}

Dela via