Dimensions

В этом документе перечислены параметры, которые поддерживаются в YouTube Reporting API. С помощью этого API можно запрашивать из YouTube Аналитики большие объемы данных по каналу или владельцу контента.

Параметры – это общие критерии, которые используются для агрегирования данных, например дата, когда произошло действие пользователя, или страна, в которой он находился.

Каждый массовый отчет поддерживает предопределенный список параметров, и в любом отчете каждая строка данных имеет уникальную комбинацию значений параметров. Таким образом, комбинация значений параметров в каждой строке функционирует как первичный ключ для этой строки. Вам не нужно указывать, какие параметры будут включены в отчет.

Основные параметры

Хотя на YouTube Reporting API распространяются правила прекращения поддержки, определенные в Условиях использования, на неосновные параметры и показатели эти правила не распространяются. В определениях на этой странице все основные параметры явно обозначены как таковые.

Ниже перечислены основные параметры API. Все они также являются основными параметрами в YouTube Analytics API.

Дополнительную информацию можно найти в списке YouTube API, на которые распространяются правила прекращения поддержки.

Размеры

В разделах ниже описаны параметры, которые используются в массовых отчетах YouTube Reporting API. Если не указано иное, эти параметры используются в отчетах как по каналам, так и по владельцам контента.

Ресурсы

Эти параметры соответствуют ресурсам, которыми управляют каналы и владельцы контента на YouTube:

video_id (основной параметр)
Идентификатор видео YouTube. В YouTube Data API это значение свойства id ресурса video. This is a core dimension and is subject to the Deprecation Policy.
playlist_id
Идентификатор плейлиста YouTube. В YouTube Data API это значение свойства id ресурса playlist.
channel_id (основной параметр)
Идентификатор канала YouTube. В YouTube Data API это значение свойства id ресурса channel. This is a core dimension and is subject to the Deprecation Policy.
asset_id (только в отчетах для владельцев контента)
Идентификатор объекта, управляемого в системе Content ID. Объект – это представление вашей интеллектуальной собственности в системе Content ID. На сайте YouTube идентификаторы объектов можно найти в системе управления контентом. Вы также можете получить их с помощью YouTube Content ID API.

Географические области

Эти параметры позволяют определить географический регион, связанный с действиями пользователя, эффективностью объявления или показателями расчетного дохода.

country_code (основной параметр)
Страна, связанная с показателями в строке отчета. Значение параметра – двухбуквенный код страны по стандарту ISO-3166-1, например US, CN (Китай) или FR (Франция). Код страны ZZ используется для отчетных показателей, для которых YouTube не удалось определить связанную страну. This is a core dimension and is subject to the Deprecation Policy.
province_code
Штат или территория США, к которым относятся показатели в строке отчета. Значение параметра – это код ISO 3166-2, который идентифицирует штат США или округ Колумбия, например US-MI (Мичиган) или US-TX (Техас). Код провинции US-ZZ используется для отчетных показателей, для которых YouTube не удалось определить связанный штат США.

Примечание. Этот параметр не поддерживает значения ISO 3166-2, которые идентифицируют внешние малые острова США, поскольку у этих территорий также есть собственные коды стран ISO 3166-1. Кроме того, не поддерживаются регионы других стран, кроме США.

Периоды

date (основной параметр)
Этот параметр позволяет определить дату, связанную с показателями в каждой строке отчета. В массовых отчетах дата относится к периоду, который начинается в 00:00 и заканчивается в 23:59 по тихоокеанскому времени в указанный день, месяц и год. В зависимости от времени года тихоокеанское время соответствует UTC-7 или UTC-8.

Обратите внимание, что обычно дата представляет собой 24-часовой период, но в дни перехода на летнее время она может составлять 23 часа, а в дни перехода на зимнее время – 25 часов. This is a core dimension and is subject to the Deprecation Policy.

Места воспроизведения

Эти параметры позволяют получить информацию о странице или приложении, где произошли действия пользователя.

