Abrufen von Add-On-Käufen
Verwenden Sie diese Methode in der Microsoft Store-Analyse-API, um aggregierte Kaufdaten für Add-Ons für Ihre App im JSON-Format während eines bestimmten Zeitraums und anderer optionaler Filter abzurufen. Diese Informationen sind auch im Bericht "Add-On-Käufe" im Partner Center verfügbar.
Voraussetzungen
Um diese Methode zu verwenden, müssen Sie zuerst Folgendes tun:
- Falls noch nicht geschehen, erfüllen Sie alle Voraussetzungen für die Microsoft Store-Analyse-API.
- Rufen Sie ein Azure AD-Zugriffstoken ab, das im Anforderungsheader für diese Methode verwendet wird. Nachdem Sie ein Zugriffstoken erhalten haben, haben Sie 60 Minuten Zeit, es zu verwenden, bevor es abläuft. Nachdem das Token abgelaufen ist, können Sie eine neue abrufen.
Anforderung
Anforderungssyntax
| Methode | Anforderungs-URI |
|---|---|
| GET | https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions |
Anforderungsheader
| Header | type | BESCHREIBUNG |
|---|---|---|
| Authorization | Zeichenfolge | Erforderlich. Das Azure AD-Zugriffstoken im Formular Bearer<-Token>. |
Anforderungsparameter
Der Parameter applicationId oder inAppProductId ist erforderlich. Um Kaufdaten für alle add-ons abzurufen, die für die App registriert sind, geben Sie den applicationId-Parameter an. Um Kaufdaten für ein einzelnes Add-On abzurufen, geben Sie den Parameter inAppProductId an. Wenn Sie beide angeben, wird der applicationId-Parameter ignoriert.
| Parameter | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
| applicationId | Zeichenfolge | Die Store-ID der App, für die Sie Add-On-Kaufdaten abrufen möchten. | Ja |
| inAppProductId | Zeichenfolge | Die Store-ID des Add-Ons, für das Sie Kaufdaten abrufen möchten. | Ja |
| startDate | Datum | Das Startdatum im Datumsbereich der Add-On-Kaufdaten, die abgerufen werden sollen. Die Standardeinstellung ist das aktuelle Datum. | Nein |
| endDate | Datum | Das Enddatum im Datumsbereich der Add-On-Kaufdaten, die abgerufen werden sollen. Die Standardeinstellung ist das aktuelle Datum. | Nein |
| Oben | INT | Die Anzahl der Datenzeilen, die in der Anforderung zurückgegeben werden sollen. Der Höchstwert und der Standardwert, falls nicht angegeben, ist 10000. 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 |
| skip | INT | Die Anzahl der Zeilen, die in der Abfrage übersprungen werden sollen. Verwenden Sie diesen Parameter, um große Datasets zu durchlaufen. Beispielsweise ruft top=10000 und skip=0 die ersten 10000 Datenzeilen ab, top=100000 und skip=10000 ruft die nächsten 10000 Datenzeilen usw. ab. | Nein |
| filter | Zeichenfolge | Eine oder mehrere Anweisungen, die die Zeilen in der Antwort filtern. Weitere Informationen finden Sie im Abschnitt zu Filterfelder weiter unten. | Nein |
| aggregationLevel | Zeichenfolge | Gibt den Zeitraum an, für den aggregierte Daten abgerufen werden sollen. Dies kann eine der folgenden Zeichenfolgen sein: Tag, Woche oder Monat. Wenn keine Angabe erfolgt, lautet der Standardwert Tag. | Nein |
| orderby | Zeichenfolge | Eine Anweisung, die die Ergebnisdatenwerte für jeden Add-On-Kauf anordnet. Die Syntax ist orderby=Feld [order], Feld [order],.... Der Feld-Parameter kann eine der folgenden Zeichenfolgen sein:
Der Order-Parameter ist optional und kann asc oder desc sein, um die aufsteigende oder absteigende Reihenfolge für jedes Feld anzugeben. Die Standardeinstellung ist asc. Hier ist ein Beispiel für eine orderby-Zeichenfolge: orderby=date,market |
Nein |
| groupby | Zeichenfolge | Eine Anweisung, die Datenaggregation nur auf die angegebenen Felder anwendet. Sie können die folgenden Felder angeben:
Die zurückgegebenen Datenzeilen enthalten die im groupby-Parameter angegebenen Felder sowie Folgendes:
Der groupby-Parameter kann mit dem aggregationLevel-Parameter verwendet werden. Zum Beispiel: &groupby=ageGroup,market&aggregationLevel=week |
Nein |
Filter (Felder)
Der Filter-Parameter der Anforderung enthält eine oder mehrere Anweisungen, die die Zeilen in der Antwort filtern. Jede Anweisung enthält ein Feld und einen Wert, die den Operatoren eq oder ne zugeordnet sind, und Anweisungen können mithilfe und oder oder kombiniert werden. Hier sind einige Beispiel-Filter-Parameter:
- filter=market eq 'US' und gender eq 'm'
- filter=(market ne 'US') and (gender ne 'Unknown') and (gender ne 'm') and (market ne 'NO') and (ageGroup ne 'greater than 55' or ageGroup ne 'less than 13')
Eine Liste der unterstützten Felder finden Sie in der folgenden Tabelle. Zeichenfolgenwerte müssen von einfachen Anführungszeichen im Filter-Parameter umgeben sein.
| Felder | Beschreibung |
|---|---|
| acquisitionType | Eine der folgenden Zeichenfolgen:
|
| ageGroup | Eine der folgenden Zeichenfolgen:
|
| storeClient | Eine der folgenden Zeichenfolgen:
|
| gender | Eine der folgenden Zeichenfolgen:
|
| market | Eine Zeichenfolge, die den ISO 3166-Ländercode des Marktes enthält, auf dem der Kauf erfolgte. |
| osVersion | Eine der folgenden Zeichenfolgen:
|
| deviceType | Eine der folgenden Zeichenfolgen:
|
| orderName | Eine Zeichenfolge, die den Namen der Bestellung für den Werbecode angibt, der zum Abrufen des Add-Ons verwendet wurde (dies gilt nur, wenn der Benutzer das Add-On durch Einlösen eines Werbecodes erworben hat). |
Beispiel für eine Anfrage
In den folgenden Beispielen werden verschiedene Anforderungen zum Abrufen von Add-On-Kaufdaten veranschaulicht. Ersetzen Sie die Werte inAppProductId und applicationId durch die entsprechende Store-ID für Ihr Add-On oder Ihre App.
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?inAppProductId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?inAppProductId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=7/3/2015&top=100&skip=0&filter=market ne 'US' and gender ne 'Unknown' and gender ne 'm' and market ne 'NO' and ageGroup ne '>55' HTTP/1.1
Authorization: Bearer <your access token>
Antwort
Antworttext
| Wert | type | BESCHREIBUNG |
|---|---|---|
| Wert | array | Ein Array von Objekten, die aggregierte Add-On-Kaufdaten enthalten. Weitere Informationen zu den Daten in den einzelnen Objekten finden Sie im Abschnitt Add-On-Akquisitionswerte weiter unten. |
| @nextLink | Zeichenfolge | 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 oberste Parameter der Anforderung auf 10000 festgelegt ist, aber für die Abfrage mehr als 10000 Zeilen mit Add-On-Kaufdaten vorhanden sind. |
| TotalCount | INT | Die Gesamtanzahl der Zeilen im Datenergebnis für die Abfrage. |
Add-On-Akquisitionswerte
Elemente im Value-Array enthalten die folgenden Werte.
| Wert | type | Beschreibung |
|---|---|---|
| Datum | Zeichenfolge | Das erste Datum im Datumsbereich für die Kaufdaten. 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. |
| inAppProductId | Zeichenfolge | Die Store-ID des Add-Ons, für das Sie Kaufdaten abrufen. |
| inAppProductName | Zeichenfolge | Der Anzeigename des Add-ons. Dieser Wert wird nur in den Antwortdaten angezeigt, wenn der aggregationLevel-Parameter auf Tag festgelegt ist, es sei denn, Sie geben das inAppProductName-Feld im groupby-Parameter an. |
| applicationId | Zeichenfolge | Die Store-ID der App, für die Sie Add-On-Kaufdaten abrufen möchten. |
| applicationName | Zeichenfolge | Der Anzeigename der App. |
| deviceType | Zeichenfolge | Der Gerätetyp, der den Kauf abgeschlossen hat. Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder |
| orderName | Zeichenfolge | Der Name der Bestellung. |
| storeClient | Zeichenfolge | Die Version des Stores, in der der Kauf erfolgte. Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder |
| osVersion | Zeichenfolge | Die Betriebssystemversion, auf der der Kauf erfolgte. Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder |
| market | Zeichenfolge | Der ISO 3166-Ländercode des Marktes, auf dem der Kauf erfolgte. |
| gender | Zeichenfolge | Das Geschlecht des Benutzers, der den Kauf getätigt hat. Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder |
| ageGroup | Zeichenfolge | Die Altersgruppe des Benutzers, der den Kauf getätigt hat. Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder |
| acquisitionType | Zeichenfolge | Die Art des Erwerbs (kostenlos, bezahlt usw.). Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder |
| acquisitionQuantity | integer | Die Anzahl der erfolgten Käufe. |
Beispiel für Anforderung und Antwort
Der folgende Codeausschnitt veranschaulicht einen Beispieltext für Anforderungs- und JSON-Antwort für diese Anforderung.
Beispiel-Anfrage
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappacquisitions?applicationId=9NBLGGGZ5QDR
HTTP/1.1
Authorization: Bearer <your access token>
Beispiel für eine Antwort
{
"Value": [
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Deluxe Collector's Edition",
"addonProductId": "9NBLGGAAGZDQ",
"date": "2022-07-29",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 18.12,
"purchasePriceLocalAmount": 18.12,
"purchaseTaxUSDAmount": 1.13,
"purchaseTaxLocalAmount": 1.13
},
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Episode 4",
"addonProductId": "9NAAAAAAAAAQ",
"date": "2017-01-07",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 4.147206,
"purchasePriceLocalAmount": 3.99,
"purchaseTaxUSDAmount": 0.686004,
"purchaseTaxLocalAmount": 0.66
},
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Deluxe Collector's Edition",
"addonProductId": "9NALGGGZ5QDQ",
"date": "2018-04-01",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 1.99,
"purchasePriceLocalAmount": 1.99,
"purchaseTaxUSDAmount": 0.0,
"purchaseTaxLocalAmount": 0.0
},
{
"applicationId": "9NBLGGGZ5QDR",
"inAppProductName": "Strategy Guide Episode 4",
"addonProductId": "9NBLGGGZ5QDQ",
"date": "2021-11-25",
"acquisitionQuantity": 1,
"purchasePriceUSDAmount": 1.31902922876179,
"purchasePriceLocalAmount": 150.0,
"purchaseTaxUSDAmount": 0.114315866492689,
"purchaseTaxLocalAmount": 13.0
},
],
"TotalCount": 4,
"DataFreshnessTimestamp": "2022-07-29T05:54:00"
}
Zugehörige Themen
- Bericht zu Add-On-Käufen
- Zugreifen auf Analysedaten mithilfe von Microsoft Store-Diensten
- Abrufen von Add-On-Konvertierungen nach Kanal
- Abrufen von App-Käufen
- Abrufen von App-Erwerbstrichterdaten
- Abrufen von App-Konvertierungen nach Kanal
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für