YouTube Reporting API
YouTube Reporting API позволяет разработчикам планировать отчеты, а затем загружать созданные массовые отчеты. API поддерживает предопределенный набор отчетов, каждый из которых содержит полный набор данных YouTube Analytics для канала или владельца контента.
В приведенных ниже шагах объясняется, как планировать задания отчетов и получать отчеты:
- Вызовите метод
reportTypes.list() , чтобы получить список отчетов, которые может получить владелец канала или контента. - Вызовите метод
jobs.create() , чтобы определить отчет, который должен быть создан для канала или владельца контента. Впоследствии вы можете использовать API jobs.list() и jobs.delete() для извлечения или изменения списка генерируемых отчетов. - Вызовите метод
jobs.reports.list() , чтобы получить список отчетов, созданных для определенного задания. Каждый ресурс в ответе содержит свойство downloadUrl , указывающее URL-адрес, с которого можно загрузить отчет. - Отправьте авторизованный запрос
GET , чтобы получить отчет по URL-адресу загрузки.
Авторизация
Все запросы YouTube Reporting API должны быть авторизованы. В руководстве по авторизации объясняется, как использовать протокол OAuth 2.0 для получения токенов авторизации.
Запросы YouTube Reporting API используют следующие области авторизации:
| Сферы |
|---|
| 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
Список отчетов, созданных для указанного задания создания отчетов. |
| Методы |
|---|
list | GET /v1/reportTypes
Возвращает список типов отчетов, которые может получить владелец канала или контента. |
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2023-02-22 UTC.
[null,null,["Последнее обновление: 2023-02-22 UTC."],[[["The YouTube Reporting API allows developers to schedule and download bulk reports containing comprehensive YouTube Analytics data for channels or content owners."],["Developers can use the API to retrieve a list of available reports, create jobs to generate reports, and manage these jobs through listing and deletion."],["Generated reports can be downloaded via a specified URL obtained from the API's response, after retrieving them by using the `jobs.reports.list()` method."],["The API requires OAuth 2.0 authorization, and provides scopes for viewing user activity metrics (`https://www.googleapis.com/auth/yt-analytics.readonly`) and monetary reports (`https://www.googleapis.com/auth/yt-analytics-monetary.readonly`)."]]],["Developers use the YouTube Reporting API to schedule and download bulk reports containing YouTube Analytics data. Key actions include: listing available report types via `reportTypes.list()`, creating reporting jobs with `jobs.create()`, and managing jobs using `jobs.list()` and `jobs.delete()`. To get data, retrieve generated reports for a specific job with `jobs.reports.list()`, each with a downloadable URL. Finally, you can request the download using the given URL. All actions require authorization via OAuth 2.0.\n"]]
