Channels: update

ה-API תומך עכשיו באפשרות לסמן את הערוץ או את הסרטונים כתוכן שהוא 'במיוחד לילדים'. בנוסף, המשאבים channel ו-video מכילים עכשיו מאפיין שמזהה את הסטטוס "במיוחד לילדים" של הערוץ או הסרטון. ב-10 בינואר 2020 עדכנו גם את התנאים וההגבלות של שירותי ה-API של YouTube ואת כללי המדיניות למפתחים. מידע נוסף מופיע בהיסטוריית הגרסאות של YouTube Data API Service ושל תנאים והגבלות של שירותי ה-API של YouTube.

עדכון המטא-נתונים של ערוץ. חשוב לשים לב שהשיטה הזו תומכת רק בעדכונים לאובייקטים brandingSettings,‏ invideoPromotion ו-localizations של המשאב channel ולמאפייני הצאצא שלהם.

השפעה על המכסה: קריאה ל-method הזה מנצלת 50 יחידות מהמכסה.

תרחישים נפוצים לדוגמה

בקשה

בקשת HTTP

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

אישור

כדי לבצע את הבקשה הזו, נדרשת הרשאה עם לפחות אחד מההיקפים הבאים. למידע נוסף על אימות והרשאה, קראו את המאמר הטמעת הרשאת OAuth 2.0.

היקף
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

פרמטרים

בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים שמופיעים ברשימה הם פרמטרים של שאילתה.

פרמטרים
פרמטרים נדרשים
part string
הפרמטר part משמש לשתי מטרות בפעולה הזו. הוא מציין את המאפיינים שפעולת הכתיבה תגדיר, וגם את המאפיינים שייכללו בתגובה מה-API.

ה-API מאפשר להגדיר את ערך הפרמטר רק ל-brandingSettings, ל-invideoPromotion או ל-localizations. (אפשר לעדכן רק אחד מהחלקים האלה בבקשה אחת).

חשוב לשים לב שהשיטה הזו מבטלת את הערכים הקיימים של כל המאפיינים הניתנים לשינוי שכלולים בחלק שצוין בערך הפרמטר.
פרמטרים אופציונליים
onBehalfOfContentOwner string
אפשר להשתמש בפרמטר הזה רק בבקשה מורשית כראוי.

הפרמטר onBehalfOfContentOwner מציין שהמשתמש המאומת פועל בשם בעלי התוכן שצוינו בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן של YouTube שבבעלותם ובניהולם הרבה ערוצי YouTube שונים. הוא מאפשר לבעלי התוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוצים שלהם, בלי לספק פרטי כניסה לאימות לכל ערוץ בנפרד. חשבון מערכת ניהול התוכן (CMS) שהמשתמש מאמת צריך להיות מקושר לבעלי התוכן שצוינו ב-YouTube.

צריך לספק את הפרמטר הזה אם הבקשה מאומתת באמצעות פרטי כניסה של משתמש שהוא בעלי תוכן במערכת ניהול התוכן (CMS) שפועל בערוץ מנוהל. אם לא מציינים את הפרמטר הזה, הבקשה מופעלת בהקשר הישיר של המשתמש המאומת ומוחזרת שגיאת HTTP 403 Forbidden.

גוף הבקשה

מציינים משאב channel בגוף הבקשה. למשאב הזה:

  • צריך לציין ערך למאפיינים הבאים:

    • 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

    אם אתם שולחים בקשת עדכון ולא מציינים ערך למאפיין שכבר יש לו ערך, הערך הקיים של המאפיין יימחק.

תשובה

אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה משאב channel בגוף התגובה.

שגיאות

בטבלה הבאה מפורטות הודעות השגיאה שה-API יכול להחזיר בתגובה לקריאה ל-method הזה. פרטים נוספים זמינים במאמר YouTube Data API - Errors.

סוג השגיאה פרטי השגיאה תיאור
badRequest (400) brandingValidationError אחד מהערכים באובייקט brandingSettings נכשל באימות. משתמשים ב-method‏ channels.list כדי לאחזר את ההגדרות הקיימות של הערוץ, ומעדכנים את ערכי המאפיינים לפי ההנחיות במסמכי התיעוד של המשאב channels.
badRequest (400) channelTitleUpdateForbidden כשמעדכנים את brandingSettings part של ערוץ, צריך להגדיר את הערך של המאפיין brandingSettings.channel.title לשם הנוכחי של הערוץ או להשמיט את המאפיין. אם תשנו את ערך המאפיין, ה-API יחזיר שגיאה.
badRequest (400) defaultLanguageNotSetError צריך להגדיר את defaultLanguage לעדכון localizations.
badRequest (400) invalidBrandingOption אחת מהגדרות שקשורות למותגים שציינתם לא קיימת. צריך להשתמש ב-method‏ 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 אחד מהערכים באובייקט הלוקליזציה נכשל באימות. צריך להשתמש ב-method‏ channels.list כדי לאחזר ערכים תקינים, ולעדכן אותם לפי ההנחיות במסמכי התיעוד של משאב הערוצים.
badRequest (400) tooManyPromotedItems חרגת ממספר הפריטים המותרים לקידום בחלק invideoPromotion.
forbidden (403) channelForbidden הבקשה לא נתמכת בערוץ שצוין בפרמטר id או שההרשאה לבקשה לא תקינה.
forbidden (403) promotedVideoNotAllowed הערוץ שבקשת ה-API מנסה לעדכן לא נמצא. צריך לבדוק את הערך של הנכס id במשאב channel שאליו נשלחה הבקשה כדי לוודא שמזהה הערוץ נכון.
forbidden (403) websiteLinkNotAllowed אסור להשתמש בכתובת האתר שצוינה.
notFound (404) channelNotFound לא נמצא הערוץ שצוין בפרמטר id.
notFound (404) channelNotFound הערוץ שצוין בפרמטר id לא נמצא או שאין לו אפשרויות מיתוג.
notFound (404) unknownChannelId לא נמצא מזהה הערוץ שצוין.
notFound (404) unknownChannelId מזהה הערוץ שצוין ב-recentlyUploadedBy לא נמצא.
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 במטא-נתונים של הבקשה צריך לציין כתובת אתר בחלק invideoPromotion. מגדירים את הערך של המאפיין invideoPromotion.items[].id.websiteUrl במשאב שהבקשה שולחת.

רוצה לנסות?

משתמשים ב-APIs Explorer כדי לשלוח קריאה ל-API הזה ולראות את בקשת ה-API והתגובה.