YouTube Reporting API

API для создания отчетов на YouTube позволяет разработчикам планировать задачи создания отчетов, а затем загружать сгенерированные пакетные отчеты. API поддерживает предопределенный набор отчетов, каждый из которых содержит полный набор данных YouTube Analytics для канала или владельца контента.

Ниже описаны шаги по планированию заданий для создания отчетов и их получению:

  1. Вызовите метод reportTypes.list() , чтобы получить список отчетов, которые может получить владелец канала или контента.
  2. Вызовите метод jobs.create() чтобы указать отчет, который должен быть сгенерирован для владельца канала или контента. Затем вы можете использовать методы jobs.list() и jobs.delete() из API для получения или изменения списка генерируемых отчетов.
  3. Вызовите метод jobs.reports.list() , чтобы получить список отчетов, сгенерированных для конкретного задания. Каждый ресурс в ответе содержит свойство downloadUrl , указывающее URL-адрес, с которого можно загрузить отчет.
  4. Отправьте авторизованный GET запрос для получения отчета по URL-адресу для скачивания.

Авторизация

Все запросы к API отчетов YouTube должны быть авторизованы. В руководстве по авторизации объясняется, как использовать протокол OAuth 2.0 для получения токенов авторизации.

Для запросов к API отчетов YouTube используются следующие области авторизации:

Объем Описание
https://www.googleapis.com/auth/yt-analytics.readonly Просматривайте отчеты YouTube Analytics по вашему контенту на YouTube. Этот раздел предоставляет доступ к показателям активности пользователей, таким как количество просмотров и оценок.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly Просматривайте финансовые отчеты YouTube Analytics по вашему контенту на YouTube. Этот раздел предоставляет доступ к показателям активности пользователей, а также к прогнозируемым показателям дохода и эффективности рекламы.

Типы ресурсов

В следующих разделах приведено общее описание ресурсов и методов API. Все URI методов, указанные в таблицах, являются относительными к https://youtubereporting.googleapis.com .

работа

Методы
create POST /v1/jobs
Создает задание на формирование отчета. Создав задание на формирование отчета, вы даете указание YouTube генерировать этот отчет ежедневно. Отчет становится доступен в течение 24 часов с момента создания задания.
delete DELETE /v1/jobs/{jobId}
Удаляет задание на составление отчета.
get GET /v1/jobs/{jobId}
Получает информацию о конкретной задаче по формированию отчетов, запланированной для владельца канала или контента.
list GET /v1/jobs
Отображает список задач по созданию отчетов, запланированных для канала или владельца контента. Каждый ресурс в ответе содержит свойство id , которое указывает идентификатор, используемый YouTube для уникальной идентификации задачи. Этот идентификатор необходим для получения списка отчетов, созданных для данной задачи, или для ее удаления.

jobs.reports

Методы
get GET /v1/jobs/{jobId}/reports/{reportId}
Получает метаданные для конкретного отчета.
list GET /v1/jobs/{jobId}/reports
Отображает список отчетов, созданных для указанного задания по формированию отчетов.

reportTypes

Методы
list GET /v1/reportTypes
Возвращает список типов отчетов, которые может получить владелец канала или контента.