Bericht-API 2.0 für Werber

Inhalt

Überblick

Die Berichterstattungs-API bietet Werbern eine programmatische Methode, um auf Daten zuzugreifen, die sich im Dashboard befinden. Ihr Bericht-API-Schlüssel ist für alle Apps derselbe. Jede App hat eine einzigartige Bericht-API-ID, die Sie auf der entsprechenden Seite der Anwendung finden.

Host

Host: https://report.api.vungle.com/ext/adv/reports/spend

Authentifizierung

Die Sicherheit wird im Anfrage-Header abgewickelt. Finden Sie Ihren API-Schlüssel auf der Bericht-Seite des Vungle Dashboards auf. Wenn Sie keinen API-Schlüssel besitzen, senden Sie eine E-Mail an tech-support@vungle.com, um einen anzufordern!

Header anfordern

Schlüssel Wert Beschreibung
Authorization: Bearer [API Key] API-Schlüssel
Vungle-Version: 1 API-Version
Accept: text/csv oder application/json Für Ergebnisse akzeptierte Datenformate. Standard ist text/csv.

 

Ergebnisse

  • Format: Wir unterstützen JSON- und CSV-Ausgaben, die im Header der Anforderung angegeben werden.
  • Datenbereich: Historische Informationen sind bis zu sechs Monate verfügbar. Um ältere Daten zu empfangen, schreiben Sie Ihrem Kontomanager eine E-Mail an tech-support@vungle.com.
  • Falls keine Daten vorhanden sind: Beachten Sie, dass Vungle im Fall von fehlenden Daten in Ihrer Anfrage eine Antwort mit "empty 200" schickt. Dies zeigt an, dass die Anfrage stattgefunden hat, allerdings keine Daten zur Rückgabe verfügbar sind.

Quelle: GET /reports/spend

Filter-Parameter

Verwenden sie Filter-Parameter, um die Ergebnisse auf eine Teilmenge Ihrer Ausgaben-Daten zu beschränken. Die Meisten Filter sind optional. In diesem Fall gibt Vungle alle Ergebnisse für diesen Filter zurück.

Parametername Format Aktion Falls nicht verfügbar Beispiel
start ISO8601-Datum Beschränkt die Ergebnismenge auf die Ausgaben-Daten bis zu diesem Datum Lehnt Anfrage ab start=2017-01-01
end ISO8601-Datum Beschränkt die Ergebnismenge auf die Ausgaben-Daten vor diesem Datum Lehnt Anfrage ab end=2017-01-02 
country  Kommagetrennte Liste an ISO 3166-1-Alpha-2-Ländercodes Gibt nur Ausgaben-Daten zurück, die den aufgeführten Ländern entsprechen Gibt alle Länder zurück

country=US

country=US,CA

country=US,CA,AU
applicationId  Kommagetrennte Liste an Vungle Anwendungs-IDs zur Rückgabe Gibt nur Ausgaben-Daten zurück, die den aufgeführten Anwendungen entsprechen Gibt alle Anwendungen zurück

applicationId=586e201e242e3fd308000220

applicationId=586e201e242e3fd308000220,585849c3756684a50c0000a0
campaignId  Kommagetrennte Liste an Kampagnen-IDs Gibt nur Ausgaben-Daten zurück, die den aufgeführten Kampagnen entsprechen Gibt alle Kampagnen zurück

campaignId=586e201e242e3fd308000220

campaignId=586e201e242e3fd308000220,585849c3756684a50c0000a0

creativeId  Kommagetrennte Liste an Kreativ-IDs Gibt nur Ausgaben-Daten zurück, die den aufgeführten Kreativen entsprechen Gibt alle Kreative zurück

creativeId=586e201e242e3fd308000220

creativeId=586e201e242e3fd308000220,585849c3756684a50c0000a0

siteID Kommagetrennte Liste an Herausgeber-App-Objekt-IDs Gibt nur Ausgaben-Daten zurück, die den aufgeführten Anwendungen entsprechen Gibt alle Herausgeber zurück

