Abrufen von App-KäufenGet app acquisitions

Verwenden Sie diese Methode in der Microsoft Store Analytics-API, um aggregierte Erwerbs Daten im JSON-Format für eine Anwendung während eines bestimmten Datums Bereichs und anderen optionalen Filtern zu erhalten.Use this method in the Microsoft Store analytics API to get aggregate acquisition data in JSON format for an application during a given date range and other optional filters. Diese Informationen finden Sie auch im Partner Center im Bericht über Käufe .This information is also available in the Acquisitions report in Partner Center.

VoraussetzungenPrerequisites

Zur Verwendung dieser Methode sind folgende Schritte erforderlich:To use this method, you need to first do the following:

  • Wenn Sie dies nicht bereits getan haben, müssen Sie alle Voraussetzungen für die Microsoft Store Analytics-API erfüllen.If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • Rufen Sie ein Azure AD-Zugriffstoken ab, das im Anforderungsheader für diese Methode verwendet wird.Obtain an Azure AD access token to use in the request header for this method. Nachdem Sie ein Zugriffstoken erhalten haben, haben Sie 60 Minuten Zeit, es zu verwenden, bevor es abläuft.After you obtain an access token, you have 60 minutes to use it before it expires. Wenn das Token abgelaufen ist, können Sie ein neues abrufen.After the token expires, you can obtain a new one.

AnforderungRequest

AnforderungssyntaxRequest syntax

MethodeMethod Anforderungs-URIRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appacquisitions

AnforderungsheaderRequest header

HeaderHeader typeType BESCHREIBUNGDescription
AuthorizationAuthorization Zeichenfolgestring Erforderlich.Required. Das Azure AD-Zugriffstoken im Format Bearer <token>.The Azure AD access token in the form Bearer <token>.

AnforderungsparameterRequest parameters

ParameterParameter typeType BESCHREIBUNGDescription ErforderlichRequired
applicationIdapplicationId Zeichenfolgestring Die Speicher-ID der APP, für die Sie Erfassungsdaten abrufen möchten.The Store ID of the app for which you want to retrieve acquisition data. JaYes
startDatestartDate datedate Das Startdatum im Datumsbereich der Kaufdaten, die abgerufen werden sollen.The start date in the date range of acquisition data to retrieve. Als Standardeinstellung wird das aktuelle Datum festgelegt.The default is the current date. NeinNo
endDateendDate datedate Das Enddatum im Datumsbereich der Kaufdaten, die abgerufen werden sollen.The end date in the date range of acquisition data to retrieve. Als Standardeinstellung wird das aktuelle Datum festgelegt.The default is the current date. NeinNo
toptop INTint Die Anzahl der Datenzeilen, die in der Anforderung zurückgegeben werden sollen.The number of rows of data to return in the request. Der Maximal- und Standardwert ist 10.000, wenn nicht anders angegeben.The maximum value and the default value if not specified is 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.If there are more rows in the query, the response body includes a next link that you can use to request the next page of data. NeinNo
skipskip INTint Die Anzahl der Zeilen, die in der Abfrage übersprungen werden sollen.The number of rows to skip in the query. Verwenden Sie diesen Parameter, um große Datensätze durchzublättern.Use this parameter to page through large data sets. Beispielsweise rufen „top=10000“ und „skip=0“ die ersten 10.000 Datenzeilen ab, „top=10000“ und „skip=10000“ die nächsten 10.000 Datenzeilen usw.For example, top=10000 and skip=0 retrieves the first 10000 rows of data, top=10000 and skip=10000 retrieves the next 10000 rows of data, and so on. NeinNo
filterfilter Zeichenfolgestring Mindestens eine Anweisung, die die Zeilen in der Antwort filtert.One or more statements that filter the rows in the response. Jede-Anweisung enthält einen Feldnamen aus dem Antworttext und den Wert, die den EQ -oder ne -Operatoren zugeordnet sind, und-Anweisungen können mithilfe von and oder orkombiniert werden.Each statement contains a field name from the response body and value that are associated with the eq or ne operators, and statements can be combined using and or or. Zeichenfolgenwerte im Parameter filter müssen von einfachen Anführungszeichen eingeschlossen werden.String values must be surrounded by single quotes in the filter parameter. Beispiel: Filter = Market EQ ' US ' und Geschlecht EQ 'm '.For example, filter=market eq 'US' and gender eq 'm'.

Sie können die folgenden Felder aus dem Antworttext angeben:You can specify the following fields from the response body:

  • acquisitionTypeacquisitionType
  • ageGroupageGroup
  • storeClientstoreClient
  • gendergender
  • Marktforschungsmarket
  • osVersionosVersion
  • deviceTypedeviceType
  • orderNameorderName
