API do Chartboost

Última atualização:

 

Com a API do Chartboost, você pode acessar análises de campanha e app, obter informações de conta e rendimentos, enviar, atualizar lances de campanha e muito mais.

 

 

  • Autenticação: você precisa incluir o ID de usuário e assinatura do usuário da sua conta para autenticar suas solicitações de API. Você encontra o seu ID de usuário e assinatura de usuário no topo da página API Explorer do painel.
  • Métodos HTTP: métodos HTTP necessários: GET, POST, PUT etc., variam de acordo com o ponto de extremidade. Veja o método HTTP de cada pedido no API Explorer do painel. Todas as solicitações devem ser feitas por HTTPS. O exemplo das análises relacionadas abaixo mostra duas consultas: uma solicitação inicial para colocar a tarefa na fila e a consulta de acompanhamento que usa o ID da tarefa para recuperar os resultados.
// exemplo de pseudocódigo para a solicitação de consulta inicial
query_url = "http://analytics.chartboost.com/v3/metrics/campaign?" + query_params
query_params = "... groupBy=app,creative ..."

response = get(query_url);
if (response.status = 202) {
 jobId = response.parse('jobId');
// capturar o jobId para a função retrieve()
 file.write(jobId);
 }
else {
// falha de manipulação
};


// exemplo de pseudocódigo de recuperar o resultado por jobId
query_url = "http://analytics.chartboost.com/v3/metrics/jobs/" + jobId
query_params = ""

created = get(query_url + "?status=true");
if (created.status == 201) {
response = get(query_url);
if (response.status == 200) {
// dados bons para os nerds
}
else {
// falha de manipulação
}
};
  • Após receber as consultas GET /campaign e GET /install que usam o parâmetro groupBy, a API do Chartboost responderá com um ID de tarefa que serve como confirmação de que a solicitação foi aceita e colocada na fila para o processamento.
  • Você pode então usar o ID para verificar o status da tarefa em uma solicitação posterior, usando este novo ponto de extremidade: GET /v3/metrics/jobs/[job_id]?status=true
  • A consulta retornará 201 {status: "created"} se os resultados da tarefa estiverem prontos para ser coletados. Quando o seu sistema receber essa resposta, você poderá puxar os dados da seguinte forma: GET /v3/metrics/jobs/[job_id]
  • Se você tentar recuperar seus dados antes da tarefa terminar, talvez receba uma resposta vazia ou incompleta.
  • Os resultados da consulta são armazenados e disponíveis por até 24 horas antes da exclusão.
  • Atualmente, o único tipo de conteúdo suportado é application/octet-stream, onde os resultados retornam em formulário TSV (note que nossos arquivos TSV ainda têm a extensão .csv).
  • Métodos API: a API do Chartboost tem quatro tipos de métodos: métodos de análise, métodos de app, métodos de campanha e métodos de conta. Cada tipo de método tem teus pontos de extremidade específicos. Use o API Explorer do painel ou uma das opções abaixo para encontrar o ponto de extremidade correto para a sua solicitação.
  • Parâmetros: adicione parâmetros para construir solicitações para testes. Os parâmetros necessários aparecem em vermelho no seu painel.
  • A maioria dos relatórios de análises retornados de nossa API são em formato JSON. Consultas específicas são retornadas em formato TSV (valor separado por tab). Saiba mais sobre formatos ▶
  • Siga as regras da API do Chartboost relacionadas abaixo.

▲ Voltar para o topo

 

Estas diretrizes ajudam a assegurar que todas as solicitações de clientes retornarão rapidamente. Se você não respeitar estes limites, seu acesso à API será limitado.

Use corretamente a API para o seu benefício e o de todos os outros clientes Chartboost.
Faça intervalos entre as solicitações. Se você precisa receber cinco relatórios diferentes a cada dia, não envie as cinco solicitações ao mesmo tempo. Aguarde pelo menos alguns minutos entre as solicitações. Seu acesso à API será limitado se você fizer mais de 1 consulta por minuto.
Agrupe seus apps em uma única solicitação. Em vez de enviar uma solicitação exclusiva à API para cada app, use o parâmetro appId e deixe a API retornar dados para todos eles.

▲ Voltar para o topo

 

Métodos de análises Métodos de app Métodos de campanha Métodos de conta

 


Você também pode se interessar...