LiveBroadcasts

ה-API תומך עכשיו באפשרות לסמן שידורים חיים כתוכן 'במיוחד לילדים', והמשאב liveBroadcast כולל עכשיו מאפיין שמציין את הסטטוס 'במיוחד לילדים' של השידור החי. ב-10 בינואר 2020 עודכנו גם התנאים וההגבלות של שירותי YouTube API וכללי המדיניות למפתחים. מידע נוסף מופיע בהיסטוריית הגרסאות של שירות YouTube Live Streaming API ושל התנאים וההגבלות של שירותי YouTube API.

משאב liveBroadcast מייצג אירוע שיועבר בסטרימינג ב-YouTube באמצעות וידאו בשידור חי.

Methods

ה-API תומך בשיטות הבאות למשאבי liveBroadcasts:

list
‫
מחזירה רשימה של שידורים ב-YouTube שתואמים לפרמטרים של בקשת ה-API. כדאי לנסות עכשיו.
הוספה
יצירת שידור. כדאי לנסות עכשיו.
עדכון
עדכון של שידור. לדוגמה, אפשר לשנות את הגדרות השידור שמוגדרות באובייקט contentDetails של משאב liveBroadcast. רוצים לנסות?
מחיקה
מחיקת שידור. כדאי לנסות עכשיו.
bind
קושרת שידור ב-YouTube לסטרימינג או מסירה קשר קיים בין שידור לסטרימינג. שידור יכול להיות מקושר רק לשידור וידאו אחד, אבל שידור וידאו יכול להיות מקושר לכמה שידורים. כדאי לנסות עכשיו.
transition
משנה את הסטטוס של שידור חי ב-YouTube ומתחיל תהליכים שקשורים לסטטוס החדש. לדוגמה, כשמשנים את הסטטוס של שידור ל-testing, מערכת YouTube מתחילה להעביר את הווידאו לשידור המעקב של השידור הזה. לפני שמפעילים את השיטה הזו, צריך לוודא שהערך של המאפיין status.streamStatus של הסטרים שמשויך לשידור הוא active. רוצים לנסות?
cuepoint
‫
הוספת נקודת רמז לשידור חי. יכול להיות שנקודת האות תפעיל הפסקה למודעה.

ייצוג משאבים

מבנה ה-JSON הבא מציג את הפורמט של משאב liveBroadcasts:

{
  "kind": "youtube#liveBroadcast",
  "etag": etag,
  "id": string,
  "snippet": {
    "publishedAt": datetime,
    "channelId": string,
    "title": string,
    "description": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    },
    "scheduledStartTime": datetime,
    "scheduledEndTime": datetime,
    "actualStartTime": datetime,
    "actualEndTime": datetime,
    "isDefaultBroadcast": boolean,
    "liveChatId": string
  },
  "status": {
    "lifeCycleStatus": string,
    "privacyStatus": string,
    "recordingStatus": string,
    "madeForKids": string,
    "selfDeclaredMadeForKids": string,
  },
  "contentDetails": {
    "boundStreamId": string,
    "boundStreamLastUpdateTimeMs": datetime,
    "monitorStream": {
      "enableMonitorStream": boolean,
      "broadcastStreamDelayMs": unsigned integer,
      "embedHtml": string
    },
    "enableEmbed": boolean,
    "enableDvr": boolean,
    "recordFromStart": boolean,
    "enableClosedCaptions": boolean,
    "closedCaptionsType": string,
    "projection": string,
    "enableLowLatency": boolean,
    "latencyPreference": boolean,
    "enableAutoStart": boolean,
    "enableAutoStop": boolean,
    "availabilityConfig": {
      "globalConfig": {
        "excludedRegionCodes": [
          string
        ],
        "interval": {
          "startTime": datetime,
          "endTime": datetime
        }
      },
      "regionsConfig": {
        "regionIntervals": [
          {
            "regionCode": string,
            "interval": {
              "startTime": datetime,
              "endTime": datetime
            }
          }
        ]
      }
    }
  },
  "statistics": {
    "totalChatCount": unsigned long
  },
  "monetizationDetails": {
    "adsMonetizationStatus": string,
    "eligibleForAdsMonetization": boolean,
    "cuepointSchedule": {
      "enabled": boolean,
      "pauseAdsUntil": datetime,
      "ytOptimizedCuepointConfig": string,
      "creatorCuepointConfig": {
        "scheduleStrategy": string,
        "repeatIntervalSecs": unsigned integer
      }
    }
  }
}

