Dados agregados da Pull API

Visão geral: use URIs para obter seus relatórios agregados da AppsFlyer em arquivos CSV.

PullAPIAverage_us-en.png

  Procurando dados brutos da Pull API?

Dados brutos da Pull API

Características dos dados agregados da Pull API

  • Os relatórios retornam como arquivos CSV.
  • As taxas de atualização dos dados são iguais às do relatório equivalente na página de Exportar Dados e na página de Visão Geral do dashboard. Considere que o custo pode ser atualizado com um atraso de várias horas e isso depende do parceiro fornecer os dados de custo. 
  • Filtrar por opções disponíveis: fonte de mídia e intervalo de datas.
  • Os recursos adicionais da Pull API são:
    • Capacidade de filtrar por tipo de toque de atribuição
    • Fuso horário selecionável 
  • A Pull API é adequada para uso por usuários de contas e desenvolvedores de BI;

Relatórios de desempenho agregados disponíveis na Pull API

Categoria  UA Retargeting* Protect360
Parceiros (fonte de mídia)

Parceiros por data

Diariamente

Geolocalização

Relatório de geolocalização por data

* Para relatórios de redirecionamento, adicione &reattr=true ao URI. 

 Leitura relacionada:

Terminologia

Termo Descrição
Pull API

Solução para baixar relatórios CSV usando URIs.

Chamada de API ou chamada 

Enviando o URI à AppsFlyer colando-o na barra de endereços do navegador ou usando scripts.

URI
  • Identificador de recurso uniforme semelhante a um endereço da Web (URL) que contém a especificação do relatório.
  • Templates de URI estão disponíveis na página da API no Painel.

Guia para usuários da conta

