В этом документе определены параметры, поддерживаемые API YouTube Reporting . Этот API извлекает пакетные отчеты, содержащие данные YouTube Analytics для канала или владельца контента.
Параметры — это общие критерии, которые используются для агрегирования данных, например, дата совершения пользователем действия или страна, в которой находились пользователи.
Каждый пакетный отчёт поддерживает предопределённый список измерений, и в любом отчёте каждая строка данных содержит уникальную комбинацию значений измерений. Таким образом, комбинация значений измерений в каждой строке служит первичным ключом для этой строки. Вам не нужно указывать, какие измерения должны быть включены в отчёт, и у вас нет возможности указать их.
Основные размеры
Хотя API YouTube Reporting регулируется Политикой устаревания, изложенной в Условиях обслуживания , на дополнительные параметры (и дополнительные метрики) эта политика не распространяется. В определениях на этой странице любой параметр, являющийся основным, явно обозначен как таковой.
В следующем списке перечислены основные параметры API. Все они также являются основными параметрами API YouTube Analytics.
Более подробную информацию можно найти в списке API YouTube, на которые распространяется Политика устаревания .
Размеры
В следующих разделах описаны параметры, используемые в массовых отчётах API YouTube Reporting. Если не указано иное, эти параметры используются как в отчётах по каналам , так и в отчётах по владельцам контента .
Ресурсы
Эти измерения соответствуют ресурсам, которыми управляют владельцы каналов и контента на YouTube:
- video_id (core dimension)
- Идентификатор видео YouTube. В API данных YouTube это значение свойства
idvideo. This is a core dimension and is subject to the Deprecation Policy . - playlist_id
- Идентификатор плейлиста YouTube. В API данных YouTube это значение свойства
idресурсаplaylist. - channel_id (core dimension)
- Идентификатор канала YouTube. В API данных YouTube это значение свойства
idресурсаchannel. This is a core dimension and is subject to the Deprecation Policy . - asset_id (only used in content owner reports)
- Идентификатор актива, управляемый в системе Content ID YouTube. Актив — это представление вашей интеллектуальной собственности в этой системе. На сайте YouTube идентификаторы активов можно найти в Менеджере контента YouTube. Вы также можете получить их с помощью API YouTube Content ID .
Географические районы
Эти измерения определяют географический регион, связанный с активностью пользователей, эффективностью рекламы или предполагаемыми показателями дохода.
- country_code (core dimension)
- Страна, связанная с метриками в строке отчёта. Значение параметра представляет собой двухбуквенный код страны 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 (core dimension)
- Это измерение определяет дату, связанную с метриками в каждой строке отчёта. В пакетных отчётах дата относится к периоду, начинающемуся с 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. - playback_location_detail
- Это измерение указывает URL-адрес или приложение, где произошло воспроизведение. Это измерение поддерживается только для просмотров, выполненных во встроенных проигрывателях, что означает, что значение измерения заполняется только в строках, где оно равно
1В остальных строках значение этого измерения пустое.
Подробности воспроизведения
- live_or_on_demand
- Это измерение показывает, связаны ли показатели активности пользователей в строке данных с просмотрами прямой трансляции. Данные по этому измерению доступны для дат, начиная с 1 апреля 2014 г.
В следующей таблице перечислены значения измерений:Ценности liveДанные строки описывают активность пользователя, имевшую место во время прямой трансляции. onDemandДанные строки описывают активность пользователя, которая не имела места во время прямой трансляции. - subscribed_status
- Это измерение указывает, связаны ли метрики активности пользователей в строке данных со зрителями, подписавшимися на канал видео или плейлиста. Возможные значения:
subscribedиunsubscribed.
Обратите внимание, что значение параметра актуально на момент совершения пользователем действия. Например, предположим, что пользователь не подписан на канал и смотрит одно из видео на этом канале, затем подписывается на канал и смотрит другое видео, и всё это в один и тот же день. В отчёте канала указано, что одно представление имеет значениеsubscribed_status, равноеsubscribed, а другое — значениеsubscribed_status, равноеunsubscribed.
Источники трафика
- traffic_source_type
- Это измерение определяет тип реферера, связанный с метриками активности пользователя. Тип реферера описывает способ, которым пользователи перешли на видео или канал, связанный со строкой данных в отчёте. В следующей таблице перечислены значения измерения:
Ценности 0Прямой или неизвестный
Это значение охватывает как прямой трафик на страницу, так и страницы, для которых реферер неизвестен. В отчётах по запросам этот тип источника трафика обозначается какNO_LINK_OTHERилиUNKNOWN_MOBILE_OR_DIRECT.1Реклама на YouTube
Зритель перешёл на видео по рекламе. Если в отчёте по источнику трафика значение этого параметра равно1, то параметр traffic_source_detail определяет тип рекламы, показанной зрителю. В отчётах по запросам этот тип источника трафика определяется какADVERTISING. Возможные значения:Ценности ctp_engagement_adРеклама с функцией воспроизведения по клику engagement_adРеклама для вовлечения googlemediaadsРеклама в Google Поиске insearch_displayTrueView в поиске и на дисплее instreamTrueView в потоке instream-selectЗарезервированный пропускаемый поток 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. Возможные значения:Ценности g-crecРекомендуемые каналы offlineОффлайн promotionПартнерское продвижение unknownНеизвестный widgetВиджет для домашнего экрана Android youtu.beyoutu.be ytremoteYouTube Remote 9Внешний
Посетители перешли по ссылке с другого сайта. Этот источник трафика включает переходы из результатов поиска Google. В отчёте по источникам трафика, если значение этого параметра равно9, параметр traffic_source_detail идентифицирует внешнюю веб-страницу. В отчётах по запросам этот тип источника трафика обозначается какEXT_URL.11Видеокарты и аннотации
Зрители перешли на сайт, нажав на аннотацию или карточку в другом видео. В отчётах по запросам этот тип источника трафика обозначается какANNOTATION.14Плейлисты
Просмотры происходили во время воспроизведения видео в составе плейлиста. В отчётах по запросам этот тип источника трафика обозначается какPLAYLIST.
Обратите внимание, что этот источник трафика отличается от типа источника18, который указывает на то, что просмотры исходили со страницы, на которой перечислены все видео в плейлисте.17Уведомления
Зрители были перенаправлены по электронной почте или с помощью уведомления от YouTube. В отчётах по запросам этот тип источника трафика обозначается какNOTIFICATION. Возможные значения:Ценности inboxpushsdigПросмотры были получены из уведомлений, которые были частью дайджеста подписчика uploaded_otherПросмотры были получены из неpush-уведомлений, таких как уведомления по электронной почте или входящие сообщения, отправленные подписчикам при загрузке видео. uploaded_pushПросмотры были получены из push-уведомлений, отправленных подписчикам при загрузке видео. 18Страницы плейлистов
Просмотры были получены со страницы, содержащей список всех видео в плейлисте. В отчётах по запросам этот тип источника трафика обозначается какYT_PLAYLIST_PAGE.
Обратите внимание, что этот источник трафика отличается от типа источника14, который указывает на то, что просмотры происходили во время воспроизведения видео в рамках плейлиста.19Программирование из заявленного контента
Просмотры были получены из заявленных видео, загруженных пользователями, которые владелец контента использовал для продвижения просмотренного контента. В отчётах по запросам этот источник трафика обозначается какCAMPAIGN_CARD. Этот источник трафика поддерживается только в отчётах владельца контента.20Интерактивный видеоконец-экран
Просмотры, инициированные конечной заставкой другого видео. В отчётах по запросам этот тип источника трафика обозначается какEND_SCREEN.23Истории
Зритель перенаправлялся на страницу, просматривая предыдущее видео вертикальным свайпом в разделе «Истории».24Шорты
Зритель перенаправлялся на него, проводя по вертикали от предыдущего видео в режиме просмотра коротких видео.25Страницы продуктов
Видеоролики на странице продукта перенаправляли зрителей на другой канал.26Страницы хэштегов
Просмотры происходят со страниц хэштегов VOD или опорных страниц хэштегов Shorts.27Звуковые страницы
Просмотры происходят со страниц звуковых роликов Shorts.28Живое перенаправление
Просмотры, полученные с помощью Live Redirects .29Подкасты
Просмотры были получены со страницы YouTube Podcasts .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 Knowledge Graph. -
26– Значение параметра определяет хэштег, который привел к направленному трафику. -
27– Значение параметра определяет видео, с которого был осуществлен переход зрителя. -
28– Значение параметра указывает идентификатор канала, с которого зритель был перенаправлен с помощью Live Redirects . -
30– Значение параметра определяет видео, с которого был осуществлен переход зрителя.
-
Устройства
- device_type
- Этот параметр определяет физический форм-фактор устройства, на котором был выполнен просмотр. В следующей таблице перечислены допустимые значения параметра:
Ценности 100Неизвестный 101Компьютер 102ТВ 103Игровая консоль 104Мобильный телефон 105Планшет - operating_system
- Это измерение определяет программную систему устройства, на котором был выполнен просмотр. В следующей таблице перечислены допустимые значения измерения:
Ценности 1Другой 2Окна 3Windows Mobile 4Андроид 5iOS 6Симбиан 7Ежевика 9Макинтош 10PlayStation 11Бада 12WebOS 13Линукс 14Хиптоп 15MeeGo 16Wii 17Xbox 18PlayStation Vita 19Смарт ТВ 20Нинтендо 3DS 21Chromecast 22Тизен 23Firefox 24RealMedia 25KaiOS 26Року 27Nintendo Switch 28Apple tvOS 29Fire OS 30ChromeOS 31Видаа 32ВегаОС
Демография
Демографические параметры помогают вам понять возрастной диапазон и гендерное распределение вашей аудитории. Справочный центр YouTube содержит дополнительную информацию о демографических данных в отчётах YouTube Analytics .
- age_group (core dimension)
- Это измерение определяет возрастную группу вошедших в систему пользователей, связанных с данными отчёта. API использует следующие возрастные группы:
-
AGE_13_17 -
AGE_18_24 -
AGE_25_34 -
AGE_35_44 -
AGE_45_54 -
AGE_55_64 -
AGE_65_
-
- gender (core dimension)
- Это измерение определяет пол вошедших в систему пользователей, связанных с данными отчёта. Допустимые значения:
FEMALE,MALEиGENDER_OTHER. This is a core dimension and is subject to the Deprecation Policy .
Взаимодействие и обмен контентом
- Это измерение определяет сервис, который использовался для публикации видео. Видео можно публиковать на YouTube (или через проигрыватель YouTube) с помощью кнопки «Поделиться». This is a core dimension and is subject to the Deprecation Policy .
В следующей таблице перечислены допустимые значения размеров:Ценности 0Неизвестный 1Дигг 4реддит 5StumbleUpon 6микс 7Yahoo! Япония 8идти 9Амеба 10Фейсбук 11Майспейс 12Нуджидж 18Туэнти 20menéame 21Выкоп 22Скайрок 25Фотка 28привет5 31Твиттер 32Cyworld 34Блогер 36ВКонтакте (ВКонтакте) 37Ракутен (楽天市場) 38Живой Журнал 39Одноклассники (Одноклассники) 40тамблер. 42Линкедин 43Google+ 44Вейбо 45Пинтерест 46Электронная почта 47Фейсбук Мессенджер 49WhatsApp 50Hangouts 51Gmail 52Какао (Kakao Talk) 53Другой 55Копировать в буфер обмена 59Встроить 60Текстовое сообщение 61Android-сообщения 62Сообщения Verizon 63Текстовое сообщение HTC 64Беседы с Sony 65Отправьте СМС 66Электронная почта LGE 67Линия 68Вайбер 69Кик 70Скайп 71BlackBerry Messenger 72WeChat 73История КАКАО 74Дропбокс 75Телеграмма 76Страницы Facebook 77GroupMe 78Электронная почта Android 79Motorola Сообщения 80Поделиться поблизости 81Навер 82Диалог активности системы iOS 83Входящие Google 84Android-мессенджер 85YouTube Музыка 86YouTube Гейминг 87YouTube Дети 88YouTube ТВ
Более подробную информацию смотрите в справочной документации .
Аннотации
- annotation_type
- Этот параметр определяет способ отображения аннотации во время видео. В следующей таблице перечислены возможные значения параметра:
Справочный центр YouTube предоставляет более подробную информацию о различных типах аннотаций, а также о процессе добавления аннотаций к вашим видео.Ценности 0Неизвестный 1Примечание 3В центре внимания 4Заголовок 8Речевой пузырь 9Этикетка 10Брендинговый водяной знак 11Рекомендуемое видео 12Рекомендуемый плейлист 30Призыв к действию - annotation_id
- Идентификатор, который YouTube использует для уникальной идентификации аннотации.
Карты
- card_type
- Этот параметр определяет тип карты, показанной пользователю. В следующей таблице перечислены возможные значения параметра:
Справочный центр YouTube предоставляет более подробную информацию о различных типах карточек, а также о процессе добавления карточек в ваши видео.Ценности 0Неизвестный 60Связь 61Сбор средств 62Видео 63Плейлист 65Финансирование от фанатов 66Товары 68Связанный веб-сайт 69Канал - card_id
- Идентификатор, который YouTube использует для уникальной идентификации карты.
Конечные экраны
- end_screen_element_type
- Это измерение определяет тип элемента конечной заставки, отображаемого пользователю. В следующей таблице перечислены типы элементов конечной заставки и их значения:
Ценности 501Видео - элемент продвигает другое видео YouTube. 502Плейлист - Элемент продвигает плейлист YouTube. 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Пропускаемые видеорекламы (Аукцион) auctionTrueviewInstream2Рекламные объявления (Аукцион) auctionDisplay3Видеореклама без возможности пропуска (Аукцион) auctionInstream5Показывать рекламу (зарезервировано) reservedDisplay6Видеореклама без возможности пропуска (зарезервировано) reservedInstream13Неизвестный unknown15Пропускаемые видеорекламы (зарезервировано) reservedInstreamSelect19Рекламные объявления (аукцион) auctionBumperInstream20Рекламные объявления (зарезервировано) reservedBumperInstreamПримечание: отчеты по запросам могут содержать информацию о некоторых дополнительных типах рекламы, которые ранее использовались на YouTube.
Параметры владельца контента
Следующие параметры используются только в отчетах владельцев контента.
- claimed_status (only used in content owner reports)
- Это измерение указывает, что строка данных содержит только метрики для заявленного контента. Единственное допустимое значение для этого измерения —
claimed. Таблица в определении измеренияuploader_typeсодержит более подробную информацию об использовании этого измерения.
- uploader_type (core dimension) (only used in content owner reports)
- Это измерение указывает, содержит ли строка данных метрики для контента, загруженного указанным владельцем контента, и/или контента, загруженного третьими лицами, например, видео, загруженных пользователями. Допустимые значения:
selfиthirdParty. Это основное измерение, подпадающее под действие Политики устаревания .
В таблице ниже показаны поддерживаемые комбинации дляclaimed_statusиuploader_type:значение claimed_statusзначение uploader_typeОписание [Не установлено] self Строка содержит данные YouTube Analytics по заявленному и невостребованному контенту, загруженному владельцем контента. claimed self Строка содержит данные о заявленном контенте, загруженном владельцем контента. claimed thirdParty Строка содержит данные о заявленном контенте, загруженном третьей стороной.