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