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

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

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

מידע נוסף מופיע במאמר שליחת הודעות פרטיות למשתמשי Google Chat.
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

סוג ההערה.

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

UserMentionMetadata

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

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

object (User)

המשתמש הזכיר אותך.
type

enum (Type)

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

סוג

טיפוסים בני מנייה (enums)
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

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

סוג

טיפוסים בני מנייה (enums)
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)
  }
  // End of list of possible types for union field data.
}
שדות
uri

string

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

RichLinkType

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

טיפוסים בני מנייה (enums)
DRIVE_FILE סוג קישור עשיר ב-Google Drive.

DriveLinkData

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

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

object (DriveDataRef)

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

string

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

פרוטוקול Thread

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

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

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

string

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

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

string

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

המזהה הזה ייחודי לאפליקציית 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.

טיפוסים בני מנייה (enums)
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)

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

תיבת דו-שיח

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

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

טיפוסים בני מנייה (enums)
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 Mapping: 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

UpdatedWidget

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

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

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

טיפוסים בני מנייה (enums)
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)

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

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)

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

שיטות

create

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

delete

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

get

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

list

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

patch

 מעדכן הודעה.

update

 מעדכן הודעה.