Sobre templates de URI

  • Os templates de URI disponíveis no dev hub são preenchidos com a identificação do aplicativo e o tipo de relatório.
  • Eles possuem placeholders para datas (from/to) que você precisa editar.
  • A parte do URI à direita do ponto de interrogação (?) contém parâmetros. Cada parâmetro começa com um "e" comercial ((&). Os parâmetros são usados para definir filtros, especificar campos adicionais a serem incluídos, moeda e fuso horário. Por exemplo, em relatórios agregados para limitar (filtrar por) uma fonte de mídia específica, use o parâmetro media_source: &media_source=facebook
  • Para entender melhor a Pull API, termine o tutorial a seguir.

Como obter seu primeiro tutorial de relatório da Pull API

Antes de começar:

Para fazer download de um relatório do dev hub: 

  1. Vá para a referência da API do dev hub na AppsFlyer.

    API_Reference.jpg

  2. Selecione um tipo de relatório no menu à esquerda.Por exemplo, Relatórios de dados brutos (não-orgânicos) > Instalações.
    Consulte a tabela abaixo para obter uma lista de todos os tipos de relatórios.

  3. Preencha todos os campos obrigatórios 
  4. O template de URI é exibido à direita. 
  5. Copie o URI clicando no ícone de cópia.
  6. Abra uma nova aba no seu navegador e cole o URI.
  7. Clique em <Enter> para enviar a chamada da API. 
    O relatório é baixado.
Relatório Descrição Taxa de atualização
Relatórios de dados brutos (não orgânicos)
Instalações Registra as 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.
Diariamente
Reinstalações
Registra os usuários que, após desinstalar o aplicativo, engajam com uma fonte de mídia 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 in-app orgânicos
Registra informações sobre os eventos realizados pelos usuários.
Contínuo
Desinstalações orgânicas
Registra os usuários desinstalando o aplicativo.
Diariamente
Reinstalações orgânicas
Registra a receita publicitária para usuários atribuída a uma fonte de mídia de retargeting durante a janela de reengajamento.
Diariamente
Dados brutos da receita publicitária
Receita publicitária atribuída
Registra receita publicitária para os usuários atribuída a uma fonte de mídia. Diariamente
Receita publicitária orgânica Registra receita publicitária para usuários não atribuídos a uma fonte de mídia. Diariamente
Fraude Protect360
Instalações Registra instalações identificadas como fraudulentas e, portanto, não atribuídas a nenhuma fonte 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. Diariamente
Eventos in-app de pós-atribuição Registra eventos in-app para instalações identificadas como fraudulentas após serem atribuídas a uma fonte de mídia ou consideradas fraudulentas sem levar em conta a instalação em si. Diariamente
Cliques Registra cliques realizados por usuários bloqueados pelo Protect360. Diariamente
Postbacks de instalação bloqueados Registra cópias de postbacks enviados para uma fonte 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. Diariamente
Postback de evento in-app Registra postbacks de eventos in-app enviados à fonte da mídia. Diariamente
Retargeting de postbacks de eventos in-app Registra eventos in-app realizados por usuários durante a janela de reengajamento. em tempo real
Retargeting de postbacks de conversão Registra eventos in-app realizados por usuários durante a janela de reengajamento. em tempo real

Parâmetros dos dados agregados da Pull API

URI e parâmetros do relatório agregado

Parâmetros obrigatórios do URI agregado

Parâmetro Descrição
api_token Token de autorização do portador da API.
from (a partir de)
  • O intervalo de datas consiste em um parâmetro fromto. O intervalo é o período de LTV (instalação).
  • Formato: yyyy-mm-dd, 
  • Exemplo: 2010-01-01-2010 ou 2010-01-01
to (até) Data final. Quanto a from

Filtragem opcional de dados agregados e parâmetros de exibição, excluindo relatórios Protect360

Parâmetro Descrição
media_source

Use para limitar (filtrar) uma fonte de mídia específica.

  • Exemplo:media_source=facebook
attribution_touch_type

Defina este parâmetro como mostrado no exemplo para obter KPIs de atribuição de visualização (VTA). 

Exemplo: attribution_touch_type=impression

currency

Moeda de receita e custo.

Relatórios agregados de Pull API sempre usam a moeda específica do aplicativo. 

reattr

Obtenha dados de conversões de retargeting.

  • [Padrão] Se falso, as campanhas de dados de aquisição de usuários (UA) serão retornadas.
  • Se verdadeiro, a conversão de retargeting irá retornar.
  • Exemplo:reattr=true
Fuso horário

[Padrão] Os dados retornam usando UTC.

  • Os templates de URIs são preenchidos com o parâmetro de fuso horário definido para o fuso horário específico do aplicativo. 
  • [Padrão] Se o parâmetro não for enviado, os dados retornarão usando UTC.
  • Se você enviar timezone=[Joda-Time], os dados serão retornados usando o fuso horário específico do aplicativo.

Observações sobre a seleção de fusos horários

  • O formato de fuso horário Joda-Time considera o horário de verão.
  • O valor de Joda-Time deve ser idêntico ao valor definido na página de definições do aplicativo. Por exemplo, se o fuso horário definido é o de Paris, o valor do fuso horário na URL da Pull API deve ser timezone=Europe%2fParis.
  • Extrair dados no fuso horário selecionado está disponível somente a partir da data em que a configuração do fuso horário foi feita. Qualquer dado anterior à data da mudança usa UTC como fuso horário. 

Relatório filtrado do Google Ads

https://hq.appsflyer.com/export/com.greatapp/partners_report/v5?
from=2018-04-09&to=2018-05-09&media_source=googleadwords_int

Relatório filtrado do Facebook

https://hq.appsflyer.com/export/com.greatapp/partners_report/v5?
from=2018-04-09&to=2018-05-09&media_source=facebook
Parâmetros opcionais para relatórios do Protect360
Parâmetro Descrição
URI
  • Obtenha a URI do Protect360 no painel.
  • Modifique a URI conforme descrito aqui. 
PID

Para filtrar o relatório por uma fonte de mídia específica, use o parâmetro  pid. Por exemplo, para obter os dados de abc_net,  pid=abc_net.

Fuso horário

Seleciona o fuso horário usado para retornar dados.

Se timezone não for enviado, os dados serão retornados usando UTC.

Templates incluindo o parâmetro timezone

Exemplo: timezone=preferred: use para obter dados usando o fuso horário específico do aplicativo.

KPIs

Os parâmetros Protect360 são os mesmos na Pull API e na Master API.

KPIs de atribuição de exibição (VTA)

  • Para obter os KPIs do VTA, adicione o parâmetro attribution_touch_type=impression ao URI do relatório agregado da Pull API, conforme detalhado no exemplo.
  • Você pode usar o parâmetro com qualquer um dos relatórios agregados disponíveis. Basta copiar a URI da interface do usuário e anexar o parâmetro.
  • Você também pode adicionar o parâmetro &media_source para limitar o relatório a uma fonte de mídia específica, conforme ilustrado no exemplo a seguir.
  • Alguns KPIs de VTA, como cliques, impressões e APIs de custo, não têm valores associados a eles e exibem o valor N/A. 
Exemplo Exemplo de URI
Somente VTA  https://hq.appsflyer.com/export/{app_id}/partners_report/v5?from=yyyy-mm-dd&to=yyyy-mm-dd&attribution_touch_type=impression

VTA e fonte de mídia

https://hq.appsflyer.com/export/{app_id}/partners_report/v5?from=yyyy-mm-dd&to=yyyy-mm-dd&attribution_touch_type=impression&media_source=example_ad_network

Informações adicionais

Características e limitações

Característica
Característica Comentários 
Tipo de token de API necessário AppsFlyerAdmin_us-en.pngToken V2.0
Acesso da ad network N
Acesso das agências S
Transparência da agência S
Moeda específica do aplicativo S
Fuso horário específico do aplicativo S
Custo Os dados de custo são apenas para campanhas de UA; não para retargeting ou campanhas inativas (campanhas sem instalações).
Atualização de dados Contínuo
Dados históricos S
Dados não orgânicos S
Dados orgânicos S
Limitações de taxa

Limitação

Limitações de tamanho
  • As chamadas de API retornam no máximo 200 mil linhas.
  • Se um relatório tiver exatamente 200 mil linhas, assuma que estão faltando linhas.
  • Faça múltiplas chamadas de API usando os parâmetros from/to que incluem a hora do dia.  

Atenção! A Pull API para dados brutos aceita 1 milhão de linhas. Os relatórios de dados agregados são limitados a 200 mil linhas. 

Alterações de nome da campanha Os relatórios de Pull API não são compatíveis com alterações no nome da campanha

Erro da API e solução de problemas

Códigos e soluções de erro
Status Código Sintoma/mensagem solução
OK 200 Arquivo CSV vazio
  • addtional_fields  aparece mais de uma vez no URI
  • Certifique-se de que as datas de e para tenham o formato aaaa-mm-dd
OK

200

 

Nenhum token de API encontrado na URI

Erro na solicitação

400

O histórico de lookback dos relatórios de dados brutos é limitado a 90 dias

Use to e from para limitar o período a 3 meses ou menos.

Erro na solicitação

400

Seu limite de chamadas de API foi atingido para o tipo de relatório fornecido

-
Não autorizado

401

O token da API fornecido é inválido 

Peça o token atual para um administrador.
Não autorizado

401

A conta pode ser suspensa

Faça login no painel e verifique o status da conta. 

Não encontrado

404

A página com a mensagem de erro 404 da AppsFlyer é exibida

  • Certifique-se de que o ID do aplicativo está correto. Os aplicativos iOS devem começar com id.
  • O token não corresponde ao aplicativo. Você está usando o token correto?