Udostępnij za pośrednictwem

Pobieranie analizy subskrypcji pogrupowanych według dat lub terminów

  • Artykuł

Dotyczy: Centrum partnerskie | Centrum partnerskie obsługiwane przez firmę 21Vianet | Centrum partnerskie dla Microsoft Cloud for US Government

Jak uzyskać informacje analizy subskrypcji dla klientów pogrupowane według dat lub terminów.

Wymagania wstępne

Żądanie REST

Składnia żądania

Metoda Identyfikator URI żądania
GET {baseURL}/partner/v1/analytics/subscriptions?groupby={groupby_queries}

Parametry identyfikatora URI

Użyj następujących wymaganych parametrów ścieżki, aby zidentyfikować organizację i pogrupować wyniki.

Nazwa Typ Wymagane Opis
groupby_queries pary ciągów i dateTime Tak Terminy i daty filtrowania wyniku.

Składnia Grupuj wg

Grupowanie według parametru musi składać się z serii rozdzielonych przecinkami wartości pól.

Przykład niezakodowany wygląda następująco:

?groupby=termField1,dateField1,termField2

W poniższej tabeli przedstawiono listę obsługiwanych pól dla grupowania według.

Pole Typ Opis
customerTenantId ciąg Ciąg sformatowany za pomocą identyfikatora GUID, który identyfikuje dzierżawę klienta.
Customername ciąg Nazwa klienta.
customerMarket ciąg Kraj/region, w którym klient prowadzi działalność.
identyfikator ciąg Ciąg sformatowany przez identyfikator GUID, który identyfikuje subskrypcję.
status ciąg Stan subskrypcji. Obsługiwane wartości to: "ACTIVE", "SUSPENDED" lub "DEPROVISIONED".
Productname ciąg Nazwa produktu.
Subscriptiontype ciąg Typ subskrypcji. Uwaga: w tym polu jest rozróżniana wielkość liter. Obsługiwane wartości to: "Office", "Azure", "Microsoft365", "Dynamics", "EMS".
autoRenewEnabled Wartość logiczna Wartość wskazująca, czy subskrypcja jest odnawiana automatycznie.
partnerId ciąg Identyfikator partnera. W przypadku odsprzedawcy bezpośredniego ten parametr będzie identyfikatorem PartnerID partnera. W przypadku odsprzedawcy pośredniego ten parametr będzie identyfikatorem PartnerID odsprzedawcy pośredniego.
Friendlyname ciąg Nazwa subskrypcji.
partnerName ciąg Nazwa partnera, dla którego zakupiono subskrypcję
Providername ciąg Jeśli transakcja subskrypcji dotyczy odsprzedawcy pośredniego, nazwa dostawcy to dostawca pośredni, który kupił subskrypcję.
Creationdate ciąg w formacie daty i godziny UTC Data utworzenia subskrypcji.
effectiveStartDate ciąg w formacie daty i godziny UTC Data rozpoczęcia subskrypcji.
commitmentEndDate ciąg w formacie daty i godziny UTC Data zakończenia subskrypcji.
currentStateEndDate ciąg w formacie daty i godziny UTC Data zmiany bieżącego stanu subskrypcji.
trialToPaidConversionDate ciąg w formacie daty i godziny UTC Data konwersji subskrypcji z wersji próbnej na płatną. Wartość domyślna to null.
trialStartDate ciąg w formacie daty i godziny UTC Data rozpoczęcia okresu próbnego subskrypcji. Wartość domyślna to null.
lastUsageDate ciąg w formacie daty i godziny UTC Data ostatniego użycia subskrypcji. Wartość domyślna to null.
anulowanie aprowizacjiDate ciąg w formacie daty i godziny UTC Data anulowania aprowizacji subskrypcji. Wartość domyślna to null.
lastRenewalDate ciąg w formacie daty i godziny UTC Data ostatniego odnowienia subskrypcji. Wartość domyślna to null.

Filtruj pola

W poniższej tabeli wymieniono opcjonalne pola filtru i ich opisy:

Pole Typ Opis
top (pierwsze) int Liczba wierszy danych do zwrócenia w żądaniu. Jeśli wartość nie jest określona, wartość maksymalna i wartość domyślna to 10000. Jeśli w zapytaniu znajduje się więcej wierszy, treść odpowiedzi zawiera następny link, którego można użyć do żądania następnej strony danych.
Pomiń int Liczba wierszy do pominięcia w zapytaniu. Użyj tego parametru, aby stronicować za pośrednictwem dużych zestawów danych. Na przykład top=10000 i skip=0 pobiera pierwsze 10000 wierszy danych, top=10000 i skip=10000 pobiera kolejne 10000 wierszy danych.
filter ciąg Co najmniej jedna instrukcja, która filtruje wiersze w odpowiedzi. Każda instrukcja filtru zawiera nazwę pola z treści odpowiedzi i wartość skojarzona z eqoperatorem contains , nelub dla niektórych pól. Instrukcje można łączyć przy użyciu instrukcji and lub or. Wartości ciągów muszą być ujęte w apostrofy w parametrze filtru. Poniższa sekcja zawiera listę pól, które można filtrować, oraz operatory obsługiwane w tych polach.
aggregationLevel ciąg Określa zakres czasu, dla którego mają być pobierane zagregowane dane. Może być jednym z następujących ciągów: dzień, tydzień lub miesiąc. Jeśli wartość nie jest określona, wartość domyślna to dateRange. Uwaga: ten parametr ma zastosowanie tylko wtedy, gdy pole daty jest przekazywane jako część parametru groupBy.
Groupby ciąg Instrukcja, która stosuje agregację danych tylko do określonych pól.

Nagłówki żądań

Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum partnerskiego.

Treść żądania

Brak.

Przykład żądania

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions?groupBy=subscriptionType
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
Content-Type: application/json
Content-Length: 0

Odpowiedź REST

W przypadku powodzenia treść odpowiedzi zawiera kolekcję zasobów subskrypcji pogrupowanych według określonych terminów i dat.

Kody powodzenia i błędów odpowiedzi

Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie oraz dodatkowe informacje o debugowaniu. Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i dodatkowe parametry. Aby uzyskać pełną listę, zobacz Kody błędów.

Przykład odpowiedzi

HTTP/1.1 200 OK
Content-Length: 177
Content-Type: application/json; charset=utf-8
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: aaaa0000-bb11-2222-33cc-444444dddddd
{
  "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
}

Zobacz też

Analiza Centrum partnerskiego — zasoby