На этой странице перечислены изменения API и обновления документации как для YouTube Reporting API, так и для YouTube Analytics API. Оба API позволяют разработчикам получать доступ к данным YouTube Analytics, хотя и разными способами. Подпишитесь на этот список изменений .
15 января 2026 г.
API отчетов YouTube теперь поддерживает отчеты о охвате для каналов и владельцев контента. Отчеты о охвате предоставляют статистику по показам миниатюр видео и коэффициентам кликабельности.
- Для каналов доступны отчеты
channel_reach_basic_a1иchannel_reach_combined_a1. - Для владельцев контента доступны отчеты
content_owner_reach_basic_a1иcontent_owner_reach_combined_a1.
Эти отчеты подтверждают соответствие следующим новым показателям:
-
video_thumbnail_impressions -
video_thumbnail_impressions_ctr
22 сентября 2025 г.
Ранее объявленное прекращение поддержки отчетов отложено с 30 сентября 2025 года на 31 октября 2025 года. Предыдущие версии отчетов, обновленные с учетом изменений количества просмотров в Shorts, будут оставаться доступными до этого времени, за исключением отчета по претензиям версии 1.0 ( content_owner_active_claims_a1 ) и отчета по претензиям версии 1.1 ( content_owner_active_claims_a2 ), которые по-прежнему будут устаревать 30 сентября.
24 июня 2025 г.
Как было объявлено 26 марта 2025 года , API для создания массовых отчетов будет обновлен в рамках изменения счетчика просмотров коротких сообщений. Были внесены следующие изменения:
- Для каждого отчета, включающего представления, а это большинство отчетов, были созданы новые версии. Версия каждого затронутого отчета увеличилась на единицу, например, с версии
a2до версииa3. - Для коротких видеороликов просмотры теперь будут учитываться по количеству запусков или повторных воспроизведений ролика. Для видео изменений нет.
- В обновленные отчеты будет добавлен новый столбец
engaged_views, отражающий предыдущую методику подсчета просмотров.
Эти изменения вступают в силу с 30 июня 2025 года для API массовых отчетов. Обязательно внесите соответствующие корректировки в процесс обработки отчетов.
Предыдущие версии отчетов будут доступны до 30 сентября 2025 года. После 30 сентября 2025 года предыдущие версии будут устарели. Обязательно перейдите на последние версии.
Наконец, обязательно следуйте передовым методам обработки отчетов, чтобы избежать сбоев в работе конвейеров обработки в будущем из-за изменений в отчетах.
В следующих таблицах представлены новые версии отчетов для каждого типа отчетов:
Массовые отчеты по данным для YouTube Analytics
| Отчеты каналов - Видеоотчеты | ||
|---|---|---|
| Название отчета | Предыдущая версия | Последняя версия |
| Активность пользователей | channel_basic_a2 | channel_basic_a3 |
| Активность пользователей по провинциям | канал_провинция_а2 | канал_провинция_а3 |
| Места воспроизведения | channel_playback_location_a2 | channel_playback_location_a3 |
| Источники трафика | channel_traffic_source_a2 | channel_traffic_source_a3 |
| Тип устройства и операционная система | channel_device_os_a2 | канал_устройства_os_a3 |
| Субтитры | channel_subtitles_a2 | channel_subtitles_a3 |
| Объединенный | канал_комбинированный_a2 | канал_объединенный_a3 |
| Отчеты по каналам - Отчеты по плейлистам | ||
|---|---|---|
| Название отчета | Предыдущая версия | Последняя версия |
| Активность пользователей | playlist_basic_a1 | playlist_basic_a2 |
| Активность пользователей по провинциям | playlist_province_a1 | playlist_province_a2 |
| Места воспроизведения | playlist_playback_location_a1 | playlist_playback_location_a2 |
| Источники трафика | playlist_traffic_source_a1 | playlist_traffic_source_a2 |
| Тип устройства и операционная система | playlist_device_os_a1 | playlist_device_os_a2 |
| Объединенный | playlist_combined_a1 | playlist_combined_a2 |
| Отчеты для владельцев контента - Видеоотчеты | ||
|---|---|---|
| Название отчета | Предыдущая версия | Последняя версия |
| Активность пользователей | content_owner_basic_a3 | content_owner_basic_a4 |
| Активность пользователей по провинциям | content_owner_province_a2 | content_owner_province_a3 |
| Места воспроизведения | content_owner_playback_location_a2 | content_owner_playback_location_a3 |
| Источники трафика | content_owner_traffic_source_a2 | content_owner_traffic_source_a3 |
| Тип устройства и операционная система | content_owner_device_os_a2 | content_owner_device_os_a3 |
| Субтитры | content_owner_subtitles_a2 | content_owner_subtitles_a3 |
| Объединенный | content_owner_combined_a2 | content_owner_combined_a3 |
| Отчеты для владельцев контента - Отчеты по плейлистам | ||
|---|---|---|
| Название отчета | Предыдущая версия | Последняя версия |
| Активность пользователей | content_owner_playlist_basic_a1 | content_owner_playlist_basic_a2 |
| Активность пользователей по провинциям | content_owner_playlist_province_a1 | content_owner_playlist_province_a2 |
| Места воспроизведения | content_owner_playlist_playback_location_a1 | content_owner_playlist_playback_location_a2 |
| Источники трафика | content_owner_playlist_traffic_source_a1 | content_owner_playlist_traffic_source_a2 |
| Тип устройства и операционная система | content_owner_playlist_device_os_a1 | content_owner_playlist_device_os_a2 |
| Объединенный | content_owner_playlist_combined_a1 | content_owner_playlist_combined_a2 |
| Отчеты для владельцев контента - Отчеты по активам | ||
|---|---|---|
| Название отчета | Предыдущая версия | Последняя версия |
| Активность пользователей | content_owner_asset_basic_a2 | content_owner_asset_basic_a3 |
| Активность пользователей по провинциям | content_owner_asset_province_a2 | content_owner_asset_province_a3 |
| Места воспроизведения видео | content_owner_asset_playback_location_a2 | content_owner_asset_playback_location_a3 |
| Источники трафика | content_owner_asset_traffic_source_a2 | content_owner_asset_traffic_source_a3 |
| Тип устройства и операционная система | content_owner_asset_device_os_a2 | content_owner_asset_device_os_a3 |
| Объединенный | content_owner_asset_combined_a2 | content_owner_asset_combined_a3 |
Отчеты, управляемые системой — финансовые (не связанные с музыкой)
| Отчеты владельцев контента - Отчеты по короткометражным фильмам (не музыкальным) | ||
|---|---|---|
| Название отчета | Предыдущая версия | Последняя версия |
| Сводка по мировым доходам от рекламы | content_owner_shorts_global_ad_revenue_summary_a1 | content_owner_shorts_global_ad_revenue_summary_a2 |
| Ежедневный обзор доходов от рекламы | content_owner_shorts_day_ad_revenue_summary_a1 | content_owner_shorts_day_ad_revenue_summary_a2 |
| Сводка доходов от рекламы по странам | content_owner_shorts_country_ad_revenue_summary_a1 | content_owner_shorts_country_ad_revenue_summary_a2 |
| Сводка доходов от рекламы | content_owner_shorts_ad_revenue_summary_a1 | content_owner_shorts_ad_revenue_summary_a2 |
Отчеты, управляемые системой — нефинансовые
| Отчеты для владельцев контента - Отчеты по претензиям | ||
|---|---|---|
| Название отчета | Предыдущая версия | Последняя версия |
| Активные претензии | content_owner_active_claims_a2 | content_owner_active_claims_a3 |
| Отчеты для владельцев контента - Отчеты по метаданным видео | ||
|---|---|---|
| Название отчета | Предыдущая версия | Последняя версия |
| Метаданные видео | content_owner_video_metadata_a3 | content_owner_video_metadata_a4 |
| Отчеты для владельцев контента - Отчеты по активам | ||
|---|---|---|
| Название отчета | Предыдущая версия | Последняя версия |
| Ресурсы | content_owner_asset_a2 | content_owner_asset_a3 |
| Конфликты активов | content_owner_asset_conflict_a2 | content_owner_asset_conflict_a3 |
24 апреля 2025 г.
Как было объявлено 26 марта 2025 года , API целевых запросов будет обновлен в рамках изменения счетчика просмотров коротких сообщений:
- В случае с короткими видеороликами,
viewsтеперь будут учитываться по количеству запусков или повторных воспроизведений короткого ролика. - Новый показатель,
engagedViews, будет отражать предыдущую методологию подсчета просмотров.engagedViewsбудет доступен во всех отчетах вместе сviews.
Эти изменения вступят в силу с 30 апреля 2025 года для API целевых запросов. Обязательно скорректируйте свои запросы соответствующим образом.
Ознакомьтесь с историей изменений, чтобы узнать, какие изменения и когда будут внесены в API для создания массовых отчетов.
22 апреля 2025 г.
Как было объявлено 7 апреля 2024 года , параметр isCurated устарел для отчетов по каналам и отчетов по плейлистам владельцев контента. С 31 декабря 2024 года этот параметр больше не поддерживается. Он был удален из отчетов и документации.
26 марта 2025 г.
В это обновление внесены следующие изменения, касающиеся API аналитики и отчетов YouTube:
Начиная с 31 марта 2025 года, YouTube изменит способ подсчета просмотров коротких видеороликов (Shorts). Раньше просмотр засчитывался после того, как ролик воспроизводился в течение определенного количества секунд. Теперь просмотры будут учитываться по количеству запусков или повторных воспроизведений ролика, без минимального требования к времени просмотра. Подробнее.
API-интерфейсы YouTube Analytics (целевые запросы) и Reporting (массовые отчеты) будут обновлены со следующими изменениями:
- В случае коротких видеороликов
viewsподсчитываются по количеству запусков или повторных воспроизведений короткого ролика. - Будет введена новая метрика,
engagedViews, которая будет отражать предыдущую методику подсчета просмотров. - Если вы являетесь владельцем канала или имеете право доступа к данным канала, вы сможете запрашивать как обновленные, так и вовлеченные просмотры.
Обновление целевых запросов будет произведено к 30 апреля, а обновление массовых отчетов — к 30 июня. До этого времени представления будут основаны на старой методологии. Представления коротких сообщений и каналов не будут совпадать с данными аналитики в Studio.
Кроме того, ранее объявленное прекращение поддержки отчета «Ежедневные заявки на пособие по безработице» (версия 1.0) отложено.
Просмотрите историю изменений, чтобы узнать, когда в API были внесены изменения.
3 марта 2025 г.
В это обновление внесены следующие изменения, касающиеся API отчетов YouTube:
Примечание: Это объявление об устаревании функции.
Отчет «Ежедневные претензии» (версия 1.0) устарел для партнеров. Его поддержка будет прекращена с 30 апреля 2025 года и позже. Соответственно, были обновлены характеристики этого отчета. Вместо него используйте последнюю версию отчета «Ежедневные претензии».
15 ноября 2024 г.
Примечание: Данное изменение вступает в силу с 18 ноября 2024 года.
В документацию по API YouTube Analytics (целевые запросы) внесены изменения, в которых указано, что для отчетов по источникам трафика метод 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. Пример приведен в разделе, определяющем отчеты по плейлистам на основе времени .
4 декабря 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 Reporting (массовые отчеты) поддерживают новое значение детализации источника трафика:
- В API аналитики YouTube (целевые запросы), если значение параметра
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 Reporting (массовые отчеты) поддерживают новое значение параметра «Источник трафика», указывающее на то, что зритель перешел на сайт, проведя пальцем вертикально в режиме просмотра коротких видеороликов YouTube Shorts:
- В API аналитики YouTube (целевые запросы) параметр
insightTrafficSourceTypeподдерживает значениеSHORTS. - В API отчетов YouTube (массовые отчеты) параметр
traffic_source_typeподдерживает значение24.
Для этого нового типа источника трафика параметр детализации источника трафика — insightTrafficSourceDetail в API YouTube Analytics или traffic_source_detail в API отчетов YouTube — не заполнен.
20 июля 2020 г.
В этом обновлении описаны два изменения, затрагивающие API аналитики YouTube (целевые запросы):
- Максимальный размер группы отчетов в YouTube Analytics увеличен с 200 до 500 элементов.
- Параметр
filtersметодаreports.queryопределяет список фильтров, которые должны применяться при получении данных YouTube Analytics. Параметр позволяет указывать несколько значений для фильтровvideo,playlistиchannel, а максимальное количество идентификаторов, которые можно указать для этих фильтров, увеличено с 200 до 500.
13 февраля 2020 г.
Это обновление содержит следующие изменения, касающиеся API аналитики YouTube (целевые запросы) и API отчетов YouTube (массовые отчеты). Подробнее об этих изменениях можно узнать в Справочном центре YouTube .
В обоих API набор возможных значений параметров источника трафика для уведомлений меняется. В целевых запросах уведомления отображаются как insightTrafficSourceType=NOTIFICATION . В пакетных отчетах уведомления отображаются как traffic_source_type=17 .
Новые значения разделяют уведомления, связанные с загруженными видео и прямыми трансляциями, которые ранее помечались как uploaded , на две категории:
-
uploaded_push- Просмотры получены благодаря push-уведомлениям, отправленным подписчикам при загрузке видео. -
uploaded_other- Просмотры получены из уведомлений, не являющихся push-уведомлениями, таких как уведомления по электронной почте или входящие сообщения, отправляемые подписчикам при загрузке видео.
Эти значения возвращаются за период времени, начинающийся с 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-дневные периоды. Например:- Количество просмотров за семидневный период можно рассчитать, суммировав количество просмотров за каждый день этого периода.
- Процент зрителей за семидневный период можно рассчитать, умножив количество просмотров за каждый день на процент зрителей за этот день, чтобы получить количество зрителей, которые были авторизованы во время просмотра видео в этот день. Затем количество авторизованных зрителей можно сложить за весь период и разделить на общее количество просмотров за этот период, чтобы получить процент зрителей за весь период.
- Количество уникальных зрителей за семидневный период рассчитать невозможно, поскольку один и тот же зритель может быть учтен как уникальный зритель в разные дни. Однако, вместо параметра
30DayTotalsможно использовать измерениеmonth, чтобы экстраполировать данные о количестве уникальных зрителей за 30-дневный период. Обратите внимание, что измерениеmonthотносится к календарным месяцам, тогда как измерение30DayTotalsрассчитывает 30-дневные периоды на основе указанных начальной и конечной дат.
27 июня 2019 г.
В это обновление внесены следующие изменения, касающиеся API YouTube Analytics (целевые запросы):
Поскольку первая версия API полностью устарела, документация была обновлена, чтобы удалить ссылки на эту версию, включая уведомление об устаревании и руководство по миграции, объясняющее, как обновиться до версии 2.
1 ноября 2018 г.
В это обновление внесены следующие изменения, касающиеся API YouTube Analytics (целевые запросы):
Первая версия API устарела. Если вы еще этого не сделали, пожалуйста, как можно скорее обновите свои API-клиенты до версии 2, чтобы минимизировать сбои в работе сервиса. Более подробную информацию см. в руководстве по миграции .
Обратите внимание, что график этой амортизации был первоначально объявлен 26 апреля 2018 года .
17 сентября 2018 г.
В это обновление внесены следующие изменения, касающиеся API YouTube Analytics (целевые запросы):
В новом разделе об анонимизации данных в документе «Обзор модели данных» объясняется, что некоторые данные YouTube Analytics могут быть ограничены, если метрики не соответствуют определенному пороговому значению. Это может происходить в различных случаях. На практике это означает, что отчет может не содержать всех (или каких-либо) ваших данных, если:
Видео или канал имеют ограниченный трафик в течение определенного периода времени.
или
Вы выбрали фильтр или параметр, например, источник трафика или страну, значения которого не соответствуют определенному пороговому значению.
В новом разделе также обсуждаются типы данных, которые могут быть ограничены в отчетах YouTube Analytics.
В отчеты по каналам и владельцам контента внесены изменения, отражающие тот факт, что метрики
redViewsиestimatedRedMinutesWatchedбольше не поддерживаются для отчетов по местоположению воспроизведения, источнику трафика и типу устройства/операционной системе.
18 июня 2018 г.
В это обновление внесены следующие изменения в API аналитики YouTube (целевые запросы):
- Изменились требования к объему применения следующих методов:
- Запросы к методу
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 (целевые запросы):
- В разделе «Обзор API» появился новый раздел « Агрегированные метрики и удаленные элементы» , в котором объясняется, как ответы API обрабатывают данные, связанные с удаленными ресурсами, такими как видео, плейлисты или каналы.
- В раздел « Рекомендации по использованию API» внесены изменения, напоминающие о возможности использования YouTube Data API для получения дополнительных метаданных для ресурсов, указанных в ответах YouTube Analytics API. Как указано в Политике разработчиков сервисов YouTube API (разделы III.E.4.b–III.E.4.d), клиенты API должны либо удалять, либо обновлять сохраненные метаданные ресурсов из этого API каждые 30 дней.
22 мая 2018 г.
В это обновление внесены следующие изменения, касающиеся API отчетов YouTube (массовых отчетов):
- В настоящее время ожидается, что следующие изменения вступят в силу в июле 2018 года, и новые правила будут применяться во всем мире ко всем отчетам и задачам формирования отчетов.
После внесения изменений большинство отчетов API, включая отчеты по ретроспективному анализу, будут доступны в течение 60 дней с момента их создания. Однако отчеты, содержащие исторические данные, будут доступны в течение 30 дней с момента их создания.
Prior to this announcement, all API reports have been available for 180 days from the time that they were generated. To be clear, when this policy change goes into effect, historical data reports that are more than 30 days old will also no longer be accessible via the API. All other reports that are more than 60 days old will also no longer be accessible. As such, the documentation now states that reports created prior to the policy change will be available for up to 180 days.
After the change, when you schedule a reporting job, YouTube will generate reports from that day forward and covering the 30-day period prior to the time the job was scheduled. Prior to the change, when you schedule a reporting job, YouTube will generate reports covering the 180-day period prior to the time that the job was scheduled.
The best practices section has been updated to remind you that you can use the YouTube Data API to retrieve additional metadata for resources identified in reports. As noted in the YouTube API Services Developer Policies (sections III.E.4.b through III.E.4.d), API clients must either delete or refresh stored resource metadata from that API after 30 days.
The Report characteristics section has been updated to note that even though report data is not filtered, reports that contain data for a time period on or after June 1, 2018, will not contain any references to YouTube resources that were deleted at least 30 days prior to the date the report was generated.
The historical data section of the API overview has been updated to note that when you schedule a new reporting job, the historical reports are typically posted within a couple of days. Previously, the documentation stated that it could take up to 30 days for such reports to be available.
The backfill data section of the API overview has been updated to more clearly define backfill data as a data set that replaces a previously delivered set.
26 апреля 2018 г.
Version 2 of the YouTube Analytics (Targeted Queries) API (v2) is now publicly available. The following list identifies product and documentation changes related to the new API version:
The v2 API is almost identical to the v1 API. However, you will likely need to update your code to reflect the changes listed below. All of these changes are explained in detail in the new migration guide .
- The API's version has changed from
v1tov2. - The base URL for API requests has changed from
https://www.googleapis.com/youtube/analytics/v1tohttps://youtubeanalytics.googleapis.com/v2. - Several parameters for the
reports.querymethod have updated names. Specifically, parameter names that contain hyphens, likeend-datein the v1 API use camel case (endDate) rather than hyphens in the v2 API. This change makes parameter names consistent throughout the API since the API's methods for creating and managing groups already used camel casing for parameter names. - The v2 API does not support batch requests sent to Google's global HTTP batch endpoint (
www.googleapis.com/batch). If you are sending batch requests in the v2 API, you need to use the endpointhttps://youtubeanalytics.googleapis.com/v2instead.
In addition, a few v1 features are not supported in the v2 API:
- The
reports.querymethod no longer supports thealt,quotaUser, anduserIprequest parameters. - The v2 API does not provide a batch endpoint that supports batches comprised of requests to different APIs. (A batch can be comprised of requests to different methods of the same API, however.) This deprecation is not specific to the YouTube Analytics API as Google is deprecating the global batch endpoint across all of its APIs.
- The v2 API does not support the JSON-RPC protocol, which was supported in API v1. Again, this deprecation is not specific to the YouTube Analytics API.
- The API's version has changed from
Note: This is a deprecation announcement.
Version 1 of the API (v1) is now deprecated and will be supported until October 31, 2018. All requests to the v1 API will stop working after that date. As such, please be sure to upgrade to the v2 API no later than October 31, 2018, to avoid any interruption in your ability to access YouTube Analytics data via the API.
February 21, 2018
This update contains the following changes to the YouTube Analytics (Targeted Queries) API:
- Viewer demographic reports, which aggregate viewing statistics based on viewers' age group and gender, no longer support the
youtubeProductdimension, which identifies the YouTube service on which the user activity occurred.
18 января 2018 г.
This update contains the following changes:
YouTube Reporting API (Bulk Reports)
- The
operating_systemdimension, which identifies the software system of the device on which views occurred, now supports the following value:-
25: KaiOS
-
- The
YouTube Analytics API (Targeted Queries)
- The
operatingSystemdimension supports the dimension valueKAIOS.
- The
December 20, 2017
This update contains two changes related to the YouTube Reporting API:
The API server now supports gzip compression for requests that download reports. Note that gzip compression is not supported for other types of API requests. Enabling gzip compression reduces the bandwidth needed for each API response. And, while your application will need additional CPU time to uncompress API responses, the benefit of consuming fewer network resources usually outweighs that cost.
To receive a gzip-encoded response, set the
Accept-EncodingHTTP request header togzipas shown in the following example:Accept-Encoding: gzip
This functionality is explained in the API overview and in the definition of the
reportresource'sdownloadUrlproperty.The documentation of the
age groupandgenderdimensions has been corrected to show the actual values that the API returns for those dimensions. Note that this is a documentation correction and does not reflect a change in API functionality or behavior. Specifically, the following values have changed:- Values for the
age_groupdimension use uppercase letters, contain underscores between the wordAGEand the numbers in the age group, and use underscores instead of hyphens. As such, values likeage13-17andage18-24have been corrected toAGE_13_17andAGE_18_24, respectively. - Values for the
genderdimension use uppercase letters. Thus, the valuesfemale,male, andgender_otherhave been corrected toFEMALE,MALE, andGENDER_OTHER.
- Values for the
10 августа 2017 г.
On August 10, 2016, this documentation announced the deprecation of the YouTube Analytics API's earnings metric. (At the same time, the API added support for a new metric, named estimatedRevenue , that provides the same data.)
Since the earnings metric was a core metric, it was supported for one year from the date of the announcement. Now that that yearlong period has ended, however, the earnings metric is no longer supported. As a result, API requests that specify the earnings metric now return a 400 HTTP response code. If you haven't already updated your app to use the estimatedRevenue metric instead of the earnings metric, please do so as soon as possible.
The API documentation has been updated to remove remaining references to the earnings metric.
6 июля 2017 г.
This update contains the following changes:
YouTube Analytics API (Targeted Queries)
The API documentation has been updated to reflect the fact that API responses contain data up until the last day in the requested date range for which all metrics being queried are available.
For example, if a request specifies an end date of July 5, 2017, and values for all of the requested metrics are only available through July 3, 2017, that will be the last date for which data is included in the response. (That is true even if data for some of the requested metrics is available for July 4, 2017.)
The
adTypedimension now supports the valuereservedBumperInstream, which refers to a non-skippable video ad of up to 6 seconds that plays before a video can be viewed. The ad format is identical to theauctionBumperInstreamad, but this type refers to ads sold on a reserved rather than an auction basis.
YouTube Reporting API (Bulk Reports)
The
ad_typedimension now supports the value20, which refers to bumper ads sold on a reserved basis. Bumper ads are non-skippable video ads of up to 6 seconds that play before a video can be viewed. Note that the value19for this dimension also refers to bumper ads that are sold on an auction rather than a reserved basis.Reporting jobs for the following YouTube Reporting API reports have been deleted:
-
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
These report types were announced as deprecated on September 15, 2016 , and reports were no longer generated for those report types after December 15, 2016. Previously generated reports were still available for 180 days from the time they were generated. Thus, some reports were accessible as late as June 15, 2017. However, since the reports are no longer available, the jobs associated with the reports are not needed either.
-
24 мая 2017 г.
All reporting jobs for the following YouTube Reporting API reports have been deleted:
-
content_owner_ad_performance_a1 -
content_owner_asset_estimated_earnings_a1 -
content_owner_estimated_earnings_a1
These report types were announced as deprecated on June 22, 2016 , and reports were no longer generated for those report types after September 22, 2016. Previously generated reports were still available for 180 days from the time they were generated. Thus, some reports were accessible as late as March 22, 2017. However, since the reports are no longer available, the jobs associated with the reports are not needed either.
22 мая 2017 г.
This update contains the following changes:
YouTube Reporting API (Bulk Reports)
- The
sharing_servicedimension, which identifies the service that was used to share videos, now supports the following values:-
85: YouTube Music -
86: YouTube Gaming -
87: YouTube Kids -
88: YouTube TV
In addition, the name used to identify value
52has been updated in the documentation to Kakao (Kakao Talk) to more clearly differentiate it from value73(Kakao Story). This change does not reflect any change in API behavior or classification of videos shared with these services. -
- The
YouTube Analytics API (Targeted Queries)
- The
sharingServicedimension now supports the following values:-
YOUTUBE_GAMING -
YOUTUBE_KIDS -
YOUTUBE_MUSIC -
YOUTUBE_TV
-
- The
28 марта 2017 г.
Channel owners who can access revenue data through YouTube Analytics in Creator Studio can now also access that revenue data via the YouTube Analytics API:
The API supports the following revenue-related metrics:
-
adImpressions -
cpm -
estimatedAdRevenue -
estimatedRedPartnerRevenue -
estimatedRevenue -
grossRevenue -
monetizedPlaybacks -
playbackBasedCpm
These metrics are supported for the following reports:
-
Channel owners can also now retrieve an ad performance report , which supports the
adTypedimension as well as the optionaldaydimension.The YouTube Analytics API sample requests guide now includes a section for channel revenue reports .
17 марта 2017 г.
This update contains the following changes:
The YouTube Analytics API supports the
redViewsandestimatedRedMinutesWatchedmetrics, both of which relate to YouTube Red viewership. In fact, the API has actually supported these metrics for some time, and the YouTube Reporting API already supports both metrics as announced on September 15, 2016 .- The
redViewsmetric identifies the number of times that a video was viewed by YouTube Red members. - The
estimatedRedMinutesWatchedmetric identifies the number of minutes that YouTube Red members watched a video.
The channel reports and content owner reports documentation has been updated to show which reports support the two new metrics. They are supported in any reports that already supported the
viewsandestimatedMinutesWatchedmetrics.- The
3 марта 2017 г.
This update contains the following changes:
YouTube Reporting API (Bulk Reports)
The definition of the
datedimension has been corrected to note that the dimension value refers to the period beginning at 12:00 am Pacific time and ending at 11:59 pm Pacific time on the specified day, month, and year. Depending on the time of year, Pacific time is either UTC-7 or UTC-8.Though dates typically represent a 24-hour period, dates when clocks are adjusted forward represent a 23-hour period, and dates when clocks are adjusted backward represent a 25-hour period. (Previously, the documentation stated that each date represented a unique 24-hour period and that Pacific time was always UTC-8.)
Note that this correction does not represent a change in actual API behavior.
- The
operating_systemdimension, which identifies the software system of the device on which views occurred, now supports the following values:-
22: Tizen -
23: Firefox -
24: RealMedia
-
All reporting jobs for the
content_owner_basic_a1report type have been deleted. That report type had been fully deprecated as of August 19, 2016 , but previously generatedcontent_owner_basic_a1reports were still available for 180 days from the time they were generated. Thus, some reports were accessible as late as February 19, 2017. However, since the reports are no longer available, the jobs associated with the reports are not needed either.
YouTube Analytics API (Targeted Queries)
The description of dimensions related to
time periodshas been corrected to note that the dimension value refers to the period beginning at 12:00 am Pacific time and ending at 11:59 pm Pacific time on the specified day, month, and year. Depending on the time of year, Pacific time is either UTC-7 or UTC-8.Though dates typically represent a 24-hour period, dates when clocks are adjusted forward represent a 23-hour period, and dates when clocks are adjusted backward represent a 25-hour period. (Previously, the documentation stated that Pacific time was UTC-8 and did not mention the possibility that a day might not represent a 24-hour period.)
Note that this correction does not represent a change in actual API behavior.
The channel reports documentation has been updated to note that channel reports do not currently contain earnings or ad performance metrics. As a result, the
https://www.googleapis.com/auth/yt-analytics-monetary.readonlyscope does not currently grant access to monetary data in channel reports.- The
operatingSystemdimension supports three new dimension values:-
FIREFOX -
REALMEDIA -
TIZEN
-
8 февраля 2017 г.
The YouTube Analytics API now supports the optional include-historical-channel-data parameter. Note that this parameter is only relevant when retrieving content owner reports .
The parameter allows a content owner to indicate that an API response should include channels' watch time and view data from the time period prior to when the channels were linked to the content owner. The default parameter value is false , which means that, by default, the API response only includes watch time and view data from the time that channels were linked to the content owner.
These rules also apply if the API request retrieves data for multiple channels:
- If the parameter value is
false, then the watch time and views data returned for any given channel is based on the date that that channel was linked to the content owner.
It is important to remember that different channels might have been linked to a content owner on different dates. If the API request is retrieving data for multiple channels and the parameter value isfalse, then the API response contains watch time and view data based on the linking date for each respective channel. - If the parameter value is
true, then the response returns watch time and view data for all channels based on the start and end dates specified in the API request.
15 декабря 2016 г.
The following YouTube Reporting API reports are no longer supported and have been removed from the documentation. A newer version of each report is available. (The deprecation announcement for these reports was made on September 15, 2016.)
Channel reports
-
channel_basic_a1- Replaced by thechannel_basic_a2report. -
channel_province_a1- Replaced by thechannel_province_a2report. -
channel_playback_location_a1- Replaced by thechannel_playback_location_a2report. -
channel_traffic_source_a1- Replaced by thechannel_traffic_source_a2report. -
channel_device_os_a1- Replaced by thechannel_device_os_a2report. -
channel_subtitles_a1- Replaced by thechannel_subtitles_a2report. -
channel_combined_a1- Replaced by thechannel_combined_a2report.
-
Content owner reports
-
content_owner_basic_a2- Replaced by thecontent_owner_basic_a3report. -
content_owner_province_a1- Replaced by thecontent_owner_province_a2report. -
content_owner_playback_location_a1- Replaced by thecontent_owner_playback_location_a2report. -
content_owner_traffic_source_a1- Replaced by thecontent_owner_traffic_source_a2report. -
content_owner_device_os_a1- Replaced by thecontent_owner_device_os_a2report. -
content_owner_subtitles_a1- Replaced by thecontent_owner_subtitles_a2report. -
content_owner_combined_a1- Replaced by thecontent_owner_combined_a2report. -
content_owner_asset_basic_a1- Replaced by thecontent_owner_asset_basic_a2report. -
content_owner_asset_province_a1- Replaced by thecontent_owner_asset_province_a2report. -
content_owner_asset_playback_location_a1- Replaced by thecontent_owner_asset_playback_location_a2report. -
content_owner_asset_traffic_source_a1- Replaced by thecontent_owner_asset_traffic_source_a2report. -
content_owner_asset_device_os_a1- Replaced by thecontent_owner_asset_device_os_a2report. -
content_owner_asset_combined_a1- Replaced by thecontent_owner_asset_combined_a2report.
-
The list of current report types in the API reference documentation has also been updated.
11 ноября 2016 г.
This update contains the following changes:
The YouTube Reporting API supports three new end screen reports as well as new dimensions and metrics for those reports. The reports provide impression and click-through statistics for the end screens that display after a video stops playing.
End screen reports
- The end screen report for channel videos contains statistics for all of a channel's videos.
- The end screen report for content owner videos contains statistics for videos on any of a content owner's channels.
- The end screen report for content owner assets contains statistics for the assets associated with the videos after which the end screens display.
End screen dimensions
-
end_screen_element_type: The type of end screen element associated with the statistics. -
end_screen_element_id: The ID that YouTube uses to uniquely identify the end screen element.
-
End screen metrics
Note: Data for end screen metrics is available as of May 1, 2016.
-
end_screen_element_impressions: The total number of end screen element impressions. One impression is logged for each end screen element that displays. -
end_screen_element_clicks: The number of times that end screen elements were clicked. -
end_screen_element_click_rate: The click-through rate for end screen elements.
-
The following reports are no longer supported and have been removed from the documentation. A newer version of each report is available. (The deprecation announcement for these reports was made on June 22, 2016.)
-
content_owner_ad_performance_a1- Replaced by thecontent_owner_ad_rates_a1report. -
content_owner_estimated_earnings_a1- Replaced by thecontent_owner_estimated_revenue_a1report. -
content_owner_asset_estimated_earnings_a1- Replaced by thecontent_owner_asset_estimated_revenue_a1report.
-
The YouTube Help Center contains more detailed information about adding end screens to your videos .
8 ноября 2016 г.
This update contains the following changes to the YouTube Analytics API:
The metrics in the following list are fully deprecated and no longer supported. As announced on August 10, 2016, new metrics referring to the same data are already supported. The table below shows the deprecated metric name and the new metric name:
Deprecated metric New metric adEarningsestimatedAdRevenueimpressionBasedCpmcpmimpressionsadImpressionsredPartnerRevenueestimatedRedPartnerRevenue
October 27, 2016
YouTube now automatically generates a set of system-managed ad revenue reports for content owners that have access to the corresponding reports in the Reports section of YouTube's Creator Studio. The new system-managed API reports are designed to provide programmatic access to data that is also available in the manually downloadable Creator Studio reports.
The system-managed reports overview provides a brief overview of the new reports and explains the process for retrieving them via the API. This process is slightly different from that for retrieving bulk reports for YouTube Analytics since partners do not need to schedule jobs to generate the reports.
The reportType resource's id property has been updated to include a list of the system-managed reports that you can access via the API:
- Monthly, worldwide ad revenue per video
- Daily, per-country ad revenue per video
- Monthly, worldwide ad revenue per asset
- Daily, per-country ad revenue per asset
- Claims (this report does not contain revenue data)
27 сентября 2016 г.
Note: This is a deprecation announcement.
The YouTube Analytics API's uniques metric has been deprecated. This is not a core metric and it will be supported until October 31, 2016.
15 сентября 2016 г.
This update contains the following YouTube Reporting API changes:
The API supports two new metrics related to YouTube Red viewership:
-
red_views: The number of times that a video was viewed by YouTube Red members. -
red_watch_time_minutes: The number of minutes that YouTube Red members watched a video.
-
The API supports new versions of 20 reports. All of the new versions support the new
red_viewsandred_watch_time_minutesmetrics.For each report, the number in the new report type ID is one number higher than in the old report type ID. (The old versions of these reports are now deprecated as described later in this revision history.) For example, the
channel_basic_ a1report is now deprecated and has been replaced by thechannel_basic_ a2report.The following lists identify the new report type IDs:
Channel video reports
Content owner video reports
Content owner asset reports
Note: This is a deprecation announcement.
Note that if you already have jobs to create any of the older versions of the reports listed above, you need to create new jobs for the renamed reports. In conjunction with the release of the new report versions, the following report versions have been deprecated:
-
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
If you have jobs for any of those reports, you should not expect YouTube to generate new reports for those jobs after December 15, 2016. Generated reports will still be available for 180 days from the time they were generated.
-
19 августа 2016 г.
This update contains the following YouTube Reporting API change:
The
content_owner_basic_a1report has been fully deprecated and removed from the documentation. YouTube will no longer generate new reports of that type, though reports that were already generated will still be available for 180 days from the time they were generated.The
content_owner_basic_a1report's replacement is thecontent_owner_basic_a2report as explained in the revision history entry for May 19, 2016 .
11 августа 2016 г.
This update contains the following changes:
The newly published YouTube API Services Terms of Service ("the Updated Terms"), discussed in detail on the YouTube Engineering and Developers Blog , provides a rich set of updates to the current Terms of Service. In addition to the Updated Terms , which will go into effect as of February 10, 2017, this update includes several supporting documents to help explain the policies that developers must follow.
The full set of new documents is described in the revision history for the Updated Terms . In addition, future changes to the Updated Terms or to those supporting documents will also be explained in that revision history. You can subscribe to an RSS feed listing changes in that revision history from a link in that document.
10 августа 2016 г.
This update includes the following changes:
YouTube Analytics API (Targeted Queries)
Note: This is a deprecation announcement.
The metrics in the following table are being deprecated. At the same time, new metrics referring to the same data are being introduced. In effect, this means that the old metrics are being renamed, though the YouTube Analytics API will support both metric names until the deprecation dates listed in the table.
Old metric name New metric name Support date earningsestimatedRevenue10 августа 2017 г. adEarningsestimatedAdRevenue4 ноября 2016 г. redPartnerRevenueestimatedRedPartnerRevenue4 ноября 2016 г. impressionBasedCpmcpm4 ноября 2016 г. impressionsadImpressions4 ноября 2016 г. Note that the
earningsmetric was a core metric , so it will be supported for one year from the date of this announcement. The other metrics, which were not core metrics, will be supported for three months, until November 4, 2016.For example, until November 4, 2016, an API request can specify the
impressionBasedCpmmetric, thecpmmetric, or both. However, after that date, only thecpmmetric will be supported.- The
insightTrafficSourceTypedimension supports two new dimension values:-
CAMPAIGN_CARD: This traffic source is only supported for content owner reports . It indicates that the views originated from claimed, user-uploaded videos that the content owner used to promote the viewed content. -
END_SCREEN: The data pertains to views that originated from the endscreen of another video.
For both new traffic sources, you can also retrieve a
traffic source detailreport. In both cases, theinsightTrafficSourceDetaildimension identifies the video from which the viewer was referred. -
The
adTypedimension now supports the valueauctionBumperInstream, which refers to a non-skippable video ad of up to 6 seconds that plays before a video can be viewed.
YouTube Reporting API (Bulk Reports)
- The
traffic_source_typedimension now supports the following values:-
19: This traffic source is only supported for content owner reports . It indicates that the views originated from claimed, user-uploaded videos that the content owner used to promote the viewed content. -
20: The data pertains to views that originated from the endscreen of another video.
For both new traffic sources, the
traffic_source_detaildimension identifies the video from which the viewer was referred. -
The API's list of core metrics has been corrected to list
estimated_partner_revenueas a core metric and to remove theearningsfrom that list. (Theearningsmetric has never been supported in the YouTube Reporting API.)The
ad_typedimension now supports the value19that refers to bumper ads, which are non-skippable video ads of up to 6 seconds that play before a video can be viewed.
- The
18 июля 2016 г.
This update includes the following changes:
YouTube Analytics API (Targeted Queries)
- The lists of supported metrics for the following channel reports have been updated to include card metrics. Support for card metrics in these reports was actually added on June 28, 2016, and the revision history entry for that date explains the change in more detail. The reports are:
- Basic user activity for US states
- User activity in US states for specific time periods
- User activity by province
- User activity by subscribed status
- User activity by subscribed status for provinces
- Top videos by state
- Top videos for subscribed or unsubscribed viewers
The lists of filters have been corrected for both channel audience retention reports and content owner audience retention reports to reflect that the
videofilter is required and thegroupfilter is not supported.Previously, the documentation for both reports incorrectly stated that the report could be retrieved using one of those two filters or using neither filter.
- The lists of supported metrics for the following channel reports have been updated to include card metrics. Support for card metrics in these reports was actually added on June 28, 2016, and the revision history entry for that date explains the change in more detail. The reports are:
YouTube Reporting API (Bulk Reports)
- In the API overview , the section that explains how to retrieve a report's download URL has been corrected to state that YouTube does generate downloadable reports for days on which no data was available. Those reports contain a header row but do not contain additional data. This information had already been updated in the Report characteristics section of the same document on April 12, 2016 .
- The list of dimensions in the
content_owner_asset_cards_a1report has been corrected to reflect that the report uses thecard_iddimension. Previously, the documentation incorrectly listed the dimension name ascard_title.
28 июня 2016 г.
The YouTube Analytics API documentation has been updated to reflect support for card metrics in numerous channel and content owner reports. The newly supported metrics are:
The metrics are supported in the following types of reports:
- Basic stats( channels , content owners )
- Time-based( channels , content owners )
- User geography ( channels , content owners )
- User activity by subscribed status ( channels , content owners )
- Top videos ( channels , content owners )
22 июня 2016 г.
This update contains the following YouTube Reporting API changes. The first change pertains to the API in general, and the remaining changes only affect content owner reports :
The Report characteristics section of the API overview has been updated to clarify that reports are available via the API for 180 days from the time that they are generated.
Previously, the documentation stated that reports are available for a period of up to 180 days prior to the date that the API request is sent. While also technically true, the original text was, at best, rather confusing.
The API supports new versions of three reports. Two of those reports also contain new and renamed metrics:
The
content_owner_ad_rates_a1report is the new version of thecontent_owner_ad_performance_a1report. The newly renamed report is identical to the previous version.Two reports that have new versions have been renamed:
- The new version of the
content_owner_estimated_earnings_a1report is namedcontent_owner_estimated_revenue_a1. - The new version of the
content_owner_asset_estimated_earnings_a1report is namedcontent_owner_asset_estimated_revenue_a1.
Both newly renamed reports differ from their predecessors in the following ways:
- They add the new
estimated_partner_red_revenuemetric, which estimates the total earnings from YouTube Red subscriptions. - They add the new
estimated_partner_transaction_revenuemetric, which estimates revenue from transactions, such as paid content and Fan Funding, minus any partner-charged refunds. - They rename the
estimated_partner_ad_sense_revenuemetric toestimated_partner_ad_auction_revenue. - They rename the
estimated_partner_double_click_revenuemetric toestimated_partner_ad_reserved_revenue.
- The new version of the
Note that if you already have jobs to create any of the older versions of these reports, you need to create new jobs for the renamed reports. In conjunction with the release of the new report versions, the
content_owner_ad_performance_a1,content_owner_estimated_earnings_a1, andcontent_owner_asset_estimated_earnings_a1reports have been deprecated.If you have jobs for any of those reports, you should not expect YouTube to generate new reports for those jobs after September 22, 2016. Generated reports will still be available for 180 days from the time they were generated.
The definition of the
reportTyperesource'sidproperty has been updated to reflect the current set of available reports.The names of two metrics have been corrected in the documentation to match the names that appear in reports. This is purely a documentation fix and does not reflect a change in actual report contents:
- The
estimated_partner_adsense_revenuemetric's name has been updated toestimated_partner_ad_sense_revenue. Note, however, that this metric only appears in two reports that are being deprecated with this update. As described above, this metric has been renamedestimated_partner_ad_auction_revenuein newer versions of those reports. - The
estimated_partner_doubleclick_revenuemetric's name has been updated toestimated_partner_double_click_revenue. Again, note that this metric only appears in two reports that are being deprecated with this update. As described above, this metric has been renamedestimated_partner_ad_reserved_revenuein newer versions of those reports.
- The
The dimensions documentation for the Reporting API has been updated to no longer list the
elapsed_video_time_percentageandaudience_retention_typeproperties. These dimensions are not currently supported by any reports available through the API.
19 мая 2016 г.
This update contains the following YouTube Reporting API changes:
The API supports a new version of the user activity report for content owners . The report type ID for the new report is
content_owner_basic_a2. Unlike the previous version of the report,content_owner_basic_a1, the new version supports thelikesanddislikesmetrics.If you already have a job to create the
content_owner_basic_a1report, you still need to create a new job for thecontent_owner_basic_a2report. YouTube is not automatically migrating content owners to the new report version or automatically creating a job to generate the new report version. In some implementations, the appearance of a new, unexpected job could be a breaking change.In conjunction with the release of the new report, the
content_owner_basic_a1report has been deprecated . If you have a job for that report, you should not expect YouTube to generate new reports for that job after August 19, 2016. Generated reports will still be available for 180 days from the time they were generated.The
reportType,job, andreportresources all support a new property that identifies whether the associated resource represents a deprecated report type:The
reportTyperesource'sdeprecateTimeproperty specifies the date and time that the report type will be deprecated. This property only has a value for reports that have been announced as deprecated, and the value represents the date when YouTube will stop generating reports of that type.After a report type is announced as deprecated, YouTube generates reports of that type for another three months. For example, this update on May 19, 2016, announces the deprecation of the
content_owner_basic_a1report. Thus, thedeprecateTimefor that report type specifies a time on August 19, 2016, after which YouTube will stop generating reports of that type.The
jobresource'sexpireTimeproperty specifies the date and time that the job expired or will expire. This property has a value if the report type associated with the job has been deprecated or if reports generated for the job have not been downloaded for a prolonged period of time. The date marks the time after which YouTube no longer generates new reports for the job.The
reportresource'sjobExpireTimeproperty specifies the date and time that the job that is associated with the report either expired or will expire. This property contains the same value as theexpireTimeproperty in thejobresource, as described in the previous item in this list.
The
jobs.createmethod now returns a400HTTP response code (Bad Request) if you try to create a job for a deprecated report. In addition, the method's documentation now lists several other reasons that cause an API request to fail.
12 апреля 2016 г.
This update contains the following changes, all of which only affect the YouTube Reporting API:
YouTube now generates data covering the 180-day period prior to the time a reporting job was first scheduled. Previously, the Reporting API did not deliver any historical data. This change affects all jobs, including those created prior to this announcement.
Historical reports are posted as soon as they are available, though it takes roughly one month for all of the historical data to be posted for a job. So, a month after scheduling a reporting job, you will have access to around seven months of data. (All of the historical data for jobs created prior to this announcement should be posted within a month of the announcement.)
Note that historical data is only available as of July 1, 2015. As a result, jobs created before December 28, 2015, will have less than 180 days of historical data.
These change are all explained in the new historical data section of the Reporting API overview.
The report characteristics section of the YouTube Reporting API overview has been updated with the following changes:
The documentation now states that reports are available for a period of 180 days after they are generated and, therefore, available for API clients to download. Previously, the documentation stated that reports were available for a period of up to six months prior to the date that the API request is sent.
The documentation has been updated to reflect the fact that the API now generates downloadable reports for days on which no data was available. Those reports will contain header rows but will not contain additional data.
The YouTube Reporting API will soon support a set of automatically generated, system-managed reports that contain ad revenue data or YouTube Red subscription revenue data. The reports will be available to content owners who can already access manually downloadable revenue reports in the YouTube Creator Studio . Thus, the new API functionality will provide programmatic access to that data.
The following API changes are being announced now in preparation for the launch of system-managed reports:
The
jobresource's newsystemManagedproperty indicates whether the resource describes a job that generates system-managed reports. YouTube automatically generates system-managed reports for YouTube content owners, and content owners cannot modify or delete jobs that create those reports.The
jobs.listmethod's newincludeSystemManagedparameter indicates whether the API response should include jobs for system-managed reports. The parameter's default value isfalse.The
jobs.reports.listmethod's newstartTimeAtOrAfterparameter indicates that the API response should only contain reports if the earliest data in the report is on or after the specified date. Similarly, thestartTimeBeforeparameter indicates that the API response should only contain reports if the earliest data in the report is before the specified date.Unlike the method's
createdAfterparameter, which pertains to the time that the report was created, the new parameters pertain to the data in the report.The
reportTyperesource's newsystemManagedproperty indicates whether the resource describes a system-managed report.The
reportTypes.listmethod's newincludeSystemManagedparameter indicates whether the API response should include system-managed reports. The parameter's default value isfalse.
28 марта 2016 г.
The YouTube Reporting API and YouTube Analytics API now return view statistics for several additional sharing services.
- In the YouTube Reporting API, the
sharing_servicedimension supports these new values:-
82: iOS system activity dialog -
83: Google Inbox -
84: Android Messenger
-
- In the YouTube Analytics API, the
sharingServicedimension supports these new values:-
ANDROID_MESSENGER: Android Messenger -
INBOX: Google Inbox -
IOS_SYSTEM_ACTIVITY_DIALOG: iOS system activity dialog
-
16 марта 2016 г.
This update contains the following changes, which affect both the YouTube Reporting API and the YouTube Analytics API:
API для создания отчетов на YouTube
- The
playback_location_typedimension supports two new dimension values:-
7: 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. -
8: The data pertains to views that took place directly on the YouTube search results page.
-
- The
traffic_source_typedimension now supports18as 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 source type14, which indicates that the views occurred while the video was being played as part of a playlist.
API аналитики YouTube
- The
insightPlaybackLocationTypedimension 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
insightTrafficSourceTypedimension now supportsYT_PLAYLIST_PAGEas 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 thePLAYLISTsource type, which indicates that the views occurred while the video was being played as part of a playlist.
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.
- In the YouTube Reporting API, the
operating_systemdimension uses the value21to identify views that take place via Chromecast. - In the YouTube Analytics API, the
operatingSystemdimension uses the valueCHROMECASTto identify views that take place via Chromecast.
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 .
15 декабря 2015 г.
This update contains the following changes, all of which affect the YouTube Analytics API:
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 Показатели: 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
videofilter 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.insertmethod now returns an unauthorized (403HTTP 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.listmethod now supports pagination. If the API response does not contain all available groups, then the response'snextPageTokenparameter specifies a token that can be used to retrieve the next page of results. Set the method'spageTokenparameter to that value to retrieve additional results.
10 ноября 2015 г.
This update contains the following changes:
The YouTube Analytics API now supports the
redPartnerRevenuemetric, 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
redPartnerRevenuemetric:- Basic stats
- Time-based
- User geography
- Top videos – For this report,
redPartnerRevenueis 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.
29 октября 2015 г.
This update contains the following changes:
The documentation for the YouTube Reporting API's
datedimension 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 thecreatedAfterquery 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
createdAfterparameter to avoid repeatedly processing the same report.The definitions of the
jobresource'screateTimeproperty and thereportresource'sstartTime,endTime, andcreateTimeproperties 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.
8 октября 2015 г.
This update contains the following changes:
The documentation for the YouTube Analytics API's
sharingServicedimension 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_servicedimension's definition has also been updated to list the newly supported values. The enum values that are greater than59are the new ones in the list.
24 сентября 2015 г.
This update contains the following changes:
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.
20 августа 2015 г.
This update contains the following changes:
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.querymethod, 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.
22 июля 2015 г.
This update contains several changes, all of which only apply to content owners:
The new
adEarningsmetric includes total estimated earnings (net revenue) from all Google-sold advertising sources. It is not a core metric. The API supports theadEarningsmetric for any report that already supported theearningsmetric.In addition, the definition of the
earningsmetric 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
primaryAdGrossRevenuemetric has been deprecated. Instead, use thegrossRevenuemetric to retrieve revenue data.In addition to the deprecated
primaryAdGrossRevenuemetric, ad performance reports no longer support themonetizedPlaybacksandplaybackBasedCpmmetrics. However, several video reports do still support those metrics.
1 июня 2015 г.
This update contains the following changes:
The API now supports two new metrics for video reports,
videosAddedToPlaylistsandvideosRemovedFromPlaylists. 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.
-
31 марта 2015 г.
This update contains the following changes:
The
favoritesAddedandfavoritesRemovedmetrics 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 .
16 марта 2015 г.
This update contains the following changes:
The new
currencyparameter 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, andimpressionBasedCpmmetrics 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.
25 февраля 2015 г.
This update contains the following changes:
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
groupandgroupItemresources for creating and managing groups.- The
groupresource represents an Analytics group, a custom collection of up to 200 channels, videos, playlists, or assets. The API supportslist,insert,update, anddeletemethods for this resource. - The
groupItemresource represents an item in an Analytics group. The API supportslist,insert, anddeletemethods for this resource.
So, for example, you could create a group using the
groups.insertmethod and then add items to that group using thegroupItems.insertmethod.- The
Retrieving report data for a group
The dimensions documentation has been updated to include the
groupdimension, which can be used as a filter for many channel reports and content owner reports . When you use thegroupfilter, 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.
13 февраля 2015 г.
This update contains the following changes:
The API no longer supports the
showdimension.
28 августа 2014 г.
This update contains the following changes:
The API now supports the ability to specify multiple values for the
video,playlist,channel, andshowdimensions when those dimensions are used as filters . To specify multiple values, set thefiltersparameter 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
filtersparameter definition for complete details about this functionality.
16 июля 2014 г.
This update contains the following changes:
When retrieving a channel report, you can now retrieve data for the authenticated user's channel by setting the value of the
idsparameter tochannel==MINE. (You can also still set theidsparameter tochannel== CHANNEL_IDto 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
viewsandestimatedMinutesWatchedmetrics, and some also support theaverageViewDurationmetric.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
isCuratedfilter, 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
elapsedVideoTimeRatiodimension measures the amount of the video that has elapsed for the corresponding metric values:The
audienceWatchRatiometric 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
relativeRetentionPerformancemetric 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
audienceTypefilter 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
annotationClickThroughRateandannotationCloseRatemetrics.-
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
annotationClickThroughRateandannotationCloseRatemetrics is available as of June 10, 2012.)-
GOOGLE_SEARCHis no longer reported as a separate value for theinsightTrafficSourceTypedimension. Instead, referrals from Google search results are now attributed to theEXT_URLtraffic source type. As a result, it's also no longer possible to retrieve aninsightTrafficSourceDetailreport that sets theinsightTrafficSourceTypefilter toGOOGLE_SEARCH.
31 января 2014 г.
This update contains the following changes:
The content owner reports document has been updated to reflect that the
subscribersGainedandsubscribersLostmetrics 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
claimedStatusanduploaderTypefilters.
16 января 2014 г.
This update contains the following changes:
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
- Географический
- Место воспроизведения
- Traffic source
- Device/OS
- Демографические данные
- Социальный
- 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
provincedimension, and also uses thefiltersparameter 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
filtersparameter to ensure the response only includes data for a particular province.
The definition of the
provincedimension has been updated to note that whenprovinceis included in thedimensionsparameter value, the request must also restrict data to the United States by includingcountry==USin thefiltersparameter value.
6 января 2014 г.
This update contains the following changes:
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
- Географический
- Место воспроизведения
- Traffic source
- Device/OS
- Демографические данные
- Социальный
- Лучшие видео
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
provincedimension 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
filtersquery 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
continentdimension specifies a United Nations (UN) statistical region code that identifies a continent. This dimension can only be used as a filter .The
subContinentdimension 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
continentfilter when you are using thesubContinentfilter. (In fact, the API will return an error if a request uses both dimensions.)
The documentation has been corrected so that the
insightTrafficSourceDetaildimension does not include theinsightTrafficSourceTypevaluePROMOTEDas a valid filter value.
30 сентября 2013 г.
This update contains the following changes:
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_APPas a value for theinsightPlaybackLocationTypedimension. In conjunction with this update, as of September 10, 2013, playbacks are no longer categorized asMOBILEplaybacks, 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_APPplaybacks, depending on the type of application where the playbacks occur.The API now supports
PLAYLISTas a value for theinsightTrafficSourceTypedimension. The value indicates that video views were referred from a playlist. Previously, these views would have been classified using the dimension'sYT_OTHER_PAGEcategory.
16 июля 2013 г.
This update contains the following changes:
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
sortparameter 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,
deviceTypeandoperatingSystem, 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
deviceTypereport lets you retrieve view counts and estimated watch time for different types of devices, including desktop, mobile, and tablet devices. You can also use theoperatingSystemfilter to restrict the device type report to only contain statistics for devices running a specific operating system, such as Android or iOS .The
operatingSystemreport lets you retrieve view counts and estimated watch time for different operating systems, such as Android, iOS, Linux, and more. You can also use thedeviceTypefilter 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
insightPlaybackLocationTypedimension may return the valueYT_OTHER, which identifies views that are not classified using one of the dimension's other values.
23 мая 2013 г.
This update contains the following changes:
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.
May 10, 2013
This update contains the following changes:
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 .
May 6, 2013
This update contains the following changes:
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
insightPlaybackLocationDetailandinsightTrafficSourceDetaildimensions have been enhanced in the following ways:They now support an optional
countryfilter.Content owners can now retrieve these reports using any of the following new
filtercombinations. Note that all of these combinations also support the optionalcountryfilter.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
-
3 мая 2013 г.
This update contains the following changes:
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
insightTrafficSourceTypedimension now supportsSUBSCRIBERas 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, theinsightTrafficSourceDetailfield will specify the homepage feed or other page from which views were referred.
28 марта 2013 г.
This update contains the following changes:
The API now supports two new metrics,
annotationClickThroughRateandannotationCloseRate, 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.
-
21 марта 2013 г.
This update contains the following changes:
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.readonlyscope.
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 .
4 февраля 2013 г.
This update contains the following changes:
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.
14 ноября 2012 г.
This update contains the following changes:
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.
2 октября 2012 г.
This update contains the following changes:
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 .
12 сентября 2012 г.
This update contains the following changes:
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 theclaimedStatusanduploaderTypedimensions.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
subscribersGainedandsubscribersLostmetrics 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.