Freigeben über

Abonnementsergänzungen abrufen

Verwenden Sie diese Methode in der Microsoft Store-Analyse-API, um aggregierte Kaufdaten für Add-On-Abonnements für Ihre App während eines bestimmten Zeitraums und anderer optionaler Filter abzurufen.

Voraussetzungen

Um diese Methode zu verwenden, müssen Sie zuerst Folgendes ausführen:

  • Falls noch nicht geschehen, füllen Sie alle Voraussetzungen für die Microsoft Store-Analyse-API aus.
  • Holen Sie sich ein Azure AD-Zugriffstoken, um es im Header der Anfrage für diese Methode zu verwenden. Nachdem Sie ein Zugriffstoken abgerufen haben, müssen Sie es 60 Minuten verwenden, bevor es abläuft. Nachdem das Token abgelaufen ist, können Sie eine neue abrufen.

Anfrage

Anforderungssyntax

Methode Anforderungs-URI
ERHALTEN/Bekommen https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions

Anforderungs-Kopfzeile

Kopfzeile Typ BESCHREIBUNG
Autorisierung Schnur Erforderlich. Das Azure AD-Zugriffstoken in der Form Bearer<token>.

Anforderungsparameter

Parameter Typ BESCHREIBUNG Erforderlich
Anwendungs-ID Schnur Die Store-ID der App, für die Sie Abonnement-Add-On-Kaufdaten abrufen möchten. Ja
AbonnementProduktId Schnur Die Store-ID des Abonnement-Add-Ons, für das Sie Kaufdaten abrufen möchten. Wenn Sie diesen Wert nicht angeben, gibt diese Methode Kaufdaten für alle Abonnement-Add-Ons für die angegebene App zurück. Nein
Startdatum Datum Das Startdatum im Datumsbereich von Abonnement-Add-On-Kaufdaten, die abgerufen werden sollen. Der Standardwert ist das aktuelle Datum. Nein
Enddatum Datum Das Enddatum im Datumsbereich von Abonnement-Add-On-Kaufdaten, die abgerufen werden sollen. Der Standardwert ist das aktuelle Datum. Nein
Nach oben INT Die Anzahl der Datenzeilen, die in der Anforderung zurückgegeben werden sollen. Der Maximalwert und der Standardwert, wenn nicht angegeben ist, ist 100. Wenn in der Abfrage weitere Zeilen vorhanden sind, enthält der Antworttext einen nächsten Link, den Sie verwenden können, um die nächste Seite mit Daten anzufordern. Nein
hüpfen INT Die Anzahl der Zeilen, die in der Abfrage übersprungen werden sollen. Verwenden Sie diesen Parameter, um große Datensätze zu durchblättern. Beispielsweise ruft "top=100" und "skip=0" die ersten 100 Datenzeilen ab, "top=100" und "skip=100" die nächsten 100 Datenzeilen usw. Nein
Filter Schnur Eine oder mehrere Anweisungen, die den Antworttext filtern. Jede Anweisung kann die Operatoren eq oder ne verwenden, und Anweisungen können mit und oder mit oderkombiniert werden. Sie können die folgenden Zeichenfolgen in den Filteranweisungen angeben (dies entspricht Werten im Antworttext):
  • Datum
  • subscriptionProductName
  • Name der Anwendung
  • Artikelnummer
  • Markt
  • Gerätetyp

Hier ist ein Beispiel Filterparameter: filter=date eq '2017-07-08'.

 Nein
Aggregationsniveau Schnur Gibt den Zeitraum an, für den aggregierte Daten abgerufen werden sollen. Dies kann eine der folgenden Zeichenfolgen sein: Tag, Wocheoder Monat. Wenn nicht angegeben, ist der Standardwert Tag. Nein
Sortierung nach Schnur Eine Anweisung, die die Ergebnisdatenwerte für jede Erwerbung eines Abonnement-Zusatzmoduls anordnet. Die Syntax lautet orderby=field [order],field [order],.... Der field-Parameter kann eine der folgenden Zeichenfolgen sein:
  • Datum
  • subscriptionProductName
  • Name der Anwendung
  • Artikelnummer
  • Markt
  • Gerätetyp

Der Order-Parameter ist optional und kann asc oder desc sein, um die aufsteigende oder absteigende Reihenfolge für jedes Feld anzugeben. Der Standardwert ist asc.

Hier ist ein Beispiel für eine Orderby-Zeichenfolge : orderby=date,market

 Nein
GruppierenNach Schnur Eine Aussage, die die Datenaggregation nur auf die angegebenen Felder anwendet. Sie können die folgenden Felder angeben:
  • Datum
  • subscriptionProductName
  • Name der Anwendung
  • Artikelnummer
  • Markt
  • Gerätetyp

Der parameter groupby kann mit dem aggregationLevel-Parameter verwendet werden. Beispiel: groupby=market&aggregationLevel=week

 Nein

