Marges ophalen

Van toepassing op: Partnercentrum

Juiste rollen: Beheerdersagent

Als partner in het CSP-programma kunt u de GetMargins-API aanroepen om een lijst met marges voor privéaanbiedingen op te halen die door ISV-uitgevers zijn uitgebreid.

Vereisten

Referenties zoals beschreven in verificatie in partnercentrum. Dit scenario ondersteunt verificatie met zowel zelfstandige app- als app+gebruikersreferenties.

REST-aanvraag

[GET] /v1/marges

Aanvraagsyntaxis

Wijze	Aanvraag-URI
GET	{baseURL}/v1/marges HTTP/1.1

Aanvraagheaders

Zie Rest-headers in Partnercentrum voor meer informatie.

Aanvraagtekst

Geen

Aanvraagvoorbeeld

GET https://api.partnercenter.microsoft.com/v1/margins 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-antwoord

Als dit lukt, retourneert deze aanvraag een lijst met marges voor privéaanbiedingen. De ISV-uitgever kan de marge van de privéaanbieding configureren als een vaste percentagekorting, die wordt toegepast op de oorspronkelijke prijs van de aanbieding, of als een aangepaste prijs die de oorspronkelijke prijs van de aanbieding overschrijft. Beide margetypen worden geretourneerd in het antwoord van de GetMargins-API.

Elk regelitem in het antwoord bevat begin- en einddatums. De marge van de privéaanbieding wordt alleen toegepast op aankopen die binnen deze twee datums worden gedaan. Aankopen die buiten dat tijdsbestek zijn gedaan, krijgen niet het voordeel van de marge van de privéaanbieding.

Geslaagde antwoorden en foutcodes

Elk antwoord wordt geleverd met een HTTP-statuscode die aangeeft dat het succes of de fout optreedt en meer informatie over foutopsporing. Gebruik een hulpprogramma voor netwerktracering om deze code, het fouttype en meer parameters te lezen. Zie Foutcodes voor de volledige lijst.

Antwoordvoorbeelden

Marge voor privéaanbieding op basis van percentage

In dit voorbeeld heeft de ISV-uitgever de marge van de privéaanbieding geconfigureerd als een vast percentage korting op de oorspronkelijke prijs van de aanbieding. De korting wordt weergegeven in de eigenschap percentageMargin. Omdat deze privéaanbieding wordt uitgebreid voor een specifieke SKU, wordt SKU-informatie zoals SKU-naam en SKU-id opgegeven. Als de ISV-uitgever ervoor heeft gekozen om de privéaanbieding voor alle SKU's uit te breiden, zou deze informatie niet worden opgegeven.

Respons

HTTP/1.1 200 OK
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
{
"pageSize": 1,
"totalSize": 1,
"results": [
{
      "id": "1aa125798b04_01a14813-f6d1-494a-ace1-b84525cf3db4",
      "type": "Percentage",
      "productId": "DZH318Z0HJ49",
      "publisherName": "Test Publisher Name",
      "productTitle": "Test Offer Beta",
      "skuTitle": "Test Offer Beta SKU 1",
      "skuId": "0001",
      "productType": "SaaS",
      "marginPercentage": 10.0,
      "startDate": "2022-02-24T18:38:02.8104364Z",
      "endDate": "2022-04-30T23:59:59Z",
      "status": "live",
      "statusDate": "2022-02-24T18:38:02.8104364Z"
}
]
}

Marge voor aangepaste prijsaanbieding

In dit voorbeeld heeft de ISV-uitgever de marge voor privéaanbiedingen geconfigureerd als een aangepaste prijs die de oorspronkelijke prijs van hun SaaS-oplossing overschrijft met aangepaste meters. In plaats van een marginPercentage-eigenschap zoals in het vorige voorbeeld, bevat dit regelitem een eigenschap priceConfiguration die de details van de aangepaste prijzen bevat.

Het pricingModel in dit voorbeeld wordt vermeld als een 'vast tarief'-model, wat betekent dat u een vast bedrag per termijn betaalt. Als de ISV een vast bedrag per gebruiker in rekening brengt, zegt het pricingModel 'per gebruiker'.

