Abrufen von App-Käufen

  • Artikel

Verwenden Sie diese Methode in der Microsoft Store-Analyse-API, um gesammelte Kaufdaten im JSON-Format für eine Anwendung während eines bestimmten Zeitraums und andere optionale Filter abzurufen. Diese Informationen sind auch im Bericht "Käufe" im Partner Center verfügbar.

Voraussetzungen

Um diese Methode zu verwenden, müssen Sie zuerst folgendes tun:

Anforderung

Anforderungssyntax

Methode Anforderungs-URI
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions

Anforderungsheader

Header type BESCHREIBUNG
Authorization Zeichenfolge Erforderlich. Das Azure AD-Zugriffstoken im Formular Bearer<-Token>.

Anforderungsparameter

Parameter Typ Beschreibung Erforderlich
applicationId Zeichenfolge Die Store-ID der App, für die Sie Kaufdaten abrufen möchten. Ja
startDate Datum Das Startdatum im Datumsbereich der abzurufenden Kaufdaten. Der Standardwert ist das aktuelle Datum. Nein
endDate Datum Das Enddatum im Datumsbereich der abzurufenden Kaufdaten. Der Standardwert ist das aktuelle Datum. Nein
Oben INT Die Anzahl der Datenzeilen, die in der Anforderung ausgegeben werden sollen. Der Maximalwert und der Standardwert ist 1000 (wenn nicht anders festgelegt). Wenn in der Abfrage weitere Zeilen vorhanden sind, enthält der Antworttext einen Link “Weiter“, den Sie verwenden können, um die nächste Seite mit Daten anzufordern. Nein
skip INT Die Anzahl der Zeilen in der Anforderung, die ü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 ab, usw. Nein
filter Zeichenfolge Eine oder mehrere Anweisungen, die die Zeilen in der Antwort filtern. Jede Anweisung enthält einen Feldnamen aus dem Antworttext und Wert, die dem Eq- oder ne-Operator zugeordnet sind, und Anweisungen können mit und oder oder kombiniert werden. Zeichenfolgenwerte müssen von einfachen Anführungszeichen im Filterparameter umgeben sein. Beispielsweise filter=market eq 'US' und gender eq 'm'.

Sie können die folgenden Felder im Antworttext angeben:

  • KaufTyp
  • Altersgruppe
  • StoreClient
  • Geschlecht
  • Markt
  • osVersion
  • GeräteTyp
  • BestellungName
 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 Kauf anordnet. Die Syntax ist orderby=field [order],field [order],.... Der Feldparameter kann eine der folgenden Zeichenfolgen sein:
  • date
  • KaufTyp
  • Altersgruppe
  • StoreClient
  • Geschlecht
  • Markt
  • osVersion
  • GeräteTyp
  • BestellungName

Der Parameter Bestellung 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 folgende Felder angeben:
  • date
  • applicationName
  • KaufTyp
  • Altersgruppe
  • StoreClient
  • Geschlecht
  • Markt
  • osVersion
  • GeräteTyp
  • BestellungName

Die zurückgegebenen Datenzeilen enthalten die im Groupby-Parameter angegebenen Felder sowie folgendes:

  • Datum
  • applicationId
  • Kaufmenge

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

 Nein

Beispiel für eine Anfrage

Im folgenden Beispiel werden mehrere Anforderungen zum Abrufen von App-Kaufdaten veranschaulicht. Ersetzen Sie den applicationId-Wert durch die Store-ID für Ihre App.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?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/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and gender eq 'm'  HTTP/1.1
Authorization: Bearer <your access token>

Antwort

Antworttext

Wert type BESCHREIBUNG
Wert array Eine Matrix von Objekten, die aggregierte Kaufdaten für die App enthalten. Weitere Informationen zu den Daten in den einzelnen Objekten finden Sie unten im Abschnitt Akquisitionswerte‭.
@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, für die Abfrage jedoch mehr als 10000 Zeilen mit Kaufdaten vorhanden sind.
TotalCount INT Die Gesamtanzahl der Zeilen in den Datenergebnissen einer Abfrage

Akquisitionswerte

Elemente in der Matrix Wert enthalten die folgenden Werte.