Beispielanfrage

Die folgenden Beispiele zeigen, wie Sie Abonnement-Add-On-Kaufdaten abrufen. Ersetzen Sie den Wert applicationId durch die entsprechende Store-ID für Ihre App.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions?applicationId=9NBLGGGZ5QDR&startDate=2017-07-07&endDate=2017-07-08 HTTP/1.1
Authorization: Bearer <your access token>

Antwort

Antwortkörper

Wert Typ BESCHREIBUNG
Wert Array Ein Array von Objekten, die aggregierte Abonnement-Add-On-Kaufdaten enthalten. Weitere Informationen zu den Daten in den einzelnen Objekten finden Sie im Abschnitt über die -Abonnementakquisitionswerte unten.
@nextLink Schnur Wenn zusätzliche Datenseiten vorhanden sind, enthält diese Zeichenfolge einen URI, den Sie verwenden können, um die nächste Seite mit Daten anzufordern. Dieser Wert wird beispielsweise zurückgegeben, wenn der top Parameter der Anforderung auf 100 festgelegt ist, es jedoch mehr als 100 Zeilen mit Abonnement-Add-On-Kaufdaten für die Abfrage gibt.
Gesamtzahl INT Die Gesamtanzahl der Zeilen des Abfrageergebnisses.

Abonnementakquisitionswerte

Elemente im Value-Array enthalten die folgenden Werte.

Wert Typ BESCHREIBUNG
Datum Schnur Das erste Datum im Datumsbereich für die Erfassungsdaten. Wenn die Anforderung einen einzelnen Tag angegeben hat, ist dieser Wert dieses Datum. Wenn die Anforderung eine Woche, einen Monat oder einen anderen Datumsbereich angegeben hat, ist dieser Wert das erste Datum in diesem Datumsbereich.
AbonnementProduktId Schnur Die Store-ID des Abonnement-Add-Ons, für das Sie Kaufdaten abrufen.
abonnementProduktName Schnur Der Anzeigename des Abonnement-Add-Ons.
Anwendungs-ID Schnur Die Store-ID der App, für die Sie Daten zum Erwerb von Abonnement-Add-Ons anfordern.
Anwendungsname Schnur Der Anzeigename der App.
SKU-Nummer Schnur Die ID der -SKU des Abonnement-Zusatzmoduls, für das Sie Erwerbsdaten abrufen.
Gerätetyp Schnur Eine der folgenden Zeichenfolgen, die den Gerätetyp angibt, der den Erwerb abgeschlossen hat:
  • PC
  • Telefon
  • Console-Xbox Eins
  • Console-Xbox Serie X
  • Iot
  • Holographisch
  • Unbekannt
Markt Schnur Der ISO 3166-Ländercode des Marktes, auf dem der Erwerb erfolgte.
Währungscode Schnur Der Währungscode im ISO 4217-Format für Bruttoumsatz vor Steuern.
Bruttoverkauf vor Steuern Integer Der Bruttoumsatz in der lokalen Währung, angegeben durch den Wert des Währungscodes.
Gesamtaktiveanzahl Integer Die Anzahl der aktiven Abonnements insgesamt während des angegebenen Zeitraums. Dies entspricht der Summe der goodStandingActiveCount, pendingGraceActiveCount, graceActiveCountund lockedActiveCount Werte.
gesamtChurnAnzahl Integer Die Gesamtzahl der Abonnements, die während des angegebenen Zeitraums deaktiviert wurden. Dies entspricht der Summe der Werte von billingChurnCount, nonRenewalChurnCount, refundChurnCount, chargebackChurnCount, earlyChurnCountund otherChurnCount.
neueZählung Integer Die Anzahl der neuen Abonnementkäufe während des angegebenen Zeitraums, einschließlich Testversionen.
Erneuerungsanzahl Integer Die Anzahl der Abonnementverlängerungen während des angegebenen Zeitraums, einschließlich vom Benutzer initiierter Verlängerungen und automatischer Verlängerungen.
AnzahlAktiverMitgliederInGutemAnsehen Integer Die Anzahl der Abonnements, die während des angegebenen Zeitraums aktiv waren und bei denen das Ablaufdatum der Abfrage dem >= EndDate Wert entspricht.
pendingGraceActiveCount Integer Die Anzahl der Abonnements, die während des angegebenen Zeitraums aktiv waren, bei denen jedoch ein Abrechnungsfehler auftrat, und bei denen das Ablaufdatum des Abonnements >= der EndDate Wert für die Abfrage ist.
GnadenfristAktiveZahl Integer Die Anzahl der Abonnements, die während des angegebenen Zeitraums aktiv waren, aber einen Abrechnungsfehler hatten und wo:
  • Das Ablaufdatum des Abonnements ist <EndDate Wert für die Abfrage.
  • Das Ende der Nachfrist ist >= der Endwert endDate.
