Channels: update

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

อัปเดตข้อมูลเมตาของช่อง โปรดทราบว่าปัจจุบันวิธีนี้รองรับเฉพาะการอัปเดตออบเจ็กต์ brandingSettings, invideoPromotion และ localizations ของทรัพยากร channel รวมถึงพร็อพเพอร์ตี้ย่อย

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

Use Case ทั่วไป

ส่งคำขอ

คำขอ HTTP

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

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

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

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

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

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

  • id

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

  • brandingSettings.channel.country
  • brandingSettings.channel.description
  • brandingSettings.channel.defaultLanguage
  • brandingSettings.channel.keywords
  • brandingSettings.channel.trackingAnalyticsAccountId
  • brandingSettings.channel.unsubscribedTrailer
  • localizations.(key)
  • localizations.(key).title
  • localizations.(key).description
  • status.selfDeclaredMadeForKids

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

คำตอบ

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

ข้อผิดพลาด

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

ประเภทข้อผิดพลาด	รายละเอียดข้อผิดพลาด	คำอธิบาย
badRequest (400)	brandingValidationError	ค่าใดค่าหนึ่งในออบเจ็กต์ brandingSettings ไม่ผ่านการตรวจสอบ ใช้เมธอด channels.list เพื่อดึงการตั้งค่าที่มีอยู่สำหรับช่องนั้นๆ และอัปเดตค่าพร็อพเพอร์ตี้ตามหลักเกณฑ์ในเอกสารประกอบเกี่ยวกับแหล่งข้อมูลของ channels
badRequest (400)	channelTitleUpdateForbidden	เมื่ออัปเดต brandingSettings part ของแชแนล คุณต้องตั้งค่าพร็อพเพอร์ตี้ brandingSettings.channel.title เป็นชื่อปัจจุบันของช่อง หรือไม่ต้องระบุพร็อพเพอร์ตี้นี้ API จะแสดงผลข้อผิดพลาดหากคุณเปลี่ยนค่าของพร็อพเพอร์ตี้
badRequest (400)	defaultLanguageNotSetError	ต้องตั้งค่า defaultLanguage เพื่ออัปเดต localizations
badRequest (400)	invalidBrandingOption	หนึ่งในการตั้งค่าการแสดงแบรนด์ที่คุณระบุไม่มีอยู่ ใช้เมธอด channels.list เพื่อเรียกข้อมูลค่าที่ถูกต้องและตรวจสอบว่าได้อัปเดตค่าดังกล่าวตามหลักเกณฑ์ในเอกสารประกอบเกี่ยวกับแหล่งข้อมูลของ channels
badRequest (400)	invalidCustomMessage	ข้อมูลเมตาของคำขอระบุข้อความที่กำหนดเองที่ไม่ถูกต้อง ตรวจสอบค่าของพร็อพเพอร์ตี้ invideoPromotion.items[].customMessage ในทรัพยากรที่คำขอส่งมา
badRequest (400)	invalidDuration	ข้อมูลเมตาของคำขอระบุระยะเวลาที่ไม่ถูกต้องในส่วน invideoPromotion
badRequest (400)	invalidDuration	ข้อมูลเมตาของคำขอระบุประเภทตำแหน่งที่ไม่ถูกต้องสำหรับการกำหนดตำแหน่งรายการที่โปรโมตในโปรแกรมเล่นวิดีโอ ตรวจสอบค่าของพร็อพเพอร์ตี้ invideoPromotion.position.type ในทรัพยากรที่คำขอส่งมา
badRequest (400)	invalidRecentlyUploadedBy	ข้อมูลเมตาของคำขอระบุรหัสช่องที่ไม่ถูกต้อง ตรวจสอบค่าของพร็อพเพอร์ตี้ invideoPromotion.items[].id.recentlyUploadedBy ในทรัพยากรที่คำขอส่งมา
badRequest (400)	invalidTimingOffset	ข้อมูลเมตาของคำขอระบุการชดเชยเวลาที่ไม่ถูกต้องในส่วน invideoPromotion
badRequest (400)	invalidTimingOffset	ข้อมูลเมตาของคำขอระบุการชดเชยเวลาที่ไม่ถูกต้องเพื่อระบุว่าควรแสดงรายการที่โปรโมตในวิดีโอเพลเยอร์เมื่อใด ตรวจสอบค่าของพร็อพเพอร์ตี้ invideoPromotion.timing.offsetMs ในทรัพยากรที่คำขอส่งมา
badRequest (400)	invalidTimingType	ข้อมูลเมตาของคำขอระบุวิธีการกำหนดเวลาที่ไม่ถูกต้องเพื่อกำหนดว่าควรแสดงรายการที่โปรโมตในโปรแกรมเล่นวิดีโอเมื่อใด ตรวจสอบค่าของพร็อพเพอร์ตี้ invideoPromotion.timing.type ในทรัพยากรที่คำขอส่งมา
badRequest (400)	localizationValidationError	ค่าใดค่าหนึ่งในออบเจ็กต์การแปลไม่ผ่านการตรวจสอบ ใช้เมธอด channels.list เพื่อดึงข้อมูลค่าที่ถูกต้องและตรวจสอบว่าได้อัปเดตค่าดังกล่าวตามหลักเกณฑ์ในเอกสารประกอบเกี่ยวกับช่องทางต่างๆ
badRequest (400)	tooManyPromotedItems	จำนวนรายการที่โปรโมตที่อนุญาตเกินจำนวนที่อนุญาตในส่วน invideoPromotion
forbidden (403)	channelForbidden	แชแนลที่ระบุในพารามิเตอร์ id ไม่สนับสนุนคำขอ หรือคำขอไม่ได้รับอนุญาตอย่างถูกต้อง
forbidden (403)	promotedVideoNotAllowed	ไม่พบแชแนลที่คำขอ API กำลังพยายามอัปเดต ตรวจสอบค่าของพร็อพเพอร์ตี้ id ในทรัพยากร channel ที่คำขอส่งมาเพื่อให้แน่ใจว่ารหัสช่องถูกต้อง
forbidden (403)	websiteLinkNotAllowed	ไม่อนุญาตให้ใช้ URL ของเว็บไซต์ที่ระบุ
notFound (404)	channelNotFound	ไม่พบแชแนลที่ระบุในพารามิเตอร์ id
notFound (404)	channelNotFound	ไม่พบแชแนลที่ระบุโดยพารามิเตอร์ id หรือไม่มีตัวเลือกการสร้างแบรนด์
notFound (404)	unknownChannelId	ไม่พบรหัสแชแนลที่ระบุ
notFound (404)	unknownChannelId	ไม่พบรหัสช่องอัปเดตล่าสุดที่ระบุ
notFound (404)	unknownVideoId	ไม่พบรหัสวิดีโอที่ระบุเป็นรายการที่โปรโมต
required (400)	requiredItemIdType	ข้อมูลเมตาของคำขอต้องระบุประเภทรายการในส่วน invideoPromotion
required (400)	requiredItemId	ข้อมูลเมตาของคำขอต้องระบุรหัสรายการในส่วน invideoPromotion
required (400)	requiredTimingOffset	ข้อมูลเมตาคำขอต้องระบุการชดเชยเวลาเริ่มต้นเพื่อให้ YouTube ระบุได้ว่าจะแสดงรายการที่โปรโมตเมื่อใด ตั้งค่าพร็อพเพอร์ตี้ invideoPromotion.defaultTiming.offsetMs ในทรัพยากรที่คำขอส่ง
required (400)	requiredTimingOffset	ข้อมูลเมตาของคำขอต้องระบุการชดเชยเวลาเพื่อให้ YouTube ระบุได้ว่าจะแสดงรายการที่โปรโมตเมื่อใด ตั้งค่าพร็อพเพอร์ตี้ invideoPromotion.timing.offsetMs ในทรัพยากรที่คำขอส่ง
required (400)	requiredTimingType	ข้อมูลเมตาของคำขอต้องระบุวิธีการกำหนดเวลาเพื่อให้ YouTube ระบุได้ว่าจะแสดงรายการที่โปรโมตเมื่อใด ตั้งค่าพร็อพเพอร์ตี้ invideoPromotion.defaultTiming.type ในทรัพยากรที่คำขอส่ง
required (400)	requiredTimingType	ข้อมูลเมตาของคำขอต้องระบุวิธีการกำหนดเวลาเพื่อให้ YouTube ระบุได้ว่าจะแสดงรายการที่โปรโมตเมื่อใด ตั้งค่าพร็อพเพอร์ตี้ invideoPromotion.timing.type ในทรัพยากรที่คำขอส่ง
required (400)	requiredTiming	ข้อมูลเมตาของคำขอต้องระบุเวลาสำหรับแต่ละรายการในส่วน invideoPromotion
required (400)	requiredVideoId	ข้อมูลเมตาของคำขอต้องระบุรหัสวิดีโอเพื่อระบุรายการที่โปรโมต
required (400)	requiredWebsiteUrl	ข้อมูลเมตาของคำขอต้องระบุ URL ของเว็บไซต์ในส่วน invideoPromotion ตั้งค่าพร็อพเพอร์ตี้ invideoPromotion.items[].id.websiteUrl ในทรัพยากรที่คำขอส่ง

ลองใช้เลย

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