Ресурс subscription содержит информацию о подписке пользователя YouTube. Подписка уведомляет пользователя о добавлении новых видео на канал или о выполнении другим пользователем одного из нескольких действий на YouTube, например, о загрузке видео, оценке видео или комментировании видео.
Методы
API поддерживает следующие методы для ресурсов subscriptions :
- list
- Возвращает ресурсы подписки, соответствующие критериям запроса API. Попробуйте прямо сейчас .
- insert
- Добавляет подписку на канал аутентифицированного пользователя. Попробуйте прямо сейчас .
- delete
- Удаляет подписку. Попробуйте сейчас .
Представление ресурсов
Следующая структура 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 | etagEtag этого ресурса. |
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Высота изображения. |