Freigeben über


Add-Ons erwerben

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 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/inappacquisitions

Anforderungs-Kopfzeile

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

Anforderungsparameter

Die applicationId oder inAppProductId Parameter sind erforderlich. Um Kaufdaten für alle Add-ons abzurufen, die für die App registriert sind, geben Sie den Parameter applicationId an. Um die Kaufdaten für ein einzelnes Add-On zu erhalten, geben Sie den Parameter inAppProductId an. Wenn Sie beides angeben, wird der applicationId Parameter ignoriert.

Parameter Typ BESCHREIBUNG Erforderlich
Anwendungs-ID Schnur Die Store-ID der App, für die Sie Add-On-Kaufdaten abrufen möchten. Ja
In-App-Produkt-ID Schnur Die Store-ID des Add-Ons, für das Sie Kaufdaten abrufen möchten. Ja
Startdatum Datum Das Startdatum im Datumsbereich der Erweiterungserwerbsdaten, die abgerufen werden sollen. Der Standardwert ist das aktuelle Datum. Nein
Enddatum Datum Das Enddatum im Datumsbereich der 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 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
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=10000 und skip=0 die ersten 10000 Datenzeilen ab, top=100000 und skip=10000 ruft die nächsten 10000 Datenzeilen usw. ab. Nein
Filter Schnur Eine oder mehrere Aussagen, die die Zeilen in der Antwort filtern. Für weitere Informationen siehe den Abschnitt Filterfelder weiter unten. 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 jeden Add-On-Kauf anordnet. Die Syntax lautet orderby=field [order],field [order],.... Der field-Parameter kann eine der folgenden Zeichenfolgen sein:
  • Datum
  • Erwerbsart
  • Altersgruppe-
  • Kunde speichern
  • Geschlecht
  • Markt
  • Betriebssystemversion
  • Gerätetyp
  • Name der Bestellung

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
  • Name der Anwendung
  • inAppProduktname
  • Erwerbsart
  • Altersgruppe-
  • Kunde speichern
  • Geschlecht
  • Markt
  • Betriebssystemversion
  • Gerätetyp
  • Name der Bestellung

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

  • Datum
  • Anwendungs-ID
  • inAppProduktId
  • Anschaffungsmenge

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

Nein

Filterfelder

Der Filter Parameter der Anforderung enthält eine oder mehrere Anweisungen, mit denen die Zeilen in der Antwort gefiltert werden. Jede Aussage enthält ein Feld und einen Wert, die den Operatoren eq oder ne zugeordnet sind, und Aussagen können mithilfe von und oder oderkombiniert werden. Dies sind einige Beispiele für Filterparameter:

  • filter=market eq 'US' und gender eq 'm'
  • filter=(market ne 'US') and (gender ne 'Unbekannt') and (gender ne 'm') and (market ne 'NO') and (ageGroup ne 'größer als 55' or ageGroup ne 'weniger als 13')

Eine Liste der unterstützten Felder finden Sie in der folgenden Tabelle. Zeichenfolgenwerte müssen von einfachen Anführungszeichen im Filterparameter umgeben sein.

Felder BESCHREIBUNG
Erwerbstyp Eine der folgenden Zeichenfolgen:
  • kostenlos
  • Versuch
  • bezahlte
  • Rabattcode
  • Iap
Altersgruppe Eine der folgenden Zeichenfolgen:
  • weniger als 13
  • 13-17
  • 18-24
  • 25-34
  • 35-44
  • 44-55
  • größer als 55
  • Unbekannt
storeClient Eine der folgenden Zeichenfolgen:
  • 'Windows Phone Store' (Kunde)
  • Microsoft Store (Client)
  • Microsoft Store im Web
  • Mengenabnahme durch Unternehmen
  • Andere
Geschlecht Eine der folgenden Zeichenfolgen:
  • m
  • f
  • Unbekannt
Markt Eine Zeichenfolge, die den ISO 3166-Ländercode des Marktes enthält, auf dem der Kauf erfolgte.
osVersion Eine der folgenden Zeichenfolgen:
  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Phone 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Unbekannt
Gerätetyp Eine der folgenden Zeichenfolgen:
  • PC
  • Telefon
  • Console-Xbox Eins
  • Console-Xbox Serie X
  • Iot
  • Holographisch
  • Unbekannt
Bestellname Eine Zeichenfolge, die den Namen der Bestellung für den Werbecode angibt, der zum Erwerb des Add-Ons verwendet wurde (dies gilt nur, wenn der Benutzer das Add-On durch Einlösen eines Werbecodes erworben hat).

Beispielanfrage

In den folgenden Beispielen werden verschiedene Anfragen zum Abruf von Daten über den Erwerb von Add-Ons veranschaulicht. Ersetzen Sie die Werte von 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

Antwortkörper

Wert Typ BESCHREIBUNG
Wert Array Ein Array von Objekten, die aggregierte Daten zu Add-On-Erwerbungen enthalten. Weitere Informationen zu den Daten in den einzelnen Objekten finden Sie in den Add-On-Kaufwerten Abschnitt 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. Zum Beispiel wird dieser Wert zurückgegeben, wenn der top Parameter der Anforderung auf 10000 festgelegt ist, aber mehr als 10000 Zeilen mit Erwerbsdaten für Add-ons für die Abfrage vorhanden sind.
Gesamtzahl INT Die Gesamtanzahl der Zeilen des Abfrageergebnisses.

Erweiterungskaufwerte

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.
In-App-Produkt-ID Schnur Die Store-ID des Add-Ons, für das Sie Kaufdaten abrufen.
In-App-Produktname Schnur Der Anzeigename des Add-Ons. Dieser Wert wird nur in den Antwortdaten angezeigt, wenn der Parameter aggregationLevel auf Tagfestgelegt ist, es sei denn, Sie geben das Feld inAppProductName im groupby Parameter an.
Anwendungs-ID Schnur Die Store-ID der App, für die Sie Add-On-Kaufdaten abrufen möchten.
Anwendungsname Schnur Der Anzeigename der App.
Gerätetyp Schnur Der Gerätetyp, der die Übernahme abgeschlossen hat. Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder.
Bestellname Schnur Der Name der Bestellung.
storeClient Schnur Die Version des Stores, in der der Kauf erfolgte. Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder.
osVersion Schnur Die Betriebssystemversion, auf der der Erwerb erfolgte. Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder.
Markt Schnur Der ISO 3166-Ländercode des Marktes, auf dem der Erwerb erfolgte.
Geschlecht Schnur Das Geschlecht des Benutzers, der den Kauf getätigt hat. Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder.
Altersgruppe Schnur Die Altersgruppe des Benutzers, der den Kauf getätigt hat. Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder.
Erwerbstyp Schnur Die Art des Erwerbs (kostenlos, bezahlt usw.). Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder.
Erwerbsmenge Integer Die Anzahl der Übernahmen, die stattgefunden haben.

Beispiel für Anforderung und Antwort

Der folgende Codeausschnitt zeigt eine Beispielanforderung und den JSON-Antwortinhalt für diese Anforderung.

Beispielanforderung

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

Beispielantwort

{
    "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"
}