Share via

Získání analytických informací o předplatných filtrovaných podle vyhledávacího dotazu

  • Článek

Platí pro: Partnerské centrum | Partnerské centrum provozované společností 21Vianet | Partnerské centrum pro Microsoft Cloud pro státní správu USA

Jak získat analytické informace o předplatném pro zákazníky filtrované vyhledávacím dotazem.

Požadavky

  • Přihlašovací údaje popsané v ověřování v Partnerském centru Tento scénář podporuje ověřování pouze s přihlašovacími údaji uživatele.

Požadavek REST

Syntaxe požadavku

metoda Identifikátor URI žádosti
GET {baseURL}/partner/v1/analytics/subscriptions?filter={filter_string}

Parametry identifikátoru URI

Pomocí následujícího parametru požadované cesty identifikujte organizaci a vyfiltrujte vyhledávání.

Name Type Požadováno Popis
filter_string string Ano Filtr, který se použije pro analýzu předplatného. Informace o syntaxi, polích a operátorech pro použití v tomto parametru najdete v částech Syntaxe filtru a Pole filtru.

Syntaxe filtru

Parametr filtru se musí skládat jako řada kombinací polí, hodnot a operátorů. Více kombinací lze kombinovat pomocí and nebo or operátory.

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

  • Řetězec: ?filter=Field operator 'Value'
  • Boolean: ?filter=Field operator Value
  • Obsahuje ?filter=contains(field,'value')

Filtrovat pole

Parametr filtru požadavku obsahuje jeden nebo více příkazů, které filtrují řádky v odpovědi. Každý příkaz obsahuje pole a hodnotu, které jsou přidruženy k operátorům eq nebo ne operátorům. Některá pole také podporují operátory contains, gt, gelt, a le operátory. Příkazy lze kombinovat pomocí and nebo or operátory.

Tady jsou příklady řetězců filtru:

autoRenewEnabled eq true

autoRenewEnabled eq true and customerMarket eq 'US'

Následující tabulka obsahuje seznam podporovaných polí a operátorů podpory pro parametr filtru. Řetězcové hodnoty musí být obklopeny jednoduchými uvozovkami.

Parametr Podporované operátory Popis
autoRenewEnabled eq, ne Hodnota označující, jestli se předplatné prodloužilo automaticky.
commitmentEndDate eq, ne, gt, lt, , gele Datum ukončení předplatného.
creationDate eq, ne, gt, lt, , gele Datum vytvoření předplatného
currentStateEndDate eq, ne, gt, lt, , gele Datum, kdy se změní aktuální stav předplatného.
customerMarket eq, ne Země/oblast, ve které zákazník obchoduje.
customerName contains Jméno zákazníka.
customerTenantId eq, ne Řetězec formátovaný identifikátorem GUID, který identifikuje tenanta zákazníka.
deprovisionedDate eq, ne, gt, lt, , gele Datum zrušení zřízení předplatného. Výchozí hodnotou je hodnota null.
effectiveStartDate eq, ne, gt, lt, , gele Datum zahájení předplatného.
Friendlyname contains Název předplatného.
ID eq, ne Řetězec formátovaný identifikátorem GUID, který identifikuje předplatné.
lastRenewalDate eq, ne, gt, lt, , gele Datum posledního prodloužení předplatného. Výchozí hodnotou je hodnota null.
lastUsageDate eq, ne, gt, lt, , gele Datum posledního použití předplatného. Výchozí hodnotou je hodnota null.
partnerId eq, ne ID partnera. U přímého prodejce je tato hodnota ID partnera. U nepřímého prodejce je tato hodnota ID partnera nepřímého prodejce.
partnerName string Jméno partnera, pro kterého bylo předplatné zakoupeno
productName contains, , eqne Název produktu.
Providername string Pokud je transakce předplatného pro nepřímého prodejce, název poskytovatele je nepřímý poskytovatel, který předplatné koupil.
stav eq, ne Stav předplatného. Podporované hodnoty jsou: ACTIVE, SUSPENDED nebo DEPROVISIONED.
subscriptionType eq, ne 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.
trialStartDate eq, ne, gt, lt, , gele Datum, kdy se zkušební období předplatného spustilo. Výchozí hodnotou je hodnota null.
trialToPaidConversionDate eq, ne, gt, lt, , gele Datum, kdy se předplatné převede ze zkušební verze na placené. Výchozí hodnotou je hodnota null.

Záhlaví žádosti

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

Text požadavku

Nezaokrouhlovat.

Příklad požadavku

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions?filter=autoRenewEnabled eq true
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 tělo odpovědi kolekci prostředků předplatného, které splňují kritéria filtru.

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

Každá odpověď obsahuje stavový kód HTTP, který indikuje informace o úspěchu nebo selhání a 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

{
    "customerTenantId": "735920EB-A564-4C72-9FE5-52632562712C",
    "customerName": "SURFACE TEST2",
    "customerMarket": "US",
    "id": "B76412DA-D382-4688-A6A4-711A207C1C2E",
    "status": "ACTIVE",
    "productName": "UNKNOWN",
    "subscriptionType": "Azure",
    "autoRenewEnabled": true,
    "partnerId": "3B33E682-00C3-41EE-9DD2-A548ADF56438",
    "friendlyName": "MICROSOFT AZURE",
    "creationDate": "2017-06-02T23:11:58.747",
    "effectiveStartDate": "2017-06-02T00:00:00",
    "commitmentEndDate": null,
    "currentStateEndDate": null,
    "trialToPaidConversionDate": null,
    "trialStartDate": null,
    "trialEndDate": null,
    "lastUsageDate": null,
    "deprovisionedDate": null,
    "lastRenewalDate": null,
    "licenseCount": 0
}

Viz také