Reports

Ресурс report идентифицирует конкретный экземпляр отчета. Ресурс определяет период времени, за который отчет содержит данные, а также URL-адрес, с которого отчет можно загрузить.

Методы

В следующей таблице показаны методы, которые API поддерживает для ресурсов report .

Методы
get Извлекает метаданные для определенного отчета.
list Перечисляет отчеты, созданные для указанного задания создания отчетов.

Представление ресурса JSON

В приведенной ниже структуре JSON показан формат ресурса report : 

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

Характеристики

В следующей таблице определены свойства, которые появляются в этом ресурсе:

Характеристики
id string
Идентификатор, который YouTube присваивает для уникальной идентификации отчета. Каждый отчет связан с одним заданием, хотя задание может быть связано со многими идентификаторами отчетов.
jobId string
Идентификатор задания, создавшего этот отчет.
startTime timestamp
Начало периода времени, охватываемого экземпляром отчета. Включающее значение представляет собой временную метку в формате RFC3339 UTC «Zulu» с точностью до микросекунд. Пример: "2015-10-02T15:01:23.045678Z" .

endTime timestamp
Конец периода времени, охватываемого экземпляром отчета. Эксклюзивное значение — это временная метка в формате RFC3339 UTC «Zulu» с точностью до микросекунд. Пример: "2015-10-02T15:01:23.045678Z" .

createTime timestamp
Дата и время создания задания. Значение свойства представляет собой временную метку в формате RFC3339 UTC «Zulu» с точностью до микросекунд. Пример: "2015-10-02T15:01:23.045678Z" .

jobExpireTime timestamp
Дата и время, когда срок действия задания, связанного с отчетом, истек или истечет. Значение свойства представляет собой временную метку в формате RFC3339 UTC «Zulu» с точностью до микросекунд. Пример: "2015-10-02T15:01:23.045678Z" .

Это свойство имеет значение, если либо тип отчета, связанный с заданием отчета, устарел, либо отчеты, созданные для этого задания, не загружались в течение длительного периода времени. Значение обозначает дату, после которой YouTube больше не будет создавать новые отчеты по заданию.

Если у вас есть задание, в котором указана дата истечения срока действия, вам следует обновить свою систему, чтобы прекратить запрашивать отчет к этой дате. В некоторых случаях может быть доступен отчет о замене.
downloadUrl string
URL-адрес, с которого можно скачать отчет. Значение свойства имеет максимальную длину 1000 символов.

Чтобы получить отчет, отправьте запрос HTTP GET на этот URL-адрес. В запросе установите заголовок HTTP-запроса Authorization , используя в качестве значения заголовка свой токен авторизации .

Использование gzip

Вы можете уменьшить пропускную способность, необходимую для загрузки отчетов, включив сжатие gzip для запросов на загрузку. Хотя вашему приложению потребуется дополнительное время ЦП для распаковки ответов API, выгода от потребления меньшего количества сетевых ресурсов обычно перевешивает эти затраты.

Чтобы получить ответ в кодировке gzip, установите для заголовка HTTP-запроса Accept-Encoding значение gzip , как показано в следующем примере: 

Accept-Encoding: gzip