В этом документе объясняются сходства и различия в способах доступа к данным YouTube Analytics через API YouTube Analytics и API отчетов YouTube, чтобы вы могли выбрать подходящий API для своего приложения.
Оба API позволяют получать данные YouTube Analytics. Кроме того, оба API поддерживают владельцев каналов YouTube и владельцев контента YouTube, каждый из которых может получить доступ к определенному набору отчетов:
Отчеты по каналам содержат показатели активности пользователей для указанного канала.
В отчетах владельцев контента представлены сводные показатели по всем каналам, связанным с указанным владельцем контента на YouTube. Например, звукозаписывающая компания может получить отчет, содержащий объединенную статистику по каналам YouTube всех артистов лейбла. Некоторые отчеты владельцев контента содержат показатели активности пользователей, в то время как другие содержат показатели, связанные с доходом и эффективностью рекламы.
API для создания отчетов также позволяет некоторым владельцам контента получать доступ к отчетам о доходах от рекламы, управляемым системой. Данные из этих отчетов можно получить только с помощью API для создания отчетов.
Все запросы к API YouTube Analytics и YouTube Reporting должны быть авторизованы владельцем канала или контента, которому принадлежат запрашиваемые данные.
Содержание отчета
Отчеты, получаемые через API, содержат два типа данных:
Измерения — это распространенные критерии, используемые для агрегирования данных, такие как дата совершения пользователем действия или страна, в которой находились пользователи.
В отчете каждая строка данных имеет уникальную комбинацию значений измерений. Таким образом, комбинация значений измерений каждой строки выступает в качестве первичного ключа для этой строки.
Метрики — это отдельные показатели активности пользователей, эффективности рекламы или предполагаемого дохода. Метрики активности пользователей включают в себя такие данные, как количество просмотров видео и оценки (лайки и дизлайки).
Выберите подходящий API для вашего приложения.
- API аналитики YouTube
- API YouTube Analytics поддерживает целевые запросы в реальном времени для создания пользовательских отчетов YouTube Analytics. API предоставляет параметры фильтрации и сортировки, поэтому вызывающему приложению не требуется изначально поддерживать эти функции.
Каждый API-запрос указывает диапазон дат, за который будут возвращены данные. API также позволяет получать еженедельные и ежемесячные наборы данных. Таким образом, вызывающему приложению не нужно хранить полученные наборы данных или агрегировать статистику по диапазонам дат. - API для создания отчетов на YouTube
- API отчетов YouTube позволяет получать пакетные отчеты, содержащие данные YouTube Analytics для канала или владельца контента. Он предназначен для приложений, которые могут импортировать большие наборы данных и предоставляют инструменты для фильтрации, сортировки и анализа этих данных.
Каждый отчет содержит предопределенный набор полей. Вы используете API для планирования заданий по созданию отчетов, каждое из которых определяет отчет, который должен сгенерировать YouTube. Затем YouTube генерирует ежедневный отчет, который можно асинхронно загрузить. Каждый отчет содержит данные за уникальный 24-часовой период.
Кроме того, YouTube автоматически генерирует набор системных отчетов для владельцев контента, имеющих доступ к соответствующим отчетам в YouTube Creator Studio . Эти отчеты предоставляют программный доступ к данным о доходах от рекламы.
Поддерживаемые отчеты
В таблице ниже указаны различные типы отчетов, которые можно получить с помощью API. Целевые запросы доступны с помощью API YouTube Analytics, а пакетные отчеты — с помощью API отчетов YouTube.
Данные, доступные в одном API, могут быть недоступны в другом. Например, API YouTube Analytics позволяет получать показатели активности пользователей еженедельно или ежемесячно, тогда как API YouTube Reporting требует от вас самостоятельного агрегирования этих данных. С другой стороны, API YouTube Reporting поддерживает отчеты по активам для владельцев контента, но эти данные недоступны в API YouTube Analytics.
| Типы отчетов | |
|---|---|
| Видеорепортажи | Поддерживается для каналов ( запрос или массовая обработка ) и владельцев контента ( запрос или массовая обработка ). Видеоотчеты предоставляют статистику по всей активности пользователей, связанной с видео канала или видео владельца контента. Например, эти отчеты содержат количество просмотров ваших видео. В API YouTube Analytics некоторые отчеты по видео от владельцев контента также включают предполагаемый доход и показатели эффективности рекламы. |
| Отчеты о охвате | Поддерживается для каналов ( массовая обработка ) и владельцев контента ( массовая обработка ). Показатели охвата также доступны в отчетах по видео для целевых запросов. В отчетах об охвате представлена статистика по показам миниатюр видео и коэффициенту кликабельности. |
| Отчеты по плейлистам | Поддерживается для каналов ( запрос или массовая обработка ) и владельцев контента ( запрос или массовая обработка ). Отчеты по плейлистам предоставляют статистику, непосредственно связанную с просмотрами видео в контексте плейлиста. API отчетов YouTube поддерживает отчеты об удержании аудитории для плейлистов, но API аналитики YouTube не поддерживает аналогичный отчет. |
| Отчеты об эффективности рекламы | Поддерживается для владельцев контента ( запросы или массовая рассылка ). Отчеты об эффективности рекламы предоставляют метрики, основанные на показах, для объявлений, которые демонстрировались во время воспроизведения видео. Эти метрики учитывают каждый показ объявления, а каждое воспроизведение видео может привести к нескольким показам. |
| Отчеты о прогнозируемой выручке | Поддерживается для владельцев контента ( массовая рассылка ). Отчеты об оценочной выручке содержат общую оценочную выручку от видеороликов, полученных из рекламных источников, продаваемых Google, и из источников, не связанных с рекламой. Эти отчеты также содержат некоторые показатели эффективности рекламы. Обратите внимание, что отчеты, управляемые системой, содержат фактическую выручку. |
| Отчеты по активам | Поддерживается для владельцев контента ( массовая рассылка ). Отчеты по контенту предоставляют метрики активности пользователей, связанные с видеороликами, которые привязаны к контенту владельца. Видео включается в отчет владельца контента, если владелец контента заявил, что это видео соответствует одному из его собственных ресурсов. Видео могло быть загружено владельцем контента или другим пользователем YouTube. |
| Отчеты, управляемые системой | Поддерживается для владельцев контента, имеющих доступ к соответствующим отчетам в меню «Отчеты» в YouTube Creator Studio. Системные отчеты предоставляют фактические данные о доходах, полученных от использования ресурсов и видео. Дополнительный отчет содержит список заявленных видео и соответствующих им ресурсов. Не все отчеты Creator Studio доступны через API. Примечание: YouTube автоматически генерирует отчеты, управляемые системой, для владельцев контента, имеющих доступ к соответствующим отчетам в Creator Studio. В результате процесс получения этих отчетов отличается от процесса получения других типов отчетов из этого списка. Дополнительную информацию см. в документации по отчетам, управляемым системой . |
Ключевые отличия
В таблице ниже приведены важные различия между API аналитики и отчетов YouTube.
| Особенность | API аналитики YouTube | API для создания отчетов на YouTube |
|---|---|---|
| Процесс получения данных | В каждом API-запросе указываются параметры и метрики, которые необходимо вернуть, а также период времени, за который будут возвращены данные. | Приложения планируют выполнение заданий по формированию отчетов. Для каждого задания YouTube генерирует ежедневные отчеты, которые можно загрузить в асинхронном режиме. |
| Диапазоны дат | В некоторых отчетах API указывается дата, когда пользователь проявлял активность. В некоторых из этих отчетов поддерживаются параметры для агрегирования показателей активности пользователей по месяцам. | Во всех отчетах API указывается день, когда пользователь совершил какие-либо действия. Приложения, использующие API, могут реализовывать функции агрегирования данных за определенные периоды времени. |
| Фильтрация данных | Вы можете фильтровать отчеты, чтобы включать только строки, для которых измерение имеет определенное значение. API также поддерживает некоторые измерения, такие как континент и субконтинент , которые используются только в качестве фильтров. | API поддерживает пакетную загрузку полных наборов данных. Он не поддерживает фильтрацию и не возвращает данные только для фильтруемых измерений. Клиентское приложение сохраняет загруженные данные и реализует собственные функции для их фильтрации. |
| Сортировка | Отчеты можно сортировать по возвращаемым значениям метрик. Некоторые отчеты поддерживают только ограниченное количество результатов. Например, отчет, в котором перечислены самые просматриваемые видео канала, возвращает максимум 200 строк. | Этот API поддерживает пакетную загрузку полных наборов данных. Клиентские приложения могут реализовывать собственные функции для сортировки загруженных данных. |
| Перечисления | В отчетах API используются текстовые значения, такие как "ANDROID" или "CHANNEL", для идентификации значений перечисляемых измерений. | Отчеты API содержат целочисленные значения, которые можно сопоставить с текстовыми значениями. |
| Квота | API-сервер оценивает каждый запрос, чтобы определить стоимость его квоты. В разделе « Использование квоты» более подробно описана методология. | Проблема использования квот отсутствует, поскольку данные извлекаются один раз, а затем фильтруются, сортируются и запрашиваются внутри приложения. |
| Уникальные отчеты |
| |
| Уникальные размеры | группа (измерение, учитывающее только фильтр) континент (измерение только с фильтром) субконтинент (измерение только с фильтром) месяц просмотров на начало плейлиста среднее время в плейлисте | annotation_id аннотация_тип asset_id card_id card_type live_or_on_demand subscribed_status язык_субтитров |
| Уникальные метрики | уникальные относительная эффективность удержания просмотров на начало плейлиста среднее время в плейлисте | card_click_rate card_clicks card_impressions card_teaser_click_rate card_teaser_clicks card_teaser_impressions estimated_partner_adsense_revenue estimated_partner_doubleclick_revenue playlist_saves_added playlist_saves_removed |
Различия в именовании API
В двух API используются разные соглашения об именовании для идентификации параметров и метрик. В названиях API YouTube Analytics используется верблюжий регистр (camelCase), например, adType . В названиях API YouTube Reporting используются строчные буквы и подчеркивания, например, ad_type .
В следующих таблицах указаны различные имена, которые два API используют для идентификации одних и тех же метрик и измерений. В некоторых случаях разница между двумя именами больше, чем та, которая получается после преобразования имени из camelCase в подчеркивания. Например, измерение video в API YouTube Analytics называется video_id, а в API отчетов YouTube video_id .