activity
資源包含特定頻道或使用者在 YouTube 上採取的動作相關資訊。在活動資訊提供中回報的動作包括對影片進行評分、分享影片、將影片標示為最愛、上傳影片等。每個 activity
資源都會識別動作類型、與動作相關聯的頻道,以及與動作相關聯的資源,例如已評分或上傳的影片。
方法
這個 API 支援下列 activities
資源的方法:
系統已不再支援 activities.insert
方法。
資源表示法
以下 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 }, "like": { "resourceId": { "kind": string, "videoId": string, } }, "favorite": { "resourceId": { "kind": string, "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 物件包含活動的基本詳細資料,包括活動的類型和群組 ID。 |
snippet.publishedAt |
datetime 活動發生的日期和時間。這個值會以 ISO 8601 格式指定。 |
snippet.channelId |
string YouTube 用來識別活動相關頻道的 ID。 |
snippet.title |
string 主要與活動相關聯的資源標題。 |
snippet.description |
string 主要與活動相關聯的資源說明。 |
snippet.thumbnails |
object 主要對應於活動相關資源的縮圖圖片地圖。而地圖中每個物件的鍵都是縮圖名稱,而值是包含縮圖其他資訊的資訊。 |
snippet.thumbnails.(key) |
object 有效的鍵值如下:
|
snippet.thumbnails.(key).url |
string 圖片網址。 |
snippet.thumbnails.(key).width |
unsigned integer 圖片的寬度。 |
snippet.thumbnails.(key).height |
unsigned integer 圖片的高度。 |
snippet.channelTitle |
string 對這項活動負責的頻道頻道標題 |
snippet.type |
string 資源說明的活動類型。 這項屬性的有效值如下:
|
snippet.groupId |
string 與活動相關聯的群組 ID。群組 ID 可識別與同一使用者和資源相關聯的使用者事件,舉例來說,如果使用者為影片評分,並將同一部影片標示為最愛項目,這些事件的項目就會在使用者的活動資訊提供中,使用相同的群組 ID。在使用者介面中,您可以將相同的 groupId 值事件分組,避免重複活動。 |
contentDetails |
object contentDetails 物件包含與活動相關聯的內容相關資訊。舉例來說,如果 snippet.type 值是 videoRated ,則 contentDetails 物件的內容會識別評分的影片。 |
contentDetails.upload |
object upload 物件包含上傳影片的相關資訊。這個屬性只會在 snippet.type 是 upload 時顯示。 |
contentDetails.upload.videoId |
string YouTube 用來識別上傳影片的 ID。 |
contentDetails.like |
object like 物件包含獲得正面 (例如) 評分的資源資訊。這個屬性只會在 snippet.type 是 like 時顯示。 |
contentDetails.like.resourceId |
object resourceId 物件包含可識別評分資源的資訊。 |
contentDetails.like.resourceId.kind |
string API 資源類型。 |
contentDetails.like.resourceId.videoId |
string 如果評分資源是影片,YouTube 用來辨識該部影片的 ID。這個屬性只會在 resourceId.kind 是 youtube#video 時顯示。 |
contentDetails.favorite |
object favorite 物件包含標示為最愛影片的相關資訊。這個屬性只會在 snippet.type 是 favorite 時顯示。 |
contentDetails.favorite.resourceId |
object resourceId 物件包含可標示為標示為收藏的資源資訊。 |
contentDetails.favorite.resourceId.kind |
string API 資源類型。 |
contentDetails.favorite.resourceId.videoId |
string YouTube 用於識別喜愛的影片的專屬 ID。這個屬性只會在 resourceId.kind 為 youtube#video 時顯示。注意: activities.list 方法目前不會傳回新註解的資源。 |
contentDetails.comment |
object comment 物件包含收到註解的資源相關資訊。這個屬性只會在 snippet.type 是 comment 時顯示。 |
contentDetails.comment.resourceId |
object resourceId 物件包含的資訊,可識別與留言相關的資源。 |
contentDetails.comment.resourceId.kind |
string API 資源類型。 |
contentDetails.comment.resourceId.videoId |
string YouTube 用來辨識與留言相關的影片 ID。這個屬性只會在 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 用來識別使用者的訂閱項目的 ID。這個屬性只會在 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 用來識別 ID 的影片。這個屬性只會在 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 用來辨識該影片的 ID。這個屬性只會在 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 會使用這個 ID 來識別影片的專屬 ID。這個屬性只會在 seedResourceId.kind 是 youtube#video 時顯示。 |
contentDetails.recommendation.seedResourceId.channelId |
string YouTube 用於識別頻道的 ID,如果頻道是由特定頻道推薦,就會成為此 ID。這個屬性只會在 seedResourceId.kind 是 youtube#channel 時顯示。 |
contentDetails.recommendation.seedResourceId.playlistId |
string 當播放清單是由特定播放清單所產生時,YouTube 用於辨識該播放清單的 ID。這個屬性只會在 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 用來辨識社交網路訊息中特定影片 (例如貼文提及影片) 的 ID。只有在 social.resourceId.kind 屬性的值為 youtube#video 時,這個屬性才會顯示。 |
contentDetails.social.resourceId.channelId |
string YouTube 用來辨識社群網路貼文中特定頻道的 ID (如果貼文是頻道)。只有在 social.resourceId.kind 屬性的值為 youtube#channel 時,這個屬性才會顯示。 |
contentDetails.social.resourceId.playlistId |
string 頻道所發布的播放清單,如果播放清單提及播放清單,YouTube 就會用於識別該播放清單的播放清單。只有在 social.resourceId.kind 屬性的值為 youtube#playlist 時,這個屬性才會顯示。 |
contentDetails.social.author |
string 社交網路訊息的作者。 |
contentDetails.social.referenceUrl |
string 社交網路貼文的網址。 |
contentDetails.social.imageUrl |
string 文章作者的圖片。 |
contentDetails.channelItem |
object channelItem 物件包含新增至管道的資源詳細資料。這個屬性只會在 snippet.type 是 channelItem 時顯示。 |
contentDetails.channelItem.resourceId |
object resourceId 物件包含的資訊可識別新增至管道的資源。 |