REST Resource: spaces.messages

מקור מידע: הודעה

הודעה במרחב משותף ב-Google Chat.

ייצוג JSON 
{
  "name": string,
  "sender": {
    object (User)
  },
  "createTime": string,
  "lastUpdateTime": string,
  "deleteTime": string,
  "text": string,
  "formattedText": string,
  "cards": [
    {
      object (Card)
    }
  ],
  "cardsV2": [
    {
      object (CardWithId)
    }
  ],
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "thread": {
    object (Thread)
  },
  "space": {
    object (Space)
  },
  "fallbackText": string,
  "actionResponse": {
    object (ActionResponse)
  },
  "argumentText": string,
  "slashCommand": {
    object (SlashCommand)
  },
  "attachment": [
    {
      object (Attachment)
    }
  ],
  "matchedUrl": {
    object (MatchedUrl)
  },
  "threadReply": boolean,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ]
}
שדות
name

string

שם המשאב שמוצג בפורמט spaces/*/messages/*.

לדוגמה: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB
sender

object (User)

פלט בלבד. המשתמש שיצר את ההודעה. אם אפליקציית Chat מבצעת אימות כמשתמש, הפלט יאכלס את המשתמש name ואת type.
createTime

string (Timestamp format)

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

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

string (Timestamp format)

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

string (Timestamp format)

פלט בלבד. השעה שבה ההודעה נמחקה ב-Google Chat. אם ההודעה לא נמחקת אף פעם, השדה הזה יהיה ריק.
text

string

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

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

string

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

  • תחביר סימון לבלוקים מודגשים, נטויים, עם קו חוצה, ברוחב אחיד וברוחב אחיד.
  • אזכור על ידי המשתמש בפורמט <users/{user}>.
  • היפר-קישורים מותאמים אישית בפורמט <{url}|{rendered_text}>, כאשר המחרוזת הראשונה היא כתובת ה-URL והשני הוא הטקסט שעבר עיבוד – לדוגמה, <http://example.com|custom text>.
  • אמוג'י בהתאמה אישית בפורמט :{emoji_name}: — לדוגמה: :smile:. הבעיה הזו לא רלוונטית לאמוג'י ב-Unicode, למשל U+1F600 לאמוג'י עם פרצוף מחייך.

מידע נוסף זמין במאמר הצגת עיצוב הטקסט שנשלח בהודעה
cards[]
(deprecated)

object (Card)

הוצא משימוש: יש להשתמש במדיניות cardsV2 במקום זאת.

כרטיסים עשירים, מעוצבים ואינטראקטיביים שאפשר להשתמש בהם כדי להציג רכיבי ממשק משתמש, כמו טקסטים מעוצבים, לחצנים ותמונות שניתן ללחוץ עליהן. לרוב, הכרטיסים מוצגים מתחת לגוף ההודעה. הגודל המקסימלי של cards ושל cardsV2 הוא 32KB.
cardsV2[]

object (CardWithId)

מערך של כרטיסים.

אפשר ליצור כרטיסים רק באפליקציות צ'אט. אם אפליקציית Chat מבצעת אימות כמשתמש, ההודעות לא יכולות להכיל כרטיסים.

למידע נוסף על כרטיסים ועל יצירתם, אפשר לעיין במאמר עיצוב ממשקי משתמש דינמיים, אינטראקטיביים ועקביים עם כרטיסים.
annotations[]

object (Annotation)

פלט בלבד. ביאורים שמשויכים ל-text בהודעה הזו.
thread

object (Thread)

השרשור שאליו שייכת ההודעה. לדוגמה, תוכלו להיעזר במאמר התחלת שרשור הודעות או מענה אליו.
space

object (Space)

אם אפליקציית Chat מבצעת אימות כמשתמש, הפלט יאכלס את המרחב המשותף name.
fallbackText

string

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

object (ActionResponse)

קלט בלבד. פרמטרים שאפליקציית Chat יכולה להשתמש בהם כדי להגדיר איך התשובה שלה תפורסם.
argumentText

string

פלט בלבד. גוף ההודעה בטקסט פשוט ללא כל האזכורים שלו באפליקציית Chat.
slashCommand

object (SlashCommand)

פלט בלבד. מידע על פקודות דרך שורת הפקודות, אם רלוונטי.
attachment[]

object (Attachment)

קובץ מצורף שהעלה משתמש.
matchedUrl

object (MatchedUrl)

פלט בלבד. כתובת URL ב-spaces.messages.text שתואמת לתבנית תצוגה מקדימה של קישור. מידע נוסף זמין במאמר תצוגה מקדימה של קישורים.
threadReply

boolean

פלט בלבד. כאשר true, ההודעה היא תשובה בשרשור תשובות. כש-false, ההודעה מופיעה בשיחה ברמה העליונה של המרחב המשותף כהודעה הראשונה בשרשור או כהודעה ללא תשובות בשרשור.

אם אי אפשר לענות להודעות במרחב המשותף הזה, השדה הזה הוא תמיד false.
clientAssignedMessageId

string

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

object (EmojiReactionSummary)

פלט בלבד. רשימת סיכומי התגובות של האמוג'י בהודעה.
deletionMetadata

object (DeletionMetadata)

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

object (QuotedMessageMetadata)

פלט בלבד. מידע על הודעות שצוטטו על ידי משתמשי Google Chat במרחבים משותפים. משתמשי Google Chat יכולים לצטט הודעה כדי להשיב לה.
attachedGifs[]

object (AttachedGif)

פלט בלבד. תמונות בפורמט GIF שמצורפות להודעה.

מזהה כרטיס

כרטיס בהודעה ב-Google Chat.

אפשר ליצור כרטיסים רק באפליקציות צ'אט. אם אפליקציית Chat מבצעת אימות כמשתמש, ההודעה לא יכולה להכיל כרטיסים.

ייצוג JSON 
{
  "cardId": string,
  "card": {
    object (Card)
  }
}
שדות
cardId

string

חובה אם ההודעה מכילה כמה כרטיסים. המזהה הייחודי של כרטיס בהודעה.
card

object (Card)

כרטיס. הגודל המקסימלי הוא 32KB.

הערה

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

דוגמה לגוף של הודעה בטקסט פשוט:

Hello @FooBot how are you!"

המטא-נתונים התואמים של ההערות:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
ייצוג JSON 
{
  "type": enum (AnnotationType),
  "length": integer,
  "startIndex": integer,

  // Union field metadata can be only one of the following:
  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  }
  // End of list of possible types for union field metadata.
}
שדות
type

enum (AnnotationType)

סוג ההערה הזו.
length

integer

האורך של מחרוזת המשנה בגוף ההודעה בטקסט פשוט שההערה הזו תואמת לו.
startIndex

integer

אינדקס התחלה (מבוסס 0, כולל) בגוף ההודעה בטקסט פשוט שההערה הזו מתייחסת אליו.
שדה איחוד metadata. מטא-נתונים נוספים לגבי ההערה. הערך של metadata יכול להיות רק אחת מהאפשרויות הבאות:
userMention

object (UserMentionMetadata)

המטא-נתונים של אזכור משתמש.
slashCommand

object (SlashCommandMetadata)

המטא-נתונים של פקודה דרך שורת הפקודות.

סוג הערה

סוג ההערה.

טיפוסים בני מנייה (enum)
ANNOTATION_TYPE_UNSPECIFIED ערך ברירת המחדל של טיפוסים בני מנייה (enum). אין להשתמש בו.
USER_MENTION משתמש אוזכר.
SLASH_COMMAND מופעלת פקודה דרך שורת הפקודות.

מטא-נתונים של UserReference

מטא-נתונים של הערות לאזכרים של משתמש (@).

ייצוג JSON 
{
  "user": {
    object (User)
  },
  "type": enum (Type)
}
שדות
user

object (User)

המשתמש ציין.
type

enum (Type)

סוג האזכור של המשתמש.

סוג

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED ערך ברירת המחדל של טיפוסים בני מנייה (enum). אין להשתמש בו.
ADD הוספת משתמש למרחב המשותף.
MENTION אזכור משתמש במרחב המשותף.

SlashCommandMetadata

מטא-נתונים של הערות לפקודות דרך שורת הפקודות (/).

ייצוג JSON 
{
  "bot": {
    object (User)
  },
  "type": enum (Type),
  "commandName": string,
  "commandId": string,
  "triggersDialog": boolean
}
שדות
bot

object (User)

אפליקציית Chat שהפקודה שלה הופעלה.
type

enum (Type)

הסוג של הפקודה דרך שורת הפקודות.
commandName

string

שם הפקודה לוכסן שהופעל.
commandId

string (int64 format)

מזהה הפקודה של הפקודה שהופעלה דרך לוכסן.
triggersDialog

boolean

מציין אם הפקודה לוכסן היא תיבת דו-שיח.

סוג

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED ערך ברירת המחדל של טיפוסים בני מנייה (enum). אין להשתמש בו.
ADD צירוף אפליקציית Chat למרחב המשותף.
INVOKE צריך להפעיל פקודה דרך שורת הפקודות במרחב המשותף.

Thread

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

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

ייצוג JSON 
{
  "name": string,
  "threadKey": string
}
שדות
name

string

פלט בלבד. שם המשאב של השרשור.

לדוגמה: spaces/{space}/threads/{thread}
threadKey

string

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

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

תגובה לפעולה

פרמטרים שאפליקציית Chat יכולה להשתמש בהם כדי להגדיר איך התשובה שלה תפורסם.

ייצוג JSON 
{
  "type": enum (ResponseType),
  "url": string,
  "dialogAction": {
    object (DialogAction)
  }
}
שדות
type

enum (ResponseType)

קלט בלבד. סוג התשובה מאפליקציית Chat.
url

string

קלט בלבד. כתובת אתר שבה משתמשים יכולים לאמת או להגדיר. (רק ל-REQUEST_CONFIG סוגי תשובות.)
dialogAction

object (DialogAction)

קלט בלבד. תשובה לאירוע שקשור לתיבת דו-שיח. יש לציין יחד עם ResponseType.Dialog.

סוג תגובה

סוג התשובה מאפליקציית Chat.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED סוג ברירת המחדל שמטופל כ-NEW_MESSAGE.
NEW_MESSAGE מפרסמים את הנושא כהודעה חדשה בנושא.
UPDATE_MESSAGE מעדכנים את ההודעה באפליקציית Chat. הפעולה הזו מותרת רק באירוע CARD_CLICKED שבו סוג שולח ההודעה הוא BOT.
UPDATE_USER_MESSAGE_CARDS מעדכנים את הכרטיסים בהודעות של המשתמשים. מותר לשלוח תגובות רק לאירוע MESSAGE עם כתובת URL תואמת או לאירוע CARD_CLICKED שסוג שולח ההודעה הוא HUMAN. המערכת מתעלמת מהטקסט.
REQUEST_CONFIG יש לבקש מהמשתמש אימות או הגדרות נוספות בפרטיות.
DIALOG מוצג תיבת דו-שיח.

תיבת דו-שיח

מכילה תיבת דו-שיח וקוד סטטוס של בקשה.

ייצוג JSON 
{
  "actionStatus": {
    object (ActionStatus)
  },

  // Union field action can be only one of the following:
  "dialog": {
    object (Dialog)
  }
  // End of list of possible types for union field action.
}
שדות
actionStatus

object (ActionStatus)

קלט בלבד. סטטוס של בקשה להפעלה או לשליחת תיבת דו-שיח. מציגה סטטוס והודעה למשתמשים, במקרה הצורך. לדוגמה, במקרה של שגיאה או הצלחה.

שדה איחוד action.

הערך של action יכול להיות רק אחת מהאפשרויות הבאות:
dialog

object (Dialog)

קלט בלבד. תיבת דו-שיח של הבקשה.

תיבת דו-שיח

גלישת טקסט סביב גוף הכרטיס של תיבת הדו-שיח.

ייצוג JSON 
{
  "body": {
    object (Card)
  }
}
שדות
body

object (Card)

קלט בלבד. גוף תיבת הדו-שיח, שמוצג בחלון עזר. האפליקציות של Google Chat לא תומכות בישויות הכרטיסים הבאות: DateTimePicker, OnChangeAction.

סטטוס פעולה

מייצג את הסטטוס של בקשה להפעלה או לשליחה של תיבת דו-שיח.

ייצוג JSON 
{
  "statusCode": enum (Code),
  "userFacingMessage": string
}
שדות
statusCode

enum (Code)

קוד הסטטוס.
userFacingMessage

string

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

קוד

קודי השגיאה הקנוניים של ממשקי API של gRPC.

לפעמים יכולים להופיע כמה קודי שגיאה. השירותים אמורים להחזיר את קוד השגיאה הספציפי ביותר שחל. לדוגמה, אם שני הקודים מתאימים, עדיף OUT_OF_RANGE על פני FAILED_PRECONDITION. באופן דומה, עדיף לבחור ב-NOT_FOUND או ב-ALREADY_EXISTS על פני FAILED_PRECONDITION.

טיפוסים בני מנייה (enum)
OK

זו לא שגיאה. הוחזרה בהצלחה.

מיפוי HTTP: 200 OK
CANCELLED

הפעולה בוטלה, בדרך כלל על ידי המתקשר.

מיפוי HTTP: בקשה סגורה של לקוח 499
UNKNOWN

שגיאה לא ידועה. לדוגמה, ייתכן שהשגיאה הזו תוחזר כשערך Status שהתקבל ממרחב כתובות אחר שייך למרחב שגיאות שאינו ידוע במרחב הכתובות הזה. כמו כן, ייתכן ששגיאות שהועלו על ידי ממשקי API שלא מחזירים מספיק מידע על השגיאות יומרו לשגיאה הזו.

מיפוי HTTP: שגיאת שרת פנימית 500
INVALID_ARGUMENT

הלקוח ציין ארגומנט לא חוקי. לתשומת ליבך, הערך הזה שונה מהערך FAILED_PRECONDITION. INVALID_ARGUMENT מציין ארגומנטים בעייתיים ללא קשר למצב המערכת (למשל, שם קובץ שגוי).

מיפוי HTTP: בקשה לא תקינה 400
DEADLINE_EXCEEDED

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

מיפוי HTTP: הזמן הקצוב לתפוגה של שער 504
NOT_FOUND

חלק מהישות המבוקשת (למשל קובץ או ספרייה) לא נמצאה.

הערה למפתחי שרתים: אם בקשה מסוימת נדחית עבור קבוצה שלמה של משתמשים, למשל השקה הדרגתית של תכונה או רשימת היתרים שאינה מתועדת, ניתן להשתמש ב-NOT_FOUND. אם בקשה נדחית עבור משתמשים מסוימים במחלקה של משתמשים, כגון בקרת גישה מבוססת-משתמש, יש להשתמש ב-PERMISSION_DENIED.

מיפוי HTTP: 404 לא נמצא
ALREADY_EXISTS

הישות שהלקוח ניסה ליצור (למשל, קובץ או ספרייה) כבר קיימת.

מיפוי HTTP: התנגשות 409
PERMISSION_DENIED

למתקשר אין הרשאה לבצע את הפעולה שצוינה. אין להשתמש ב-PERMISSION_DENIED לדחיות שנגרמו עקב מיצוי של המשאב (יש להשתמש ב-RESOURCE_EXHAUSTED במקום זאת לשגיאות האלה). אין להשתמש ב-PERMISSION_DENIED אם לא ניתן לזהות את המתקשר (יש להשתמש ב-UNAUTHENTICATED במקום זאת לשגיאות כאלה). קוד השגיאה הזה לא רומז לכך שהבקשה תקפה או שהישות המבוקשת קיימת או עומדת בתנאים-מוקדמים אחרים.

מיפוי HTTP: 403 אסור
UNAUTHENTICATED

לבקשה אין פרטי כניסה חוקיים לאימות עבור הפעולה.

מיפוי HTTP: 401 לא מורשה
RESOURCE_EXHAUSTED

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

מיפוי HTTP: 429 יותר מדי בקשות
FAILED_PRECONDITION

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

מטמיעים של שירותים יכולים להשתמש בהנחיות הבאות כדי להחליט בין FAILED_PRECONDITION, ABORTED ו-UNAVAILABLE: (א) יש להשתמש ב-UNAVAILABLE אם הלקוח יכול לנסות שוב רק את הקריאה שנכשלה. (ב) יש להשתמש ב-ABORTED אם הלקוח צריך לנסות שוב ברמה גבוהה יותר. לדוגמה, כאשר בדיקה וקבוצה שהוגדרה ללקוח נכשלת, המשמעות היא שהלקוח צריך להפעיל מחדש רצף של קריאה-שינוי-כתיבה. (ג) יש להשתמש ב-FAILED_PRECONDITION אם הלקוח לא מנסה שוב עד שמצב המערכת יתוקן באופן מפורש. לדוגמה, אם השדה "rmdir" נכשל כי הספרייה לא ריקה, צריך להחזיר את הפונקציה FAILED_PRECONDITION כי הלקוח לא צריך לנסות שוב אלא אם הקבצים נמחקו מהספרייה.

מיפוי HTTP: בקשה לא תקינה 400
ABORTED

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

בהנחיות שלמעלה מוסבר איך להחליט בין FAILED_PRECONDITION, ABORTED ו-UNAVAILABLE.

מיפוי HTTP: התנגשות 409
OUT_OF_RANGE

נעשה ניסיון לבצע את הפעולה מעבר לטווח התקף. למשל, חיפוש או קריאה מעבר לסוף הקובץ.

בניגוד ל-INVALID_ARGUMENT, השגיאה הזו מציינת בעיה שניתן לתקן אם מצב המערכת ישתנה. לדוגמה, מערכת קבצים של 32 ביט תפיק INVALID_ARGUMENT אם תתבקש לקרוא בהיסט שאינו בטווח [0,2^32-1], אבל תפיק OUT_OF_RANGE אם תתבקש לקרוא מהקיזוז שחל על גודל הקובץ הנוכחי.

יש חפיפה מסוימת בין FAILED_PRECONDITION ל-OUT_OF_RANGE. מומלץ להשתמש ב-OUT_OF_RANGE (השגיאה הספציפית יותר) כשהיא מופעלת, כדי שמתקשרים שחוזרים על עצמם במרחב משותף יוכלו לחפש בקלות את השגיאה OUT_OF_RANGE ולזהות מתי הם יסיימו.

מיפוי HTTP: בקשה לא תקינה 400
UNIMPLEMENTED

הפעולה אינה מיושמת או אינה נתמכת/מופעלת בשירות זה.

מיפוי HTTP: 501 לא יושם
INTERNAL

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

מיפוי HTTP: שגיאת שרת פנימית 500
UNAVAILABLE

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

בהנחיות שלמעלה מוסבר איך להחליט בין FAILED_PRECONDITION, ABORTED ו-UNAVAILABLE.

מיפוי HTTP: שירות 503 לא זמין
DATA_LOSS

אובדן או פגיעה בנתונים שלא ניתן לשחזר.

מיפוי HTTP: שגיאת שרת פנימית 500

לוכסן Command

פקודת לוכסן ב-Google Chat.

ייצוג JSON 
{
  "commandId": string
}
שדות
commandId

string (int64 format)

המזהה של הפקודה שמבוססת על לוכסן הופעל.

כתובת URL תואמת

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

ייצוג JSON 
{
  "url": string
}
שדות
url

string

פלט בלבד. כתובת ה-URL שנמצאה לה התאמה.

סיכום התגובה

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

ייצוג JSON 
{
  "emoji": {
    object (Emoji)
  },
  "reactionCount": integer
}
שדות
emoji

object (Emoji)

אמוג'י שמשויך לתגובות.
reactionCount

integer

המספר הכולל של תגובות שנעשה בהן שימוש באמוג'י המשויך.

מטא-נתונים של מחיקה

מידע על הודעה שנמחקה. הודעה נמחקת כשמגדירים את deleteTime.

ייצוג JSON 
{
  "deletionType": enum (DeletionType)
}
שדות
deletionType

enum (DeletionType)

שדה זה מציין מי מחק את ההודעה.

סוג המחיקה

מי מחק את ההודעה ואיך היא נמחקה.

טיפוסים בני מנייה (enum)
DELETION_TYPE_UNSPECIFIED הערך הזה לא בשימוש.
CREATOR המשתמש מחק את ההודעה שלו.
SPACE_OWNER הבעלים של המרחב המשותף מחקו את ההודעה.
ADMIN אדמין ב-Google Workspace מחק את ההודעה.
APP_MESSAGE_EXPIRY אחת מההודעות של אפליקציית Chat נמחקה כשפג התוקף שלה.
CREATOR_VIA_APP אפליקציית Chat מחקה את ההודעה בשם המשתמש.
SPACE_OWNER_VIA_APP אפליקציית Chat מחקה את ההודעה בשם הבעלים של המרחב המשותף.

QuotedMessageMetadata

מידע על הודעה מצוטטת.

ייצוג JSON 
{
  "name": string,
  "lastUpdateTime": string
}
שדות
name

string

פלט בלבד. שם המשאב של ההודעה המצוטטת.

פורמט: spaces/{space}/messages/{message}
lastUpdateTime

string (Timestamp format)

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

קובץ GIF מצורף

תמונת GIF שצוינה באמצעות כתובת URL.

ייצוג JSON 
{
  "uri": string
}
שדות
uri

string

פלט בלבד. כתובת ה-URL שמארחת את תמונת ה-GIF.

שיטות

create

 יצירת הודעה במרחבים משותפים ב-Google Chat.

delete

 ההודעה נמחקת.

get

 הפונקציה מחזירה פרטים על הודעה מסוימת.

list

 בתיבת הדו-שיח הזו מוצגים כל ההודעות במרחב המשותף שהמתקשר משתתף בו, כולל הודעות מכל המשתמשים והמרחבים המשותפים שחסמתם.

patch

 עדכון הודעה.

update

 עדכון הודעה.