Wert Typ 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.
applicationId Zeichenfolge Die Store-ID der App, für die Sie Kaufdaten abrufen.
applicationName Zeichenfolge Der Anzeigename der App.
deviceType Zeichenfolge Eine der folgenden Zeichenfolgen, die den Typ des Geräts angibt, auf dem der Kauf durchgeführt wurde:
  • PC
  • Telefonnummer
  • Konsolen-Xbox One
  • Konsolen-Xbox Series X
  • IoT
  • Holographisch
  • Unbekannt
BestellungName Zeichenfolge Der Name der Bestellung.
storeClient Zeichenfolge Eine der folgenden Zeichenfolgen, die die Version des Stores angibt, in dem der Kauf erfolgte:
  • Windows Telefon Store (Client)
  • Microsoft Store (Client) (oder Windows Store (Client) bei Abfragen nach Daten vor dem 23. März 2018)
  • Microsoft Store (Web) (oder Windows Store (Web) bei Abfragen nach Daten vor dem 23. März 2018)
  • Volumenkauf durch Organisationen
  • Andere
osVersion Zeichenfolge Eine der folgenden Zeichenfolgen, die die Betriebssystemversion angibt, über die der Kauf durchgeführt wurde:
  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Phone 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Unbekannt
market Zeichenfolge Der Ländercode ISO 3166 des Marktes, auf dem der Kauf erfolgte.
gender Zeichenfolge Eine der folgenden Zeichenfolgen, die das Geschlecht des Benutzers angibt, der den Kauf getätigt hat:
  • m
  • f
  • Unbekannt
ageGroup Zeichenfolge Eine der folgenden Zeichenfolgen, die die Altersgruppe des Benutzers angibt, der den Kauf getätigt hat:
  • Jünger als 13
  • 13-17
  • 18-24
  • 25-34
  • 35-44
  • 44-55
  • Älter als 55
  • Unbekannt
KaufTyp Zeichenfolge Eine der folgenden Zeichenfolgen, die den Typ des Kaufs angibt:
  • Kostenlos
  • Testversion
  • Bezahlt
  • Angebotscode
  • Lap
  • Abonnement-Lap
  • Private Zielgruppe
  • Vorbestellung
  • Xbox Game Pass (oder Game Pass, wenn Daten vor dem 23. März 2018 abgefragt werden)
  • Datenträger
  • Prepaid-Code
Kaufmenge Zahl Die Anzahl der Käufe, die während der angegebenen Aggregationsebene aufgetreten sind.

Beispiel Anforderung und Antwort

Die folgenden Codeausschnitte zeigen beispielweise Anforderungs- und JSON-Antworttext für diese Anforderung.

Beispiel-Anfrage

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

Beispiel für eine Antwort

{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "date": "2022-07-29",
            "acquisitionQuantity": 7,
            "purchasePriceUSDAmount": 0.0,
            "purchasePriceLocalAmount": 0.0,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
  ],
  "TotalCount": 1,
  "DataFreshnessTimestamp": "2022-07-29T08:42:00"
}

Beispiel-Anfrage

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions?applicationId=9NBLGGGZ5QDR&startDate=8/1/2021&endDate=12/21/2021&skip=0&filter=market&groupby=date,applicationName,acquisitionType,ageGroup,storeClient,gender,market,osVersion,deviceType  HTTP/1.1
Authorization: Bearer <your access token>

Beispiel für eine Antwort

	{
    "Value": [
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "acquisitionType": "Free",
            "storeClient": "Microsoft Store (client)",
            "gender": "f",
            "market": "TW",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "date": "2021-08-01",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 0.0,
            "purchasePriceLocalAmount": 0.0,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
        {
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "acquisitionType": "Free",
            "storeClient": "Microsoft Store (client)",
            "gender": "Unknown",
            "market": "BR",
            "osVersion": "Windows 10",
            "deviceType": "PC",
            "date": "2021-08-01",
            "acquisitionQuantity": 1,
            "purchasePriceUSDAmount": 0.0,
            "purchasePriceLocalAmount": 0.0,
            "purchaseTaxUSDAmount": 0.0,
            "purchaseTaxLocalAmount": 0.0
        },
      ],  
  "TotalCount": 2,
  "DataFreshnessTimestamp": "2022-07-29T08:42:00"
 }