מעדכן שידור. לדוגמה, אפשר לשנות את הגדרות השידור שמוגדרות באובייקט 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 , ואפשר להשתמש בו רק בשילוב עם הפרמטר הזה. בנוסף, יש לאשר את הבקשה באמצעות חשבון CMS שמקושר לבעלי התוכן בפרמטר 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 |
המשאב livecastcast לא ציין ערך חוקי עבור המאפיין 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 |
משאב השידור החי לא ציין סטטוס פרטיות חוקי. הצגת ערכי privacyStatus תקינים. |
invalidValue (400) |
invalidProjection |
משאב LiveBroadcast הכיל ערך לא חוקי עבור המאפיין contentDetails.projection . לא ניתן להגדיר שידור קבוע ל-360. |
invalidValue (400) |
invalidScheduledEndTime |
משאב LiveBroadcast הכיל ערך לא חוקי עבור המאפיין snippet.scheduledEndTime . שעת הסיום המתוזמנת חייבת להיות זהה לשעת ההתחלה שנקבעה. |
invalidValue (400) |
invalidScheduledStartTime |
משאב LiveBroadcast הכיל ערך לא חוקי עבור המאפיין snippet.scheduledStartTime . מועד ההתחלה שנקבע חייב להיות בעתיד. |
invalidValue (400) |
invalidTitle |
המשאב livecastcast לא ציין ערך חוקי עבור המאפיין 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.