Method: spaces.messages.create

יצירת הודעה במרחב ב-Chat. דוגמה מופיעה במאמר בנושא שליחת הודעה.

יש תמיכה בסוגי האימות הבאים:

  • אימות אפליקציה עם היקף ההרשאות:
    • https://www.googleapis.com/auth/chat.bot
  • אימות משתמשים עם אחת מהרשאות הגישה הבאות:
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • ‫https://www.googleapis.com/auth/chat.import (רווחים במצב ייבוא בלבד)

ב-Chat, השיוך של שולח ההודעה משתנה בהתאם לסוג האימות שבו אתם משתמשים בבקשה.

בתמונה הבאה אפשר לראות איך Chat משייך הודעה כשמשתמשים באימות אפליקציה. ב-Chat, אפליקציית ה-Chat מוצגת כשולחת ההודעה. תוכן ההודעה יכול לכלול טקסט (text), כרטיסים (cardsV2) ווידג'טים של אביזרים (accessoryWidgets).

ההודעה נשלחה עם אימות האפליקציה

בתמונה הבאה אפשר לראות איך Chat משייך מאפיינים להודעה כשמשתמשים באימות משתמשים. ב-Chat, המשתמש מוצג כשולח ההודעה, ואפליקציית Chat משויכת להודעה באמצעות השם שלה. תוכן ההודעה יכול לכלול רק טקסט (text).

הודעה שנשלחה עם אימות משתמש

הגודל המקסימלי של ההודעה, כולל תוכן ההודעה, הוא 32,000 בייטים.

בבקשות webhook, התשובה לא מכילה את ההודעה המלאה. התשובה מאכלסת רק את השדות name ו-thread.name, בנוסף למידע שהיה בבקשה.

בקשת HTTP

POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. שם המשאב של המרחב שבו רוצים ליצור את ההודעה.

פורמט: spaces/{space}

פרמטרים של שאילתה

פרמטרים
threadKey
(deprecated)

string

אופציונלי. הוצא משימוש: במקומו, צריך להשתמש ב-thread.thread_key. המזהה של השרשור. אפשר לכתוב עד 4,000 תווים. כדי להתחיל שרשור או להוסיף הודעה לשרשור, יוצרים הודעה ומציינים threadKey או thread.name. דוגמאות לשימוש מופיעות במאמר התחלת שרשור או מענה לשרשור.
requestId

string

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

enum (MessageReplyOption)

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

כשמגיבים לאינטראקציות של משתמשים, המערכת מתעלמת מהשדה הזה. כשמגיבים בשרשור, התשובה נוצרת באותו השרשור. אחרת, התשובה תיצור שרשור חדש.
messageId

string

אופציונלי. מזהה מותאם אישית של הודעה. מאפשר לאפליקציות ל-Chat לקבל, לעדכן או למחוק הודעה בלי לאחסן את המזהה שהמערכת הקצתה בשם המשאב של ההודעה (שמוצג בשדה name של ההודעה).

הערך בשדה הזה צריך לעמוד בדרישות הבאות:

  • מתחיל ב-client-. לדוגמה, client-custom-name הוא מזהה מותאם אישית תקין, אבל custom-name לא.
  • התווים יכולים להיות רק אותיות קטנות, מספרים ומקפים, והאורך המקסימלי הוא 63 תווים.
  • ייחודי במרחב. אפליקציית Chat לא יכולה להשתמש באותו מזהה מותאם אישית להודעות שונות.

מידע נוסף מופיע במאמר בנושא מתן שם להודעה.
createMessageNotificationOptions

object (CreateMessageNotificationOptions)

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

גוף הבקשה

גוף הבקשה מכיל מופע של Message.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של Message.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

מידע נוסף זמין במדריך ההרשאות.

MessageReplyOption

המדיניות מציינת איך לענות להודעה. יכול להיות שנוסיף עוד מדינות בעתיד.

טיפוסים בני מנייה (enum)
MESSAGE_REPLY_OPTION_UNSPECIFIED ברירת מחדל. מתחילים שרשור חדש. אם משתמשים באפשרות הזו, המערכת מתעלמת מכל thread ID או threadKey שכלולים.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD יוצר את ההודעה כתשובה לשרשור שצוין על ידי thread ID או threadKey. אם השליחה נכשלת, ההודעה מתחילה שרשור חדש במקום זאת.
REPLY_MESSAGE_OR_FAIL יוצר את ההודעה כתשובה לשרשור שצוין על ידי thread ID או threadKey. אם משתמשים ב-threadKey חדש, נוצר שרשור חדש. אם יצירת ההודעה נכשלת, מוחזרת שגיאת NOT_FOUND במקום זאת.

CreateMessageNotificationOptions

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

ייצוג ב-JSON 
{
  "notificationType": enum (NotificationType)
}
שדות
notificationType

enum (NotificationType)

סוג ההתראה של ההודעה.

NotificationType

אפשרויות לסוגי ההתראות על ההודעה.

טיפוסים בני מנייה (enum)
NOTIFICATION_TYPE_NONE התנהגות ברירת המחדל. ההתנהגות של ההתראה דומה למצב שבו המשתמש האנושי שולח את ההודעה באמצעות ממשק המשתמש של Chat: לא נשלחת התראה לשולח האנושי.
NOTIFICATION_TYPE_FORCE_NOTIFY

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

נדרש אימות אפליקציה.
NOTIFICATION_TYPE_SILENT

ההתראה מושתקת כאילו המשתתפים הפעילו את ההגדרה נא לא להפריע ב-Chat או השתיקו את המרחב.

נדרש אימות אפליקציה.