API de generación de informes 2.0 para editores

Contenido

Descripción general

La API de generación de informes ofrece a los editores una manera programática para acceder a los datos en el panel de control. Su clave de la API de generación de informes es la misma para todas sus aplicaciones. Cada aplicación cuenta con una ID de API de generación de informes única, que se encuentra en la página de la aplicación correspondiente.

Host

Host: https://report.api.vungle.com/ext/pub/reports/performance

Autenticación

La seguridad se controla en el encabezado de la solicitud. Encuentre la clave de su API en la página de informes en el panel de control de Vungle. Si aún no cuenta con una clave para API, envíe un correo electrónico a tech-support@vungle.com para solicitar una.

Encabezados de las solicitudes

Clave Valor Descripción
Authorization: Bearer [API Key] Clave de la API
Vungle-Version: 1 Versión de la API
Accept: text/csv or application/json Accepted data format for results. Default is text/csv.

 

Resultados

  • Formato: admitimos formatos JSON y CSV.
  • Alcance de los datos: se encuentra disponible información histórica de más de seis meses. Para recuperar datos anteriores, envíe un correo electrónico al gerente de cuentas: tech-support@vungle.com.
  • En el caso de que no hayan datos: tenga en cuenta que si no hay datos disponibles para su consulta, Vungle enviará una respuesta vacía tipo 200. Esto indica que la solicitud se realizó correctamente, pero no hay datos disponibles.

Recursos: GET /informes/rendimiento

Parámetros de filtro

Use los parámetros de filtro para limitar los resultados a un subconjunto de datos de rendimiento. La mayoría de los filtros son opcionales. Si se selecciona un filtro, Vungle devuelve todos los resultados de ese filtro.

Nombre del parámetro Formato Medida Si no está disponible Ejemplo
start Fecha según ISO8601 Limita los resultados establecidos para los datos de rendimiento a partir de esta fecha Se rechaza la solicitud start=2017-01-01
end Fecha según ISO8601 Limita los resultados establecidos para los datos de rendimiento hasta esta fecha Se rechaza la solicitud end=2017-01-02 
country  Lista separada por comas de códigos de países según ISO 3166-1 Alpha-2 Devuelve solo los datos de rendimiento que coinciden con los países en la lista Devuelve los datos de todos los países

country=US

country=US,CA

country=US,CA,AU
applicationId  Lista separada por comas de las ID de las aplicaciones de Vungle que se desean Devuelve solo los datos de rendimiento de las aplicaciones en la lista Devuelve los datos de todas las aplicaciones

applicationId=586e201e242e3fd308000220

applicationId=586e201e242e3fd308000220,585849c3756684a50c0000a0
incentivized ‘true’/’false’ or 1/0 Devuelve solo los datos de rendimiento del tráfico de anuncios incentivados o no incentivados Devuelve los datos de rendimiento del tráfico de anuncios incentivados y no incentivados

incentivized=true

incentivized=false

Parámetro de dimensiones

Utilice las dimensiones para que sus informes sean más o menos granulares. Envíe las dimensiones como una lista separada por comas con un parámetro de dimensiones. Si no solicita explícitamente una dimensión, Vungle no clasificará el informe en función de esa dimensión.

Cómo usar el parámetro de dimensiones

Nombre del parámetro Formato Ejemplo
dimensions Lista separada por comas de cadenas específicas, en la tabla a continuación

dimensions=platform

dimensions=application,date,country

 

Dimensiones disponibles

Nombre de 
la dimensión
Devuelve Ejemplo de devolución
platform Agrupados por cadena de plataforma
platform
iOS
application Agrupados por ID y nombre de aplicación de Vungle
application id application name
58086457cdf5f9eb6d000060 Sonic Dash
placement Agrupados por ID de ubicación y nombre
placement id placement name
12345678 Level 3
date  Agrupados por fecha 
date
2017-01-01
country Agrupados por país
country
US
incentivized Agrupados por tráfico de anuncios incentivados
incentivized
verdadero
falso

En el caso de las dimensiones que requieren la búsqueda de un nombre (por ejemplo, el nombre de la aplicación), si Vungle no puede recuperar la búsqueda, se devuelve una cadena "Desconocido" en lugar del nombre.

Parámetro de agregados

Use agregados para definir los datos de rendimiento que le interesan. Envíe agregados como una lista separada por comas con un parámetro de agregados. Si un agregado no está en la lista, Vungle asume que no desea recibir esos datos.

Cómo usar el parámetro de agregados

Nombre del parámetro Formato Ejemplo
aggregates Lista separada por comas de cadenas específicas, en la tabla a continuación

aggregates=views

aggregates=views,installs,ecpm

 

Agregados disponibles

Nombre de 
la dimensión
Devuelve
views entero
completes entero
clicks  entero 
revenue  entero
ecpm (ingresos del editor * 1000 / vistas) como un float

  

Ejemplos de consultas y respuestas

Ejemplo 1: ingresos en JSON

Solicitud


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"

Respuesta


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

Ejemplo 2: ingresos en CSV

Solicitud


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"

Respuesta


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

Example 3: Placement

Solicitud

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"

Respuesta


[
    {
        "placement id" : "12345678",
        "placement name": "level 3",
        "views": 1234,
        "revenue": 123.0       
    }
]
¿Tiene más preguntas? Enviar una solicitud

Comentarios