מאפיינים

בטבלה הבאה מוגדרים המאפיינים שמופיעים במשאב הזה:

מאפיינים
kind ‫string
מזהה את סוג משאב ה-API. הערך יהיה youtube#liveBroadcast.
etag etag
ה-Etag של מקור המידע הזה.
id string
המזהה ש-YouTube מקצה כדי לזהות את השידור באופן ייחודי.
snippet object
אובייקט snippet מכיל פרטים בסיסיים על האירוע, כולל הכותרת, התיאור, שעת ההתחלה ושעת הסיום.
snippet.publishedAt datetime
התאריך והשעה שבהם השידור נוסף ללוח הזמנים של שידורים חיים ב-YouTube. הערך מצוין בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.channelId string
המזהה שמשמש את YouTube לזיהוי ייחודי של הערוץ שמפרסם את השידור.
snippet.title string
השם של השידור. חשוב לזכור שהשידור מייצג בדיוק סרטון אחד ב-YouTube. אפשר להגדיר את השדה הזה על ידי שינוי של משאב השידור או על ידי הגדרת השדה title של משאב הסרטון המתאים.
snippet.description string
תיאור השידור. בדומה לtitle, אפשר להגדיר את השדה הזה על ידי שינוי של משאב השידור או על ידי הגדרת השדה description של משאב הווידאו המתאים.
snippet.thumbnails object
מפה של תמונות ממוזערות שמשויכות לשידור. לכל אובייקט מוטמע באובייקט הזה, המפתח הוא השם של התמונה הממוזערת והערך הוא אובייקט שמכיל מידע נוסף על התמונה הממוזערת.
snippet.thumbnails.(key) object
הערכים התקינים של המפתח הם:
  • ‫default – תמונת ברירת המחדל. התמונה הממוזערת שמוגדרת כברירת מחדל לסרטון – או למשאב שמפנה לסרטון, כמו פריט בפלייליסט או תוצאת חיפוש – היא ברוחב של 120 פיקסלים ובגובה של 90 פיקסלים. תמונת ברירת המחדל של הערוץ היא ברוחב 88 פיקסלים ובגובה 88 פיקסלים.
  • ‫medium – גרסה ברזולוציה גבוהה יותר של התמונה הממוזערת. במקרה של סרטון (או משאב שמפנה לסרטון), התמונה הזו היא ברוחב 320 פיקסלים ובגובה 180 פיקסלים. התמונה של הערוץ היא ברוחב 240 פיקסלים ובגובה 240 פיקסלים.
  • ‫high – גרסה ברזולוציה גבוהה של התמונה הממוזערת. במקרה של סרטון (או משאב שמפנה לסרטון), התמונה הזו היא ברוחב 480 פיקסלים ובגובה 360 פיקסלים. התמונה של הערוץ היא ברוחב 800 פיקסלים ובגובה 800 פיקסלים.
snippet.thumbnails.(key).url string
כתובת ה-URL של התמונה.
snippet.thumbnails.(key).width unsigned integer
רוחב התמונה.
snippet.thumbnails.(key).height unsigned integer
גובה התמונה.
snippet.scheduledStartTime datetime
התאריך והשעה שבהם השידור מתוזמן להתחיל. הערך מצוין בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ). ב-Creator Studio אפשר ליצור שידור בלי לתזמן שעת התחלה. במקרה כזה, השידור מתחיל בכל פעם שבעל הערוץ מתחיל לשדר. בשידורים האלה, הערך של datetime תואם לאפס בזמן האפוקה של Unix, ואי אפשר לשנות את הערך הזה באמצעות ה-API או ב-Creator Studio.
snippet.scheduledEndTime ‫datetime
התאריך והשעה שבהם השידור אמור להסתיים. הערך מצוין בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ). אם לא מציינים ערך למאפיין הזה במשאב liveBroadcast, השידור מתוזמן להמשיך ללא הגבלת זמן. באופן דומה, אם לא תציינו ערך למאפיין הזה, מערכת YouTube תתייחס לשידור כאילו הוא יימשך ללא הגבלת זמן.
snippet.actualStartTime ‫datetime
התאריך והשעה שבהם השידור התחיל בפועל. המידע הזה זמין רק כשהסטטוס של השידור הוא live. הערך מצוין בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.actualEndTime datetime
התאריך והשעה שבהם השידור הסתיים בפועל. המידע הזה זמין רק כשהסטטוס של השידור הוא complete. הערך מצוין בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
snippet.isDefaultBroadcast boolean
המאפיין הזה ייצא משימוש ב-1 בספטמבר 2020 או אחרי התאריך הזה. באותו זמן, מערכת YouTube תפסיק ליצור שידור סטרימינג ושידור רגיל כברירת מחדל כשבערוץ מופעלת האפשרות לשידור חי בסטרימינג. פרטים נוספים מופיעים בהודעה על הוצאה משימוש.
המאפיין הזה מציין אם השידור הזה הוא שידור ברירת המחדל.

