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 參數的值，以擷取結果集中的下一頁。分頁權杖可能會過期，應用程式應捨棄權杖並呼叫 API，而不使用 pageToken 啟動新要求。
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 個，就會發生這項錯誤。