本頁面由 Cloud Translation API 翻譯而成。

Groups: list

傳回符合 API 要求參數的群組清單。舉例來說，您可以擷取已驗證使用者擁有的所有群組，也可以根據一或多個群組的專屬 ID 擷取這些群組。

要求

GET https://youtubeanalytics.googleapis.com/v2/groups

這項要求需要授權，且至少包含下列其中一個範圍 (進一步瞭解驗證和授權)。

範圍
https://www.googleapis.com/auth/yt-analytics.readonly	查看 YouTube 內容的 YouTube 數據分析報表。這個範圍可讓您存取使用者活動指標，例如觀看次數和評分次數。
https://www.googleapis.com/auth/yt-analytics-monetary.readonly	查看 YouTube 內容的 YouTube 數據分析報表。這個範圍可存取使用者活動指標，以及預估收益和廣告成效指標。
https://www.googleapis.com/auth/youtube	管理 YouTube 帳戶。在 YouTube Analytics API 中，頻道擁有者可使用這個範圍管理 YouTube Analytics 群組和群組項目。
https://www.googleapis.com/auth/youtubepartner	查看及管理 YouTube 上的資產和相關內容。在 YouTube Analytics API 中，內容擁有者可使用這個範圍管理 YouTube Analytics 群組和群組項目。

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

參數
篩選器 (請指定下列任一參數)
`id`	`string` `id` 參數會指定一份以半形逗號分隔的清單，列出您要擷取的資源使用的 YouTube 群組 ID。每個群組都必須由經過驗證的使用者擁有。在 `group` 資源中，`id` 屬性會指定群組的 YouTube 群組 ID。請注意，如果未指定 `id` 參數的值，就必須將 `mine` 參數設為 `true`。
`mine`	`boolean` 這個參數只能用於適當的授權要求。如要擷取已驗證使用者擁有的所有群組，請將這個參數的值設為 `true`。
選用參數
`onBehalfOfContentOwner`	`string` 這個參數只能用於適當的授權要求。注意：這個參數僅適用於擁有及管理許多不同 YouTube 頻道的 YouTube 內容合作夥伴。 `onBehalfOfContentOwner` 參數表示要求的授權憑證可識別 YouTube 使用者，這些使用者是代表參數值中指定的內容擁有者。這項功能可讓內容擁有者驗證一次，即可存取所有影片和頻道資料，不必為每個頻道提供驗證憑證。使用者驗證的帳戶必須連結至指定的 YouTube 內容擁有者。
`pageToken`	`string` `pageToken` 參數會在結果集中標示應傳回的特定網頁。在 API 回應中，`nextPageToken` 屬性會識別下一個可擷取的網頁。

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

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

{
  "kind": "youtube#groupListResponse",
  "etag": etag,
  "items": [
    group Resource
  ],
  "nextPageToken": string
}

下表定義了這個資源中顯示的屬性：

屬性
`kind`	`string` 識別 API 資源的類型。值為 `youtube#groupListResponse`。
`etag`	`etag` 這項資源的 Etag。
`items[]`	`list` 符合 API 要求參數的群組清單。清單中的每個項目都代表一個 `group` 資源。
`nextPageToken`	`string` 可用於做為 `pageToken` 參數值的符記，用於擷取結果集的下一頁。

這個 API 不會定義任何專屬於此 API 方法的錯誤訊息。不過，這個方法仍可能傳回錯誤訊息說明文件中列出的一般 API 錯誤。

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