playback_location_type
Этот параметр позволяет определить тип страницы или приложения, где было зарегистрировано действие пользователя. В таблице ниже перечислены значения параметров.
Значение Описание
0 Данные относятся к действиям, которые произошли на странице просмотра видео на YouTube или в официальном приложении YouTube, например в приложении YouTube для Android.
1 Данные относятся к действиям, которые произошли на другом сайте или в приложении, где видео было встроено с помощью тега <iframe> или <object>.
2 Данные относятся к действиям, которые произошли на странице канала YouTube.
5 Данные относятся к показателям, которые нельзя классифицировать по одному из других перечисленных типов местоположений.
7 Данные относятся к просмотрам, которые произошли на главной странице YouTube, в фиде подписок или в другом разделе YouTube.
8 Данные относятся к просмотрам, которые произошли непосредственно на странице результатов Поиска на YouTube.
10 Данные относятся к просмотрам в ленте YouTube Shorts.
11 Данные относятся к просмотрам в ленте вертикальных трансляций.
12 Данные относятся к просмотрам на вкладке "Семплы" в YouTube Music.
playback_location_detail
Этот параметр указывает URL или приложение, в котором произошло воспроизведение. Этот параметр поддерживается только для просмотров во встроенных проигрывателях, то есть его значение указывается только в строках, где значение параметра – 1. В других строках значение этого параметра не указано.

Сведения о воспроизведении

live_or_on_demand
Этот параметр указывает, связаны ли показатели действий пользователя в строке данных с просмотрами прямой трансляции. Данные по этому параметру доступны с 1 апреля 2014 г.

В таблице ниже перечислены значения параметра.
Значение Описание
live Данные в строке описывают действия пользователя во время прямой трансляции.
onDemand Данные в строке описывают действия пользователя, которые не происходили во время прямой трансляции.
subscribed_status
Этот параметр показывает, связаны ли показатели действий пользователей в строке данных со зрителями, которые подписаны на канал, где размещено видео или плейлист. Допустимые значения: subscribed и unsubscribed.

Обратите внимание, что значение параметра точно отражает время, когда произошло действие пользователя. Например, пользователь, не подписанный на канал, смотрит одно из его видео, затем подписывается на канал и смотрит другое видео в тот же день. В отчете по каналу указано, что у одного просмотра значение subscribed_status равно subscribed, а у другого – subscribed_statusunsubscribed.

Источники трафика

