Abrufen der Leistungsdaten einer Anzeigenkampagne
Verwenden Sie diese Methode in der Microsoft Store-Analyse-API, um eine aggregierte Zusammenfassung der Leistungsdaten für Werbekampagnen für Ihre Anwendungen während eines bestimmten Zeitraums und anderer optionaler Filter abzurufen. Diese Methode gibt die Daten im JSON-Format zurück.
Diese Methode gibt die gleichen Daten zurück, die vom Anzeigenkampagnenbericht im Partner Center bereitgestellt werden. Weitere Informationen zu Anzeigenkampagnen finden Sie unter Erstellen einer Anzeigenkampagne für Ihre App.
Zum Erstellen, Aktualisieren oder Abrufen von Details für Anzeigenkampagnen können Sie die Methoden zum Verwalten von Anzeigenkampagnen in der Microsoft Store-Werbungs-API verwenden.
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/promotion |
Anforderungsheader
| Header | Typ | Beschreibung |
|---|---|---|
| Autorisierung | Zeichenfolge | Erforderlich. Das Azure AD-Zugriffstoken im Formular Bearer<-Token>. |
Anforderungsparameter
Verwenden Sie den applicationId-Parameter , um Leistungsdaten für Anzeigenkampagnen für eine bestimmte App abzurufen. Um Anzeigenleistungsdaten für alle Apps abzurufen, die Ihrem Entwicklerkonto zugeordnet sind, lassen Sie den applicationId-Parameter weg.
| Parameter | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
| applicationId | Zeichenfolge | Die Store-ID der App, für die Sie Leistungsdaten für Anzeigenkampagnen abrufen möchten. | No |
| startDate | date | Das Startdatum im Datumsbereich der abzurufenden Leistungsdaten einer Anzeigenkampagne im Format JJJJ/MM/TT. Der Standardwert ist das aktuelle Datum minus 30 Tage. | No |
| endDate | date | Das Enddatum im Datumsbereich der abzurufenden Leistungsdaten einer Anzeigenkampagne im Format JJJJ/MM/TT. Der Standardwert ist das aktuelle Datum minus einen Tag. | No |
| 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 die Zeilen in der Antwort filtern. Der einzige unterstützte Filter ist campaignId. Jede Anweisung kann die Operatoren eq oder ne verwenden, und Anweisungen können mit und oder oder kombiniert werden. Hier sehen Sie einen Beispiel-Filter-Parameter: filter=campaignId eq '100023'. |
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 die Leistungsdaten der Anzeigenkampagne anordnet. Die Syntax ist orderby=Feld [order], Feld [order],.... Der Feld-Parameter kann eine der folgenden Zeichenfolgen sein:
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,campaignId |
No |
| groupby | Zeichenfolge | Eine Anweisung, die Datenaggregation nur auf die angegebenen Felder anwendet. Sie können die folgenden Felder angeben:
Der groupby-Parameter kann mit dem aggregationLevel-Parameter verwendet werden. Zum Beispiel: &groupby=applicationId&aggregationLevel=week |
No |
Anforderungsbeispiel
Im folgenden Beispiel werden mehrere Anforderungen zum Abrufen von Leistungsdaten für Anzeigenkampagnen veranschaulicht.
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?aggregationLevel=week&groupby=applicationId,campaignId,date HTTP/1.1
Authorization: Bearer <your access token>
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion?applicationId=9NBLGGH0XK8Z&startDate=2015/1/20&endDate=2016/8/31&skip=0&filter=campaignId eq '31007388' HTTP/1.1
Authorization: Bearer <your access token>
Antwort
Antworttext
| Wert | Typ | BESCHREIBUNG |
|---|---|---|
| Wert | array | Ein Array von Objekten, die aggregierte Leistungsdaten für Anzeigenkampagnen enthalten. Weitere Informationen zu den Daten in den einzelnen Objekten finden Sie im Abschnitt Kampagnenleistungsobjekt weiter unten. |
| @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 5 festgelegt ist, für die Abfrage jedoch mehr als 5 Datenelemente vorhanden sind. |
| TotalCount | int | Die Gesamtanzahl der Zeilen im Datenergebnis für die Abfrage. |
Kampagnenleistungsobjekt
Elemente im Value-Array enthalten die folgenden Werte.
| Wert | Typ | Beschreibung |
|---|---|---|
| Datum | Zeichenfolge | Das erste Datum im Datumsbereich für die Leistungsdaten der Anzeigenkampagne. 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. |
| applicationId | Zeichenfolge | Die Store-ID der App, für die Sie Leistungsdaten für Anzeigenkampagnen abrufen. |
| campaignId | Zeichenfolge | Die ID der Anzeigenkampagne. |
| lineId | Zeichenfolge | Die ID der Lieferposition der Anzeigenkampagne, die diese Leistungsdaten generiert hat. |
| currencyCode | Zeichenfolge | Der Währungscode des Kampagnenbudgets. |
| Ausgaben | Zeichenfolge | Der für die Anzeigenkampagne aufgewendete Budgetbetrag. |
| Aufrufe | long | Die Anzahl der Anzeigenaufrufe für die Kampagne. |
| Installation | long | Die Anzahl der App-Installationen im Zusammenhang mit der Kampagne. |
| clicks | long | Die Anzahl der Anzeigenklicks für die Kampagne. |
| iapInstalls | long | Die Anzahl der Add-On-Installationen (auch als In-App-Kauf oder IAP bezeichnet) im Zusammenhang mit der Kampagne. |
| activeUsers | long | Die Anzahl der Benutzer, die auf eine zur Kampagne gehörende Anzeige geklickt haben und zur App zurückgekehrt sind. |
Beispielantwort
Im folgenden Beispiel wird ein Beispiel für einen JSON-Antworttext für diese Anforderung veranschaulicht.
{
"Value": [
{
"date": "2015-04-12",
"applicationId": "9WZDNCRFJ31Q",
"campaignId": "4568",
"lineId": "0001",
"currencyCode": "USD",
"spend": 700.6,
"impressions": 200,
"installs": 30,
"clicks": 8,
"iapInstalls": 0,
"activeUsers": 0
},
{
"date": "2015-05-12",
"applicationId": "9WZDNCRFJ31Q",
"campaignId": "1234",
"lineId": "0002",
"currencyCode": "USD",
"spend": 325.3,
"impressions": 20,
"installs": 2,
"clicks": 5,
"iapInstalls": 0,
"activeUsers": 0
}
],
"@nextLink": "promotion?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=2015/1/20&endDate=2016/8/31&top=2&skip=2",
"TotalCount": 1917
}