แสดงรายการการออกอากาศของ YouTube ที่ตรงกับพารามิเตอร์คำขอ API
Use Case ทั่วไป
ส่งคำขอ
คำขอ HTTP
GET https://www.googleapis.com/youtube/v3/liveBroadcasts
การให้สิทธิ์
คำขอนี้จำเป็นต้องให้สิทธิ์พร้อมขอบเขตต่อไปนี้อย่างน้อย 1 ขอบเขต (อ่านเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์)
ขอบเขต |
---|
https://www.googleapis.com/auth/youtube.readonly |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
พารามิเตอร์
ตารางต่อไปนี้แสดงพารามิเตอร์ที่การค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงอยู่เป็นพารามิเตอร์การค้นหา
พารามิเตอร์ | ||
---|---|---|
พารามิเตอร์ที่จำเป็น | ||
part |
string พารามิเตอร์ part จะระบุรายการที่คั่นด้วยคอมมาของพร็อพเพอร์ตี้ทรัพยากร liveBroadcast อย่างน้อย 1 รายการซึ่งการตอบกลับของ API จะรวมไว้ด้วย ชื่อ part ที่คุณใส่ไว้ในค่าพารามิเตอร์ได้คือ id , snippet , contentDetails , monetizationDetails และ status |
|
ตัวกรอง (ระบุพารามิเตอร์ใดพารามิเตอร์หนึ่งต่อไปนี้) | ||
broadcastStatus |
string พารามิเตอร์ broadcastStatus จะกรองการตอบสนองของ API ให้รวมเฉพาะการออกอากาศที่มีสถานะที่ระบุเท่านั้นค่าที่ยอมรับมีดังนี้
|
|
id |
string พารามิเตอร์ id จะระบุรายการรหัสการออกอากาศของ YouTube ที่คั่นด้วยคอมมา ซึ่งระบุรายการออกอากาศที่กำลังเรียกดูอยู่ ในทรัพยากร liveBroadcast พร็อพเพอร์ตี้ id ระบุรหัสของการออกอากาศ |
|
mine |
boolean พารามิเตอร์ mine สามารถใช้เพื่อสั่งให้ API แสดงผลเฉพาะการออกอากาศที่เป็นของผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์เท่านั้น ตั้งค่าพารามิเตอร์เป็น true เพื่อดึงเฉพาะการออกอากาศของคุณเอง |
|
พารามิเตอร์ที่ไม่บังคับ | ||
broadcastType |
string พารามิเตอร์ broadcastType จะกรองการตอบสนองของ API ให้รวมเฉพาะการออกอากาศที่มีประเภทที่ระบุเท่านั้น ควรใช้พารามิเตอร์ในคำขอที่ตั้งค่าพารามิเตอร์ mine เป็น true หรือที่ใช้พารามิเตอร์ broadcastStatus ค่าเริ่มต้นคือ event ค่าที่ยอมรับมีดังนี้
|
|
maxResults |
unsigned integer พารามิเตอร์ maxResults จะระบุจำนวนรายการสูงสุดที่ควรแสดงผลในชุดผลลัพธ์ ค่าที่ยอมรับคือ 0 ถึง 50 ค่าเริ่มต้นคือ 5 |
|
onBehalfOfContentOwner |
string พารามิเตอร์นี้ใช้ได้เฉพาะในคำขอที่ได้รับอนุญาตที่ถูกต้องเท่านั้น หมายเหตุ: พารามิเตอร์นี้มีไว้สําหรับพาร์ทเนอร์เนื้อหาของ YouTube เท่านั้น พารามิเตอร์ onBehalfOfContentOwner ระบุว่าข้อมูลเข้าสู่ระบบการให้สิทธิ์ของคําขอระบุผู้ใช้ YouTube CMS ที่ดําเนินการในนามของเจ้าของเนื้อหาที่ระบุไว้ในค่าพารามิเตอร์ พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์ด้านเนื้อหาของ YouTube ที่เป็นเจ้าของและจัดการช่อง YouTube ต่างๆ จำนวนมาก ซึ่งช่วยให้เจ้าของเนื้อหาตรวจสอบสิทธิ์เพียงครั้งเดียวและมีสิทธิ์เข้าถึงข้อมูลวิดีโอและช่องทั้งหมดโดยไม่ต้องระบุข้อมูลเข้าสู่ระบบการตรวจสอบสิทธิ์สำหรับแต่ละช่อง บัญชี CMS ที่ผู้ใช้ตรวจสอบสิทธิ์จะต้องลิงก์กับเจ้าของเนื้อหา YouTube ที่ระบุ |
|
onBehalfOfContentOwnerChannel |
string พารามิเตอร์นี้ใช้ได้เฉพาะในคำขอที่ได้รับอนุญาตที่ถูกต้องเท่านั้น พารามิเตอร์นี้ใช้ได้เฉพาะในคำขอที่ได้รับอนุญาตอย่างถูกต้องเท่านั้น หมายเหตุ: พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหาของ YouTube เท่านั้น พารามิเตอร์ onBehalfOfContentOwnerChannel จะระบุรหัสช่อง YouTube ของช่องที่กำลังเพิ่มวิดีโอ ต้องระบุพารามิเตอร์นี้เมื่อคำขอระบุค่าสำหรับพารามิเตอร์ onBehalfOfContentOwner และใช้ร่วมกับพารามิเตอร์ดังกล่าวได้เท่านั้น นอกจากนี้ คำขอจะต้องได้รับอนุญาตโดยใช้บัญชี CMS ที่ลิงก์กับเจ้าของเนื้อหาที่พารามิเตอร์ onBehalfOfContentOwner ระบุไว้ สุดท้าย ช่องที่ระบุค่าพารามิเตอร์ onBehalfOfContentOwnerChannel จะต้องลิงก์กับเจ้าของเนื้อหาที่พารามิเตอร์ onBehalfOfContentOwner ระบุไว้พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหาของ YouTube ที่เป็นเจ้าของและจัดการช่อง YouTube ต่างๆ จำนวนมาก ช่วยให้เจ้าของเนื้อหาตรวจสอบสิทธิ์ครั้งเดียวและดำเนินการต่างๆ ในนามของช่องที่ระบุไว้ในค่าพารามิเตอร์ได้ โดยไม่ต้องระบุข้อมูลเข้าสู่ระบบการตรวจสอบสิทธิ์สำหรับแต่ละช่อง |
|
pageToken |
string พารามิเตอร์ pageToken ระบุหน้าที่เฉพาะเจาะจงในชุดผลลัพธ์ที่ควรแสดงผล ในการตอบกลับของ API พร็อพเพอร์ตี้ nextPageToken และ prevPageToken จะระบุหน้าอื่นๆ ที่ดึงได้ |
เนื้อหาของคำขอ
ไม่ต้องให้เนื้อหาคำขอเมื่อเรียกใช้วิธีการนี้
คำตอบ
หากทำสำเร็จ เมธอดนี้จะส่งเนื้อหาการตอบกลับที่มีโครงสร้างต่อไปนี้กลับมา
{ "kind": "youtube#liveBroadcastListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveBroadcast Resource ] }
พร็อพเพอร์ตี้
ตารางต่อไปนี้จะกำหนดพร็อพเพอร์ตี้ที่ปรากฏในทรัพยากรนี้
พร็อพเพอร์ตี้ | |
---|---|
kind |
string ระบุประเภทของทรัพยากร API ค่าจะเป็น youtube#liveBroadcastListResponse |
etag |
etag Etag ของทรัพยากรนี้ |
nextPageToken |
string โทเค็นที่ใช้เป็นค่าของพารามิเตอร์ pageToken เพื่อดึงหน้าถัดไปในชุดผลลัพธ์ |
prevPageToken |
string โทเค็นที่ใช้เป็นค่าพารามิเตอร์ pageToken เพื่อดึงหน้าก่อนหน้าในชุดผลลัพธ์ได้ |
pageInfo |
object ออบเจ็กต์ pageInfo สรุปข้อมูลการแบ่งหน้าสำหรับชุดผลลัพธ์ |
pageInfo.totalResults |
integer จำนวนผลการค้นหาทั้งหมดในชุดผลลัพธ์ |
pageInfo.resultsPerPage |
integer จำนวนผลลัพธ์ที่รวมอยู่ในการตอบกลับของ API |
items[] |
list รายการประกาศที่ตรงกับเกณฑ์คำขอ |
ข้อผิดพลาด
ตารางต่อไปนี้ระบุข้อความแสดงข้อผิดพลาดที่ API อาจแสดงผลเพื่อตอบสนองต่อการเรียกเมธอดนี้ โปรดดูรายละเอียดเพิ่มเติมในเอกสารประกอบเกี่ยวกับข้อความแสดงข้อผิดพลาด
ประเภทข้อผิดพลาด | รายละเอียดข้อผิดพลาด | คำอธิบาย |
---|---|---|
insufficientPermissions |
insufficientLivePermissions |
คำขอไม่ได้รับอนุญาตให้เรียกดูการถ่ายทอดสด |
insufficientPermissions |
liveStreamingNotEnabled |
ผู้ใช้ที่ให้สิทธิ์ตามคำขอไม่ได้เปิดใช้การสตรีมวิดีโอสดบน YouTube ผู้ใช้สามารถดูข้อมูลเพิ่มเติมได้ที่ https://www.youtube.com/features |
ลองใช้เลย
ใช้ APIs Explorer เพื่อเรียกใช้ API นี้ และดูคำขอ API และการตอบสนอง