หมายเหตุ: API สำหรับ Content ID ของ YouTube มีขึ้นเพื่อให้พาร์ทเนอร์เนื้อหาของ YouTube ใช้งาน และไม่สามารถเข้าถึงได้โดยนักพัฒนาแอปบางรายหรือผู้ใช้ YouTube บางราย หากคุณไม่เห็น API สำหรับ Content ID ของ YouTube เป็นหนึ่งในบริการที่แสดงอยู่ในคอนโซล Google API โปรดดูศูนย์ช่วยเหลือของ YouTube เพื่อดูข้อมูลเพิ่มเติมเกี่ยวกับโปรแกรมพาร์ทเนอร์ YouTube
ป้ายกำกับเนื้อหาช่วยให้คุณจัดระเบียบเนื้อหาให้เป็นหมวดหมู่ที่กำหนดเอง ซึ่งช่วยให้ง่ายต่อการจัดระเบียบไลบรารีเนื้อหาของคุณ คุณสามารถค้นหาเนื้อหาโดยอิงตามป้ายกำกับของเนื้อหาได้ ซึ่งยังช่วยลดความยุ่งยากของการใช้งานในกรณีที่คุณต้องการอัปเดตเนื้อหาบางกลุ่มโดยเฉพาะ
คู่มือนี้จะอธิบายถึงวิธีใช้ API สำหรับ Content ID ของ YouTube เพื่อทำงานทั่วไปหลายอย่างที่เกี่ยวข้องกับป้ายกำกับ หลายส่วนในคู่มือนี้มีตัวอย่างที่เชื่อมโยงและสร้าง Google API Explorer ซึ่งจะช่วยให้คุณทดสอบการค้นหาแต่ละครั้งได้
สร้างป้ายกำกับเนื้อหา
API รองรับวิธีสร้างป้ายกำกับเนื้อหา 2 วิธีดังนี้
-
เรียกเมธอด
assetLabels.insert
เนื้อหาของคำขอคือทรัพยากรassetLabel
ที่พร็อพเพอร์ตี้labelName
ระบุชื่อที่ไม่ซ้ำกันของป้ายกำกับใหม่ API จะแสดงโค้ดตอบกลับ HTTP409 (Conflict)
หากมีป้ายกำกับที่ใช้ชื่อเดียวกันอยู่แล้วการค้นหาด้านล่างเรียกใช้เมธอด
assetLabels.insert
เพื่อสร้างป้ายกำกับใหม่ชื่อExplorer Test
เนื้อหาของคำขอตัวอย่างคือ:{ "labelName": "Explorer Test" }
คำขอไม่ได้ตั้งค่าพารามิเตอร์การค้นหาใดๆ อย่างไรก็ตาม หากบัญชี Google ของคุณเชื่อมโยงกับบัญชีเจ้าของเนื้อหาหลายบัญชี คุณต้องตั้งค่าสำหรับพารามิเตอร์
onBehalfOfContentOwner
ด้วย[no parameters set]
-
เรียกใช้เมธอด
assets.update
เพื่ออัปเดตป้ายกำกับสำหรับเนื้อหา ในคำขอ ให้ตั้งค่าพร็อพเพอร์ตี้label[]
ของทรัพยากรasset
เป็นรายการป้ายกำกับที่เชื่อมโยงกับเนื้อหา API จะสร้างป้ายกำกับเนื้อหาใหม่โดยอัตโนมัติสำหรับป้ายกำกับใดก็ตามในรายการที่ก่อนหน้านี้ยังไม่ได้สร้างอย่างชัดแจ้งให้เป็นทรัพยากรassetLabel
แสดงรายการป้ายกำกับเนื้อหาของเจ้าของเนื้อหา
หากต้องการดึงรายการป้ายกำกับเนื้อหาของเจ้าของเนื้อหา ให้เรียกเมธอด assetLabels.list
- โดยค่าเริ่มต้น API จะแสดงป้ายกำกับเนื้อหาทั้งหมดสำหรับเจ้าของเนื้อหา
- หากคุณกำหนดค่าสำหรับพารามิเตอร์การค้นหา
labelPrefix
แล้ว API จะแสดงผลป้ายกำกับเนื้อหาของเจ้าของเนื้อหาที่ขึ้นต้นด้วยสตริงที่ระบุเท่านั้น
การค้นหาต่อไปนี้เรียกใช้เมธอด assetLabels.list
เพื่อเรียกป้ายกำกับทั้งหมดของเจ้าของเนื้อหา อย่างไรก็ตาม โปรดทราบว่าหากบัญชี Google ของคุณเชื่อมโยงกับบัญชีเจ้าของเนื้อหาหลายบัญชี คุณต้องตั้งค่าสำหรับพารามิเตอร์ onBehalfOfContentOwner
มิฉะนั้นคำขอจะแสดงผลข้อผิดพลาด 400 (Bad Request)
[no parameters set]
การค้นหาด้านล่างเรียกใช้วิธีการเดียวกัน แต่ตั้งค่าของพารามิเตอร์ labelPrefix
เป็น news
ดังนั้น ป้ายกำกับเดียวที่ API แสดงผลคือป้ายกำกับที่ขึ้นต้นด้วยสตริงนั้น
labelPrefix=news
อัปเดตป้ายกำกับของเนื้อหา
คุณอัปเดตป้ายกำกับเนื้อหาได้โดยการตั้งค่าของพร็อพเพอร์ตี้ label[]
เมื่อเรียกใช้เมธอด assets.update เมื่อคุณอัปเดตเนื้อหา ระบบจะนำรายการป้ายกำกับก่อนหน้าออก แล้วแทนที่ด้วยรายการที่ส่งในคำขอ API ดังนั้น หากต้องการเก็บรายการป้ายกำกับก่อนหน้าไว้ คุณควรใช้เมธอด assets.list
เพื่อเรียกข้อมูลรายการป้ายกำกับเดิม จากนั้นจึงแก้ไขค่าของคุณสมบัติ label[]
หากค่าพร็อพเพอร์ตี้ว่างเปล่า API จะนำป้ายกำกับที่เชื่อมโยงกับเนื้อหาก่อนหน้านี้ออก
คุณสามารถเชื่อมโยงป้ายกำกับเดียวกันกับเนื้อหาหลายรายการและยังกำหนดป้ายกำกับหลายรายการกับเนื้อหาเดียวกันได้ ป้ายกำกับสามารถมีช่องว่างได้ ซึ่งหมายความว่าป้ายกำกับแต่ละรายการสามารถมีความยาวเกิน 1 คำได้ อักขระที่ห้ามใช้ ได้แก่ วงเล็บมุม (< >) จุลภาค (,) โคลอน (:) และอักขระไปป์แนวตั้ง (|) แต่ละป้ายกำกับต้องมีความยาวอย่างน้อย 2 ไบต์และยาวไม่เกิน 30 ไบต์ เจ้าของเนื้อหาแต่ละรายสามารถเพิ่มป้ายกำกับได้สูงสุด 30 รายการในแต่ละเนื้อหา โดยความยาวรวมสูงสุดทั้งหมดสำหรับแต่ละเนื้อหาอยู่ที่ 500 ไบต์
ค้นหาเนื้อหาตามป้ายกำกับ
หากต้องการดึงรายการเนื้อหาที่เชื่อมโยงกับป้ายกำกับหรือกลุ่มป้ายกำกับ ให้เรียกเมธอด assetSearch.list
โดยใช้พารามิเตอร์การค้นหา labels
เพื่อระบุรายการป้ายกำกับเนื้อหาที่คั่นด้วยคอมมา
- โดยค่าเริ่มต้น API จะแสดงรายการเนื้อหาที่มีป้ายกำกับเนื้อหาที่ระบุทั้งหมด
- หากคำขอ API ของคุณตั้งค่าพารามิเตอร์
includeAnyProvidedLabel
เป็นtrue
แล้ว API จะแสดงชิ้นงานที่ตรงกับป้ายกำกับที่ระบุอย่างน้อย 1 ป้าย