Videos: update

ตอนนี้ API รองรับการตั้งสถานะช่องหรือวิดีโอเป็น "สร้างมาเพื่อเด็ก" แล้ว นอกจากนี้ ขณะนี้ทรัพยากร channel และ video ยังมีพร็อพเพอร์ตี้ที่ระบุสถานะ "สร้างมาเพื่อเด็ก" ของช่องหรือวิดีโอนั้นด้วย นอกจากนี้ เรายังได้ปรับปรุงนโยบายสำหรับนักพัฒนาซอฟต์แวร์และข้อกำหนดในการให้บริการของบริการ YouTube API ไปเมื่อวันที่ 10 มกราคม 2020 ด้วย ดูข้อมูลเพิ่มเติมได้ที่ประวัติการแก้ไขบริการ YouTube Data API และข้อกำหนดในการให้บริการของบริการ YouTube API

อัปเดตข้อมูลเมตาของวิดีโอ

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

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

ส่งคำขอ

คำขอ HTTP

PUT https://www.googleapis.com/youtube/v3/videos

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

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

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

พารามิเตอร์

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

พารามิเตอร์
พารามิเตอร์ที่จำเป็น
part string
พารามิเตอร์ part มีไว้เพื่อวัตถุประสงค์ 2 อย่างในการดำเนินการนี้ โดยจะระบุพร็อพเพอร์ตี้ที่การดำเนินการเขียนจะตั้งค่า รวมถึงพร็อพเพอร์ตี้ที่การตอบกลับจาก API จะรวมด้วย

โปรดทราบว่าเมธอดนี้จะลบล้างค่าที่มีอยู่ของพร็อพเพอร์ตี้ที่เปลี่ยนแปลงได้ทั้งหมดที่อยู่ในส่วนต่างๆ ที่ค่าพารามิเตอร์ระบุไว้ เช่น การตั้งค่าความเป็นส่วนตัวของวิดีโอจะอยู่ในส่วนที่ status ดังนั้น หากคำขอของคุณเป็นการอัปเดตวิดีโอส่วนตัว และค่าพารามิเตอร์ part ของคำขอมีส่วนที่ status อยู่ด้วย ระบบจะอัปเดตการตั้งค่าความเป็นส่วนตัวของวิดีโอเป็นค่าใดก็ได้ที่ระบุไว้ในเนื้อหาคำขอ หากเนื้อหาคำขอไม่ได้ระบุค่า ระบบจะนำการตั้งค่าความเป็นส่วนตัวที่มีอยู่ออกและวิดีโอจะเปลี่ยนกลับไปใช้การตั้งค่าความเป็นส่วนตัวเริ่มต้น

นอกจากนี้ ชิ้นส่วนบางรายการอาจมีพร็อพเพอร์ตี้ที่ไม่สามารถตั้งค่าได้เมื่อแทรกหรืออัปเดตวิดีโอ เช่น ออบเจ็กต์ statistics จะรวมสถิติที่ YouTube คํานวณสําหรับวิดีโอไว้ และไม่มีค่าที่คุณกําหนดหรือแก้ไขได้ หากค่าพารามิเตอร์ระบุ part ที่ไม่มีค่าที่เปลี่ยนแปลงได้ part ดังกล่าวจะยังคงรวมอยู่ในคำตอบของ API

รายการต่อไปนี้คือชื่อ part ที่คุณรวมไว้ในค่าพารามิเตอร์ได้
  • contentDetails
  • fileDetails
  • id
  • liveStreamingDetails
  • localizations
  • paidProductPlacementDetails
  • player
  • processingDetails
  • recordingDetails
  • snippet
  • statistics
  • status
  • suggestions
  • topicDetails
