הפניית API

חומר העזר בנושא API מסביר איך לתזמן שידורים חיים וזרמי וידאו ב-YouTube באמצעות ה-YouTube Live Streaming API.

סוגי המשאבים

LiveBroadcasts

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

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

שיטה בקשת HTTP תיאור
מזהי URI ביחס ל-https://www.googleapis.com/youtube/v3
bind POST /liveBroadcasts/bind מקשרים שידור ב-YouTube לשידור או מסירים קישור קיים בין השידור לבין השידור. ניתן לקשר שידור רק לזרם וידאו אחד, אך ייתכן ששידור וידאו יהיה מקושר ליותר משידור אחד.
delete DELETE /liveBroadcasts מחיקת שידור.
insert POST /liveBroadcasts יצירת שידור.
list GET /liveBroadcasts מחזירה רשימה של שידורי YouTube שתואמים לפרמטרים של בקשת ה-API.
transition POST /liveBroadcasts/transition משנה את הסטטוס של שידור חי ב-YouTube ומתחיל תהליכים המשויכים לסטטוס החדש. לדוגמה, כשמעבירים את הסטטוס של שידור מסוים ל-testing, המערכת של YouTube מתחילה לשדר וידאו לשידור המוניטור של אותו שידור. לפני שמפעילים את השיטה הזו, צריך לוודא שהערך בנכס status.streamStatus של הסטרימינג שמשויך לשידור הוא active.
update PUT /liveBroadcasts מעדכן שידור. לדוגמה, אפשר לשנות את הגדרות השידור שמוגדרות באובייקט contentDetails של המשאב liveBroadcast.
cuepoint POST /liveBroadcasts/cuepoint הוספת נקודת סימון לשידור חי. נקודת הסימון עשויה להפעיל הפסקה למודעה.

LiveChatBans

משאב של liveChatBan מזהה משתמש ב-YouTube וצ'אט בשידור חי ב-YouTube שאסור למשתמשים להשתתף בהם.

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

שיטה בקשת HTTP תיאור
מזהי URI ביחס ל-https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/bans מסירה חסימה שמונעת ממשתמש מסוים להשתתף בצ'אט בשידור חי, וכתוצאה מכך מאפשרת לו להצטרף מחדש לצ'אט. בקשת ה-API צריכה לקבל אישור מהבעלים של הערוץ או מהמנהל של הצ'אט בשידור חי שמשויך לחסימה.
insert POST /liveChat/bans חסימת משתמש מסוים בצ'אט בשידור חי. בקשת ה-API צריכה לקבל אישור מהבעלים של הערוץ או מהמנהל של הצ'אט בשידור חי שמשויך לחסימה.

LiveChatMessages

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

התכונה 'צ'אט בשידור חי' מופעלת כברירת מחדל בשידורים חיים וזמינה כל עוד האירוע בשידור חי פעיל. (לאחר סיום האירוע, הצ'אט בשידור חי לא יהיה זמין יותר לאירוע הזה).

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

שיטה בקשת HTTP תיאור
מזהי URI ביחס ל-https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/messages מחיקה של הודעת צ'אט. בקשת ה-API צריכה לקבל אישור מהבעלים של הערוץ או מהמנהל של הצ'אט בשידור חי שמשויך לחסימה.
insert POST /liveChat/messages הוספת הודעה לצ'אט בשידור חי.
list GET /liveChat/messages הצגת רשימה של הודעות צ'אט בשידור חי בצ'אט ספציפי.

LiveChatModerators

משאב של liveChatModerator מייצג מנהל צ'אט בשידור חי ב-YouTube. מנהל הצ'אט יכול לחסום משתמשים מהצ'אט או לבטל את החסימה שלהם, להסיר הודעות ולבצע פעולות ניהול אחרות בצ'אט בשידור חי.

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

שיטה בקשת HTTP תיאור
מזהי URI ביחס ל-https://www.googleapis.com/youtube/v3
delete DELETE /liveChat/moderators הסרה של מנהל צ'אט. הבקשה חייבת להיות מאושרת על ידי הבעלים של הערוץ של השידור החי.
insert POST /liveChat/moderators הוספת מנהל חדש לצ'אט. הבקשה חייבת להיות מאושרת על ידי הבעלים של הערוץ של השידור החי.
list GET /liveChat/moderators הצגת רשימה של מנהלי צ'אט בשידור חי. הבקשה חייבת להיות מאושרת על ידי הבעלים של הערוץ של השידור החי.

LiveStreams

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

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

שיטה בקשת HTTP תיאור
מזהי URI ביחס ל-https://www.googleapis.com/youtube/v3
delete DELETE /liveStreams מוחק זרם וידאו.
insert POST /liveStreams יצירת וידאו בסטרימינג. הסטרימינג מאפשר לשלוח את הסרטון ל-YouTube, ולאחר מכן לשדר אותו לקהל שלכם.
list GET /liveStreams הפונקציה מחזירה רשימה של שידורי וידאו שתואמים לפרמטרים של בקשות ה-API.
update PUT /liveStreams מעדכן זרם וידאו. אם לא ניתן לעדכן את הנכסים שאתם רוצים לשנות, תצטרכו ליצור שידור חדש עם ההגדרות המתאימות.

SuperChatEvents

משאב של superChatEvent מייצג הודעת Super Chat שנרכשה על ידי מעריץ במהלך שידור חי ב-YouTube. בסטרימינג של הצ'אט בשידור חי ב-YouTube, הודעות Super Chat מובלטות בשתי דרכים:

  • הודעות Super Chat מודגשות בצבע.
  • הודעות Super Chat נשארות מוצמדות בשורת ההודעות לפרק זמן מוגדר.

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

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

שיטה בקשת HTTP תיאור
מזהי URI ביחס ל-https://www.googleapis.com/youtube/v3
list GET /superChatEvents הצגת רשימה של אירועי Super Chat משידורים חיים של הערוץ ב-30 הימים האחרונים.

סוגי המשאבים שהוצאו משימוש

FanFundingEvents

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

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

שיטה בקשת HTTP תיאור
מזהי URI ביחס ל-https://www.googleapis.com/youtube/v3
list GET /fanFundingEvents פירוט אירועים של מימון על ידי מעריצים בערוץ. הבעלים של הערוץ צריכים לאשר את בקשת ה-API.

LiveCuepoints

משאב של liveCuepoint מפעיל הפסקה למודעות בשידור הווידאו בשידור.

הערה: פקודת ה-API לשליטה ב-cuepoints היא למעשה חלק מ-YouTube Content ID API, עם דרישות הרשאה שונות מאלה של בקשות לניהול משאבים של liveBroadcast ו-liveStream.

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

שיטה בקשת HTTP תיאור
מזהי URI ביחס ל-https://www.googleapis.com/
insert POST /liveCuepoints הוספת נקודת סימון לשידור חי. בשלב זה, בקשות לשיטה זו חייבות לקבל אישור מחשבון המשויך לבעלי תוכן ב-YouTube.

נותני חסות

משאב sponsor מייצג נותן חסות לערוץ YouTube. נותן חסות מעניק ליוצר תמיכה כספית קבועה, כמו דמי מינוי או דמי מינוי, ומקבל הטבות מיוחדות. לדוגמה: נותני חסות יכולים לשוחח בצ'אט כשהיוצר הפעיל בצ'אט מצב לנותני חסות בלבד.

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

שיטה בקשת HTTP תיאור
מזהי URI ביחס ל-https://www.googleapis.com/youtube/v3
list GET /sponsors רשימה של נותני החסות של הערוץ. הבעלים של הערוץ צריכים לאשר את בקשת ה-API.