Sponsors: list
จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน
บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ
หมายเหตุ: เราเลิกใช้งานวิธีนี้ตั้งแต่วันที่ 31 มีนาคม 2020 ซึ่งแทนที่ด้วยเมธอด
members.list คุณดูข้อมูลเกี่ยวกับเมธอดดังกล่าวได้ในเอกสาร YouTube Data API
ระบบจะไม่รองรับเมธอด
sponsors.list อีกต่อไปตั้งแต่วันที่ 30 กันยายน 2020
ไคลเอ็นต์ API ควรอัปเดตการเรียกเมธอด
sponsors.list เพื่อใช้เมธอด
members.list แทน
แสดงสมาชิก (ก่อนหน้านี้เรียกว่า "ผู้สนับสนุน") สำหรับช่อง คำขอ API ต้องได้รับอนุญาตจากเจ้าของช่อง
Use Case ทั่วไป
ส่งคำขอ
คำขอ HTTP
GET https://www.googleapis.com/youtube/v3/sponsors
การให้สิทธิ์
คำขอนี้ต้องได้รับการให้สิทธิ์อย่างน้อย 1 ขอบเขตต่อไปนี้ (อ่านเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์)
| ขอบเขต |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtube.readonly |
พารามิเตอร์
ตารางต่อไปนี้แสดงพารามิเตอร์ที่การค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงอยู่เป็นพารามิเตอร์การค้นหา
| พารามิเตอร์ |
| พารามิเตอร์ที่จำเป็น |
part |
string
พารามิเตอร์ part จะระบุส่วนทรัพยากร sponsor ที่การตอบกลับจาก API จะรวมไว้ ค่าที่รองรับคือ id และ snippet |
| พารามิเตอร์ที่ไม่บังคับ |
filter |
string
พารามิเตอร์ filter จะระบุผู้สนับสนุนช่องที่จะแสดง ค่าเริ่มต้นคือ newest
ค่าที่ยอมรับได้มีดังนี้
all – ส่งคืนผู้สนับสนุนทั้งหมดตั้งแต่ใหม่สุดไปเก่าสุดnewest – กลับไปยังหน้าของผู้สนับสนุนล่าสุด 1 หน้า คำขอที่ตามมาที่ใช้ 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
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 4.0 และตัวอย่างโค้ดได้รับอนุญาตภายใต้ใบอนุญาต Apache 2.0 เว้นแต่จะระบุไว้เป็นอย่างอื่น โปรดดูรายละเอียดที่นโยบายเว็บไซต์ Google Developers Java เป็นเครื่องหมายการค้าจดทะเบียนของ Oracle และ/หรือบริษัทในเครือ
อัปเดตล่าสุด 2024-04-26 UTC
[null,null,["อัปเดตล่าสุด 2024-04-26 UTC"],[],[],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."]]