traffic_source_type
Этот параметр определяет тип реферера, связанный с показателями действий пользователей. Тип URL перехода описывает, как пользователи перешли к видео или каналу, связанному со строкой данных в отчете. В таблице ниже перечислены значения параметров.
Значение Описание
0 Прямой или неизвестный
Это значение включает прямой трафик на страницу, а также страницы, для которых неизвестен URL перехода. В отчетах о запросах этот тип источника трафика обозначается как NO_LINK_OTHER или UNKNOWN_MOBILE_OR_DIRECT.
1 Реклама на YouTube
Зритель перешел к видео по ссылке в рекламе. Если в отчете об источниках трафика значение этого параметра – 1, то параметр traffic_source_detail определяет тип объявления, которое было показано зрителю. В отчетах о запросах этот тип источника трафика обозначается как ADVERTISING. Возможные значения:
Значение Описание
ctp_engagement_ad Объявление, ориентированное на взаимодействие, с воспроизведением по клику
engagement_ad Объявление, ориентированное на взаимодействие
googlemediaads Поисковые объявления Google
insearch_display TrueView In-Search и In-Display
instream TrueView In-Stream
instream-select Объявления Freewheel Reserved в формате In-Stream с возможностью пропуска
unknown Реклама на YouTube без категории
video_wall Видеостена
yva Видеореклама на главной странице
3 Функции выбора контента
Зритель перешел на страницу просмотра с другой страницы YouTube, на которой есть ссылки на видео или каналы. Если в отчете об источниках трафика значение этого параметра – 3, то параметр traffic_source_detail определяет функцию, которая привлекла трафик. В отчетах о запросах этот тип источника трафика обозначается как SUBSCRIBER. Возможные значения:
Значение Описание
explore Детям: исследуйте
learning Для детей: обучение
music Фид "Музыка"
my-history История просмотра
my-subscriptions Мои подписки
my-uploads Мои загрузки
podcasts Целевая страница с подкастами
shows Детские телешоу
watch-later Смотреть позже
what-to-watch Найти, что посмотреть
4 Каналы YouTube.
Зрители перешли на видео со страницы канала YouTube. Если в отчете об источниках трафика значение этого параметра равно 4, то параметр traffic_source_detail указывает идентификатор канала. В отчетах о запросах этот тип источника трафика обозначается как YT_CHANNEL.
5 Поиск на YouTube.
Зрители перешли к видео из результатов поиска на YouTube. Если в отчете об источниках трафика значение этого параметра равно 5, то параметр traffic_source_detail указывает связанный поисковый запрос. В отчетах о запросах этот тип источника трафика обозначается как YT_SEARCH.
7 Рекомендуемые видео
Просмотры, полученные благодаря рекомендациям на страницах просмотра других видео. Если в отчете об источниках трафика значение этого параметра равно 7, то параметр traffic_source_detail определяет идентификатор видео. В отчетах о запросах этот тип источника трафика обозначается как RELATED_VIDEO или YT_RELATED.
8 Другие функции YouTube
Зрители перешли на страницу видео со страницы YouTube, которая не относится ни к одному из перечисленных выше типов источников трафика. Если в отчете об источниках трафика значение этого параметра – 8, то параметр traffic_source_detail определяет URL страницы. В отчетах о запросах этот тип источника трафика обозначается как YT_OTHER_PAGE. Возможные значения:
Значение Описание
creator Творческая студия YouTube
g-crec Рекомендованные каналы
offline Офлайн
promotion Программа продвижения партнеров
unknown Неизвестно
widget Виджет на главном экране Android
youtu.be youtu.be
ytremote Пульт YouTube
9 Внешние источники
Зрители перешли по ссылке на другом сайте. К этому источнику трафика относятся переходы из результатов поиска Google. Если в отчете об источниках трафика значение этого параметра равно 9, то параметр traffic_source_detail идентифицирует внешнюю веб-страницу. В отчетах о запросах этот тип источника трафика обозначается как EXT_URL.
11 Подсказки и аннотации
Зрители перешли к видео, нажав на подсказку или аннотацию в другом ролике. В отчетах о запросах этот тип источника трафика обозначается как ANNOTATION.
14 Плейлисты
Просмотры видео в составе плейлиста. В отчетах по запросам этот источник трафика обозначается как PLAYLIST.

Обратите внимание, что этот источник трафика отличается от источника 18, который указывает на то, что просмотры были получены со страницы, на которой перечислены все видео в плейлисте.
17 Уведомления.
Зрители перешли по ссылке в электронном письме или уведомлении от YouTube. В отчетах о запросах этот тип источника трафика обозначается как NOTIFICATION. Возможные значения:
Значение Описание
inbox
push
sdig Просмотры, полученные благодаря уведомлениям из дайджеста для подписчиков.
uploaded_other Просмотры, полученные благодаря уведомлениям, которые не являются push-уведомлениями, например электронным письмам или уведомлениям в папке "Входящие", отправленным подписчикам после загрузки видео.
uploaded_push Просмотры, полученные благодаря push-уведомлениям, которые были отправлены подписчикам после загрузки видео.
18 Страницы плейлистов
Просмотры со страниц, на которых перечислены все видео из плейлиста. В отчетах по запросам этот источник трафика обозначается как YT_PLAYLIST_PAGE.

