Sponsors: list

หมายเหตุ: วิธีนี้เลิกใช้งานตั้งแต่วันที่ 31 มีนาคม 2020 ซึ่งมีการแทนที่ด้วยเมธอด members.list คุณดูข้อมูลเกี่ยวกับวิธีการดังกล่าวได้ในเอกสารประกอบของ YouTube Data API

ตั้งแต่วันที่ 30 กันยายน 2020 เป็นต้นไป ระบบจะไม่รองรับเมธอด sponsors.list อีกต่อไป ไคลเอ็นต์ API ควรอัปเดตการเรียกใช้เมธอด sponsors.list เพื่อใช้เมธอด members.list แทน

รายชื่อสมาชิกของช่อง (ก่อนหน้านี้เรียกว่า "ผู้สนับสนุน") สําหรับช่อง เจ้าของช่องต้องเป็นผู้อนุญาตคําขอ API

กรณีการใช้งานทั่วไป

ส่งคำขอ

คำขอ 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 อาจแสดงเพื่อตอบสนองต่อการเรียกเมธอดนี้ โปรดดูรายละเอียดเพิ่มเติมในเอกสารประกอบข้อความแสดงข้อผิดพลาด

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
forbidden (403) insufficientPermissions คุณไม่มีสิทธิ์ที่จําเป็นในการดูผู้สนับสนุนของช่อง
invalidValue (400) invalidValueInRequest คําขอมีค่าที่ไม่ถูกต้อง
invalidValue (400) sponsorshipNotEnabledForChannelId ช่องนี้ไม่ได้เปิดใช้ผู้สนับสนุน

ลองใช้เลย

ใช้ APIs Explorer เพื่อเรียกใช้ API นี้และดูคําขอและการตอบกลับ API