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,
  "silent": boolean,
  "clientAssignedMessageId": string,
  "emojiReactionSummaries": [
    {
      object (EmojiReactionSummary)
    }
  ],
  "privateMessageViewer": {
    object (User)
  },
  "deletionMetadata": {
    object (DeletionMetadata)
  },
  "quotedMessageMetadata": {
    object (QuotedMessageMetadata)
  },
  "attachedGifs": [
    {
      object (AttachedGif)
    }
  ],
  "accessoryWidgets": [
    {
      object (AccessoryWidget)
    }
  ],
  "elements": {
    object (Elements)
  },
  "markupSyntax": enum (MarkupSyntax)
}
שדות
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 מאמתת כמשתמש, הפלט מאכלס רק את השדות user name ו-type גם למשתמשים פנימיים וגם למשתמשים חיצוניים, אלא אם הם חברים במרחב או שיש להם זיקה קודמת, כמו שיחה בצ'אט ישיר (DM), עם המשתמש המתקשר.
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 לאמוג'י של פרצוף מחייך.

  • רשימת תבליטים באמצעות כוכביות (*) – לדוגמה, * item.

מידע נוסף זמין במאמר איך רואים את עיצוב הטקסט בהודעות.
cards[]
(deprecated)

object (Card)

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

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

object (CardWithId)

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

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

במאמר שליחת הודעה מוסבר איך יוצרים הודעה שמכילה כרטיסים.

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

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

object (Annotation)

פלט בלבד. אפשר לשייך הערות לגוף ההודעה בטקסט פשוט או לצ'יפים שמקשרים למשאבים של Google Workspace, כמו Google Docs או Sheets, עם startIndex ו-length של 0.
thread

object (Thread)

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

object (Space)

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

string

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

object (ActionResponse)

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

string

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

object (SlashCommand)

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

object (Attachment)

זה שינוי אופציונלי. קובץ מצורף שהמשתמש העלה.
matchedUrl

object (MatchedUrl)

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

boolean

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

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

boolean

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

string

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

object (EmojiReactionSummary)

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

object (User)

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

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

object (DeletionMetadata)

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

object (QuotedMessageMetadata)

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

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

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

דוגמה לשימוש מופיעה במאמר ציטוט של הודעה אחרת.
attachedGifs[]

object (AttachedGif)

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

object (AccessoryWidget)

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

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

object (Elements)

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

markupSyntax

enum (MarkupSyntax)

זה שינוי אופציונלי. מציין איך השרת מפרש את תוכן השדה text של ההודעה כשיוצרים הודעה או מעדכנים את השדה text של הודעה.

כששולחים קריאה ל-UpdateMessage, צריך להגדיר את markupSyntax ואת text במשאב Message ולכלול את text (ולא את markupSyntax) ב-updateMask.

הערה

אפשר לשייך הערות לגוף ההודעה בטקסט פשוט או לצ'יפים שמקשרים למשאבים של Google Workspace, כמו Google Docs או Sheets, עם startIndex ו-length של 0. כדי להוסיף עיצוב בסיסי להודעת טקסט, אפשר לעיין במאמר עיצוב הודעות טקסט.

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

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,

  "userMention": {
    object (UserMentionMetadata)
  },
  "slashCommand": {
    object (SlashCommandMetadata)
  },
  "richLinkMetadata": {
    object (RichLinkMetadata)
  },
  "customEmojiMetadata": {
    object (CustomEmojiMetadata)
  }
}
שדות
type

enum (AnnotationType)

סוג ההערה.
length

integer

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

integer

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

קישור עשיר למשאב. אפשר לשייך קישורים עשירים לגוף ההודעה בטקסט פשוט, או לייצג צ'יפים שמקשרים למשאבים של Google Workspace כמו Google Docs או Sheets עם startIndex ו-length של 0.

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

  "driveLinkData": {
    object (DriveLinkData)
  },
  "chatSpaceLinkData": {
    object (ChatSpaceLinkData)
  },
  "meetSpaceLinkData": {
    object (MeetSpaceLinkData)
  },
  "calendarEventLinkData": {
    object (CalendarEventLinkData)
  }
}
שדות
uri

