Dados brutos da Pull API

Premium

Para:

Profissionais de marketing

Última atualização: 10 de Novembro de 2023 20:39

Visão geral: use esta API para obter relatórios de dados brutos em arquivos CSV.

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 por 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:
- Selecionar moeda
- Selecionar o fuso horário

Relatórios de dados brutos disponíveis via Pull API

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 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 in-app orgânicos	Registra informações sobre os eventos realizados pelos usuários.	Contínuo
Desinstalações orgânicas	Registra os usuários que desinstalaram o aplicativo.	Diariamente
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.	Diariamente
Dados brutos da receita publicitária
Receita de anúncios atribuída	Registra a receita de anúncios dos usuários atribuída a um canal de mídia.	Diariamente
Receita publicitária orgânica	Registra a receita de anúncios dos usuários não atribuída a um canal de mídia.	Diariamente
Fraude 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.	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 um canal 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 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.	Diariamente
Postback de evento in-app	Registra postbacks de eventos in-app enviados ao canal de 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

Usando os dados brutos da Pull API

Para usar os dados brutos da Pull API:

Obtenha o token da API. Um administrador precisa recuperar o token.
Forneça ao seu desenvolvedor o token de API a ser usado no cabeçalho de autenticação.
Forneça aos seus desenvolvedores os parâmetros a serem inseridos quando eles fizerem a chamada de API, conforme descrito nas seções a seguir. Os parâmetros determinam o foco do relatório, como ele é organizado e fornecem um cronograma de relatório.
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
a partir de	O intervalo de datas consiste em parâmetros`from`e `to`. As datas estão relacionadas à data da atividade. Formato: `aaaa-mm-dd`, `aaaa-mm-dd hh:mm`, ou `aaaa-mm-dd hh:mm:ss` Observação: o espaço precisa ser codificado como mostrado aqui `de=2020-04-01%2001:00:00` - Em geral, os navegadores codificarão o espaço. Exemplo: 2010-01-01 ou 2010-01-01 20:15 (parâmetros de horas e minutos disponíveis para relatórios de dados brutos).
até	Data final. Quanto a `from`
media_source	`media_source`: para limitar (filtrar) a chamada para uma fonte de mídia específica. Defina os parâmetros `media_source` e `category` da seguinte maneira: Para anúncios Meta, defina a categoria e a fonte de mídia como facebook Para o Twitter, 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 retornadas por uma única chamada de API. [Default] se nenhum valor for enviado, até 200 mil linhas 200000: até 200 mil linhas retornam 1000000: até 1M de linhas de retorno Exemplo: `maximum_rows=1000000` permite até 1M de linhas.
event_name	Filtre eventos in-app por eventos específicos. Selecione múltiplos eventos usando uma lista separada por vírgula. Exemplo: `event_name=af_purchase,ftd`
reattr	Defina os dados de atribuição de retargeting [Padrão] Se falso, as campanhas de dados de aquisição de usuários (UA) serão retornadas. Se verdadeiro, o retargeting dos dados de atribuição será retornado. 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 da receita e do custo [Padrão] Se o parâmetro não for enviado, os dados retornarão como USD. Ou seja, não faça nada e os resultados retornarão em USD. Se você enviar `currency=preferred` a moeda específica do aplicativo é usada. Ou seja, a moeda definida nas configurações do aplicativo. Exemplo: se a moeda específica do aplicativo for EUR, ao enviar `currency=preferred`os valores retornam em EUR.
Fuso horário	[Padrão] Os dados retornam usando 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` Observação: `+`,`-`, e `:` precisam ser codificados. Exemplo: +10:00 codifica para `%2B10%3A00`
geolocalização	Filtrar 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: `geo=ZA`
from_install time	O intervalo de datas consiste em parâmetros`from`e `to`. As datas estão relacionadas à data da atividade. Formato: `aaaa-mm-dd` Exemplo: 2010-01-01
to_install_time	Data final. Quanto ao `from_install time`
agency	Para limitar (filtrar) a chamada a uma agência específica.

Campos do Protect360

Veja o guia de dados brutos Protect360

Campos de período de tempo

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

de/até: yyyy-mm-dd hh:mm
de:
- Somente data = desde o início (00:00) da data escolhida
- Data e hora = a partir das 00:00
Parâmetro até:
- Somente data = até o final (24:00) do dia escolhido
- Data e hora = até, mas não incluindo a hora mostrada

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. Veja a tabela a seguir para opções.

Chamada de API A partir de Para

Primeira chamada da API

de=aaaa-mm-dd

Exemplo:

de=2019-12-29
Começa nesta data no início do dia às 00:00

até=aaaa-mm-dd 12:00

Exemplo:

até=2019-12-29 12:00
Continua até 11:59:59, não 12:00

Opção A: segunda chamada de API

Exemplo:

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

Começa a partir do meio-dia 29 Dez 2019
Termina meia-noite 29 dez 2019

from=yyyy-mm-dd 12:00

Exemplo:

de=2019-12-29 12:00
Começa a partir de e inclui 12:00

até=yyyy-mm-dd

Exemplo:

até=2019-12-29
Termina à meia-noite

Opção B: segunda chamada da API

from=yyyy-mm-dd 12:00

Exemplo:

de=2019-12-29 12:00
Começa a partir de e inclui 12:00

até=aaaa-mm-dd+1 00:00

+1 = dia seguinte às 00:00

Exemplo:

até=2019-12-30 00:00
Ou seja, antes de qualquer tempo decorrido em 30 de dezembro

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

Campos adicionais

Campos de relatório adicionais não são adicionados à lista padrão de campos para que novos campos não afetem seus processos de importação e ingestão existentes. Use o parâmetro additional_fields para obter campos não padrão.

Liste um campo apenas uma vez.
Veja a lista de campos disponíveis.
Exemplo: additional_fields=device_download_time,deeplink_url

Campos padrão

Campos padrão da Pull API
Data/hora do toque atribuído
Data/hora da instalação
Data/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
O recibo está validado
parceira
Fonte de mídia
Canal
Palavras-chave
Campanha
ID da campanha
Conjunto de anúncios
Adset ID
Anúncio
Ad ID
Tipo de anúncio
Site ID
ID do sub-site
Subparâmetro 1
Subparâmetro 2
Subparâmetro 3
Subparâmetro 4
Subparâmetro 5
Modelo de custo
Valor de custo
Moeda do custo
Parceiro do colaborador 1
Fonte de mídia do colaborador 1
Campanha do colaborador 1
Tipo de toque do colaborador 1
Hora do toque do colaborador 1
Parceiro colaborador 2
Fonte de mídia do colaborador 2
Campanha colaborador 2
Tipo de toque do colaborador 2
Data e hora toque do colaborador 2
Parceiro colaborador 3
Fonte de mídia do colaborador 3
Campanha colaborador 3
Tipo do toque do colaborador 3
Data/hora do toque do colaborador 3
Região
Código do país
Estado
CIDADE
Código postal
DMA
IP
WiFi
Operator
Carrier
language
ID da AppsFlyer
ID de publicidade
IDFA
ID do Android
ID de usuário cliente
IMEI
IDFV
Plataforma
Tipo do dispositivo
Versão do SO
Versão do aplicativo
Versão do SDK
App ID
Nome do aplicativo
ID do pacote
Está redirecionando
Tipo de conversão de redirecionamento
Lookback de atribuição
Reengagement Window
É atribuição primária
Agente do usuário
Referência HTTP
URL original

Informações adicionais

Características e limitações

Característica	Comentários
Tipo de API token necessário	Token V2.0
Acesso da ad network	Não
Acesso das agências	Sim
Transparência da agência	Sim. No entanto, observe que, se você usar o filtro de agência e 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 significa que, para agências não transparentes, todos os dados são incluídos; não apenas dados das fontes de mídia filtradas.
Moeda específica do aplicativo	Sim
Fuso horário específico do aplicativo	Sim
Atualização de dados	Equivalente à disponibilidade dos dados no painel 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 de pós-atribuição Receita de anúncios
Dados históricos	Sim. De acordo com políticas de retenção e limitação de taxas.
Dados não orgânicos	Sim
Dados orgânicos	Sim
Limitação de taxa	Limitações da API para dados brutos.
Limitações de tamanho	As chamadas de API retornam 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 de/para 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 da atividade.

Soluçã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 você definiu o parâmetro `timezone`. Caso contrário, os dados são enviados usando UTC e não seu fuso horário de aplicação.

Veja também

Como selecionar a ferramenta certa de entrega de dados/API de relatórios