איך שידורים שמוגדרים כברירת מחדל פועלים

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

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

אחרי שההמרה מסתיימת, הסרטון נכלל ברשימת הסרטונים שהועלו לערוץ. הסרטון לא זמין מיד אחרי שהשידור מסתיים, ואורך העיכוב קשור לאורך השידור בפועל.
snippet.liveChatId string
המזהה של הצ'אט בשידור חי ב-YouTube של השידור. בעזרת המזהה הזה, אפשר להשתמש בשיטות של משאב liveChatMessage כדי לאחזר, להוסיף או למחוק הודעות בצ'אט. אפשר גם להוסיף או להסיר מנהלי תגובות בצ'אט, לחסום משתמשים מהשתתפות בצ'אטים בשידור חי או להסיר חסימות קיימות.
status object
האובייקט status מכיל מידע על סטטוס האירוע.
status.lifeCycleStatus string
הסטטוס של השידור. אפשר לעדכן את הסטטוס באמצעות השיטה liveBroadcasts.transition של ה-API.

הערכים התקינים של המאפיין הזה הם:
  • ‫complete – השידור הסתיים.
  • ‫created – השידור כולל הגדרות לא מלאות, ולכן הוא לא מוכן למעבר לסטטוס live או testing, אבל הוא נוצר והוא תקין בכל שאר המובנים.
  • ‫live – השידור פעיל.
  • ‫liveStarting – השידור נמצא בתהליך של מעבר לסטטוס live.
  • ‫ready – הגדרות השידור הושלמו והשידור יכול לעבור לסטטוס live או testing.
  • ‫revoked – השידור הזה הוסר על ידי האדמין.
  • ‫testStarting – השידור נמצא בתהליך של מעבר לסטטוס testing.
  • ‫testing – השידור גלוי רק לשותף.
status.privacyStatus string
סטטוס הפרטיות של השידור. חשוב לזכור שהשידור מייצג בדיוק סרטון אחד ב-YouTube, ולכן הגדרות הפרטיות זהות לאלה שנתמכות בסרטונים. בנוסף, אפשר להגדיר את השדה הזה על ידי שינוי של משאב השידור או על ידי הגדרת השדה privacyStatus של משאב הסרטון המתאים.

הערכים התקינים של המאפיין הזה הם:
  • private
  • public
  • unlisted
status.recordingStatus ‫string
סטטוס התיעוד של השידור.

הערכים התקפים של המאפיין הזה הם:
  • notRecording
  • recorded
  • recording