พารามิเตอร์ที่ไม่บังคับ
onBehalfOfContentOwner string
ใช้พารามิเตอร์นี้ได้ในคำขอที่ได้รับอนุญาตอย่างถูกต้องเท่านั้น หมายเหตุ: พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหา YouTube โดยเฉพาะ

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

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

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

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

    • id
    • snippet.title – จำเป็นต้องระบุพร็อพเพอร์ตี้นี้เมื่อคำขออัปเดต snippet ของทรัพยากร video เท่านั้น
    • snippet.categoryId – คุณต้องระบุพร็อพเพอร์ตี้นี้เฉพาะในกรณีที่คำขออัปเดต snippet ของทรัพยากร video

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

    • snippet.categoryId
    • snippet.defaultLanguage
    • snippet.description
    • snippet.tags[]
    • snippet.title
    • status.embeddable
    • status.license
    • status.privacyStatus
    • status.publicStatsViewable
    • status.publishAt – หากตั้งค่าพร็อพเพอร์ตี้นี้ คุณต้องตั้งค่าพร็อพเพอร์ตี้ status.privacyStatus เป็น private ด้วย
    • status.selfDeclaredMadeForKids
    • status.containsSyntheticMedia
    • recordingDetails.recordingDate
    • localizations.(key)
    • localizations.(key).title
    • localizations.(key).description

    หากคุณส่งคำขออัปเดต แต่ไม่ได้ระบุค่าสำหรับพร็อพเพอร์ตี้ที่มีค่าอยู่แล้ว ระบบจะลบค่าที่มีอยู่ของพร็อพเพอร์ตี้นั้น

คำตอบ

หากดำเนินการสำเร็จ วิธีการนี้จะแสดงผล Resource วิดีโอในเนื้อหาการตอบกลับ

ข้อผิดพลาด

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

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
badRequest (400) defaultLanguageNotSet คำขอ API พยายามเพิ่มรายละเอียดวิดีโอที่แปลเป็นภาษาท้องถิ่นโดยไม่ระบุภาษาเริ่มต้นของรายละเอียดวิดีโอ
badRequest (400) invalidCategoryId พร็อพเพอร์ตี้ snippet.categoryId ระบุรหัสหมวดหมู่ที่ไม่ถูกต้อง ใช้เมธอด videoCategories.list เพื่อเรียกข้อมูลหมวดหมู่ที่รองรับ
badRequest (400) invalidDefaultBroadcastPrivacySetting คำขอพยายามตั้งค่าความเป็นส่วนตัวที่ไม่ถูกต้องสำหรับการออกอากาศเริ่มต้น
badRequest (400) invalidDescription ข้อมูลเมตาคำขอระบุคำอธิบายวิดีโอที่ไม่ถูกต้อง
badRequest (400) invalidPublishAt ข้อมูลเมตาคำขอระบุเวลาเผยแพร่ตามกำหนดการที่ไม่ถูกต้อง
badRequest (400) invalidRecordingDetails ออบเจ็กต์ recordingDetails ในข้อมูลเมตาของคำขอระบุรายละเอียดการบันทึกที่ไม่ถูกต้อง
badRequest (400) invalidTags ข้อมูลเมตาของคำขอระบุคีย์เวิร์ดของวิดีโอที่ไม่ถูกต้อง
badRequest (400) invalidTitle ข้อมูลเมตาของคำขอระบุชื่อวิดีโอที่ไม่ถูกต้องหรือว่างเปล่า
badRequest (400) invalidVideoMetadata ข้อมูลเมตาของคำขอไม่ถูกต้อง
forbidden (403) forbidden
forbidden (403) forbiddenEmbedSetting คำขอพยายามตั้งค่าการฝังที่ไม่ถูกต้องสำหรับวิดีโอ โปรดทราบว่าบางช่องอาจไม่มีสิทธิ์เสนอเพลเยอร์แบบฝังสำหรับสตรีมแบบสด ดูข้อมูลเพิ่มเติมได้ที่ศูนย์ช่วยเหลือของ YouTube
forbidden (403) forbiddenLicenseSetting คำขอพยายามตั้งค่าใบอนุญาตที่ไม่ถูกต้องสำหรับวิดีโอ
forbidden (403) forbiddenPrivacySetting คำขอพยายามตั้งค่าความเป็นส่วนตัวที่ไม่ถูกต้องสำหรับวิดีโอ
notFound (404) videoNotFound ไม่พบวิดีโอที่คุณพยายามอัปเดต ตรวจสอบค่าของช่อง id ในเนื้อหาคำขอเพื่อให้แน่ใจว่าถูกต้อง

ลองใช้งาน

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