Captions: list

แสดงผลรายการแทร็กคำบรรยายแทนเสียงที่เชื่อมโยงกับวิดีโอที่ระบุ โปรดทราบว่าการตอบกลับจาก API จะไม่มีคำบรรยายจริง และเมธอด captions.download จะช่วยให้คุณดึงแทร็กคำบรรยายแทนเสียงได้

ผลกระทบต่อโควต้า: การเรียกเมธอดนี้มีค่าใช้จ่ายโควต้า 50 หน่วย

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

ส่งคำขอ

คำขอ HTTP

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

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

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

ขอบเขต
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

พารามิเตอร์

ตารางต่อไปนี้แสดงพารามิเตอร์ที่การค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่แสดงเป็นพารามิเตอร์การค้นหา

พารามิเตอร์
พารามิเตอร์ที่จำเป็น
part string
พารามิเตอร์ part จะระบุส่วนของทรัพยากร caption ที่การตอบกลับจาก API จะรวมไว้

รายการด้านล่างมีชื่อ part ที่คุณสามารถรวมไว้ในค่าพารามิเตอร์
  • id
  • snippet
videoId string
พารามิเตอร์ videoId จะระบุรหัสวิดีโอ YouTube ของวิดีโอที่ API ควรแสดงแทร็กคำบรรยายแทนเสียง
พารามิเตอร์ที่ไม่บังคับ
id string
พารามิเตอร์ id จะระบุรายการที่คั่นด้วยคอมมาของรหัสที่ระบุทรัพยากร caption ที่ควรดึงข้อมูล รหัสแต่ละรายการต้องระบุแทร็กคำบรรยายแทนเสียงที่เชื่อมโยงกับวิดีโอที่ระบุ
onBehalfOfContentOwner string
พารามิเตอร์นี้ใช้ได้เฉพาะในคำขอที่ได้รับอนุญาตอย่างถูกต้อง หมายเหตุ: พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหาของ YouTube เท่านั้น

พารามิเตอร์ onBehalfOfContentOwner บ่งชี้ว่าข้อมูลเข้าสู่ระบบการให้สิทธิ์ของคำขอระบุผู้ใช้ YouTube CMS ที่ดำเนินการในนามของเจ้าของเนื้อหาที่ระบุในค่าพารามิเตอร์ พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหาของ YouTube ที่เป็นเจ้าของและจัดการช่อง YouTube หลายช่อง ซึ่งช่วยให้เจ้าของเนื้อหาตรวจสอบสิทธิ์ได้ครั้งเดียวและเข้าถึงข้อมูลวิดีโอและช่องทั้งหมดได้โดยไม่ต้องระบุข้อมูลรับรองการตรวจสอบสิทธิ์สำหรับแต่ละช่อง บัญชี CMS จริงที่ผู้ใช้ตรวจสอบสิทธิ์ต้องลิงก์กับเจ้าของเนื้อหา YouTube ที่ระบุ

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

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

คำตอบ

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

{
  "kind": "youtube#captionListResponse",
  "etag": etag,
  "items": [
    caption Resource
  ]
}

พร็อพเพอร์ตี้

ตารางต่อไปนี้กำหนดพร็อพเพอร์ตี้ที่ปรากฏในทรัพยากรนี้

พร็อพเพอร์ตี้
kind string
ระบุประเภทของทรัพยากร API ค่าจะเป็น youtube#captionListResponse
etag etag
Etag ของทรัพยากรนี้
items[] list
รายการคำบรรยายที่ตรงกับเกณฑ์คำขอ

ข้อผิดพลาด

ตารางต่อไปนี้ระบุข้อความแสดงข้อผิดพลาดที่ API อาจแสดงผลเพื่อตอบสนองต่อการเรียกเมธอดนี้ โปรดดูรายละเอียดเพิ่มเติมในเอกสารประกอบข้อความแสดงข้อผิดพลาด

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
forbidden (403) forbidden ไม่สามารถดึงแทร็กคำบรรยายแทนเสียงอย่างน้อย 1 รายการเนื่องจากสิทธิ์ที่เชื่อมโยงกับคำขอไม่เพียงพอที่จะดึงทรัพยากรที่ขอ คำขออาจไม่ได้รับอนุญาตอย่างถูกต้อง
notFound (404) captionNotFound ไม่พบแทร็กคำบรรยายแทนเสียงที่ระบุอย่างน้อย 1 รายการ ข้อผิดพลาดนี้เกิดขึ้นหากพารามิเตอร์ videoId ระบุวิดีโอจริง แต่พารามิเตอร์ id ระบุรหัสแทร็กคำบรรยายที่ไม่มีอยู่ หรือรหัสแทร็กที่เชื่อมโยงกับวิดีโออื่นๆ ตรวจสอบค่าของพารามิเตอร์ id และ videoId ของคำขอเพื่อให้แน่ใจว่าถูกต้อง
notFound (404) videoNotFound ไม่พบวิดีโอที่ระบุโดยพารามิเตอร์ videoId

ลองใช้งาน

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