Ресурс activity содержит информацию о действии, которое определенный канал или пользователь совершил на YouTube. В фиде действий отображаются такие действия, как отправка ссылки на видео, загрузка видео и т. д. Каждый ресурс activity определяет тип действия, канал, связанный с действием, и ресурсы, связанные с действием, например видео, которое было оценено или загружено.
Методы
API поддерживает следующие методы для ресурсов activities:
Представление ресурса
Ниже приведена структура JSON ресурса activities:
{
"kind": "youtube#activity",
"etag": etag,
"id": string,
"snippet": {
"publishedAt": datetime,
"channelId": string,
"title": string,
"description": string,
"thumbnails": {
(key): {
"url": string,
"width": unsigned integer,
"height": unsigned integer
}
},
"channelTitle": string,
"type": string,
"groupId": string
},
"contentDetails": {
"upload": {
"videoId": string
},
"comment": {
"resourceId": {
"kind": string,
"videoId": string,
"channelId": string,
}
},
"subscription": {
"resourceId": {
"kind": string,
"channelId": string,
}
},
"playlistItem": {
"resourceId": {
"kind": string,
"videoId": string,
},
"playlistId": string,
"playlistItemId": string
},
"recommendation": {
"resourceId": {
"kind": string,
"videoId": string,
"channelId": string,
},
"reason": string,
"seedResourceId": {
"kind": string,
"videoId": string,
"channelId": string,
"playlistId": string
}
},
"social": {
"type": string,
"resourceId": {
"kind": string,
"videoId": string,
"channelId": string,
"playlistId": string
},
"author": string,
"referenceUrl": string,
"imageUrl": string
},
"channelItem": {
"resourceId": {
}
},
}
}Свойства
В таблице ниже приведены свойства, которые используются в этом ресурсе.
| Свойства | |
|---|---|
kind |
stringТип ресурса API. Значение будет youtube#activity. |
etag |
etagТег ETag этого ресурса. |
id |
stringИдентификатор, который YouTube использует для уникальной идентификации действия. |
snippet |
objectОбъект snippet содержит основную информацию о действии, в том числе его тип и идентификатор группы. |
snippet.publishedAt |
datetimeДата и время, когда произошло действие. Значение указывается в формате ISO 8601. |
snippet.channelId |
stringИдентификатор, который YouTube использует для уникальной идентификации канала, связанного с действием. |
snippet.title |
stringНазвание ресурса, в основном связанного с действием. |
snippet.description |
stringОписание ресурса, в основном связанного с действием. |
snippet.thumbnails |
objectКарта значков, связанных с ресурсом, который в основном связан с действием. Для каждого объекта на карте ключ – это название значка, а значение – это объект, который содержит другую информацию о значке. |
snippet.thumbnails.(key) |
objectДопустимые значения ключей:
|
snippet.thumbnails.(key).url |
stringURL изображения. |
snippet.thumbnails.(key).width |
unsigned integerШирина изображения. |
snippet.thumbnails.(key).height |
unsigned integerВысота изображения. |
snippet.channelTitle |
stringНазвание канала, на котором произошло событие. |
snippet.type |
stringТип действия, описанного в ресурсе. Допустимые значения этого свойства:
|
snippet.groupId |
stringИдентификатор группы, связанной с действием. Идентификатор группы позволяет определить события, связанные с одним и тем же пользователем и ресурсом. Например, если пользователь загружает видео и смотрит его, записи об этих событиях будут иметь один и тот же идентификатор группы в фиде действий пользователя. В пользовательском интерфейсе можно сгруппировать события с одинаковым значением groupId, чтобы избежать повторений. |
contentDetails |
objectОбъект contentDetails содержит информацию о контенте, связанном с действием. Например, если значение snippet.type – videoRated, то контент объекта contentDetails идентифицирует видео, которому поставлена оценка. |
contentDetails.upload |
objectОбъект upload содержит информацию о загруженном видео. Это свойство присутствует, только если для типа snippet.type выбран вариант upload. |
contentDetails.upload.videoId |
stringИдентификатор, который YouTube использует для уникальной идентификации загруженного видео. |
contentDetails.comment |
objectОбъект comment содержит информацию о ресурсе, к которому был оставлен комментарий. Это свойство присутствует, только если для типа snippet.type выбран вариант comment. |
contentDetails.comment.resourceId |
objectОбъект resourceId содержит информацию, которая идентифицирует ресурс, связанный с комментарием. |
contentDetails.comment.resourceId.kind |
stringТип ресурса API. |
contentDetails.comment.resourceId.videoId |
stringИдентификатор, который YouTube использует для уникальной идентификации видео, связанного с комментарием. Это свойство присутствует, только если для типа resourceId.kind выбран вариант youtube#video. |
contentDetails.comment.resourceId.channelId |
stringИдентификатор, который YouTube использует для уникальной идентификации канала, связанного с комментарием. Это свойство присутствует, только если для типа resourceId.kind выбран вариант youtube#channel. |
contentDetails.subscription |
objectОбъект subscription содержит информацию о канале, на который подписался пользователь. Возвращаются только общедоступные подписки. Это свойство присутствует только в том случае, если для типа snippet.type выбран вариант subscription. |
contentDetails.subscription.resourceId |
objectОбъект resourceId содержит информацию, которая идентифицирует ресурс, на который подписался пользователь. |
contentDetails.subscription.resourceId.kind |
stringТип ресурса API. |
contentDetails.subscription.resourceId.channelId |
stringИдентификатор, который YouTube использует для уникальной идентификации канала, на который подписался пользователь. Это свойство присутствует, только если для типа resourceId.kind выбран вариант youtube#channel. |
contentDetails.playlistItem |
objectОбъект playlistItem содержит информацию о новом элементе плейлиста. Это свойство присутствует, только если для типа snippet.type выбран вариант playlistItem. |
contentDetails.playlistItem.resourceId |
objectОбъект resourceId содержит информацию, которая идентифицирует ресурс, добавленный в плейлист. |
contentDetails.playlistItem.resourceId.kind |
stringТип ресурса API. |
contentDetails.playlistItem.resourceId.videoId |
stringИдентификатор, который YouTube использует для уникальной идентификации видео, добавленного в плейлист. Это свойство присутствует, только если для типа resourceId.kind выбран вариант youtube#video. |
contentDetails.playlistItem.playlistId |
stringЗначение, которое YouTube использует для уникальной идентификации плейлиста. |
contentDetails.playlistItem.playlistItemId |
stringЗначение, которое YouTube использует для уникальной идентификации объекта в плейлисте. |
contentDetails.recommendation |
objectОбъект recommendation содержит информацию о рекомендуемом ресурсе. Это свойство присутствует, только если для типа snippet.type выбран вариант recommendation. |
contentDetails.recommendation.resourceId |
objectОбъект resourceId содержит информацию, которая идентифицирует рекомендуемый ресурс. |
contentDetails.recommendation.resourceId.kind |
stringТип ресурса API. |
contentDetails.recommendation.resourceId.videoId |
stringИдентификатор, который YouTube использует для уникальной идентификации видео, если рекомендуемый ресурс является видео. Это свойство присутствует, только если для типа resourceId.kind выбран вариант youtube#video. |
contentDetails.recommendation.resourceId.channelId |
stringИдентификатор, который YouTube использует для уникальной идентификации канала, если рекомендуемый ресурс является каналом. Это свойство присутствует, только если для типа resourceId.kind выбран вариант youtube#channel. |
contentDetails.recommendation.reason |
stringПричина, по которой ресурс рекомендуется пользователю. Допустимые значения для этого свойства:
|
contentDetails.recommendation.seedResourceId |
objectОбъект seedResourceId содержит информацию о ресурсе, который вызвал рекомендацию. |
contentDetails.recommendation.seedResourceId.kind |
stringТип ресурса API. |
contentDetails.recommendation.seedResourceId.videoId |
stringИдентификатор, который YouTube использует для уникальной идентификации видео, если рекомендация была вызвана определенным видео. Это свойство присутствует, только если для типа seedResourceId.kind выбран вариант youtube#video. |
contentDetails.recommendation.seedResourceId.channelId |
stringИдентификатор, который YouTube использует для уникальной идентификации канала, если рекомендация была вызвана определенным каналом. Это свойство присутствует, только если для типа seedResourceId.kind выбран вариант youtube#channel. |
contentDetails.recommendation.seedResourceId.playlistId |
stringИдентификатор, который YouTube использует для уникальной идентификации плейлиста, если рекомендация была вызвана определенным плейлистом. Это свойство присутствует, только если для типа seedResourceId.kind выбран вариант youtube#playlist. |
contentDetails.social |
objectОбъект social содержит сведения о публикации в социальной сети. Это свойство присутствует, только если для типа snippet.type выбран вариант social. |
contentDetails.social.type |
stringНазвание социальной сети. Допустимые значения для этого свойства:
|
contentDetails.social.resourceId |
objectОбъект resourceId содержит информацию, которая идентифицирует ресурс, связанный с записью в социальной сети. |
contentDetails.social.resourceId.kind |
stringТип ресурса API. |
contentDetails.social.resourceId.videoId |
stringИдентификатор, который YouTube использует для уникальной идентификации видео, упомянутого в записи в социальной сети. Это свойство будет присутствовать, только если свойство social.resourceId.kind имеет значение youtube#video. |
contentDetails.social.resourceId.channelId |
stringИдентификатор, который YouTube использует для уникальной идентификации канала, представленного в публикации в социальной сети, если публикация относится к каналу. Это свойство будет присутствовать, только если свойство social.resourceId.kind имеет значение youtube#channel. |
contentDetails.social.resourceId.playlistId |
stringИдентификатор, который YouTube использует для уникальной идентификации плейлиста, упомянутого в записи в социальной сети. Это свойство будет присутствовать, только если значение свойства social.resourceId.kind – youtube#playlist. |
contentDetails.social.author |
stringАвтор публикации в социальной сети. |
contentDetails.social.referenceUrl |
stringURL публикации в социальной сети. |
contentDetails.social.imageUrl |
stringИзображение автора записи. |
contentDetails.channelItem |
objectОбъект channelItem содержит сведения о ресурсе, добавленном на канал. Это свойство присутствует, только если для типа snippet.type выбран вариант channelItem. |
contentDetails.channelItem.resourceId |
objectОбъект resourceId содержит информацию, которая идентифицирует ресурс, добавленный на канал. |