LiveChatMessages: insert

להוסיף הודעה או סקר לצ'אט בשידור חי.

השפעה על המכסה: קריאה ל-method הזה מנצלת 20 יחידות מהמכסה.

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

בקשה

בקשת HTTP

POST https://www.googleapis.com/youtube/v3/liveChat/messages

אישור

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

היקף
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

פרמטרים

בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים שמופיעים ברשימה הם פרמטרים של שאילתה.

פרמטרים
פרמטרים נדרשים
part string
לפרמטר part יש שתי מטרות. הוא מזהה את המאפיינים שפעולת הכתיבה תגדיר, וגם את המאפיינים שהתגובה מה-API תכלול. מגדירים את ערך הפרמטר בתור snippet.

גוף הבקשה

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

  • snippet.liveChatId
  • ‫snippet.type – בוחרים אחת מהאפשרויות הבאות: textMessageEvent או pollEvent
  • אם הסוג הוא textMessageEvent, צריך לכלול את snippet.textMessageDetails.messageText
  • אם הסוג הוא pollEvent, צריך לכלול את האובייקט snippet.pollDetails במבנה הבא:
    • ‫snippet.pollDetails.metadata.questionText (מחרוזת): השאלה העיקרית בסקר.
    • ‫snippet.pollDetails.metadata.options (מערך): רשימה של אובייקטים של אפשרויות.
    • דרישות: צריך לכלול לפחות 2 פריטים ולכל היותר 4 פריטים.
    • סדר: הפריטים מוצגים ברצף לפי הסדר המדויק שבו הם מופיעים ברשימה.
    • כל אובייקט במערך חייב להכיל:
      • optionText (מחרוזת): הטקסט שמוצג לאפשרות הספציפית הזו בסקר.

תשובה

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

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
forbidden (403) forbidden אין לכם את ההרשאות הנדרשות כדי ליצור את ההודעה שצוינה.
forbidden (403) liveChatDisabled הבעלים השביתו את הצ'אט בשידור החי שצוין, ולכן אי אפשר להוסיף הודעות לצ'אט.
forbidden (403) liveChatEnded הצ'אט בשידור חי שצוין כבר לא פעיל.
invalidValue (400) messageTextInvalid טקסט ההודעה (snippet.textMessageDetails.messageText) לא תקין.
notFound (404) liveChatNotFound הצ'אט בשידור חי שזוהה בבקשת ה-API לא קיים. השגיאה הזו מתרחשת אם הבעלים מחק את הצ'אט.
required (400) liveChatIdRequired המשאב liveChatMessage חייב לכלול ערך למאפיין snippet.liveChatId ולציין אותו.
required (400) messageTextRequired למשאב liveChatMessage צריך להיות ערך שצוין במאפיין snippet.textMessageDetails.messageText.
required (400) typeRequired המשאב liveChatMessage חייב לכלול ערך למאפיין snippet.type ולציין אותו. מגדירים את ערך הפרמטר ל-text
required (400) preconditionCheckFailed כבר יש סקר פעיל שמוצמד.
rateLimitExceeded rateLimitExceeded המשתמש פרסם יותר מדי הודעות צ'אט בפרק זמן נתון.

רוצה לנסות?

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