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.moderateComments
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 |
המטא-נתונים של הבקשה מציינים משך לא חוקי בחלק invideoקידום. |
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 |
חרגת מהמספר המותר של פריטים מקודמים בחלק invideoקידום. |
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 ואת התשובה.