API Reference

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

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

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

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

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

Авторизация

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

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

Области применения
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 плейлистов.

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

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

Метод 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 Удаляет элемент из группы.