Activities

YouTube 已淘汰頻道公告功能。activities.list 方法會 不會傳回頻道公告,且 activities.insert方法否 應用程式。詳情請參閱 YouTube 說明中心

activity 資源包含特定頻道或使用者在 YouTube 上進行的動作相關資訊。活動動態消息回報的動作包括為影片評分、分享影片、將影片標示為最愛、上傳影片等。每項 activity 資源都會識別動作類型、與動作相關聯的頻道,以及與該動作相關聯的資源,例如經過評分或上傳的影片。

方法

API 支援下列 activities 資源方法:

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

不再支援 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 用來識別活動的專屬 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 像素,高度為 88 像素。
  • medium:解析度較高的縮圖圖片。影片 (或影片資源) 寬度為 320 像素,高度為 180 像素。頻道的圖片寬度為 240px,高度為 240px。
  • high:縮圖的高解析度版本。影片 (或影片資源) 寬度為 480px,高度為 360px。頻道圖片的寬度和高度為 800px 和 800px。
  • standard - 比 high 解析度圖片更高的縮圖圖片解析度版本。這張圖片用於部分影片和其他有關影片的資源,例如播放清單項目或搜尋結果。此圖片的寬度為 640px,高度為 480px。
  • maxres:縮圖圖片的解析度最高版本。這個圖片大小適用於部分影片和其他有關影片的資源,例如播放清單項目或搜尋結果。此圖片的寬度為 1280px,高度為 720px。
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
  • bulletin (已淘汰)
snippet.groupId string
與活動相關聯的群組 ID。群組 ID 可用來識別與同一使用者和資源相關聯的使用者事件。舉例來說,如果使用者對影片評分,並將同一部影片標示為最愛,則這些事件的項目會在使用者的活動動態消息中顯示相同的群組 ID。在使用者介面中,您可以將具有相同 groupId 值的事件分組,避免重複。
contentDetails object
contentDetails 物件包含與活動相關聯的內容相關資訊。舉例來說,如果 snippet.type 值為 videoRated,則 contentDetails 物件的內容會識別已評分的影片。
contentDetails.upload object
upload 物件包含已上傳影片的相關資訊。這個屬性只有在 snippet.typeupload 時才會顯示。
contentDetails.upload.videoId string
YouTube 用來識別已上傳影片的唯一 ID。
contentDetails.like object
like 物件包含獲得正面 (例如) 評分的資源相關資訊。這個屬性只有在 snippet.typelike 時才會顯示。
contentDetails.like.resourceId object
resourceId 物件包含的資訊,可識別已評分資源。
contentDetails.like.resourceId.kind string
API 資源的類型。
contentDetails.like.resourceId.videoId string
如果分級資源為影片,YouTube 用來識別影片的專屬 ID。這個屬性只有在 resourceId.kindyoutube#video 時才會顯示。
contentDetails.favorite object
favorite 物件包含標示為最愛影片的影片相關資訊。這個屬性只有在 snippet.typefavorite 時才會顯示。
contentDetails.favorite.resourceId object
resourceId 物件包含的資訊,可識別標示為最愛的資源。
contentDetails.favorite.resourceId.kind string
API 資源的類型。
contentDetails.favorite.resourceId.videoId string
YouTube 用來識別最愛影片的專屬 ID。只有在 resourceId.kindyoutube#video 時,才會顯示這個屬性。

注意:activities.list 方法目前不會傳回新註解的資源。
contentDetails.comment object
comment 物件包含收到註解的資源相關資訊。這個屬性只有在 snippet.typecomment 時才會顯示。
contentDetails.comment.resourceId object
resourceId 物件包含的資訊可識別與註解相關聯的資源。
contentDetails.comment.resourceId.kind string
API 資源的類型。
contentDetails.comment.resourceId.videoId string
YouTube 用來識別留言所屬影片的專屬 ID。這個屬性只有在 resourceId.kindyoutube#video 時才會顯示。
contentDetails.comment.resourceId.channelId string
YouTube 用來識別留言所屬頻道的 ID。這個屬性只有在 resourceId.kindyoutube#channel 時才會顯示。
contentDetails.subscription object
subscription 物件包含使用者所訂閱頻道的相關資訊。這個屬性只有在 snippet.typesubscription 時才會顯示。
contentDetails.subscription.resourceId object
resourceId 物件包含的資訊,可識別使用者訂閱的資源。
contentDetails.subscription.resourceId.kind string
API 資源的類型。
contentDetails.subscription.resourceId.channelId string
YouTube 用來識別使用者訂閱頻道的 ID。這個屬性只有在 resourceId.kindyoutube#channel 時才會顯示。
contentDetails.playlistItem object
playlistItem 物件包含新播放清單項目的相關資訊。這個屬性只有在 snippet.typeplaylistItem 時才會顯示。
contentDetails.playlistItem.resourceId object
resourceId 物件包含的資訊可識別已新增至播放清單的資源。
contentDetails.playlistItem.resourceId.kind string
API 資源的類型。
contentDetails.playlistItem.resourceId.videoId string
YouTube 用來識別加入播放清單的影片的專屬 ID。這個屬性只有在 resourceId.kindyoutube#video 時才會顯示。
contentDetails.playlistItem.playlistId string
YouTube 用來識別播放清單的值。
contentDetails.playlistItem.playlistItemId string
YouTube 用來識別播放清單中特定項目的值。
contentDetails.recommendation object
recommendation 物件包含建議資源的相關資訊。這個屬性只有在 snippet.typerecommendation 時才會顯示。
contentDetails.recommendation.resourceId object
resourceId 物件包含的資訊,可識別建議資源。
contentDetails.recommendation.resourceId.kind string
API 資源的類型。
contentDetails.recommendation.resourceId.videoId string
如果建議資源為影片,YouTube 用來識別影片的專屬 ID。這個屬性只有在 resourceId.kindyoutube#video 時才會顯示。
contentDetails.recommendation.resourceId.channelId string
如果建議資源為頻道,YouTube 用來識別頻道的專屬 ID。這個屬性只有在 resourceId.kindyoutube#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.kindyoutube#video 時才會顯示。
contentDetails.recommendation.seedResourceId.channelId string
如果推薦內容是由特定頻道造成,YouTube 用來識別頻道的 ID。這個屬性只有在 seedResourceId.kindyoutube#channel 時才會顯示。
contentDetails.recommendation.seedResourceId.playlistId string
如果建議是由特定播放清單引起,YouTube 用來識別該播放清單的 ID。這個屬性只有在 seedResourceId.kindyoutube#playlist 時才會顯示。
contentDetails.social object
social 物件包含社群網路貼文的詳細資料。這個屬性只有在 snippet.typesocial 時才會顯示。
contentDetails.social.type string
社群網路的名稱。

這項資源的有效值如下:
  • facebook
  • googlePlus
  • twitter
  • unspecified
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 用來識別該播放清單的不重複 ID。這個屬性只有在 social.resourceId.kind 屬性的值為 youtube#playlist 時才會顯示。
contentDetails.social.author string
社交網路貼文的作者。
contentDetails.social.referenceUrl string
社交網路貼文的網址。
contentDetails.social.imageUrl string
文章作者的圖片。
contentDetails.channelItem object
channelItem 物件包含新增至管道的資源詳細資料。這個屬性只有在 snippet.typechannelItem 時才會顯示。
contentDetails.channelItem.resourceId object
resourceId 物件包含的資訊可識別新增至管道的資源。