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 Reporting должны быть авторизованы. Руководство по авторизации объясняет, как использовать протокол 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 использует для уникальной идентификации задания. Этот идентификатор нужен для получения списка отчетов, которые были сгенерированы для задания, или для удаления задания.

отчеты о работе

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

reportTypes

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