status.madeForKids ‫boolean
הערך הזה מציין אם השידור מסווג כתוכן לילדים. ערך המאפיין הזה הוא לקריאה בלבד.
status.selfDeclaredMadeForKids boolean
בבקשה liveBroadcasts.insert המאפיין הזה מאפשר לבעלי הערוץ לציין שהשידור הוא תוכן לילדים. בבקשה liveBroadcasts.list, ערך המאפיין מוחזר רק אם בעלי הערוץ אישרו את בקשת ה-API.
contentDetails ‫object
האובייקט contentDetails מכיל מידע על תוכן הווידאו של האירוע, כמו האם אפשר להציג את התוכן בנגן וידאו מוטמע או שהוא יועבר לארכיון ולכן יהיה זמין לצפייה אחרי שהאירוע יסתיים.
contentDetails.boundStreamId ‫string
הערך הזה מזהה באופן ייחודי את live stream שמשויך לשידור.
contentDetails.boundStreamLastUpdateTimeMs datetime
התאריך והשעה שבהם השידור החי שאליו מתייחס הערך boundStreamId עודכן לאחרונה.
contentDetails.monitorStream object
האובייקט monitorStream מכיל מידע על זרם הצפייה, שמשמש את המשדר לבדיקת תוכן האירוע לפני שזרם השידור מוצג לציבור.
contentDetails.monitorStream.enableMonitorStream boolean
הערך הזה קובע אם שידור המעקב מופעל לשידור. אם הפעלתם את שידור הבקרה, YouTube ישדר את תוכן האירוע בשידור מיוחד שמיועד לצפייה של המשדר בלבד. השדרן יכול להשתמש בסטרימינג כדי לבדוק את תוכן האירוע וגם כדי לזהות את הזמנים האופטימליים להוספת נקודות רמז.

אם רוצים להגדיר שידור עם testing שלב או אם רוצים להגדיר עיכוב שידור לאירוע, צריך להגדיר את הערך הזה ל-true. בנוסף, אם הערך של המאפיין הזה הוא true, צריך להעביר את השידור למצב testing לפני שאפשר להעביר אותו למצב live. (אם הערך של המאפיין הוא false, לשידור לא יכול להיות שלב testing, ולכן אפשר להעביר את השידור ישירות למצב live).‫

כשupdate a broadcast, צריך להגדיר את המאפיין הזה אם בקשת ה-API כוללת את החלק contentDetails בערך הפרמטר part. עם זאת, כשinsert a broadcast, המאפיין הוא אופציונלי וערך ברירת המחדל שלו הוא true.

חשוב: אי אפשר לעדכן את המאפיין הזה אחרי שהשידור עובר למצב testing או live.
contentDetails.monitorStream.broadcastStreamDelayMs unsigned integer
אם הגדרתם את המאפיין enableMonitorStream לערך true, המאפיין הזה קובע את משך עיכוב השידור החי.‫

כשupdate a broadcast, צריך להגדיר את המאפיין הזה אם בקשת ה-API כוללת את החלק contentDetails בערך הפרמטר part. עם זאת, כשinsert a broadcast, המאפיין הוא אופציונלי וערך ברירת המחדל שלו הוא 0. הערך הזה מציין שאין עיכוב בשידור. הערה: אי אפשר לעדכן את המאפיין הזה אחרי שהשידור עובר למצב testing או live.
contentDetails.monitorStream.embedHtml string
קוד HTML שמטמיע נגן שמפעיל את שידור המסך.
contentDetails.enableEmbed boolean
ההגדרה הזו מציינת אם אפשר להפעיל את שידור הווידאו בנגן מוטמע. אם תבחרו להעביר את הסרטון לארכיון (באמצעות המאפיין enableArchive), ההגדרה הזו תחול גם על הסרטון בארכיון.‫

כשupdate a broadcast, צריך להגדיר את המאפיין הזה אם בקשת ה-API כוללת את החלק contentDetails בערך הפרמטר part. עם זאת, כשinsert a broadcast, המאפיין הוא אופציונלי וערך ברירת המחדל שלו הוא true.

הערה: אי אפשר לעדכן את המאפיין הזה אחרי שהשידור עובר למצב testing או live.
contentDetails.enableDvr boolean
ההגדרה הזו קובעת אם הצופים יכולים לגשת לפקדי DVR בזמן הצפייה בסרטון. לחצני השליטה של ה-DVR מאפשרים לצופים לשלוט בחוויית הפעלת הסרטון על ידי השהיה, הרצה אחורה או הרצה קדימה של התוכן. ערך ברירת המחדל של המאפיין הזה הוא true. ‫

כשupdate a broadcast, צריך להגדיר את המאפיין הזה אם בקשת ה-API כוללת את החלק contentDetails בערך הפרמטר part. עם זאת, כשinsert a broadcast, המאפיין הוא אופציונלי וערך ברירת המחדל שלו הוא true.

חשוב: אם רוצים שההפעלה תהיה זמינה מיד אחרי סיום השידור, צריך להגדיר את הערך של true וגם את הערך של המאפיין enableArchive כ-true. בנוסף, אי אפשר לעדכן את המאפיין הזה אחרי שהשידור עובר למצב testing או live.
contentDetails.recordFromStart boolean
ההגדרה הזו מציינת אם YouTube יתחיל אוטומטית להקליט את השידור אחרי שהסטטוס של האירוע ישתנה לשידור חי.

