Reports: run

Gera um relatório. Faça um teste.

Por padrão, os relatórios são gerados de forma assíncrona. Também é possível gerar relatórios pequenos de forma síncrona. Se a geração síncrona de relatório não for concluída a tempo, um arquivo de relatório ainda será retornado, e o relatório será processado de forma assíncrona.

Solicitação

Solicitação HTTP

POST https://www.googleapis.com/dfareporting/v3.4/userprofiles/profileId/reports/reportId/run

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de caminho
profileId long É o ID do perfil de usuário do Campaign Manager 360.
reportId long É o ID do relatório.
Parâmetros de consulta opcionais
synchronous boolean Se for definido e verdadeiro, tenta gerar o relatório de forma síncrona. Padrão: false

Autorização

Esta solicitação requer autorização com o seguinte escopo:

Escopo
https://www.googleapis.com/auth/dfareporting

Para mais informações, consulte a página de autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação com este método.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "kind": "dfareporting#file",
  "etag": etag,
  "reportId": long,
  "id": long,
  "lastModifiedTime": long,
  "status": string,
  "fileName": string,
  "format": string,
  "dateRange": {
    "kind": "dfareporting#dateRange",
    "startDate": date,
    "endDate": date,
    "relativeDateRange": string
  },
  "urls": {
    "browserUrl": string,
    "apiUrl": string
  }
}
Nome da propriedade Valor Descrição Notas
kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#file".
etag etag É a ETag deste recurso.
reportId long É o ID do relatório de onde esse arquivo foi gerado.
id long O ID único desse arquivo de relatório.
lastModifiedTime long É o registro de data e hora em milissegundos desde a época da última modificação desse arquivo.
status string É o status do arquivo de relatório.

Os valores aceitáveis são os seguintes:
  • "CANCELLED"
  • "FAILED"
  • "PROCESSING"
  • "REPORT_AVAILABLE"
fileName string É o nome do arquivo.
format string É o formato de saída do relatório. Disponível somente quando o arquivo estiver disponível.

Os valores aceitáveis são os seguintes:
  • "CSV"
  • "EXCEL"
dateRange nested object É o período dos dados de relatório do arquivo. O período será sempre o intervalo absoluto do relatório gerado.
dateRange.kind string É o tipo de recurso. Neste caso, dfareporting#dateRange.
dateRange.startDate date É a data de início do período, inclusive. Uma string no formato: "aaaa-MM-dd". gravável
dateRange.endDate date A data de término do período, inclusive. Uma string no formato: "aaaa-MM-dd". gravável
dateRange.relativeDateRange string É o período relativo a quando o relatório é gerado.

Os valores aceitáveis são os seguintes:
  • "LAST_14_DAYS"
  • "LAST_24_MONTHS"
  • "LAST_30_DAYS"
  • "LAST_365_DAYS"
  • "LAST_60_DAYS"
  • "LAST_7_DAYS"
  • "LAST_90_DAYS"
  • "MONTH_TO_DATE"
  • "PREVIOUS_MONTH"
  • "PREVIOUS_QUARTER"
  • "PREVIOUS_WEEK"
  • "PREVIOUS_YEAR"
  • "QUARTER_TO_DATE"
  • "TODAY"
  • "WEEK_TO_DATE"
  • "YEAR_TO_DATE"
  • "YESTERDAY"
gravável
urls object São os URLs de que será feito o download do arquivo de relatório completo.
urls.browserUrl string É o URL para fazer o download dos dados de relatório usando um navegador.
urls.apiUrl string É o URL para fazer o download dos dados de relatório por meio da API.

Faça um teste

Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta.