Abrufen von Anzeigenleistungsdaten

  • Artikel

Verwenden Sie diese Methode in der Microsoft Store-Analyse-API, um aggregierte Anzeigenleistungsdaten für Ihre Anwendungen während eines bestimmten Zeitraums und andere optionale Filter abzurufen. Diese Methode gibt die Daten im JSON-Format zurück.

Diese Methode gibt die gleichen Daten zurück, die vom Bericht zur Anzeigenleistung im Partner Center bereitgestellt werden.

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.

Weitere Informationen finden Sie unter Access-Analysedaten mithilfe von Microsoft Store-Diensten.

Anfordern

Anforderungssyntax

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

Anforderungsheader

Header Typ Beschreibung
Autorisierung Zeichenfolge Erforderlich. Das Azure AD-Zugriffstoken im Formular Bearer<-Token>.

Anforderungsparameter

Verwenden Sie den applicationId-Parameter , um Anzeigenleistungsdaten 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 Anzeigenleistungsdaten abrufen möchten. No
startDate date Das Startdatum im Datumsbereich der abzurufenden Anzeigenleistungsdaten im Format JJJJ/MM/TT. Der Standardwert ist das aktuelle Datum minus 30 Tage. No
endDate date Das Enddatum im Datumsbereich der abzurufenden Anzeigenleistungsdaten 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. Weitere Informationen finden Sie im Abschnitt zu Filterfelder weiter unten. 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 anordnet. Die Syntax ist orderby=Feld [order], Feld [order],.... Der Feld-Parameter kann eine der folgenden Zeichenfolgen sein:
  • date
  • market
  • deviceType
  • adUnitId

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 die folgenden Felder angeben:

  • applicationId
  • applicationName
  • date
  • accountCurrencyCode
  • market
  • deviceType
  • adUnitName
  • adUnitId
  • pubCenterAppName
  • adProvider

Der groupby-Parameter kann mit dem aggregationLevel-Parameter verwendet werden. Zum Beispiel: &groupby=applicationId&aggregationLevel=week

 No

Filter (Felder)

Der Filter-Parameter des Anforderungstexts enthält eine oder mehrere Anweisungen, die die Zeilen in der Antwort filtern. Jede Anweisung enthält ein Feld und einen Wert, die den Operatoren eq oder ne zugeordnet sind, und Anweisungen können mithilfe und oder oder kombiniert werden. Hier sehen Sie einen Beispiel-Filter-Parameter:

  • filter=market eq 'US' und deviceType eq 'phone'

Eine Liste der unterstützten Felder finden Sie in der folgenden Tabelle. Zeichenfolgenwerte müssen von einfachen Anführungszeichen im Filter-Parameter umgeben sein.

Feld Beschreibung
Markt Eine Zeichenfolge, die den ISO 3166-Ländercode des Marktes enthält, in dem die Anzeigen bereitgestellt wurden.
deviceType Eine der folgenden Zeichenfolgen: PC/Tablet oder Telefon.
adUnitId Eine Zeichenfolge, die eine Anzeigeneinheits-ID angibt, die auf den Filter angewendet werden soll.
pubCenterAppName Eine Zeichenfolge, die den pubCenter-Namen für die aktuelle App angibt, die auf den Filter angewendet werden soll.
adProvider Eine Zeichenfolge, die einen Anzeigenanbieternamen angibt, der auf den Filter angewendet werden soll.
date Eine Zeichenfolge, die ein Datum im Format JJJJ/MM/TT angibt, das auf den Filter angewendet werden soll.

Anforderungsbeispiel

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

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/adsperformance?applicationId=9NBLGGH4R315&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/adsperformance?applicationId=9NBLGGH4R315&startDate=8/1/2015&endDate=8/31/2015&skip=0&$filter=market eq 'US' and deviceType eq 'phone’ eq 'US'; and gender eq 'm'  HTTP/1.1
Authorization: Bearer <your access token>

Antwort

Antworttext

Wert Typ BESCHREIBUNG
Wert array Ein Array von Objekten, die aggregierte Anzeigenleistungsdaten enthalten. Weitere Informationen zu den Daten in den einzelnen Objekten finden Sie unten im Abschnitt mit den Anzeigenleistungswerten .
@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.

Anzeigenleistungswerte

Elemente im Value-Array enthalten die folgenden Werte.

Wert Typ Beschreibung
Datum Zeichenfolge Das erste Datum im Datumsbereich für die Anzeigenleistungsdaten. 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 Anzeigenleistungsdaten abrufen.
applicationName Zeichenfolge Der Anzeigename der App.
adUnitId Zeichenfolge Die ID der Anzeigeneinheit.
adUnitName Zeichenfolge Der Name der Anzeigeneinheit, wie vom Entwickler im Partner Center angegeben.
adProvider Zeichenfolge Der Name des Anzeigenanbieters.
deviceType Zeichenfolge Die Art des Geräts, auf dem die Anzeigen geschaltet wurden. Eine Liste der unterstützten Zeichenfolgen finden Sie oben im Abschnitt Filterfelder
Markt Zeichenfolge Der ISO 3166-Ländercode des Marktes, in dem die Anzeigen bedient wurden.
accountCurrencyCode Zeichenfolge Der Währungscode für das Konto.
pubCenterAppName Zeichenfolge Der Name der pubCenter-App, die der App im Partner Center zugeordnet ist.
adProviderRequests int Die Anzahl der Anzeigenanforderungen für den angegebenen Anzeigenanbieter.
Aufrufe int Die Anzahl der Anzeigenaufrufe.
clicks int Die Anzahl der Anzeigenklicks.
revenueInAccountCurrency Zahl Die Einnahmen in der Währung für das Land/die Region des Kontos.
requests int Die Anzahl der Anzeigenanforderungen

Beispielantwort

Im folgenden Beispiel wird ein Beispiel für einen JSON-Antworttext für diese Anforderung veranschaulicht.

{
  "Value": [
    {
      "date": "2015-03-09",
      "applicationId": "9NBLGGH4R315",
      "applicationName": "Contoso Demo",
      "market": "US",
      "deviceType": "phone",
      "adUnitId":"10765920",
      "adUnitName":"TestAdUnit",
      "revenueInAccountCurrency": 10.0,
      "impressions": 1000,
      "requests": 10000,
      "clicks": 1,
      "accountCurrencyCode":"USD"
    },
    {
      "date": "2015-03-09",
      "applicationId": "9NBLGGH4R315",
      "applicationName": "Contoso Demo",
      "market": "US",
      "deviceType": "phone",
      "adUnitId":"10795110",
      "adUnitName":"TestAdUnit2",
      "revenueInAccountCurrency": 20.0,
      "impressions": 2000,
      "requests": 20000,
      "clicks": 3,
      "accountCurrencyCode":"USD"
    },
  ],
  "@nextLink": "adsperformance?applicationId=9NBLGGH4R315&aggregationLevel=week&startDate=2015/03/01&endDate=2016/02/01&top=2&skip=2",
  "TotalCount": 191753
}