NeinNo
aggregationLevelaggregationLevel Zeichenfolgestring Gibt den Zeitraum an, für den aggregierte Daten abgerufen werden sollen.Specifies the time range for which to retrieve aggregate data. Dies kann eine der folgenden Zeichenfolgen sein: day, week oder month.Can be one of the following strings: day, week, or month. Wenn keine Angabe erfolgt, lautet der Standardwert day.If unspecified, the default is day. NeinNo
orderbyorderby Zeichenfolgestring Eine Anweisung, die die Ergebnisdatenwerte für die einzelnen Käufe anfordert.A statement that orders the result data values for each acquisition. Die Syntax lautet OrderBy = Field [Order], Field [Order],.... Der Feld Parameter kann eine der folgenden Zeichen folgen sein:The syntax is orderby=field [order],field [order],.... The field parameter can be one of the following strings:
  • datedate
  • acquisitionTypeacquisitionType
  • ageGroupageGroup
  • storeClientstoreClient
  • gendergender
  • Marktforschungsmarket
  • osVersionosVersion
  • deviceTypedeviceType
  • orderNameorderName

Der Parameter order ist optional und kann asc oder desc sein, um die auf- oder absteigende Anordnung der einzelnen Felder anzugeben.The order parameter is optional, and can be asc or desc to specify ascending or descending order for each field. Der Standardwert ist ASC.The default is asc.

Hier ist ein Beispiel für eine OrderBy -Zeichenfolge: OrderBy = Date, MarketHere is an example orderby string: orderby=date,market

NeinNo
groupbygroupby Zeichenfolgestring Eine Anweisung, die nur auf die angegebenen Felder Datenaggregationen anwendet.A statement that applies data aggregation only to the specified fields. Sie können die folgenden Felder angeben:You can specify the following fields:
  • datedate
  • applicationNameapplicationName
  • acquisitionTypeacquisitionType
  • ageGroupageGroup
  • storeClientstoreClient
  • gendergender
  • Marktforschungsmarket
  • osVersionosVersion
  • deviceTypedeviceType
  • orderNameorderName

Die zurückgegebenen Datenzeilen enthalten die Felder, die im Parameter groupby angegeben sind, sowie die folgenden:The returned data rows will contain the fields specified in the groupby parameter as well as the following:

  • datedate
  • applicationIdapplicationId
  • acquisitionQuantityacquisitionQuantity

Der Parameter groupby kann mit dem Parameter aggregationLevel verwendet werden.The groupby parameter can be used with the aggregationLevel parameter. Beispiel: & GroupBy = AgeGroup, Market & aggregationlevel = WeekFor example: &groupby=ageGroup,market&aggregationLevel=week

NeinNo

AnforderungsbeispielRequest example

Das folgende Beispiel zeigt verschiedene Anforderungen für den Abruf von Kaufdaten für Apps.The following example demonstrates several requests for getting app acquisition data. Ersetzen Sie den applicationId-Wert durch die Store-ID Ihrer App.Replace the applicationId value with the Store ID for your 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>

AntwortResponse

AntworttextResponse body

WertValue typeType BESCHREIBUNGDescription
WertValue arrayarray Ein Array von-Objekten, die aggregierte Erfassungsdaten für die APP enthalten.An array of objects that contain aggregate acquisition data for the app. Weitere Informationen zu den Daten in den einzelnen Objekten finden Sie unten im Abschnitt Kaufwerte.For more information about the data in each object, see the acquisition values section below.
@nextLink Zeichenfolgestring Wenn weitere Seiten mit Daten vorhanden sind, enthält diese Zeichenfolge einen URI, mit dem Sie die nächste Seite mit Daten anfordern können.If there are additional pages of data, this string contains a URI that you can use to request the next page of data. Beispielsweise wird dieser Wert zurückgegeben, wenn der Parameter top der Anforderung auf 10000 festgelegt ist, es jedoch mehr als 10.000 Zeilen mit Kaufdaten für die Abfrage gibt.For example, this value is returned if the top parameter of the request is set to 10000 but there are more than 10000 rows of acquisition data for the query.
TotalCountTotalCount INTint Die Gesamtzahl der Zeilen im Datenergebnis für die Abfrage.The total number of rows in the data result for the query.

KaufwerteAcquisition values

Elemente im Array Value enthalten die folgenden Werte.Elements in the Value array contain the following values.

