Abrufen von App-Konvertierungen nach KanalGet app conversions by channel

Verwenden Sie diese Methode in der Microsoft Store Analytics-API, um in einem bestimmten Datumsbereich und anderen optionalen Filtern Aggregat Konvertierungen nach Kanal für eine Anwendung zu erhalten.Use this method in the Microsoft Store analytics API to get aggregate conversions by channel for an application during a given date range and other optional filters.

  • Eine Konvertierung bedeutet, dass ein Kunde (angemeldet mit einem Microsoft-Konto) eine Lizenz für Ihre APP abgerufen hat (unabhängig davon, ob Sie Geld abgerechnet haben oder Sie kostenlos angeboten haben).A conversion means that a customer (signed in with a Microsoft account) has newly obtained a license to your app (whether you charged money or you've offered it for free).
  • Der Kanal ist die Methode, bei der ein Kunde auf der Auflistungs Seite Ihrer APP angekommen ist (z. b. über den Store oder eine benutzerdefinierte App-Promotionkampagne).The channel is the method in which a customer arrived at your app's listing page (for example, via the Store or a custom app promotion campaign).

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

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 Konvertierungsdaten abrufen möchten.The Store ID of the app for which you want to retrieve conversion data. Beispiel für eine Store-ID: 9WZDNCRFJ3Q8.An example Store ID is 9WZDNCRFJ3Q8. JaYes
startDatestartDate datedate Das Startdatum im Datumsbereich von Konvertierungsdaten, die abgerufen werden sollen.The start date in the date range of conversion data to retrieve. Der Standardwert ist 1/1/2016.The default is 1/1/2016. NeinNo
endDateendDate datedate Das Enddatum im Datumsbereich von Konvertierungsdaten, die abgerufen werden sollen.The end date in the date range of conversion 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 Eine oder mehrere-Anweisungen, die den Antworttext filtern.One or more statements that filter the response body. Alle Anweisungen können die Operatoren eq oder ne verwenden. Zudem können sie mit and oder or kombiniert werden.Each statement can use the eq or ne operators, and statements can be combined using and or or. Sie können die folgenden Zeichen folgen in den Filter Anweisungen angeben.You can specify the following strings in the filter statements. Beschreibungen finden Sie im Abschnitt Konvertierungs Werte in diesem Artikel.For descriptions, see the conversion values section in this article.
  • applicationNameapplicationName
  • appTypeappType
  • customcampaignidcustomCampaignId
  • referenreruridomainreferrerUriDomain
  • channelTypechannelType
  • storeClientstoreClient
  • deviceTypedeviceType
  • Marktforschungsmarket

Hier ist ein Beispiel für einen Filter Parameter: Filter = Geräte-ype EQ ' PC '.Here is an example filter parameter: filter=deviceType eq 'PC'.

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 Ergebnisdaten Werte für jede Konvertierung anordnet.A statement that orders the result data values for each conversion. 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
  • applicationNameapplicationName
  • appTypeappType
  • customcampaignidcustomCampaignId
  • referenreruridomainreferrerUriDomain
  • channelTypechannelType
  • storeClientstoreClient
  • deviceTypedeviceType
  • Marktforschungsmarket

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
  • appTypeappType
  • customcampaignidcustomCampaignId
  • referenreruridomainreferrerUriDomain
  • channelTypechannelType
  • storeClientstoreClient
  • deviceTypedeviceType
  • Marktforschungsmarket

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
  • Anzahl von KomponentenconversionCount
  • ClickCountclickCount

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

Im folgenden Beispiel werden mehrere Anforderungen zum erhalten von App-Konvertierungsdaten veranschaulicht.The following example demonstrates several requests for getting app conversion 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/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=2/1/2017&top=10&skip=0  HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/appchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=1/1/2017&endDate=4/31/2017&skip=0&filter=market eq 'US'  HTTP/1.1
Authorization: Bearer <your access token>

AntwortResponse

AntworttextResponse body

WertValue typeType BESCHREIBUNGDescription
WertValue arrayarray Ein Array von-Objekten, die aggregierte Konvertierungsdaten für die APP enthalten.An array of objects that contain aggregate conversion data for the app. Weitere Informationen zu den Daten in den einzelnen Objekten finden Sie unten im Abschnitt Konvertierungs Werte .For more information about the data in each object, see the conversion 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. Dieser Wert wird z. b. zurückgegeben, wenn der Top -Parameter der Anforderung auf 10 festgelegt ist, aber mehr als 10 Zeilen von Konvertierungsdaten für die Abfrage vorhanden sind.For example, this value is returned if the top parameter of the request is set to 10 but there are more than 10 rows of conversion 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.

Konvertierungs WerteConversion values

Objekte im Wertarray enthalten die folgenden Werte.Objects in the Value array contain the following values.

WertValue typeType BESCHREIBUNGDescription
datedate Zeichenfolgestring Das erste Datum im Datumsbereich für die Konvertierungsdaten.The first date in the date range for the conversion 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 Speicher-ID der APP, für die Sie Konvertierungsdaten abrufen.The Store ID of the app for which you are retrieving conversion data.
applicationNameapplicationName Zeichenfolgestring Der Anzeige Name der APP, für die Sie Konvertierungsdaten abrufen.The display name of the app for which you are retrieving conversion data.
appTypeappType Zeichenfolgestring Der Typ des Produkts, für das Sie Konvertierungsdaten abrufen.The type of the product for which you are retrieving conversion data. Bei dieser Methode ist der einzige unterstützte Wert " App".For this method, the only supported value is App.
customcampaignidcustomCampaignId Zeichenfolgestring Die ID-Zeichenfolge für eine benutzerdefinierte App-Promotionkampagne , die der APP zugeordnet ist.The ID string for a custom app promotion campaign that is associated with the app.
referenreruridomainreferrerUriDomain Zeichenfolgestring Gibt die Domäne an, in der die APP-Auflistung mit der ID der benutzerdefinierten App-herauf Stufung aktiviert wurde.Specifies the domain where the app listing with the custom app promotion campaign ID was activated.
channelTypechannelType Zeichenfolgestring Eine der folgenden Zeichen folgen, die den Kanal für die Konvertierung angibt:One of the following strings that specifies the channel for the conversion:
  • CustomcampaignidCustomCampaignId
  • Datenverkehr speichernStore Traffic
  • AndereOther
storeClientstoreClient Zeichenfolgestring Die Version des Stores, in der die Konvertierung aufgetreten ist.The version of the Store where the conversion occurred. Der einzige unterstützte Wert ist sfc.Currently, the only supported value is SFC.
deviceTypedeviceType Zeichenfolgestring 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
marketmarket Zeichenfolgestring Der ISO 3166-Ländercode des Markts, an dem die Konvertierung erfolgt ist.The ISO 3166 country code of the market where the conversion occurred.
ClickCountclickCount numbernumber Die Anzahl der Kunden klickt auf den Link der APP-Auflistung.The number of customer clicks on your app listing link.
Anzahl von KomponentenconversionCount numbernumber Die Anzahl der Kunden Konvertierungen.The number of customer conversions.

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-01-01",
      "applicationId": "9NBLGGGZ5QDR",
      "applicationName": "Contoso App",
      "appType": "App",
      "customCampaignId": "",
      "referrerUriDomain": "Universal Client Store",
      "channelType": "Store Traffic",
      "storeClient": "SFC",
      "deviceType": "PC",
      "market": "US",
      "clickCount": 7,
      "conversionCount": 0
    }
  ],
  "@nextLink": null,
  "TotalCount": 1
}