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

הפרמטר הזה מיועד לשותפי תוכן ב-YouTube שהם הבעלים של ערוצי YouTube רבים ומנהלים אותם. הוא מאפשר לבעלי התוכן לבצע אימות פעם אחת ולבצע פעולות בשם הערוץ שצוין בערך הפרמטר, בלי לספק פרטי כניסה לאימות לכל ערוץ בנפרד.

גוף הבקשה

מציינים משאב liveBroadcast בגוף הבקשה. למשאב הזה:

  • חובה לציין ערך למאפיינים האלה:

    • id
    • snippet.scheduledStartTime
    • contentDetails.monitorStream.enableMonitorStream
    • contentDetails.monitorStream.broadcastStreamDelayMs

  • אפשר להגדיר ערכים למאפיינים הבאים:

    • snippet.title
    • snippet.description
    • snippet.categoryId
    • snippet.scheduledStartTime
    • snippet.scheduledEndTime
    • status.privacyStatus
    • contentDetails.monitorStream.enableMonitorStream
    • contentDetails.monitorStream.broadcastStreamDelayMs
    • contentDetails.enableAutoStart
    • contentDetails.enableAutoStop
    • contentDetails.enableClosedCaptions
    • contentDetails.enableDvr
    • contentDetails.enableEmbed
    • contentDetails.recordFromStart
    • contentDetails.availabilityConfig
    • monetizationDetails.adsMonetizationStatus
    • monetizationDetails.cuepointSchedule.enabled
    • monetizationDetails.cuepointSchedule.pauseAdsUntil
    • monetizationDetails.cuepointSchedule.ytOptimizedCuepointConfig
    • monetizationDetails.cuepointSchedule.creatorCuepointConfig.scheduleStrategy
    • monetizationDetails.cuepointSchedule.creatorCuepointConfig.repeatIntervalSecs

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

תשובה

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

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
backendError (503) backendError עדיין אי אפשר להחיל חלק מההגדרות. הסיבה לכך היא כנראה שהשידור נוצר רק עכשיו. כדאי לנסות שוב בעוד כמה שניות.
forbidden (403) closedCaptionsTypeModificationNotAllowed אפשר לשנות את הערך של contentDetails.closedCaptionsType רק כשהשידור נמצא בסטטוס created או ready.
forbidden (403) monetizationDetailsModificationNotAllowed בעלי ערוצים שלא משתתפים בתוכנית השותפים של YouTube‏ (YPP) לא יכולים לשנות את monetizationDetails של סרטון.
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.
invalidArgument missingAdsMonetizationStatus הערך של ads_monetization_status צריך להיות ON או OFF.
invalidValue (400) invalidAutoStart המשאב liveBroadcast הכיל ערך לא חוקי במאפיין contentDetails.enableAutoStart. אי אפשר לשנות את ההגדרה enableAutoStart לשידור קבוע.
invalidValue (400) invalidAutoStop המשאב liveBroadcast הכיל ערך לא חוקי במאפיין contentDetails.enableAutoStop. אי אפשר לשנות את ההגדרה enableAutoStop של שידור קבוע.
invalidValue (400) invalidDescription במשאב של שידור חי לא צוין ערך תקין במאפיין 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) invalidEligibleForAdsMonetization השדה eligible_for_ads_monetization הוא לקריאה בלבד ואי אפשר לציין אותו בשדה monetization_details.
invalidValue (400) invalidCuepointSchedule במשאב liveBroadcast יש ערך לא תקין במאפיין monetizationDetails.cuepointSchedule. השגיאה הזו יכולה להופיע מהסיבות הבאות:
  • אי אפשר לציין את cuepoint_schedule אם ads_monetization_status הוא OFF.
  • צריך לציין את cuepoint_schedule אם הערך של ads_monetization_status הוא ON.
 אי אפשר לציין את cuepoint_schedule אם ads_monetization_status מושבת.
invalidValue (400) invalidEnabled המשאב liveBroadcast מכיל ערך לא חוקי או ערך שמתנגש עם המאפיין monetizationDetails.cuepointSchedule.enabled. השגיאה הזו יכולה להופיע מהסיבות הבאות:
  • צריך לציין את enabled בשדה cuepoint_schedule.
  • אי אפשר לציין את pause_ads_until, yt_optimized_cuepoint_config או creator_cuepoint_config אם הערך של enabled הוא false.
  • אם הערך של enabled הוא True, אפשר לציין רק אחד מהשדות yt_optimized_cuepoint_config ו-creator_cuepoint_config.
invalidValue (400) invalidCreatorCuepointConfig חובה לציין גם את schedule_strategy וגם את repeat_interval_secs.
invalidValue (400) invalidRepeatIntervalSecs הערך של המאפיין repeat_interval_secs צריך להיות בטווח [360, 3600].
invalidValue (400) invalidPauseAdsUntil במשאב liveBroadcast יש ערך לא תקין במאפיין 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 המשאב liveBroadcast הכיל ערך לא חוקי במאפיין contentDetails.projection. אי אפשר להגדיר הקרנה של שידור מתמשך ל-360.
invalidValue (400) invalidScheduledEndTime המשאב liveBroadcast הכיל ערך לא חוקי במאפיין snippet.scheduledEndTime. שעת הסיום המתוזמנת חייבת להיות אחרי שעת ההתחלה המתוזמנת.
invalidValue (400) invalidScheduledStartTime במשאב liveBroadcast היה ערך לא תקין במאפיין snippet.scheduledStartTime. שעת ההתחלה שקובעים צריכה להיות בעתיד.
invalidValue (400) invalidTitle במשאב liveBroadcast לא צוין ערך חוקי למאפיין snippet.title. האורך של snippet.title צריך להיות בין תו אחד ל-100 תווים.
notFound (404) liveBroadcastNotFound המאפיין id שצוין במשאב liveBroadcast לא זיהה שידור.
preconditionFailed (412) videoNotEligibleForAdsMonetization הסרטון לא כשיר למונטיזציה באמצעות מודעות. זה יכול לקרות אם הערוץ לא כשיר למונטיזציה.
required (400) broadcastStreamDelayMsRequired המאפיין contentDetails.monitorStream.broadcastStreamDelayMs לא צוין במשאב liveBroadcast.
required (400) enableMonitorStreamRequired המאפיין contentDetails.monitorStream.enableMonitorStream לא צוין במשאב liveBroadcast.
required (400) idRequired במשאב liveBroadcast צריך לכלול את המאפיין id ולציין לו ערך.
required (400) scheduledEndTimeRequired המאפיין snippet.scheduledEndTime לא צוין במשאב liveBroadcast.
required (400) scheduledStartTimeRequired המאפיין snippet.scheduledStartTime לא צוין במשאב liveBroadcast.

רוצה לנסות?

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