API de relatório 2.0 para anunciantes

Conteúdo

Visão geral

A API de relatório oferece aos anunciantes um modo programático de acessar dados apresentados no painel. Sua Chave de API de relatório é a mesma para todos os seus aplicativos. Cada aplicativo tem um ID de API de relatório único, que você encontra em sua respectiva página do aplicativo.

Host

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

Autenticação

A segurança é tratada no cabeçalho da solicitação. Encontre sua chave de API na página Relatórios em um painel Vungle. Se você ainda não tem uma chave de API, envie email para tech-support@vungle.com para solicitar uma!

Cabeçalhos de solicitação

Chave Valor Descrição
Authorization: Bearer [API Key] Chave de API
Vungle-Version: 1 Versão da API
Accept: text/csv ou application/json Formatos de dados aceitos para resultados. O padrão é text/csv.

 

Resultados

  • Formato: Suportamos saídas em JSON e CSV, especificado no cabeçalho de solicitação.
  • Faixa de data: Informação histórica está disponível para até seis meses. Para recuperar dados mais antigos, envie email para seu gerente de conta em tech-support@vungle.com.
  • Caso não existam dados: Observe que se não existem dados disponíveis para sua query, a Vungle retorna uma resposta 200 vazia. Isto indica que a solicitação foi bem sucedida, mas não existem dados disponíveis para retorno.

Recurso: GET /reports/spend

Parâmetros de filtro

Use parâmetros de filtro para restringir resultados de um sub-conjunto de seus dados de gasto. Muitos filtros são opcionais, para os quais a Vungle retorna todos os resultados para aquele filtro.

Nome do parâmetro Formato Ação Se indisponível Exemplo
start Data ISO8601 Limita o conjunto de resultado de dados de gastos a partir desta data Rejeita a solicitação start=2017-01-01
end Data ISO8601 Limita o conjunto de resultado de dados de gastos até esta data Rejeita a solicitação end=2017-01-02 
country  Lista de códigos de país ISO 3166-1 Alpha-2 separados por vírgula Retorna apenas dados de gastos que estejam nos países listados Retorna todos os países

country=US

country=US,CA

country=US,CA,AU
applicationId  Lista de IDs Vungle de aplicativo separados por vírgula para retorno Retorna apenas dados de gastos que estejam nos aplicativos listados Retorna todos os aplicativos

applicationId=586e201e242e3fd308000220

applicationId=586e201e242e3fd308000220,585849c3756684a50c0000a0
campaignId  Lista de IDs Vungle de campanha separados por vírgula para retorno Retorna apenas dados de gastos que estejam nas campanhas listadas Retorna todas as campanhas

campaignId=586e201e242e3fd308000220

campaignId=586e201e242e3fd308000220,585849c3756684a50c0000a0

creativeId  Lista de IDs Vungle de criativo separados por vírgula para retorno Retorna apenas dados de gastos que estejam nos criativos listados Retorna todos os criativos

creativeId=586e201e242e3fd308000220

creativeId=586e201e242e3fd308000220,585849c3756684a50c0000a0

siteID Lista de IDs Vungle de objeto de aplicativo de editor separados por vírgula para retorno Retorna apenas dados de gastos que estejam nos aplicativos listados Retorna todos os editores

siteId=586e201e242e3fd308000220

siteId=586e201e242e3fd308000220,585849c3756684a50c0000a0

Parâmetro de dimensões

Use dimensões para tornar seus relatórios mais ou menos granulares. Envie as dimensões como uma lista separada por vírgula em um parâmetro dimensions. Se você não solicitar explicitamente uma dimensão, o Vungle não gera o relatório por aquela dimensão.

Uso do parâmetro de dimensões

Nome do parâmetro Formato Exemplo
dimensions Lista de strings específicas separada por vírgula, listada na tabela abaixo

dimensions=platform

dimensions=campaign,creative,date

 

Dimensões disponíveis

Nome da 
dimensão
Retorna Retorno de exemplo
platform Agrupado por string de plataforma
platform
iOS
campaign Agrupado por ID e nome de campanha
campaign id campaign name
58086457cdf5f9eb6d000060 Toy Blast iOS CA iPhone
date  Agrupado por data 
date
2017-01-01
country Agrupado por país
country
US
creative Agrupado por ID e nome de criativo
creative id creative name
58086457cdf5f9eb6d000060 Toy Blast Landscape IEC
site Agrupado por ID e nome de objeto de aplicativo de editor
site id site name
58086457cdf5f9eb6d000060 Sonic Dash iOS

 

Para dimensões que requerem um lookup de nome (por exemplo, nome do site), se a Vungle não consegue recuperar o lookup, retornamos uma string 'Desconhecida' no lugar do nome.

Parâmetro de agregação

Use agregações para definir quais dados de desempenho interessam a você. Envie as agregações como uma lista separada por vírgula em um parâmetro aggregates. Se uma agregação não está na lista, a Vungle assume que você não deseja receber aqueles dados.

Uso do parâmetro de agregações

Nome do parâmetro Formato Exemplo
aggregates Lista de strings específicas separada por vírgula, listada na tabela abaixo

aggregates=views

aggregates=views,installs,ecpm

 

Agregações disponíveis

Nome da 
dimensão
Retorna
views Inteiro
completes Inteiro
clicks  Inteiro
installs  Inteiro
spend  Inteiro
ecpm (gasto * 1000 / visualizações) como um ponto flutuante

 

Queries e respostas de exemplo

Exemplo 1: JSON Spend

Solicitação

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"

Resposta


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

Exemplo 2: CSV Spend

Solicitação

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"

Resposta

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

Solicitação

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"

Resposta


[
    {
        "campaign id" : "12345678",
        "campaign name": "test campaign 1",
        "views": 1234,
        "spend": 123.0       
    }
]
Tem mais dúvidas? Envie uma solicitação

Comentários