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

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

תשובה

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

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
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 משאב השידור החי הכיל ערך לא חוקי למאפיין contentDetails.enableAutoStart. לא ניתן לשנות את ההגדרה enableAutoStart לשידור קבוע.
invalidValue (400) invalidAutoStop משאב השידור החי הכיל ערך לא חוקי למאפיין contentDetails.enableAutoStop. אי אפשר לשנות את ההגדרה enableAutoStop בשידור קבוע.
invalidValue (400) invalidDescription המשאב Live Broadcast לא ציין ערך חוקי עבור הנכס snippet.description. השדה snippet.description יכול להכיל עד 5,000 תווים.
invalidValue (400) invalidEmbedSetting משאב השידור החי הכיל ערך לא חוקי למאפיין contentDetails.enable_embed. אי אפשר להטמיע את השידור הזה.
invalidValue (400) invalidEnableClosedCaptions במשאב Live Broadcast, הערך של המאפיין contentDetails.enableClosedCaptions לא תואם לערך של ההגדרה contentDetails.closedCaptionType. משנים את המשאב כך שיכלול רק אחד משני המאפיינים, ולאחר מכן שולחים מחדש את הבקשה.
invalidValue (400) invalidLatencyPreferenceOptions המשאב Live Broadcast הכיל ערך לא חוקי לנכס contentDetails.latencyPreference. לא כל ההגדרות נתמכות בהעדפה הזו של זמן האחזור.
invalidValue (400) invalidPauseAdsUntil משאב השידור החי מכיל ערך לא חוקי למאפיין 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 משאב השידור החי הכיל ערך לא חוקי למאפיין contentDetails.projection. אי אפשר להגדיר את התצוגה של שידור קבוע ל-360.
invalidValue (400) invalidScheduledEndTime המשאב Live Broadcast הכיל ערך לא חוקי לנכס snippet.scheduledEndTime. שעת הסיום המתוזמנת חייבת להיות אחרי שעת ההתחלה המתוזמנת.
invalidValue (400) invalidScheduledStartTime משאב השידור החי הכיל ערך לא חוקי למאפיין snippet.scheduledStartTime. שעת ההתחלה המתוזמנת חייבת להיות בעתיד.
invalidValue (400) invalidTitle במשאב ה-liveBroadcast לא צוין ערך חוקי למאפיין snippet.title. אורך השדה snippet.title חייב להיות בין 1 ל-100 תווים.
notFound (404) liveBroadcastNotFound המאפיין id שצוין במשאבlivebroadcast לא זיהה שידור.
required (400) broadcastStreamDelayMsRequired המשאבים של שידור חי לא ציינו את המאפיין contentDetails.monitorStream.broadcastStreamDelayMs.
required (400) enableMonitorStreamRequired המשאבים של שידור חי לא ציינו את המאפיין contentDetails.monitorStream.enableMonitorStream.
required (400) idRequired משאב השידור החי חייב לכלול ערך למאפיין id ולציין אותו.
required (400) scheduledEndTimeRequired המשאבים של שידור חי לא ציינו את המאפיין snippet.scheduledEndTime.
required (400) scheduledStartTimeRequired המשאבים של שידור חי לא ציינו את המאפיין snippet.scheduledStartTime.

נסה בעצמך!

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