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 עם סימנים שנוספו כדי לציין את העיצוב. יכול להיות שהשדה הזה לא יתעד את כל הפורמטים שגלויים בממשק המשתמש, אבל הוא כולל את הפריטים הבאים:

  • תחביר של סימון לטקסט מודגש, נטוי, מחוק, מודפס בגופן monospace, מודפס בגופן monospace בבלוק ורשימת תבליטים.

  • אזכורים של משתמשים בפורמט <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)
  }
  // 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)

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

AnnotationType

סוג ההערה.

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

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

השם של פקודת ה-slash שהופעל.
commandId

string (int64 format)

מזהה הפקודה של פקודת ה-slash שהופעל.
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}

שרשור

שרשור במרחב משותף ב-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)

קלט בלבד. Dialog של הבקשה.

תיבת דו-שיח

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

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

object (Card)

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

ActionStatus

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

ייצוג ב-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 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 ביט תיצור את הערך INVALID_ARGUMENT אם תתבקשו לקרוא ב-offset שלא נמצא בטווח [0,2^32-1], אבל היא תיצור את הערך OUT_OF_RANGE אם תתבקשו לקרוא מ-offset שמעבר לגודל הקובץ הנוכחי.

יש חפיפה רבה בין 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)

המזהה של פקודת ה-slash שהופעל.

MatchedUrl

כתובת URL תואמת בהודעה ב-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

 עדכון הודעה.