WertValue typeType BESCHREIBUNGDescription
datedate Zeichenfolgestring Das erste Datum im Datumsbereich für die Kaufdaten.The first date in the date range for the acquisition data. Wenn die Anforderung einen einzelnen Tag angibt, ist dieses Datum dieser Wert.If the request specified a single day, this value is that date. Wenn die Anforderung eine Woche, einen Monat oder einen anderen Datumsbereich angibt, ist dieser Wert das erste Datum in diesem Datumsbereich.If the request specified a week, month, or other date range, this value is the first date in that date range.
applicationIdapplicationId Zeichenfolgestring Die Store-ID der App, für die Sie Kaufdaten abrufen.The Store ID of the app for which you are retrieving acquisition data.
applicationNameapplicationName Zeichenfolgestring Der Anzeigename der App.The display name of the app.
deviceTypedeviceType Zeichenfolgestring Eine der folgenden Zeichen folgen, die den Typ des Geräts angibt, auf dem der Erwerb erfolgt ist:One of the following strings that specifies the type of device on which the acquisition occurred:
  • PCPC
  • SmartphonePhone
  • Konsole-Xbox OneConsole-Xbox One
  • Konsole-Xbox Series XConsole-Xbox Series X
  • IoTIoT
  • HolographicHolographic
  • UnbekanntUnknown
orderNameorderName Zeichenfolgestring Der Name der Bestellung.The name of the order.
storeClientstoreClient Zeichenfolgestring Eine der folgenden Zeichen folgen, die die Version des Speicher Orts angibt, in dem der Erwerb erfolgt ist:One of the following strings that indicates the version of the Store where the acquisition occurred:
  • Windows Phone Store (client)Windows Phone Store (client)
  • Microsoft Store (Client) (oder Windows Store (Client) bei der Abfrage von Daten vor dem 23. März 2018)Microsoft Store (client) (or Windows Store (client) if querying for data before March 23, 2018)
  • Microsoft Store (Web) (oder Windows Store (Web) , wenn vor dem 23. März 2018 Daten abgefragt werden sollen)Microsoft Store (web) (or Windows Store (web) if querying for data before March 23, 2018)
  • Volume purchase by organizationsVolume purchase by organizations
  • AndereOther
osVersionosVersion Zeichenfolgestring Eine der folgenden Zeichen folgen, die die Betriebssystemversion angibt, auf der der Erwerb erfolgt ist:One of the following strings that specifies the OS version on which the acquisition occurred:
  • Windows Phone 7.5Windows Phone 7.5
  • Windows Phone 8Windows Phone 8
  • Windows Phone 8.1Windows Phone 8.1
  • Windows Phone 10Windows Phone 10
  • Windows 8Windows 8
  • Windows 8.1Windows 8.1
  • Windows 10Windows 10
  • UnbekanntUnknown
marketmarket Zeichenfolgestring Die ISO 3166-Ländercode des Markts, in dem der Kauf erfolgte.The ISO 3166 country code of the market where the acquisition occurred.
gendergender Zeichenfolgestring Eine der folgenden Zeichen folgen, die das Geschlecht des Benutzers angibt, der die Übernahme durchgeführt hat:One of the following strings that specifies the gender of the user who made the acquisition:
  • mm
  • ff
  • UnbekanntUnknown
ageGroupageGroup Zeichenfolgestring Eine der folgenden Zeichen folgen, die die Altersgruppe des Benutzers angibt, der die Übernahme durchgeführt hat:One of the following strings that specifies the age group of the user who made the acquisition:
  • less than 13less than 13
  • 13-1713-17
  • 18-2418-24
  • 25-3425-34
  • 35-4435-44
  • 44-5544-55
  • greater than 55greater than 55
  • UnbekanntUnknown
acquisitionTypeacquisitionType Zeichenfolgestring Eine der folgenden Zeichen folgen, die den Typ des Erwerbs angibt:One of the following strings that indicates the type of acquisition:
  • FreeFree
  • TestversionTrial
  • BezahltPaid
  • Aktions CodePromotional code
  • IAPIap
  • Abonnement-IAPSubscription Iap
  • Private ZielgruppePrivate Audience
  • Vorab anordnenPre Order
  • Xbox Game Pass (oder Game Pass bei der Abfrage von Daten vor dem 23. März 2018)Xbox Game Pass (or Game Pass if querying for data before March 23, 2018)
  • DiskDisk
  • Prepaid-CodePrepaid Code
acquisitionQuantityacquisitionQuantity numbernumber Die Anzahl der Käufe, die während der angegebenen Aggregationsebene erfolgten.The number of acquisitions that occurred during the specified aggregation level.

AntwortbeispielResponse example

Das folgende Beispiel zeigt ein Beispiel für einen JSON-Antworttext für diese Anforderung.The following example demonstrates an example JSON response body for this request.

{
  "Value": [
    {
      "date": "2016-02-01",
      "applicationId": "9NBLGGGZ5QDR",
      "applicationName": "Contoso Demo",
      "deviceType": "Phone",
      "orderName": "",
      "storeClient": "Windows Phone Store (client)",
      "osVersion": "Windows Phone 8.1",
      "market": "IT",
      "gender": "m",
      "ageGroup": "0-17",
      "acquisitionType": "Free",
      "acquisitionQuantity": 1
    }
  ],
  "@nextLink": "appacquisitions?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=2015/01/01&endDate=2016/02/01&top=1&skip=1&orderby=date desc",
  "TotalCount": 466766
}