本頁面由 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 數據分析的群組和群組項目。
https://www.googleapis.com/auth/youtubepartner	查看及管理 YouTube 資產和 YouTube 上的相關內容。內容擁有者可以在 YouTube Analytics API 中使用這個範圍來管理 YouTube 數據分析的群組和群組項目。

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

參數
篩選器 (請僅指定下列其中一個參數)
`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 要求和回應。