Обратите внимание, что этот источник трафика отличается от источника 14, который указывает на то, что просмотры произошли во время воспроизведения видео в составе плейлиста.
19 Просмотры видео, на которые заявлены права.
Просмотры видео, на которые заявлены права и которые владелец контента использовал для продвижения. В отчетах о запросах этот источник трафика обозначается как CAMPAIGN_CARD. Этот источник трафика поддерживается только в отчетах для владельцев контента.
20 Интерактивная конечная заставка
Просмотры, полученные благодаря конечной заставке в другом видео. В отчетах о запросах этот тип источника трафика обозначается как END_SCREEN.
23 Сюжеты
Зритель перешел к видео, пролистав вертикальный список сюжетов.
24 Shorts
Зритель перешел к видео, пролистав ленту Shorts.
25 Страницы товаров
Видео на странице товара перенаправляли зрителей на другой канал.
26 Страницы хештегов
Просмотры со страниц хештегов обычных или коротких видео.
27 Страницы треков
Просмотры со страниц Shorts с этим треком.
28 Live-редирект
Просмотры, полученные благодаря live-редиректу.
29 Подкасты
Просмотры со страницы Подкасты на YouTube.
30 Использованный фрагмент видео
Просмотры по ссылке на использованный фрагмент видео в проигрывателе Shorts.
31 Лента вертикальных трансляций
Просмотры из ленты вертикальных трансляций.
32 Похожее видео
Просмотры, полученные благодаря ссылке на похожее видео в проигрывателе Shorts.
traffic_source_detail
Этот параметр предоставляет дополнительные сведения об источнике трафика, который указан в значении параметра traffic_source_type в строке. Значение этого параметра заполняется для следующих значений параметра traffic_source_type:
  • 1 – значение параметра, которое определяет тип объявления, показанного зрителю. Список возможных значений приведен в определении параметра traffic_source_type.
  • 3 – значение параметра, которое определяет функцию YouTube, приведшую к переходу. Список возможных значений приведен в определении параметра traffic_source_type.
  • 4 – значение параметра указывает идентификатор канала, с которого был перенаправлен зритель.
  • 5 – значение параметра указывает поисковый запрос, который привел к переходу.
  • 7 – значение параметра, которое позволяет определить, из какого видео зритель перешел на ваш канал.
  • 8 – значение параметра, которое определяет тип страницы YouTube, с которой поступил трафик. Список возможных значений приведен в определении параметра traffic_source_type.
  • 9 – значение параметра, которое определяет внешнюю страницу, с которой был перенаправлен трафик.
  • 17 – значение параметра, определяющее тип уведомления, которое привело к переходу. Список возможных значений приведен в определении параметра traffic_source_type.
  • 19 – значение параметра, которое позволяет определить, из какого видео зритель перешел на ваш канал.
  • 20 – значение параметра, которое позволяет определить, из какого видео зритель перешел на ваш канал.
  • 25 – значение параметра, которое определяет идентификатор товара (идентификатор сети знаний Google).
  • 26 – значение параметра, определяющее хештег, который привел к переходу.
  • 27 – значение параметра, которое позволяет определить, из какого видео зритель перешел на ваш канал.
  • 28 – значение параметра указывает идентификатор канала, с которого зритель был перенаправлен с помощью live-редиректа.
  • 30 – значение параметра указывает на видео, из которого был выполнен переход.

Устройства

device_type
Этот параметр позволяет определить размеры устройства, на котором выполняется воспроизведение. В таблице ниже перечислены допустимые значения параметров.
Значение Описание
100 Неизвестно
101 На компьютере
102 На телевидении
103 Игровая приставка
104 Мобильный телефон
105 Планшет
operating_system
Этот параметр позволяет узнать, на устройствах с какими операционными системами пользователи смотрели ваши видео. В таблице ниже перечислены допустимые значения параметров.
Значение Описание
1 Другое
2 Windows
3 Windows Mobile
4 Android
5 iOS
6 Symbian
7 Blackberry
9 Macintosh
10 PlayStation
11 Bada
12 WebOS
13 Linux
14 Hiptop
15 MeeGo
16 Wii
17 Xbox
18 PlayStation Vita
19 Smart TV
20 Nintendo 3DS
21 Chromecast
22 Tizen
23 Firefox
24 RealMedia
25 KaiOS
26 Устройства Roku
27 Nintendo Switch
28 Apple tvOS
29 Fire OS
30 ChromeOS
31 Vidaa
32 VegaOS

Демография

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

age_group (основной параметр)
Этот параметр позволяет узнать возрастную группу вошедших в аккаунт пользователей, связанных с данными отчета, и включает пользователей, которым, по оценкам YouTube, меньше 18 лет. В API используются следующие возрастные группы:
  • AGE_13_17
  • AGE_18_24
  • AGE_25_34
  • AGE_35_44
  • AGE_45_54
  • AGE_55_64
  • AGE_65_
This is a core dimension and is subject to the Deprecation Policy.
Пол (основной параметр)
Этот параметр позволяет определить пол вошедших в аккаунт пользователей, связанных с данными отчета. Допустимые значения: FEMALE, MALE и GENDER_OTHER. This is a core dimension and is subject to the Deprecation Policy.

