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

Members: list

注意：只有個別創作者可以使用這個端點，針對已啟用頻道頻道會員功能的 YouTube 頻道提出要求。請與您的 Google 或 YouTube 代表聯絡，要求存取權。

列出頻道的會員 (舊稱「贊助方」)。API 要求必須由管道擁有者授權。

配額影響：呼叫此方法的配額費用為 2 個單位。

要求

HTTP 要求

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

授權

此要求需要以下範圍的授權：

範圍
`https://www.googleapis.com/auth/youtube.channel-memberships.creator`

參數

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

參數
必要參數
`part`	`string` `part` 參數會指定 API 回應將包含的 `member` 資源屬性。將參數值設為 `snippet`。
選用參數
`mode`	`string` `mode` 參數會指出將哪些成員納入 API 回應中。將參數值設為下列其中一個值： `all_current` (預設)：列出目前的成員，由新到舊。使用此值時，當 API 回應不含 `nextPageToken` 時，系統會在清單結束時到達。 `updates` - 只列出上次 API 呼叫後加入或升級的成員。請注意，第一次呼叫會啟動新的更新串流，但實際上不會傳回任何成員。如要開始擷取成員資格更新，您必須使用 `nextPageToken` 以所需的頻率輪詢端點。請注意，使用這個值時，API 回應一律包含 `nextPageToken`。
`maxResults`	`unsigned integer` `maxResults` 參數會指定要在結果集中傳回的項目數量上限。可接受的值為 `0` 到 `1000` (含首尾)。預設值為 `5`。
`pageToken`	`string` `pageToken` 參數可指定要傳回結果集中的特定網頁。憑證專屬於原始 API 要求使用的 `mode`，因此您無法使用單一模式擷取的頁面憑證，然後再切換至其他模式。
`hasAccessToLevel`	`string` `hasAccessToLevel` 參數值是等級 ID，用來指定結果集成員應有的最低層級。
`filterByMemberChannelId`	`string` `filterByMemberChannelId` 參數會指定以逗號分隔的頻道 ID 清單，該管道可用來檢查特定使用者的成員資格狀態。例如 `UC_1,UC_2,UC_3`。每次呼叫最多可以指定 100 個頻道。

要求主體

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

回應

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

{
  "kind": "youtube#memberListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    member Resource
  ]
}

屬性

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

屬性
`kind`	`string` 識別 API 資源類型。這個值會是 `youtube#memberListResponse`。
`etag`	`etag` 這項資源的 Etag。
`nextPageToken`	`string` 這個符記可用做 `pageToken` 參數的值，以擷取結果集的下一頁。頁面符記可能過期，您的應用程式應捨棄憑證，並在沒有 `pageToken` 的情況下呼叫 API，以發出新的要求。
`pageInfo`	`object` `pageInfo` 物件會封裝結果集的分頁資訊。
`pageInfo.totalResults`	`integer` 結果集中的結果總數。
`pageInfo.resultsPerPage`	`integer` API 回應中包含的結果數量。
`items[]`	`list` 符合要求條件的成員清單。

錯誤

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

錯誤類型	錯誤詳細資料	說明
`badRequest (400)`	`channelMembershipsNotEnabled`	授權要求的創作者頻道未啟用頻道會員功能。
`badRequest (400)`	`invalidMode`	`mode` 參數值無效。如果 `pageToken` 參數指定使用的符記與指定模式不同，就會發生這個錯誤。
`badRequest (400)`	`invalidPageToken`	`pageToken` 參數值無效。如果要求中使用的頁面憑證已過期或無法辨識，就可能發生這項錯誤。
`badRequest (400)`	`invalidHasAccessToLevel`	`hasAccessToLevel` 參數值無效。指定的 `id` 沒有層級。
`badRequest (400)`	`invalidFilterByMemberChannelId`	`filterByMemberChannelId` 參數值無效。如果 `filterByMemberChannelId` 參數值指定超過 100 個管道，就會發生這個錯誤。