string

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

RichLinkType

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

טיפוסים בני מנייה (enum)
DRIVE_FILE סוג של קישור עשיר ב-Google Drive.
CHAT_SPACE סוג של קישור עשיר למרחב ב-Chat. לדוגמה, צ'יפ חכם של מרחב משותף.
GMAIL_MESSAGE סוג קישור עשיר להודעה ב-Gmail. ספציפית, צ'יפ של Gmail משיתוף ב-Chat. ה-API תומך רק בקריאת הודעות עם קישורים עשירים מסוג GMAIL_MESSAGE.
MEET_SPACE סוג קישור עשיר להודעה ב-Meet. לדוגמה, צ'יפ של Meet.
CALENDAR_EVENT סוג קישור עשיר להודעה ביומן. לדוגמה, צ'יפ של יומן Google.

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}

MeetSpaceLinkData

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

ייצוג ב-JSON 
{
  "meetingCode": string,
  "type": enum (Type),
  "huddleStatus": enum (HuddleStatus)
}
שדות
meetingCode

string

קוד הפגישה של המרחב המקושר ב-Meet.
type

enum (Type)

מציין את סוג המרחב ב-Meet.
huddleStatus

enum (HuddleStatus)

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

סוג

סוג המרחב ב-Meet.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED ערך ברירת המחדל של ה-enum. אל תשתמשו בהם.
MEETING המרחב ב-Meet הוא פגישה.
HUDDLE המרחב ב-Meet הוא שיחה מהירה.

HuddleStatus

סטטוס השיחה

טיפוסים בני מנייה (enum)
HUDDLE_STATUS_UNSPECIFIED ערך ברירת המחדל של ה-enum. אל תשתמשו בהם.
STARTED השיחה המהירה התחילה.
ENDED השיחה המהירה הסתיימה. במקרה כזה, המזהים וה-URI של המרחב ב-Meet לא יהיו תקפים יותר.
MISSED השיחה לא נענתה. במקרה כזה, המזהים וה-URI של המרחב ב-Meet לא יהיו תקפים יותר.

CalendarEventLinkData

נתונים של קישורים לאירועים ביומן.

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

string

מזהה היומן של היומן המקושר.
eventId

string

מזהה האירוע של אירוע היומן המקושר.

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)
  },

  "dialog": {
    object (Dialog)
  }
}
שדות
actionStatus

object (ActionStatus)

קלט בלבד. סטטוס של בקשה להפעיל או לשלוח תיבת דו-שיח. הצגת סטטוס והודעה למשתמשים, במקרה הצורך. לדוגמה, במקרה של שגיאה או הצלחה.
הפעולה שצריך לבצע. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
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 הזמן שהוקצב לשער חלף
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 אם הלקוח צריך לנסות שוב ברמה גבוהה יותר. לדוגמה, כשפעולת test-and-set שצוינה על ידי הלקוח נכשלת, זה מצביע על כך שהלקוח צריך להפעיל מחדש רצף של read-modify-write. (ג) משתמשים ב-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 אם תתבקש לקרוא בהיסט שלא נמצא בטווח [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

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

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

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

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

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

UpdatedWidget

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

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

  "suggestions": {
    object (SelectionItems)
  }
}
שדות
widget

string

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

object (SelectionItems)

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

SelectionItems

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

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

object (SelectionItem)

מערך של אובייקטי SelectionItem.

SlashCommand

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

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

string (int64 format)

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

MatchedUrl

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

מידע על הודעה שמצוטטת בהודעה אחרת.

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

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

