На этой странице перечислены изменения API и обновления документации для API отчетов YouTube и API YouTube Analytics. Оба API позволяют разработчикам получать доступ к данным YouTube Analytics, хотя и разными способами. Подпишитесь на этот журнал изменений .
15 ноября 2024 г.
Примечание. Следующее изменение вступает в силу 18 ноября 2024 г.
В документацию по API YouTube Analytics (целевые запросы) добавлена информация о том, что для отчетов об источниках трафика метод API reports.query
теперь возвращает ошибку, если произведение количества запрошенных видео на количество дней в диапазоне дат превышает 50 000. Например, запрос, который получает данные для 500 идентификаторов видео, может запрашивать данные максимум за 100 дней.
Это изменение затрагивает отчеты как для каналов , так и для владельцев контента .
Чтобы уменьшить количество строк, возвращаемых запросом, разделите запрос на несколько запросов, которые указывают меньшее количество видео или устанавливают более короткие диапазоны дат. Как правило, массовые отчеты рекомендуются для больших наборов данных.
6 мая 2024 г.
API YouTube Analytics (целевые запросы) поддерживает три новых отчета для каналов:
Отчет «Активность пользователей по DMA» — это географический отчет, в котором представлена статистика активности пользователей по назначенным рыночным зонам (DMA). Для этого отчета необходимо установить значение параметра
filters
country==US
.Отчет «Одновременные зрители» показывает количество одновременных зрителей различных частей одного видео в прямом эфире.
В отчете «Отмены участников» представлена статистика, показывающая, почему пользователи отменили свое членство в канале .
В этом отчете используется новое
membershipsCancellationSurveyReason
, которое указывает, почему пользователь отменил членство в канале. Он также использует новуюmembershipsCancellationSurveyResponses
, которая показывает, сколько членств в каналах было отменено по этой причине.
Кроме того, отчет «Удержание аудитории» был улучшен и теперь поддерживает три новых показателя:
7 апреля 2024 г.
API YouTube Analytics (целевые запросы) имеет несколько обновлений, связанных с отчетами о плейлистах владельцев контента. Обновления аналогичны обновлениям, связанным с отчетами о плейлистах каналов, о которых было объявлено 19 января 2024 года.
Следующая запись истории изменений содержит почти ту же информацию, что и запись от 19 января 2024 г. Однако обратите внимание, что отчеты о плейлистах владельцев контента будут поддерживать измерение isCurated
до 31 декабря 2024 г., а это измерение будет поддерживаться для отчетов о плейлистах каналов до 30 июня 2024 г.
Примечание. Это объявление об устаревании.
Параметр
isCurated
устарел для отчетов о плейлистах владельцев контента. Он перестанет поддерживаться 31 декабря 2024 г. или после этой даты. Определение этого параметра было соответствующим образом обновлено.Чтобы сохранить обратную совместимость при удалении измерения
isCurated
, вам также необходимо обновить код, чтобы получить метрикуplaylistViews
вместо метрикиviews
только для отчетов по спискам воспроизведения. Поскольку метрикаviews
по-прежнему поддерживается для отчетов по спискам воспроизведения, хотя и с другим значением, API по-прежнему будет возвращать данные, если вы не обновите имя метрики. Конечно, вы можете изменить свое приложение для получения и отображения какviews
, так иplaylistViews
.Помимо измерения
isCurated
, в новых отчетах больше не поддерживаются следующие функции API:- Фильтры местоположения, такие как
continent
иsubcontinent
не поддерживаются для отчетов о новых плейлистах каналов. - Метрики
redViews
иestimatedRedMinutesWatched
больше не поддерживаются для отчетов о плейлистах новых каналов. Эти метрики не были доступны в YouTube Studio, поэтому это изменение приводит функциональность API в соответствие с функциями, доступными в приложении Studio. - Измерения
subscribedStatus
иyoutubeProduct
больше не поддерживаются в качестве фильтров для отчетов о плейлистах канала. Эти фильтры были недоступны в YouTube Studio, поэтому это изменение приводит функциональность API в соответствие с функциональностью, доступной в приложении Studio.
- Фильтры местоположения, такие как
Раздел отчетов о плейлистах документации по отчетам владельцев контента был обновлен, чтобы более подробно объяснить типы показателей, которые поддерживаются для отчетов о плейлистах:
- Агрегированные показатели видео предоставляют показатели активности пользователей и показов, которые суммируются для всех видео в плейлистах владельца контента, которые также принадлежат этому владельцу контента. Агрегированные показатели видео поддерживаются только для запросов API, которые не используют измерение
isCurated
. - Показатели плейлиста отражают активность и вовлеченность пользователей в контексте страницы плейлиста. Эти показатели включают в себя данные о том, что будут также учитываться просмотры видео, не принадлежащих вам, в плейлисте, но только тогда, когда эти просмотры произошли в контексте плейлиста.
- В разделе поддерживаемых показателей списка воспроизведения указаны агрегированные показатели видео и показатели списка воспроизведения, которые поддерживаются для отчетов по спискам воспроизведения.
- Агрегированные показатели видео предоставляют показатели активности пользователей и показов, которые суммируются для всех видео в плейлистах владельца контента, которые также принадлежат этому владельцу контента. Агрегированные показатели видео поддерживаются только для запросов API, которые не используют измерение
Следующие новые показатели в плейлистах поддерживаются для отчетов по плейлистам для владельцев контента. Обратите внимание, что эти метрики поддерживаются только в том случае, если запрос API на получение отчетов не использует измерение
isCurated
. См. документацию по метрикам для определения каждой метрики:Поведение метрики
views
теперь зависит от того, использовал ли запрос API, получивший отчет о плейлисте, измерениеisCurated
:- Если запрос включает параметр
isCurated
, показательviews
— это показатель в плейлисте, который указывает, сколько раз видео просматривалось в контексте плейлистов владельца контента. - Если запрос не включает измерение
isCurated
, показательviews
представляет собой совокупный показатель видео, который определяет общее количество просмотров видео в плейлистах владельца контента, независимо от того, имели ли эти просмотры место в контексте плейлиста. В агрегированную сумму входят только просмотры видео, принадлежащие владельцу контента, связанному с каналом, которому принадлежит плейлист.
В этих отчетах, в которых не используется параметрisCurated
, метрикаplaylistViews
указывает, сколько раз видео просматривалось в контексте плейлиста. Этот показатель учитывает просмотры всех видео в плейлисте, независимо от того, какому каналу они принадлежат.
- Если запрос включает параметр
Для каждого отчета о плейлисте документация по отчетам владельца контента теперь включает таблицы, показывающие поддерживаемые метрики для этого отчета в зависимости от того, включает ли запрос API измерение
isCurated
. Пример см. в разделе, посвященном определению отчетов по спискам воспроизведения на основе времени .
19 января 2024 г.
API YouTube Analytics (целевые запросы) имеет несколько обновлений, связанных с отчетами о плейлистах каналов. Обновления включают устаревший параметр и несколько новых и обновленных показателей:
Примечание. Это объявление об устаревании.
Параметр
isCurated
устарел для отчетов по каналам. Он перестанет поддерживаться 30 июня 2024 г. или после этой даты. Определение этого параметра было соответствующим образом обновлено.Чтобы сохранить обратную совместимость при удалении измерения
isCurated
, вам также необходимо обновить код, чтобы получить метрикуplaylistViews
вместо метрикиviews
только для отчетов по спискам воспроизведения. Поскольку метрикаviews
по-прежнему поддерживается для отчетов по спискам воспроизведения, хотя и с другим значением, API по-прежнему будет возвращать данные, если вы не обновите имя метрики. Конечно, вы можете изменить свое приложение для получения и отображения какviews
, так иplaylistViews
.Помимо измерения
isCurated
, в новых отчетах больше не поддерживаются следующие функции API:- Фильтры местоположения, такие как
continent
иsubcontinent
не поддерживаются для отчетов о новых плейлистах каналов. - Метрики
redViews
иestimatedRedMinutesWatched
больше не поддерживаются для отчетов о плейлистах новых каналов. Эти метрики не были доступны в YouTube Studio, поэтому это изменение приводит функциональность API в соответствие с функциями, доступными в приложении Studio. - Измерения
subscribedStatus
иyoutubeProduct
больше не поддерживаются в качестве фильтров для отчетов о плейлистах канала. Эти фильтры были недоступны в YouTube Studio, поэтому это изменение приводит функциональность API в соответствие с функциональностью, доступной в приложении Studio.
- Фильтры местоположения, такие как
Раздел отчетов о плейлистах документации по отчетам о каналах был обновлен, чтобы более подробно объяснить типы показателей, которые поддерживаются для отчетов о плейлистах:
- Агрегированные показатели видео предоставляют показатели активности пользователей и показов, которые суммируются для всех видео в плейлистах канала, которые также принадлежат этому каналу. Агрегированные показатели видео поддерживаются только для запросов API, которые не используют измерение
isCurated
. - Показатели плейлиста отражают активность и вовлеченность пользователей в контексте страницы плейлиста. Эти показатели включают в себя данные о том, что будут также учитываться просмотры видео, не принадлежащих вам, в плейлисте, но только тогда, когда эти просмотры произошли в контексте плейлиста.
- В разделе поддерживаемых показателей списка воспроизведения указаны агрегированные показатели видео и показатели списка воспроизведения, которые поддерживаются для отчетов по спискам воспроизведения.
- Агрегированные показатели видео предоставляют показатели активности пользователей и показов, которые суммируются для всех видео в плейлистах канала, которые также принадлежат этому каналу. Агрегированные показатели видео поддерживаются только для запросов API, которые не используют измерение
В отчетах по плейлистам для каналов поддерживаются следующие новые показатели плейлистов . Эти показатели пока не поддерживаются для отчетов владельцев контента. Обратите внимание, что эти метрики поддерживаются только в том случае, если запрос API на получение отчетов не использует измерение
isCurated
. См. документацию по метрикам для определения каждой метрики:Поведение метрики
views
теперь зависит от того, использовал ли запрос API, получивший отчет о плейлисте, измерениеisCurated
:- Если запрос включает параметр
isCurated
, показательviews
— это показатель в плейлисте, который указывает, сколько раз видео было просмотрено в контексте плейлистов канала. - Если запрос не включает измерение
isCurated
, показательviews
представляет собой совокупный показатель видео, который определяет общее количество просмотров видео в плейлистах канала, независимо от того, имели ли эти просмотры место в контексте плейлиста. В агрегированную сумму входят только просмотры видео, принадлежащих каналу, которому принадлежит плейлист.
В этих отчетах, в которых не используется параметрisCurated
, метрикаplaylistViews
указывает, сколько раз видео просматривалось в контексте плейлиста. Этот показатель учитывает просмотры всех видео в плейлисте, независимо от того, какому каналу они принадлежат.
- Если запрос включает параметр
Для каждого отчета о плейлисте документация по отчетам о каналах теперь включает таблицы, показывающие поддерживаемые метрики для этого отчета в зависимости от того, включает ли запрос API измерение
isCurated
. Пример см. в разделе, посвященном определению отчетов по спискам воспроизведения на основе времени .
04 декабря 2023 г.
API YouTube Analytics (целевые запросы) был обновлен и теперь объединяет два значения измерения insightTrafficSourceType
. Ранее этот параметр различал видео, воспроизводимые как часть списка воспроизведения ( PLAYLIST
), и просмотры, происходящие со страницы, на которой перечислены все видео в списке воспроизведения ( YT_PLAYLIST_PAGE
). В дальнейшем оба типа представлений будут связаны со значением измерения PLAYLIST
.
15 декабря 2022 г.
API YouTube Analytics (целевые запросы) поддерживает два новых параметра и один новый отчет:
Новый отчет показывает активность пользователей по городам. Этот отчет доступен владельцам каналов и контента . Этот отчет содержит новый параметр
city
, который определяет оценку YouTube города, в котором имела место активность пользователя.Новое измерение
creatorContentType
определяет тип контента YouTube, который связан с показателями активности пользователей в строке данных. Поддерживаемые значения:LIVE_STREAM
,SHORTS
,STORY
иVIDEO_ON_DEMAND
.Параметр
creatorContentType
поддерживается как необязательный параметр для всех видеоотчетов владельцев каналов и контента.Руководство по примерам запросов API YouTube Analytics теперь включает примеры для обоих новых параметров.
Ссылки на измерения
7DayTotals
и30DayTotals
были удалены из документации. Об прекращении поддержки этих размеров было объявлено в октябре 2019 года.
26 августа 2022 г.
API YouTube Analytics (целевые запросы) и API отчетов YouTube (массовые отчеты) поддерживают новое значение подробностей об источнике трафика:
- В API YouTube Analytics API (целевые запросы), если значение измерения
insightTrafficSourceType
равноSUBSCRIBER
, тогда для значенияinsightTrafficSourceDetail
можно установитьpodcasts
, что указывает на то, что трафик был перенаправлен с целевой страницы подкастов. - В API отчетов YouTube (массовые отчеты), если значение параметра
traffic_source_type
равно3
, то значениеtraffic_source_detail
может быть установлено вpodcasts
, что указывает на то, что трафик был перенаправлен с целевой страницы подкастов.
11 февраля 2022 г.
Набор допустимых значений для gender
измерения изменится 11 августа 2022 года или после этой даты. Это может быть обратно несовместимым изменением в вашей реализации API. В соответствии с разделом «Изменения, несовместимые с обратной совместимостью» Условий обслуживания API-сервисов YouTube, об этом изменении объявляется за шесть месяцев до его вступления в силу. Обновите реализацию API до 11 августа 2022 г., чтобы обеспечить плавный переход к новому набору значений.
Конкретные изменения, которые вносятся:
- В API YouTube Analytics (целевые запросы)
gender
параметр в настоящее время поддерживает два значения:female
иmale
. 11 августа 2022 г. или позднее это измерение будет поддерживать три значения:female
,male
иuser_specified
. - В API отчетов YouTube (массовые отчеты)
gender
параметр в настоящее время поддерживает три значения:FEMALE
,MALE
иGENDER_OTHER
. 11 августа 2022 г. или позже набор поддерживаемых значений изменится наFEMALE
,MALE
иUSER_SPECIFIED
.
9 февраля 2022 г.
По состоянию на 13 декабря 2021 года были обновлены два показателя, исключающие трафик зацикленных клипов. Это изменение затрагивает как API YouTube Analytics (целевые запросы), так и API отчетов YouTube (массовые отчеты).
- В API YouTube Analytics (целевые запросы) метрики
averageViewDuration
иaverageViewPercentage
исключают трафик зацикленных клипов по состоянию на 13 декабря 2021 г. - В API отчетов YouTube (массовые отчеты) метрики
average_view_duration_seconds
иaverage_view_duration_percentage
исключают трафик зацикленных клипов по состоянию на 13 декабря 2021 года.
2 февраля 2022 г.
Этот API отчетов YouTube (массовые отчеты) поддерживает новое значение параметра источника трафика, которое указывает, что просмотры возникли в результате прямых перенаправлений :
- В API отчетов YouTube (массовые отчеты) параметр
traffic_source_type
поддерживает значение28
.
Для этого типа источника трафика измерение traffic_source_detail
указывает идентификатор канала, с которого был перенаправлен зритель.
23 сентября 2020 г.
Этот API YouTube Analytics (целевые запросы) и API отчетов YouTube (массовые отчеты) поддерживают новое значение параметра источника трафика, которое указывает, что зритель перешел, проведя по вертикали при просмотре YouTube Shorts:
- В API YouTube Analytics API (целевые запросы) параметр
insightTrafficSourceType
поддерживает значениеSHORTS
. - В API отчетов YouTube (массовые отчеты) параметр
traffic_source_type
поддерживает значение24
.
Параметр сведений об источнике трафика — insightTrafficSourceDetail
в API YouTube Analytics или traffic_source_detail
в API отчетов YouTube — не заполняется для этого нового типа источника трафика.
20 июля 2020 г.
Это обновление охватывает два изменения, которые влияют на API YouTube Analytics (целевые запросы):
- Максимальный размер группы отчетов YouTube Analytics увеличился с 200 до 500 объектов.
- Параметр
filters
методаreports.query
определяет список фильтров, которые следует применять при получении данных YouTube Analytics. Параметр поддерживает возможность указать несколько значений для фильтровvideo
,playlist
иchannel
, а максимальное количество идентификаторов, которые можно указать для этих фильтров, увеличено с 200 до 500 идентификаторов.
13 февраля 2020 г.
Это обновление содержит следующие изменения, связанные с API YouTube Analytics (целевые запросы) и API отчетов YouTube (массовые отчеты). Подробнее об этих изменениях можно узнать в Справочном центре YouTube .
В обоих API меняется набор возможных значений детализации источников трафика для уведомлений. В целевых запросах уведомления отображаются как insightTrafficSourceType=NOTIFICATION
. В массовых отчетах уведомления обозначаются как traffic_source_type=17
.
Новые значения разделяют уведомления, связанные с загруженными видео и прямыми трансляциями, которые ранее считались uploaded
, на две категории:
-
uploaded_push
— просмотры происходят из push-уведомлений, отправленных подписчикам при загрузке видео. -
uploaded_other
— просмотры возникли из-за не-push-уведомлений, таких как уведомления по электронной почте или входящих сообщениях, отправленных подписчикам при загрузке видео.
Эти значения возвращаются для временного диапазона, начинающегося с 13 января 2020 г. (13 января 2020 г.).
Кроме того, напоминаем, что эти значения представляют собой не сами уведомления, а скорее источники трафика, которые привели к определенным просмотрам на YouTube. Например, если в строке отчета указаны views=3
, traffic_source_type=17
( NOTIFICATION
) и traffic_source_detail=uploaded_push
, строка указывает, что три просмотра были результатом того, что зрители нажимали на push-уведомления, отправленные при загрузке видео.
15 октября 2019 г.
Это обновление содержит следующие изменения, связанные с API YouTube Analytics (целевые запросы):
Примечание. Это объявление об устаревании.
YouTube прекращает поддержку измерений
7DayTotals
и30DayTotals
. Вы по-прежнему можете получать данные с использованием этих измерений до 15 апреля 2020 года. Начиная с этой даты или позже, попытки получить отчеты с использованием измерения7DayTotals
или30DayTotals
вернут ошибку.Обратите внимание, что пользователи могут воспроизводить некоторые данные для этих измерений, делая запросы с использованием измерения
day
и агрегируя или получая данные за семи- или 30-дневные периоды. Например:- Количество просмотров за семидневный период можно рассчитать путем суммирования количества просмотров за каждый день этого периода.
- ViewerPercentage за семидневный период можно рассчитать, умножив количество просмотров, произошедших каждый день, на viewerPercentage за этот день, чтобы получить количество зрителей, вошедших в систему при просмотре видео в тот день. Затем можно добавить количество вошедших в систему зрителей за весь период и разделить на общее количество просмотров за этот период, чтобы получить процент просмотра за весь период.
- Количество уникальных зрителей за семидневный период подсчитать невозможно, поскольку один и тот же зритель может быть рассчитан как уникальный зритель в разные дни. Однако вы можете использовать измерение
month
вместо измерения30DayTotals
чтобы экстраполировать данные о количестве уникальных зрителей за 30-дневный период. Обратите внимание, что измерениеmonth
относится к календарным месяцам, тогда как измерение30DayTotals
вычисляет 30-дневные периоды на основе указанной даты начала и окончания.
27 июня 2019 г.
Это обновление содержит следующие изменения, связанные с API YouTube Analytics (целевые запросы):
Поскольку версия 1 API полностью устарела, документация была обновлена и удалены ссылки на эту версию, включая уведомление об устаревании и руководство по переходу, объясняющее, как обновиться до версии 2.
1 ноября 2018 г.
Это обновление содержит следующие изменения, связанные с API YouTube Analytics (целевые запросы):
Версия 1 API устарела. Если вы еще этого не сделали, обновите свои клиенты API, чтобы они использовали версию 2 API, как можно скорее, чтобы свести к минимуму перебои в обслуживании. Более подробную информацию см. в руководстве по миграции .
Обратите внимание, что график прекращения поддержки первоначально был объявлен 26 апреля 2018 г.
17 сентября 2018 г.
Это обновление содержит следующие изменения, связанные с API YouTube Analytics (целевые запросы):
В новом разделе анонимизации данных в обзорном документе модели данных объясняется, что некоторые данные YouTube Analytics ограничены, если показатели не соответствуют определенному пороговому значению. Это может произойти в самых разных случаях. На практике это означает, что отчет может не содержать все (или некоторые) ваши данные, если:
видео или канал имеет ограниченный трафик в течение определенного периода времени,
или
вы выбрали фильтр или параметр, например источник трафика или страну, значения которого не соответствуют определенному порогу.
В новом разделе также обсуждаются типы данных, которые могут быть ограничены в отчетах YouTube Analytics.
Документы отчетов о каналах и отчетов владельцев контента были обновлены, чтобы отразить тот факт, что метрики
redViews
иestimatedRedMinutesWatched
больше не поддерживаются для отчетов о местоположении воспроизведения, источнике трафика и типе устройства/операционной системе.
18 июня 2018 г.
Это обновление содержит следующие изменения в API YouTube Analytics (целевые запросы):
- Изменились требования к области применения следующих методов:
- Запросы к методу
reports.query
должны иметь доступ к областиhttps://www.googleapis.com/auth/youtube.readonly
. - Запросы к методу
groupItems.list
должны иметь доступ к:- область
https://www.googleapis.com/auth/youtube
или - область действия
https://www.googleapis.com/auth/youtube.readonly
и
областьhttps://www.googleapis.com/auth/yt-analytics.readonly
Первый вариант использует одну область, которая является областью чтения и записи, а второй вариант использует две области только для чтения.
- область
- Запросы к методу
23 мая 2018 г.
Это обновление содержит следующие изменения в API YouTube Analytics (целевые запросы):
- Обзор API содержит новый раздел «агрегированные показатели и удаленные элементы» , в котором объясняется, как ответы API обрабатывают данные, связанные с удаленными ресурсами, такими как видео, плейлисты или каналы.
- Раздел рекомендаций по обзору API был обновлен, чтобы напомнить вам, что вы можете использовать API данных YouTube для получения дополнительных метаданных для ресурсов, указанных в ответах API YouTube Analytics. Как указано в Политике разработчика API-сервисов YouTube (разделы с III.E.4.b по III.E.4.d), клиенты API должны либо удалить, либо обновить метаданные сохраненных ресурсов из этого API через 30 дней.
22 мая 2018 г.
Это обновление содержит следующие изменения, связанные с API отчетов YouTube (массовые отчеты):
- Следующие изменения вступят в силу в июле 2018 года. Новые политики применяются глобально ко всем отчетам и заданиям по отчетности.
После изменения большинство отчетов API, включая отчеты о заполнении, будут доступны в течение 60 дней с момента их создания. Однако отчеты, содержащие исторические данные, будут доступны в течение 30 дней с момента их создания.
До этого объявления все отчеты API были доступны в течение 180 дней с момента их создания. Чтобы внести ясность: когда это изменение политики вступит в силу, отчеты с историческими данными старше 30 дней также больше не будут доступны через API. Все остальные отчеты старше 60 дней также станут недоступны. Таким образом, в документации теперь указано, что отчеты, созданные до изменения политики, будут доступны в течение 180 дней.
После изменения, когда вы планируете задание по составлению отчетов, YouTube будет создавать отчеты, начиная с этого дня, и охватывать 30-дневный период, предшествовавший запланированному заданию. До изменения, когда вы планируете задание по составлению отчетов, YouTube будет создавать отчеты, охватывающие 180-дневный период до времени, когда задание было запланировано.
Раздел рекомендаций был обновлен, чтобы напомнить вам, что вы можете использовать API данных YouTube для получения дополнительных метаданных для ресурсов, указанных в отчетах. Как указано в Политике разработчика API-сервисов YouTube (разделы с III.E.4.b по III.E.4.d), клиенты API должны либо удалить, либо обновить метаданные сохраненных ресурсов из этого API через 30 дней.
Раздел «Характеристики отчета» был обновлен, и в нем указано, что, хотя данные отчета не фильтруются, отчеты, содержащие данные за период времени, начиная с 1 июня 2018 года или после этой даты, не будут содержать никаких ссылок на ресурсы YouTube, которые были удалены как минимум за 30 дней до этого. до даты составления отчета.
Раздел исторических данных обзора API был обновлен, чтобы отметить, что при планировании нового задания по составлению отчетов исторические отчеты обычно публикуются в течение нескольких дней. Ранее в документации указывалось, что предоставление таких отчетов может занять до 30 дней.
Раздел данных обратной засыпки в обзоре API был обновлен, чтобы более четко определить данные обратной засыпки как набор данных, который заменяет ранее предоставленный набор.
26 апреля 2018 г.
Версия 2 API YouTube Analytics (целевые запросы) (v2) теперь общедоступна. В следующем списке указаны изменения продукта и документации, связанные с новой версией API:
API версии 2 практически идентичен API версии 1. Однако вам, вероятно, потребуется обновить свой код, чтобы отразить изменения, перечисленные ниже. Все эти изменения подробно описаны в новом руководстве по миграции .
- Версия API изменилась с
v1
наv2
. - Базовый URL-адрес для запросов API изменился с
https://www.googleapis.com/youtube/analytics/v1
наhttps://youtubeanalytics.googleapis.com/v2
. - У некоторых параметров метода
reports.query
обновлены имена. В частности, имена параметров, содержащие дефисы, напримерend-date
в API версии 1, используют верблюжий регистр (endDate
), а не дефисы в API версии 2. Это изменение делает имена параметров единообразными во всем API, поскольку в методах API для создания групп и управления ими уже используется верблюжий регистр для имен параметров. - API версии 2 не поддерживает пакетные запросы, отправляемые на глобальную пакетную точку HTTP Google (
www.googleapis.com/batch
). Если вы отправляете пакетные запросы через API версии 2, вместо этого вам необходимо использовать конечную точкуhttps://youtubeanalytics.googleapis.com/v2
.
Кроме того, некоторые функции версии 1 не поддерживаются в API версии 2:
- Метод
reports.query
больше не поддерживает параметры запросаalt
,quotaUser
иuserIp
. - API версии 2 не предоставляет конечную точку пакета, которая поддерживает пакеты, состоящие из запросов к различным API. (Однако пакет может состоять из запросов к различным методам одного и того же API.) Это прекращение поддержки не относится только к API YouTube Analytics, поскольку Google прекращает поддержку глобальной конечной точки пакета во всех своих API.
- API версии 2 не поддерживает протокол JSON-RPC, который поддерживался в API версии 1. Опять же, это прекращение поддержки не относится только к API YouTube Analytics.
- Версия API изменилась с
Примечание. Это объявление об устаревании.
Версия 1 API (v1) устарела и будет поддерживаться до 31 октября 2018 г. После этой даты все запросы к API версии 1 перестанут работать. Поэтому обязательно обновите API до версии 2 не позднее 31 октября 2018 года, чтобы избежать перебоев в доступе к данным YouTube Analytics через API.
21 февраля 2018 г.
Это обновление содержит следующие изменения в API YouTube Analytics (целевые запросы):
- Демографические отчеты о зрителях, которые объединяют статистику просмотров на основе возрастной группы и пола зрителей, больше не поддерживают измерение
youtubeProduct
, которое идентифицирует сервис YouTube, в котором произошла активность пользователя.
18 января 2018 г.
Это обновление содержит следующие изменения:
API отчетов YouTube (массовые отчеты)
- Измерение
operating_system
, которое идентифицирует программную систему устройства, на котором были просмотры, теперь поддерживает следующее значение:-
25
: КайОС
-
- Измерение
API YouTube Analytics (целевые запросы)
- Измерение
operatingSystem
поддерживает значение измеренияKAIOS
.
- Измерение
20 декабря 2017 г.
Это обновление содержит два изменения, связанных с API отчетов YouTube:
Сервер API теперь поддерживает сжатие gzip для запросов на загрузку отчетов. Обратите внимание, что сжатие gzip не поддерживается для других типов запросов API. Включение сжатия gzip уменьшает пропускную способность, необходимую для каждого ответа API. И хотя вашему приложению потребуется дополнительное время ЦП для распаковки ответов API, выгода от потребления меньшего количества сетевых ресурсов обычно перевешивает эти затраты.
Чтобы получить ответ в кодировке gzip, установите для заголовка HTTP-запроса
Accept-Encoding
gzip
как показано в следующем примере:Accept-Encoding: gzip
Эта функциональность объясняется в обзоре API и в определении свойства
downloadUrl
ресурсаreport
.Документация по параметрам
age group
иgender
была исправлена, чтобы отображать фактические значения, которые API возвращает для этих параметров. Обратите внимание, что это исправление документации и не отражает изменение функциональности или поведения API. В частности, изменились следующие значения:- Значения измерения
age_group
используют прописные буквы, содержат символы подчеркивания между словомAGE
и цифрами возрастной группы, а также символы подчеркивания вместо дефисов. Таким образом, такие значения, какage13-17
иage18-24
были исправлены наAGE_13_17
иAGE_18_24
соответственно. - В значениях
gender
измерения используются прописные буквы. Таким образом, значенияfemale
,male
иgender_other
были исправлены наFEMALE
,MALE
иGENDER_OTHER
.
- Значения измерения
10 августа 2017 г.
10 августа 2016 г. в этой документации было объявлено о прекращении поддержки показателя earnings
API YouTube Analytics. (В то же время в API добавлена поддержка новой метрики с именем estimatedRevenue
, которая предоставляет те же данные.)
Поскольку показатель earnings
был основным показателем, он поддерживался в течение одного года с даты объявления. Однако теперь, когда этот годичный период закончился, показатель earnings
больше не поддерживается. В результате запросы API, в которых указан показатель earnings
, теперь возвращают код ответа HTTP 400
. Если вы еще не обновили свое приложение, чтобы использовать показатель estimatedRevenue
вместо показателя earnings
, сделайте это как можно скорее.
Документация API была обновлена, и в ней удалены оставшиеся ссылки на показатель earnings
.
6 июля 2017 г.
Это обновление содержит следующие изменения:
API YouTube Analytics (целевые запросы)
Документация API была обновлена, чтобы отразить тот факт, что ответы API содержат данные до последнего дня в запрошенном диапазоне дат, для которого доступны все запрашиваемые метрики.
Например, если в запросе указана дата окончания 5 июля 2017 г., а значения для всех запрошенных показателей доступны только до 3 июля 2017 г., это будет последняя дата, за которую данные будут включены в ответ. (Это верно, даже если данные по некоторым из запрошенных показателей доступны на 4 июля 2017 г.)
Измерение
adType
теперь поддерживает значениеreservedBumperInstream
, которое относится к видеообъявлению без возможности пропуска продолжительностью до 6 секунд, которое воспроизводится перед просмотром видео. Формат объявления идентичен объявлению наauctionBumperInstream
, но этот тип относится к объявлениям, продаваемым зарезервировано, а не на аукционной основе.
API отчетов YouTube (массовые отчеты)
Параметр
ad_type
теперь поддерживает значение20
, которое относится к объявлениям-заставкам, продаваемым зарезервировано. Объявления-заставки – это видеообъявления продолжительностью до 6 секунд без возможности пропуска, которые воспроизводятся перед просмотром видео. Обратите внимание, что значение19
для этого измерения также относится к бамперской рекламе, которая продается на аукционе, а не за зарезервированной основой.Отчеты о работах для следующих отчетов API отчетности YouTube были удалены:
-
channel_basic_a1
-
channel_province_a1
-
channel_playback_location_a1
-
channel_traffic_source_a1
-
channel_device_os_a1
-
channel_subtitles_a1
-
channel_combined_a1
-
content_owner_basic_a2
-
content_owner_province_a1
-
content_owner_playback_location_a1
-
content_owner_traffic_source_a1
-
content_owner_device_os_a1
-
content_owner_subtitles_a1
-
content_owner_combined_a1
-
content_owner_asset_basic_a1
-
content_owner_asset_province_a1
-
content_owner_asset_playback_location_a1
-
content_owner_asset_traffic_source_a1
-
content_owner_asset_device_os_a1
-
content_owner_asset_combined_a1
Эти типы отчетов были объявлены как устаревшие 15 сентября 2016 года , и отчеты больше не были получены для этих типов отчетов после 15 декабря 2016 года. Ранее созданные отчеты все еще были доступны в течение 180 дней с момента их создания. Таким образом, некоторые отчеты были доступны уже 15 июня 2017 года. Однако, поскольку отчеты больше не доступны, рабочие места, связанные с отчетами, также не нужны.
-
24 мая 2017 года
Все рабочие места для отчетов для следующих отчетов API отчетности YouTube были удалены:
-
content_owner_ad_performance_a1
-
content_owner_asset_estimated_earnings_a1
-
content_owner_estimated_earnings_a1
Эти типы отчетов были объявлены как устаревшие 22 июня 2016 года , и отчеты больше не были получены для этих типов отчетов после 22 сентября 2016 года. Ранее генерируемые отчеты все еще были доступны в течение 180 дней с момента их создания. Таким образом, некоторые отчеты были доступны до 22 марта 2017 года. Однако, поскольку отчеты больше не доступны, рабочие места, связанные с отчетами, тоже не нужны.
22 мая 2017 года
Это обновление содержит следующие изменения:
Youtube Reporting API (объемные отчеты)
- Размер
sharing_service
, который идентифицирует услугу, которая использовалась для обмена видео, теперь поддерживает следующие значения:-
85
: музыка на YouTube -
86
: игры на YouTube -
87
: дети на YouTube -
88
: телевизор YouTube
Кроме того, имя, используемое для идентификации значения
52
было обновлено в документации Kakao (Kakao Talk) , чтобы более четко отличить его от значения73
(история Kakao). Это изменение не отражает каких -либо изменений в поведении API или классификации видео, которые делятся с этими услугами. -
- Размер
YouTube Analytics API (целевые запросы)
- Размер
sharingService
теперь поддерживает следующие значения:-
YOUTUBE_GAMING
-
YOUTUBE_KIDS
-
YOUTUBE_MUSIC
-
YOUTUBE_TV
-
- Размер
28 марта 2017 года
Владельцы каналов, которые могут получить доступ к данным о доходах через аналитику YouTube в Creator Studio, теперь также могут получить доступ к данным о доходах через API YouTube Analytics:
API поддерживает следующие показатели, связанные с доходами:
-
adImpressions
-
cpm
-
estimatedAdRevenue
-
estimatedRedPartnerRevenue
-
estimatedRevenue
-
grossRevenue
-
monetizedPlaybacks
-
playbackBasedCpm
Эти метрики поддерживаются для следующих отчетов:
-
Владельцы каналов также могут также получить отчет о производительности рекламы , который поддерживает измерение
adType
а также дополнительноеday
измерение.Руководство по запросам API API YouTube Analytics теперь включает в себя раздел для отчетов о доходах канала .
17 марта 2017 года
Это обновление содержит следующие изменения:
API API YouTube Analytics поддерживает
redViews
иestimatedRedMinutesWatched
Metrics, оба из которых относятся к YouTube Red Viewershiew. Фактически, API фактически поддерживает эти метрики в течение некоторого времени, и API отчетности YouTube уже поддерживает обе метрики, как объявлено 15 сентября 2016 года .- Метрика
redViews
идентифицирует количество раз, когда видео -участники Red просмотрели видео. - Метрика
estimatedRedMinutesWatched
определяет количество минут, которые youtube Red смотрели видео.
Отчеты о каналах и документации владельца контента были обновлены, чтобы показать, какие отчеты поддерживают два новых показателя. Они поддерживаются в любых отчетах, которые уже поддержали
views
иestimatedMinutesWatched
счетов.- Метрика
3 марта 2017 года
Это обновление содержит следующие изменения:
Youtube Reporting API (объемные отчеты)
Определение измерения
date
было исправлено, чтобы отметить, что значение измерения относится к периоду, начинающемуся в 12:00 в Тихоокеанском времени и заканчивается в 23:59 Тихоокеанское время в указанный день, месяц и год. В зависимости от времени года, Pacific Time является UTC-7 или UTC-8.Хотя даты обычно представляют 24-часовой период, даты, когда часы регулируются вперед, представляют 23-часовой период, а даты, когда часы регулируются назад, представляют 25-часовой период. (Ранее в документации говорилось, что каждая дата представляла собой уникальный 24-часовой период, и это время Тихого океана всегда было UTC-8.)
Обратите внимание, что эта коррекция не представляет собой изменение фактического поведения API.
- Измерение
operating_system
, которое идентифицирует программную систему устройства, на котором произошли представления, теперь поддерживает следующие значения:-
22
: Тизен -
23
: Firefox -
24
: Realmedia
-
Все задания отчетности для типа отчета
content_owner_basic_a1
были удалены. Этот тип отчета был полностью устарел по состоянию на 19 августа 2016 года , но ранее сгенерированные отчетыcontent_owner_basic_a1
все еще были доступны в течение 180 дней с момента их создания. Таким образом, некоторые отчеты были доступны уже 19 февраля 2017 года. Однако, поскольку отчеты больше не доступны, рабочие места, связанные с отчетами, также не нужны.
YouTube Analytics API (целевые запросы)
Описание измерений, связанных с
time periods
было исправлено, чтобы отметить, что значение измерения относится к периоду, начинающемуся в 12:00 по тихоокеанскому времени и заканчивается в 23:59 Тихоокеанское время в указанный день, месяц и год. В зависимости от времени года, Pacific Time является UTC-7 или UTC-8.Хотя даты обычно представляют 24-часовой период, даты, когда часы регулируются вперед, представляют 23-часовой период, а даты, когда часы регулируются назад, представляют 25-часовой период. (Ранее в документации указывалось, что Тихоокеанское время было UTC-8 и не упоминала о возможности того, что день может не представлять 24-часовой период.)
Обратите внимание, что эта коррекция не представляет собой изменение фактического поведения API.
Документация канала сообщается о том, что в настоящее время отчеты каналов в настоящее время не содержат доходов или показателей производительности рекламы. В результате
https://www.googleapis.com/auth/yt-analytics-monetary.readonly
Scope в настоящее время не предоставляет доступ к денежным данным в отчетах каналов.- Размер
operatingSystem
поддерживает три новых значения измерения:-
FIREFOX
-
REALMEDIA
-
TIZEN
-
8 февраля 2017 года
API YouTube Analytics теперь поддерживает необязательный параметр include-historical-channel-data
. Обратите внимание, что этот параметр актуален только при получении отчетов владельца контента .
Параметр позволяет владельцу контента указать, что ответ API должен включать в себя время наблюдения за каналами и просмотр данных с периода времени до того, как каналы были связаны с владельцем контента. Значение параметра по умолчанию является false
, что означает, что по умолчанию ответ API включает в себя только время наблюдения и просмотр данных с момента, когда каналы были связаны с владельцем контента.
Эти правила также применяются, если запрос API получает данные для нескольких каналов:
- Если значение параметра является
false
, то время наблюдения и представления данных, возвращаемых для любого данного канала, основано на дате, когда этот канал был связан с владельцем контента.
Важно помнить, что разные каналы могли быть связаны с владельцем контента в разные даты. Если запрос API получает данные для нескольких каналов, а значение параметра являетсяfalse
, то ответ API содержит время наблюдения и просмотр данных на основе даты связывания для каждого соответствующего канала. - Если значение параметра
true
, то ответ возвращает время наблюдения и просмотр данных для всех каналов на основе дат начала и окончания, указанных в запросе API.
15 декабря 2016 года
Следующие отчеты API отчетности на YouTube больше не поддерживаются и были удалены из документации. Доступна более новая версия каждого отчета. ( Объявление об испаке этих отчетов было сделано 15 сентября 2016 года.)
Отчеты о каналах
-
channel_basic_a1
- заменен отчетомchannel_basic_a2
. -
channel_province_a1
- заменен отчетомchannel_province_a2
. -
channel_playback_location_a1
- заменен отчетомchannel_playback_location_a2
. -
channel_traffic_source_a1
- заменен отчетомchannel_traffic_source_a2
. -
channel_device_os_a1
- заменен отчетомchannel_device_os_a2
. -
channel_subtitles_a1
- заменен отчетомchannel_subtitles_a2
. -
channel_combined_a1
- заменен отчетомchannel_combined_a2
.
-
Владелец контента отчеты
-
content_owner_basic_a2
- заменен отчетомcontent_owner_basic_a3
. -
content_owner_province_a1
- заменен отчетомcontent_owner_province_a2
. -
content_owner_playback_location_a1
- заменен отчетомcontent_owner_playback_location_a2
. -
content_owner_traffic_source_a1
- заменен отчетомcontent_owner_traffic_source_a2
. -
content_owner_device_os_a1
- заменен отчетомcontent_owner_device_os_a2
. -
content_owner_subtitles_a1
- заменен отчетомcontent_owner_subtitles_a2
. -
content_owner_combined_a1
- заменен отчетомcontent_owner_combined_a2
. -
content_owner_asset_basic_a1
- заменен отчетомcontent_owner_asset_basic_a2
. -
content_owner_asset_province_a1
- заменен отчетомcontent_owner_asset_province_a2
. -
content_owner_asset_playback_location_a1
- заменен отчетомcontent_owner_asset_playback_location_a2
. -
content_owner_asset_traffic_source_a1
- заменен отчетомcontent_owner_asset_traffic_source_a2
. -
content_owner_asset_device_os_a1
- заменен отчетомcontent_owner_asset_device_os_a2
. -
content_owner_asset_combined_a1
- заменен отчетомcontent_owner_asset_combined_a2
.
-
Список текущих типов отчетов в справочной документации API также был обновлен.
11 ноября 2016 года
Это обновление содержит следующие изменения:
Отчеты о конечном экране
- Отчет о конечном экране для видео каналов содержит статистику для всех видео канала.
- Отчет о конечном экране для видео с владельцем контента содержит статистику для видео на любом из каналов владельца контента.
- Отчет о конечном экране для активов владельца контента содержит статистику для активов, связанных с видео, после чего отображаются конечные экраны.
Размеры конечного экрана
-
end_screen_element_type
: тип элемента конечного экрана, связанный со статистикой. -
end_screen_element_id
: Идентификатор, который YouTube использует для однозначного идентификации элемента конечного экрана.
-
Метрики конечного экрана
Примечание. Данные для метриков конечного экрана доступны по состоянию на 1 мая 2016 года.
-
end_screen_element_impressions
: общее количество отпечатков элемента конечного экрана. Одно впечатление регистрируется для каждого элемента конечного экрана, который отображается. -
end_screen_element_clicks
: количество раз, когда элементы экрана нажимали. -
end_screen_element_click_rate
: скорость клика для элементов экрана.
-
Следующие отчеты больше не поддерживаются и были удалены из документации. Доступна более новая версия каждого отчета. ( Объявление об испаке этих отчетов было сделано 22 июня 2016 года.)
-
content_owner_ad_performance_a1
- заменен отчетомcontent_owner_ad_rates_a1
. -
content_owner_estimated_earnings_a1
- заменен отчетомcontent_owner_estimated_revenue_a1
. -
content_owner_asset_estimated_earnings_a1
- заменен отчетомcontent_owner_asset_estimated_revenue_a1
.
-
Метрики в следующем списке полностью устарели и больше не поддерживаются. Как было объявлено 10 августа 2016 года, новые метрики, относящиеся к тем же данным, уже поддерживаются. В таблице ниже показано устаревшее метрическое имя и новое метрическое имя:
Устаревшая метрика Новая метрика adEarnings
estimatedAdRevenue
impressionBasedCpm
cpm
impressions
adImpressions
redPartnerRevenue
estimatedRedPartnerRevenue
- Ежемесячный мировой доход от рекламы на видео
- Ежедневно, доход от рекламы в страну за видео
- Ежемесячный мировой доход от рекламы на активу
- Ежедневно, доход от рекламы на расстояние от актива
- Претензии (в этом отчете не содержатся данные о доходах)
API поддерживает два новых показателя, связанных с YouTube Red Viewershiewership:
-
red_views
: количество раз, когда видео было просмотрено youtube Red Members. -
red_watch_time_minutes
: количество минут, которые YouTube Red смотрели видео.
-
API поддерживает новые версии из 20 отчетов. Все новые версии поддерживают новые метрики
red_views
иred_watch_time_minutes
.Для каждого отчета число в новом идентификаторе типа отчета на один номер выше, чем в старом идентификаторе типа отчета. (Старые версии этих отчетов в настоящее время устанавливаются, как описано позже в этой истории пересмотра.) Например, отчет
channel_basic_ a1
теперь устарел и был заменен отчетомchannel_basic_ a2
.Следующие списки определяют новые идентификаторы типа отчета:
Отчеты о канале
Видео -репортаж с владельцем контента
Отчеты владельца контента Asset
Примечание: это объявление об ископке.
Обратите внимание, что если у вас уже есть задания, чтобы создать любую из более старых версий отчетов, перечисленных выше, вам необходимо создать новые рабочие места для переименованных отчетов. В сочетании с выпуском новых версий отчета были устарели следующие версии отчета:
-
channel_basic_a1
-
channel_province_a1
-
channel_playback_location_a1
-
channel_traffic_source_a1
-
channel_device_os_a1
-
channel_subtitles_a1
-
channel_combined_a1
-
content_owner_basic_a2
-
content_owner_province_a1
-
content_owner_playback_location_a1
-
content_owner_traffic_source_a1
-
content_owner_device_os_a1
-
content_owner_subtitles_a1
-
content_owner_combined_a1
-
content_owner_asset_basic_a1
-
content_owner_asset_province_a1
-
content_owner_asset_playback_location_a1
-
content_owner_asset_traffic_source_a1
-
content_owner_asset_device_os_a1
-
content_owner_asset_combined_a1
Если у вас есть рабочие места для любого из этих отчетов, вы не должны ожидать, что YouTube будет генерировать новые отчеты для этих рабочих мест после 15 декабря 2016 года. Сформированные отчеты все еще будут доступны в течение 180 дней с момента их сведения.
-
Отчет
content_owner_basic_a1
был полностью устарел и удален из документации. YouTube больше не будет генерировать новые отчеты такого типа, хотя уже сгенерированные отчеты все равно будут доступны в течение 180 дней с момента их сведения.Замена отчета
content_owner_basic_a1
- это отчетcontent_owner_basic_a2
, как это было объяснено в записи истории пересмотра за 19 мая 2016 года .Недавно опубликованные Услуги службы услуг API YouTube («Обновленные термины»), подробно обсуждаемые в блоге YouTube Engineering and Developers , предоставляет богатый набор обновлений в текущих условиях обслуживания. В дополнение к обновленным условиям , которые вступит в силу по состоянию на 10 февраля 2017 года, это обновление включает в себя несколько подтверждающих документов, которые помогут объяснить политику, за которыми должны следовать разработчики.
Полный набор новых документов описан в истории пересмотра для обновленных терминов . Кроме того, будущие изменения в обновленных терминах или в тех подтверждающих документах также будут объяснены в этой истории пересмотра. Вы можете подписаться на изменения списка каналов RSS в этой истории пересмотра по ссылке в этом документе.
YouTube Analytics API (целевые запросы)
Примечание: это объявление об ископке.
Метрики в следующей таблице устанавливаются. В то же время вводятся новые метрики, относящиеся к тем же данным. По сути, это означает, что старые метрики переименованы в переименование, хотя API YouTube Analytics будет поддерживать оба метрических имена до тех пор, пока даты снижения, указанные в таблице.
Старое метрическое название Новое метрическое название Дата поддержки earnings
estimatedRevenue
10 августа 2017 года adEarnings
estimatedAdRevenue
4 ноября 2016 года redPartnerRevenue
estimatedRedPartnerRevenue
4 ноября 2016 года impressionBasedCpm
cpm
4 ноября 2016 года impressions
adImpressions
4 ноября 2016 года Обратите внимание, что показатель
earnings
был основным показателем , поэтому он будет поддерживаться в течение одного года с даты этого объявления. Другие показатели, которые не были основными показателями, будут поддерживаться в течение трех месяцев до 4 ноября 2016 года.Например, до 4 ноября 2016 года запрос API может указать метрику
impressionBasedCpm
, метрикуcpm
или оба. Однако после этой даты будет поддержан только показательcpm
.-
insightTrafficSourceType
Dimension поддерживает два новых значения измерения:-
CAMPAIGN_CARD
: Этот источник трафика поддерживается только для отчетов владельца контента . Это указывает на то, что представления возникают из заявленных пользовательских видеороликов, которые владелец контента использовал для продвижения просмотренного контента. -
END_SCREEN
: Данные относятся к представлениям, которые происходили из конечного экрана другого видео.
Для обоих новых источников трафика вы также можете получить отчет
traffic source detail
. В обоих случаях измерениеinsightTrafficSourceDetail
идентифицирует видео, из которого был направлен зритель. -
adType
теперь поддерживает ValueauctionBumperInstream
, который относится к не подлежащему видеообъявлению до 6 секунд, которая играет до того, как можно просмотреть видео.
Youtube Reporting API (объемные отчеты)
- Размер
traffic_source_type
теперь поддерживает следующие значения:-
19
: Этот источник трафика поддерживается только для отчетов владельца контента . Это указывает на то, что представления возникают из заявленных пользовательских видеороликов, которые владелец контента использовал для продвижения просмотренного контента. -
20
: Данные относятся к представлениям, которые возникли из конечного экрана другого видео.
Для обоих новых источников трафика измерение
traffic_source_detail
идентифицирует видео, из которого был направлен зритель. -
Список основных метрик API был исправлен, чтобы перечислить
estimated_partner_revenue
как основной метрику и удалитьearnings
из этого списка. (Метрикаearnings
никогда не поддерживалась в API отчетности YouTube.)Размер
ad_type
теперь поддерживает значение19
, которое ссылается на бамперскую рекламу, которая представляет собой не поддающуюся видеообъявления до 6 секунд, которые воспроизводятся до того, как можно будет просмотреть видео.
- Размер
YouTube Analytics API (целевые запросы)
- Списки поддерживаемых метрик для следующих отчетов о каналах были обновлены, чтобы включить показатели карт. Поддержка показателей карт в этих отчетах была фактически добавлена 28 июня 2016 года, и запись истории пересмотра за эту дату более подробно объясняет изменение. Отчеты:
- Основная активность пользователя для штатов США
- Активность пользователя в штатах США в течение определенных периодов времени
- Активность пользователя по провинции
- Активность пользователя подписанным статусом
- Активность пользователя подписанным статусом для провинций
- Лучшие видео по штату
- Лучшие видео для подписанных или отписанных зрителей
Списки фильтров были исправлены как для отчетов о хранении аудитории канала , так и для отчетов по удержанию аудитории контента, чтобы отразить, что необходим
video
, иgroup
фильтр не поддерживается.Ранее документация для обоих отчетов неправильно указывалась, что отчет может быть извлечен с использованием одного из этих двух фильтров или не использует ни фильтра.
- Списки поддерживаемых метрик для следующих отчетов о каналах были обновлены, чтобы включить показатели карт. Поддержка показателей карт в этих отчетах была фактически добавлена 28 июня 2016 года, и запись истории пересмотра за эту дату более подробно объясняет изменение. Отчеты:
Youtube Reporting API (объемные отчеты)
- В обзоре API в разделе, в котором объясняется, как получить URL -адрес загрузки отчета, был исправлен, чтобы заявить, что YouTube генерирует загружаемые отчеты в течение нескольких дней, на которые не было доступно данные. Эти отчеты содержат строку заголовка, но не содержат дополнительных данных. Эта информация уже была обновлена в разделе характеристик отчета того же документа 12 апреля 2016 года .
- Список измерений в отчете
content_owner_asset_cards_a1
был исправлен, чтобы отразить, что в отчете используется измерениеcard_id
. Ранее документация неправильно перечислила имя измерения какcard_title
.
- Основная статистика ( каналы , владельцы контента )
- На основе времени ( каналы , владельцы контента )
- География пользователя ( каналы , владельцы контента )
- Активность пользователя подписанным статусом ( каналы , владельцы контента )
- Лучшие видео ( каналы , владельцы контента )
Раздел характеристик отчета обзора API был обновлен, чтобы уточнить, что отчеты доступны через API в течение 180 дней с момента, когда они генерируются.
Ранее в документации говорилось, что отчеты доступны в течение периода до 180 дней до даты отправки запроса API. Хотя это и технически верно, оригинальный текст, в лучшем случае, довольно запутанным.
API поддерживает новые версии трех отчетов. Два из этих отчетов также содержат новые и переименованные метрики:
Отчет
content_owner_ad_rates_a1
- это новая версия отчетаcontent_owner_ad_performance_a1
. Недавно переименованный отчет идентичен предыдущей версии.Два отчета, в которых есть новые версии, были переименованы в переименование:
- Новая версия отчета
content_owner_estimated_earnings_a1
называетсяcontent_owner_estimated_revenue_a1
. - Новая версия отчета
content_owner_asset_estimated_earnings_a1
называетсяcontent_owner_asset_estimated_revenue_a1
.
Оба недавно переименованных отчета отличаются от своих предшественников следующими способами:
- Они добавляют новую метрику
estimated_partner_red_revenue
, которая оценивает общую прибыль от подписки на YouTube Red. - Они добавляют новую метрику
estimated_partner_transaction_revenue
, которая оценивает доход от транзакций, таких как платный контент и финансирование поклонников, за исключением любых возмещений, заряженных партнером. - Они переименованы в метрику
estimated_partner_ad_sense_revenue
до outestimated_partner_ad_auction_revenue
. - Они переименованы в метрику
estimated_partner_double_click_revenue
доestimated_partner_ad_reserved_revenue
.
- Новая версия отчета
Обратите внимание, что если у вас уже есть работа, чтобы создать любую из более старых версий этих отчетов, вам необходимо создать новые рабочие места для переименованных отчетов. В сочетании с выпуском новых версий отчета,
content_owner_ad_performance_a1
,content_owner_estimated_earnings_a1
иcontent_owner_asset_estimated_earnings_a1
установили отчеты.Если у вас есть рабочие места для любого из этих отчетов, вы не должны ожидать, что YouTube будет создавать новые отчеты для этих рабочих мест после 22 сентября 2016 года. Сформированные отчеты все еще будут доступны в течение 180 дней с момента их сведения.
Определение свойства
id
ресурсаreportType
было обновлено, чтобы отразить текущий набор доступных отчетов.Имена двух метрик были исправлены в документации, чтобы соответствовать именам, которые появляются в отчетах. Это исключительно исправление документации и не отражает изменение фактического содержимого отчета:
-
estimated_partner_ad_sense_revenue
метрикиestimated_partner_adsense_revenue
Обратите внимание, однако, что этот показатель появляется только в двух отчетах, которые устарели с этим обновлением. Как описано выше, этот показатель был переименован вestimated_partner_ad_auction_revenue
в новых версиях этих отчетов. - Имя метрики
estimated_partner_doubleclick_revenue
было обновлено до outestimated_partner_double_click_revenue
. Опять же, обратите внимание, что этот показатель появляется только в двух отчетах, которые устарели с этим обновлением. Как описано выше, этот показатель был переименован вestimated_partner_ad_reserved_revenue
в новых версиях этих отчетов.
-
Документация Dimensions для API отчетности была обновлена, чтобы больше не перечислить свойства
elapsed_video_time_percentage
иaudience_retention_type
. Эти размеры в настоящее время не поддерживаются какими -либо отчетами, доступными через API.API поддерживает новую версию отчета об активности пользователя для владельцев контента . Идентификатор типа отчета для нового отчета -
content_owner_basic_a2
. В отличие от предыдущей версии отчета,content_owner_basic_a1
, новая версия поддерживаетlikes
иdislikes
метрики.Если у вас уже есть задание по созданию отчета
content_owner_basic_a1
, вам все равно нужно создать новое задание для отчетаcontent_owner_basic_a2
. YouTube не автоматически переносит владельцев контента в новую версию отчета или автоматически создает задание для создания новой версии отчета. В некоторых реализациях появление новой, неожиданной работы может стать нарушением.В сочетании с выпуском нового отчета был устарел отчет
content_owner_basic_a1
. Если у вас есть работа для этого отчета, вы не должны ожидать, что YouTube будет генерировать новые отчеты для этой работы после 19 августа 2016 года. Сформированные отчеты все еще будут доступны в течение 180 дней с момента их создания.reportType
,job
иreport
ресурсов все поддерживают новое свойство, которое определяет, представляет ли связанный ресурс устаревший тип отчета:Собственность
reportType
ResourcedeprecateTime
определяет дату и время, когда тип отчета будет устарел. Это свойство имеет значение только для отчетов, которые были объявлены как устаревшие, а значение представляет дату, когда YouTube перестанет генерировать отчеты такого типа.После того, как тип отчета объявлен как устаревший, YouTube генерирует отчеты такого типа еще на три месяца. Например, это обновление 19 мая 2016 года объявляет о том, как отчет
content_owner_basic_a1
. Таким образом,deprecateTime
для этого типа отчета указывается время 19 августа 2016 года, после чего YouTube перестанет генерировать отчеты такого типа.Собственность
expireTime
job
ресурса определяет дату и время, когда работа истекает или истечет. Это свойство имеет ценность, если тип отчета, связанный с заданием, устарел или если отчеты, полученные для работы, не были загружены в течение длительного периода времени. Дата отмечает время, после чего YouTube больше не генерирует новые отчеты для работы.Собственность
jobExpireTime
отreport
о том, как и срок действия работы, связанная с отчетом, истек срок действия истечения срока действия. Это свойство содержит то же значение, что и свойствоexpireTime
вjob
ресурсе, как описано в предыдущем элементе в этом списке.
Метод
jobs.create
теперь возвращает400
HTTP -код ответа (Bad Request
), если вы попытаетесь создать задание для устаревшего отчета. Кроме того, в документации метода в настоящее время перечислены несколько других причин, которые приводят к сбою запроса API.YouTube теперь генерирует данные, охватывающие 180-дневный период до того времени, когда работа отчетности была первой запланированной. Ранее, отчетный API не предоставил никаких исторических данных. Это изменение влияет на все рабочие места, в том числе те, которые созданы до этого объявления.
Исторические отчеты публикуются, как только они будут доступны, хотя требуется примерно один месяц, чтобы все исторические данные были размещены на работу. Итак, через месяц после планирования работы отчетности у вас будет доступ к примерно семи месяцам данных. (Все исторические данные для рабочих мест, созданные до этого объявления, должны быть опубликованы в течение месяца после объявления.)
Обратите внимание, что исторические данные доступны только с 1 июля 2015 года. В результате работы, созданные до 28 декабря 2015 года, будут иметь менее 180 дней исторических данных.
Все эти изменения объясняются в новом разделе « Исторические данные обзора API».
Раздел характеристик отчета в API отчетности YouTube был обновлен с помощью следующих изменений:
В документации теперь говорится, что отчеты доступны в течение 180 дней после того, как они генерируются и, следовательно, доступны для клиентов API для загрузки. Ранее в документации говорилось, что отчеты были доступны в течение периода до шести месяцев до даты отправки запроса API.
Документация была обновлена, чтобы отразить тот факт, что API теперь генерирует загружаемые отчеты в течение нескольких дней, в которые не было доступно никаких данных. Эти отчеты будут содержать строки заголовков, но не будут содержать дополнительные данные.
API отчетности YouTube вскоре поддержит набор автоматически сгенерированных, управляемых системными отчетами, которые содержат данные о доходах от AD или данные о доходах от подписки на YouTube. Отчеты будут доступны для владельцев контента, которые уже могут получить доступ к отчетам о загружаемых доходах вручную в студии YouTube Creator . Таким образом, новая функция API обеспечит программный доступ к этим данным.
Следующие изменения API теперь объявляются в подготовке к запуску отчетов, управляемых системой:
Новое свойство
systemManaged
job
ресурса указывает, описывает ли ресурс работу, которая генерирует отчеты, управляемые системой. YouTube автоматически генерирует отчеты, управляемые системой для владельцев контента YouTube, а владельцы контента не могут модифицировать или удалять задания, которые создают эти отчеты.Новый метод
jobs.list
включает параметрincludeSystemManaged
указывает, должен ли ответ API включать задания для отчетов, управляемых системой. Значение по умолчанию параметраfalse
.Новый параметр метода
jobs.reports.list
Method указывает на тоstartTimeAtOrAfter
что ответ API должен содержать отчеты только в том случае, если самые ранние данные в отчете находятся в указанной дате или после. Аналогичным образом, параметрstartTimeBefore
указывает, что ответ API должен содержать отчеты только в том случае, если самые ранние данные в отчете находятся до указанной даты.В отличие от параметра
createdAfter
метода, который относится к тому времени, которое был создан отчет, новые параметры относятся к данным в отчете.Новое свойство
systemManaged
отreportType
указывает, описывает ли ресурс отчет, управляемый системой.Новый Method New Method New Method
includeSystemManaged
reportTypes.list
, должен ли ответ API включать отчеты, управляемые системой. Значение по умолчанию параметраfalse
.
- В API отчетности YouTube измерение
sharing_service
поддерживает эти новые значения:-
82
: Диалог активности системы iOS -
83
: Google Входящие ящики -
84
: Android Messenger
-
- В API YouTube Analytics
sharingService
Dimension поддерживает эти новые значения:-
ANDROID_MESSENGER
: Android Messenger -
INBOX
: Google Bobox -
IOS_SYSTEM_ACTIVITY_DIALOG
: Диалог активности системы iOS
-
- Измерение
playback_location_type
поддерживает два новых значения измерения:-
7
: Данные относятся к представлениям, которые имели место на домашней странице YouTube или на главном экране, в подаче подписки пользователя или в другой функции просмотра YouTube. -
8
: Данные относятся к представлениям, которые имели место непосредственно на странице результатов поиска на YouTube.
-
- Размер
traffic_source_type
теперь поддерживает18
как значение измерения. This value indicates that the video views originated from a page that lists all of the videos in a playlist. This source differs from source type14
, which indicates that the views occurred while the video was being played as part of a playlist. - The
insightPlaybackLocationType
dimension supports two new dimension values:-
BROWSE
: The data pertains to views that took place on the YouTube home page or home screen, in the user's subscription feed, or in another YouTube browsing feature. -
SEARCH
: The data pertains to views that took place directly on the YouTube search results page.
-
- The
insightTrafficSourceType
dimension now supportsYT_PLAYLIST_PAGE
as a dimension value. This value indicates that the video views originated from a page that lists all of the videos in a playlist. This source differs from thePLAYLIST
source type, which indicates that the views occurred while the video was being played as part of a playlist. - In the YouTube Reporting API, the
operating_system
dimension uses the value21
to identify views that take place via Chromecast. - In the YouTube Analytics API, the
operatingSystem
dimension uses the valueCHROMECAST
to identify views that take place via Chromecast. The YouTube Analytics API now supports three new playback detail dimensions , which can be used in a variety of channel and content owner reports:
-
liveOrOnDemand
: This dimension indicates whether the data in the report describes user activity that occurred during a live broadcast. -
subscribedStatus
: This dimension indicates whether the user activity metrics in the data are associated with viewers who were subscribed to the video's or playlist's channel. -
youtubeProduct
: This dimension identifies the YouTube property on which the user activity occurred. Possible values include the core YouTube website (or YouTube app), YouTube Gaming, and YouTube Kids.
The documentation has been updated to identify new playback detail reports that are available for channels and content owners . In addition, many other reports have been updated to note that one or more of these dimensions can optionally be used as dimensions and/or filters in those reports.
-
The format of the tables that explain the reports has changed to make it easier for you to identify valid combinations of dimensions, metrics, and filters that can be used to retrieve each report. The table below, which explains the "Device Type" report for channels, shows the new format:
Содержание Размеры: Необходимый deviceType Use 0 or more day , liveOrOnDemand , subscribedStatus , youtubeProduct Metrics: Use 1 or more views , estimatedMinutesWatched Фильтры: Use 0 or 1 country , province , continent , subContinent Use 0 or 1 video , group Use 0 or more operatingSystem , liveOrOnDemand , subscribedStatus , youtubeProduct The terminology describing required and optional fields is explained in the documentation for channel and content owner reports.
The YouTube Analytics API now automatically drops entities that the API user cannot retrieve data for from filters that support multiple values (
video
,playlist
, andchannel
). Previously, the API server would have just returned an error if the API user could not access data for at least one of the specified items.For example, suppose a user submits an API request in which the
video
filter lists 20 video IDs. The user owns 18 of the videos. However, one videos ID identifies a video owned by another channel, and another ID identifies a video that was deleted and, therefore, no longer exists. In this case, instead of returning an error, the API server now drops the two videos that the user cannot access, and the API response contains data for the 18 videos that the API user owns.If you request data for an empty YouTube Analytics
group
, the API now returns an empty data set rather than an error.The YouTube Analytics API's
groupItems.insert
method now returns an unauthorized (403
HTTP response code) error if you try to add an entity to a group but you do not have access to that entity. Previously, the API would have allowed you to add the entity to the group, but later returned an unauthorized error when you tried to retrieve report data for that group.The YouTube Analytics API's
groups.list
method now supports pagination. If the API response does not contain all available groups, then the response'snextPageToken
parameter specifies a token that can be used to retrieve the next page of results. Set the method'spageToken
parameter to that value to retrieve additional results.The YouTube Analytics API now supports the
redPartnerRevenue
metric, which reports the total estimated revenue earned from YouTube Red subscriptions for the selected report dimensions. The metric's value reflects earnings from both music and non-music content and is subject to month-end adjustment.The YouTube Analytics API's list of content owner reports has been updated to identify the video reports that support the
redPartnerRevenue
metric:- Basic stats
- Time-based
- User geography
- Top videos – For this report,
redPartnerRevenue
is also supported as a sorting metric, which means you can retrieve a list of videos sorted by their YouTube Red earnings.
The top videos report definition for the YouTube Analytics API now reflects that this report also supports the following earnings metrics:
earnings
,adEarnings
,grossRevenue
,monetizedPlaybacks
,playbackBasedCpm
,impressions
, andimpressionBasedCpm
.The documentation for the YouTube Reporting API's
date
dimension has been corrected to reflect that dates reference the 24-hour period beginning at 12:00 am Pacific time (UTC-8). Previously, the documentation stated that the date began at 12:00 am (GMT).In addition, the YouTube Analytics API documentation has been updated to note that all date-related dimensions (
day
,7DayTotals
,30DayTotals
, andmonth
) refer to dates beginning at 12:00 am Pacific time (UTC-8).The YouTube Reporting API's
jobs.reports.list()
method now supports thecreatedAfter
query parameter. If specified, this parameter indicates that the API response should only list reports created after the specified date and time, including new reports with backfilled data. Note that the parameter value pertains to the time that the report is created and not the dates associated with the returned data.The parameter value is a timestamp in RFC3339 UTC "Zulu" format, accurate to microseconds. Example:
"2015-10-02T15:01:23.045678Z"
.The YouTube Reporting API best practices have also been updated to explain how you can use the
createdAfter
parameter to avoid repeatedly processing the same report.The definitions of the
job
resource'screateTime
property and thereport
resource'sstartTime
,endTime
, andcreateTime
properties have all been corrected to note that the property values are accurate to microseconds, not nanoseconds. In addition, all of the definitions now accurately reflect that the property value is a timestamp.The documentation for the YouTube Analytics API's
sharingService
dimension has been updated to include a list of possible dimension values. The list includes a number of newly supported services.The YouTube Reporting API's
sharing_service
dimension's definition has also been updated to list the newly supported values. The enum values that are greater than59
are the new ones in the list.The new YouTube Reporting API retrieves bulk data reports that contain YouTube Analytics data for a channel or content owner. It is designed for applications that can import large data sets and that provide tools to filter, sort, and mine that data.
Each YouTube Reporting API report contains a predefined set of dimensions and metrics. (YouTube Analytics API reports also use metrics and dimensions.) In a report, each row of data has a unique combination of dimension values. You can aggregate data across rows based on dimension values to calculate metrics for individual videos, countries, live videos, subcribed users, and so forth.
You can use the API to schedule reporting jobs, each of which identifies a report that YouTube should generate. Once you have set up a job, YouTube generates a daily report that can be asynchronously downloaded. Each report contains data for a unique, 24-hour period.
Although they are different APIs, the YouTube Analytics API and the YouTube Reporting API both enable developers to retrieve YouTube Analytics data. Since the APIs both provide access to similar data sets, the documentation for the two APIs is being published as a single set of documentation.
- The Guides tab in the documentation set contains information common to both APIs, including instructions for authorizing API requests.
- The Bulk reports tab contains reference documentation and other content specifically for the YouTube Reporting API.
- The Targeted queries tab contains reference documentation and other content specifically for the YouTube Analytics API.
- The Samples tab lists code samples available for either of the two APIs.
- The Tools tab lists additional resources available to help developers implement either of the two APIs.
The API documentation has been restructured in an effor to make the API easier to understand. As such, these changes do not describe new features:
The documentation now contains one page that lists all available channel reports and another that lists all available content owner reports . Previously, the documentation had separate pages for channel video reports, channel playlist reports, and so forth.
The new data model overview seeks to provide a clearer introduction to how the API works. Specifically, this document tries to better explain how YouTube uses metrics, dimensions, and filters to calculate report values.
The API's
reports.query
method, which you use to retrieve reports, is now documented separately. The information on that page had previously been on some other pages. The new page is designed to help you more easily identify the information you need to send to retrieve a report.
The new
adEarnings
metric includes total estimated earnings (net revenue) from all Google-sold advertising sources. It is not a core metric. The API supports theadEarnings
metric for any report that already supported theearnings
metric.In addition, the definition of the
earnings
metric has been corrected to reflect the fact that its value includes total estimated earnings from all Google-sold advertising sources as well as from non-advertising sources. Previously, the definition incorrectly indicated that the metric only included earnings from advertising sources.The
primaryAdGrossRevenue
metric has been deprecated. Instead, use thegrossRevenue
metric to retrieve revenue data.In addition to the deprecated
primaryAdGrossRevenue
metric, ad performance reports no longer support themonetizedPlaybacks
andplaybackBasedCpm
metrics. However, several video reports do still support those metrics.The API now supports two new metrics for video reports,
videosAddedToPlaylists
andvideosRemovedFromPlaylists
. The lists of video reports for channels and content owners have both been updated to identify the reports that support the new metrics.-
videosAddedToPlaylists
– The number of times that videos in the scope of the query were added to any YouTube playlists. The videos could have been added to the video owner's playlist or to other channels' playlists. -
videosRemovedFromPlaylists
– The number of times that videos in the scope of the query were removed from any YouTube playlists. The videos could have been removed from the video owner's playlist or from other channels' playlists.
Both metrics include default playlists like the "Watch Later" playlist. However, they do not count playlists that a video is automatically added to, such as a channel's uploads playlist or a user's watch history. Also note that these metrics reflect the absolute number of additions and deletions. So, if a user adds a video to a playlist, then removes it, and then adds it again, the metrics indicate that the video was added to two playlists and removed from one.
Data for these metrics is available as of October 1, 2014.
-
The
favoritesAdded
andfavoritesRemoved
metrics are both deprecated effective as of this announcement. These are both core metrics and subject to the Deprecation Policy set forth in the terms of service .The new
currency
parameter allows you to retrieve earnings metrics in a currency other than United States dollars (USD
). If the parameter is set, then the API converts values for theearnings
,grossRevenue
,playbackBasedCpm
, andimpressionBasedCpm
metrics to the specified currency. The values returned are estimates calculated using exchange rates that change on a daily basis.The parameter value is a three-letter, ISO 4217 currency code. The default value is
USD
. The parameter definition contains a list of supported currency codes.The API now supports the ability to create and manage YouTube Analytics groups as well as the ability to retrieve report data for those groups.
Creating and managing groups
This update introduces the
group
andgroupItem
resources for creating and managing groups.- The
group
resource represents an Analytics group, a custom collection of up to 200 channels, videos, playlists, or assets. The API supportslist
,insert
,update
, anddelete
methods for this resource. - The
groupItem
resource represents an item in an Analytics group. The API supportslist
,insert
, anddelete
methods for this resource.
So, for example, you could create a group using the
groups.insert
method and then add items to that group using thegroupItems.insert
method.- The
Retrieving report data for a group
The dimensions documentation has been updated to include the
group
dimension, which can be used as a filter for many channel reports and content owner reports . When you use thegroup
filter, the API returns data for all of the items in that group. Note that the API does not currently support the ability to create reports for asset groups.
See the YouTube Help Center for more information about YouTube Analytics groups.
The API no longer supports the
show
dimension.The API now supports the ability to specify multiple values for the
video
,playlist
,channel
, andshow
dimensions when those dimensions are used as filters . To specify multiple values, set thefilters
parameter value to a comma-separated list of the video, playlist, channel, or show IDs for which the API response should be filtered. The parameter value can specify up to 200 IDs.If you specify multiple values for the same filter, you can also add that filter to the list of dimensions that you specify for the request. This is true even if the filter is not listed as a supported dimension for a particular report. If you do add the filter to the list of dimensions, then the API also uses the filter values to group results.
See the
filters
parameter definition for complete details about this functionality.When retrieving a channel report, you can now retrieve data for the authenticated user's channel by setting the value of the
ids
parameter tochannel==MINE
. (You can also still set theids
parameter tochannel== CHANNEL_ID
to retrieve data for the specified channel.)The API now supports playlist reports, which contain statistics related to video views that occur in the context of a playlist. Playlist reports are available for channels and content owners .
All playlist reports support the
views
andestimatedMinutesWatched
metrics, and some also support theaverageViewDuration
metric.In addition, all playlist reports support the following new metrics. Note that each of these metrics only reflect playlist views that occurred on the web.
-
playlistStarts
: The number of times viewers initiated playback of a playlist. -
viewsPerPlaylistStart
: The average number of video views that occurred each time a playlist was initiated. -
averageTimeInPlaylist
: The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated.
Any request to retrieve a playlist report must use the
isCurated
filter, which must be set to1
(isCurated==1
).-
The API now supports an audience retention report. This report measures a video's ability to retain its audience. The report's new
elapsedVideoTimeRatio
dimension measures the amount of the video that has elapsed for the corresponding metric values:The
audienceWatchRatio
metric identifies the absolute ratio of viewers watching the video at the given point in the video. The ratio is calculated by comparing the number of times a portion of a video has been watched to the total number of views of the video.Note that a portion of a video could be watched more than once (or not at all) in a given video view. For example, if users rewind and watch the same portion of a video multiple times, then the absolute ratio for that portion of the video the could be greater than
1
.The
relativeRetentionPerformance
metric shows how well a video retains viewers during playbacks in comparison to all YouTube videos of similar length. A value of 0 indicates that the video retains viewers worse than any other video of similar length, while a value of 1 indicates that the video retains viewers better than any other video of similar length. A median value of 0.5 indicates that half of the videos of similar length retain viewers better while half retain viewers worse.
You can also use the
audienceType
filter so that the report only returns data associated with organic views, views from TrueView in-stream ads, or views from TrueView in-display ads. (Organic views are the direct result of user action, such as a search for a video or a click on a suggested video.)The API supports several new metrics related to annotations. The metrics listed below can be retrieved with any reports that previously supported the
annotationClickThroughRate
andannotationCloseRate
metrics.-
annotationImpressions
: The total number of annotation impressions. -
annotationClickableImpressions
: The number of annotations that appeared and could be clicked. -
annotationClosableImpressions
: The number of annotations that appeared and could be closed. -
annotationClicks
: The total number of clicked annotations. -
annotationCloses
: The total number of closed annotations.
All of the new metrics are core metrics and are subject to the Deprecation Policy . However, note that data is available for the new metrics as of July 16, 2013. (Data for the
annotationClickThroughRate
andannotationCloseRate
metrics is available as of June 10, 2012.)-
GOOGLE_SEARCH
is no longer reported as a separate value for theinsightTrafficSourceType
dimension. Instead, referrals from Google search results are now attributed to theEXT_URL
traffic source type. As a result, it's also no longer possible to retrieve aninsightTrafficSourceDetail
report that sets theinsightTrafficSourceType
filter toGOOGLE_SEARCH
.The content owner reports document has been updated to reflect that the
subscribersGained
andsubscribersLost
metrics can now be retrieved for content claimed or uploaded by a content owner.The change is visible in the first basic stats report for content owners, which now supports the
claimedStatus
anduploaderType
filters.The sample requests document has been redesigned to group examples in categories, using a tab format similar to the one recently released for channel and content owner reports. With the new design, examples are grouped into the following categories:
- Basic stats
- Time-based
- Geographic
- Playback location
- Traffic source
- Device/OS
- Demographic
- Социальные
- Earnings/Ads (for content owner reports only)
The sample requests document now includes new examples for retrieving province-specific data in either channel reports or content owner reports.
Province-specific metrics for US states and Washington DC : This report retrieves a province-by-province breakdown of view counts and other statistics for a channel's videos. The data covers US states and Washington DC The example uses the
province
dimension, and also uses thefilters
parameter to restrict the response to only include results for the United States.Viewer demographics in California (age group and gender) : This report retrieves statistics about the age group and gender of viewers in California who watched a channel's videos or, for content owner reports, a content owner's claimed content. This example uses the
filters
parameter to ensure the response only includes data for a particular province.
The definition of the
province
dimension has been updated to note that whenprovince
is included in thedimensions
parameter value, the request must also restrict data to the United States by includingcountry==US
in thefilters
parameter value.The documents that list the supported channel and content owner reports have been redesigned. Instead of providing a table that lists all possible reports, each document instead groups the reports into categories:
- Basic stats
- Time-based
- Geographic
- Playback location
- Traffic source
- Device/OS
- Demographic
- Социальные
- Топ видео
Each document displays these categories as a list of tabs, and you can click any tab to see the supported reports in that category.
The API now supports three new geographic dimensions:
province
,continent
, andsubContinent
.The
province
dimension lets you retrieve statistics for US states and for the District of Colombia. The API supports two uses for this dimension:The API supports two reports that break statistics down on a state-by-state basis. Both reports are available for channels and content owners .
- The core stats report provides several statistics, including view counts and estimated minutes watched.
- The time-based report provides the same statistics, but aggregates data on a daily, 7-day, 30-day, or monthly basis.
You can use the
filters
query parameter to restrict a report to only contain statistics for a particular state. Several reports support this type of filtering, including geographic reports, playback location reports, traffic source reports, device reports, operating system reports, demographic reports, and top-video reports.
The
continent
dimension specifies a United Nations (UN) statistical region code that identifies a continent. This dimension can only be used as a filter .The
subContinent
dimension specifies a United Nations (UN) statistical region code that identifies a sub-region of a continent. This dimension can also only be used as a filter.Since each sub-region is only associated with one continent, there is no need to also use the
continent
filter when you are using thesubContinent
filter. (In fact, the API will return an error if a request uses both dimensions.)
The documentation has been corrected so that the
insightTrafficSourceDetail
dimension does not include theinsightTrafficSourceType
valuePROMOTED
as a valid filter value.The YouTube Analytics API is now subject to the Deprecation Policy described in the Terms of Service . However, the API's non-core dimensions and non-core metrics are not subject to the Deprecation Policy. The dimensions and metrics pages have been updated to list core dimensions and core metrics. In addition, the definitions on those pages have been updated to explicitly identify core dimensions and metrics.
The API now supports
EXTERNAL_APP
as a value for theinsightPlaybackLocationType
dimension. In conjunction with this update, as of September 10, 2013, playbacks are no longer categorized asMOBILE
playbacks, though mobile playbacks that occurred before that date will still be categorized with that value.With this update, mobile playbacks are now classified as either
WATCH
,EMBEDDED
, orEXTERNAL_APP
playbacks, depending on the type of application where the playbacks occur.The API now supports
PLAYLIST
as a value for theinsightTrafficSourceType
dimension. The value indicates that video views were referred from a playlist. Previously, these views would have been classified using the dimension'sYT_OTHER_PAGE
category.The API now supports the ability to sort reports by multiple dimensions and metrics. The sample requests document contains a new example, Sorting requests by multiple dimensions/metrics , that demonstrates this functionality. The request retrieves traffic source data and has a
sort
parameter value ofday,-views
. Results are sorted chronologically, but within the result set for each day, the first row contains data for the traffic source that generated the most views, the second row contains data for the source with that generated the next highest amount of views, and so forth .The API now supports two new dimensions,
deviceType
andoperatingSystem
, which can be used to retrieve data about the devices where viewers are watching your videos. The API supports reports that use either or both dimensions.The
deviceType
report lets you retrieve view counts and estimated watch time for different types of devices, including desktop, mobile, and tablet devices. You can also use theoperatingSystem
filter to restrict the device type report to only contain statistics for devices running a specific operating system, such as Android or iOS .The
operatingSystem
report lets you retrieve view counts and estimated watch time for different operating systems, such as Android, iOS, Linux, and more. You can also use thedeviceType
filter to restrict the operating system report to only contain statistics for a specific type of device, such as mobile devices or tablets.
The new device type and operating system reports are available for channels and for content owners .
The sample requests document has been updated to include three device reports for channels and three device reports for content owners.
The
insightPlaybackLocationType
dimension may return the valueYT_OTHER
, which identifies views that are not classified using one of the dimension's other values.The content owner reports document has been updated to reflect that you can sort the top video report in descending order of earnings to identify videos with the highest earnings. This report is the first one listed in the second table of the User activity and earnings reports section.
YouTube no longer identifies experimental API features and services. Instead, we now provide a list of YouTube APIs that are subject to the deprecation policy .
The API now supports the ability to retrieve watch time metrics –
estimatedMinutesWatched
,averageViewDuration
, andaverageViewPercentage
– in conjunction with other metrics, including view metrics, engagement metrics, earnings metrics, and ad performance metrics.The lists of available channel reports and content owner reports have been updated to reflect this change. (The lists are actually shorter now since the watch time metrics can be retrieved as part of other listed reports.)
The Sample API requests document has also been updated.
The reports that use the
insightPlaybackLocationDetail
andinsightTrafficSourceDetail
dimensions have been enhanced in the following ways:They now support an optional
country
filter.Content owners can now retrieve these reports using any of the following new
filter
combinations. Note that all of these combinations also support the optionalcountry
filter.Playback location detail
-
channel,insightPlaybackLocationType==EMBEDDED
-
show,insightPlaybackLocationType==EMBEDDED
-
claimedStatus,insightPlaybackLocationType==EMBEDDED
-
uploaderType,insightPlaybackLocationType==EMBEDDED
-
uploaderType,claimedStatus,insightPlaybackLocationType==EMBEDDED
-
Traffic source detail
-
channel,insightTrafficSourceType
-
show,insightTrafficSourceType
-
claimedStatus,insightTrafficSourceType
-
uploaderType,insightTrafficSourceType
-
uploaderType,claimedStatus,insightTrafficSourceType
-
The new Sample API requests document provides examples that demonstrate how to retrieve many different types of reports using the YouTube Analytics API . Each example includes a brief description of the report that the request retrieves and then shows the dimensions, metrics, filters, and sort parameters for the request.
The
insightTrafficSourceType
dimension now supportsSUBSCRIBER
as a valid value. This value identifies video views that were referred from feeds on the YouTube homepage or from YouTube subscription features. If you filter based on this traffic source, theinsightTrafficSourceDetail
field will specify the homepage feed or other page from which views were referred.The API now supports two new metrics,
annotationClickThroughRate
andannotationCloseRate
, which are related to viewer interactions with annotations that display during your videos. The lists of channel reports and content owner reports have both been updated to identify the reports that support the new metrics.-
annotationClickThroughRate
– The ratio of annotations that viewers clicked to the total number of clickable annotation impressions. -
annotationCloseRate
– The ratio of annotations that viewers closed to the total number of annotation impressions.
-
The API now supports earnings and ad performance metrics as well as new ad performance reports. The metrics and the reports are all accessible only to YouTube content partners who participate in the YouTube Partner Program .
The newly supported reports support playback-based ad performance metrics and impression-based ad performance metrics. See the content owner reports documentation for more information about ad performance reports.
The newly supported metrics are listed below. The list of content owner reports has been updated to identify the reports, including the two new reports, that support these metrics.
-
earnings
– Total estimated earnings from all Google-sold advertising sources. -
grossRevenue
– Estimated gross revenue from Google or DoubleClick partners. -
primaryAdGrossRevenue
– Estimated gross revenue, summed and classified under the primary ad type for the video playbacks that the report covers, from Google or DoubleClick partners. -
monetizedPlaybacks
– The number of playbacks that showed at least one ad impression. -
playbackBasedCpm
– Estimated gross revenue per thousand playbacks. -
impressions
– The number of verified ad impressions served. -
impressionBasedCpm
– Estimated gross revenue per thousand ad impressions.
Note: See the metric definitions for complete details.
-
Any request that retrieves earnings or ad performance metrics must send an authorization token that grants access using the new
https://www.googleapis.com/auth/yt-analytics-monetary.readonly
scope.
The API documentation has been reorganized so that different types of reports are explained on separate pages. As such, there are now separate pages explaining the different types of channel reports and content owner reports .
The API's reference guide now has an examples section, which includes code samples that demonstrate how to call the API using the Java, JavaScript, Python, and Ruby client libraries. The JavaScript code sample is the same one discussed in detail in the sample application documentation.
The API reference guide now features the APIs Explorer , which enables you to call the API, see the API request, and retrieve real data in the response.
The API supports a number of new reports for both channels and content owners, which are described below. Each report is available as a channel report or a content owner report . The dimensions and metrics pages have also been updated accordingly.
The playback location report specifies the number of video views that took place on different types of pages or applications .
The playback location detail report identifies the embedded players that generated the most views for a specified video. It provides a more fine-grained view than the playback location report by identifying the URLs associated with the top embedded players.
The traffic source report identifies the number of videos views that originated from different types of referrers .
The traffic source detail report identifies the referrers that generated the most views for a specified video and a specified traffic source type. For example, this report could you the related videos that sent the most traffic to a specific video. This report is supported for several traffic sources .
Watch time reports provide the amount of time viewers spent watching your content. The reports can aggregate data for a specific time frame – day, previous seven days, previous 30 days, etc. – or country. If a report aggregates data by either day or country, it can also specify the average length of each video view as well as the average percentage of each video that users watched.
The YouTube Analytics API is now available to all developers. You can activate the API for your project, without having to first request access, from the Services panel in the APIs console .
The new Getting Started section outlines the prerequisites and basic steps for building an application that uses the YouTube Analytics API .
The new understanding quota usage section provides guidelines for optimizing your API quota usage. The API server calculates a query cost for each request, and that cost is deducted from your API usage quota. Since different types of reports may have greatly different query costs, you should plan to use your quota efficiently, and your application should only request the metrics and data that it actually needs.
The temporal dimensions section has been updated to explain that those dimensions indicate that an Analytics report should aggregate data based on a time period. The API now supports the following additional temporal dimensions:
-
7DayTotals
– Data in the report will be aggregated so that each row contains data for a seven-day period. -
30DayTotals
– Data in the report will be aggregated so that each row contains data for a 30-day period. -
month
– Data in the report will be aggregated by calendar month.
Similarly, the available reports section has been updated to reflect the API's support for reports that use these dimensions.
-
The reporting entity dimensions section has been updated to note that API requests to retrieve content owner reports must filter data using either one of these dimensions (
video
,channel
, orshow
) or a supported combination of theclaimedStatus
anduploaderType
dimensions.The API now supports two new sorting options for top-video reports . These reports, which are available as channel reports or content owner reports, contain metrics (views, comments, likes, etc.) on a per-country basis and break down those metrics by video. You can now sort these reports based on the number of users who subscribed to or unsubscribed from a channel from the video's watch page.
The definitions of the
subscribersGained
andsubscribersLost
metrics have been updated to explain that a channel can gain or lose subscribers in several places, including the video watch page, the channel page, and the guide that appears on the YouTube home page. When these metrics appear in a video-specific report, they only include statistics from the specified video's watch page.
API Reporting YouTube поддерживает три новых отчета о конечных экранах, а также новые размеры и показатели для этих отчетов. Отчеты предоставляют создание и проведенные статистики для конечных экранов, которые отображаются после того, как видео перестает играть.
Справочный центр YouTube содержит более подробную информацию о добавлении конечных экранов к вашим видео .
8 ноября 2016 года
Это обновление содержит следующие изменения в API YouTube Analytics:
27 октября 2016 года
YouTube теперь автоматически генерирует набор отчетов по доходам от рекламы, управляемых системой, для владельцев контента, которые имеют доступ к соответствующим отчетам в разделе отчетов на YouTube Creator Studio. Новые отчеты API, управляемые системой, предназначены для предоставления программного доступа к данным, которые также доступны в отчетах вручную загружаемых Creator Studio.
Обзор отчетов, управляемый системой, содержит краткий обзор новых отчетов и объясняет процесс для их извлечения через API. Этот процесс немного отличается от процесса для получения объемных отчетов для аналитики YouTube, поскольку партнерам не нужно планировать работы для создания отчетов.
Свойство id
ресурса reportType
было обновлено, чтобы включить список отчетов, управляемых системой, которые вы можете получить через API:
27 сентября 2016 года
Примечание: это объявление об ископке.
Метрика uniques
Api YouTube Analytics установилась. Это не основная метрика, и она будет поддерживаться до 31 октября 2016 года.
15 сентября 2016 года
Это обновление содержит следующие изменения API отчетности YouTube:
19 августа 2016 г.
Это обновление содержит следующее изменение API отчетности YouTube:
11 августа 2016 года
Это обновление содержит следующие изменения:
10 августа 2016 года
Это обновление включает в себя следующие изменения:
18 июля 2016 года
Это обновление включает в себя следующие изменения:
28 июня 2016 года
Документация по API youtube Analytics была обновлена, чтобы отразить поддержку показателей карт в многочисленных отчетах о каналах и владельцах контента . Недавно поддерживаемые метрики:
Метрики поддерживаются в следующих типах отчетов:
22 июня 2016 г.
Это обновление содержит следующие изменения API отчетности YouTube. Первое изменение относится к API в целом, а оставшиеся изменения влияют только на отчеты владельца контента :
19 мая 2016 года
Это обновление содержит следующие изменения API отчетности YouTube:
12 апреля 2016 года
Это обновление содержит следующие изменения, все это только влияет на API отчетности YouTube:
28 марта 2016 года
API API отчетности YouTube и API YouTube Analytics теперь возвращает статистику для нескольких дополнительных услуг обмена.
16 марта 2016 года
Это обновление содержит следующие изменения, которые влияют как на API отчетности YouTube, так и API YouTube Analytics:
YouTube Reporting API
YouTube Analytics API
February 8, 2016
The list of metrics supported for the YouTube Analytics API has been updated so that card metrics are no longer listed as supported metrics for that API. (None of that API's reports had been documented as supporting any of the card metrics.)
Note that you can still retrieve card metrics using the YouTube Reporting API, which supports those metrics for numerous channel and content owner reports.
January 6, 2016
The YouTube Reporting API and YouTube Analytics API both now specifically identify views that occur via a Chromecast device.
December 21, 2015
In the documentation, the names of the annotation_clickable_impressions
and annotation_closable_impressions
metrics have been updated to match the names being returned in the reports. Previously, the names were documented as clickable_annotation_impressions
and closable_annotation_impressions
.
December 18, 2015
European Union (EU) laws require that certain disclosures must be given to and consents obtained from end users in the EU. Therefore, for end users in the European Union, you must comply with the EU User Consent Policy . We have added a notice of this requirement in our YouTube API Terms of Service .
December 15, 2015
This update contains the following changes, all of which affect the YouTube Analytics API:
November 10, 2015
This update contains the following changes:
October 29, 2015
This update contains the following changes:
October 8, 2015
This update contains the following changes:
September 24, 2015
This update contains the following changes:
August 20, 2015
This update contains the following changes:
July 22, 2015
This update contains several changes, all of which only apply to content owners:
June 1, 2015
This update contains the following changes:
March 31, 2015
This update contains the following changes:
March 16, 2015
This update contains the following changes:
February 25, 2015
This update contains the following changes:
February 13, 2015
This update contains the following changes:
August 28, 2014
This update contains the following changes:
July 16, 2014
This update contains the following changes:
January 31, 2014
This update contains the following changes:
January 16, 2014
This update contains the following changes:
January 6, 2014
This update contains the following changes:
September 30, 2013
This update contains the following changes:
July 16, 2013
This update contains the following changes:
May 23, 2013
This update contains the following changes:
May 10, 2013
This update contains the following changes:
May 6, 2013
This update contains the following changes:
May 3, 2013
This update contains the following changes:
March 28, 2013
This update contains the following changes:
March 21, 2013
This update contains the following changes:
February 4, 2013
This update contains the following changes:
November 14, 2012
This update contains the following changes:
October 2, 2012
This update contains the following changes:
September 12, 2012
This update contains the following changes: