лист регистраций изменений

На этой странице перечислены изменения API и обновления документации для API отчетов YouTube и API YouTube Analytics. Оба API позволяют разработчикам получать доступ к данным YouTube Analytics, хотя и разными способами. Подпишитесь на этот список изменений . Подписаться

15 декабря 2022 г.

API YouTube Analytics (Targeted Queries) поддерживает два новых параметра и один новый отчет:

  • В новом отчете представлена ​​активность пользователей по городам. Этот отчет доступен для владельцев каналов и контента. Этот отчет содержит новый параметр city , который определяет оценку YouTube города, в котором происходили действия пользователя.

  • Новый параметр creatorContentType определяет тип контента YouTube, который связан с показателями действий пользователей в строке данных. Поддерживаемые значения: LIVE_STREAM , SHORTS , STORY и VIDEO_ON_DEMAND .

    Измерение creatorContentType поддерживается в качестве дополнительного измерения для всех видеоотчетов о каналах и владельцах контента.

  • Руководство по примерам запросов API YouTube Analytics теперь включает примеры для обоих новых параметров.

  • Ссылки на измерения 7DayTotals и 30DayTotals были удалены из документации. Об устаревании этих размеров было объявлено в октябре 2019 года.

26 августа 2022 г.

API YouTube Analytics (Targeted Queries) и API YouTube Reporting (Bulk Reports) поддерживают новое значение детализации источника трафика:

  • В API YouTube Analytics (Targeted Queries) API, если значение измерения insightTrafficSourceType равно SUBSCRIBER , тогда значение insightTrafficSourceDetail может быть установлено на podcasts , что указывает на то, что трафик был направлен с целевой страницы подкастов.
  • В API отчетов YouTube (массовые отчеты), если значение параметра traffic_source_type равно 3 , значение traffic_source_detail может быть установлено на podcasts , что указывает на то, что трафик был передан с целевой страницы подкастов.

11 февраля 2022 г.

Набор допустимых значений для gender параметра изменится 11 августа 2022 г. или позднее. Это может быть несовместимым с предыдущими изменениями в реализации API. В соответствии с разделом «Изменения, несовместимые с предыдущими версиями » Условий использования API-сервисов YouTube, об этом изменении объявляется за шесть месяцев до того, как оно вступит в силу. Обновите реализацию API до 11 августа 2022 г., чтобы обеспечить плавный переход на новый набор значений.

Конкретные изменения вносятся:

  • В API YouTube Analytics (Targeted Queries) параметр 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 (массовые отчеты).

2 февраля 2022 г.

Этот API отчетов YouTube (массовые отчеты) поддерживает новое значение параметра источника трафика, указывающее, что просмотры были получены с помощью Live Redirects :

  • В API отчетов YouTube (массовые отчеты) параметр traffic_source_type поддерживает значение 28 .

Для этого типа источника трафика измерение traffic_source_detail указывает идентификатор канала, с которого был направлен зритель.

23 сентября 2020 г.

Этот API YouTube Analytics (Targeted Queries) и API YouTube Reporting (Bulk Reports) API поддерживают новое значение параметра источника трафика, которое указывает, что зритель был перенаправлен, проведя пальцем по вертикали при просмотре YouTube Shorts:

  • В API YouTube Analytics (Targeted Queries) API параметр insightTrafficSourceType поддерживает значение SHORTS .
  • В API отчетов YouTube (массовые отчеты) параметр traffic_source_type поддерживает значение 24 .

Параметр сведений об источнике трафика — insightTrafficSourceDetail в API YouTube Analytics или traffic_source_detail в API отчетов YouTube — не заполняется для этого нового типа источника трафика.

20 июля 2020 г.

Это обновление охватывает два изменения, влияющие на API YouTube Analytics (Targeted Queries):

  • Максимальный размер группы отчетности YouTube Analytics увеличился с 200 до 500 объектов.
  • Параметр filters метода reports.query определяет список фильтров, которые следует применять при получении данных YouTube Analytics. Параметр поддерживает возможность указывать несколько значений для фильтров video , playlist и channel , а максимальное количество идентификаторов, которые можно указать для этих фильтров, увеличено с 200 до 500 идентификаторов.

13 февраля 2020 г.

Это обновление содержит следующие изменения, связанные с API YouTube Analytics (целевые запросы) и API отчетов YouTube (массовые отчеты). Вы можете узнать больше об этих изменениях в Справочном центре YouTube .

В обоих API меняется набор возможных значений детализации источника трафика для уведомлений. В целевых запросах уведомления отображаются как insightTrafficSourceType=NOTIFICATION . В массовых отчетах уведомления отображаются как traffic_source_type=17 .

Новые значения разделяют уведомления, связанные с загруженными видео и прямыми трансляциями, которые ранее считались uploaded , на две категории:

  • uploaded_push — просмотры, полученные из push-уведомлений, отправленных подписчикам при загрузке видео.
  • uploaded_other — просмотры, полученные из не-push-уведомлений, таких как электронные письма или уведомления из папки «Входящие», отправленные подписчикам при загрузке видео.

Эти значения возвращаются для диапазона времени, начиная с 13 января 2020 г. (13 января 2020 г.).

Кроме того, напоминаем, что эти значения представляют не сами уведомления, а источники трафика, которые привели к определенным просмотрам на YouTube. Например, если в строке отчета указано views=3 , traffic_source_type=17 ( NOTIFICATION ) и traffic_source_detail=uploaded_push , в строке указано, что зрители нажимали на push-уведомления, отправленные при загрузке видео, три просмотра.

15 октября 2019 г.

Это обновление содержит следующие изменения, связанные с API YouTube Analytics (целевые запросы):

  • Примечание. Это объявление об устаревании.

    YouTube прекращает поддержку параметров 7DayTotals и 30DayTotals . Вы по-прежнему можете получать данные с использованием этих параметров до 15 апреля 2020 г. В эту дату или позже попытки получить отчеты с использованием параметров 7DayTotals или 30DayTotals вернут ошибку.

    Обратите внимание, что пользователи могут воспроизвести некоторые данные для этих измерений, запросив их с использованием измерения day и агрегируя или получая данные за семи- или 30-дневные периоды. Например:

    • Количество просмотров за семидневный период можно рассчитать путем суммирования количества просмотров за каждый день этого периода.
    • ViewerPercentage за семидневный период можно рассчитать, умножив количество просмотров, которые происходили каждый день, на viewerPercentage за этот день, чтобы получить количество зрителей, которые вошли в систему при просмотре видео в этот день. Затем можно добавить количество зарегистрированных зрителей за весь период и разделить на общее количество просмотров за этот период, чтобы получить viewerPercentage за весь период.
    • Количество уникальных зрителей за семидневный период рассчитать невозможно, так как один и тот же зритель может быть рассчитан как уникальный зритель в разные дни. Однако вы можете использовать измерение month вместо измерения 30DayTotals для экстраполяции данных о количестве уникальных зрителей за 30-дневный период. Обратите внимание, что измерение month относится к календарным месяцам, тогда как измерение 30DayTotals вычисляет 30-дневные периоды на основе указанной даты начала и окончания.

27 июня 2019 г.

Это обновление содержит следующие изменения, связанные с API YouTube Analytics (целевые запросы):

  • Поскольку версия 1 API теперь полностью устарела, документация была обновлена, чтобы удалить ссылки на эту версию, включая уведомление об устаревании и руководство по миграции, объясняющее, как выполнить обновление до версии 2.

1 ноября 2018 г.

Это обновление содержит следующие изменения, связанные с API YouTube Analytics (целевые запросы):

  • Версия 1 API устарела. Если вы еще этого не сделали, как можно скорее обновите свои клиенты API, чтобы использовать версию 2 API, чтобы свести к минимуму перебои в обслуживании. Дополнительные сведения см. в руководстве по миграции .

    Обратите внимание, что график прекращения поддержки был первоначально объявлен 26 апреля 2018 года .

17 сентября 2018 г.

Это обновление содержит следующие изменения, связанные с API YouTube Analytics (целевые запросы):

  • В новом разделе анонимизации данных в обзорном документе модели данных объясняется, что некоторые данные YouTube Analytics ограничены, когда показатели не соответствуют определенному порогу. Это может произойти в самых разных случаях. На практике это означает, что отчет может содержать не все (или некоторые) ваши данные, если:

    1. видео или канал имеет ограниченный трафик в течение определенного периода времени,

      или

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

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

  • Документы отчетов по каналам и владельцев контента были обновлены, чтобы отразить тот факт, что метрики redViews и estimatedRedMinutesWatched больше не поддерживаются для отчетов о местоположении воспроизведения, источнике трафика и типе устройства/операционной системе.

18 июня 2018 г.

Это обновление содержит следующие изменения в API YouTube Analytics (целевые запросы):

  • Изменились требования к области для следующих методов:
    • Запросы к методу reports.query должны иметь доступ к области https://www.googleapis.com/auth/youtube.readonly .
    • Запросы к методу groupItems.list должны иметь доступ к:
      • область https://www.googleapis.com/auth/youtube
        или
      • область https://www.googleapis.com/auth/youtube.readonly
        и
        область https://www.googleapis.com/auth/yt-analytics.readonly

      В первом варианте используется одна область, которая является областью чтения-записи, а во втором варианте используются две области только для чтения.

23 мая 2018 г.

Это обновление содержит следующие изменения в API YouTube Analytics (целевые запросы):

  • Обзор API содержит новый раздел, сводные показатели и удаленные элементы , в котором объясняется, как ответы API обрабатывают данные, связанные с удаленными ресурсами, такими как видео, плейлисты или каналы.
  • Раздел с рекомендациями в обзоре API был обновлен, чтобы напомнить вам, что вы можете использовать API данных YouTube для получения дополнительных метаданных для ресурсов, указанных в ответах API YouTube Analytics. Как указано в Политике разработчиков служб API YouTube (разделы с III.E.4.b по III.E.4.d), клиенты API должны либо удалить, либо обновить сохраненные метаданные ресурсов из этого API через 30 дней.

22 мая 2018 г.

Это обновление содержит следующие изменения, связанные с API отчетов YouTube (массовые отчеты):

  • Следующие изменения должны вступить в силу в июле 2018 г., а новые политики применяются глобально ко всем отчетам и заданиям создания отчетов.

    • После внесения изменений большинство отчетов API, включая отчеты об обратной засыпке, будут доступны в течение 60 дней с момента их создания. Однако отчеты, содержащие исторические данные, будут доступны в течение 30 дней с момента их создания.

      До этого объявления все отчеты API были доступны в течение 180 дней с момента их создания. Чтобы было ясно, когда это изменение политики вступит в силу, отчеты с историческими данными, которым более 30 дней, также больше не будут доступны через API. Все остальные отчеты старше 60 дней также будут недоступны. Таким образом, в документации теперь указано, что отчеты, созданные до изменения политики, будут доступны в течение 180 дней.

    • После изменения, когда вы запланируете отчетное задание, YouTube будет создавать отчеты с этого дня вперед и охватывать 30-дневный период до времени, когда задание было запланировано. До внесения изменений, когда вы планируете отчетное задание, YouTube будет генерировать отчеты за период в 180 дней до времени, когда задание было запланировано.

  • Раздел с рекомендациями был обновлен, чтобы напомнить вам, что вы можете использовать API данных YouTube для получения дополнительных метаданных для ресурсов, указанных в отчетах. Как указано в Политике разработчиков служб API YouTube (разделы с III.E.4.b по III.E.4.d), клиенты API должны либо удалить, либо обновить сохраненные метаданные ресурсов из этого API через 30 дней.

  • В разделе «Характеристики отчета» указано, что, хотя данные отчета не фильтруются, отчеты, содержащие данные за период времени, начиная с 1 июня 2018 г., не будут содержать ссылок на ресурсы YouTube, которые были удалены не менее чем за 30 дней до этого. на дату составления отчета.

  • Раздел исторических данных в обзоре API был обновлен, чтобы отметить, что при планировании нового задания отчетов исторические отчеты обычно публикуются в течение нескольких дней. Ранее в документации указывалось, что предоставление таких отчетов может занять до 30 дней.

  • Раздел данных обратной засыпки в обзоре API был обновлен, чтобы более четко определить данные обратной засыпки как набор данных, который заменяет ранее доставленный набор.

26 апреля 2018 г.

Версия 2 API YouTube Analytics (Targeted Queries) (v2) теперь общедоступна. В следующем списке указаны изменения продукта и документации, связанные с новой версией API:

  • API v2 почти идентичен API v1. Однако вам, вероятно, потребуется обновить код, чтобы отразить перечисленные ниже изменения. Все эти изменения подробно описаны в новом руководстве по миграции .

    • Версия API изменилась с v1 на v2 .
    • Базовый URL-адрес для запросов API изменился с https://www.googleapis.com/youtube/analytics/v1 на https://youtubeanalytics.googleapis.com/v2 .
    • У нескольких параметров метода reports.query обновлены имена. В частности, имена параметров, которые содержат дефисы, такие как end-date в API версии 1, используют верблюжий регистр ( endDate ), а не дефисы в API версии 2. Это изменение делает имена параметров согласованными во всем API, поскольку в методах API для создания групп и управления ими уже используется верблюжий регистр для имен параметров.
    • API v2 не поддерживает пакетные запросы, отправляемые на глобальную конечную точку пакета HTTP Google ( www.googleapis.com/batch ). Если вы отправляете пакетные запросы в API версии 2, вместо этого вам нужно использовать конечную точку https://youtubeanalytics.googleapis.com/v2 .

    Кроме того, некоторые функции v1 не поддерживаются в v2 API:

    • Метод reports.query больше не поддерживает параметры запроса alt , quotaUser и userIp .
    • API v2 не предоставляет конечную точку пакета, которая поддерживает пакеты, состоящие из запросов к различным API. (Однако пакет может состоять из запросов к различным методам одного и того же API.) Это устаревание не относится к API YouTube Analytics, поскольку Google прекращает поддержку глобальной конечной точки пакета во всех своих API.
    • API v2 не поддерживает протокол JSON-RPC, который поддерживался в API v1. Опять же, это устаревание не относится к API YouTube Analytics.

  • Примечание. Это объявление об устаревании.

    Версия 1 API (v1) устарела и будет поддерживаться до 31 октября 2018 г. Все запросы к API v1 перестанут работать после этой даты. Поэтому обязательно обновите API до версии 2 не позднее 31 октября 2018 года, чтобы не прерывать доступ к данным YouTube Analytics через API.

21 февраля 2018 г.

Это обновление содержит следующие изменения в API YouTube Analytics (целевые запросы):

  • Демографические отчеты о зрителях, которые объединяют статистику просмотров на основе возрастной группы и пола зрителей, больше не поддерживают параметр youtubeProduct , который идентифицирует сервис YouTube, в котором произошло действие пользователя.

18 января 2018 г.

Это обновление содержит следующие изменения:

  • API отчетов YouTube (массовые отчеты)

    • Измерение operating_system , определяющее программную систему устройства, на котором происходили представления, теперь поддерживает следующее значение:
      • 25 : КайОС

  • API YouTube Analytics (целевые запросы)

    • Измерение operatingSystem поддерживает значение измерения KAIOS .

20 декабря 2017 г.

Это обновление содержит два изменения, связанные с API отчетов YouTube:

  • Сервер API теперь поддерживает сжатие gzip для запросов на загрузку отчетов. Обратите внимание, что сжатие gzip не поддерживается для других типов запросов API. Включение сжатия gzip снижает пропускную способность, необходимую для каждого ответа API. И хотя вашему приложению потребуется дополнительное процессорное время для распаковки ответов API, выгода от использования меньшего количества сетевых ресурсов обычно перевешивает эти затраты.

    Чтобы получить ответ в кодировке gzip, установите для заголовка HTTP-запроса Accept-Encoding gzip , как показано в следующем примере:

    Accept-Encoding: gzip

    Эта функциональность объясняется в обзоре API и в определении свойства downloadUrl ресурса report .

  • Документация параметров age group и gender была исправлена, чтобы показать фактические значения, которые API возвращает для этих параметров. Обратите внимание, что это исправление документации и не отражает изменения в функциональности или поведении API. В частности, изменились следующие значения:

    • Значения параметра age_group используют прописные буквы, содержат символы подчеркивания между словом AGE и числами в возрастной группе и используют символы подчеркивания вместо дефисов. Таким образом, такие значения, как age13-17 и age18-24 были скорректированы на AGE_13_17 и AGE_18_24 соответственно.
    • В значениях gender параметра используются прописные буквы. Таким образом, значения female , male , и gender_other были скорректированы на FEMALE , MALE и GENDER_OTHER .

10 августа 2017 г.

10 августа 2016 г. в этой документации было объявлено о прекращении поддержки показателя earnings API YouTube Analytics. (В то же время в API добавлена ​​поддержка новой метрики под названием estimatedRevenue , которая предоставляет те же данные.)

Поскольку метрика earnings была основной метрикой, она поддерживалась в течение одного года с даты объявления. Однако теперь, когда этот годовой период закончился, показатель earnings больше не поддерживается. В результате запросы API, в которых указана метрика earnings , теперь возвращают код ответа HTTP 400 . Если вы еще не обновили свое приложение, чтобы использовать показатель estimatedRevenue вместо показателя earnings , сделайте это как можно скорее.

Документация API была обновлена, чтобы удалить оставшиеся ссылки на показатель earnings .

6 июля 2017 г.

Это обновление содержит следующие изменения:

  • API YouTube Analytics (целевые запросы)

    • Документация API была обновлена, чтобы отразить тот факт, что ответы API содержат данные до последнего дня в запрошенном диапазоне дат, для которого доступны все запрашиваемые показатели.

      Например, если в запросе указана дата окончания 5 июля 2017 г., а значения всех запрошенных показателей доступны только до 3 июля 2017 г., это будет последняя дата, для которой данные включены в ответ. (Это верно, даже если данные по некоторым запрошенным показателям доступны на 4 июля 2017 г.)

    • Измерение adType теперь поддерживает значение, reservedBumperInstream , которое относится к видеообъявлению без возможности пропуска продолжительностью до 6 секунд, которое воспроизводится перед просмотром видео. Формат объявления идентичен объявлению с auctionBumperInstream , но этот тип относится к объявлениям, продаваемым на основе резервирования, а не на основе аукциона.

  • API отчетов YouTube (массовые отчеты)

    • Параметр ad_type теперь поддерживает значение 20 , которое относится к рекламным объявлениям-заставкам, продаваемым по предварительному заказу. Объявления-заставки — это видеообъявления продолжительностью до 6 секунд без возможности пропуска, которые воспроизводятся перед просмотром видео. Обратите внимание, что значение 19 для этого параметра также относится к объявлениям-заставкам, которые продаются на аукционе , а не по предварительному заказу.

    • Удалены задания отчетов для следующих отчетов YouTube Reporting API:

      • channel_basic_a1
      • channel_province_a1
      • channel_playback_location_a1
      • channel_traffic_source_a1
      • channel_device_os_a1
      • channel_subtitles_a1
      • channel_combined_a1
      • content_owner_basic_a2
      • content_owner_province_a1
      • content_owner_playback_location_a1
      • content_owner_traffic_source_a1
      • content_owner_device_os_a1
      • content_owner_subtitles_a1
      • content_owner_combined_a1
      • content_owner_asset_basic_a1
      • content_owner_asset_province_a1
      • content_owner_asset_playback_location_a1
      • content_owner_asset_traffic_source_a1
      • content_owner_asset_device_os_a1
      • content_owner_asset_combined_a1

      Эти типы отчетов были объявлены устаревшими 15 сентября 2016 г. , и после 15 декабря 2016 г. отчеты для этих типов отчетов больше не создавались. Ранее созданные отчеты по-прежнему были доступны в течение 180 дней с момента их создания. Таким образом, некоторые отчеты были доступны только 15 июня 2017 г. Однако, поскольку отчеты больше не доступны, задания, связанные с отчетами, также не нужны.

24 мая 2017 г.

Все задания отчетов для следующих отчетов YouTube Reporting API были удалены:

  • content_owner_ad_performance_a1
  • content_owner_asset_estimated_earnings_a1
  • content_owner_estimated_earnings_a1

Эти типы отчетов были объявлены устаревшими 22 июня 2016 г. , и после 22 сентября 2016 г. отчеты для этих типов отчетов больше не создавались. Ранее созданные отчеты по-прежнему были доступны в течение 180 дней с момента их создания. Таким образом, некоторые отчеты были доступны только 22 марта 2017 г. Однако, поскольку отчеты больше не доступны, задания, связанные с отчетами, также не нужны.

22 мая 2017 г.

Это обновление содержит следующие изменения:

  • API отчетов YouTube (массовые отчеты)

    • Параметр sharing_service , определяющий сервис, который использовался для обмена видео, теперь поддерживает следующие значения:

      • 85 : Музыка на YouTube
      • 86 : Игры на YouTube
      • 87 : Детский YouTube
      • 88 : Ютуб ТВ

      Кроме того, имя, используемое для идентификации значения 52 было обновлено в документации на Kakao (Kakao Talk) , чтобы более четко отличать его от значения 73 (Kakao Story). Это изменение не отражает каких-либо изменений в поведении API или классификации видео, передаваемых этим службам.

  • API YouTube Analytics (целевые запросы)

    • Измерение sharingService теперь поддерживает следующие значения:

      • YOUTUBE_GAMING
      • YOUTUBE_KIDS
      • YOUTUBE_MUSIC
      • YOUTUBE_TV

28 марта 2017 г.

Владельцы каналов, которые могут получить доступ к данным о доходах через YouTube Analytics в Creator Studio, теперь также могут получить доступ к этим данным о доходах через API YouTube Analytics:

17 марта 2017 г.

Это обновление содержит следующие изменения:

  • API YouTube Analytics поддерживает показатели redViews и estimatedRedMinutesWatched , оба из которых относятся к просмотру YouTube Red. На самом деле API уже некоторое время поддерживает эти метрики, а YouTube Reporting API уже поддерживает обе метрики, как было объявлено 15 сентября 2016 года .

    • Метрика redViews определяет, сколько раз видео было просмотрено участниками YouTube Red.
    • estimatedRedMinutesWatched метрика RedMinutesWatched определяет количество минут, в течение которых участники YouTube Red смотрели видео.

    Отчеты по каналам и отчеты владельцев контента были обновлены, чтобы показать, какие отчеты поддерживают две новые метрики. Они поддерживаются во всех отчетах, в которых уже поддерживаются views и показатели estimatedMinutesWatched .

3 марта 2017 г.

Это обновление содержит следующие изменения:

  • API отчетов YouTube (массовые отчеты)

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

      Хотя даты обычно представляют собой 24-часовой период, даты, когда часы переводятся вперед, представляют собой 23-часовой период, а даты, когда часы переводятся назад, представляют собой 25-часовой период. (Ранее в документации указывалось, что каждая дата представляет собой уникальный 24-часовой период и что тихоокеанское время всегда было UTC-8.)

      Обратите внимание, что это исправление не представляет собой изменение фактического поведения API.

    • Измерение operating_system , определяющее программную систему устройства, на котором происходили представления, теперь поддерживает следующие значения:
      • 22 : Тизен
      • 23 : Фаерфокс
      • 24 : РеалМедиа

    • Все задания отчетов для типа отчета content_owner_basic_a1 удалены. Этот тип отчета полностью устарел с 19 августа 2016 г. , но ранее созданные отчеты content_owner_basic_a1 по-прежнему были доступны в течение 180 дней с момента их создания. Таким образом, некоторые отчеты были доступны только 19 февраля 2017 г. Однако, поскольку отчеты больше не доступны, задания, связанные с отчетами, также не нужны.

  • API YouTube Analytics (целевые запросы)

    • Описание измерений, связанных с time periods было исправлено, чтобы отметить, что значение измерения относится к периоду, начинающемуся в 00:00 по тихоокеанскому времени и заканчивающемуся в 23:59 по тихоокеанскому времени в указанный день, месяц и год. В зависимости от времени года тихоокеанское время либо UTC-7, либо UTC-8.

      Хотя даты обычно представляют собой 24-часовой период, даты, когда часы переводятся вперед, представляют собой 23-часовой период, а даты, когда часы переводятся назад, представляют собой 25-часовой период. (Ранее в документации указывалось, что тихоокеанское время — UTC-8, и не упоминалась возможность того, что день может не соответствовать 24-часовому периоду.)

      Обратите внимание, что это исправление не представляет собой изменение фактического поведения API.

    • Документация по отчетам по каналам была обновлена, чтобы отметить, что отчеты по каналам в настоящее время не содержат показателей доходов или эффективности рекламы. В результате область https://www.googleapis.com/auth/yt-analytics-monetary.readonly в настоящее время не предоставляет доступ к денежным данным в отчетах по каналам.

    • Измерение operatingSystem поддерживает три новых значения измерения:
      • FIREFOX
      • REALMEDIA
      • TIZEN

8 февраля 2017 г.

API YouTube Analytics теперь поддерживает необязательный параметр include-historical-channel-data . Обратите внимание, что этот параметр актуален только при получении отчетов о владельцах контента .

Параметр позволяет владельцу контента указать, что ответ API должен включать время просмотра каналов и данные о просмотрах за период времени, предшествующий тому, когда каналы были связаны с владельцем контента. Значение параметра по умолчанию — false , что означает, что по умолчанию ответ API включает только время просмотра и данные о просмотрах с момента, когда каналы были связаны с владельцем контента.

Эти правила также применяются, если запрос API извлекает данные для нескольких каналов:

  • Если значение параметра равно false , данные о времени просмотра и просмотрах, возвращаемые для любого заданного канала, основаны на дате, когда этот канал был связан с владельцем контента.

    Важно помнить, что разные каналы могли быть связаны с владельцем контента в разные даты. Если запрос API извлекает данные для нескольких каналов и значение параметра равно false , то ответ API содержит данные о времени просмотра и просмотрах на основе даты связывания для каждого соответствующего канала.
  • Если значение параметра равно true , ответ возвращает данные о времени просмотра и просмотрах для всех каналов на основе дат начала и окончания, указанных в запросе API.

15 декабря 2016 г.

Следующие отчеты YouTube Reporting API больше не поддерживаются и были удалены из документации. Доступна более новая версия каждого отчета. ( Объявление об устаревании этих отчетов было сделано 15 сентября 2016 г.)

Список текущих типов отчетов в справочной документации API также был обновлен.

11 ноября 2016 г.

