API InCost para ad networks

Para:
Ad Networks
Última atualização:

Visão geral: A API InCost, parte do AppsFlyer ROI360, permite que ad networks enviem programaticamente dados de custos de publicidade para a AppsFlyer. Isso fornece aos anunciantes dados de custo agregados e permite que eles entendam o verdadeiro impacto da sua rede.

Sobre a API InCost

A API InCost é a solução ideal para redes de anúncios enviarem dados de custo para a AppsFlyer. Os parceiros da ad network enviam dados detalhados de custos de publicidade para a AppsFlyer usando a API. A AppsFlyer ingere e processa os dados e os disponibiliza para anunciantes e parceiros por meio de painéis e relatórios.

Benefícios

  • Ajude seus clientes a entender o verdadeiro impacto da sua rede com relatórios de custos sem atrito. Sem dados de custo, seus clientes perdem uma peça crucial do quebra-cabeça de mensuração e não conseguem medir o ROAS com precisão. Dessa forma, eles podem investir erroneamente em outros canais de mídia, impactando negativamente seus resultados financeiros.
  • Comprove seu ROI com uma solução que garante mensuração de custos precisa, completa e em tempo real.
  • A API InCost é rápida e simples de implantar, e o impacto é quase imediato. Você também obtém controle total sobre como e quando envia os dados, incluindo a capacidade de enviar dados de custo de até 90 dias atrás.
  • A API InCost é compatível com todos os modelos de preços de campanha, não apenas ao CPI (que é o único modelo disponível ao enviar custo por clique).
  • Destaque-se na AppsFlyer Partner Marketplace com um selo de “Custo” que indica que este é um recurso compatível.

Implementando a API InCost

Pré-requisitos: Para elegibilidade à API InCost, sua ad network requer:

  • Que 90% das campanhas contêm o ID da campanha na atribuição.
  • Capacidade de enviar dados pelo menos 6 vezes por dia para maior atualização dos dados. Os horários específicos ficam a critério da ad network.
  • [Se a ad network atualizar dados retroativamente] A capacidade de enviar dados dos últimos 7 dias sempre, para maior conclusão de dados.

Para implementar a API InCost e começar a enviar dados de custo para o AppsFlyer:

  • Siga as etapas na tabela a seguir.
Etapa # Ação 
1

Solicitar o InCost:

  1. Na AppsFlyer, no menu superior, selecione Ajuda > Entre em contato com nossa equipe.
    O widget Assistente de parceiro é aberto.
  2. Selecione Habilitar mensuração de custos e envie suas informações.
    Após o envio, um ticket será aberto e um engenheiro de soluções para parceiros da AppsFlyer entrará em contato com você.
2 Certifique-se de que as hierarquias de campanha (ID da campanha e, opcionalmente, ID do conjunto de anúncios e ID do anúncio) estejam incluídas nos seus links de atribuição para mais de 90% do seu tráfego.
3

Obtenha o Token de API da AppsFlyer no dashboard da AppsFlyer.
4

Envie o token da API ao seu desenvolvedor para usar no cabeçalho de autorização da API e peça que ele siga as instruções para implementar os três métodos da API:

  1. Obtenha a lista de aplicativos.
  2. Upload do inCost: Informe ao desenvolvedor com quais campos preencher o JSON:
    • Campos obrigatórios devem ser preenchidos. Ou seja, não envie campos vazios. 
    • O canal de mídia é restrito aos canais de mídia associados (registrados) à sua conta de ad network. Obtenha a lista com seu gerente de desenvolvimento de parceiros.
    • Leve em consideração o fuso horário do aplicativo (conforme relatado pela API Obter lista de permissões do aplicativo) para alinhar as datas dos dados de custo com as do aplicativo.
    • Se houver campos que não fazem parte da hierarquia de relatórios de custos da sua campanha, não os inclua. Por exemplo, ID do conjunto de anúncios, nome do ativo, ID do anúncio, nome do anúncio.
  3. Obtenha o status de trabalho.
6

No tópico do ticket (da etapa 1), notifique a AppsFlyer que a implementação da API foi concluída e aguarde a confirmação de que sua integração está operacional.
7

Certifique-se de que seus anunciantes habilitem Obter dados de custo na aba de custo da página de parceiro integrado da AppsFlyer. Dessa forma, eles começarão a receber dados de custos.

Campos para InCost Upload JSON

Campo

Obrigatório

Observações

data

Sim
  • Data do gasto
  • Formato: YYYY-MM-DD
  • Exemplo:2019-12-30
app_id

Sim
  • O ID do aplicativo conforme aparece na plataforma AppsFlyer
  • Formato: String de até 250 caracteres
  • Exemplo: Android:com.app.name, iOS: id123456789

media_source

Sim
  • Nome da rede (ID) que exibe o anúncio associado à sua conta de parceiro de ad network da AppsFlyer
  • Formato: String 50 caracteres
  • Exemplo: network_int

af_prt

Não*
  • Obrigatório para atribuição de agência e dados de custo.
  • Nome da agência conforme exibido no link de atribuição e associado à conta da agência na AppsFlyer.
  • Formato: String 50 caracteres
  • Exemplo: agencya

campaign_id

Sim
  • Deve ser idêntico ao af_c_idparâmetro enviado no link de atribuição
  • Não é permitido um string vazio
  • Formato: String 24 caracteres
  • Exemplo: 123abc

campaign_name

Sim
  • Formato: String 100 caracteres
  • Exemplo: my_campaign123

adset_id

 Não*
  • Obrigatório se você enviar adset_name
  • Deve ser idêntico ao af_adset_idparâmetro enviado no link de atribuição
  • Se o seu relatório de custos não for compatível adset_id, nunca o envie
  • Formato: String 24 caracteres
  • Exemplo: 123A

adset_name

Não
  • Se você enviar este campo, você também deve enviar adset_id
  • Formato: String 100 caracteres
  • Exemplo:my_adset_name

ad_id

Não*
  • Obrigatório se você enviar ad_name.
  • Esse campo deve ser idêntico ao parâmetro af_ad_id enviado no link de atribuição
  • Se o seu relatório de custos não for compatível adset_id, nunca o envie
  • Formato: String 24 caracteres
  • Exemplo:123AB

site_id

Não
  • ID exclusivo que identifica o publisher que exibe o anúncio.
  • Formato: String 24 caracteres.

ad_name

Não
  • Se você enviar este campo, você também deve enviar ad_id
  • Formato: String 100 caracteres
  • Exemplo:Ad-name

geo

Não
  • O país que você registrou como associado ao custo
  • Sempre que possível, isso deve representar o país onde o anúncio foi exibido
  • Formato: Código de país ISO 3166 de 2 caracteres
  • Exemplo:US, CN, ZA
currency

Sim
  • Tipo de moeda do gasto
  • Formato: Código de moeda ISO 4217 de 3 caracteres
  • Exemplo: USD, EUR, ZAR
spend Sim
  • Valor do gasto usando a moeda especificada 
  • Cinco dígitos permitidos após a vírgula
  • O valor 0 (zero) é permitido
  • Valores negativos NÃO são permitidos
  • Não envie,delimitadores
  • Não envie valores entre aspas. 
  • Formato: Número decimal
  • Valores de exemplo: 1 1.2 1234.20
channel Não
  • Deve ser idêntico ao parâmetro af_channel enviado no link de atribuição
  • Formato: String 20 caracteres
  • Exemplo:my_channel
keywords Não
  • Formato: String 100 caracteres
  • Exemplo:abc app

* Veja a coluna de observações, pois em alguns casos é necessário enviar este campo.