Získání okrajů

Platí pro: Partnerské centrum

Příslušné role: Agent pro správu

Jako partner v programu CSP můžete volat rozhraní GetMargins API, abyste získali seznam privátních nabídek rozšířených vydavateli nezávislých výrobců softwaru.

Požadavky

Přihlašovací údaje popsané v ověřování v Partnerském centru Tento scénář podporuje ověřování pomocí samostatných přihlašovacích údajů aplikace i aplikace a uživatele.

Požadavek REST

[GET] /v1/margins

Syntaxe požadavku

metoda	Identifikátor URI žádosti
GET	{baseURL}/v1/margins HTTP/1.1

Záhlaví žádosti

Další informace najdete v tématu Hlavičky REST Partnerského centra.

Text požadavku

Nic

Příklad požadavku

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

Odpověď REST

V případě úspěchu tento požadavek vrátí seznam privátních okrajů nabídek. Vydavatel nezávislých výrobců softwaru může nakonfigurovat marži privátní nabídky buď jako pevnou procentuální slevu, která se použije na původní cenu nabídky, nebo jako vlastní cenu, která přepíše původní cenu nabídky. Oba typy okrajů se vrátí v odpovědi rozhraní GetMargins API.

Každá položka řádku v odpovědi obsahuje počáteční a koncové datum. Marže privátní nabídky se použije pouze u nákupů, které jsou provedeny v těchto dvou datech. Nákupy provedené mimo tento časový rámec nezískají výhodu marže privátní nabídky.

Kódy úspěšnosti a chyb odpovědi

Každá odpověď obsahuje stavový kód HTTP, který indikuje úspěch nebo selhání a další informace o ladění. Ke čtení tohoto kódu, typu chyby a dalších parametrů použijte nástroj pro trasování sítě. Úplný seznam najdete v tématu Kódy chyb.

Příklady odpovědí

Marže privátní nabídky založená na procentech

V tomto příkladu vydavatel nezávislých výrobců softwaru nakonfiguroval marži privátní nabídky jako pevnou procentuální slevu z původní ceny nabídky. Sleva se zobrazí ve vlastnosti percentageMargin. Vzhledem k tomu, že tato soukromá nabídka je rozšířená pro konkrétní skladovou položku, zadává se informace o skladové posílce, jako je název skladové položky a ID skladové položky. Pokud se vydavatel nezávislých výrobců softwaru rozhodl rozšířit soukromou nabídku pro všechny skladové položky, tyto informace by se nezadály.

Response

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

Vlastní cena – privátní nabídka – marže

V tomto příkladu vydavatel isV nakonfiguroval privátní nabídku jako vlastní cenu, která přepíše původní cenu svého řešení SaaS vlastními měřiči. Místo marginPercentage vlastnost jako v předchozím příkladu, tato položka řádku obsahuje priceConfiguration vlastnost, která obsahuje podrobnosti o vlastních cenách.

Model pricingModel v tomto příkladu je uveden jako model "flat rate", což znamená, že platíte nastavenou částku za období. Pokud isV účtuje nastavenou částku na uživatele, cenaModel by řekl "na uživatele".

Pole "purchase" obsahuje podrobnosti o cenách pro každou dobu trvání období. IsV v tomto příkladu nakonfiguroval pouze měsíční dobu trvání, ale pole "purchase" může obsahovat také "Roční" dobu trvání. V rámci konfigurace nákupu pro daný termín uvádí includedMeterQuantities částky pro každý vlastní měřič, který je součástí ceny. Vzhledem k tomu, že vydavatel isV může nakonfigurovat různé cenové body pro různé trhy zákazníků, pole marketSetPrices obsahuje vlastní cenu pro každý trh a měnu, ve které je soukromá nabídka dostupná. V tomto příkladu zahrnuje plochá sazba 448,75262 GPB pro zákazníka na trhu GB (Spojené království) 20 zařízení a 30 000 e-mailů měsíčně.

Pole Consumption obsahuje informace o cenách nadlimitního využití pro každý vlastní měřič. Pokud produkt isV nemá vlastní měřiče, bude toto pole prázdné. Všimněte si, že pole consumption obsahuje řádkovou položku pro každý vlastní měřič uvedený v seznamu "includedMeterQuantities". Pokud v tomto příkladu spotřebujete více než 20 zařízení za měsíc, zaplatíte dalších 0,44729 GBP za 1 další zařízení za měsíc. Pokud využíváte více než 30 000 e-mailů, platíte 0,38765 GBP za 100 dalších e-mailů za měsíc.

Response

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

Výše uvedený příklad by měl mít následující výsledek.