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 上的活動並未提供充足的資訊來產生活動動態消息,系統就會使用這個值。

要求主體

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

回應

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

{
  "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 要求和回應。