Resumo: envie dados brutos de eventos de atribuição para seus endpoints do lado do servidor.
Push API
A Push API transmite dados brutos gerados pela atribuição da AppsFlyer e pela atribuição da SKAdNetwork na forma de mensagens para seus servidores. Você pode selecionar os tipos de mensagens e o conteúdo, além de definir os endpoints de destino.
Os tipos de mensagem disponíveis, a atualização dos dados e os campos dependem da estrutura de atribuição (AppsFlyer ou SKAN), conforme descrito nas seções a seguir.
Mensagens de atribuição da AppsFlyer
Características da mensagem
Características | Detalhes |
---|---|
Separação por tipo de mensagem |
Exemplo: Uma mensagem contém o seguinte:
Use a tabela para determinar se esse evento é o evento de instalação de um usuário orgânico. |
Atualização dos dados | As mensagens são enviadas logo após o evento ser registrado na plataforma da AppsFlyer. Isso geralmente ocorre em poucos minutos. |
Conteúdo da mensagem (campos) |
|
Formato dos campos de carimbo de data/hora |
|
Tipos de mensagens disponíveis
Contexto de atribuição | Tipo de mensagem | campo conversion_type | campo campaign_type | campo event_name | campo event_type |
---|---|---|---|---|---|
Aquisição de usuários | Instalação* | install |
Non-organic: UA Organic: organic |
install |
|
Aquisição de usuários | Eventos in-app de instalação | install |
Non-organic: UA Organic: organic |
Advertiser-defined event names |
|
Retargeting | Reengajamento | re-engagement | retargeting | re-engagement | re-attribution |
Retargeting | Eventos in-app de reengajamento | re-engagement | retargeting | Advertiser-defined event names | re-engagement-in-app-event |
Retargeting | Re-atribuição | reinstall | retargeting | re-attribution | re-attribution |
Aquisição de usuários | Reinstalação | reinstall |
Non-organic: UA Organic: organic |
reinstall |
|
Retargeting | Eventos in-app de reatribuição | reinstall | retargeting | Advertiser-defined event names | re-attribution-in-app-event |
* Algumas instalações relacionadas à atribuição de view-through são atribuídas a uma fonte de mídia restrita. |
Campos exclusivos
Nome exibido | Nome na Push API |
---|---|
Moeda selecionada* | selected_currency |
Receita na moeda selecionada | revenue_in_selected_ currency |
Custo na moeda selecionada | cost_in_selected_ currency |
Fuso horário selecionado para o download do dispositivo | device_download_time_selected_timezone |
Fuso horário selecionado por hora de atribuição do toque | attributed_touch_time_selected_timezone |
Hora de instalação no fuso horário selecionado | install_time_selected_ timezone |
Hora do evento no fuso horário selecionado | event_time_selected_ timezone |
Fuso horário selecionado(*) | selected_timezone |
* Essa é a configuração no nível do aplicativo em vigor no momento em que a mensagem da API é enviada. |
Mensagens de atribuição da SKAN
Essa seção descreve as mensagens (tipos de relatório) disponíveis para SKAN e como identificá-las. Leia o conteúdo e, em seguida, configure o endpoint de atribuição da SKAN.
Leitura adicional: campos de dados brutos da SKAN. As mensagens da Push API têm estrutura e campos equivalentes.
Características da mensagem:
Características | Detalhes |
---|---|
Separação por tipo de mensagem |
Exemplo: Uma mensagem contém o seguinte:
A partir disso, podemos determinar que:
|
Atualização dos dados |
|
Exemplos de mensagens | A planilha contém exemplos de mensagens. O exemplo fornecido tem um formato JSON. Exemplos de mensagens SKAN. |
Tipos de mensagens para atribuição da SKAN
Tipo de mensagem | campo event_name | campo skad_redownload | campo event_type |
---|---|---|---|
Instalações | install |
|
skad-install |
Re-downloads | install | True | skad-re-download |
Eventos in-app | O nome do evento definido pelo anunciante | O nome do evento definido pelo anunciante | skad-in-app-event |
Postbacks do iOS | Nunca disponíveis nessa mensagem | Às vezes disponíveis | skad-postback |
Cópia de postbacks | Nunca disponível nessa mensagem | Às vezes disponível | skad-postback-copy |
Configurar endpoints da Push API
Atenção
Você não deve usar a Push API para enviar dados atribuídos da AppsFlyer a terceiros pelos seguintes motivos:
- Você pode violar regulamentos de privacidade, como a CCPA, se o usuário optar por não enviar seus dados a terceiros.
- Algumas fontes de mídia restringem a forma como os dados a nível do usuário fornecidos por elas são usados, compartilhados com terceiros ou ambos. Certifique-se de cumprir os termos de uso da fonte de mídia.
Por exemplo, X Ads, Snapchat, Pinterest.
Atenção: isso não se aplica aos dados SKAN. Use a Push API para enviar dados SKAN para endpoints de terceiros.
Para configurar a Push API, preencha a lista de ações abaixo.
Checklist de configuração da Push API
Etapa | Atribuição da AppsFlyer | Atribuição na SKAdNetwork |
---|---|---|
1 |
Se você já possui um endpoint ativo da Push API, pode pular essa etapa. Complete os requisitos do lado do servidor. |
|
2 | Para atribuição da AppsFlyer, planeje as configurações do endpoint usando a checklist da Push API. | Não aplicável |
3 | Configure o endpoint de atribuição da AppsFlyer | Configure o endpoint de atribuição da SKAdNetwork |
Requisitos do lado do servidor (seu servidor)
Verifique se o seu servidor cumpre com os requisitos listados aqui:
Requisitos do lado do servidor
URL do endpoint |
|
Código de retorno do endpoint | Ao receber uma mensagem, seu endpoint deve retornar um código de status HTTP 200. |
Incluir servidores da AppsFlyer na lista de permissões | Inclua os endereços IP do servidor da AppsFlyer na lista de permissões dos seus sistemas de firewall e segurança para garantir a comunicação com o endpoint. |
Versões TLS |
|
Portas | Portas: 80, 443 |
Atenção! Um mecanismo de tempo limite, com duração de 4 segundos, é usado. Se a AppsFlyer não receber uma mensagem de OK durante esse período, isso será considerado uma falha no envio da mensagem.
Checklist para o planejamento da Push API para atribuição na AppsFlyer
- Use essa checklist para planejar suas configurações de endpoint de atribuição na AppsFlyer. Os números na figura correspondem aos números de linha no checklist.
- Essa seção não é relevante para a atribuição na SKAdNetwork. Consulte o artigo configurar a atribuição da SKAdNetwork.
Endpoint
Tabela de planejamento do endpoint
Não. | Configuração | Detalhes | Use essa coluna para registrar suas configurações planejadas |
---|---|---|---|
1 | Método | POST ou GET | |
2 | URL do endpoint | - | |
3 | Tipos de mensagem de evento |
|
|
4 |
|
AvisoSe você marcar Selecionar tudo, os arquivos recém-adicionados também serão selecionados automaticamente. Certifique-se de que você pode oferecer suporte a todos os novos campos adicionados automaticamente ao esquema para evitar problemas.
|
|
5 |
Tipo de evento in-app
|
Filtre por evento in-app para reduzir o tráfego enviado ao seu endpoint.
|
Configure o endpoint de atribuição da AppsFlyer
Atenção: Somente o proprietário da conta da AppsFlyer pode fazer alterações nas configurações da Push API. Outros usuários da conta podem visualizar as configurações.
Adicione um endpoint de atribuição da AppsFlyer
- Acesse relatórios > acesso à API. Vá até a seção da Push API.
- Clique em Adicionar Endpoint.
- Selecione um método HTTP: POST ou GET
- Insira a URL do Endpoint/strong>. Se você receber a mensagem "essa URL não é segura", entre em contato com o suporte da AppsFlyer.
- Selecione um ou mais tipos de evento. Atenção: se as mensagens de evento in-app estiverem desativadas, isso significa que nenhum evento in-app foi gravado até o momento.
- Selecione os campos para preencher a mensagem da Push API. Atenção:
- campos obrigatórios sempre enviados: App ID, nome do evento, horário do evento, IDFA (iOS) ou Advertising ID (Android)
- Use os controles representados na figura a seguir para selecionar campos opcionais.
- Os campos mais comuns são pré-selecionados por padrão. Você pode cancelar as seleções.
- Selecione os campos opcionais conforme necessário.
- Use Limpar tudo para limpar todos os campos opcionais.
- Não enviamos campos vazios/nulos e a chave associada. Leve isso em conta ao planejar seus processos de importação/análise.
- Selecione um ou mais (até 52 eventos) ou Todos os eventos in-app.
- A lista é preenchida por tipos de eventos que já foram gravados. Se estiver faltando um evento, envie um evento desse tipo usando um dispositivo de teste.
- Clique em Salvar.
A Push API agora está ativa. Os dados de conversão são enviados para o endpoint. - Teste o endpoint usando o procedimento a seguir.
Para testar o endpoint:
- Clique Enviar teste.
Uma mensagem de resultado do teste é exibida abaixo do botão Enviar teste.
Uma mensagem de teste é enviada para o endpoint. Se o teste falhar, certifique-se de que você incluiu os endereços de IP da AppsFlyer na lista de permissões.
Atenção! Um mecanismo de tempo limite, com duração de 2 segundos, é usado. Se a AppsFlyer não receber uma mensagem de OK durante esse período, isso será considerado uma falha no envio da mensagem. - Verifique se o endpoint recebeu a mensagem de teste.
Veja uma cópia da mensagem enviada.
Configure o endpoint de atribuição da SKAdNetwork
Atenção: Somente o proprietário da conta da AppsFlyer pode fazer alterações nas configurações da Push API. Outros usuários da conta podem visualizar as configurações.
Para adicionar um endpoint da Push API da SKAdNetwork:
- Acesse relatórios > acesso à API. Vá até a seção da Push API.
- Selecione SKAdNetwork como a entidade de atribuição.
- Clique em Adicionar endpoint.
Atenção: Você pode definir de 1 a 3 endpoints da SKAdNetwork por aplicativo. - Selecione um método HTTP: POST ou GET
- Insira a URL doEndpoint. Se você receber a mensagem "essa URL não é segura", entre em contato com o suporte da AppsFlyer.
- Não enviamos campos vazios/nulos e a chave associada. Leve isso em conta ao planejar seus processos de importação/análise.
- Clique em Salvar.
A Push API agora está ativa. Os dados são enviados para o endpoint.
Configurar token de autenticação
Usando o token de autenticação da Push API, os clientes podem integrar e proteger suas mensagens da Push-API de forma contínua, adicionando um header de autorização personalizável com um token solicitado.
Você pode personalizar um header de autorização que será enviado com suas mensagens da Push-API, definindo o nome do token e o valor associado a cada app ID. Isso garante que suas mensagens não sejam apenas seguras, mas também adaptadas às suas necessidades específicas.
Procedimentos adicionais — gerenciando endpoints
Alterar um endpoint
Atenção: somente o proprietário da conta da AppsFlyer pode fazer alterações nas configurações da Push API. Outros usuários da conta podem visualizar as configurações.
Para modificar as configurações do endpoint:
- Vá para Relatório > Acesso à API. Vá até a seção da Push API.
- Localize o endpoint a ser modificado.
- Faça as alterações.
- Clique em Salvar.
Excluir um endpoint
Atenção: somente o proprietário da conta da AppsFlyer pode fazer alterações nas configurações da Push API. Outros usuários da conta podem visualizar as configurações.
Para excluir um endpoint:
- acesse relatórios > acesso à API. Vá até a seção da Push API.
- Clique em excluir endpoint.
- Clique em salvar.
O endpoint é removido.
Solução de problemas, características e limitações
Falha nas mensagens de teste
Se você não receber a mensagem de teste e restringir o acesso aos seus servidores por endereço IP: certifique-se de que você incluiu todos os endereços IP da AppsFlyer na lista de permissões.
Duplicar eventos in-app de retargeting
Os eventos de retargeting in-app são duplicados quando um evento de compra ocorre como parte da campanha de retargeting durante uma janela de reengajamento de UA. Isso é feito para atribuir receita à fonte de mídia de UA e à fonte de mídia de retargeting.
Você só receberá eventos duplicados se ambos estiverem ativos:
- Eventos in-app à instalação
- Eventos in-app relacionados ao retargeting
Identificar e desduplicar eventos in-app
A seleção de mensagens de eventos in-app está desativada
- Mensagens de eventos in-app só podem ser selecionadas após a gravação de um evento in-app.
- Use um dispositivo de teste para gerar um evento in-app ou use a API S2S para fazer isso manualmente.
Mensagens de push e CloudFront ausentes
Você está usando Amazon CloudFront como seu endpoint? Nesse caso, verifique se o CloudFront está rejeitando a mensagem com o código 421. Se sim, consulte o artigo Como o CloudFront atende solicitações de HTTPS.
Mensagens de erro de endpoint
Sintoma: a mensagem essa URL não é segura é exibida quando você configura a URL do endpoint.
Ação necessária: entre em contato com o suporte da AppsFlyer, inclua o App ID, a URL do endpoint e uma captura de tela da mensagem de erro.
Características e limitações
Caraterística | Observações |
---|---|
Ad networks | Indisponível. |
Agências | Indisponível. |
Fuso horário específico do aplicativo | Disponível |
Moeda específica do aplicativo | Disponível |
Limitações de tamanho | Não aplicável |
Orgânico | Sim |
Não orgânico | Sim |
Atualização dos dados | Contínuo |
Histórico de dados | Indisponível. Se faltarem dados, use a Pull API para obter os dados. No caso da SKAN, você pode obter alguns históricos de dados por meio do Data Locker (limitado pela janela de disponibilidade do Data Locker). |
Acesso do proprietário da conta/usuário |
Somente o proprietário da conta da AppsFlyer pode fazer alterações nas configurações da Push API.
Outros usuários de conta podem visualizar as configurações da Push API, mas não podem fazer mudanças. |
Token de autenticação em mensagens de teste | Os headers de mensagem de teste não incluem o token de autenticação. |
Posso incluir headers personalizados com a solicitação da Push API?
Não. A Push API é compatível com o uso do header Authorization
apenas para tokens de autenticação. Headers personalizados adicionais — como consumer-key
— não são compatíveis.
Se você precisar enviar parâmetros extras, inclua-os na URL. Por exemplo:
https://your.server.com?consumer_key=abc456