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

  • תחביר תגי עיצוב לטקסט מודגש, נטוי, קו חוצה, Unicode, בלוק Unicode ורשימה עם תבליטים.

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

עיצוב כרטיסים בתצוגה מקדימה בעזרת הכלי ליצירת כרטיסים.

לפתיחת הכלי ליצירת כרטיסים

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

השם של פקודת הלוכסן שהופעלה.
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}

שרשור

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

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

תיבת דו-שיח

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

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

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

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

מיפוי HTTP: 409 Conflict
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 Bad Request
UNIMPLEMENTED

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

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

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

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

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

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

מיפוי HTTP: 503 Service Unavailable
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)

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

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

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

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

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

 עדכון הודעה.