Reports.files

Um recurso de arquivo são os metadados associados à geração de um relatório. Cada arquivo é associado a um relatório principal e contém informações sobre o status da execução do relatório e, quando a execução for concluída, os URLs para os dados do relatório real.

Para ver uma lista de métodos deste recurso, consulte o final desta página.

Representações do recurso

Representa um recurso Arquivo. Um arquivo contém os metadados para a geração de um relatório. Esse recurso mostra o status da geração e mantém os URLs para os dados do relatório gerado se o processo terminar e o status for "REPORT_AVAILABLE".

{
  "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
dateRange nested object O período para o qual o arquivo tem os dados de relatório. O período será sempre o intervalo absoluto para o qual o relatório é gerado.
dateRange.endDate date A data de término do período, inclusive. Uma string no formato: "aaaa-MM-dd". gravável
dateRange.kind string O tipo de recurso. Neste caso, dfareporting#dateRange.
dateRange.relativeDateRange string O período relativo a quando o relatório é gerado.

Os valores aceitáveis são:
  • "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
dateRange.startDate date A data de início do período, inclusive. Uma string no formato: "aaaa-MM-dd". gravável
etag etag ETag deste recurso.
fileName string O nome do arquivo.
format string O formato de saída do relatório. Disponível apenas quando o arquivo estiver disponível.

Os valores aceitáveis são:
  • "CSV"
  • "EXCEL"
id long O ID único desse arquivo de relatório.
kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#file".
lastModifiedTime long O registro de data e hora em milissegundos desde época da última modificação desse arquivo.
reportId long O ID do relatório a partir do qual esse arquivo foi gerado.
status string O status do arquivo de relatório.

Os valores aceitáveis são:
  • "CANCELLED"
  • "FAILED"
  • "PROCESSING"
  • "REPORT_AVAILABLE"
urls object Os URLs de que será feito o download do arquivo de relatório completo.
urls.apiUrl string O URL para fazer o download dos dados de relatório por meio da API.
urls.browserUrl string O URL para fazer o download dos dados de relatório usando um navegador.

Métodos

Todos os arquivos de um relatório podem ser listados ou você pode buscar um só arquivo pelo ID e o ID do relatório principal.

get
Recupera um arquivo de relatório pelo ID do relatório e pelo ID do arquivo. Esse método é compatível com download de mídia.
list
Lista os arquivos para um relatório.