Abrufen von Add-On-KäufenGet add-on acquisitions

Verwenden Sie diese Methode in der Microsoft Store Analytics-API, um aggregierte Erfassungsdaten für Add-ons für Ihre APP im JSON-Format in einem bestimmten Datumsbereich und anderen optionalen Filtern zu erhalten.Use this method in the Microsoft Store analytics API to get aggregate acquisition data for add-ons for your app in JSON format during a given date range and other optional filters. Diese Informationen sind auch im Bericht " Add-on-Akquisitionen " im Partner Center verfügbar.This information is also available in the Add-on 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/inappacquisitions

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

Die Parameter applicationId oder inAppProductId sind erforderlich.The applicationId or inAppProductId parameter is required. Um Kaufdaten für alle für die App registrierten Add-Ons abzurufen, geben Sie den Parameter applicationId an.To retrieve acquisition data for all add-ons registered to the app, specify the applicationId parameter. Um Kaufdaten für ein einzelnes für die App registriertes Add-On abzurufen, geben Sie den Parameter inAppProductId an.To retrieve acquisition data for a single add-on, specify the inAppProductId parameter. Wenn Sie beide Parameter angeben, wird der Parameter applicationId ignoriert.If you specify both, the applicationId parameter is ignored.

ParameterParameter typeType BESCHREIBUNGDescription ErforderlichRequired
applicationIdapplicationId Zeichenfolgestring Die Speicher-ID der APP, für die Sie Add-on-Erwerbs Daten abrufen möchten.The Store ID of the app for which you want to retrieve add-on acquisition data. JaYes
inAppProductIdinAppProductId Zeichenfolgestring Die Speicher-ID des Add-Ins, für das Sie Erwerbs Daten abrufen möchten.The Store ID of the add-on for which you want to retrieve acquisition data. JaYes
startDatestartDate datedate Das Startdatum im Datumsbereich der Add-On-Kaufdaten, die abgerufen werden sollen.The start date in the date range of add-on 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 Add-On-Kaufdaten, die abgerufen werden sollen.The end date in the date range of add-on 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. Weitere Informationen finden Sie unten im Abschnitt Filterfelder.For more information, see the filter fields section below. 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 Add-On-Käufe anfordert.A statement that orders the result data values for each add-on 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
  • inAppProductNameinAppProductName
  • 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
  • inAppProductIdinAppProductId
  • 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

FilterfelderFilter fields

Der Parameter filter der Anforderung enthält mindestens eine Anweisung, die die Zeilen in der Antwort filtert.The filter parameter of the request contains one or more statements that filter the rows in the response. Jede Anweisung enthält ein Feld und einen Wert, das/der mit den Operatoren eq oder ne verknüpft ist. Anweisungen können mit and oder or kombiniert werden.Each statement contains a field and value that are associated with the eq or ne operators, and statements can be combined using and or or. Im Folgenden finden Sie einige Beispiele für filter-Parameter:Here are some example filter parameters:

  • filter=market eq 'US' and gender eq 'm'filter=market eq 'US' and 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’)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’)

Die Liste der unterstützten Felder finden Sie in der folgenden Tabelle.For a list of the supported fields, see the following table. Zeichenfolgenwerte im Parameter filter müssen von einfachen Anführungszeichen eingeschlossen werden.String values must be surrounded by single quotes in the filter parameter.

FelderFields BESCHREIBUNGDescription
acquisitionTypeacquisitionType Eine der folgenden Zeichenfolgen:One of the following strings:
  • Kostenfree
  • versuchtentrial
  • tetenpaid
  • promotional codepromotional code
  • iapiap
ageGroupageGroup Eine der folgenden Zeichenfolgen:One of the following strings:
  • 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
storeClientstoreClient Eine der folgenden Zeichenfolgen:One of the following strings:
  • Windows Phone Store (client)Windows Phone Store (client)
  • Microsoft Store (Client)Microsoft Store (client)
  • Microsoft Store (Web)Microsoft Store (web)
  • Volume purchase by organizationsVolume purchase by organizations
  • AndereOther
gendergender Eine der folgenden Zeichenfolgen:One of the following strings:
  • mm
  • ff
  • UnbekanntUnknown
marketmarket Eine Zeichenfolge, die den ISO 3166-Ländercode des Markts enthält, in dem der Kauf erfolgte.A string that contains the ISO 3166 country code of the market where the acquisition occurred.
osVersionosVersion Eine der folgenden Zeichenfolgen:One of the following strings:
  • 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
deviceTypedeviceType Eine der folgenden Zeichenfolgen:One of the following strings:
  • PCPC
  • SmartphonePhone
  • Konsole-Xbox OneConsole-Xbox One
  • Konsole-Xbox Series XConsole-Xbox Series X
  • IoTIoT
  • HolographicHolographic
  • UnbekanntUnknown
