Abrufen von Abonnementanalysen, gruppiert nach Datumsangaben oder Begriffen

Artikel
06/19/2023

Gilt für: Partner Center | Partner Center-Betrieb durch 21Vianet | Partner Center für Microsoft Cloud for US Government

Hier erfahren Sie, wie Sie Abonnementanalyseinformationen für Ihre Kunden abrufen, gruppiert nach Datumsangaben oder Bedingungen.

Voraussetzungen

Anmeldeinformationen, wie unter Partner Center-Authentifizierung beschrieben. Dieses Szenario unterstützt nur die Authentifizierung mit Benutzeranmeldeinformationen.

REST-Anforderung

Anforderungssyntax

Methode	Anforderungs-URI
GET	{baseURL}/partner/v1/analytics/subscriptions?groupby={groupby_queries}

URI-Parameter

Verwenden Sie die folgenden erforderlichen Pfadparameter, um Ihre organization zu identifizieren und die Ergebnisse zu gruppieren.

Name	Typ	Erforderlich	BESCHREIBUNG
groupby_queries	Zeichenfolgenpaare und dateTime	Ja	Die Begriffe und Datumsangaben zum Filtern des Ergebnisses.

GroupBy-Syntax

Der Group by-Parameter muss aus einer Reihe von durch Kommas getrennten Feldwerten zusammengesetzt werden.

Ein nicht codiertes Beispiel sieht wie folgt aus:

?groupby=termField1,dateField1,termField2

Die folgende Tabelle enthält eine Liste der unterstützten Felder für gruppieren nach.

Feld	Typ	BESCHREIBUNG
customerTenantId	Zeichenfolge	Eine GUID-formatierte Zeichenfolge, die den Kundenmandanten identifiziert.
customerName	Zeichenfolge	Der Name des Kunden.
customerMarket	Zeichenfolge	Das Land/die Region, in dem der Kunde Geschäfte tätigt.
id	Zeichenfolge	Eine GUID-formatierte Zeichenfolge, die das Abonnement identifiziert.
status	Zeichenfolge	Der Abonnementstatus. Unterstützte Werte sind: "ACTIVE", "SUSPENDED" oder "DEPROVISIONED".
ProductName	Zeichenfolge	Der Name des Produkts.
subscriptionType	Zeichenfolge	Der Abonnementtyp. Hinweis: Bei diesem Feld wird die Groß-/Kleinschreibung beachtet. Unterstützte Werte sind: "Office", "Azure", "Microsoft365", "Dynamics", "EMS".
autoRenewEnabled	Boolean	Ein Wert, der angibt, ob das Abonnement automatisch verlängert wird.
partnerId	Zeichenfolge	Die PartnerID. Bei einem direkten Wiederverkäufer ist dieser Parameter die PartnerID des Partners. Bei einem indirekten Wiederverkäufer ist dieser Parameter die PartnerID des indirekten Wiederverkäufers.
friendlyName	Zeichenfolge	Der Name des Abonnements.
partnerName	Zeichenfolge	Name des Partners, für den das Abonnement erworben wurde
providerName	Zeichenfolge	Wenn die Abonnementtransaktion für den indirekten Wiederverkäufer gilt, ist der Anbietername der indirekte Anbieter, der das Abonnement erworben hat.
creationDate	Zeichenfolge im UTC-Zeitformat (Datum und Uhrzeit)	Das Datum, an dem das Abonnement erstellt wurde.
effectiveStartDate	Zeichenfolge im UTC-Zeitformat (Datum und Uhrzeit)	Das Datum, an dem das Abonnement beginnt.
commitmentEndDate	Zeichenfolge im UTC-Zeitformat (Datum und Uhrzeit)	Das Datum, an dem das Abonnement endet.
currentStateEndDate	Zeichenfolge im UTC-Zeitformat (Datum und Uhrzeit)	Das Datum, an dem sich die aktuelle status des Abonnements ändert.
trialToPaidConversionDate	Zeichenfolge im UTC-Zeitformat (Datum und Uhrzeit)	Das Datum, an dem das Abonnement von der Testversion in die kostenpflichtige Umrechnung umgestellt wird. Der Standardwert ist "null".
trialStartDate	Zeichenfolge im UTC-Zeitformat (Datum und Uhrzeit)	Das Datum, an dem der Testzeitraum für das Abonnement gestartet wurde. Der Standardwert ist "null".
lastUsageDate	Zeichenfolge im UTC-Zeitformat (Datum und Uhrzeit)	Das Datum, an dem das Abonnement zuletzt verwendet wurde. Der Standardwert ist "null".
deprovisionedDate	Zeichenfolge im UTC-Zeitformat (Datum und Uhrzeit)	Das Datum, an dem die Bereitstellung des Abonnements aufgehoben wurde. Der Standardwert ist "null".
lastRenewalDate	Zeichenfolge im UTC-Zeitformat (Datum und Uhrzeit)	Das Datum, an dem das Abonnement zuletzt verlängert wurde. Der Standardwert ist "null".

