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 ระบุหน้าเฉพาะในชุดผลลัพธ์ที่ควรแสดง ในพร็อพเพอร์ตี้ nextPageToken และ prevPageToken ของการตอบกลับจาก API จะระบุหน้าอื่นๆ ที่ดึงข้อมูลได้

เนื้อความของคำขอ

อย่าระบุเนื้อความของคำขอเมื่อเรียกใช้เมธอดนี้

คำตอบ

หากทำสำเร็จ เมธอดนี้จะแสดงเนื้อหาการตอบกลับที่มีโครงสร้างดังต่อไปนี้

{
  "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