Captions: list

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

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

Use Case ทั่วไป

ส่งคำขอ

คำขอ 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