Filterfelder

In der folgenden Tabelle sind optionale Filterfelder und deren Beschreibungen aufgeführt:

Feld	Typ	BESCHREIBUNG
top	INT	Die Anzahl der Datenzeilen, die in der Anforderung zurückgegeben werden sollen. Wenn der Wert nicht angegeben wird, sind der Höchstwert und der Standardwert 10000. Sind in der Abfrage keine weiteren Zeilen, enthält der Antworttext den Link „Weiter“, über den Sie die nächste Seite mit Daten anfordern können.
skip	INT	Die Anzahl der Zeilen, die in der Abfrage übersprungen werden sollen. Verwenden Sie diesen Parameter, um große Datensätze durchzublättern. Beispielsweise werden mit top=10000 und skip=0 die ersten 10000 Datenzeilen abgerufen, top=10000 und skip=10000 die nächsten 10000 Datenzeilen.
filter	Zeichenfolge	Mindestens eine Anweisung, die die Zeilen in der Antwort filtert. Jede Filter-Anweisung enthält einen Feldnamen aus dem Antworttext und einen Wert, der dem `eq`Operator , `ne`oder für bestimmte Felder `contains` zugeordnet ist. Anweisungen können mit `and` oder `or`kombiniert werden. Zeichenfolgenwerte im Parameter filter müssen von einfachen Anführungszeichen eingeschlossen werden. Im folgenden Abschnitt finden Sie eine Liste der Felder, die gefiltert werden können, sowie die Operatoren, die mit diesen Feldern unterstützt werden.
aggregationLevel	Zeichenfolge	Gibt den Zeitraum an, für den aggregierte Daten abgerufen werden sollen. Dies kann eine der folgenden Zeichenfolgen sein: day, week oder month. Wenn der Wert nicht angegeben ist, ist der Standardwert dateRange. Hinweis: Dieser Parameter gilt nur, wenn ein Datumsfeld als Teil des groupBy-Parameters übergeben wird.
Groupby	Zeichenfolge	Eine Anweisung, die nur auf die angegebenen Felder Datenaggregationen anwendet.

Anforderungsheader

Weitere Informationen finden Sie unter Partner Center-REST-Header.

Anforderungstext

Keine.

Anforderungsbeispiel

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

REST-Antwort

Bei erfolgreicher Ausführung enthält der Antworttext eine Sammlung von Abonnementressourcen , die nach den angegebenen Begriffen und Datumsangaben gruppiert sind.

Erfolgs- und Fehlercodes der Antwort

Jede Antwort enthält einen HTTP-Statuscode, der Aufschluss darüber gibt, ob der Vorgang erfolgreich war, sowie ggf. zusätzliche Debuginformationen. Verwende ein Tool für die Netzwerkablaufverfolgung, um diesen Code, den Fehlertyp und zusätzliche Parameter zu lesen. Die vollständige Liste findest du unter Partner-API: REST-Fehlercodes.

Antwortbeispiel

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
}

Weitere Informationen

Partner Center Analytics – Ressourcen

Freigeben über