Abrufen von Add-On-Konvertierungen nach Kanal

  • Artikel

Verwenden Sie diese Methode in der Microsoft Store-Analyse-API, um aggregierte Konvertierungen nach Kanal für ein Add-On während eines bestimmten Zeitraums und andere optionale Filter abzurufen.

  • Eine Konvertierung bedeutet, dass ein Kunde (über ein Microsoft-Konto angemeldet) eine Lizenz für Ihr Add-On neu erworben hat (unabhängig davon, ob Sie dafür Geld verlangt oder es kostenlos angeboten haben).
  • Der Kanal ist die Methode, mit der ein Kunde zur Eintragsseite Ihrer App gelangt ist (z. B. über den Store oder eine benutzerdefinierte App-Werbekampagne).

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 tun:

  • Falls noch nicht geschehen, erfüllen Sie alle Voraussetzungen für die Microsoft Store-Analyse-API.
  • Rufen Sie ein Azure AD-Zugriffstoken ab, das im Anforderungsheader für diese Methode verwendet wird. Nachdem Sie ein Zugriffstoken erhalten haben, haben Sie 60 Minuten Zeit, es zu verwenden, bevor es abläuft. Nachdem das Token abgelaufen ist, können Sie eine neue abrufen.

Anfordern

Anforderungssyntax

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

Anforderungsheader

Header Typ Beschreibung
Autorisierung 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 Add-On-Konvertierungsdaten abrufen möchten. Ein Beispiel für die Store-ID ist 9WZDNCRFJ3Q8. Ja
inAppProductId Zeichenfolge Die Store-ID des Add-Ons, für das Sie Konvertierungsdaten abrufen möchten. Ja
startDate date Das Startdatum im Datumsbereich der Konvertierungsdaten, die abgerufen werden sollen. Der Standardwert ist der 1.1.2016. No
endDate date Das Enddatum im Datumsbereich der Konvertierungsdaten, die abgerufen werden sollen. Die Standardeinstellung ist das aktuelle Datum. Nein
Oben int Die Anzahl der Datenzeilen, die in der Anforderung zurückgegeben werden sollen. Der Höchstwert und der Standardwert, falls nicht angegeben, 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
skip int Die Anzahl der Zeilen, die in der Abfrage ü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 usw. ab. Nein
filter Zeichenfolge Eine oder mehrere Anweisungen, die den Antworttext filtern. Jede Anweisung kann die Operatoren eq oder ne verwenden, und Anweisungen können mit und oder oder kombiniert werden. Sie können die folgenden Zeichenfolgen in den Filteranweisungen angeben. Beschreibungen finden Sie im Abschnitt Konvertierungswerte in diesem Artikel.
  • applicationName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • DeviceType
  • market

Hier ist ein Beispiel-Filter-Parameter: filter=deviceType eq 'PC'.

 No
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. No
orderby Zeichenfolge Eine Anweisung, die die Ergebnisdatenwerte für jede Konvertierung anordnet. Die Syntax ist orderby=Feld [order], Feld [order],.... Der Feld-Parameter kann eine der folgenden Zeichenfolgen sein:
  • date
  • applicationName
  • inAppProductName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • DeviceType
  • market

Der Order-Parameter 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
  • inAppProductName
  • appType
  • customCampaignId
  • referrerUriDomain
  • channelType
  • storeClient
  • DeviceType
  • market

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

  • Datum
  • applicationId
  • inAppProductId
  • inAppProductName
  • conversionCount
  • clickCount

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

 No

Anforderungsbeispiel

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

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

Antwort

Antworttext

Wert Typ BESCHREIBUNG
Wert array Eine Matrix von Objekten, die aggregierte Konvertierungsdaten für das Add-On enthalten. Weitere Informationen zu den Daten in den einzelnen Objekten finden Sie unten im Abschnitt "Konvertierungswerte ".
@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 z. B. zurückgegeben, wenn der oberste Parameter der Anforderung auf 10 festgelegt ist, es jedoch mehr als 10 Zeilen mit Konvertierungsdaten für die Abfrage gibt.
TotalCount int Die Gesamtanzahl der Zeilen in den Datenergebnissen für die Abfrage.

Konvertierungswerte

Jedes Objekt in der Matrix Wert enthält die folgenden Werte:

Wert Typ Beschreibung
Datum Zeichenfolge Das erste Datum im Datumsbereich für die Konvertierungsdaten. 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.
inAppProductId Zeichenfolge Die Store-ID des Add-Ons, für das Sie Konvertierungsdaten abrufen.
inAppProductName Zeichenfolge Der Anzeigename des Add-Ons, für das Sie Konvertierungsdaten abrufen.
applicationId Zeichenfolge Die Store-ID der App, für die Sie Konvertierungsdaten abrufen.
applicationName Zeichenfolge Der Anzeigename der App, für die Sie Konvertierungsdaten abrufen.
appType Zeichenfolge Der Typ des Produkts, für das Sie Konvertierungsdaten abrufen. Der einzige unterstützte Wert für diese Methode ist Add-On.
customCampaignId Zeichenfolge Die ID-Zeichenfolge für eine benutzerdefinierte App-Werbekampagne, die der App zugeordnet ist.
referrerUriDomain Zeichenfolge Gibt die Domain an, unter der der App-Eintrag mit der ID der benutzerdefinierten App-Werbekampagne aktiviert wurde.
channelType Zeichenfolge Eine der folgenden Zeichenfolgen, die den Kanal für die Konvertierung angibt:
  • CustomCampaignId
  • Store Traffic
  • Andere
storeClient Zeichenfolge Die Version des Stores, in dem die Konvertierung erfolgt ist. Akutell lautet der einzige unterstützte Wert SFC.
deviceType Zeichenfolge Eine der folgenden Zeichenfolgen:
  • PC
  • Telefonnummer
  • Konsolen-Xbox One
  • Konsolen-Xbox Series X
  • IoT
  • Holographisch
  • Unbekannt
Markt Zeichenfolge Der Ländercode ISO 3166 des Marktes, in dem die Konvertierung erfolgte.
clickCount Zahl Die Anzahl der Kundenklicks auf Ihren App-Eintragslink.
conversionCount Zahl Die Anzahl der Kundenkonvertierungen.

Beispielanforderung 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/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2019&endDate=12/20/2021&top=10&skip=0
HTTP/1.1
Authorization: Bearer <your access token>

Beispiel für eine Antwort

{
    "Value": [
        {
            "inAppProductId": "9NN2HW33ZB2G",
            "applicationId": "9NBLGGGZ5QDR",
            "clickCount": 220636,
            "conversionCount": 154
        },
        {
            "inAppProductId": "9PN07J0WC18B",
            "applicationId": "9NBLGGGZ5QDR",
            "clickCount": 277061,
            "conversionCount": 187
        }
    ],
    "@nextLink": "",
    "TotalCount": 2
}

Beispiel-Anfrage

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/inappchannelconversions?applicationId=9NBLGGGZ5QDR&startDate=12/19/2021&endDate=12/20/2021&top=10&skip=0&groupby=date,applicationName,inAppProductName,appType,customCampaignId,referrerUriDomain,channelType,storeClient,deviceType,market
HTTP/1.1
Authorization: Bearer <your access token>

Beispiel für eine Antwort

{
    "Value": [
        {
            "inAppProductId": "9WZDNCRCWW61",
            "inAppProductName": "SeasonPass0",
            "appType": "Add-On",
            "date": "2022-06-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "mcg_mahjong_othergames",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "BR",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5H",
            "inAppProductName": "OEMFreePurchase",
            "appType": "Add-On",
            "date": "2022-07-06",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "mcg_solitaire_othergames",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "AT",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5Z",
            "inAppProductName": "Episode1Combo",
            "appType": "Add-On",
            "date": "2022-07-09",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5H",
            "inAppProductName": "OEMFreePurchase",
            "appType": "Add-On",
            "date": "2022-07-09",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW4Z",
            "inAppProductName": "Episode1Grandfathered",
            "appType": "Add-On",
            "date": "2022-07-11",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "|autosuggest",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "ES",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5W",
            "inAppProductName": "Episode2Combo",
            "appType": "Add-On",
            "date": "2022-07-11",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW4P",
            "inAppProductName": "SeasonPass24",
            "appType": "Add-On",
            "date": "2022-07-12",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "vungle",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CZ",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW5H",
            "inAppProductName": "OEMFreePurchase",
            "appType": "Add-On",
            "date": "2022-07-13",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "9wzdncrfjbd8",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "CA",
            "clickCount": 1,
            "conversionCount": 1
        },
        {
            "inAppProductId": "9WZDNCRCWW61",
            "inAppProductName": "SeasonPass0",
            "appType": "Add-On",
            "date": "2022-07-17",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "customCampaignId": "scom-web-store",
            "channelType": "CustomCampaignId",
            "storeClient": "SFW",
            "deviceType": "Unknown",
            "market": "US",
            "clickCount": 1,
            "conversionCount": 1
        }
    ],
    "@nextLink": "",
    "TotalCount": 9
}