ערך ברירת המחדל של המאפיין הזה הוא true, ואפשר להגדיר אותו רק ל-false אם לערוץ השידור מותר להשבית את ההקלטות של שידורים חיים.

אם לערוץ שלכם אין הרשאה להשבית הקלטות, ותנסו להוסיף שידור עם המאפיין recordFromStart שמוגדר לערך false, ה-API יחזיר שגיאה Forbidden. בנוסף, אם לערוץ שלכם אין את ההרשאה הזו ותנסו לעדכן שידור כדי להגדיר את המאפיין recordFromStart לערך false, ה-API יחזיר שגיאה modificationNotAllowed.‫

כשupdate a broadcast, צריך להגדיר את המאפיין הזה אם בקשת ה-API כוללת את החלק contentDetails בערך הפרמטר part. עם זאת, כשinsert a broadcast, המאפיין הוא אופציונלי וערך ברירת המחדל שלו הוא true.

חשוב: אם רוצים שההפעלה תהיה זמינה מיד אחרי סיום השידור, צריך להגדיר את הערך של המאפיין enableDvr ל-true. אם מגדירים את ערך המאפיין הזה כ-true אבל לא מגדירים את ערך המאפיין enableDvr כ-true, יכול להיות שיהיה עיכוב של יום בערך עד שהסרטון שנשמר בארכיון יהיה זמין להפעלה.

הערה: אי אפשר לעדכן את המאפיין הזה אחרי שהשידור עובר למצב testing או live.
contentDetails.enableClosedCaptions boolean
המאפיין הזה יצא משימוש ב-17 בדצמבר 2015. במקומו צריך להשתמש במאפיין contentDetails.closedCaptionsType.

ההגדרה הזו מציינת אם כתוביות בשיטת HTTP POST מופעלות לשידור הזה. ללקוחות API שכבר משתמשים בנכס הזה:
  • הגדרת ערך המאפיין ל-true שווה להגדרת המאפיין contentDetails.closedCaptionsType ל-closedCaptionsHttpPost.
  • הגדרת ערך המאפיין ל-false שווה להגדרת המאפיין contentDetails.closedCaptionsType ל-closedCaptionsDisabled.
contentDetails.closedCaptionsType string
הערה: הנכס הזה מחליף את הנכס contentDetails.enableClosedCaptions.

הנכס הזה מציין אם הכתוביות מופעלות בשידור, ואם כן, איזה סוג של כתוביות אתם מספקים:
  • ‫closedCaptionsDisabled: הכתוביות מושבתות בשידור החי.
  • ‫closedCaptionsHttpPost: אתם שולחים כתוביות באמצעות HTTP POST לכתובת URL להעלאה שמשויכת לשידור החי.
  • ‫closedCaptionsEmbedded: הכתוביות יקודדו בזרם הווידאו בפורמטים EIA-608 ו/או CEA-708.
contentDetails.projection string
פורמט ההקרנה של השידור הזה. ערך ברירת המחדל של המאפיין הוא rectangular.

הערכים התקינים של המאפיין הם:
  • 360
  • rectangular
contentDetails.enableLowLatency boolean
מציין אם השידור הזה צריך להיות מקודד לסטרימינג עם השהיה נמוכה. שידור עם השהיה נמוכה יכול לקצר את הזמן שנדרש כדי שהסרטון יוצג למשתמשים שצופים בשידור, אבל הוא גם יכול להשפיע על הרזולוציה של הצופים בשידור.
contentDetails.latencyPreference ‫string
מציין באיזו הגדרת זמן אחזור להשתמש לשידור הזה. אפשר להשתמש במאפיין הזה במקום במאפיין enableLowLatency, שלא תומך ב-ultraLow.

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

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

הערכים התקפים של המאפיין הזה הם:
  • normal
  • low
  • ultraLow
