Bericht-API 2.0 für Herausgeber

Inhalt

Überblick

Die Berichterstattungs-API bietet Herausgebern 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/pub/reports/performance

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 or application/json Accepted data format for results. Default is text/csv.

 

Ergebnisse

  • Format: Wir unterstützen JSON- und CSV-Ausgaben.
  • 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/performance

Filter-Parameter

Verwenden sie Filter-Parameter, um die Ergebnisse auf eine Teilmenge Ihrer Performance-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 Performance-Daten bis zu diesem Datum Lehnt Anfrage ab start=2017-01-01
end ISO8601-Datum Beschränkt die Ergebnismenge auf die Performance-Daten nach diesem Datum Lehnt Anfrage ab end=2017-01-02 
country  Kommagetrennte Liste an ISO 3166-1-Alpha-2-Ländercodes Gibt nur Performance-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 Performance-Daten zurück, die den aufgeführten Anwendungen entsprechen Gibt alle Anwendungen zurück

applicationId=586e201e242e3fd308000220

applicationId=586e201e242e3fd308000220,585849c3756684a50c0000a0
incentivized ‘true’/’false’ or 1/0 Gibt nur Performance-Daten für Verkehr mit Anreiz oder Verkehr ohne Anreiz zurück Gibt mit Anreiz und ohne Anreiz zurück

incentivized=true

incentivized=false

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=application,date,country

 

Verfügbare Dimensionen

Dimension
Name
Gibt zurück Rückgabebeispiel
platform Nach Plattform-String gruppiert
platform
iOS
application Nach Vungle Anwendungs-ID und Name gruppiert
application id application name
58086457cdf5f9eb6d000060 Sonic Dash
Platzierung

Nach Platzierungs-ID und Name gruppiert.

Bei Apps, die noch Vungle SDK v. 4.1 und unterhalb verwenden, die keine Platzierungen unterstützen, werden die Platzierungs-ID und der Platzierungsname in unserem Bericht nicht angezeigt, aber Aggregationen wie Ansichten und Herausgeberumsatz sind dennoch korrekt. Das bedeutet, dass nicht-aktualisierte Geräte auch weiterhin in den Berichten angezeigt werden, aber ohne Anzeige der Platzierungen.

placement id placement name
12345678 Level 3
date  Nach Datum gruppiert
date
2017-01-01
country Nach Land gruppiert
country
US
incentivized Nach Verkehr mit Belohnung gruppiert
incentivized
true
false

Bei Dimensionen, die das Nachsehen eines Namens erfordern (z.B. Anwendungsname) 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 
revenue  integer
ecpm (Herausgeberumsatz * 1000 / Ansichten) als Float

  

Beispielanfragen und Antworten

Beispiel 1: JSON-Umsatz

Anfrage


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

Rückgabe


[
    {
        "platform" : "iOS",
        "date": "2017-03-01",
        "country": "US",
        "views": 1234,
        "revenue": 123.0,
        "ecpm": 99.67,       
    },
    {
        "platform" : "iOS",
        "date": "2017-03-01",
        "country": "CA",
        "view": 35,
        "revenue": 2.0,
        "ecpm": 57.14,
    },
    ...
]

Beispiel 2: CSV-Umsatz

Anfrage


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

Rückgabe


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

Example 3: Placement

Anfrage

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

Rückgabe


[
    {
        "placement id" : "12345678",
        "placement name": "level 3",
        "views": 1234,
        "revenue": 123.0       
    }
]
Haben Sie Fragen? Anfrage einreichen

Kommentare