Method: spaces.messages.create

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

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

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

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

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

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

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

בקשת HTTP

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

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

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

גוף הבקשה

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