contentDetails.enableAutoStart boolean
מציין אם השידור הזה צריך להתחיל אוטומטית כשמתחילים לשדר וידאו ב-live stream המקושר.
contentDetails.enableAutoStop boolean
ההגדרה מציינת אם השידור הזה צריך להסתיים אוטומטית כדקה אחרי שבעלי הערוץ מפסיקים את שידור הווידאו בשידור הווידאו המקושר.
contentDetails.availabilityConfig object
הגדרת הזמינות של השידור. המאפיין הזה משמש להגדרת זמינות באזור ספציפי או לחסימה של אזורים ספציפיים. ההגדרה הזו אופציונלית – אם היא לא מוגדרת, היא לא נאכפת.
contentDetails.availabilityConfig.globalConfig object
הגדרת הזמינות הגלובלית של השידור. הסרטון זמין בכל האזורים, חוץ מאלה שצוינו ברשימה excludedRegionCodes.
contentDetails.availabilityConfig.globalConfig.excludedRegionCodes list (string)
רשימה של האזורים שבהם הסרטון חסום.
contentDetails.availabilityConfig.globalConfig.interval object
חלון הזמן שמוגדר כברירת מחדל שבו הסרטון זמין בכל האזורים שלא נחסמו. הערה: אי אפשר להשתמש במאפיין הזה בשידורים חיים פעילים או בשידורים חיים שצפויים להתחיל.
contentDetails.availabilityConfig.globalConfig.interval.startTime datetime
התאריך והשעה שבהם הסרטון יהיה זמין. אם לא צוין, הסרטון כבר זמין. הערך מצוין בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
contentDetails.availabilityConfig.globalConfig.interval.endTime datetime
התאריך והשעה שבהם הסרטון מפסיק להיות זמין. אם לא מציינים תאריך, הסרטון זמין לנצח. אי אפשר להגדיר שעת התחלה ושעת סיום שמוגדרות ליותר מחמש שנים מהיום. הערך מצוין בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
contentDetails.availabilityConfig.regionsConfig object
הגדרת הזמינות האזורית של השידור. הסרטון זמין רק באזורים שצוינו.
contentDetails.availabilityConfig.regionsConfig.regionIntervals list (object)
רשימה של אזורים וחלונות זמן שבהם הסרטון זמין. אם מציינים אזור כמה פעמים, המערכת משתמשת באיחוד של כל המרווחים.
contentDetails.availabilityConfig.regionsConfig.regionIntervals.regionCode ‫string
האזור שבו הסרטון זמין.
contentDetails.availabilityConfig.regionsConfig.regionIntervals.interval object
חלון הזמן שבו הסרטון זמין באזור שצוין. הערה: אי אפשר להשתמש במאפיין הזה בשידורים חיים פעילים או בשידורים חיים שצפויים להתחיל.
contentDetails.availabilityConfig.regionsConfig.regionIntervals.interval.startTime datetime
התאריך והשעה שבהם הסרטון יהיה זמין באזור שצוין. אם לא צוין, הסרטון כבר זמין. הערך מצוין בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
contentDetails.availabilityConfig.regionsConfig.regionIntervals.interval.endTime datetime
התאריך והשעה שבהם הסרטון מפסיק להיות זמין באזור שצוין. אם לא מציינים תאריך, הסרטון זמין לנצח. אי אפשר להגדיר שעת התחלה ושעת סיום שמוגדרות ליותר מחמש שנים מהיום. הערך מצוין בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ).
statistics ‫object
אובייקט statistics מכיל נתונים סטטיסטיים שקשורים לשידור חי. הערכים של הנתונים הסטטיסטיים האלה יכולים להשתנות במהלך השידור, ואפשר לאחזר אותם רק בזמן שהשידור מתקיים.
statistics.totalChatCount unsigned long
המספר הכולל של הודעות הצ'אט בשידור חי שמשויכות לשידור. המאפיין והערך שלו מוצגים אם השידור גלוי למשתמש, אם התכונה 'צ'אט בשידור חי' מופעלת בו ויש בו לפחות הודעה אחת. שימו לב: לא יצוין ערך לנכס הזה אחרי שהשידור יסתיים. לכן, המאפיין הזה לא יציין את מספר ההודעות בצ'אט בסרטון בארכיון של שידור חי שהסתיים.
monetizationDetails object
האובייקט monetizationDetails מכיל מידע על פרטי המונטיזציה של הסטרימינג, למשל אם הכלי האוטומטי להוספת מודעות מופעל או אם ההוספה של מודעות באמצע הסרטון מתעכבת.
monetizationDetails.adsMonetizationStatus string
המאפיין הזה מציין אם מודעות באמצע הסרטון מופעלות בשידור וידאו. הערכים התקינים הם on ו-off.
monetizationDetails.eligibleForAdsMonetization string
המאפיין הזה מציין אם שידור וידאו עומד בדרישות להצגת מודעות באמצע הסרטון. יכולות להיות מגוון סיבות לכך ששידור לא יעמוד בדרישות, למשל אם יש תלונה קיימת או שהערוץ לא מוגדר להפעלת מונטיזציה.
monetizationDetails.cuepointSchedule object
אובייקט cuepointSchedule מציין את הגדרות האוטומציה של המודעות לשידור.
monetizationDetails.cuepointSchedule.enabled boolean
הערך הזה קובע אם המודעות מוכנסות לשידור באופן אוטומטי. אם הערך הוא true, מערכת YouTube תוסיף באופן אוטומטי מודעות באמצע הסרטון לשידור. הערך של השדות האחרים באובייקט monetizationDetails.cuepointSchedule יקבע את לוח הזמנים להצגת המודעות.
monetizationDetails.cuepointSchedule.pauseAdsUntil ‫datetime
הערך הזה מציין שמערכת YouTube לא צריכה להוסיף מודעות באמצע הסרטון לשידור עד לתאריך ולשעה שצוינו. הערך מצוין בפורמט ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ). כדי להשהות מודעות, צריך להגדיר בשדה הזה ערך של תאריך ושעה עתידיים. כדי לבטל את ההשהיה של המודעות, אפשר להגדיר בשדה הזה ערך של תאריך ושעה בעבר או ערך ריק.
monetizationDetails.cuepointSchedule.ytOptimizedCuepointConfig string
בשדה הזה מצוינת האפשרות שנבחרה לנקודות ציון להצגת מודעות שמוכנסות באופן אוטומטי. בשדה אפשר לציין אחד משלושה מצבים:
  • ‫LOW: פוטנציאל נמוך יותר לרווחים, חוויית צפייה עם פחות הפסקות
  • MEDIUM: פוטנציאל בינוני להכנסות, חוויית צפייה מאוזנת
  • ‫HIGH: פוטנציאל רווחים גבוה יותר, חוויית צופה עם יותר הפסקות
