Introdução
Este endpoint permite que os anunciantes enviem dados Vungle sobre cada evento de nível de usuário, se acontecer. O objetivo desta API de dados de evento é permitir que os anunciantes ajudem a Vungle a saber quais usuários são valiosos para você. Quando você nos envia informações de evento a partir do seu aplicativo, a Vungle pode otimizar suas campanhas para ajudá-lo a conquistar os usuários que mais interessam a você.
Conteúdo
Solicitação HTTP
http://ingest.vungle.com/eventData
POST
Suportamos solicitações POST
com os seguintes tipos de conteúdo de corpo:
-
application/x-www-form-urlencoded
-
application/json
Nota: A Vungle recomenda o uso do método POST
com um corpo JSON.
curl -H "Content-Type: application/json" -d '{"data": "myData"}' "http://ingest.vungle.com/eventData"
GET
Também suportamos solicitações GET
usando parâmetros de consulta.
curl "http://ingest.vungle.com/eventData?data=myData"
Parâmetros requeridos
Cada evento que você nos envia tem parâmetros obrigatórios e opcionais. Rejeitaremos as solicitações que não tiverem os parâmetros necessários e iremos avisá-lo quais estão faltando. Consulte a seção de erros para mais detalhes.
Identificador de dispositivo
Requeremos pelo menos UM identificador de dispositivo por evento, de forma que você não precisa passar todos.
Parâmetro | Descrição |
device_idfa |
Apple IDFA ou ID de anúncio do Google Play Services |
device_mac |
Endereço MAC em formato canônico, tendo hífen ou vírgula como separador |
device_other_id |
Algum outro identificador único, e.g. ID Android, identificadores hashed, etc. |
Nota: A Vungle recomenda o uso de device_idfa sempre que possível!
Outros parâmetros requeridos
Você precisa passar todos os parâmetros requeridos remanescentes para que possamos aceitar o evento.
Parâmetro | Descrição |
vungle_app_id |
O ID do aplicativo é fornecido no painel Vungle |
trk |
Fonte do evento de entrada. No caso de uma integração servidor-a-servidor, você deve usar um autoidentificador; deve também identificar o provedor de rastreamento, e.g. ‘tune’, 'kochava’,'adjust’,'appsflyer’,etc. |
event_trk_id |
Este deve ser um identificador que seja único para o evento. Usado para evitar duplicidade. |
event_id |
O identificador de evento Vungle. Se este evento foi realizado por um usuário direcionado para seu aplicativo por campanha Vungle, este identificador foi passado a você no rastreamento de visualização ou clique. |
event_name |
Este deve ser uma string que identifica o evento que é consistente pelos usuários, e.g. 'tutorial-complete’, 'level-3’, 'purchase' etc. |
Exemplos:
Um exemplo POST
corpo:
{
"device_idfa" : "236A005B-700F-4889-B9CE-99",
"vungle_app_id" : "myVungleApp",
"trk" : "tune",
"event_trk_id" : "uniqueID1234",
"event_name" : "tutorial-complete"
}
Um exemplo de solicitação GET
:
curl "http://ingest.vungle.com/eventData?device_idfa=236A005B-700F-4889-B9CE-999EAB2B605D&vungle_app_id=myVungleApp&trk=tune&event_trk_id=uniqueID1234&event_name=tutorial-complete"
As cargas de trabalho acima iriam retornar uma resposta '200 OK' e são exemplos da solicitação mínima que você pode enviar para a Vungle.
Parâmetros opcionais
Estes parâmetros são opcionais, mas são importantes para que a Vungle determine quais são os usuários de valor, de modo que você deve passar a maior quantidade possível.
Parâmetro | Padrão | Descrição |
event_value | Nenhum | Algum valor numérico associado com o evento. Deve ser relativo a outros eventos que você envia à Vungle. Por exemplo, um IAP $4.99 deve ser 4.99. |
event_currency |
'usd' |
Se event_value é um valor monetário explícito, defina a moeda aqui. |
event_iap_event |
false |
Defina uma flag para declarar se o evento foi uma compra feita dentro do aplicativo. |
device_limit_track |
false |
Booleano para determinar se o dispositivo tem uma definição 'limite de rastreamento de anúncio'. |
event_datetime |
Data e hora da recepção do evento | Data e hora da ocorrência do evento. Se o fuso horário não for especificado, assume-se UTC. A data e hora devem ser no formato ISO 8601. |
device_ip |
Nenhum | Endereço IP do dispositivo. |
device_make |
Nenhum | Fabricante do dispositivo. |
device_model |
Nenhum | Modelo do dispositivo. |
device_carrier |
Nenhum | Operadora de celular do dispositivo. |
device_language |
Nenhum | Código ISO 639-1 de idioma do dispositivo (2 dígitos). |
device_country |
Nenhum | Código ISO 3166 do país do IP de origem (2 dígitos). |
device_user_agent |
Nenhum | Agente de usuário do navegador do dispositivo. |
device_os |
Nenhum | Número de versão do sistema operacional. |
Nota: Certifique-se de anotar o parâmetro event_value
e considerar os valores para cada evento. A Vungle é agnóstica quanto aos números reais utilizados, mas os eventos devem ter valores que tenham valor relativo uns aos outros. A Vungle procurará maximizar o valor geral dos tipos de usuários que enviamos a você.
Exemplo de parâmetros opcionais
{
"event_currency" : "usd",
"event_iap_event" : true,
"device_limit_track" : false,
"event_datetime" : "2015-03-15T13:27:36Z",
"device_ip" : "201.15.25.11",
"device_make" : "samsung",
"device_model" : "sm-g900v",
"device_carrier" : "verizon",
"device_language" : "es",
"device_country" : "us",
"device_user_agent" : "Mozilla/5.0 (Linux; U; Android 2.2.1; fr-fr; HTC_DesireZ_A7272 Build/FRG83D) AppleWebKit/533.1 (KHTML, like Gecko), Version/4.0 Mobile Safari/533.1",
"device_os" : "4.3.2",
"event_value" : 1.99
}
Códigos de erro
Retornamos os seguintes códigos:
Código de erro | Significado |
200 |
OK - Obrigado! |
400 |
Solicitação incorreta - Sua solicitação não é válida. Muito provavelmente você omitiu um ou mais parâmetros obrigatórios. Verifique o corpo da resposta para pistas. |
500 |
Erro interno de servidor - Tivemos um problema com nosso servidor. Tente novamente mais tarde. |
503 |
Serviço indisponível - Estamos temporariamente fora para manutenção. Tente novamente mais tarde. |
Se respondermos com um '400 BAD REQUEST', verifique o corpo da resposta. Faremos o possível para diagnosticar o problema, o que muito provavelmente será um ou dois campos que estão faltando. Por exemplo,
curl "http://ingest.vungle.com/eventData?trk=tune&event_trk_id=uniqueID1234"
Retornaria uma resposta que se parece com isto:
{
"missing_fields":
[
"vungle_app_id",
"trk",
"event_trk_id",
"event_name",
"device_idfa | device_mac | device_other_id"
]
}