orderNameorderName Eine Zeichenfolge, die den Namen der Bestellung für den Werbecode angibt, der für den Kauf des Add-Ons verwendet wurde. (Dies gilt nur, wenn der Benutzer das Add-On durch Einlösen eines Werbecodes erworben hat.)A string that specifies the name of the order for the promotional code that was used to acquire the add-on (this only applies if the user acquired the add-on by redeeming a promotional code).

AnforderungsbeispielRequest example

Die folgenden Beispiele zeigen verschiedene Anforderungen für das Abrufen von Add-On-Kaufdaten.The following examples demonstrates several requests for getting add-on acquisition data. Ersetzen Sie die Werte inAppProductId und applicationId durch die entsprechende Store-ID für Ihre App oder Ihr Add-On.Replace the inAppProductId and applicationId values with the appropriate Store ID for your add-on or 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>

AntwortResponse

AntworttextResponse body

WertValue typeType BESCHREIBUNGDescription
WertValue arrayarray Ein Array von Objekten, die aggregierte Add-On-Kaufdaten enthalten.An array of objects that contain aggregate add-on acquisition data. Weitere Informationen zu den Daten in den einzelnen Objekten finden Sie unten im Abschnitt Add-On-Kaufwerte.For more information about the data in each object, see the add-on 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 Add-On-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 add-on 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.

Add-On-KaufwerteAdd-on acquisition 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.
inAppProductIdinAppProductId Zeichenfolgestring Die Store-ID des Add-Ons, für das Sie Kaufdaten abrufen.The Store ID of the add-on for which you are retrieving acquisition data.
inAppProductNameinAppProductName Zeichenfolgestring Der Anzeigename des Add-Ons.The display name of the add-on. Dieser Wert wird in den zurückgegebenen Daten nur angezeigt, wenn der Parameter aggregationLevel auf day festgelegt ist. Dies gilt nicht, wenn im groupby-Parameter das Feld InAppProductName angegeben wurde.This value only appears in the response data if the aggregationLevel parameter is set to day, unless you specify the inAppProductName field in the groupby parameter.
applicationIdapplicationId Zeichenfolgestring Die Store-ID der App, für die Sie die Add-On-Kaufdaten abrufen möchten.The Store ID of the app for which you want to retrieve add-on acquisition data.
applicationNameapplicationName Zeichenfolgestring Der Anzeigename der App.The display name of the app.
deviceTypedeviceType Zeichenfolgestring Der Typ des Geräts, auf dem der Kauf ausgeführt wurde.The type of device that completed the acquisition. Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder.For a list of the supported strings, see the filter fields section above.
orderNameorderName Zeichenfolgestring Der Name der Bestellung.The name of the order.
storeClientstoreClient Zeichenfolgestring Die Version des Store, in dem der Kauf erfolgte.The version of the Store where the acquisition occurred. Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder.For a list of the supported strings, see the filter fields section above.
osVersionosVersion Zeichenfolgestring Die Version des Betriebssystems, auf dem der Kauf ausgeführt wurde.The OS version on which the acquisition occurred. Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder.For a list of the supported strings, see the filter fields section above.
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 Das Geschlecht des Benutzers, der den Kauf ausgeführt hat.The gender of the user who made the acquisition. Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder.For a list of the supported strings, see the filter fields section above.
ageGroupageGroup Zeichenfolgestring Die Altersgruppe des Benutzers, der den Kauf ausgeführt hat.The age group of the user who made the acquisition. Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder.For a list of the supported strings, see the filter fields section above.
acquisitionTypeacquisitionType Zeichenfolgestring Der Typ des Kaufs (kostenlos, kostenpflichtig usw.).The type of acquisition (free, paid, and so on). Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder.For a list of the supported strings, see the filter fields section above.
acquisitionQuantityacquisitionQuantity integerinteger Die Anzahl der Käufe, die ausgeführt wurden.The number of acquisitions that occurred.

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": "2015-01-02",
      "inAppProductId": "9NBLGGH3LHKL",
      "inAppProductName": "Contoso add-on 7",
      "applicationId": "9NBLGGGZ5QDR",
      "applicationName": "Contoso Demo",
      "deviceType": "Phone",
      "orderName": "",
      "storeClient": "Windows Phone Store (client)",
      "osVersion": "Windows Phone 8.1",
      "market": "GB",
      "gender": "m",
      "ageGroup": "50orover",
      "acquisitionType": "iap",
      "acquisitionQuantity": 1
    }
  ],
  "@nextLink": "inappacquisitions?applicationId=9NBLGGGZ5QDR&inAppProductId=&aggregationLevel=day&startDate=2015/01/01&endDate=2016/02/01&top=1&skip=1",
  "TotalCount": 33677
}