Captions: insert

อัปโหลดแทร็กคำบรรยายแทนเสียง

วิธีนี้รองรับการอัปโหลดสื่อ ไฟล์ที่อัปโหลดต้องเป็นไปตามข้อจำกัดต่อไปนี้

  • ขนาดไฟล์สูงสุด: 100 MB
  • ประเภท MIME ของสื่อที่ยอมรับ: text/xml, application/octet-stream, */*

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

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

ส่งคำขอ

คำขอ HTTP

POST https://www.googleapis.com/upload/youtube/v3/captions

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

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

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

พารามิเตอร์

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

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

รายการต่อไปนี้มีชื่อ part ที่คุณใส่ไว้ในค่าพารามิเตอร์ได้
  • id
  • snippet
พารามิเตอร์ที่ไม่บังคับ
onBehalfOfContentOwner string
พารามิเตอร์นี้ใช้ได้เฉพาะในคำขอที่ได้รับอนุญาตอย่างถูกต้องเท่านั้น

หมายเหตุ: พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหา YouTube โดยเฉพาะ

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

คุณควรตั้งค่าพารามิเตอร์ sync เป็น true หากคุณอัปโหลดข้อความถอดเสียงที่ไม่มีรหัสเวลา หรือหากคุณสงสัยว่ารหัสเวลาในไฟล์ไม่ถูกต้องและต้องการให้ YouTube พยายามแก้ไข

เนื้อหาของคำขอ

ระบุแหล่งข้อมูล caption ในเนื้อหาคําขอ สำหรับทรัพยากรนั้น

คุณต้องระบุค่าสำหรับพร็อพเพอร์ตี้ต่อไปนี้

  • snippet.videoId
  • snippet.language
  • snippet.name

คุณตั้งค่าพร็อพเพอร์ตี้ต่อไปนี้ได้

  • snippet.videoId
  • snippet.language
  • snippet.name
  • snippet.isDraft

คำตอบ

หากทําสําเร็จ เมธอดนี้จะแสดงทรัพยากร caption ในเนื้อหาการตอบกลับ

ข้อผิดพลาด

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

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
badRequest (400) contentRequired คำขอไม่มีเนื้อหาแทร็กคำบรรยายแทนเสียง
conflict (409) captionExists วิดีโอที่ระบุมีแทร็กคำบรรยายแทนเสียงที่มี snippet.language และ snippet.name ดังกล่าวอยู่แล้ว วิดีโออาจมีหลายแทร็กสำหรับภาษาเดียวกัน แต่แต่ละแทร็กต้องมีชื่อต่างกัน

การแก้ไขข้อผิดพลาดนี้ทำได้หลายวิธี คุณสามารถลบแทร็กที่มีอยู่แล้วแทรกแทร็กใหม่ หรือเปลี่ยนชื่อแทร็กใหม่ก่อนที่จะแทรกก็ได้
forbidden (403) forbidden สิทธิ์ที่เชื่อมโยงกับคำขอไม่เพียงพอที่จะอัปโหลดแทร็กคำบรรยายแทนเสียง คำขออาจไม่ได้รับอนุญาตอย่างเหมาะสม
invalidValue (400) invalidMetadata คำขอมีค่าข้อมูลเมตาที่ไม่ถูกต้อง ซึ่งทำให้ระบบสร้างแทร็กไม่ได้ ยืนยันว่าคำขอระบุค่าที่ถูกต้องสำหรับพร็อพเพอร์ตี้ snippet.language, snippet.name และ snippet.videoId คุณรวมพร็อพเพอร์ตี้ snippet.isDraft ได้ด้วย แต่ไม่จำเป็นต้องทำ
notFound (404) videoNotFound ไม่พบวิดีโอที่ระบุโดยพารามิเตอร์ videoId
invalidValue (400) nameTooLong snippet.name ที่ระบุในคำขอยาวเกินไป ความยาวสูงสุดที่รองรับคือ 150 อักขระ

ลองใช้งาน

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