Activities: list

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

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

配額影響：呼叫這個方法會產生 1 個單位的配額費用。

常見用途

要求

HTTP 要求

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

參數

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

參數
必要參數
part string
part 參數會指定一或多個 activity 資源屬性的半形逗號分隔清單，API 回應會包含這些屬性。

如果參數識別的屬性包含子項屬性，回應中就會包含子項屬性。舉例來說，在 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 參數指定結果集中應傳回的項目數量上限。可接受的值為 0 至 50 (含)。預設值為 5。
pageToken string
pageToken 參數會識別結果集中應傳回的特定頁面。在 API 回應中，nextPageToken 和 prevPageToken 屬性會識別可擷取的其他頁面。
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 要求和回應。