channel
ו-video
מכילים עכשיו גם מאפיין שמזהה את הסטטוס 'במיוחד לילדים' של הערוץ או הסרטון. ב-10 בינואר 2020 עודכנו גם התנאים וההגבלות של שירותי YouTube API וכללי המדיניות למפתחים. למידע נוסף, אפשר לעיין בהיסטוריות הגרסאות של שירות YouTube Data API ושל התנאים וההגבלות של שירותי YouTube API.
עדכון המטא-נתונים של הערוץ. חשוב לזכור שהשיטה הזו תומכת רק בעדכונים של האובייקטים brandingSettings
, invideoPromotion
ו-localizations
של המשאב channel
, ושל נכסי הצאצאים שלהם.
השפעה על המכסה: קריאה לשיטה הזו מחייבת עלות מכסה של 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. |
גוף הבקשה
מספקים משאב 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
אם שולחים בקשת עדכון ולא מציינים בה ערך למאפיין שכבר מוגדר לו ערך, הערך הקיים של המאפיין יימחק.
תשובה
אם הפעולה בוצעה ללא שגיאות, ה-method מחזיר משאב channel
בגוף התגובה.
שגיאות
בטבלה הבאה מפורטות הודעות השגיאה שיכולות להופיע בתגובה לקריאה לשיטה הזו. מידע נוסף זמין במאמר YouTube Data API – שגיאות.
סוג השגיאה | פרטי השגיאה | תיאור |
---|---|---|
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 |
אחת מהגדרות המיתוג שציינתם לא קיימת. משתמשים בשיטה 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 |
אחד מהערכים באובייקט localizations נכשל באימות. משתמשים בשיטה 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 |
לא נמצא מזהה הערוץ שצוין ב-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 |
המטא-נתונים של הבקשה חייבים לציין כתובת URL של אתר בקטע invideoPromotion. מגדירים את הערך של המאפיין invideoPromotion.items[].id.websiteUrl במשאב שהבקשה שולחת. |
נסה בעצמך!
משתמשים ב-APIs Explorer כדי לקרוא ל-API הזה ולראות את הבקשה ואת התשובה של ה-API.