Channels: update

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

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

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

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

בקשה

בקשת HTTP

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

אישור

בקשה זו מחייבת הרשאה עם לפחות אחד מההיקפים הבאים (מידע נוסף על אימות והרשאה).

היקף
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.

גוף הבקשה

צריך לספק משאב ערוץ בגוף הבקשה. במשאב הזה:

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

    • 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 כתובת האתר שצוינה אינה מותרת.
notFound (404) channelNotFound לא ניתן למצוא את הערוץ שצוין בפרמטר id.
notFound (404) channelNotFound הערוץ שצוין באמצעות הפרמטר id לא נמצא או שאין לו אפשרויות מיתוג.
notFound (404) unknownChannelId לא נמצא מזהה הערוץ שצוין.
notFound (404) unknownChannelId מזהה הערוץ שצוין לאחרונה UploadedBy לא נמצא.
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.