Вовлеченность и обмен контентом

sharing_service (основной параметр)
Этот параметр позволяет определить, через какой сервис пользователи делились видео. Чтобы поделиться видео на YouTube или через проигрыватель YouTube, нажмите кнопку "Поделиться". This is a core dimension and is subject to the Deprecation Policy.

В таблице ниже перечислены допустимые значения параметров.
Значение Описание
0 Неизвестно
1 Digg;
4 reddit
5 StumbleUpon
6 mixi
7 Yahoo! Japan
8 Goo
9 Ameba
10 Facebook
11 MySpace
12 NUjij
18 Tuenti
20 Menéame
21 Wykop
22 Skyrock
25 Fotka
28 hi5
31 Твиттер
32 Cyworld
34 Blogger
36 ВКонтакте
37 Rakuten (楽天市場)
38 LiveJournal
39 Одноклассники
40 Tumblr.
42 LinkedIn
43 Google+
44 Weibo
45 Pinterest
46 Электронная почта
47 Facebook Messenger
49 WhatsApp
50 Hangouts
51 Gmail
52 Kakao (Kakao Talk)
53 Другое
55 Копировать в буфер обмена
59 Встраивание
60 SMS
61 Обмен сообщениями на Android
62 Verizon Messages
63 Текстовое сообщение HTC
64 Sony Conversations
65 Go SMS
66 LGE Email
67 График
68 Viber
69 Kik
70 Skype
71 Blackberry Messenger
72 WeChat
73 KakaoStory
74 Dropbox
75 Telegram
76 Страницы Facebook
77 GroupMe
78 Android Email;
79 Motorola Messaging
80 Обмен с окружением
81 Naver
82 Диалоговое окно активности системы iOS
83 Google Inbox
84 Android Messenger
85 YouTube Music
86 YouTube Гейминг
87 YouTube Детям
88 YouTube TV
89 Совместный просмотр YouTube
90 Allo
91 Публикация в сообществе YouTube
92 Репост на вкладке "Сообщество"
93 Сообщения KaiOS
94 Копирование и вставка в Картах
95 Поделиться с детьми
96 Диалоговое окно "Действия в системе"
97 Snapchat
98 Предпросмотр отправки контента из YouTube Music в Snapchat
99 Отправить в Snapchat
100 Диалоговое окно системы Android
101 Сохранить изображение на устройстве
102 Instagram
103 Диалоговое окно действий в системе
104 Discord
105 Instagram Stories
106 Facebook Stories
107 Показ приложения в Meet
108 Samsung Messages
109 WhatsApp Business
110 Samsung Notes
111 Google Keep
112 Facebook Lite
113 ИМХО
114 YouTube Mango
115 Поделиться в группе Facebook
116 Google Chat
117 Как пригласить соавторов плейлиста
118 Быстрая отправка
119 Быстрая отправка (Samsung)
120 Показанный QR-код
121 Зеленый экран в YouTube Shorts
122 Поделиться без рекламы
123 Приложение Google
124 Google Chrome
125 Реакция вслепую
126 Ссылка для приглашения (Android)
127 Ссылка для приглашения (iOS)
128 Ремикс

Дополнительную информацию можно найти в Справочном центре.

Аннотации

annotation_type
Этот параметр определяет, как аннотация показывается во время видео. В таблице ниже перечислены возможные значения параметров.
Значение Описание
0 Неизвестно
1 Примечание
3 Spotlight
4 Название
8 Значок выноски
9 Ярлык
10 Логотип канала
11 Рекомендованное видео
12 Избранный плейлист
30 Призыв к действию
Подробнее о типах аннотаций и о том, как их добавлять, рассказывается в Справочном центре YouTube.
annotation_id
Идентификатор, который YouTube использует для уникальной идентификации аннотации.

кредитные карты;

