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)
    }
  ],
  "privateMessageViewer": {
    object (User)
  },
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ],
  "accessoryWidgets": [
    {
      object (AccessoryWidget)
    }
  ]
}
שדות
name

string

מזהה. שם המשאב של ההודעה.

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

כאשר {space} הוא המזהה של המרחב שבו ההודעה פורסמה ו-{message} הוא מזהה שהוקצה להודעה על ידי המערכת. לדוגמה, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

אם הגדרתם מזהה בהתאמה אישית כשאתם יוצרים הודעה, אתם יכולים להשתמש במזהה הזה כדי לציין את ההודעה בבקשה. לשם כך, מחליפים את {message} בערך מהשדה clientAssignedMessageId. לדוגמה, spaces/AAAAAAAAAAA/messages/client-custom-name. מידע נוסף מופיע במאמר בנושא מתן שם להודעה.
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>.

  • אמוג'י בהתאמה אישית בפורמט :{emojiName}: – לדוגמה, :smile:. הכלל הזה לא חל על אמוג'י Unicode, כמו U+1F600 לאמוג'י של פרצוף מחייך.

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

object (Card)

הוצא משימוש: במקומו צריך להשתמש ב-cardsV2.

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

object (CardWithId)

אופציונלי. מערך של כרטיסים.

רק אפליקציות ל-Chat יכולות ליצור כרטיסים. אם אפליקציית 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

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

object (EmojiReactionSummary)

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

object (User)

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

פרטים נוספים מופיעים במאמר בנושא שליחת הודעה פרטית.
deletionMetadata

object (DeletionMetadata)

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

object (QuotedMessageMetadata)

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

object (AttachedGif)

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

object (AccessoryWidget)

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

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

CardWithId

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

רק אפליקציות ל-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)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  },
  "customEmojiMetadata": {
    object (CustomEmojiMetadata)
  }
  // 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)

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

object (CustomEmojiMetadata)

המטא-נתונים של אמוג'י בהתאמה אישית.

AnnotationType

סוג ההערה.

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

UserMentionMetadata

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

ייצוג ב-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 להפעיל פקודה של שורת הפקודות במרחב.

RichLinkMetadata

קישור עשיר למשאב.

ייצוג ב-JSON 
{
  "uri": string,
  "richLinkType": enum (RichLinkType),

  // Union field data can be only one of the following:
  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  }
  // End of list of possible types for union field data.
}
שדות
uri

string

ה-URI של הקישור.
שדה איחוד data. נתונים של המשאב המקושר. הערך data יכול להיות רק אחד מהבאים:

RichLinkType

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

טיפוסים בני מנייה (enum)
DRIVE_FILE סוג קישור עשיר ב-Google Drive.
CHAT_SPACE סוג של קישור מתקדם למרחב ב-Chat. לדוגמה, צ'יפ חכם של מרחב.

DriveLinkData

נתונים של קישורים ל-Google Drive.

ייצוג ב-JSON 
{
  "driveDataRef": {
    object (DriveDataRef)
  },
  "mimeType": string
}
שדות
driveDataRef

object (DriveDataRef)

‫DriveDataRef שמפנה לקובץ ב-Google Drive.
mimeType

string

סוג ה-MIME של משאב Google Drive המקושר.

ChatSpaceLinkData

נתונים של קישורים למרחבים ב-Chat.

ייצוג ב-JSON 
{
  "space": string,
  "thread": string,
  "message": string
}
שדות
space

string

המרחב של מקור המידע המקושר של המרחב ב-Chat.

פורמט: spaces/{space}
thread

string

השרשור של מקור המידע המקושר במרחב ב-Chat.

פורמט: spaces/{space}/threads/{thread}
message

string

ההודעה של מקור המידע המקושר של המרחב ב-Chat.

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

CustomEmojiMetadata

מטא-נתונים של הערות לסמלי אמוג'י מותאמים אישית.

ייצוג ב-JSON 
{
  "customEmoji": {
    object (CustomEmoji)
  }
}
שדות
customEmoji

object (CustomEmoji)

האמוג'י בהתאמה אישית.

חוט תפירה

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

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

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

string

מזהה. שם המשאב של השרשור.

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

string

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

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

ActionResponse

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

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

enum (ResponseType)

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

string

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

object (DialogAction)

