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 回應此方法時可能傳回的錯誤訊息。詳情請參閱錯誤訊息的說明文件。
試試看！
使用 APIs Explorer 呼叫這個 API 並查看 API 要求和回應。
除非另有註明，否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權，程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間：2024-04-26 (世界標準時間)。
[null,null,["上次更新時間：2024-04-26 (世界標準時間)。"],[],[],null,["# Sponsors: list\n\nNote: This method is deprecated as of March 31, 2020. It has been replaced by the [members.list](/youtube/v3/docs/members/list) method. You can find information about that method in the YouTube Data API documentation. \n\nThe `sponsors.list` method will no longer be supported on or after September 30, 2020. API clients should update calls to the `sponsors.list` method to use the [members.list](/youtube/v3/docs/members/list) method instead.\n\nLists members (formerly known as \"sponsors\") for a channel. The API request must be authorized\nby the channel owner.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/youtube/v3/sponsors\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes ([read more about authentication and authorization](/youtube/v3/live/authentication)).\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/youtube` |\n| `https://www.googleapis.com/auth/youtube.force-ssl` |\n| `https://www.googleapis.com/auth/youtube.readonly` |\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter specifies the `sponsor` resource parts that the API response will include. Supported values are `id` and `snippet`. |\n| **Optional parameters** |||\n| `filter` | `string` The **filter** parameter specifies which channel sponsors to return. The default value is `newest`. Acceptable values are: - **all** -- Return all sponsors, from newest to oldest. - **newest** -- Return one page of the most recent sponsors. Subsequent requests using the [nextPageToken](#nextPageToken) retrieve newer subscribers as they sign up. |\n| `maxResults` | `unsigned integer` The **maxResults** parameter specifies the maximum number of items that should be returned in the result set. Acceptable values are `0` to `50`, inclusive. The default value is `5`. |\n| `pageToken` | `string` The **pageToken** parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` and `prevPageToken` properties identify other pages that could be retrieved. |\n\n### Request body\n\nDo not provide a request body when calling this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure: \n\n```objective-c\n{\n \"kind\": \"youtube#sponsorListResponse\",\n \"etag\": etag,\n \"nextPageToken\": string,\n \"pageInfo\": {\n \"totalResults\": integer,\n \"resultsPerPage\": integer\n },\n \"items\": [\n sponsor resource\n ]\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|---------------------------|----------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#sponsorListResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `nextPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set. |\n| `pageInfo` | `object` The `pageInfo` object encapsulates paging information for the result set. |\n| pageInfo.`totalResults` | `integer` The total number of results in the result set. |\n| pageInfo.`resultsPerPage` | `integer` The number of results included in the API response. |\n| `items[]` | `list` A list of sponsors that match the request criteria. |\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. Please see the [error message](/youtube/v3/live/docs/errors) documentation for more detail.\n\n| Error type | Error detail | Description |\n|----------------------|-------------------------------------|---------------------------------------------------------------------------|\n| `forbidden (403)` | `insufficientPermissions` | You do not have the necessary permissions to view the channel's sponsors. |\n| `invalidValue (400)` | `invalidValueInRequest` | The request contains an invalid value. |\n| `invalidValue (400)` | `sponsorshipNotEnabledForChannelId` | The channel does not have sponsorships enabled. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
