Method: spaces.messages.create

יצירת הודעה במרחב משותף ב-Google Chat. לדוגמה, אפשר להיעזר במאמר שליחת הודעה.

בשיטה create() נדרש אימות משתמש או אימות אפליקציה. מערכת 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 משתמשת בתחביר של Transcoding של gRPC.

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

פרמטרים
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 תווים, ורק אותיות קטנות, מספרים ומקפים.
  • הוא ייחודי במרחב המשותף. אי אפשר להשתמש באותו מזהה מותאם אישית להודעות שונות באפליקציית צ'אט.

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

גוף הבקשה

גוף הבקשה מכיל מופע של 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 במקום זאת.