LiveBroadcasts: update

מעדכן שידור. לדוגמה, אפשר לשנות את הגדרות השידור שנקבעו באובייקט contentDetails של המשאב liveBroadcast.

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

בקשה

בקשת HTTP

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

אישור

הבקשה הזו מחייבת הרשאה עם לפחות אחד מההיקפים הבאים. למידע נוסף על אימות והרשאה, ראו הטמעה של הרשאת OAuth 2.0.

היקף
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 מציין שפרטי הכניסה להרשאה של הבקשה מזהים משתמש במערכת ניהול התוכן (CMS) של YouTube שפועל בשם בעלי התוכן שצוין בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן של YouTube, שבבעלותם ובניהולם של ערוצי YouTube רבים ושונים. היא מאפשרת לבעלי תוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוץ שלהם, בלי שיצטרכו לספק פרטי כניסה לאימות לכל ערוץ בנפרד. חשבון מערכת ניהול התוכן שאיתו המשתמש מבצע אימות חייב להיות מקושר לבעלי התוכן שצוינו ב-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

    אם שולחים בקשת עדכון, ובבקשה לא צוין ערך לנכס שכבר יש לו ערך, הערך הקיים של הנכס יימחק.

תשובה

אם הפעולה בוצעה ללא שגיאות, השיטה הזו תחזיר משאבlive Broadcast בגוף התגובה.

שגיאות

הטבלה הבאה מזהה את הודעות השגיאה שה-API יכול להחזיר בתגובה לקריאה ל-method הזה. פרטים נוספים זמינים במאמר הודעת שגיאה.

סוג השגיאה פרטי השגיאה תיאור
forbidden (403) closedCaptionsTypeModificationNotAllowed אפשר לשנות את הערך של contentDetails.closedCaptionsType רק כשהשידור נמצא בסטטוס created או ready.
forbidden (403) enabledModificationNotAllowed השדה enabled הוא לקריאה בלבד.
forbidden (403) scheduleStrategyModificationNotAllowed השדה scheduleStrategy הוא לקריאה בלבד.
forbidden (403) repeatIntervalSecsModificationNotAllowed השדה repeatIntervalSecs הוא לקריאה בלבד.
forbidden (403) pauseAdsUntilModificationNotAllowed אי אפשר לשנות את השדה pauseAdsUntil. השגיאה הזו יכולה לקרות מהסיבות הבאות:
  • השדה monetizationDetails.cuepointSchedule.enabled לא מוגדר ל-true. אפשר להגדיר את השדה הזה רק ב-YouTube Studio.
  • השידור לא משודר.
