Captions: insert

อัปโหลดแทร็กคำบรรยายวิดีโอ

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

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

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

Use Case ทั่วไป

ส่งคำขอ

คำขอ HTTP

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

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

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

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

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

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

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

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

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

  • คุณกำหนดค่าสำหรับพร็อพเพอร์ตี้เหล่านี้ได้

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

คำตอบ

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

ข้อผิดพลาด

ตารางต่อไปนี้ระบุข้อความแสดงข้อผิดพลาดที่ 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