Získání analýzy předplatného seskupené podle kalendářních dat nebo termínů

Článek
03/08/2023

Platí pro: Partnerské centrum | Partnerské centrum provozované společností 21Vianet | Partnerské centrum pro Microsoft Cloud for US Government

Jak získat analytické informace o předplatném pro zákazníky seskupené podle kalendářních dat nebo podmínek.

Požadavky

Přihlašovací údaje, jak je popsáno v tématu Ověřování v Partnerském centru. Tento scénář podporuje ověřování pouze pomocí přihlašovacích údajů uživatele.

Požadavek REST

Syntaxe požadavku

Metoda	Identifikátor URI žádosti
GET	{baseURL}/partner/v1/analytics/subscriptions?groupby={groupby_queries}

Parametry identifikátoru URI

Pomocí následujících požadovaných parametrů cesty identifikujte vaši organizaci a seskupte výsledky.

Název	Typ	Vyžadováno	Popis
groupby_queries	páry řetězců a dateTime	Yes	Termíny a data pro filtrování výsledku

Syntaxe GroupBy

Seskupit podle parametru se musí skládat jako řada hodnot polí oddělených čárkami.

Nekódovaný příklad vypadá takto:

?groupby=termField1,dateField1,termField2

Následující tabulka obsahuje seznam podporovaných polí pro seskupení podle.

Pole	Typ	Description
customerTenantId	řetězec	Řetězec ve formátu GUID, který identifikuje tenanta zákazníka.
jméno zákazníka	řetězec	Jméno zákazníka.
customerMarket	řetězec	Země nebo oblast, ve které zákazník obchoduje.
id	řetězec	Řetězec ve formátu GUID, který identifikuje odběr.
status	řetězec	Stav předplatného. Podporované hodnoty jsou: "ACTIVE", "SUSPENDED" nebo "DEPROVISIONED".
Productname	řetězec	Název produktu.
typ předplatného	řetězec	Typ předplatného. Poznámka: V tomto poli se rozlišují malá a velká písmena. Podporované hodnoty jsou: "Office", "Azure", "Microsoft365", "Dynamics", "EMS".
autoRenewEnabled	Logická hodnota	Hodnota označující, jestli se předplatné prodloužilo automaticky.
id partnera	řetězec	ID partnera. V případě přímého prodejce bude tímto parametrem ID partnera. U nepřímého prodejce bude tento parametr ID partnera nepřímého prodejce.
Friendlyname	řetězec	Název předplatného.
partnerName	řetězec	Název partnera, pro kterého bylo předplatné zakoupeno
Providername	řetězec	Pokud je transakce předplatného určená pro nepřímého prodejce, název poskytovatele je nepřímý poskytovatel, který předplatné zakoupil.
datum vytvoření	string ve formátu data a času UTC	Datum vytvoření předplatného.
effectiveStartDate	string ve formátu data a času UTC	Datum, kdy odběr začíná.
commitmentEndDate	string ve formátu data a času UTC	Datum, kdy předplatné končí.
currentStateEndDate	string ve formátu data a času UTC	Datum, kdy se změní aktuální stav předplatného.
trialToPaidConversionDate	string ve formátu data a času UTC	Datum, kdy se předplatné převede ze zkušební verze na placené. Výchozí hodnotou je hodnota null.
trialStartDate	string ve formátu data a času UTC	Datum, kdy začalo zkušební období předplatného. Výchozí hodnotou je hodnota null.
lastUsageDate	string ve formátu data a času UTC	Datum posledního použití předplatného. Výchozí hodnotou je hodnota null.
deprovisionedDate	string ve formátu data a času UTC	Datum zrušení zřízení předplatného. Výchozí hodnotou je hodnota null.
posledníRenewalDate	string ve formátu data a času UTC	Datum posledního prodloužení předplatného. Výchozí hodnotou je hodnota null.

Filtrovat pole

Následující tabulka obsahuje seznam volitelných polí filtru a jejich popisy:

Pole	Typ	Description
top	int	Počet řádků dat, které se mají v požadavku vrátit. Pokud hodnota není zadaná, je maximální a výchozí hodnota 10 000. Pokud je v dotazu více řádků, text odpovědi obsahuje další odkaz, který můžete použít k vyžádání další stránky dat.
Přeskočit	int	Počet řádků, které se mají v dotazu přeskočit. Pomocí tohoto parametru můžete procházet rozsáhlé datové sady. Například top=10000 a skip=0 načte prvních 10 000 řádků dat, top=10000 a skip=10000 načte dalších 10 000 řádků dat.
filter	řetězec	Jeden nebo více příkazů, které filtrují řádky v odpovědi. Každý příkaz filter obsahuje název pole z textu odpovědi a hodnotu, která je přidružená k operátoru `eq`, `ne`nebo pro určitá pole `contains` . Příkazy je možné kombinovat pomocí nebo `and``or`. Řetězcové hodnoty musí být v parametru filtru uzavřeny v jednoduchých uvozovkách. V následující části najdete seznam polí, která je možné filtrovat, a operátory, které jsou s těmito poli podporované.
aggregationLevel	řetězec	Určuje časový rozsah, pro který se mají načíst agregovaná data. Může to být jeden z následujících řetězců: den, týden nebo měsíc. Pokud hodnota není zadaná, výchozí hodnota je dateRange. Poznámka: Tento parametr platí pouze v případě, že je pole data předáno jako součást parametru groupBy.
Groupby	řetězec	Příkaz, který použije agregaci dat pouze na zadaná pole.

Hlavičky požadavku

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

Text požadavku

Žádné

Příklad požadavku

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions?groupBy=subscriptionType
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3123
MS-CorrelationId: ec8f62e5-1d92-47e9-8d5d-1924af105123
Content-Type: application/json
Content-Length: 0

Odpověď REST

V případě úspěchu obsahuje text odpovědi kolekci prostředků předplatného seskupenou podle zadaných termínů a dat.

Úspěšné odpovědi a kódy chyb

Každá odpověď obsahuje stavový kód HTTP, který označuje úspěch nebo neúspěch, 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říklad odpovědi

HTTP/1.1 200 OK
Content-Length: 177
Content-Type: application/json; charset=utf-8
MS-CorrelationId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3123
MS-RequestId: ec8f62e5-1d92-47e9-8d5d-1924af105123
{
  "Value": [
    {
      "subscriptionType": "Azure",
      "subscriptionCount": "63",
      "licenseCount": "0"
    },
    {
      "subscriptionType": "Dynamics",
      "subscriptionCount": "62",
      "licenseCount": "405"
    },
    {
      "subscriptionType": "EMS",
      "subscriptionCount": "39",
      "licenseCount": "193"
    },
    {
      "subscriptionType": "M365",
      "subscriptionCount": "2",
      "licenseCount": "5"
    },
    {
      "subscriptionType": "Office",
      "subscriptionCount": "906",
      "licenseCount": "7485"
    },
    {
      "subscriptionType": "UNKNOWN",
      "subscriptionCount": "104",
      "licenseCount": "439"
    },
    {
      "subscriptionType": "Windows",
      "subscriptionCount": "2",
      "licenseCount": "2"
    }
  ],
  "@nextLink": null,
  "TotalCount": 7
}

Viz také

Analýzy Partnerského centra – prostředky

Share via