card_type
Этот параметр позволяет определить тип карточки, которая была показана пользователю. В таблице ниже перечислены возможные значения параметров.
Значение Описание
0 Неизвестно
60 Ссылка
61 Сбор средств
62 Видео
63 Плейлист
65 Пожертвования сообщества
66 Мерч
68 Связанный веб-сайт
69 Канал
Подробнее о типах подсказок и о том, как их добавлять, написано в Справочном центре YouTube.
card_id
Идентификатор, который YouTube использует для уникальной идентификации карточки.

Конечные заставки

end_screen_element_type
Этот параметр позволяет определить тип элемента конечной заставки, который был показан пользователю. В таблице ниже перечислены типы элементов конечных заставок и их значения.
Значение Описание
501 Видео. Элемент продвигает другое видео на YouTube.
502 Плейлист.
503 Веб-сайт. Элемент ссылается на связанный с вами сайт.
504 Канал. Ссылка на другой канал.
505 Призыв подписаться. Вы можете предложить зрителям подписаться на ваш канал.
506 Связанные
507 Краудфандинг. Ссылка на одобренный сайт для краудфандинга.
508 Товары. Элемент ссылается на одобренный сайт с товарами.
509 Самое новое. Ссылка на видео, которое вы загрузили последним.
510 Самое подходящее
end_screen_element_id
Идентификатор, который YouTube использует для уникальной идентификации элемента конечной заставки.

Субтитры

subtitle_language
Этот параметр позволяет определить, на каком языке субтитры показывались дольше всего во время просмотра. Просмотры, во время которых субтитры были отключены, не учитываются. Подробную информацию об отчетах, содержащих этот параметр, можно найти в документации по отчетам для каналов и отчетам для владельцев контента.
subtitle_language_autotranslated
Этот параметр позволяет определить язык автоматически переведенных субтитров, которые использовались дольше всего во время просмотра. Просмотры, во время которых субтитры были отключены, не учитываются. Подробную информацию об отчетах, содержащих этот параметр, можно найти в документации по отчетам для каналов и отчетам для владельцев контента.

Эффективность объявлений

ad_type
Параметр ad_type используется в отчетах об эффективности объявлений и агрегирует запрошенные показатели на основе типов объявлений, которые показывались во время воспроизведения видео. В таблице ниже перечислены возможные значения параметров. Дополнительную информацию о форматах объявлений на YouTube можно найти в Справочном центре YouTube.
Значение Описание Значение в отчетах о запросах
1 Видеообъявления с возможностью пропуска (аукцион) auctionTrueviewInstream
2 Медийные объявления (аукцион) auctionDisplay
3 Видеообъявления без возможности пропуска (аукцион) auctionInstream
5 Медийные объявления (с резервированием) reservedDisplay
6 Видеообъявления без возможности пропуска (с резервированием) reservedInstream
13 Неизвестно unknown
15 Видеообъявления с возможностью пропуска (с резервированием) reservedInstreamSelect
19 Объявления-заставки (аукцион) auctionBumperInstream
20 Объявления-заставки (зарезервированные) reservedBumperInstream

Примечание. В отчетах по запросам могут быть представлены данные о некоторых дополнительных типах объявлений, которые ранее использовались на YouTube.

Параметры владельца контента

Следующие параметры используются только в отчетах владельца контента.

claimed_status (только в отчетах для владельцев контента)
Этот параметр указывает, что строка данных содержит только показатели для контента, на который заявлены права. Единственное допустимое значение для этого параметра – claimed. В таблице с определением параметра uploader_type приведена подробная информация о том, как его использовать.
uploader_type (основной параметр) (используется только в отчетах для владельцев контента)
Этот параметр показывает, содержатся ли в строке данных показатели для контента, загруженного указанным владельцем контента и/или третьими лицами (например, видео, загруженные пользователями). Допустимые значения: self и thirdParty. Это основной параметр, на который распространяются правила прекращения поддержки.

В таблице ниже приведены поддерживаемые комбинации параметров claimed_status и uploader_type.

На сумму claimed_status На сумму uploader_type Описание
[Не задано] self Строка содержит данные YouTube Аналитики для контента, загруженного владельцем контента, на который заявлены или не заявлены права.
видео, на которые заявлены права self Строка содержит данные о контенте, на который заявлены права и который загружен владельцем контента.
видео, на которые заявлены права thirdParty Строка содержит данные о контенте, на который заявлены права и который загружен третьей стороной.