Freigeben über

Leistungsdaten für Anzeigenkampagnen abrufen

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 Eine Anzeigenkampagne für Ihre App erstellen.

Um Details für Anzeigenkampagnen zu erstellen, zu aktualisieren oder abzurufen, können Sie die Methoden zum Verwalten von Anzeigenkampagnen in der Microsoft Store-Aktionen-APIverwenden.

Voraussetzungen

Um diese Methode zu verwenden, müssen Sie zuerst Folgendes ausführen:

  • Falls noch nicht geschehen, füllen Sie alle Voraussetzungen für die Microsoft Store-Analyse-API aus.
  • Holen Sie sich ein Azure AD-Zugriffstoken, um es im Header der Anfrage für diese Methode zu verwenden. Nachdem Sie ein Zugriffstoken abgerufen haben, müssen Sie es 60 Minuten verwenden, bevor es abläuft. Nachdem das Token abgelaufen ist, können Sie eine neue abrufen.

Anfrage

Anforderungssyntax

Methode Anforderungs-URI
ERHALTEN/Bekommen https://manage.devcenter.microsoft.com/v1.0/my/analytics/promotion

Anforderungs-Kopfzeile

Kopfzeile Typ BESCHREIBUNG
Autorisierung Schnur Erforderlich. Das Azure AD-Zugriffstoken in der Form Bearer<token>.

Anforderungsparameter

Verwenden Sie den applicationId Parameter, um Leistungsdaten einer bestimmten App-Anzeigenkampagne abzurufen. Um Anzeigenleistungsdaten für alle Apps abzurufen, die Ihrem Entwicklerkonto zugeordnet sind, lassen Sie die applicationId Parameter weg.

Parameter Typ BESCHREIBUNG Erforderlich
Anwendungs-ID Schnur Die Store-ID der App, für die Sie Leistungsdaten für Anzeigenkampagnen abrufen möchten. Nein
Startdatum Datum Das Startdatum im Datumsbereich der abzurufenden Leistungsdaten einer Anzeigenkampagne im Format JJJJ/MM/TT. Der Standardwert ist das aktuelle Datum minus 30 Tage. Nein
Enddatum Datum Das Enddatum im Datumsbereich der abzurufenden Leistungsdaten einer Anzeigenkampagne im Format JJJJ/MM/TT. Der Standardwert ist das aktuelle Datum minus 1 Tag. Nein
Nach oben INT Die Anzahl der Datenzeilen, die in der Anforderung zurückgegeben werden sollen. Der Maximalwert und der Standardwert, wenn nicht angegeben ist, 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
hüpfen INT Die Anzahl der Zeilen, die in der Abfrage übersprungen werden sollen. Verwenden Sie diesen Parameter, um große Datensätze zu durchblättern. 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 Schnur Eine oder mehrere Aussagen, 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 mit oderkombiniert werden. Hier ist ein Beispiel Filter Parameter: filter=campaignId eq '100023'. Nein
Aggregationsniveau Schnur Gibt den Zeitraum an, für den aggregierte Daten abgerufen werden sollen. Dies kann eine der folgenden Zeichenfolgen sein: Tag, Wocheoder Monat. Wenn nicht angegeben, ist der Standardwert Tag. Nein
Sortierung nach Schnur

Eine Anweisung, die die Ergebnisdatenwerte für die Leistungsdaten der Anzeigenkampagne anordnet. Die Syntax lautet orderby=field [order],field [order],.... Der field-Parameter kann eine der folgenden Zeichenfolgen sein:

  • Datum
  • campaignId

Der Order-Parameter ist optional und kann asc oder desc sein, um die aufsteigende oder absteigende Reihenfolge für jedes Feld anzugeben. Der Standardwert ist asc.

Hier ist ein Beispiel orderby Zeichenfolge: orderby=date,campaignId

 Nein
GruppierenNach Schnur

Eine Aussage, die die Datenaggregation nur auf die angegebenen Felder anwendet. Sie können die folgenden Felder angeben:

  • campaignId
  • Anwendungs-ID
  • Datum
  • currencyCode

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

 Nein

Beispielanfrage

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

Antwortkörper

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 Schnur 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 top Parameter der Anforderung auf 5 festgelegt ist, für die Abfrage jedoch mehr als 5 Datenelemente vorhanden sind.
Gesamtzahl INT Die Gesamtanzahl der Zeilen des Abfrageergebnisses.

Kampagnenleistungsobjekt

Elemente im Value-Array enthalten die folgenden Werte.

Wert Typ BESCHREIBUNG
Datum Schnur Das erste Datum im Datumsbereich für die Leistungsdaten einer Werbekampagne. 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.
Anwendungs-ID Schnur Die Store-ID der App, für die Sie Leistungsdaten für Anzeigenkampagnen abrufen.
Kampagnen-ID Schnur Die ID der Werbekampagne.
lineId Schnur Die ID der Anzeigenkampagne Lieferposition, die diese Leistungsdaten generiert hat.
Währungscode Schnur Der Währungscode des Kampagnenbudgets.
ausgeben Schnur Der Für die Anzeigenkampagne aufgewendete Budgetbetrag.
Eindrücke lang Die Anzahl der Anzeigenaufrufe für die Kampagne.
Installiert lang Die Anzahl der App-Installationen im Zusammenhang mit der Kampagne.
Klicks lang Die Anzahl der Anzeigenklicks für die Kampagne.
iapInstalls lang Die Anzahl der Add-On-Installationen (auch als In-App-Kauf oder IAP bezeichnet) im Zusammenhang mit der Kampagne.
aktive Benutzer lang Die Anzahl der Benutzer, die auf eine Anzeige geklickt haben, die Teil der Kampagne ist und zur App zurückkehrt.

Antwortbeispiel

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
}
  • Last updated on