Это обновление содержит следующие изменения:

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

    • Отчеты о конечных экранах

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

    • Размеры конечного экрана

      • end_screen_element_type : тип элемента конечной заставки, связанный со статистикой.
      • end_screen_element_id : идентификатор, который YouTube использует для уникальной идентификации элемента конечной заставки.

    • Показатели конечной заставки

      Примечание. Данные по показателям конечной заставки доступны по состоянию на 1 мая 2016 года.

      • end_screen_element_impressions : общее количество показов элементов конечной заставки. Для каждого отображаемого элемента конечной заставки регистрируется один показ.
      • end_screen_element_clicks : количество кликов по элементам конечной заставки.
      • end_screen_element_click_rate : рейтинг кликов для элементов конечной заставки.

      • Справочный центр YouTube содержит более подробную информацию о добавлении конечных заставок к вашим видео .

    • Следующие отчеты больше не поддерживаются и были удалены из документации. Доступна более новая версия каждого отчета. ( Объявление об устаревании этих отчетов было сделано 22 июня 2016 г.)

    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
      adEarnings estimatedAdRevenue
      impressionBasedCpm cpm
      impressions adImpressions
      redPartnerRevenue estimatedRedPartnerRevenue

    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)

    September 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.

    September 15, 2016

    This update contains the following YouTube Reporting API changes:

    August 19, 2016

    This update contains the following YouTube Reporting API change:

    • The content_owner_basic_a1 report 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_a1 report's replacement is the content_owner_basic_a2 report as explained in the revision history entry for May 19, 2016 .

    August 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.

    August 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
        earnings estimatedRevenue August 10, 2017
        adEarnings estimatedAdRevenue November 4, 2016
        redPartnerRevenue estimatedRedPartnerRevenue November 4, 2016
        impressionBasedCpm cpm November 4, 2016
        impressions adImpressions November 4, 2016

        Note that the earnings metric 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 impressionBasedCpm metric, the cpm metric, or both. However, after that date, only the cpm metric will be supported.

      • The insightTrafficSourceType dimension 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 detail report. In both cases, the insightTrafficSourceDetail dimension identifies the video from which the viewer was referred.

      • The adType dimension now supports the value auctionBumperInstream , 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_type dimension 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_detail dimension identifies the video from which the viewer was referred.

      • The API's list of core metrics has been corrected to list estimated_partner_revenue as a core metric and to remove the earnings from that list. (The earnings metric has never been supported in the YouTube Reporting API.)

      • The ad_type dimension now supports the value 19 that refers to bumper ads, which are non-skippable video ads of up to 6 seconds that play before a video can be viewed.

    July 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 video filter is required and the group filter 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.

    • 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_a1 report has been corrected to reflect that the report uses the card_id dimension. Previously, the documentation incorrectly listed the dimension name as card_title .

    June 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:

    June 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_a1 report is the new version of the content_owner_ad_performance_a1 report. 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_a1 report is named content_owner_estimated_revenue_a1 .
        • The new version of the content_owner_asset_estimated_earnings_a1 report is named content_owner_asset_estimated_revenue_a1 .

        Both newly renamed reports differ from their predecessors in the following ways:

      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 , and content_owner_asset_estimated_earnings_a1 reports 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 reportType resource's id property 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_revenue metric's name has been updated to estimated_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 renamed estimated_partner_ad_auction_revenue in newer versions of those reports.
      • The estimated_partner_doubleclick_revenue metric's name has been updated to estimated_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 renamed estimated_partner_ad_reserved_revenue in newer versions of those reports.

    • The dimensions documentation for the Reporting API has been updated to no longer list the elapsed_video_time_percentage and audience_retention_type properties. These dimensions are not currently supported by any reports available through the API.

    May 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 the likes and dislikes metrics.

      If you already have a job to create the content_owner_basic_a1 report, you still need to create a new job for the content_owner_basic_a2 report. 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_a1 report 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 , and report resources all support a new property that identifies whether the associated resource represents a deprecated report type:

      • The reportType resource's deprecateTime property 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_a1 report. Thus, the deprecateTime for that report type specifies a time on August 19, 2016, after which YouTube will stop generating reports of that type.

      • The job resource's expireTime property 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 report resource's jobExpireTime property 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 the expireTime property in the job resource, as described in the previous item in this list.

    • The jobs.create method now returns a 400 HTTP 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.

    April 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 job resource's new systemManaged property 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.list method's new includeSystemManaged parameter indicates whether the API response should include jobs for system-managed reports. The parameter's default value is false .

      • The jobs.reports.list method's new startTimeAtOrAfter parameter indicates that the API response should only contain reports if the earliest data in the report is on or after the specified date. Similarly, the startTimeBefore parameter 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 createdAfter parameter, which pertains to the time that the report was created, the new parameters pertain to the data in the report.

      • The reportType resource's new systemManaged property indicates whether the resource describes a system-managed report.

      • The reportTypes.list method's new includeSystemManaged parameter indicates whether the API response should include system-managed reports. The parameter's default value is false .

    March 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_service dimension supports these new values:
      • 82 : iOS system activity dialog
      • 83 : Google Inbox
      • 84 : Android Messenger
    • In the YouTube Analytics API, the sharingService dimension supports these new values:
      • ANDROID_MESSENGER : Android Messenger
      • INBOX : Google Inbox
      • IOS_SYSTEM_ACTIVITY_DIALOG : iOS system activity dialog

    March 16, 2016

    This update contains the following changes, which affect both the YouTube Reporting API and the YouTube Analytics API:

    YouTube Reporting API

    • The playback_location_type dimension 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_type dimension now supports 18 as a dimension value. This value indicates that the video views originated from a page that lists all of the videos in a playlist. This source differs from source type 14 , which indicates that the views occurred while the video was being played as part of a playlist.

    YouTube Analytics API

    • The insightPlaybackLocationType dimension supports two new dimension values:
      • BROWSE : The data pertains to views that took place on the YouTube home page or home screen, in the user's subscription feed, or in another YouTube browsing feature.
      • SEARCH : The data pertains to views that took place directly on the YouTube search results page.
    • The insightTrafficSourceType dimension now supports YT_PLAYLIST_PAGE as a dimension value. This value indicates that the video views originated from a page that lists all of the videos in a playlist. This source differs from the PLAYLIST source type, which indicates that the views occurred while the video was being played as part of a playlist.

    February 8, 2016

    The list of metrics supported for the YouTube Analytics API has been updated so that card metrics are no longer listed as supported metrics for that API. (None of that API's reports had been documented as supporting any of the card metrics.)

    Note that you can still retrieve card metrics using the YouTube Reporting API, which supports those metrics for numerous channel and content owner reports.

    January 6, 2016

    The YouTube Reporting API and YouTube Analytics API both now specifically identify views that occur via a Chromecast device.

    • In the YouTube Reporting API, the operating_system dimension uses the value 21 to identify views that take place via Chromecast.
    • In the YouTube Analytics API, the operatingSystem dimension uses the value CHROMECAST to identify views that take place via Chromecast.

    December 21, 2015

    In the documentation, the names of the annotation_clickable_impressions and annotation_closable_impressions metrics have been updated to match the names being returned in the reports. Previously, the names were documented as clickable_annotation_impressions and closable_annotation_impressions .

    December 18, 2015

    European Union (EU) laws require that certain disclosures must be given to and consents obtained from end users in the EU. Therefore, for end users in the European Union, you must comply with the EU User Consent Policy . We have added a notice of this requirement in our YouTube API Terms of Service .

    December 15, 2015

    This update contains the following changes, all of which affect the YouTube Analytics API:

    • 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:

      Contents
      Dimensions:
      Required deviceType
      Use 0 or more day , liveOrOnDemand , subscribedStatus , youtubeProduct
      Metrics:
      Use 1 or more views , estimatedMinutesWatched
      Filters:
      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 , and channel ). Previously, the API server would have just returned an error if the API user could not access data for at least one of the specified items.

      For example, suppose a user submits an API request in which the video filter lists 20 video IDs. The user owns 18 of the videos. However, one videos ID identifies a video owned by another channel, and another ID identifies a video that was deleted and, therefore, no longer exists. In this case, instead of returning an error, the API server now drops the two videos that the user cannot access, and the API response contains data for the 18 videos that the API user owns.

    • If you request data for an empty YouTube Analytics group , the API now returns an empty data set rather than an error.

    • The YouTube Analytics API's groupItems.insert method now returns an unauthorized ( 403 HTTP response code) error if you try to add an entity to a group but you do not have access to that entity. Previously, the API would have allowed you to add the entity to the group, but later returned an unauthorized error when you tried to retrieve report data for that group.

    • The YouTube Analytics API's groups.list method now supports pagination. If the API response does not contain all available groups, then the response's nextPageToken parameter specifies a token that can be used to retrieve the next page of results. Set the method's pageToken parameter to that value to retrieve additional results.

    November 10, 2015

    This update contains the following changes:

    October 29, 2015

    This update contains the following changes:

    • The documentation for the YouTube Reporting API's date dimension has been corrected to reflect that dates reference the 24-hour period beginning at 12:00 am Pacific time (UTC-8). Previously, the documentation stated that the date began at 12:00 am (GMT).

      In addition, the YouTube Analytics API documentation has been updated to note that all date-related dimensions ( day , 7DayTotals , 30DayTotals , and month ) refer to dates beginning at 12:00 am Pacific time (UTC-8).

    • The YouTube Reporting API's jobs.reports.list() method now supports the createdAfter query parameter. If specified, this parameter indicates that the API response should only list reports created after the specified date and time, including new reports with backfilled data. Note that the parameter value pertains to the time that the report is created and not the dates associated with the returned data.

      The parameter value is a timestamp in RFC3339 UTC "Zulu" format, accurate to microseconds. Example: "2015-10-02T15:01:23.045678Z" .

      The YouTube Reporting API best practices have also been updated to explain how you can use the createdAfter parameter to avoid repeatedly processing the same report.

    • The definitions of the job resource's createTime property and the report resource's startTime , endTime , and createTime properties have all been corrected to note that the property values are accurate to microseconds, not nanoseconds. In addition, all of the definitions now accurately reflect that the property value is a timestamp.

    October 8, 2015

    This update contains the following changes:

    • The documentation for the YouTube Analytics API's sharingService dimension has been updated to include a list of possible dimension values. The list includes a number of newly supported services.

      The YouTube Reporting API's sharing_service dimension's definition has also been updated to list the newly supported values. The enum values that are greater than 59 are the new ones in the list.

    September 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.

    August 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.query method, which you use to retrieve reports, is now documented separately. The information on that page had previously been on some other pages. The new page is designed to help you more easily identify the information you need to send to retrieve a report.

    July 22, 2015

    This update contains several changes, all of which only apply to content owners:

    • The new adEarnings metric includes total estimated earnings (net revenue) from all Google-sold advertising sources. It is not a core metric. The API supports the adEarnings metric for any report that already supported the earnings metric.

      In addition, the definition of the earnings metric has been corrected to reflect the fact that its value includes total estimated earnings from all Google-sold advertising sources as well as from non-advertising sources. Previously, the definition incorrectly indicated that the metric only included earnings from advertising sources.

    • The primaryAdGrossRevenue metric has been deprecated. Instead, use the grossRevenue metric to retrieve revenue data.

    • In addition to the deprecated primaryAdGrossRevenue metric, ad performance reports no longer support the monetizedPlaybacks and playbackBasedCpm metrics. However, several video reports do still support those metrics.

    June 1, 2015

    This update contains the following changes:

    • The API now supports two new metrics for video reports, videosAddedToPlaylists and videosRemovedFromPlaylists . 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.

    March 31, 2015

    This update contains the following changes:

    March 16, 2015

    This update contains the following changes:

    • The new currency parameter allows you to retrieve earnings metrics in a currency other than United States dollars ( USD ). If the parameter is set, then the API converts values for the earnings , grossRevenue , playbackBasedCpm , and impressionBasedCpm metrics to the specified currency. The values returned are estimates calculated using exchange rates that change on a daily basis.

      The parameter value is a three-letter, ISO 4217 currency code. The default value is USD . The parameter definition contains a list of supported currency codes.

    February 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 group and groupItem resources for creating and managing groups.

        • The group resource represents an Analytics group, a custom collection of up to 200 channels, videos, playlists, or assets. The API supports list , insert , update , and delete methods for this resource.
        • The groupItem resource represents an item in an Analytics group. The API supports list , insert , and delete methods for this resource.

        So, for example, you could create a group using the groups.insert method and then add items to that group using the groupItems.insert method.

      • Retrieving report data for a group

        The dimensions documentation has been updated to include the group dimension, which can be used as a filter for many channel reports and content owner reports . When you use the group filter, the API returns data for all of the items in that group. Note that the API does not currently support the ability to create reports for asset groups.

      See the YouTube Help Center for more information about YouTube Analytics groups.

    February 13, 2015

    This update contains the following changes:

    • The API no longer supports the show dimension.

    August 28, 2014

    This update contains the following changes:

    • The API now supports the ability to specify multiple values for the video , playlist , channel , and show dimensions when those dimensions are used as filters . To specify multiple values, set the filters parameter value to a comma-separated list of the video, playlist, channel, or show IDs for which the API response should be filtered. The parameter value can specify up to 200 IDs.

      If you specify multiple values for the same filter, you can also add that filter to the list of dimensions that you specify for the request. This is true even if the filter is not listed as a supported dimension for a particular report. If you do add the filter to the list of dimensions, then the API also uses the filter values to group results.

      See the filters parameter definition for complete details about this functionality.

    July 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 ids parameter to channel==MINE . (You can also still set the ids parameter to channel== CHANNEL_ID to retrieve data for the specified channel.)

    • The API now supports playlist reports, which contain statistics related to video views that occur in the context of a playlist. Playlist reports are available for channels and content owners .

      All playlist reports support the views and estimatedMinutesWatched metrics, and some also support the averageViewDuration metric.

      In addition, all playlist reports support the following new metrics. Note that each of these metrics only reflect playlist views that occurred on the web.

      • playlistStarts : The number of times viewers initiated playback of a playlist.
      • viewsPerPlaylistStart : The average number of video views that occurred each time a playlist was initiated.
      • averageTimeInPlaylist : The estimated average amount of time, in minutes, that a viewer viewed videos in a playlist after the playlist was initiated.

      Any request to retrieve a playlist report must use the isCurated filter, which must be set to 1 ( isCurated==1 ).

    • The API now supports an audience retention report. Этот отчет измеряет способность видео удерживать свою аудиторию. The report's new elapsedVideoTimeRatio dimension measures the amount of the video that has elapsed for the corresponding metric values:

      • The audienceWatchRatio metric identifies the absolute ratio of viewers watching the video at the given point in the video. The ratio is calculated by comparing the number of times a portion of a video has been watched to the total number of views of the video.

        Note that a portion of a video could be watched more than once (or not at all) in a given video view. For example, if users rewind and watch the same portion of a video multiple times, then the absolute ratio for that portion of the video the could be greater than 1 .

      • The relativeRetentionPerformance metric shows how well a video retains viewers during playbacks in comparison to all YouTube videos of similar length. A value of 0 indicates that the video retains viewers worse than any other video of similar length, while a value of 1 indicates that the video retains viewers better than any other video of similar length. A median value of 0.5 indicates that half of the videos of similar length retain viewers better while half retain viewers worse.

      You can also use the audienceType filter so that the report only returns data associated with organic views, views from TrueView in-stream ads, or views from TrueView in-display ads. (Organic views are the direct result of user action, such as a search for a video or a click on a suggested video.)

    • The API supports several new metrics related to annotations. The metrics listed below can be retrieved with any reports that previously supported the annotationClickThroughRate and annotationCloseRate metrics.

      All of the new metrics are core metrics and are subject to the Deprecation Policy . However, note that data is available for the new metrics as of July 16, 2013. (Data for the annotationClickThroughRate and annotationCloseRate metrics is available as of June 10, 2012.)

    • GOOGLE_SEARCH is no longer reported as a separate value for the insightTrafficSourceType dimension. Instead, referrals from Google search results are now attributed to the EXT_URL traffic source type. As a result, it's also no longer possible to retrieve an insightTrafficSourceDetail report that sets the insightTrafficSourceType filter to GOOGLE_SEARCH .

    January 31, 2014

    This update contains the following changes:

    January 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
      • по времени
      • Географический
      • Место воспроизведения
      • Источник трафика
      • Устройство/ОС
      • Демографический
      • Социальное
      • Earnings/Ads (for content owner reports only)

    • The sample requests document now includes new examples for retrieving province-specific data in either channel reports or content owner reports.

      • Province-specific metrics for US states and Washington DC : This report retrieves a province-by-province breakdown of view counts and other statistics for a channel's videos. The data covers US states and Washington DC The example uses the province dimension, and also uses the filters parameter to restrict the response to only include results for the United States.

      • Viewer demographics in California (age group and gender) : This report retrieves statistics about the age group and gender of viewers in California who watched a channel's videos or, for content owner reports, a content owner's claimed content. This example uses the filters parameter to ensure the response only includes data for a particular province.

    • The definition of the province dimension has been updated to note that when province is included in the dimensions parameter value, the request must also restrict data to the United States by including country==US in the filters parameter value.

    January 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
      • по времени
      • Географический
      • Место воспроизведения
      • Источник трафика
      • Устройство/ОС
      • Демографический
      • Социальное
      • Top videos

      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 , and subContinent .

      • The province dimension lets you retrieve statistics for US states and for the District of Colombia. The API supports two uses for this dimension:

        • The API supports two reports that break statistics down on a state-by-state basis. Both reports are available for channels and content owners .

          • The core stats report provides several statistics, including view counts and estimated minutes watched.
          • The time-based report provides the same statistics, but aggregates data on a daily, 7-day, 30-day, or monthly basis.

        • You can use the filters query parameter to restrict a report to only contain statistics for a particular state. Several reports support this type of filtering, including geographic reports, playback location reports, traffic source reports, device reports, operating system reports, demographic reports, and top-video reports.

      • The continent dimension specifies a United Nations (UN) statistical region code that identifies a continent. This dimension can only be used as a filter .

      • The subContinent dimension specifies a United Nations (UN) statistical region code that identifies a sub-region of a continent. This dimension can also only be used as a filter.

        Since each sub-region is only associated with one continent, there is no need to also use the continent filter when you are using the subContinent filter. (In fact, the API will return an error if a request uses both dimensions.)

    • The documentation has been corrected so that the insightTrafficSourceDetail dimension does not include the insightTrafficSourceType value PROMOTED as a valid filter value.

    September 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_APP as a value for the insightPlaybackLocationType dimension. In conjunction with this update, as of September 10, 2013, playbacks are no longer categorized as MOBILE playbacks, though mobile playbacks that occurred before that date will still be categorized with that value.

      With this update, mobile playbacks are now classified as either WATCH , EMBEDDED , or EXTERNAL_APP playbacks, depending on the type of application where the playbacks occur.

    • The API now supports PLAYLIST as a value for the insightTrafficSourceType dimension. The value indicates that video views were referred from a playlist. Previously, these views would have been classified using the dimension's YT_OTHER_PAGE category.

    July 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 sort parameter value of day,-views . Results are sorted chronologically, but within the result set for each day, the first row contains data for the traffic source that generated the most views, the second row contains data for the source with that generated the next highest amount of views, and so forth.

    • The API now supports two new dimensions, deviceType and operatingSystem , which can be used to retrieve data about the devices where viewers are watching your videos. The API supports reports that use either or both dimensions.

      • The deviceType report lets you retrieve view counts and estimated watch time for different types of devices, including desktop, mobile, and tablet devices. You can also use the operatingSystem filter to restrict the device type report to only contain statistics for devices running a specific operating system, such as Android or iOS .

      • The operatingSystem report lets you retrieve view counts and estimated watch time for different operating systems, such as Android, iOS, Linux, and more. You can also use the deviceType filter to restrict the operating system report to only contain statistics for a specific type of device, such as mobile devices or tablets.

      The new device type and operating system reports are available for channels and for content owners .

    • The sample requests document has been updated to include three device reports for channels and three device reports for content owners.

    • The insightPlaybackLocationType dimension may return the value YT_OTHER , which identifies views that are not classified using one of the dimension's other values.

    May 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:

    May 6, 2013

    This update contains the following changes:

    • The API now supports the ability to retrieve watch time metrics – estimatedMinutesWatched , averageViewDuration , and averageViewPercentage – in conjunction with other metrics, including view metrics, engagement metrics, earnings metrics, and ad performance metrics.

      The lists of available channel reports and content owner reports have been updated to reflect this change. (The lists are actually shorter now since the watch time metrics can be retrieved as part of other listed reports.)

      The Sample API requests document has also been updated.

    • The reports that use the insightPlaybackLocationDetail and insightTrafficSourceDetail dimensions have been enhanced in the following ways:

      • They now support an optional country filter.

      • Content owners can now retrieve these reports using any of the following new filter combinations. Note that all of these combinations also support the optional country filter.

        • Playback location detail

          • channel,insightPlaybackLocationType==EMBEDDED
          • show,insightPlaybackLocationType==EMBEDDED
          • claimedStatus,insightPlaybackLocationType==EMBEDDED
          • uploaderType,insightPlaybackLocationType==EMBEDDED
          • uploaderType,claimedStatus,insightPlaybackLocationType==EMBEDDED

        • Traffic source detail

          • channel,insightTrafficSourceType
          • show,insightTrafficSourceType
          • claimedStatus,insightTrafficSourceType
          • uploaderType,insightTrafficSourceType
          • uploaderType,claimedStatus,insightTrafficSourceType

    May 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 insightTrafficSourceType dimension now supports SUBSCRIBER as a valid value. This value identifies video views that were referred from feeds on the YouTube homepage or from YouTube subscription features. If you filter based on this traffic source, the insightTrafficSourceDetail field will specify the homepage feed or other page from which views were referred.

    March 28, 2013

    This update contains the following changes:

    March 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.readonly scope.

    • The API documentation has been reorganized so that different types of reports are explained on separate pages. As such, there are now separate pages explaining the different types of channel reports and content owner reports .

    February 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.

    November 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.

    October 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 .

    September 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 , or show ) or a supported combination of the claimedStatus and uploaderType dimensions.

    • The API now supports two new sorting options for top-video reports . These reports, which are available as channel reports or content owner reports, contain metrics (views, comments, likes, etc.) on a per-country basis and break down those metrics by video. You can now sort these reports based on the number of users who subscribed to or unsubscribed from a channel from the video's watch page.

    • The definitions of the subscribersGained and subscribersLost metrics have been updated to explain that a channel can gain or lose subscribers in several places, including the video watch page, the channel page, and the guide that appears on the YouTube home page. When these metrics appear in a video-specific report, they only include statistics from the specified video's watch page.