ייצוג ב-JSON 
{
  "name": string,
  "lastUpdateTime": string,
  "quoteType": enum (QuoteType),
  "quotedMessageSnapshot": {
    object (QuotedMessageSnapshot)
  },
  "forwardedMetadata": {
    object (ForwardedMetadata)
  }
}
שדות
name

string

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

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

string (Timestamp format)

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

אם ההודעה נערכה, משתמשים בשדה הזה, lastUpdateTime. אם ההודעה לא נערכה אף פעם, משתמשים ב-createTime.

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

enum (QuoteType)

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

object (QuotedMessageSnapshot)

פלט בלבד. תמונת מצב של תוכן ההודעה המצוטטת.
forwardedMetadata

object (ForwardedMetadata)

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

QuoteType

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

טיפוסים בני מנייה (enum)
QUOTE_TYPE_UNSPECIFIED שמורות. הערך הזה לא בשימוש.
REPLY

כשההגדרה quoteType היא REPLY, אפשר לבצע את הפעולות הבאות:

  • אם אתם עונים בשרשור, אתם יכולים לצטט הודעה אחרת מאותו שרשור.

  • אם אתם יוצרים הודעה ראשית, אתם יכולים לצטט הודעה ראשית אחרת באותו מרחב.
FORWARD

כשההגדרה quoteType היא FORWARD, אפשר לצטט:

  • הודעה ממרחב אחר.

  • תשובה להודעה משרשור אחר באותו מרחב משותף.

QuotedMessageSnapshot

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

ייצוג ב-JSON 
{
  "sender": string,
  "text": string,
  "formattedText": string,
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "attachments": [
    {
      object (Attachment)
    }
  ]
}
שדות
sender

string

פלט בלבד. שם המחבר של ההודעה המצוטטת. מאוכלס גם בסוגי הציטוטים REPLY וגם ב-FORWARD.
text

string

פלט בלבד. תמונת מצב של תוכן הטקסט של ההודעה המצוטטת.
formattedText

string

פלט בלבד. מכיל את ההודעה המצוטטת text עם תגי עיצוב שנוספו כדי לתמוך בעיצוב עשיר כמו היפר-קישורים, אמוג'י בהתאמה אישית, תגי עיצוב וכו'. מאוכלס רק עבור סוג הציטוט FORWARD.
annotations[]

object (Annotation)

פלט בלבד. הערות שנותחו מגוף הטקסט של ההודעה המצוטטת. השדה הזה מאוכלס רק בסוג הצעת המחיר FORWARD.
attachments[]

object (Attachment)

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

ForwardedMetadata

מטא-נתונים על המרחב המקורי שממנו ההודעה הועברה.

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

string

פלט בלבד. שם המשאב של המרחב המשותף המקורי. פורמט: spaces/{space}
spaceDisplayName

string

פלט בלבד. השם המוצג של המרחב המשותף או הצ'אט האישי שממנו הועברה ההודעה, בזמן ההעברה. ב-SPACE, זה השם של המרחב. ב-DIRECT_MESSAGE, זה השם של המשתתף השני (למשל, "משתמש א'"). ב-GROUP_CHAT, השם נוצר באופן אוטומטי על סמך השמות הפרטיים של המשתתפים, עד 5 משתתפים כולל היוצר (למשל, "משתמש א', משתמש ב'").

AttachedGif

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

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

string

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

רכיבים

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

ייצוג ב-JSON 
{
  "citedSources": [
    {
      object (CitedSource)
    }
  ],
  "citations": [
    {
      object (Citation)
    }
  ]
}
שדות
citedSources[]

object (CitedSource)

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

object (Citation)

רשימה של ציטוטים בגוף הטקסט שמופיעים בטקסט של ההודעה (באמצעות תגי <chat-citation>) ומוצגים ככרטיסים אינטראקטיביים כשמעבירים מעליהם את העכבר.

Methods

create

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

delete

 מחיקת הודעה.

get

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

list

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

patch

 עדכון הודעה.

replaceCards

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

update

 עדכון הודעה.