Reports

Um recurso report identifica uma instância específica de um relatório. O recurso identifica o período de tempo no qual o relatório contém dados, bem como o URL do qual o relatório pode ser transferido por download.

Métodos

A tabela a seguir mostra os métodos compatíveis com a API para recursos report.

Métodos
get Recupera os metadados de um relatório específico.
list Lista os relatórios que foram gerados para o job de relatório especificado.

Representação de recursos JSON

A estrutura JSON abaixo mostra o formato de um recurso report:

{
  "id": string,
  "jobId": string,
  "startTime": timestamp,
  "endTime": timestamp,
  "createTime": timestamp,
  "jobExpireTime": timestamp,
  "downloadUrl": string
}

Propriedades

A tabela a seguir define as propriedades que aparecem neste recurso:

Propriedades
id string
O ID que o YouTube atribui para identificar o relatório de forma exclusiva. Cada relatório é associado a um único job, embora um job possa ser associado a muitos IDs de relatório.
jobId string
O ID do job que criou esse relatório.
startTime timestamp
O início do período que a instância de relatório abrange. O valor inclusivo é um carimbo de data/hora no formato UTC "Zulu" RFC3339, com precisão de microssegundos. Exemplo: "2015-10-02T15:01:23.045678Z".
endTime timestamp
O fim do período abrangido pela instância do relatório. O valor exclusivo é um carimbo de data/hora no formato UTC "Zulu" RFC3339, com precisão de microssegundos. Exemplo: "2015-10-02T15:01:23.045678Z".
createTime timestamp
A data e a hora em que o job foi criado. O valor da propriedade é um carimbo de data/hora no formato UTC "Zulu" RFC3339, com precisão de microssegundos. Exemplo: "2015-10-02T15:01:23.045678Z".
jobExpireTime timestamp
A data e a hora em que o job associado ao relatório expirou ou expirará. O valor da propriedade é um carimbo de data/hora no formato UTC "Zulu" RFC3339, com precisão de microssegundos. Exemplo: "2015-10-02T15:01:23.045678Z".

Essa propriedade terá um valor se o tipo de relatório associado ao job de relatório tiver sido descontinuado ou se os relatórios gerados para esse job não tiverem sido baixados por um longo período. O valor marca a data após a qual o YouTube não vai mais gerar novos relatórios para a vaga.

Se você tiver uma vaga que identifique uma data de validade, atualize seu sistema para deixar de solicitar o relatório até essa data. Em alguns casos, um relatório de substituição pode estar disponível.
downloadUrl string
O URL usado para fazer o download do relatório. O valor da propriedade tem comprimento máximo de 1.000 caracteres.

Para recuperar o relatório, envie uma solicitação GET HTTP para esse URL. Na solicitação, defina o cabeçalho de solicitação HTTP Authorization usando seu token de autorização como o valor do cabeçalho.

Como usar gzip

Você pode reduzir a largura de banda necessária para fazer o download de relatórios ativando a compactação gzip em solicitações de download. Embora seu aplicativo precise de mais tempo de CPU para descompactar as respostas da API, a vantagem de consumir menos recursos da rede geralmente supera esse custo.

Para receber uma resposta codificada em gzip, defina o cabeçalho da solicitação HTTP Accept-Encoding como gzip, conforme mostrado no exemplo a seguir:

Accept-Encoding: gzip