Dados brutos da Pull API

Premium

Resumo: use essa API para obter relatórios de dados brutos em arquivos CSV.

PullAPIRaw_us-en.png

Dados brutos da Pull API

  • A Pull API permite que você obtenha relatórios de dados brutos em arquivos CSV. Saiba mais sobre relatórios de dados brutos
  • Filtre pelas opções disponíveis: fonte de mídia, intervalo de datas, nome do evento in-app e geolocalização.   
  • Os recursos adicionais da Pull API são:
    • Escolha a moeda
    • Escolha o fuso horário

Relatórios de dados brutos disponíveis através da Pull API

Relatório Descrição Taxa de atualização
Relatórios de dados brutos (não orgânicos)
Instalações Registra instalações não orgânicas. O registro é gerado quando um usuário abre o aplicativo pela primeira vez.
Em tempo real
Eventos in-app Registra os eventos realizados pelos usuários.
Em tempo real
Desinstalações Registra quando um usuário desinstala o aplicativo.
Diário
Reinstalações
Registra os usuários que, após desinstalar o aplicativo, engajam com um canal de mídia de UA e reinstalam o aplicativo durante a janela de reatribuição. Em tempo real
Relatórios de dados brutos (orgânicos)
Instalações orgânicas
Registra quando o aplicativo é aberto por um usuário pela primeira vez.
Contínuo
Eventos orgânicos in-app
Registra informações sobre os eventos realizados pelos usuários.
Contínuo
Desinstalações orgânicas
Registra os usuários que desinstalaram o aplicativo.
Diário
Reinstalações orgânicas
Registra a receita de anúncios dos usuários atribuída a um canal de mídia de retargeting durante a janela de reengajamento.
Diário
Retargeting
Conversões Registro do usuário que abre o aplicativo depois de se engajar com uma campanha de retargeting. Em tempo real
Eventos in-app Eventos in-app realizados pelo usuário durante a janela de reengajamento. Em tempo real
Receitas de anúncios em dados brutos
Receita de anúncios atribuída
Registra a receita de anúncios dos usuários atribuída a um canal de mídia. Diário
Receita publicitária orgânica Registra a receita de anúncios dos usuários não atribuída a um canal de mídia. Diário
Fraude no Protect360
Instalações Registra instalações identificadas como fraudulentas e, portanto, não atribuídas a nenhum canal de mídia. Em tempo real
Instalações pós-atribuição Registra eventos in-app de instalações fraudulentas e, portanto, não são atribuídos de forma alguma. Em tempo real
Eventos in-app Registra eventos in-app identificados como fraudulentos pelo Protect360. Diário
Eventos in-app pós-atribuição Registra eventos in-app para instalações identificadas como fraudulentas após serem atribuídas a um canal de mídia ou consideradas fraudulentas sem levar em conta a instalação em si. Diário
Cliques Registra cliques realizados por usuários bloqueados pelo Protect360. Diário
Postbacks de instalação bloqueados Registra cópias de postbacks enviados para um canal de mídia, resultando em uma instalação bloqueada. Em tempo real
Postbacks
Postbacks de instalação Registra eventos de instalação gerados quando um usuário abre o aplicativo pela primeira vez. Diário
Postbacks de eventos in-app Registra postbacks de eventos in-app enviados ao canal de mídia. Diário
Postbacks de eventos in-app de retargeting Registra eventos in-app realizados por usuários durante a janela de reengajamento. Em tempo real
Postbacks de conversões de retargeting Registra eventos in-app realizados por usuários durante a janela de reengajamento. Em tempo real

Utilização de dados brutos da API Pull

Para utilizar dados brutos da API Pull:

  1. AppsFlyerAdmin_us-en.pngObter o token da API. Um administrador precisa de recuperar o token.
  2. Forneça ao seu desenvolvedor o token da API para ser usado no header de autenticação.
  3. Forneça aos seus desenvolvedores os parâmetros que eles devem inserir quando fizerem a chamada da API, conforme indicado nas secções seguintes. Os parâmetros determinam o foco do relatório, como ¬ele está organizado e fornecem um período para o relatório.
  4. Diga ao seu desenvolvedor para seguir as instruções de dados brutos da Pull API no hub do desenvolvedor.

Parâmetros

Parâmetro Descrição
from
  • O intervalo de datas é composto pelos parâmetros from e to. As datas estão relacionadas com a data da atividade.
  • Formato: yyyy-mm-dd, yyyy-mm-dd hh:mm ou yyyy-mm-dd hh:mm:ssAtenção: O espaço precisa de ser codificado como mostrado aqui from=2020-04-01%2001:00:00 - Em geral, os navegadores codificarão o espaço.
  • Exemplo: 01-01-2010 ou 01-01-2010 20:15 (Com parâmetros de horas e minutos disponíveis para relatórios de dados brutos).
