Visão geral dos relatórios

A API Campaign Manager 360 oferece várias maneiras de recuperar dados de anúncios trafegados pelo Campaign Manager 360.

Serviço de relatórios

A geração de relatórios usando o Reports serviço envolve um fluxo de trabalho de várias etapas para configurar, gerar e recuperar arquivos de relatório (como CSV ou Excel). Esse é o caminho de relatórios padrão para a API Campaign Manager 360 e é adequado para grandes conjuntos de dados, scripts programados automatizados ou aplicativos downstream que consomem arquivos.

O fluxo de trabalho normalmente consiste nas seguintes etapas:

  1. Defina ou localize um recurso Report (especificando dimensões, métricas, períodos e filtros) que é salvo com um ID de relatório exclusivo. Consulte Criar e atualizar relatórios.
  2. Execute a geração de relatórios chamando o reports.run método. Isso enfileira a execução do relatório e retorna um recurso File de marcador de posição. Consulte Encontrar e gerar relatórios.
  3. Verifique periodicamente o status do recurso File. Como esse processo é executado de forma assíncrona, o status de um arquivo começa como PROCESSING e faz a transição para REPORT_AVAILABLE quando concluído. Consulte Encontrar e gerar relatórios.
  4. Busque o conteúdo do arquivo (CSV ou Excel) quando a geração do relatório for concluída. Consulte Fazer o download de relatórios.

Gerar relatórios de forma síncrona

Se você precisar gerar um arquivo de relatório (CSV ou Excel) para uma pequena quantidade de dados, poderá executar o relatório de forma síncrona chamando o reports.run método com o parâmetro synchronous definido como true. A API tenta gerar o relatório em um breve período de tempo limite. Se a execução demorar mais, a execução do relatório será revertida automaticamente para a fila assíncrona.

Para mais detalhes, consulte Relatórios síncronos.

Consultar dados de relatórios

Use o método reportData.query para consultar dados de relatórios diretamente em vez de gerar um arquivo de relatório.

  • Em vez de criar e salvar um recurso Report, você especifica dimensões, métricas e outros critérios de filtragem ou classificação diretamente na solicitação.
  • A resposta contém dados de relatório estruturados, eliminando a necessidade de pesquisar e baixar um arquivo gerado.
  • A solicitação é executada de forma síncrona com um limite de 60 segundos.

Para mais detalhes, consulte Consultar dados de relatórios JSON.