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 | etagEtag этого ресурса. |
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 , именно так они отображаются в ответах 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 для добавления или удаления элементов из этого списка.Обратите внимание, что YouTube прекратил поддержку функции добавления видео в избранное. Например, свойство statistics.favoriteCount ресурса video было объявлено устаревшим 28 августа 2015 года. В результате, по историческим причинам, значение этого свойства может содержать идентификатор плейлиста, который ссылается на пустой плейлист и, следовательно, не может быть получен. |
contentDetails.relatedPlaylists. uploads | stringИдентификатор плейлиста, содержащего загруженные на канал видео. Используйте метод videos.insert для загрузки новых видео и метод videos.delete для удаления ранее загруженных видео. |
statistics | objectОбъект statistics содержит статистические данные для канала. |
statistics. viewCount | unsigned longСумма общего количества просмотров всех видеороликов канала во всех форматах. Начиная с 24 августа 2026 года, для всех форматов видео (длинные ролики, прямые трансляции и короткие видео) на канале, |
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Список ссылок на статьи Википедии, описывающие контент канала. |
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. Размер изображения — 1060x175 пикселей. |
brandingSettings.image. bannerMobileImageUrl | stringДанный объект недвижимости устарел. URL-адрес баннерного изображения, отображаемого на странице канала в мобильных приложениях. Размер изображения: 640 x 175 пикселей. |
brandingSettings.image. watchIconImageUrl | stringДанный объект недвижимости устарел. URL изображения, которое отображается над видеоплеером. Это изображение высотой 25 пикселей с гибкой шириной, не превышающей 170 пикселей. Если вы не укажете это изображение, вместо него будет отображаться название вашего канала. |
brandingSettings.image. trackingImageUrl | stringДанный объект недвижимости устарел. URL-адрес пикселя отслеживания размером 1x1 пиксель, который можно использовать для сбора статистики просмотров канала или страниц видео. |
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 инкапсулирует данные канала, которые многоканальная сеть (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Локализованное описание канала. |