Activities: list

YouTube 已淘汰頻道公告功能。activities.list 方法仍會傳回頻道公告,且系統不再支援 activities.insert 方法。詳情請造訪 YouTube 說明中心

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

配額影響:呼叫此方法的配額費用為 1 單位。

常見用途

要求

HTTP 要求

GET https://www.googleapis.com/youtube/v3/activities

參數

下表列出這項查詢支援的參數。上方列出的所有參數都是查詢參數。

參數
必要參數
part string
part 參數會指定以逗號分隔的清單,其中包含 API 回應所包含的一或多個 activity 資源屬性。

如果參數指定的屬性包含子項資源,則子屬性將納入回應中。舉例來說,在 activity 資源中,snippet 屬性包含可識別活動類型的其他屬性、活動的顯示標題等。如果設定 part=snippet,API 回應也會包含這些巢狀屬性。

以下清單包含可在參數值中加入的 part 名稱:
  • contentDetails
  • id
  • snippet
篩選器 (請僅指定下列其中一個參數)
channelId string
channelId 參數會指定專屬的 YouTube 頻道 ID。接著,API 會傳回該頻道的活動清單。
home boolean
注意:這個參數已淘汰。
在設定此參數的要求中,API 回應包含類似使用者在 YouTube 首頁上看到的項目。請注意,這個參數只能在適當的授權要求中使用。
mine boolean
這個參數只能在妥善的授權要求中使用。將這個參數的值設為 true,即可擷取已驗證使用者活動的資訊提供。
選用參數
maxResults unsigned integer
maxResults 參數會指定要在結果集中傳回的項目數量上限。可接受的值為 050 (含首尾)。預設值為 5
pageToken string
pageToken 參數可指定要傳回結果集中的網頁。在 API 回應中,nextPageTokenprevPageToken 屬性可識別其他可擷取的網頁。
publishedAfter datetime
publishedAfter 參數指定該活動可能開始的最早日期和時間,要納入 API 回應中。假如參數值指定了某一天 (而不是時間),則該日期當天的所有活動都會納入結果集。這個值以 ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) 格式指定。
publishedBefore datetime
publishedBefore 參數會指定活動開始出現之前,該活動要納入 API 回應的日期和時間。假如參數值指定了某一天 (而不是時間),則系統會從結果組合中排除該日期當天的所有活動。這個值以 ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) 格式指定。
regionCode string
regionCode 參數會指示 API 傳回指定國家/地區的結果。參數值為 ISO 3166-1 alpha-2 國家/地區代碼,如果授權使用者先前在 YouTube 上的活動並未提供足夠的資訊來產生活動資訊提供,YouTube 就會使用這個值。

要求主體

呼叫此方法時請不要提供要求主體。

回應

如果成功的話,這個方法會傳回回應內文,其結構如下:

{
  "kind": "youtube#activityListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    activity Resource
  ]
}

屬性

下表定義此資源中顯示的屬性:

屬性
kind string
識別 API 資源類型。這個值會是 youtube#activityListResponse
etag etag
這項資源的 Etag。
nextPageToken string
這個符記可用做 pageToken 參數的值,以擷取結果集的下一頁。
prevPageToken string
這個符記可用做 pageToken 參數的值,以擷取結果集的上一頁。
pageInfo object
pageInfo 物件會封裝結果集的分頁資訊。
pageInfo.totalResults integer
結果集中的結果總數。
pageInfo.resultsPerPage integer
API 回應中包含的結果數量。
items[] list
符合要求條件的活動或事件清單。

錯誤

下表說明 API 在回應此方法時可能傳回的錯誤訊息。詳情請參閱錯誤訊息說明文件。

錯誤類型 錯誤詳細資料 說明
forbidden (403) forbidden 要求未獲適當授權。
forbidden (403) homeParameterDeprecated 無法透過這個 API 取得使用者的首頁活動資料。如果您在未經授權的要求中將 home 參數設為 true,可能會發生這個錯誤。
notFound (404) channelNotFound 找不到由要求的 channelId 參數識別的頻道 ID。
notFound (404) homeChannelNotFound 找不到目前已驗證使用者的 YouTube 首頁推薦內容。
unauthorized (401) authorizationRequired 要求使用 home 參數,但未獲得適當授權。

試試看!

使用 APIs Explorer 呼叫這個 API 並查看 API 要求和回應。