to Data final. Relativo a from

media_source

media_source: Para restringir (filtrar) a chamada a uma fonte de mídia específica.

Estabeleça os parâmetros media_source e category da seguinte forma:

  • Para Meta ads, defina a categoria e a fonte de mídia como facebook
  • Para X Ads, defina a categoria e a fonte de mídia como twitter
  • Para todas as outras fontes de mídia, defina a categoria como padrão e a fonte de mídia como o nome da fonte de mídia.
  • Exemplos
    • media_source=facebook&category=facebook
    • media_source=abc_example&category=standard
maximum_rows

Número máximo de linhas devolvidas por uma única chamada de API.

  • [Padrão] Se não for enviado nenhum valor, até 200 mil linhas
  • 200.000: Até 200 mil linhas retornadas
  • 1.000.000: Até 1 milhão de linhas retornadas
  • Exemplo: maximum_rows=1000000 permite até 1 milhão de linhas.
event_name

Filtre eventos in-app por eventos específicos. Selecione vários eventos utilizando uma lista separada por vírgulas.

Exemplo: event_name=af_purchase,ftd 

reattr

Defina os dados de atribuição de retargeting.

  • [Padrão] Se for false, devolve campanhas de aquisição de usuários (UA).
  • Se for true, serão devolvidos dados de atribuição de retargeting.
  • Exemplo:reattr=true
additional_fields

Para obter campos adicionais além dos campos padrão.

Exemplo: additional_fields=device_download_time,deeplink_url

currency

Moeda de receita e custo

  • [Padrão] Se o parâmetro não for enviado, os dados serão devolvidos em USD. Ou seja, não envie nada e os resultados serão em dólares americanos.
  • Se enviar currency=preferred, a moeda específica do aplicativo será utilizada. Refere-se à moeda definida nas configurações do aplicativo.

Exemplo: Se a moeda específica do aplicativo for EUR, ao enviar currency=preferredos valores serão devolvidos em EUR.

timezone

[Padrão] Os dados são retornados utilizando UTC.

  • Para obter dados no fuso horário específico do aplicativo, adicione timezone à chamada, conforme mostrado nesta seção:
  •  timezone=[Numerical value]
  • Exemplo: Para o fuso horário UTC+10:00, use timezone=+10:00 Atenção: + - e : precisam ser codificados. Exemplo: +10:00 é codificado para %2B10%3A00
geo

Filtre os dados por código de país.

Limitação: você pode definir apenas um filtro de código de país por chamada de API.

Exemplo:

from_install time
  • O intervalo de datas é composto pelos parâmetros frome to. As datas estão relacionadas com a data da atividade.
  • Formato: yyyy-mm-dd
  • Exemplo: 01-01-2010
to_install_time

Data final. Relativo a from_install time

agency

Para restringir (filtrar) a chamada a uma agência específica.

Campos de intervalo de tempo

Se os resultados da API excederem o máximo, divida o relatório com base em horas e minutos. Aplique o seguinte:

  • from/to: aaaa-mm-dd hh:mm
  • from:
    • Apenas data = desde o início (00:00) da data selecionada
    • Data e hora = a partir das 00h, inclusive
  • Parâmetro to:
    • Apenas data = até ao fim (24h) do dia selecionado
    • Data e hora = até, mas sem incluir, a hora apresentada

Exemplo: um proprietário de aplicativo tem 1300K de instalações diárias de todas as fontes.   Para superar o limite de linha de 1M, o proprietário do aplicativo divide o dia em duas chamadas URI de 12 horas. Consulte a tabela a seguir para opções. 

Chamada de API From  To 
Primeira chamada de API

from=aaaa-mm-dd

Exemplo:

  • from=
  • Inicia nesta data no começo do dia às 00:00

to=aaaaa-mm-dd 12:00

Exemplo:

  • to=
  • Continua até às 11:59:59, e não às 12:00

Opção A: Segunda chamada de API 

 

Exemplo:

&from=2019-12-29 12:00&to=2019-12-29

  • Inicia ao meio-dia de 29 de dezembro de 2019
  • Termina à meia-noite de 29 de dezembro de 2019
 

from=aaaa-mm-dd 12:00

Exemplo:

  • from=
  • Começa a partir das 12:00, inclusive

