O recurso report identifica uma instância específica de um relatório. O recurso identifica o período durante o qual o relatório contém dados, bem como o URL no qual o relatório pode ser baixado.
Métodos
A tabela a seguir mostra os métodos compatíveis com a API para recursos report.
| Métodos | |
|---|---|
get |
Recupera os metadados para um relatório específico. |
list |
Lista os relatórios que foram gerados para o trabalho de relatório especificado. |
Representação de recurso 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 e O ID que o YouTube atribui para identificar o relatório de forma exclusiva. Cada relatório está associado a um único trabalho, embora um trabalho possa ser associado a muitos IDs de relatório. |
jobId |
string e O ID do job que criou este relatório. |
startTime |
timestamp e O início do período que a instância do relatório abrange. O valor inclusivo é um carimbo de data/hora em UTC "Zulu" RFC3339 com precisão de microssegundos. Exemplo: "2015-10-02T15:01:23.045678Z". |
endTime |
timestamp e O fim do período abrangido pela instância do relatório. O valor exclusivo é um carimbo de data/hora em UTC "Zulu" RFC3339 com precisão de microssegundos. Exemplo: "2015-10-02T15:01:23.045678Z". |
createTime |
timestamp e A data e a hora em que o job foi criado. O valor da propriedade é um carimbo de data/hora em UTC "Zulu" RFC3339 com precisão de microssegundos. Exemplo: "2015-10-02T15:01:23.045678Z". |
jobExpireTime |
timestamp e A data e a hora em que o trabalho associado ao relatório expirou ou vai expirar. O valor da propriedade é um carimbo de data/hora em 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 do relatório tiver sido descontinuado ou os relatórios gerados para esse job não tiverem sido transferidos por download por um período prolongado. O valor marca a data final em que o YouTube não vai mais gerar novos relatórios para a tarefa. Se você tiver um job que identifique uma data de validade, atualize o sistema para parar de solicitar o relatório até essa data. Em alguns casos, um relatório de substituição pode estar disponível. |
downloadUrl |
string e O URL de onde é possível fazer o download do relatório. O valor da propriedade tem um comprimento máximo de 1.000 caracteres. Para recuperar o relatório, envie uma solicitação HTTP GET para esse URL. Na solicitação, defina o cabeçalho da solicitação HTTP Authorization, usando seu token de autorização como o valor do cabeçalho.
Como usar o 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: gzip |