siteId=586e201e242e3fd308000220

siteId=586e201e242e3fd308000220,585849c3756684a50c0000a0

Dimensionen-Parameter

Verwenden Sie Dimensionen, um Ihre Berichte mehr oder weniger aufgeteilt zu gestalten. Versenden Sie Dimensionen als kommagetrennte Liste unter einem Dimensionen Parameter. Wenn Sie nicht ausdrücklich eine Dimension anfordern, teilt Vungle den Bericht nicht nach dieser Dimension auf.

Verwendung des Dimensionen-Parameters

Parametername Format Beispiel
dimensions Kommagetrennte Liste an bestimmten Strings, die in der untenstehenden Tabelle aufgeführt werden

dimensions=platform

dimensions=campaign,creative,date

 

Verfügbare Dimensionen

Dimension
Name
Gibt zurück Rückgabebeispiel
platform Nach Plattform-String gruppiert
platform
iOS
campaign Nach Kampagnen-ID und Kampagnen-Name gruppiert
campaign id campaign name
58086457cdf5f9eb6d000060 Toy Blast iOS CA iPhone
date  Nach Datum gruppiert
date
2017-01-01
country Nach Land gruppiert
country
US
creative Nach Kreativ-ID und Kreativ-Name gruppiert
creative id creative name
58086457cdf5f9eb6d000060 Toy Blast Landscape IEC
site Nach Herausgeber-App-Objekt-ID und Herausgeber-App-Name gruppiert
site id site name
58086457cdf5f9eb6d000060 Sonic Dash iOS

 

Bei Dimensionen, die das Nachsehen eines Namens erfordern (z.B. Ortsname) geben wir, wenn Vungle das Nachsehen nicht empfangen kann, anstatt des Namens den String "Unbekannt" aus.

Aggregate-Parameter

Verwenden Sie Aggregate, um zu definieren, welche Performance-Daten Sie interessieren. Versenden Sie Aggregate als kommagetrennte Liste unter einem Aggregate-Parameter. Wenn ein Aggregat sich nicht in der Liste befindet, setzt Vungle voraus, dass Sie diese Daten nicht empfangen möchten.

Verwendung des Aggregat-Parameters

Parametername Format Beispiel
aggregates Kommagetrennte Liste an bestimmten Strings, die in der untenstehenden Tabelle aufgeführt werden

aggregates=views

aggregates=views,installs,ecpm

 

Verfügbare Aggregate

Dimension
Name
Gibt zurück
views integer
completes integer
clicks  integer 
installs  integer
spend  integer
ecpm (Ausgaben * 1000 / Ansichten) als Float

 

Beispielanfragen und Antworten

Beispiel: 1: JSON Ausgaben

Anfrage

curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/adv/reports/spend?apiKey=987654321&dimensions=date,country,platform&aggregates=views,spend&start=2017-03-01&end=2017-03-05"

Rückgabe


[
    {
        "platform" : "iOS",
        "date": "2016-09-29",
        "country": "US",
        "views": 1234,
        "spend": 123.0       
    },
    {
        "platform" : "Android",
        "date": "2016-09-29",
        "country": "CA",
        "view": 35,
        "spend": 2.0
    },
    ...
]

Beispiel: 2: CSV Ausgaben

Anfrage

curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/adv/reports/spend?dimensions=date,country,platform&aggregates=views,spend&start=2017-03-01&end=2017-03-05"

Rückgabe

Platform,date,country,views,spend
ios,2017-03-01,US,1234,123.0
ios,2017-03-01,CA,35,2.0

Example 3: ID/Name Expansion

Anfrage

curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/adv/reports/spend?dimensions=campaign&aggregates=views,spend&start=2017-03-01&end=2017-03-05"

Rückgabe


[
    {
        "campaign id" : "12345678",
        "campaign name": "test campaign 1",
        "views": 1234,
        "spend": 123.0       
    }
]
Haben Sie Fragen? Anfrage einreichen

Kommentare