API Reference

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

API поддерживает два типа функций:

  • Получение отчетов — метод API reports.query извлекает отчеты YouTube Analytics.

  • Управление группами YouTube Analytics . Группа YouTube Analytics – это настраиваемая коллекция, содержащая до 500 каналов, видео, плейлистов или ресурсов. API поддерживает несколько методов создания, извлечения и обновления групп YouTube Analytics. Затем владельцы канала и контента могут использовать метод reports.query для получения сводных данных по всем элементам в группе, что может помочь в анализе производительности.

На этой странице представлен краткий обзор ресурсов и методов API, которые включают эти функции.

Авторизация

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

Запросы API YouTube Analytics используют следующие области авторизации:

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

Получение отчета

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

Метод HTTP-запрос Описание
URI относительно https://youtubeanalytics.googleapis.com/v2
query GET /reports Получает отчет YouTube Analytics. В каждом запросе API используются параметры запроса, чтобы указать идентификатор канала или владельца контента, дату начала, дату окончания и хотя бы одну метрику. Вы также можете указать дополнительные параметры запроса, такие как измерения, фильтры или инструкции по сортировке.
  • Метрики — это отдельные измерения активности пользователей, такие как просмотры видео или рейтинги (нравится и не нравится).
  • Параметры — это общие критерии, которые используются для агрегирования данных, например дата, когда произошла активность пользователя, или страна, в которой находились пользователи. В отчете каждая строка данных имеет уникальную комбинацию значений измерения.
  • Фильтры — это значения измерения, которые определяют данные, которые будут извлечены. Например, вы можете получить данные для определенной страны, определенного видео или группы видео.
Списки поддерживаемых отчетов по каналам и отчетов по владельцам контента определяют допустимые комбинации показателей, параметров и фильтров.

Управление группой

API предоставляет два ресурса для создания групп YouTube Analytics и управления ими:

Группы

Ресурс group представляет собой группу YouTube Analytics, которая представляет собой настраиваемую коллекцию из до 500 каналов, видео, плейлистов или объектов.

Все элементы в группе должны представлять один и тот же тип ресурса. Например, вы не можете создать группу, содержащую 100 видео и 100 плейлистов.

Группа Analytics может содержать только те ресурсы, которые вы загрузили или заявили, или которые связаны с каналом, которым вы управляете. В результате владельцы каналов могут создавать группы видео и списки воспроизведения. Владельцы контента могут создавать группы видео, плейлистов, каналов или объектов.

Дополнительные сведения об этом ресурсе см. в его представлении ресурса и списке свойств .

Метод HTTP-запрос Описание
URI относительно https://youtubeanalytics.googleapis.com/v2
list GET /groups Возвращает список групп, соответствующих параметрам запроса API. Например, вы можете получить все группы, которыми владеет прошедший проверку подлинности пользователь, или вы можете получить одну или несколько групп по их уникальным идентификаторам.
insert POST /groups Создает группу YouTube Analytics. После создания группы используйте метод groupItems.insert для добавления элементов в группу.
update PUT /groups Изменяет метаданные для группы. В настоящее время единственным свойством, которое можно обновить, является название группы. (Используйте groupItems.insert и groupItems.delete для добавления и удаления элементов группы.)
delete DELETE /groups Удаляет группу.

GroupItems

Ресурс groupItem представляет элемент в группе YouTube Analytics.

Дополнительные сведения об этом ресурсе см. в его представлении ресурса и списке свойств .

Метод HTTP-запрос Описание
URI относительно https://youtubeanalytics.googleapis.com/v2
list GET /groupItems Возвращает коллекцию элементов группы, соответствующих параметрам запроса API.
insert POST /groupItems Создает элемент группы.
delete DELETE /groupItems Удаляет элемент из группы.