Activities

activity 資源包含特定頻道或使用者在 YouTube 上執行的動作相關資訊。活動動態消息中回報的動作包括：為影片評分、分享影片、將影片標示為我的最愛、上傳影片等。每個 activity 資源都會指出動作類型、與動作相關聯的頻道，以及與動作相關聯的資源，例如獲得評分或上傳的影片。

方法

這個 API 支援 activities 資源的下列方法：

list
傳回符合要求條件的頻道活動事件清單。舉例來說，您可以擷取與特定頻道或使用者自有頻道相關聯的事件。立即試用。

資源表示法

下列 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 用來識別活動的專屬 ID。
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
有效鍵值如下：
  • default：預設縮圖圖片。影片的預設縮圖 (或參照影片的資源，例如播放清單項目或搜尋結果) 寬度為 120 像素，高度為 90 像素。頻道的預設縮圖寬度和高度皆為 88 像素。
  • medium：縮圖圖片的高解析度版本。如果是影片 (或參照影片的資源)，這張圖片的寬度為 320 像素，高度為 180 像素。如果是頻道，這張圖片的寬度和高度都是 240 像素。
  • high：縮圖圖片的高解析度版本。如果是影片 (或參照影片的資源)，這張圖片的寬度為 480 像素，高度為 360 像素。如果是頻道，這張圖片的寬度和高度都是 800 像素。
  • standard：比 high 解析度圖片更高的縮圖圖片版本。這張圖片適用於部分影片，以及參照影片的其他資源，例如播放清單項目或搜尋結果。這張圖片的寬度為 640 像素，高度為 480 像素。
  • maxres：縮圖圖片的最高解析度版本。部分影片和其他參照影片的資源 (例如播放清單項目或搜尋結果) 會顯示這個尺寸的圖片。這張圖片的寬度為 1280 像素，高度為 720 像素。
snippet.thumbnails.(key).url string
圖片的網址。
snippet.thumbnails.(key).width unsigned integer
圖片寬度。
snippet.thumbnails.(key).height unsigned integer
圖片的高度。
snippet.channelTitle string
負責這項活動的頻道名稱
snippet.type string
資源描述的活動類型。

這個屬性的有效值包括：
  • channelItem
  • comment - (目前未退回)
  • favorite
  • like
  • playlistItem
  • promotedItem
  • recommendation
  • social
  • subscription
  • upload
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 用來明確識別與留言相關聯頻道的 ID。只有在 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
如果建議的資源是影片，這個 ID 就是 YouTube 用來專屬識別影片的 ID。只有在 resourceId.kind 為 youtube#video 時，才會顯示這個屬性。
contentDetails.recommendation.resourceId.channelId string
如果建議的資源是頻道，則為 YouTube 用於明確識別頻道的 ID。只有在 resourceId.kind 為 youtube#channel 時，才會顯示這個屬性。
contentDetails.recommendation.reason string
向使用者推薦資源的原因。

這個屬性的有效值如下：
  • videoFavorited
  • videoLiked
  • videoWatched
contentDetails.recommendation.seedResourceId object
seedResourceId 物件包含導致建議的資源相關資訊。
contentDetails.recommendation.seedResourceId.kind string
API 資源的類型。
contentDetails.recommendation.seedResourceId.videoId string
如果推薦內容是由特定影片所致，這裡會顯示 YouTube 用來專屬識別該影片的 ID。只有在 seedResourceId.kind 為 youtube#video 時，才會顯示這個屬性。
contentDetails.recommendation.seedResourceId.channelId string
如果建議是由特定頻道所致，則為 YouTube 用於專屬識別頻道的 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
社群網路名稱。

這個屬性的有效值如下：
  • facebook
  • googlePlus
  • twitter
  • unspecified
contentDetails.social.resourceId object
resourceId 物件會封裝資訊，用來識別與社群網路貼文相關聯的資源。
contentDetails.social.resourceId.kind string
API 資源的類型。
contentDetails.social.resourceId.videoId string
如果社群網路貼文提及影片，這個 ID 是 YouTube 用來識別該影片的專屬 ID。只有在 social.resourceId.kind 屬性的值為 youtube#video 時，才會顯示這個屬性。
contentDetails.social.resourceId.channelId string
如果社群網路貼文提及頻道，YouTube 會使用這個 ID 專屬識別該頻道。只有在 social.resourceId.kind 屬性的值為 youtube#channel 時，才會顯示這個屬性。
contentDetails.social.resourceId.playlistId string
如果社群網路貼文提及播放清單，這個 ID 就是 YouTube 用來識別該播放清單的專屬 ID。只有在 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 物件包含可識別已新增至頻道的資源資訊。