monetizationDetails.cuepointSchedule.creatorCuepointConfig object
האובייקט creatorCuepointConfig מציין את האפשרות להוספת מודעות אוטומטית, שמאפשרת ליוצרים לבחור איך מודעות באמצע הסרטון יוצגו.
monetizationDetails.cuepointSchedule.creatorCuepointConfig.scheduleStrategy string
הערך הזה מציין את האסטרטגיה שבה מערכת YouTube צריכה להשתמש לתזמון של נקודות לסימון. הערכים התקינים הם:
  • ‫CONCURRENT: נקודות האיתות מתוזמנות לאותו זמן לכל הצופים
  • ‫NON_CONCURRENT: נקודות ה-Cue מתוזמנות בזמנים שונים לצופים שונים. הגישה הזו מאפשרת להציג מודעות בתדירות גבוהה יותר, כך שהצופים יוכלו לקבל נקודות ציון כשהם עומדים בדרישות.
monetizationDetails.cuepointSchedule.creatorCuepointConfig.repeatIntervalSecs unsigned integer
הערך הזה מציין את פרק הזמן, בשניות, בין הצגת מודעות אוטומטית במהלך שידור. לדוגמה, אם הערך הוא 360, מערכת YouTube יכולה להוסיף נקודות ציון להצגת מודעות באמצע הסרטון במרווחים של שש דקות.

הערה:
  • הערך מציין את הזמן בין תחילת נקודות רצופות לציון מיקום. כלומר, המרווח לא נמדד מסוף נקודת ציון אחת לתחילת נקודת הציון הבאה.
  • כדי לשמור על עקביות עם ההגדרות ב-YouTube Studio, הערך הזה צריך להיות כפולה של 6 דקות, בין 6 דקות ל-30 דקות. כל מספר שלם בבקשת העדכון בטווח הזה, גם אם הוא תקין, יעוגל כלפי מטה לכפולה הקרובה ביותר של 6 דקות.