ตัวอย่างต่อไปนี้จะแสดงวิธีใช้ YouTube Data API (v3) ในการทํางานที่เกี่ยวข้องกับคําบรรยาย
ดึงรายการแทร็กคําบรรยายวิดีโอสําหรับวิดีโอ
หากต้องการเรียกรายการแทร็กคําบรรยายวิดีโอที่พร้อมให้บริการสําหรับวิดีโอที่เฉพาะเจาะจง ให้เรียกใช้เมธอด captions.list
ตั้งค่าพารามิเตอร์ videoId
เป็นรหัสวิดีโอ YouTube ซึ่งระบุวิดีโอที่คุณกําลังดึงคําบรรยายไม่ซ้ํากัน คําขอต้องได้รับอนุญาตโดยใช้ OAuth 2.0
คําขอด้านล่างจะดึงรายการคําบรรยายสําหรับวิดีโอในช่อง YouTube ของ Google Stories
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.list? part=snippet &videoId=PRU2ShMzQRg
ดูตัวอย่างโค้ดได้จากเอกสารประกอบของเมธอด captions.list
สร้างแทร็กคําบรรยายวิดีโอ
ทดสอบการค้นหานี้โดยใช้ API Explorer ไม่ได้ เนื่องจาก API Explorer ไม่รองรับความสามารถในการอัปโหลดไฟล์ ซึ่งเป็นข้อกําหนดสําหรับวิธีนี้
คุณใช้เมธอด captions.insert
ของ API เพื่ออัปโหลดแทร็กคําบรรยายวิดีโอใหม่สําหรับวิดีโอได้ เมื่ออัปโหลดแทร็ก คุณต้องระบุค่าสําหรับพร็อพเพอร์ตี้ทรัพยากร caption
ต่อไปนี้
snippet.videoId
- เมตริกนี้ระบุวิดีโอที่กําลังเพิ่มแทร็กคําบรรยายวิดีโอsnippet.language
- ภาษาของแทร็กคําบรรยายวิดีโอsnippet.name
- ชื่อของแทร็กคําบรรยายวิดีโอ
มีตัวเลือกเพิ่มเติมต่อไปนี้เมื่ออัปโหลดแทร็กคําบรรยายวิดีโอ
-
หากตั้งค่าพารามิเตอร์
sync
เป็นtrue
YouTube จะไม่สนใจรหัสเวลาซึ่งอยู่ในไฟล์คําบรรยายวิดีโอที่อัปโหลดและสร้างรหัสเวลาใหม่สําหรับคําบรรยายวิดีโอคุณควรตั้งค่าพารามิเตอร์
sync
เป็นtrue
หากกําลังอัปโหลดข้อความถอดเสียงซึ่งไม่มีรหัสเวลา หรือสงสัยว่ารหัสเวลาในไฟล์ไม่ถูกต้องและต้องการให้ YouTube แก้ไข -
หากคุณตั้งค่าพร็อพเพอร์ตี้
snippet.isDraft
ของทรัพยากรcaption
เป็นtrue
แทร็กจะไม่ปรากฏแบบสาธารณะ
ดูตัวอย่างโค้ดได้จากเอกสารประกอบของเมธอด captions.insert
ดาวน์โหลดแทร็กคําบรรยายวิดีโอ
ทดสอบการค้นหานี้โดยใช้ API Explorer ไม่ได้ เนื่องจาก API Explorer ไม่รองรับความสามารถในการดาวน์โหลดไฟล์
หากต้องการดาวน์โหลดแทร็กคําบรรยายวิดีโอที่เฉพาะเจาะจง ให้เรียกใช้เมธอด captions.download
กําหนดค่าพารามิเตอร์ id
เป็นรหัสแทร็กคําบรรยายวิดีโอ YouTube ที่ระบุแทร็กคําบรรยายที่คุณกําลังดาวน์โหลดอยู่ไม่ซ้ํากัน คําขอต้องได้รับอนุญาตโดยใช้ OAuth 2.0
API v3 รองรับตัวเลือกต่อไปนี้
-
หากต้องการระบุว่าควรส่งแทร็กคําบรรยายวิดีโอในรูปแบบใดรูปแบบหนึ่ง ให้ตั้งค่าค่าพารามิเตอร์
tfmt
เพื่อระบุรูปแบบที่ต้องการ คําจํากัดความของพารามิเตอร์แสดงรายการค่าที่รองรับ -
หากต้องการดึงข้อมูลการแปลแทร็กคําบรรยายวิดีโอ ให้ตั้งค่าค่าพารามิเตอร์
tlang
เป็นรหัสภาษา ISO 639-1 แบบ 2 ตัวอักษรที่ระบุภาษาคําบรรยายวิดีโอที่ต้องการ การแปลเกิดขึ้นโดยใช้การแปลด้วยคอมพิวเตอร์ เช่น Google แปลภาษา
ดูตัวอย่างโค้ดได้จากเอกสารประกอบของเมธอด captions.download
อัปเดตแทร็กคําบรรยายวิดีโอ
API รองรับความสามารถในการเปลี่ยนสถานะแบบร่างของแทร็กคําบรรยายวิดีโอ อัปโหลดแทร็กคําบรรยายวิดีโอใหม่สําหรับไฟล์ หรือทั้ง 2 อย่าง
คุณสามารถใช้ API Explorer เพื่อทดสอบความสามารถในการเปลี่ยนสถานะฉบับร่างของแทร็กได้ อย่างไรก็ตาม คุณไม่สามารถใช้ API Explorer เพื่ออัปเดตแทร็กคําบรรยายวิดีโอจริงได้ เนื่องจากเครื่องมือไม่รองรับความสามารถในการอัปโหลดไฟล์
คําขอด้านล่างจะดึงรายการคําบรรยายสําหรับวิดีโอในช่อง YouTube ของ Google Stories
คําขอจะอัปเดตสถานะฉบับร่างของแทร็กคําบรรยายวิดีโอเป็น true
ซึ่งหมายความว่าแทร็กดังกล่าวจะไม่ปรากฏแบบสาธารณะ หากต้องการส่งคําขอใน API Explorer ให้เสร็จสิ้น คุณต้องตั้งค่าของพร็อพเพอร์ตี้ id
เพื่อระบุแทร็กคําบรรยายวิดีโอ
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update? part=snippet
ดูตัวอย่างโค้ดได้จากเอกสารประกอบของเมธอด captions.update
ลบแทร็กคําบรรยายวิดีโอ
ตัวอย่างนี้แสดงวิธีลบแทร็กคําบรรยายวิดีโอ ตัวอย่างมีขั้นตอนต่อไปนี้
-
ขั้นตอนที่ 1: ดึงข้อมูลรหัสแทร็กคําบรรยายวิดีโอ
ทําตามขั้นตอนด้านบนเพื่อเรียกรายการแทร็กคําบรรยายวิดีโอสําหรับวิดีโอ รายการนี้อาจใช้เพื่อแสดงรายการแทร็กคําบรรยายวิดีโอ โดยใช้รหัสของแทร็กแต่ละแทร็กเป็นคีย์
-
ขั้นตอนที่ 2: ลบแทร็ก
เรียกเมธอด
captions.delete
เพื่อลบวิดีโอที่เฉพาะเจาะจง ในคําขอ พารามิเตอร์id
จะระบุรหัสแทร็กแทร็กของแทร็กที่คุณกําลังลบ คําขอต้องได้รับอนุญาตโดยใช้ OAuth 2.0 หากคุณกําลังทดสอบคําค้นหานี้ใน API Explorer จะต้องแทนที่รหัสแทร็กคําบรรยายวิดีโอที่ถูกต้องสําหรับค่าพารามิเตอร์id
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.delete? id=CAPTION_TRACK_ID