GesperrteAktiveAnzahl Integer Die Anzahl der Abonnements, die sich in dunning befanden (d. r., das Abonnement läuft bald ab und Microsoft versucht, Guthaben für die automatische Verlängerung des Abonnements zu erwerben) während des angegebenen Zeitraums und wo:
  • Das Ablaufdatum des Abonnements ist <EndDate Wert für die Abfrage.
  • Das Ende der Nachfrist ist <= der Endwert endDate.
billingChurnCount Integer Die Anzahl der Abonnements, die während des angegebenen Zeitraums deaktiviert wurden, weil eine Abrechnungsgebühr nicht verarbeitet werden konnte und sich die Abonnements zuvor im Mahnprozess befanden.
Nichtverlängerungsabwanderungsanzahl Integer Die Anzahl der Abonnements, die während des angegebenen Zeitraums deaktiviert wurden, da sie nicht verlängert wurden.
refundChurnCount Integer Die Anzahl der Abonnements, die während des angegebenen Zeitraums deaktiviert wurden, da sie erstattet wurden.
RückbuchungChurnCount Integer Die Anzahl der Abonnements, die während des angegebenen Zeitraums aufgrund einer Rückbuchung deaktiviert wurden.
earlyChurnCount Integer Die Anzahl der Abonnements, die während des angegebenen Zeitraums deaktiviert wurden, während sie aktiv waren.
andereChurnAnzahl Integer Die Anzahl der Abonnements, die aus anderen Gründen während des angegebenen Zeitraums deaktiviert wurden.

Beispiel für Anforderung und Antwort

Die folgenden Codeausschnitte zeigen einige Beispielanforderungen und den JSON-Antwortkörper für diese Anforderungen.

Beispielanforderung

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>

Beispielantwort

{
    "Value": [
        {
            "date": "2022-04-18",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "grossSalesBeforeTax": 3460656.260391250,
            "totalActiveCount": 20211321,
            "totalChurnCount": 5605,
            "newCount": 3810366,
            "renewCount": 12102044,
            "goodStandingActiveCount": 17893664,
            "pendingGraceActiveCount": 2255792,
            "graceActiveCount": 61833,
            "lockedActiveCount": 32,
            "billingChurnCount": 4,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 2717,
            "otherChurnCount": 2884
        },
        {
            "date": "2022-04-18",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Unknown",
            "grossSalesBeforeTax": 2342.580615228,
            "totalActiveCount": 50550,
            "totalChurnCount": 7,
            "newCount": 8312,
            "renewCount": 31446,
            "goodStandingActiveCount": 44047,
            "pendingGraceActiveCount": 6503,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 5,
            "otherChurnCount": 2
        }
    ],
    "TotalCount": 2
}

Beispielanforderung

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/subscriptions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=04/20/2022&top=10&skip=0&orderby=date&groupby=date,subscriptionProductName,applicationName,skuId,market,deviceType&aggregationLevel=week
HTTP/1.1
Authorization: Bearer <your access token>

Beispielantwort

{
    "Value": [
        {
            "date": "2022-04-18",
            "subscriptionProductName": "realms.subscription.monthly.10player.01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "skuId": "0100",
            "market": "IT",
            "deviceType": "Console-Xbox One",
            "grossSalesBeforeTax": 0.0,
            "totalActiveCount": 0,
            "totalChurnCount": 0,
            "newCount": 2,
            "renewCount": 0,
            "goodStandingActiveCount": 0,
            "pendingGraceActiveCount": 0,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 0,
            "otherChurnCount": 0
        },
        {
            "date": "2022-04-18",
            "subscriptionProductName": "realms.subscription.monthly.10player.01",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "skuId": "0100",
            "market": "NO",
            "deviceType": "Unknown",
            "grossSalesBeforeTax": 0.0,
            "totalActiveCount": 0,
            "totalChurnCount": 0,
            "newCount": 0,
            "renewCount": 13,
            "goodStandingActiveCount": 0,
            "pendingGraceActiveCount": 0,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 0,
            "otherChurnCount": 0
        },
        {
            "date": "2022-04-18",
            "subscriptionProductName": "realms.subscription.monthly.10player.02",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Windows and Doors",
            "skuId": "0100",
            "market": "CA",
            "deviceType": "Unknown",
            "grossSalesBeforeTax": 0.0,
            "totalActiveCount": 152,
            "totalChurnCount": 0,
            "newCount": 0,
            "renewCount": 270,
            "goodStandingActiveCount": 133,
            "pendingGraceActiveCount": 19,
            "graceActiveCount": 0,
            "lockedActiveCount": 0,
            "billingChurnCount": 0,
            "nonRenewalChurnCount": 0,
            "refundChurnCount": 0,
            "chargebackChurnCount": 0,
            "earlyChurnCount": 0,
            "otherChurnCount": 0
        }
    ],
    "TotalCount": 3
}

 

 

  • Last updated on