YouTube Analytics API: Content Owner Reports

Примечание: Content owner reports are only accessible to YouTube content partners who participate in the YouTube Partner Program .

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

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

• Отчеты по плейлистам предоставляют статистику, непосредственно связанную с просмотрами видео в контексте плейлиста. В отчетах по плейлистам используются многие из тех же параметров и фильтров, что и в отчетах по видео.

• Отчеты об эффективности рекламы содержат показатели, связанные с доходом и эффективностью рекламы. В них используется параметр adType для группировки показателей на основе типов рекламы, которые показывались во время воспроизведения видео. В разделе отчетов об эффективности рекламы объясняется два типа показателей эффективности рекламы, которые поддерживает API.

Получение отчета

Чтобы получить отчет о владельце контента, вызовите метод reports.query API и установите значение параметра ids в запросе API равным contentOwner== OWNER_NAME , где OWNER_NAME указывает идентификатор владельца контента. Если вы не уверены в значении, обратитесь к своему менеджеру по работе с партнерами.

Авторизация

Все запросы к API YouTube Analytics должны быть авторизованы. В руководстве по авторизации объясняется, как использовать протокол OAuth 2.0 для получения токенов авторизации.

Для запросов к API YouTube Analytics используются следующие области авторизации:

Примечание: Для метрик, отмеченных звездочкой ( * ), требуется токен авторизации, предоставляющий доступ к области действия https://www.googleapis.com/auth/yt-analytics-monetary.readonly .

Фильтры

Все API-запросы для получения отчетов о владельцах контента должны фильтровать данные, используя либо параметр video , либо параметр channel , либо поддерживаемую комбинацию параметров claimedStatus и uploaderType . (Поддерживаемые комбинации перечислены в определении параметра uploaderType .)

В таблицах, описывающих поддерживаемые отчеты, указаны фильтры, которые можно использовать для каждого конкретного отчета. В описаниях фильтры, указанные в скобках, являются необязательными. Например, если в отчете указан параметр фильтрации video(,country) , то отчет можно отфильтровать таким образом, чтобы он включал только данные для конкретного видео или только данные для конкретного видео в конкретной стране.

API также поддерживает возможность указания нескольких значений для фильтров video , playlist и channel . Если вы укажете несколько значений для одного из этих фильтров, вы также можете добавить этот фильтр в список параметров, которые вы указываете для запроса. Это справедливо даже в том случае, если фильтр не указан в списке поддерживаемых параметров для конкретного отчета.

Полное объяснение того, как фильтровать результаты API по определенному значению или набору значений, см. в определении параметра filters .

Понимание таблиц отчетов

В этом разделе объясняется форматирование и терминология, используемые в таблицах, определяющих отчеты, поддерживаемые API. В следующей таблице перечислены измерения, метрики и фильтры, поддерживаемые для отчета о воспроизведении видео с подробными сведениями, с использованием измерения времени и метрики averageViewPercentage .

Таблица содержит две строки для измерений, одну строку для метрик и три строки для фильтров. Для измерений и фильтров значения из каждой строки могут быть объединены в запросе API при условии, что комбинация соответствует правилам использования, указанным в таблице. Например, допустимые значения параметров dimensions для этого отчета включают:

• dimensions=day
• dimensions=day,subscribedStatus
• dimensions=month,subscribedStatus,youtubeProduct
• dimensions=month,youtubeProduct

Однако значение параметра day,month недопустимо, поскольку оно использует два измерения, основанных на времени, и в запросе должно быть указано либо 0, либо 1.

Хотя таблицы отчетов определяют поддерживаемые измерения, метрики и фильтры, API обеспечивает соблюдение ограничений между параметрами. Запросы с неподдерживаемыми или взаимоисключающими комбинациями (например, объединение несовместимых географических фильтров или пропуск обязательных параметров) приводят к ошибке HTTP 400 badRequest с сообщением The query is not supported . Для получения информации о конкретных ограничениях, применяемых к каждому отчету, ознакомьтесь с информацией по отдельным таблицам отчетов на этой странице.

Терминология таблиц отчетов

В таблицах используется следующая терминология для обозначения того, являются ли измерения обязательными или необязательными:

• Эти термины означают, что требуется указать значение:
  • Обязательно: необходимо указать значение.
  • Используйте ровно 1: необходимо включить одно значение из группы.
  • Используйте 1 или более: Вы можете включить любые или все значения из группы, но необходимо включить хотя бы одно.
• Эти термины означают, что значение является необязательным:
  • Необязательно: Вы можете указать значение по своему усмотрению.
  • Используйте 0 или 1: Вы можете выбрать одно значение из группы.
  • Используйте 0 или более: Вы можете включить любые или все значения из группы.

Видеорепортажи

Основные статистические данные

Основные статистические данные (включая количество подписчиков)

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