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 ค่าที่ยอมรับได้มีดังนี้
|
|
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