מעדכן שידור. לדוגמה, אפשר לשנות את הגדרות השידור שהוגדרו באובייקט contentDetails
של המשאב liveBroadcast
.
תרחישים נפוצים
בקשה
בקשת HTTP
PUT https://www.googleapis.com/youtube/v3/liveBroadcasts
הרשאה
הבקשה הזו מחייבת הרשאה עם לפחות אחד מההיקפים הבאים (מידע נוסף על אימות והרשאה).
ההיקף |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
פרמטרים
בטבלה הבאה מפורטים הפרמטרים הנתמכים בשאילתה הזו. כל הפרמטרים הרשומים הם פרמטרים של שאילתות.
פרמטרים | ||
---|---|---|
פרמטרים נדרשים | ||
part |
string הפרמטר part משרת שתי מטרות בפעולה זו. היא מזהה את המאפיינים שפעולת הכתיבה תגדיר ואת המאפיינים שייכללו בתגובת ה-API.מאפייני ה- part שאפשר לכלול בערך הפרמטר הם id , snippet , contentDetails , monetizationDetails ו-status .לתשומת ליבך: השיטה הזו תבטל את הערכים הקיימים לכל המאפיינים שניתנים לשינוי ושנמצאים בחלקים שערך הפרמטר מציין. לדוגמה, סטטוס הפרטיות של שידור מוגדר בחלק status . לכן, אם הבקשה שלך היא לעדכן שידור פרטי או לא רשום, וערך הפרמטר part של הבקשה כולל את החלק status , הגדרת הפרטיות של השידור תתעדכן לערך שצוין בגוף הבקשה. אם גוף הבקשה לא מציין ערך, הגדרת הפרטיות הקיימת תוסר והשידור יחזור להגדרת הפרטיות המוגדרת כברירת מחדל. |
|
פרמטרים אופציונליים | ||
onBehalfOfContentOwner |
string ניתן להשתמש בפרמטר הזה רק בבקשה מורשית כהלכה. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube. הפרמטר onBehalfOfContentOwner מציין שפרטי הכניסה של הרשאת הבקשה מזהים משתמש YouTube CMS שפועל מטעם בעלי התוכן שצוינו בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן של YouTube שבבעלותם ומנהלים ערוצי YouTube רבים ושונים. היא מאפשרת לבעלי תוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוץ, בלי שיצטרכו לספק פרטי כניסה לאימות עבור כל ערוץ בנפרד. חשבון ה-CMS שאיתו המשתמש מבצע אימות חייב להיות מקושר לבעלי התוכן שצוינו ב-YouTube. |
|
onBehalfOfContentOwnerChannel |
string ניתן להשתמש בפרמטר הזה רק בבקשה מורשית כהלכה. ניתן להשתמש בפרמטר הזה רק בבקשה מורשית כראוי. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube. הפרמטר onBehalfOfContentOwnerChannel מציין את מזהה ערוץ YouTube של הערוץ שאליו מתווסף סרטון. הפרמטר הזה נדרש כאשר בקשה מציינת ערך לפרמטר onBehalfOfContentOwner , וניתן להשתמש בו רק בשילוב עם הפרמטר הזה. בנוסף, יש לאשר את הבקשה באמצעות חשבון מערכת ניהול תוכן המקושר לבעלי התוכן שצוין בפרמטר onBehalfOfContentOwner . לבסוף, הערוץ שצוין בערך הפרמטר onBehalfOfContentOwnerChannel חייב להיות מקושר לבעלי התוכן שצוין בפרמטר onBehalfOfContentOwner .הפרמטר הזה מיועד לשותפי תוכן של YouTube, שבבעלותם ובהם מנהלים ערוצי YouTube רבים ושונים. הוא מאפשר לבעלי תוכן לבצע אימות פעם אחת ולבצע פעולות בשם הערוץ שצוין בערך הפרמטר, ללא צורך לספק פרטי כניסה לאימות עבור כל ערוץ נפרד. |
תוכן הבקשה
צריך לספק משאב שידור חי בגוף הבקשה. באותו משאב:
-
צריך לציין ערך למאפיינים הבאים:
id
snippet.scheduledStartTime
contentDetails.monitorStream.enableMonitorStream
contentDetails.monitorStream.broadcastStreamDelayMs
-
אפשר להגדיר ערכים לנכסים הבאים:
snippet.title
snippet.description
snippet.scheduledStartTime
snippet.scheduledEndTime
status.privacyStatus
contentDetails.monitorStream.enableMonitorStream
contentDetails.monitorStream.broadcastStreamDelayMs
contentDetails.enableAutoStart
contentDetails.enableAutoStop
contentDetails.enableClosedCaptions
contentDetails.enableDvr
contentDetails.enableEmbed
contentDetails.recordFromStart
monetizationDetails.cuepointSchedule.pauseAdsUntil
אם שולחים בקשה לעדכון, ובבקשה לא מצוין ערך לנכס שכבר יש לו ערך, הערך הקיים של הנכס יימחק.
תשובה
אם הפעולה מצליחה, השיטה הזו מחזירה משאב של שידור חי בגוף התגובה.
שגיאות
בטבלה הבאה מפורטות הודעות השגיאה שה-API עשוי להחזיר בתגובה לקריאה לשיטה הזו. כדי לקבל פרטים נוספים, אפשר לעיין במסמכי התיעוד בנושא הודעת שגיאה.
סוג השגיאה | פרטי השגיאה | תיאור |
---|---|---|
forbidden (403) |
closedCaptionsTypeModificationNotAllowed |
ניתן לשנות את הערך contentDetails.closedCaptionsType רק כאשר השידור נמצא בסטטוס created או ready . |
forbidden (403) |
enabledModificationNotAllowed |
השדה enabled הוא לקריאה בלבד. |
forbidden (403) |
scheduleStrategyModificationNotAllowed |
השדה scheduleStrategy הוא לקריאה בלבד. |
forbidden (403) |
repeatIntervalSecsModificationNotAllowed |
השדה repeatIntervalSecs הוא לקריאה בלבד. |
forbidden (403) |
pauseAdsUntilModificationNotAllowed |
לא ניתן לשנות את השדה pauseAdsUntil .
השגיאה הזו יכולה להתרחש מהסיבות הבאות:
|
forbidden (403) |
enableAutoStartModificationNotAllowed |
ניתן לשנות את הערך contentDetails.enableAutoStart רק כאשר הסטרימינג לא פעיל והשידור נמצא בסטטוס created או ready . |
forbidden (403) |
enableClosedCaptionsModificationNotAllowed |
ניתן לשנות את הערך contentDetails.enableClosedCaptions רק כאשר סטטוס השידור הוא created או ready . |
forbidden (403) |
enableDvrModificationNotAllowed |
ניתן לשנות את הערך contentDetails. רק כאשר סטטוס השידור הוא created או ready . |
forbidden (403) |
enableMonitorStreamModificationNotAllowed |
ניתן לשנות את הערך contentDetails. רק כאשר סטטוס השידור הוא created או ready . |
forbidden (403) |
recordFromStartModificationNotAllowed |
ניתן לשנות את הערך contentDetails. רק כאשר סטטוס השידור הוא created או ready . |
insufficientPermissions |
insufficientLivePermissions |
הבקשה לא מורשית לעדכן את השידור החי שצוין. מידע נוסף זמין במאמר הטמעה של אימות OAuth2. |
insufficientPermissions |
liveStreamingNotEnabled |
המשתמש שאישר את הבקשה לא יכול להפעיל סטרימינג של וידאו בשידור חי ב-YouTube. מידע נוסף זמין למשתמשים בכתובת https://www.youtube.com/features. |
invalidValue (400) |
invalidAutoStart |
משאב LiveBroadcast
הכיל ערך לא חוקי עבור המאפיין contentDetails.enableAutoStart .
לא ניתן לשנות את ההגדרה של enableAutoStart לשידור קבוע. |
invalidValue (400) |
invalidAutoStop |
משאב LiveBroadcast
הכיל ערך לא חוקי עבור המאפיין contentDetails.enableAutoStop . לא ניתן
לשנות את ההגדרה של enableAutoStop לשידור קבוע. |
invalidValue (400) |
invalidDescription |
במשאב LiveBroadcast לא צוין ערך חוקי עבור המאפיין snippet.description . snippet.description יכול להכיל עד 5,000 תווים. |
invalidValue (400) |
invalidEmbedSetting |
משאב LiveBroadcast הכיל ערך לא חוקי עבור המאפיין contentDetails.enable_embed . לא ניתן להטמיע את השידור הזה. |
invalidValue (400) |
invalidEnableClosedCaptions |
במשאב LiveBroadcast, הערך של המאפיין contentDetails.enableClosedCaptions לא תואם לערך של ההגדרה contentDetails.closedCaptionType . יש לשנות את המשאב כך שיכלול רק אחד משני המאפיינים, ולאחר מכן לשלוח את הבקשה מחדש. |
invalidValue (400) |
invalidLatencyPreferenceOptions |
משאב LiveBroadcast
הכיל ערך לא חוקי עבור המאפיין contentDetails.latencyPreference .
העדפה זו של זמן אחזור לא תומכת בכל ההגדרות.
|
invalidValue (400) |
invalidPauseAdsUntil |
משאב LiveBroadcast
מכיל ערך לא חוקי עבור המאפיין monetizationDetails.cuepointSchedule.pauseAdsUntil .
השגיאה הזו יכולה להתרחש מהסיבות הבאות:
|
invalidValue (400) |
invalidPrivacyStatus |
במשאב LiveBroadcast לא צוין סטטוס פרטיות חוקי. הצגת ערכי privacyStatus תקינים. |
invalidValue (400) |
invalidProjection |
משאב LiveBroadcast הכיל ערך לא חוקי עבור המאפיין contentDetails.projection . לא ניתן להגדיר היטל של שידור קבוע ל-360. |
invalidValue (400) |
invalidScheduledEndTime |
משאב LiveBroadcast הכיל ערך לא חוקי עבור המאפיין snippet.scheduledEndTime . שעת הסיום שתוזמנה חייבת להתאים לשעת ההתחלה שנקבעה. |
invalidValue (400) |
invalidScheduledStartTime |
משאב LiveBroadcast הכיל ערך לא חוקי עבור המאפיין snippet.scheduledStartTime . תאריך ההתחלה שנקבע חייב להיות בעתיד. |
invalidValue (400) |
invalidTitle |
במשאב LiveBroadcast לא צוין ערך חוקי עבור המאפיין snippet.title . האורך של snippet.title חייב להיות בין 1 ל-100 תווים. |
notFound (404) |
liveBroadcastNotFound |
המאפיין id שצוין במשאב LiveBroadcast לא זיהה שידור. |
required (400) |
broadcastStreamDelayMsRequired |
במשאב LiveBroadcast לא צוין המאפיין contentDetails. . |
required (400) |
enableMonitorStreamRequired |
במשאב LiveBroadcast לא צוין המאפיין contentDetails. . |
required (400) |
idRequired |
משאב LiveBroadcast חייב לכלול ולציין ערך עבור המאפיין id . |
required (400) |
scheduledEndTimeRequired |
במשאב LiveBroadcast לא צוין המאפיין snippet.scheduledEndTime . |
required (400) |
scheduledStartTimeRequired |
במשאב LiveBroadcast לא צוין המאפיין snippet.scheduledStartTime . |
רוצה לנסות?
צריך להשתמש בערך APIs Explorer כדי לקרוא ל-API הזה ולראות את הבקשה והתגובה של ה-API.