API de rapport 2.0 pour les publicitaires

Contenu

Présentation

L'API de rapport permet aux publicitaires d'accéder par programmation aux données présentes sur le tableau de bord. Votre clé d'API de rapport est identique pour toutes vos applications. Chaque application possède un ID d'API de rapport unique, que vous pouvez trouver sur sa page.

Hôte

Hôte : https://report.api.vungle.com/ext/adv/reports/spend

Authentification

La sécurité est gérée dans l'en-tête de demande. Trouvez votre clé d'API dans la page des rapports sur le tableau de bord. Si vous ne disposez pas déjà d'une clé d'API, envoyez un e-mail à l'adresse tech-support@vungle.com pour en demander une !

En-têtes de demande

Clé Valeur Description
Authorization: Bearer [API Key] Clé d'API
Vungle-Version: 1 Version d'API
Accept: text/csv ou application/json Format de données accepté pour les résultats. Par défaut text/csv.

 

Résultats

  • Format : nous prenons en charge les formats JSON et CSV, spécifiés dans l'en-tête de demande.
  • Plage de date : des informations historiques sont disponibles pendant 6 mois. Pour récupérer d'anciennes données, envoyez un e-mail à votre gestionnaire de compte à l'adresse tech-support@vungle.com.
  • En cas d'absence de données: notez que si aucune données n'est disponible pour votre requête, Vungle renvoie 200 réponses vides. Cela indique que la demande a réussie, mais qu'il n'y a aucune donnée disponible à renvoyer.

Ressources : GET /reports/spend

Paramètres de filtre

Utilisez les paramètres de filtre pour restreindre les résultats à un sous-ensemble de vos données de dépenses. La plupart des filtres sont facultatifs, auquel cas Vungle renvoie tous les résultats pour ce filtre.

Nom du paramètre Format Action Si indisponible Exemple
start Date ISO8601 Limite l'ensemble de résultats aux données de dépenses à partir de cette date Rejette une demande start=2017-01-01
end Date ISO8601 Limite l'ensemble de résultats aux données de dépenses jusqu'à cette date Rejette une demande end=2017-01-02 
country  Liste séparée par des virgules de codes de pays ISO 3166-1 Alpha-2 Renvoie uniquement des données de dépenses correspondant aux pays répertoriés Renvoie tous les pays

country=US

country=US,CA

country=US,CA,AU
applicationId  Renvoie une liste séparée par des virgules d'ID d'application Vungle Renvoie uniquement des données de dépenses pour les applications répertoriées Renvoie toutes les applications

applicationId=586e201e242e3fd308000220

applicationId=586e201e242e3fd308000220,585849c3756684a50c0000a0
campaignId  Renvoie une liste séparée par des virgules d'ID de campagne Vungle Renvoie uniquement des données de dépenses pour les campagnes répertoriées Renvoie toutes les campagnes

campaignId=586e201e242e3fd308000220

campaignId=586e201e242e3fd308000220,585849c3756684a50c0000a0

creativeId  Renvoie une liste séparée par des virgules d'ID de créateurs Vungle Renvoie uniquement des données de dépenses pour les créateurs répertoriés Renvoie tous les créateurs

creativeId=586e201e242e3fd308000220

creativeId=586e201e242e3fd308000220,585849c3756684a50c0000a0

siteID Renvoie une liste séparée par des virgules d'ID d'objet d'application de l'éditeur Renvoie uniquement des données de dépenses pour les applications répertoriées Renvoie tous les éditeurs

siteId=586e201e242e3fd308000220

siteId=586e201e242e3fd308000220,585849c3756684a50c0000a0

Paramètre des dimensions

Utilisez les dimensions pour réaliser vos rapports plus ou mois granulaires. Envoyez les dimensions sous forme de liste séparée par des virgules sous un paramètre dimensions. Si vous ne demandez pas explicitement une dimension, Vungle ne décompose pas le rapport jusqu'à cette dimension.

Utilisation du paramètre des dimensions

Nom du paramètre Format Exemple
dimensions Liste séparée par des virgules de chaînes spécifiques, répertoriées dans le tableau ci-dessous

dimensions=platform

dimensions=campaign,creative,date

 

Dimensions disponibles

Nom de la 
dimension
Renvoie Exemple de renvoi
platform Groupé par chaîne de plateforme
platform
iOS
campaign Groupé par ID de campagne et nom de campagne
campaign id campaign name
58086457cdf5f9eb6d000060 Toy Blast iOS CA iPhone
date  Groupé par date 
date
2017-01-01
country Groupé par pays
country
US
creative Groupé par ID de créateur et nom de créateur
creative id creative name
58086457cdf5f9eb6d000060 Toy Blast Landscape IEC
site Groupé par ID d'objet d'application de l'éditeur et nom d'application de l'éditeur
site id site name
58086457cdf5f9eb6d000060 Sonic Dash iOS

 

Pour les dimensions exigeant une recherche de nom (par exemple, nom du site), si Vungle est incapable de récupérer la recherche, nous renvoyons une chaîne « Inconnu » à la place du nom.

Paramètre des agrégats

Utilisez les agrégats pour définir les données de performances qui vous intéressent. Envoyez les agrégats sous forme de liste séparée par des virgules sous un paramètre agrégats. Si un agrégat ne se trouve pas dans la liste, Vungle suppose que vous ne souhaitez pas recevoir cette donnée.

Utilisation du paramètre des agrégats

Nom du paramètre Format Exemple
aggregates Liste séparée par des virgules de chaînes spécifiques, répertoriées dans le tableau ci-dessous

aggregates=views

aggregates=views,installs,ecpm

 

Agrégats disponibles

Nom de la 
dimension
Renvoie
views integer
completes integer
clicks  integer 
installs  integer
spend  integer
ecpm (dépenses * 1000 / vues) comme un nombre flottant

 

Exemples de questions et de réponses

Exemple 1 : dépenses JSON

Demande

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éponse


[
    {
        "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
    },
    ...
]

Exemple 2 : dépenses CSV

Demande

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éponse

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

Demande

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éponse


[
    {
        "campaign id" : "12345678",
        "campaign name": "test campaign 1",
        "views": 1234,
        "spend": 123.0       
    }
]
Vous avez d’autres questions ? Envoyer une demande

Commentaires