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 資源部分。支援的值為 idsnippet
選用參數
filter string
filter 參數會指定要傳回哪個頻道的贊助商。預設值為 newest

可接受的值為:
  • all - 傳回所有贊助者 (從最新到最舊)。
  • newest - 傳回最近一個贊助商的一個網頁。後續使用 nextPageToken 的要求會在註冊時擷取較新的訂閱者。
maxResults unsigned integer
maxResults 參數會指定要在結果集中傳回的項目數量上限。可接受的值為 050 (含首尾)。預設值為 5
pageToken string
pageToken 參數可指定要傳回結果集中的網頁。在 API 回應中,nextPageTokenprevPageToken 屬性可識別其他可擷取的網頁。

要求主體

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

回應

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

{
  "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 要求和回應。