Sponsors: list

注意：此方法已於 2020 年 3 月 31 日淘汰。已由 members.list 方法取代。如需此方法的相關資訊，請參閱 YouTube Data API 說明文件。

2020 年 9 月 30 日當天或之後，系統將不再支援 sponsors.list 方法。API 用戶端應將呼叫 sponsors.list 方法更新為使用 members.list 方法。

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

常見用途

要求

HTTP 要求

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

授權

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

內容範圍
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

參數

下表列出此查詢支援的參數。這裡列出的參數全都是查詢參數。

參數
必要參數
part string
part 參數會指定 API 回應會包含的 sponsor 資源部分。支援的值為 id 和 snippet。
選用參數
filter string
filter 參數會指定要傳回的頻道贊助內容。預設值為 newest。

可接受的值如下：
  • all：傳回所有贊助者 (由新到舊)。
  • newest：返回最近贊助者的一頁。後續使用 nextPageToken 的要求會在註冊時擷取較新的訂閱者。
maxResults unsigned integer
maxResults 參數會指定結果集應傳回的項目數量上限。可接受的值為 0 到 50 (含頭尾)。預設值為 5。
pageToken string
pageToken 參數可在結果集中指明應傳回的特定網頁。在 API 回應中，nextPageToken 和 prevPageToken 屬性會識別其他可擷取的網頁。

要求主體

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

回應

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

{
  "kind": "youtube#sponsorListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    sponsor resource
  ]
}

屬性

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

屬性
kind string
識別 API 資源的類型。值為 youtube#sponsorListResponse。
etag etag
這項資源的 Etag。
nextPageToken string
可做為 pageToken 參數值的權杖，用於擷取結果集中的下一頁。
pageInfo object
pageInfo 物件會封裝結果集的分頁資訊。
pageInfo.totalResults integer
結果集的結果總數。
pageInfo.resultsPerPage integer
API 回應中包含的結果數量。
items[] list
符合要求條件的贊助商清單。

錯誤

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

錯誤類型 錯誤詳細資料 說明
forbidden (403) insufficientPermissions 您的權限不足，無法查看頻道贊助者。
invalidValue (400) invalidValueInRequest 要求包含無效值。
invalidValue (400) sponsorshipNotEnabledForChannelId 這個頻道未啟用贊助功能。

試試看！

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