to=aaaaa-mm-dd

Exemplo:

  • to=
  • Termina à meia-noite

Opção B: Segunda chamada API

from=aaaa-mm-dd 12:00

Exemplo:

  • from=
  • Começa a partir das 12:00, inclusive

to=aaaa-mm-dd+1 00:00

+1 = dia seguinte às 00:00

Exemplo:

  • to=
  • Significa antes de qualquer tempo ter decorrido em 30 de dezembro.

Observação: use a opção A ou B, pois elas têm os mesmos resultados. 

Campos adicionais

Os campos adicionais do relatório não são incluídos na lista padrão de campos para evitar que novos campos afetem os seus processos atuais de importação e ingestão. Utilize o parâmetro additional_fields para obter campos que não são default.

Campos padrão

Campos padrão da Pull API
Tipo de toque atribuído
Tempo de toque atribuído
Tempo de instalação
Hora do evento
Nome do evento
Valor do evento
Receita do evento
Moeda da receita do evento
Receita do evento em USD
Fonte do evento
Recibo validado
Parceiro
Fonte de mídia
Canal
Palavras-chave
Campanha
ID da campanha
Adset
Adset ID
Anúncio
Ad ID
Tipo de anúncio
Site ID
Sub Site ID
Subparâmetro 1
Subparâmetro 2
Subparâmetro 3
Subparâmetro 4
Subparâmetro 5
Modelo de custo
Valor de custo
Moeda de custo
Colaborador 1 Parceiro
Fonte de mídia do Colaborador 1
Campanha do Colaborador 1
Tipo de toque do Colaborador 1
Tempo de toque do Colaborador 1
Colaborador 2 Parceiro
Fonte de mídia do Colaborador 2
Campanha do Colaborador 2
Tipo de toque do Colaborador 2
Tempo de toque do Colaborador 2
Colaborador 3 Parceiro
Fonte de mídia do Colaborador 3
Campanha do Colaborador 3
Tipo de toque do Colaborador 3
Tempo de toque do Colaborador 3
Região
Código do país
Estado
Cidade
Código postal
DMA
IP
WIFI
Operador
Operadora
Idioma
AppsFlyer ID
Advertising ID
IDFA
Android ID
Customer User ID
IMEI
IDFV
Plataforma
Tipo de dispositivo
Versão do sistema operativo
Versão do aplicativo
Versão do SDK
App ID
Nome do aplicativo
Bundle ID
É retargeting
Tipo de conversão de retargeting
Lookback de atribuição
Janela de reengajamento
É atribuição primária
User-Agent
HTTP Referrer
URL original

Informações adicionais

Características e limitações

Característica Comentários 
Tipo de token API necessário AppsFlyerAdmin_us-en.pngToken V2.0
Acesso da ad network Não
Acesso da agência Sim
Transparência da agência Sim. No entanto, é importante lembrar que se você tanto usar o filtro de agência quanto os filtros de fonte de mídia, os filtros de fonte de mídia não se aplicarão a agências não transparentes. Isso implica que, para agências não transparentes, todos os dados são incluídos, e não apenas aqueles provenientes das fontes de media filtradas.
Moeda específica do aplicativo Sim
Fuso horário específico do aplicativo Sim
Atualização de dados
  • Equivalente à disponibilidade dos dados no dashboard de visão geral.
  • Relatórios atualizados com um atraso de algumas horas:
    • Eventos in-app orgânicos
  • Relatórios atualizados diariamente:
    • Desinstalações
    • Eventos in-app pós-atribuição
    • Receita de anúncios
Dados históricos Sim.  De acordo com as políticas de retenção e limite de taxa
Dados não orgânicos Sim
Dados orgânicos Sim
Limite de taxa

Limitações da API para dados brutos

Limitações de tamanho
  • As chamadas de API devolvem um máximo de 200K/1M linhas.
  • Se um relatório tem exatamente 200K/1M linhas, então suponha que faltam linhas.
  • Use o parâmetro maximum_rows para selecionar o número máximo de linhas.
  • Faça várias chamadas de API, usando parâmetros from/to que incluam a hora do dia.
install_date de e install_date_to O intervalo de datas de instalação deve ser anterior ao intervalo de datas de atividades. 

Resolução de problemas

Sintoma/mensagem Solução
O relatório não contém os dados esperados de acordo com o intervalo de tempo selecionado ou há uma discrepância entre o relatório de dados brutos e o relatório de dados agregados.  

Verifique se configurou o parâmetro timezone. Caso contrário, os dados são enviados usando UTC e não o fuso horário do seu app.