forbidden (403) enableAutoStartModificationNotAllowed אפשר לשנות את הערך של contentDetails.enableAutoStart רק כשהשידור לא פעיל והשידור נמצא בסטטוס created או ready.
forbidden (403) enableClosedCaptionsModificationNotAllowed אפשר לשנות את הערך contentDetails.enableClosedCaptions רק כשסטטוס השידור הוא created או ready.
forbidden (403) enableDvrModificationNotAllowed אפשר לשנות את הערך contentDetails.enableDvr רק כשסטטוס השידור הוא created או ready.
forbidden (403) enableMonitorStreamModificationNotAllowed אפשר לשנות את הערך contentDetails.monitorStream.enableMonitorStream רק כשסטטוס השידור הוא created או ready.
forbidden (403) recordFromStartModificationNotAllowed אפשר לשנות את הערך contentDetails.recordFromStart רק כשסטטוס השידור הוא created או ready.
insufficientPermissions insufficientLivePermissions לבקשה אין הרשאה לעדכן את השידור החי שצוין. מידע נוסף זמין במאמר הטמעת אימות OAuth2.
insufficientPermissions liveStreamingNotEnabled המשתמש שאישר את הבקשה לא רשאי לצפות בווידאו בשידור חי ב-YouTube. המשתמש יכול למצוא מידע נוסף בכתובת https://www.youtube.com/features.
invalidValue (400) invalidAutoStart מקור המידע: Live Broadcast הכיל ערך לא חוקי עבור המאפיין contentDetails.enableAutoStart. לא ניתן לשנות את ההגדרה enableAutoStart לשידור קבוע.
invalidValue (400) invalidAutoStop מקור המידע: Live Broadcast הכיל ערך לא חוקי עבור המאפיין contentDetails.enableAutoStop. שלך לא יכול לשנות את ההגדרה enableAutoStop עבור שידור קבוע.
invalidValue (400) invalidDescription המשאב Live Broadcast לא ציין ערך חוקי עבור הנכס snippet.description. השדה snippet.description יכול להכיל עד 5,000 תווים.
invalidValue (400) invalidEmbedSetting המשאב Live Broadcast הכיל ערך לא חוקי לנכס contentDetails.enable_embed. לא ניתן להטמיע את השידור הזה.
invalidValue (400) invalidEnableClosedCaptions במשאב Live Broadcast, הערך של המאפיין contentDetails.enableClosedCaptions לא תואם לערך של ההגדרה contentDetails.closedCaptionType. משנים את המשאב כך שיכלול רק אחד משני המאפיינים, ואז שולחים את הבקשה מחדש.
invalidValue (400) invalidLatencyPreferenceOptions מקור המידע: Live Broadcast הכיל ערך לא חוקי עבור המאפיין contentDetails.latencyPreference. העדפה זו של זמן האחזור לא תומכת בכל ההגדרות.
invalidValue (400) invalidPauseAdsUntil מקור המידע: Live Broadcast מכיל ערך לא חוקי עבור נכס monetizationDetails.cuepointSchedule.pauseAdsUntil. השגיאה הזו יכולה לקרות מהסיבות הבאות:
  • הערך monetizationDetails.cuepointSchedule.pauseAdsUntil לא מצוין בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
  • הערך של monetizationDetails.cuepointSchedule.pauseAdsUntil לא עתידי.
  • הערך של monetizationDetails.cuepointSchedule.pauseAdsUntil רחוק מ-10 דקות מהשעה הנוכחית.
invalidValue (400) invalidPrivacyStatus המשאב Livebroadcast לא ציין סטטוס פרטיות חוקי. לעיון בערכים תקינים של privacyStatus.
invalidValue (400) invalidProjection המשאב Live Broadcast הכיל ערך לא חוקי לנכס contentDetails.projection. לא ניתן להגדיר הקרנת שידור קבוע ל-360.
invalidValue (400) invalidScheduledEndTime המשאב Live Broadcast הכיל ערך לא חוקי לנכס snippet.scheduledEndTime. שעת הסיום שנקבעה חייבת להיות זהה לשעת ההתחלה שנקבעה.
invalidValue (400) invalidScheduledStartTime המשאב Live Broadcast הכיל ערך לא חוקי לנכס snippet.scheduledStartTime. שעת ההתחלה שנקבעה חייבת להיות בעתיד.
invalidValue (400) invalidTitle המשאב Livebroadcast לא ציין ערך חוקי עבור הנכס snippet.title. האורך המקסימלי של snippet.title הוא 1 עד 100 תווים.
notFound (404) liveBroadcastNotFound המאפיין id שצוין במשאבlive Broadcast לא זיהה שידור.
required (400) broadcastStreamDelayMsRequired המשאב Live Broadcast לא ציין את המאפיין contentDetails.monitorStream.broadcastStreamDelayMs.
required (400) enableMonitorStreamRequired המשאב Live Broadcast לא ציין את המאפיין contentDetails.monitorStream.enableMonitorStream.
required (400) idRequired המשאב Live Broadcast חייב לכלול ולציין ערך עבור הנכס id.
required (400) scheduledEndTimeRequired המשאב Live Broadcast לא ציין את המאפיין snippet.scheduledEndTime.
required (400) scheduledStartTimeRequired המשאב Live Broadcast לא ציין את המאפיין snippet.scheduledStartTime.

נסה בעצמך!

אפשר להשתמש ב-APIs Explorer כדי לשלוח קריאה ל-API הזה ולראות את בקשת ה-API והתגובה.