De matrix 'aankoop' bevat de prijsgegevens voor elke duur van de looptijd. De ISV in dit voorbeeld heeft alleen een 'maandelijkse' termijnduur geconfigureerd, maar de matrix 'aankoop' kan ook een 'Jaarlijkse' looptijd bevatten. In de aankoopconfiguratie voor een bepaalde term geeft includedMeterQuantities de bedragen voor elke aangepaste meter aan die zijn opgenomen in de prijs. Omdat de ISV-uitgever verschillende prijspunten voor verschillende klantmarkten kan configureren, bevat de matrix marketSetPrices de aangepaste prijs voor elke markt en valuta waarin de privéaanbieding beschikbaar is. In dit voorbeeld omvat het vaste tarief van 448,75262 GPB voor een klant in de GB-markt (Verenigd Koninkrijk) 20 apparaten en 30.000 e-mails per maand.

De matrix Verbruik bevat de prijsinformatie voor overschrijding voor elke aangepaste meter. Als het product van de ISV geen aangepaste meters heeft, is deze matrix leeg. U ziet dat de verbruikmatrix een regelitem bevat voor elke aangepaste meter die wordt vermeld in de 'includedMeterQuantities'. Als u in dit voorbeeld meer dan 20 apparaten per maand gebruikt, betaalt u een extra 0,44729 GBP per 1 extra apparaat per maand. Als u meer dan 30.000 e-mails verbruikt, betaalt u 0,38765 GBP per 100 extra e-mails per maand.

Respons

HTTP/1.1 200 OK
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
{
"pageSize": 1,
"totalSize": 1,
"results": [
{
      "id": "15680381dbad_fe3f0bc2-6372-48af-bbec-2df83918dbf2",
      "type": "CustomPrice",
      "productId": "DZH318Z0BDGN",
      "publisherName": "Test Publisher Name",
      "productTitle": "Test Offer Gamma",
      "skuTitle": "Test Offer Gamma SKU 1",
      "skuId": "0001",
      "productType": "SaaS",
      "priceConfiguration": {
        "pricingModel": "Flat rate",
        "purchase": [
          {
            "termDuration": "Monthly",
            "includedMeterQuantities": [
              "20 device",
              "30000 email"
            ],
            "startDate": "2022-01-31T17:49:25.1346812Z",
            "endDate": "2028-08-31T23:59:59Z",
            "marketSetPrices": [
              {
                "markets": [
                  "GB"
                ],
                "currency": "GBP",
                "customPrice": 447.29387
              },
              {
                "markets": [
                  "BG",
                  "FI",
                  "IT",
                  "RO"
                ],
                "currency": "GBP",
                "customPrice": 448.75262
              }
            ]
          }
        ],
        "consumption": [
          {
            "meterType": "device",
            "unitofMeasure": "per 1 device",
            "startDate": "2022-01-01T00:00:00Z",
            "endDate": "2028-08-31T23:59:59Z",
            "marketSetPrices": [
              {
                "markets": [
                  "GB"
                ],
                "currency": "GBP",
                "customPrice": 0.44729
              },
              {
                "markets": [
                  "BG",
                  "FI",
                  "IT",
                  "RO"
                ],
                "currency": "GBP",
                "customPrice": 0.44875
              }
            ]
          },
          {
            "meterType": "email",
            "unitofMeasure": "per 100 emails",
            "startDate": "2022-01-01T00:00:00Z",
            "endDate": "2028-08-31T23:59:59Z",
            "marketSetPrices": [
              {
                "markets": [
                  "GB"
                ],
                "currency": "GBP",
                "customPrice": 0.38765
              },
              {
                "markets": [
                  "BG",
                  "FI",
                  "IT",
                  "RO"
                ],
                "currency": "GBP",
                "customPrice": 0.38892
              }
            ]
          }
        ]
      },
      "startDate": "2022-01-31T17:49:25.1346812Z",
      "endDate": "2028-08-31T23:59:59Z",
      "status": "live",
      "statusDate": "2022-01-31T17:49:25.1346812Z"
    }
  ]
}

Het bovenstaande voorbeeld moet resulteren in het volgende.