channel и video теперь содержат свойство, которое указывает, предназначен ли канал или видео для детей. Условия использования сервисов YouTube API и правила для разработчиков также были обновлены 10 января 2020 г. Подробную информацию вы найдете в истории изменений сервиса YouTube Data API и Условий использования сервисов YouTube API.
Ресурс 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 канала. О том, как создать собственный URL и какие требования нужно для этого выполнить, рассказывается в Справочном центре YouTube. |
snippet.publishedAt |
datetimeДата и время создания канала. Значение указывается в формате ISO 8601. |
snippet.thumbnails |
objectКарта значков, связанных с каналом. Для каждого объекта на карте ключ – это название значка, а значение – это объект, содержащий другую информацию о значке. При показе значков в приложении убедитесь, что ваш код использует URL изображений в точности так, как они возвращаются в ответах API. Например, в URL, возвращаемом в ответе API, ваше приложение не должно использовать домен http вместо домена https.URL значков каналов доступны только в домене https, и именно в таком виде они возвращаются в ответах API. Если ваше приложение пытается загрузить изображения YouTube из домена http, они могут не отображаться. Для новых каналов значки могут быть пустыми. Они появятся в течение одного дня. |
snippet.thumbnails.(key) |
objectДопустимые значения ключей:
|
snippet.thumbnails.(key).url |
stringURL изображения. Дополнительные рекомендации по использованию 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.Обратите внимание, что функция добавления видео в избранное больше не поддерживается. Например, свойство statistics.favoriteCount ресурса video перестало поддерживаться 28 августа 2015 г. Поэтому значение этого свойства может содержать идентификатор плейлиста, который ссылается на пустой плейлист и, следовательно, невозможно получить. |
contentDetails.relatedPlaylists.uploads |
stringИдентификатор плейлиста, в котором содержатся загруженные на канал видео. Используйте метод videos.insert, чтобы загружать новые видео, и метод videos.delete, чтобы удалять ранее загруженные видео. |
statistics |
objectОбъект statistics содержит статистику по каналу. |
statistics.viewCount |
unsigned longОбщее количество просмотров всех видео на канале во всех форматах. Для всех форматов видео (обычных, трансляций и Shorts) на канале Для всех форматов видео (обычных, трансляций и Shorts) на канале |
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 и Freebase API с 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 Аналитики, который вы хотите использовать для отслеживания и измерения трафика на вашем канале. |
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 x 175 пкс. |
brandingSettings.image.bannerMobileImageUrl |
stringЭто свойство больше не поддерживается. URL баннера, который показывается на странице канала в мобильных приложениях. Размер изображения – 640 x 175 пкс. |
brandingSettings.image.watchIconImageUrl |
stringЭто свойство больше не поддерживается. URL изображения, которое появляется над видеопроигрывателем. Это изображение высотой 25 пикселей и шириной не более 170 пикселей. Если вы не добавите изображение, вместо него будет показываться название канала. |
brandingSettings.image.trackingImageUrl |
stringЭто свойство больше не поддерживается. URL пикселя отслеживания размером 1 x 1, который можно использовать для сбора статистики по просмотрам страниц канала или видео. |
brandingSettings.image.bannerTabletLowImageUrl |
stringЭто свойство больше не поддерживается. URL баннера с низким разрешением, который показывается на странице канала в приложениях для планшетов. Максимальный размер изображения – 1138 x 188 пкс. |
brandingSettings.image.bannerTabletImageUrl |
stringЭто свойство больше не поддерживается. URL баннера, который показывается на странице канала в приложениях для планшетов. Размер изображения – 1707 x 283 пкс. |
brandingSettings.image.bannerTabletHdImageUrl |
stringЭто свойство больше не поддерживается. URL баннера с высоким разрешением, который показывается на странице канала в приложениях для планшетов. Максимальный размер изображения – 2276 x 377 пкс. |
brandingSettings.image.bannerTabletExtraHdImageUrl |
stringЭто свойство больше не поддерживается. URL баннера со сверхвысоким разрешением, который показывается на странице канала в приложениях для планшетов. Максимальный размер изображения – 2560 x 424 пикселя. |
brandingSettings.image.bannerMobileLowImageUrl |
stringЭто свойство больше не поддерживается. URL баннера с низким разрешением, который показывается на странице канала в мобильных приложениях. Максимальный размер изображения – 320 x 88 пкс. |
brandingSettings.image.bannerMobileMediumHdImageUrl |
stringЭто свойство больше не поддерживается. URL баннера среднего разрешения, который показывается на странице канала в мобильных приложениях. Максимальный размер изображения – 960 x 263 пкс. |
brandingSettings.image.bannerMobileHdImageUrl |
stringЭто свойство больше не поддерживается. URL баннера с высоким разрешением, который показывается на странице канала в мобильных приложениях. Максимальный размер изображения – 1280 x 360 пкс. |
brandingSettings.image.bannerMobileExtraHdImageUrl |
stringЭто свойство больше не поддерживается. URL баннера в очень высоком разрешении, который показывается на странице канала в мобильных приложениях. Максимальный размер изображения – 1440 x 395 пкс. |
brandingSettings.image.bannerTvImageUrl |
stringЭто свойство больше не поддерживается. URL баннера в сверхвысоком разрешении, который показывается на странице канала в приложениях для телевизоров. Максимальный размер изображения – 2120 x 1192 пикселя. |
brandingSettings.image.bannerTvLowImageUrl |
stringЭто свойство больше не поддерживается. URL баннера с низким разрешением, который показывается на странице канала в приложениях для телевизоров. Максимальный размер изображения – 854 x 480 пкс. |
brandingSettings.image.bannerTvMediumImageUrl |
stringЭто свойство больше не поддерживается. URL баннера среднего разрешения, который показывается на странице канала в приложениях для телевизоров. Максимальный размер изображения – 1280 x 720 пкс. |
brandingSettings.image.bannerTvHighImageUrl |
stringЭто свойство больше не поддерживается. URL баннера с высоким разрешением, который показывается на странице канала в приложениях для телевизоров. Максимальный размер изображения – 1920 x 1080 пикселей. |
brandingSettings.image.bannerExternalUrl |
stringЭто свойство указывает на местоположение изображения, которое YouTube использует для создания баннеров разных размеров. |
brandingSettings.hints[] |
listЭто свойство и все его дочерние свойства больше не поддерживаются. Объект hints содержит дополнительные свойства брендинга. |
brandingSettings.hints[].property |
stringЭто свойство больше не поддерживается. Ресурс. |
brandingSettings.hints[].value |
stringЭто свойство больше не поддерживается. Значение свойства. |
auditDetails |
objectОбъект auditDetails содержит данные о канале, которые многоканальная сеть (МКС) оценивает, чтобы принять решение о том, принимать ли канал в сеть. Обратите внимание, что любой запрос к API, который извлекает эту часть ресурса, должен содержать токен авторизации с областью действия https://www.googleapis.com/auth/youtubepartner-channel-audit. Кроме того, любой токен, использующий эту область действия, должен быть отозван, когда МКС решит принять или отклонить канал, или в течение двух недель с даты выпуска токена. |
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Локализованное описание канала. |