Ресурс subscription содержит информацию о подписке пользователя YouTube. Подписка позволяет получать уведомления о новых видео на канале и о действиях других пользователей на YouTube, например о загрузке видео, его оценке или добавлении комментария.
Методы
API поддерживает следующие методы для ресурсов subscriptions:
Представление ресурса
Ниже приведена структура JSON для ресурса subscriptions:
{
"kind": "youtube#subscription",
"etag": etag,
"id": string,
"snippet": {
"publishedAt": datetime,
"channelTitle": string,
"title": string,
"description": string,
"resourceId": {
"kind": string,
"channelId": string,
},
"channelId": string,
"thumbnails": {
(key): {
"url": string,
"width": unsigned integer,
"height": unsigned integer
}
}
},
"contentDetails": {
"totalItemCount": unsigned integer,
"newItemCount": unsigned integer,
"activityType": string
},
"subscriberSnippet": {
"title": string,
"description": string,
"channelId": string,
"thumbnails": {
(key): {
"url": string,
"width": unsigned integer,
"height": unsigned integer
}
}
}
}Свойства
В таблице ниже приведены свойства, которые используются в этом ресурсе.
| Свойства | |
|---|---|
kind |
stringОпределяет тип ресурса API. Значение будет youtube#subscription. |
etag |
etagТег Etag этого ресурса. |
id |
stringИдентификатор, который YouTube использует для уникальной идентификации подписки. |
snippet |
objectОбъект snippet содержит основные сведения о подписке, включая ее название и канал, на который подписан пользователь. |
snippet.publishedAt |
datetimeДата и время создания подписки. Значение указывается в формате ISO 8601. |
snippet.title |
stringНазвание подписки. |
snippet.description |
stringСведения о подписке. |
snippet.resourceId |
objectОбъект id содержит информацию о канале, на который подписался пользователь. |
snippet.resourceId.kind |
stringТип ресурса API. |
snippet.resourceId.channelId |
stringЗначение, которое YouTube использует для уникальной идентификации канала, на который подписался пользователь. |
snippet.channelId |
stringИдентификатор, который YouTube использует для уникальной идентификации канала подписчика. Объект resource_id идентифицирует канал, на который подписался пользователь. |
snippet.thumbnails |
objectКарта значков, связанных с подпиской. Для каждого объекта на карте ключ – это название значка, а значение – это объект, который содержит другую информацию о значке. |
snippet.thumbnails.(key) |
objectДопустимые значения ключей:
|
snippet.thumbnails.(key).url |
stringURL изображения. |
snippet.thumbnails.(key).width |
unsigned integerШирина изображения. |
snippet.thumbnails.(key).height |
unsigned integerВысота изображения. |
contentDetails |
objectОбъект contentDetails содержит базовую статистику по подписке. |
contentDetails.totalItemCount |
unsigned integerПриблизительное количество объектов, на которые указывает подписка. |
contentDetails.newItemCount |
unsigned integerКоличество новых элементов в подписке с момента последнего просмотра контента. |
contentDetails.activityType |
stringТип действий, на которые оформлена подписка (только загрузки или все действия). Допустимые значения:
|
subscriberSnippet |
objectОбъект subscriberSnippet содержит основную информацию о подписчике. |
subscriberSnippet.title |
stringНазвание канала подписчика. |
subscriberSnippet.description |
stringОписание канала подписчика. |
subscriberSnippet.channelId |
stringИдентификатор, который YouTube присваивает каналу подписчика. |
subscriberSnippet.thumbnails |
objectУменьшенные изображения канала подписчика. |
subscriberSnippet.thumbnails.(key) |
objectДопустимые значения ключей:
|
subscriberSnippet.thumbnails.(key).url |
stringURL изображения. |
subscriberSnippet.thumbnails.(key).width |
unsigned integerШирина изображения. |
subscriberSnippet.thumbnails.(key).height |
unsigned integerВысота изображения. |