LiveBroadcasts: list

แสดงรายการการออกอากาศของ YouTube ที่ตรงกับพารามิเตอร์คำขอของ API

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

ส่งคำขอ

คำขอ HTTP

GET https://www.googleapis.com/youtube/v3/liveBroadcasts

การให้สิทธิ์

คำขอนี้ต้องได้รับการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 ขอบเขต เพื่ออ่านเพิ่มเติม เกี่ยวกับการตรวจสอบสิทธิ์และการให้สิทธิ์ โปรดดูที่การใช้การตรวจสอบสิทธิ์ OAuth 2.0

ขอบเขต
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 ให้รวมเฉพาะการออกอากาศที่มีสถานะตามที่ระบุ

ค่าที่ยอมรับได้ มีดังนี้
  • active – ส่งคืนการถ่ายทอดสดปัจจุบัน
  • all – ส่งคืนการออกอากาศทั้งหมด
  • completed – ส่งกลับการออกอากาศที่สิ้นสุดลงแล้ว
  • upcoming – ส่งคืนการออกอากาศที่ยังไม่เริ่ม
id string
พารามิเตอร์ id ระบุรายการรหัสการออกอากาศ YouTube ที่คั่นด้วยคอมมาซึ่งระบุการออกอากาศที่กำลังถูกดึงมา ในทรัพยากร liveBroadcast พร็อพเพอร์ตี้ id จะระบุรหัสของการออกอากาศ
mine boolean
พารามิเตอร์ mine สามารถใช้เพื่อสั่งให้ API ส่งเฉพาะการออกอากาศของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์แล้วเท่านั้น ตั้งค่าพารามิเตอร์เป็น true เพื่อดึงข้อมูลการออกอากาศของคุณเองเท่านั้น
พารามิเตอร์ที่ไม่บังคับ
broadcastType string
พารามิเตอร์ broadcastType จะกรองการตอบกลับของ API ให้รวมเฉพาะการออกอากาศที่มีประเภทที่ระบุเท่านั้น ควรใช้พารามิเตอร์ในคำขอที่ตั้งค่าพารามิเตอร์ mine เป็น true หรือที่ใช้พารามิเตอร์ broadcastStatus ค่าเริ่มต้นคือ event

ค่าที่ยอมรับได้ ได้แก่
  • all – ส่งคืนการออกอากาศทั้งหมด
  • event – ส่งคืนเฉพาะการถ่ายทอดกิจกรรมตามกำหนดการ
  • persistent – แสดงผลเฉพาะการออกอากาศต่อเนื่อง
maxResults unsigned integer
พารามิเตอร์ maxResults ระบุจำนวนรายการสูงสุดที่ควรแสดงผลในชุดผลลัพธ์ ค่าที่ยอมรับได้คือ 0 ถึง 50 (รวมค่าแรกและค่าสุดท้าย) ค่าเริ่มต้นคือ 5
onBehalfOfContentOwner string
พารามิเตอร์นี้ใช้ได้เฉพาะในคำขอที่ได้รับอนุญาตอย่างถูกต้องเท่านั้น
หมายเหตุ: พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหาของ YouTube เท่านั้น

พารามิเตอร์ onBehalfOfContentOwner จะระบุว่าข้อมูลเข้าสู่ระบบการให้สิทธิ์ของคำขอระบุผู้ใช้ระบบจัดการเนื้อหา (CMS) ของ YouTube ที่ทำหน้าที่ในนามของเจ้าของเนื้อหาที่ระบุไว้ในค่าพารามิเตอร์ พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหาของ 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 ดูข้อมูลเพิ่มเติมได้ที่การมีสิทธิ์ใช้ฟีเจอร์

ลองใช้งาน

ใช้ APIs Explorer เพื่อเรียกใช้ API นี้ รวมถึงดูคำขอ API และการตอบกลับ