קלט בלבד. תגובה לאירוע אינטראקציה שקשור לתיבת דו-שיח. חייב להיות מלווה ב-ResponseType.Dialog.
updatedWidget

object (UpdatedWidget)

קלט בלבד. התגובה של הווידג'ט המעודכן.

ResponseType

סוג התגובה של אפליקציית 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 מוצגת תיבת דו-שיח.
UPDATE_WIDGET שאילתה של אפשרויות להשלמה אוטומטית של טקסט בווידג'ט.

DialogAction

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

ייצוג ב-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)

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

תיבת דו-שיח

רכיב wrapper מסביב לתוכן של כרטיס תיבת הדו-שיח.

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

object (Card)

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

ActionStatus

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

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

enum (Code)

קוד הסטטוס.
userFacingMessage

string

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

קוד

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

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

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

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

מיפוי HTTP: ‏ 200 OK
CANCELLED

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

מיפוי HTTP: ‏ 499 Client Closed Request
UNKNOWN

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

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

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

מיפוי HTTP: ‏ ‎400 Bad Request
DEADLINE_EXCEEDED

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

מיפוי HTTP: ‏ 504 Gateway Timeout
NOT_FOUND

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

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

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

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

מיפוי HTTP: ‏ 409 Conflict
PERMISSION_DENIED

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

מיפוי HTTP: ‏ 403 Forbidden
UNAUTHENTICATED

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

מיפוי HTTP: ‏ 401 Unauthorized (אין הרשאה)
RESOURCE_EXHAUSTED

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

מיפוי HTTP: ‏ 429 Too Many Requests
FAILED_PRECONDITION

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

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

מיפוי HTTP: ‏ ‎400 Bad Request
ABORTED

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

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

מיפוי HTTP: ‏ 409 Conflict
OUT_OF_RANGE

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

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

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

מיפוי HTTP: ‏ ‎400 Bad Request
UNIMPLEMENTED

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

מיפוי HTTP: ‏ ‎501 Not Implemented
INTERNAL

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

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

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

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

מיפוי HTTP: ‏ 503 Service Unavailable
DATA_LOSS

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

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

UpdatedWidget

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

ייצוג ב-JSON 
{
  "widget": string,

  // Union field updated_widget can be only one of the following:
  "suggestions": {
    object (SelectionItems)
  }
  // End of list of possible types for union field updated_widget.
}
שדות
widget

string

המזהה של הווידג'ט המעודכן. המזהה צריך להיות זהה למזהה של הווידג'ט שהפעיל את בקשת העדכון.
שדה איחוד updated_widget. הווידג'ט עודכן בתגובה לפעולה של משתמש. הערך updated_widget יכול להיות רק אחד מהבאים:
suggestions

object (SelectionItems)

רשימה של תוצאות השלמה אוטומטית של ווידג'טים

SelectionItems

רשימה של תוצאות השלמה אוטומטית של ווידג'טים.

ייצוג ב-JSON 
{
  "items": [
    {
      object (SelectionItem)
    }
  ]
}
שדות
items[]

object (SelectionItem)

מערך של אובייקטים מהטיפוס SelectionItem.

SlashCommand

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

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

string (int64 format)

המזהה של הפקודה דרך שורת הפקודות.

MatchedUrl

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

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

string

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

EmojiReactionSummary

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

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

object (Emoji)

פלט בלבד. האמוג'י שמשויך לתגובות.
reactionCount

integer

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

DeletionMetadata

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

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

enum (DeletionType)

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

DeletionType

מי מחק את ההודעה ואיך היא נמחקה. יכול להיות שנוסיף עוד ערכים בעתיד. לפרטים נוספים על מחיקת הודעות אפשר לעיין במאמר עריכה ומחיקה של הודעות ב-Google Chat.

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

QuotedMessageMetadata

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

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

string

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

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

string (Timestamp format)

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

AttachedGif

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

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

string

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

AccessoryWidget

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

ייצוג ב-JSON 
{

  // Union field action can be only one of the following:
  "buttonList": {
    object (ButtonList)
  }
  // End of list of possible types for union field action.
}
שדות
שדה איחוד action. סוג הפעולה. הערך action יכול להיות רק אחד מהבאים:
buttonList

object (ButtonList)

רשימת לחצנים.

Methods

create

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

delete

 מחיקת הודעה.

get

 מחזירה פרטים על הודעה.

list

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

patch

 עדכון של הודעה.

update

 עדכון של הודעה.