API теперь поддерживает возможность пометить ваш канал или видео как предназначенные для детей. Кроме того,
channel
и video
теперь содержат свойство, которое определяет статус канала или видео «сделано для детей». Условия использования API-сервисов YouTube и Правила для разработчиков также были обновлены 10 января 2020 года. Для получения дополнительной информации см. историю изменений Сервиса API данных YouTube и Условия использования API-сервисов YouTube . Ресурс channel
содержит информацию о канале YouTube.
Методы
API поддерживает следующие методы для ресурсов channels
:
- list
- Возвращает коллекцию из нуля или более ресурсов
channel
, соответствующих критериям запроса. Попробуйте сейчас . - update
- Обновляет метаданные канала. Обратите внимание, что этот метод в настоящее время поддерживает только обновления объектов
brandingSettings
иinvideoPromotion
ресурсаchannel
, а также их дочерних свойств. Попробуйте сейчас .
Представление ресурсов
Следующая структура JSON показывает формат ресурса channels
:
{ "kind": "youtube#channel", "etag": etag, "id": string, "snippet": { "title": string, "description": string, "customUrl": string, "publishedAt": datetime, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } }, "defaultLanguage": string, "localized": { "title": string, "description": string }, "country": string }, "contentDetails": { "relatedPlaylists": { "likes": string, "favorites": string, "uploads": string } }, "statistics": { "viewCount": unsigned long, "subscriberCount": unsigned long, // this value is rounded to three significant figures "hiddenSubscriberCount": boolean, "videoCount": unsigned long }, "topicDetails": { "topicIds": [ string ], "topicCategories": [ string ] }, "status": { "privacyStatus": string, "isLinked": boolean, "longUploadsStatus": string, "madeForKids": boolean, "selfDeclaredMadeForKids": boolean }, "brandingSettings": { "channel": { "title": string, "description": string, "keywords": string, "trackingAnalyticsAccountId": string, "unsubscribedTrailer": string, "defaultLanguage": string, "country": string }, "watch": { "textColor": string, "backgroundColor": string, "featuredPlaylistId": string } }, "auditDetails": { "overallGoodStanding": boolean, "communityGuidelinesGoodStanding": boolean, "copyrightStrikesGoodStanding": boolean, "contentIdClaimsGoodStanding": boolean }, "contentOwnerDetails": { "contentOwner": string, "timeLinked": datetime }, "localizations": { (key): { "title": string, "description": string } } }
Характеристики
В следующей таблице определены свойства, которые появляются в этом ресурсе:
Характеристики | |
---|---|
kind | string Идентифицирует тип ресурса API. Значением будет youtube#channel . |
etag | etag Etag этого ресурса. |
id | string Идентификатор, который YouTube использует для уникальной идентификации канала. |
snippet | object Объект snippet содержит основные сведения о канале, такие как его заголовок, описание и миниатюры изображений. |
snippet. title | string Название канала. |
snippet. description | string Описание канала. Значение свойства имеет максимальную длину 1000 символов. |
snippet. customUrl | string Пользовательский URL-адрес канала. В Справочном центре YouTube объясняются квалификационные требования для получения собственного URL-адреса, а также способы его настройки. |
snippet. publishedAt | datetime Дата и время создания канала. Значение указывается в формате ISO 8601 . |
snippet. thumbnails | object Карта миниатюр изображений, связанных с каналом. Для каждого объекта на карте ключом является имя миниатюры изображения, а значением — объект, содержащий другую информацию о миниатюре. При отображении миниатюр в вашем приложении убедитесь, что ваш код использует URL-адреса изображений точно так, как они возвращаются в ответах API. Например, ваше приложение не должно использовать домен http вместо домена https в URL-адресе, возвращаемом в ответе API.URL-адреса миниатюр каналов доступны только в домене https , именно так URL-адреса отображаются в ответах API. Вы можете увидеть неработающие изображения в своем приложении, если оно попытается загрузить изображения YouTube из домена http . Миниатюры изображений могут быть пустыми для вновь созданных каналов, и их заполнение может занять до одного дня. |
snippet.thumbnails. (key) | object Допустимые ключевые значения:
|
snippet.thumbnails.(key). url | string URL-адрес изображения. Дополнительные рекомендации по использованию URL-адресов миниатюр в вашем приложении см. в определении свойства snippet.thumbnails . |
snippet.thumbnails.(key). width | unsigned integer Ширина изображения. |
snippet.thumbnails.(key). height | unsigned integer Высота изображения. |
snippet. defaultLanguage | string Язык текста в свойствах snippet.title и snippet.description ресурса channel . |
snippet. localized | object Объект snippet.localized содержит локализованный заголовок и описание канала или заголовок и описание канала на языке по умолчанию для метаданных канала.
localizations для добавления, обновления или удаления локализованных метаданных. |
snippet.localized. title | string Локализованное название канала. |
snippet.localized. description | string Локализованное описание канала. |
snippet. country | string Страна, с которой связан канал. Чтобы установить значение этого свойства, обновите значение свойства brandingSettings.channel.country . |
contentDetails | object Объект contentDetails инкапсулирует информацию о содержимом канала. |
contentDetails. relatedPlaylists | object Объект relatedPlaylists — это карта, которая идентифицирует плейлисты, связанные с каналом, например загруженные на канал видео или понравившиеся видео. Вы можете получить любой из этих плейлистов, используя метод playlists.list . |
contentDetails.relatedPlaylists. likes | string Идентификатор плейлиста, содержащего понравившиеся видео канала. Используйте методы playlistItems.insert и playlistItems.delete чтобы добавлять или удалять элементы из этого списка. |
contentDetails.relatedPlaylists. favorites | string Это свойство устарело. Идентификатор плейлиста, содержащего избранные видео канала. Используйте методы playlistItems.insert и playlistItems.delete чтобы добавлять или удалять элементы из этого списка.Обратите внимание, что YouTube прекратил поддержку функции избранного видео. Например, 28 августа 2015 года свойство statistics.favoriteCount video было объявлено устаревшим. В результате по историческим причинам значение этого свойства может содержать идентификатор списка воспроизведения, который ссылается на пустой список воспроизведения, и поэтому его невозможно получить. |
contentDetails.relatedPlaylists. uploads | string Идентификатор плейлиста, содержащего загруженные на канал видео. Используйте метод videos.insert для загрузки новых видео и метод videos.delete для удаления ранее загруженных видео. |
statistics | object Объект statistics инкапсулирует статистику канала. |
statistics. viewCount | unsigned long Количество просмотров канала. |
statistics. commentCount | unsigned long Это свойство устарело. Количество комментариев к каналу. |
statistics. subscriberCount | unsigned long Количество подписчиков у канала. Это значение округляется до трех значащих цифр. Дополнительную информацию об округлении количества подписчиков можно найти в истории изменений или в Справочном центре YouTube . |
statistics. videoCount | unsigned long Количество общедоступных видео, загруженных на канал. Обратите внимание, что это значение отражает только количество общедоступных видео канала, даже для владельцев. Такое поведение соответствует подсчетам, указанным на веб-сайте YouTube. |
topicDetails | object Объект topicDetails инкапсулирует информацию о темах, связанных с каналом.Важно! Дополнительные сведения об изменениях, связанных с идентификаторами тем, см. в определении свойства topicDetails.topicIds[] и в истории изменений . |
topicDetails. topicIds[] | list Список идентификаторов тем, связанных с каналом. Это свойство устарело с 10 ноября 2016 г. Оно будет поддерживаться до 10 ноября 2017 г. Важно! Из-за прекращения поддержки Freebase и API Freebase идентификаторы тем начали работать по-другому с 27 февраля 2017 г. В это время YouTube начал возвращать небольшой набор идентификаторов курируемых тем. |
topicDetails. topicCategories[] | list Список URL-адресов Википедии, описывающих содержимое канала. |
status | object Объект status инкапсулирует информацию о статусе конфиденциальности канала. |
status. privacyStatus | string Статус конфиденциальности канала. Допустимые значения для этого свойства:
|
status. isLinked | boolean Указывает, идентифицируют ли данные канала пользователя, который уже связан с именем пользователя YouTube или учетной записью Google+. Пользователь, у которого есть одна из этих ссылок, уже имеет общедоступную учетную запись YouTube, что является необходимым условием для некоторых действий, таких как загрузка видео. |
status. longUploadsStatus | string Указывает, может ли канал загружать видео продолжительностью более 15 минут. Это свойство возвращается только в том случае, если владелец канала санкционировал запрос API. Дополнительную информацию об этой функции можно найти в Справочном центре YouTube . Допустимые значения для этого свойства:
|
status. madeForKids | boolean Это значение указывает, обозначен ли канал как предназначенный для детей, и содержит текущий статус канала «сделано для детей». Например, статус может определяться на основе значения свойства selfDeclaredMadeForKids . Дополнительную информацию о настройке аудитории для вашего канала, видео или трансляций см. в Справочном центре YouTube. |
status. selfDeclaredMadeForKids | boolean В запросе channels.update это свойство позволяет владельцу канала обозначить канал как предназначенный для детей. Значение свойства возвращается только в том случае, если владелец канала санкционировал запрос API. |
brandingSettings | object Объект brandingSettings инкапсулирует информацию о брендинге канала. |
brandingSettings. channel | object Объект channel инкапсулирует фирменные свойства страницы канала. |
brandingSettings.channel. title | string Название канала. Заголовок имеет максимальную длину 30 символов. |
brandingSettings.channel. description | string Описание канала, которое отображается в окне информации о канале на странице вашего канала. Значение свойства имеет максимальную длину 1000 символов. |
brandingSettings.channel. keywords | string Ключевые слова, связанные с вашим каналом. Значение представляет собой список строк, разделенных пробелами. Ключевые слова канала могут быть усечены, если они превышают максимально допустимую длину в 500 символов или содержат неэкранированные кавычки ( " ). Обратите внимание, что ограничение в 500 символов не является ограничением для каждого ключевого слова, а скорее ограничением общей длины всех ключевых слов. . |
brandingSettings.channel. trackingAnalyticsAccountId | string Идентификатор учетной записи Google Analytics , которую вы хотите использовать для отслеживания и измерения трафика на ваш канал. |
brandingSettings.channel. unsubscribedTrailer | string Видео, которое должно воспроизводиться в модуле избранных видео в режиме просмотра страницы канала для зрителей, отписавшихся от подписки. Подписавшиеся зрители могут увидеть другое видео, в котором рассказывается о недавних действиях на канале. Если указано, значение свойства должно быть идентификатором видео YouTube общедоступного или частного видео, которое принадлежит владельцу канала. |
brandingSettings.channel. defaultLanguage | string Язык текста в свойствах snippet.title и snippet.description ресурса channel . |
brandingSettings.channel. country | string Страна, с которой связан канал. Обновите это свойство, чтобы установить значение свойства snippet.country . |
brandingSettings. watch | object Примечание. Этот объект и все его дочерние свойства устарели. Объект watch инкапсулирует фирменные свойства страниц просмотра видео канала. |
brandingSettings.watch. textColor | string Примечание. Это свойство устарело. Цвет текста фирменной области страницы просмотра видео. |
brandingSettings.watch. backgroundColor | string Примечание. Это свойство устарело. Цвет фона фирменной области страницы просмотра видео. |
brandingSettings.watch. featuredPlaylistId | string Примечание. Это свойство устарело. API возвращает ошибку, если вы попытаетесь установить его значение. |
brandingSettings. image | object Это свойство и все его дочерние свойства устарели. Объект image инкапсулирует информацию об изображениях, которые отображаются на странице канала канала или страницах просмотра видео. |
brandingSettings.image. bannerImageUrl | string Это свойство устарело. URL-адрес изображения баннера, отображаемого на странице канала на веб-сайте YouTube. Размер изображения 1060х175 пикселей. |
brandingSettings.image. bannerMobileImageUrl | string Это свойство устарело. URL-адрес изображения баннера, отображаемого на странице канала в мобильных приложениях. Размер изображения 640 на 175 пикселей. |
brandingSettings.image. watchIconImageUrl | string Это свойство устарело. URL-адрес изображения, которое появляется над видеоплеером. Это изображение высотой 25 пикселей с гибкой шириной, которая не может превышать 170 пикселей. Если вы не предоставите это изображение, вместо изображения появится название вашего канала. |
brandingSettings.image. trackingImageUrl | string Это свойство устарело. URL-адрес пикселя отслеживания размером 1 на 1 пиксель, который можно использовать для сбора статистики просмотров канала или страниц с видео. |
brandingSettings.image. bannerTabletLowImageUrl | string Это свойство устарело. URL-адрес баннера с низким разрешением, который отображается на странице канала в приложениях для планшетов. Максимальный размер изображения — 1138х188 пикселей. |
brandingSettings.image. bannerTabletImageUrl | string Это свойство устарело. URL-адрес изображения баннера, который отображается на странице канала в приложениях для планшетов. Размер изображения 1707 на 283 пикселя. |
brandingSettings.image. bannerTabletHdImageUrl | string Это свойство устарело. URL-адрес баннера с высоким разрешением, который отображается на странице канала в приложениях для планшетов. Максимальный размер изображения — 2276х377 пикселей. |
brandingSettings.image. bannerTabletExtraHdImageUrl | string Это свойство устарело. URL-адрес баннера сверхвысокого разрешения, который отображается на странице канала в приложениях для планшетов. Максимальный размер изображения — 2560 х 424 пикселя. |
brandingSettings.image. bannerMobileLowImageUrl | string Это свойство устарело. URL-адрес баннера с низким разрешением, который отображается на странице канала в мобильных приложениях. Максимальный размер изображения — 320х88 пикселей. |
brandingSettings.image. bannerMobileMediumHdImageUrl | string Это свойство устарело. URL-адрес баннера среднего разрешения, который отображается на странице канала в мобильных приложениях. Максимальный размер изображения — 960х263 пикселей. |
brandingSettings.image. bannerMobileHdImageUrl | string Это свойство устарело. URL-адрес баннера с высоким разрешением, который отображается на странице канала в мобильных приложениях. Максимальный размер изображения — 1280 на 360 пикселей. |
brandingSettings.image. bannerMobileExtraHdImageUrl | string Это свойство устарело. URL-адрес баннера с очень высоким разрешением, который отображается на странице канала в мобильных приложениях. Максимальный размер изображения — 1440 на 395 пикселей. |
brandingSettings.image. bannerTvImageUrl | string Это свойство устарело. URL-адрес баннерного изображения сверхвысокого разрешения, которое отображается на странице канала в телевизионных приложениях. Максимальный размер изображения — 2120х1192 пикселей. |
brandingSettings.image. bannerTvLowImageUrl | string Это свойство устарело. URL-адрес баннера с низким разрешением, который отображается на странице канала в телевизионных приложениях. Максимальный размер изображения — 854х480 пикселей. |
brandingSettings.image. bannerTvMediumImageUrl | string Это свойство устарело. URL-адрес баннера среднего разрешения, который отображается на странице канала в телевизионных приложениях. Максимальный размер изображения — 1280 на 720 пикселей. |
brandingSettings.image. bannerTvHighImageUrl | string Это свойство устарело. URL-адрес баннерного изображения в высоком разрешении, которое отображается на странице канала в телевизионных приложениях. Максимальный размер изображения — 1920х1080 пикселей. |
brandingSettings.image. bannerExternalUrl | string Это свойство определяет местоположение изображения баннера, которое YouTube использует для создания изображений баннера различных размеров для канала. |
brandingSettings. hints[] | list Это свойство и все его дочерние свойства устарели. Объект hints инкапсулирует дополнительные свойства брендинга. |
brandingSettings.hints[]. property | string Это свойство устарело. Недвижимость. |
brandingSettings.hints[]. value | string Это свойство устарело. Стоимость недвижимости. |
auditDetails | object Объект auditDetails инкапсулирует данные канала, которые многоканальная сеть (MCN) будет оценивать при определении, следует ли принять или отклонить конкретный канал. Обратите внимание, что любой запрос API, который получает эту часть ресурса, должен предоставить токен авторизации, содержащий область https://www.googleapis.com/auth/youtubepartner-channel-audit . Кроме того, любой токен, использующий эту область действия, должен быть отозван, когда MCN решит принять или отклонить канал, или в течение двух недель с даты выдачи токена. |
auditDetails. overallGoodStanding | boolean В этом поле указывается, есть ли какие-либо проблемы с каналом. В настоящее время это поле представляет собой результат логической операции AND над свойствами communityGuidelinesGoodStanding , copyrightStrikesGoodStanding и contentIdClaimsGoodStanding . Это означает, что это свойство имеет значение true , если все эти другие свойства также имеют значение true . Однако это свойство будет иметь значение false , если какое-либо из этих свойств имеет значение false . Однако обратите внимание, что методология, используемая для установки значения этого свойства, может быть изменена. |
auditDetails. communityGuidelinesGoodStanding | boolean Указывает, соблюдает ли канал правила сообщества YouTube. |
auditDetails. copyrightStrikesGoodStanding | boolean Указывает, есть ли на канале нарушения авторских прав. |
auditDetails. contentIdClaimsGoodStanding | boolean Указывает, есть ли на канале нерешенные претензии. |
contentOwnerDetails | object Объект contentOwnerDetails инкапсулирует данные канала, которые видны только партнеру YouTube, который связал канал со своим менеджером контента. |
contentOwnerDetails. contentOwner | string Идентификатор владельца контента, связанного с каналом. |
contentOwnerDetails. timeLinked | datetime Дата и время, когда канал был связан с владельцем контента. Значение указывается в формате ISO 8601 . |
localizations | object Объект localizations инкапсулирует переводы метаданных канала. |
localizations. (key) | object Язык локализованных метаданных, связанных со значением ключа. Значением является строка, содержащая код языка BCP-47 . |
localizations.(key). title | string Локализованное название канала. |
localizations.(key). description | string Локализованное описание канала. |