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