- משאב: Message
- ייצוג ב-JSON
- כרטיס
- CardHeader
- ImageStyle
- Section
- WidgetMarkup
- TextParagraph
- תמונה
- OnClick
- FormAction
- ActionParameter
- OpenLink
- KeyValue
- סמל
- כפתור
- TextButton
- ImageButton
- CardAction
- CardWithId
- כרטיס
- CardHeader
- ImageType
- Section
- ווידג'ט
- TextParagraph
- TextSyntax
- תמונה
- OnClick
- פעולה
- ActionParameter
- LoadIndicator
- אינטראקציה
- OpenLink
- OpenAs
- OnClose
- OverflowMenu
- OverflowMenuItem
- סמל
- MaterialIcon
- DecoratedText
- VerticalAlignment
- כפתור
- צבע
- סוג
- SwitchControl
- ControlType
- ButtonList
- TextInput
- סוג
- הצעות
- SuggestionItem
- אימות
- InputType
- HostAppDataSourceMarkup
- ChatClientDataSourceMarkup
- SpaceDataSource
- WorkflowDataSourceMarkup
- סוג
- SelectionInput
- SelectionType
- SelectionItem
- PlatformDataSource
- CommonDataSource
- DataSourceConfig
- DateTimePicker
- DateTimePickerType
- קו מפריד
- רשת
- GridItem
- ImageComponent
- ImageCropStyle
- ImageCropType
- BorderStyle
- BorderType
- GridItemLayout
- עמודות
- עמודה
- HorizontalSizeStyle
- HorizontalAlignment
- VerticalAlignment
- ווידג'טים
- ChipList
- פריסה
- צ'יפ
- קרוסלה
- CarouselCard
- NestedWidget
- חשיפה
- EventAction
- טריגר
- CommonWidgetAction
- UpdateVisibilityAction
- CollapseControl
- DividerStyle
- CardAction
- CardFixedFooter
- DisplayStyle
- ExpressionData
- מצב
- ExpressionDataCondition
- ConditionType
- הערה
- AnnotationType
- UserMentionMetadata
- סוג
- SlashCommandMetadata
- סוג
- RichLinkMetadata
- RichLinkType
- DriveLinkData
- ChatSpaceLinkData
- MeetSpaceLinkData
- סוג
- HuddleStatus
- CalendarEventLinkData
- CustomEmojiMetadata
- Thread
- ActionResponse
- ResponseType
- DialogAction
- Dialog
- ActionStatus
- Code
- UpdatedWidget
- SelectionItems
- SlashCommand
- MatchedUrl
- EmojiReactionSummary
- DeletionMetadata
- DeletionType
- QuotedMessageMetadata
- QuoteType
- QuotedMessageSnapshot
- ForwardedMetadata
- AttachedGif
- AccessoryWidget
- רכיבים
- CitedSource
- קטע קוד
- ElementsImage
- כותרת תחתונה
- ציטוט
- MarkupSyntax
- Methods
מקור מידע: הודעה
הודעה במרחב ב-Google Chat.
| ייצוג ב-JSON |
|---|
{ "name": string, "sender": { object ( |
| שדות | |
|---|---|
name |
מזהה. שם המשאב של ההודעה. פורמט: כאשר אם מגדירים מזהה מותאם אישית כשיוצרים הודעה, אפשר להשתמש במזהה הזה כדי לציין את ההודעה בבקשה על ידי החלפת |
sender |
פלט בלבד. המשתמש שיצר את ההודעה. אם האפליקציה ל-Chat מאמתת כמשתמש, הפלט מאכלס רק את השדות user |
createTime |
אופציונלי. לא ניתן לשינוי. במרחבים שנוצרו ב-Chat, השעה שבה ההודעה נוצרה. השדה הזה מיועד לפלט בלבד, אלא אם משתמשים בו במרחבים משותפים במצב ייבוא. במרחבים משותפים במצב ייבוא, צריך להגדיר בשדה הזה את חותמת הזמן ההיסטורית שבה ההודעה נוצרה במקור, כדי לשמור על זמן היצירה המקורי. |
lastUpdateTime |
פלט בלבד. השעה שבה המשתמש ערך את ההודעה בפעם האחרונה. אם ההודעה לא נערכה אף פעם, השדה הזה ריק. |
deleteTime |
פלט בלבד. השעה שבה ההודעה נמחקה ב-Google Chat. אם ההודעה לא נמחקת אף פעם, השדה הזה ריק. |
text |
אופציונלי. גוף ההודעה בטקסט פשוט. הקישור הראשון לתמונה, לסרטון או לדף אינטרנט יוצר צ'יפ של תצוגה מקדימה. אתם יכולים גם להשתמש בתיוג@כדי לפנות למשתמש ספציפי ב-Google Chat או לכל מי שבמרחב המשותף. כדי ללמוד איך ליצור הודעות טקסט, קראו את המאמר שליחת הודעה. |
formattedText |
פלט בלבד. מכיל את ההודעה
מידע נוסף זמין במאמר איך רואים את עיצוב הטקסט בהודעות. |
cards[] |
הוצא משימוש: צריך להשתמש ב- כרטיסים עשירים, מעוצבים ואינטראקטיביים שבהם אפשר להציג רכיבים בממשק המשתמש, כמו: טקסטים מעוצבים, כפתורים ותמונות שאפשר ללחוץ עליהן. בדרך כלל הכרטיסים מוצגים מתחת לגוף ההודעה בטקסט פשוט. הגודל המקסימלי של |
cardsV2[] |
אופציונלי. מערך של כרטיסים. אפליקציות צ'אט יכולות ליצור כרטיסים באמצעות אימות אפליקציה. במסגרת תוכנית התצוגה המקדימה למפתחים, אם אפליקציית Chat מאמתת את זהות המשתמש, היא יכולה ליצור הודעות בכרטיסים. אם האפליקציה שלכם ל-Chat לא משתתפת בתוכנית התצוגה המקדימה למפתחים, היא לא יכולה ליצור כרטיסים עם אימות משתמשים. כדי ללמוד איך ליצור הודעה שמכילה כרטיסים, קראו את המאמר שליחת הודעה. לעצב כרטיסים ולראות תצוגה מקדימה שלהם באמצעות הכלי ליצירת כרטיסים. פתיחת הכלי ליצירת כרטיסים |
annotations[] |
פלט בלבד. אפשר לשייך הערות לגוף ההודעה בטקסט פשוט או לצ'יפים שמקשרים למשאבים של Google Workspace, כמו Google Docs או Sheets, עם |
thread |
השרשור שההודעה שייכת אליו. דוגמה לשימוש מופיעה במאמר התחלת שרשור הודעות או מענה להודעה בשרשור. |
space |
פלט בלבד. אם האפליקציה ל-Chat מאומתת כמשתמש, הפלט מאכלס רק את המרחב המשותף |
fallbackText |
אופציונלי. תיאור בטקסט פשוט של הכרטיסים בהודעה, שמשמש כשאי אפשר להציג את הכרטיסים עצמם, למשל בהתראות בנייד. |
actionResponse |
קלט בלבד. פרמטרים שאפליקציית Chat יכולה להשתמש בהם כדי להגדיר איך התשובה שלה תפורסם. |
argumentText |
פלט בלבד. גוף ההודעה בטקסט פשוט, בלי כל האזכורים של אפליקציית הצ'אט. |
slashCommand |
פלט בלבד. מידע על פקודות דרך שורת הפקודות, אם רלוונטי. |
attachment[] |
אופציונלי. קובץ מצורף שהמשתמש העלה. |
matchedUrl |
פלט בלבד. כתובת URL בשדה |
threadReply |
פלט בלבד. כשהערך הוא אם במרחב המשותף אי אפשר לשלוח תשובות בשרשור, הערך בשדה הזה הוא תמיד |
silent |
פלט בלבד. אם זו הודעה שקטה. הודעות שקטות הן הודעות שבהן Chat משתיק את ההתראות לנמענים. |
clientAssignedMessageId |
אופציונלי. מזהה מותאם אישית להודעה. אתם יכולים להשתמש בשדה כדי לזהות הודעה, או כדי לקבל, למחוק או לעדכן הודעה. כדי להגדיר מזהה מותאם אישית, מציינים את השדה |
emojiReactionSummaries[] |
פלט בלבד. רשימת סיכומי התגובות באמוג'י להודעה. |
privateMessageViewer |
אופציונלי. לא ניתן לשינוי. קלט ליצירת הודעה, אחרת פלט בלבד. המשתמש שיכול לראות את ההודעה. אם מגדירים את השדה הזה, ההודעה פרטית ורק המשתמש שצוין והאפליקציה ל-Chat יכולים לראות אותה. כדי לכלול את השדה הזה בבקשה, צריך לשלוח קריאה ל-Chat API באמצעות אימות של האפליקציה ולהשמיט את הפרטים הבאים: פרטים נוספים זמינים במאמר שליחת הודעה פרטית. |
deletionMetadata |
פלט בלבד. מידע על הודעה שנמחקה. ההודעה נמחקת כשמוגדר |
quotedMessageMetadata |
אופציונלי. מידע על הודעה שמצוטטת בהודעה אחרת. כשאתם יוצרים הודעה, אתם יכולים לצטט הודעות מאותו שרשור, או לצטט הודעה ראשית כדי ליצור הודעה ראשית חדשה. עם זאת, אי אפשר לצטט תשובה להודעה משרשור אחר. כשמעדכנים הודעה, אי אפשר להוסיף או להחליף את השדה דוגמה לשימוש מופיעה במאמר ציטוט של הודעה אחרת. |
attachedGifs[] |
פלט בלבד. תמונות בפורמט GIF שמצורפות להודעה. |
accessoryWidgets[] |
אופציונלי. ווידג'ט אינטראקטיבי אחד או יותר שמופיע בתחתית ההודעה. אתם יכולים להוסיף ווידג'טים של אביזרים להודעות שמכילות טקסט, כרטיסים או גם טקסט וגם כרטיסים. לא נתמך בהודעות שמכילות תיבות דו-שיח. פרטים נוספים מופיעים במאמר הוספת ווידג'טים אינטראקטיביים בתחתית ההודעה. כדי ליצור הודעה עם ווידג'טים נלווים, צריך לאמת את האפליקציה. |
elements |
אופציונלי. רכיבים הם חלקים נוספים שנוצרים במהלך יצירת ההודעה, והם יכולים להיות משויכים לחלקים ספציפיים בטקסט של ההודעה. הן שונות מהערות, שהן פלט בלבד ומספקות מידע נוסף שקשור לחלקי הודעה או לטקסט ההודעה כולו. |
markupSyntax |
אופציונלי. מציין איך השרת מפרש את תוכן השדה |
CardWithId
כרטיס בהודעת צ'אט ב-Google Chat.
אפליקציות צ'אט יכולות ליצור כרטיסים באמצעות אימות אפליקציה. במסגרת תוכנית התצוגה המקדימה למפתחים, אם אפליקציית Chat מאמתת את זהות המשתמש, היא יכולה ליצור הודעות בכרטיסים. אם האפליקציה שלכם ל-Chat לא משתתפת בתוכנית התצוגה המקדימה למפתחים, היא לא יכולה ליצור כרטיסים עם אימות משתמשים.
כדי ללמוד איך ליצור הודעה שמכילה כרטיסים, קראו את המאמר שליחת הודעה.
לעצב כרטיסים ולראות תצוגה מקדימה שלהם באמצעות הכלי ליצירת כרטיסים.
פתיחת הכלי ליצירת כרטיסים| ייצוג ב-JSON |
|---|
{ "cardId": string, "card": { object ( |
| שדות | |
|---|---|
cardId |
חובה אם ההודעה מכילה כמה כרטיסים. מזהה ייחודי של כרטיס בהודעה. |
card |
כרטיס. הגודל המקסימלי הוא 32KB. |
ownerUser |
פלט בלבד. האפליקציה שהכרטיס שייך לה. |
הערה
אפשר לשייך הערות לגוף ההודעה בטקסט פשוט או לצ'יפים שמקשרים למשאבים של 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 ( |
| שדות | |
|---|---|
type |
סוג ההערה. |
length |
אורך מחרוזת המשנה בגוף ההודעה בטקסט פשוט שההערה הזו מתאימה לה. אם התג לא קיים, האורך הוא 0. |
startIndex |
אינדקס ההתחלה (מבוסס על 0, כולל) בגוף ההודעה בטקסט פשוט שההערה הזו תואמת לו. |
| מטא-נתונים נוספים על ההערה. זו רשימה של שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
userMention |
המטא-נתונים של התיוג. |
slashCommand |
המטא-נתונים של פקודה דרך שורת הפקודות. |
richLinkMetadata |
המטא-נתונים של קישור עשיר. |
customEmojiMetadata |
המטא-נתונים של אמוג'י בהתאמה אישית. |
| סוף השדות שמוציאים זה את זה. | |
AnnotationType
סוג ההערה.
| טיפוסים בני מנייה (enum) | |
|---|---|
ANNOTATION_TYPE_UNSPECIFIED |
ערך ברירת המחדל של ה-enum. אל תשתמשו בהם. |
USER_MENTION |
משתמש מוזכר. |
SLASH_COMMAND |
מופעלת פקודה דרך שורת הפקודות. |
RICH_LINK |
הערת קישור עשיר. |
CUSTOM_EMOJI |
תיאור של אמוג'י בהתאמה אישית. |
UserMentionMetadata
מטא-נתונים של הערות לתיוגי משתמשים (@).
| ייצוג ב-JSON |
|---|
{ "user": { object ( |
| שדות | |
|---|---|
user |
המשתמש שצוין. |
type |
סוג האזכור של המשתמש. |
סוג
| טיפוסים בני מנייה (enum) | |
|---|---|
TYPE_UNSPECIFIED |
ערך ברירת המחדל של ה-enum. אל תשתמשו בהם. |
ADD |
הוספת משתמש למרחב. |
MENTION |
לתייג משתמשים במרחב. |
SlashCommandMetadata
מטא-נתונים של הערות לפקודות דרך שורת הפקודות (/).
| ייצוג ב-JSON |
|---|
{ "bot": { object ( |
| שדות | |
|---|---|
bot |
האפליקציה ל-Chat שהפקודה שלה הופעלה. |
type |
סוג הפקודה דרך שורת הפקודות. |
commandName |
השם של הפקודה שהופעלה דרך שורת הפקודות. |
commandId |
מזהה הפקודה של הפקודה שהופעלה דרך שורת הפקודות. |
triggersDialog |
מציין אם הפקודה דרך שורת הפקודות מיועדת לתיבת דו-שיח. |
סוג
| טיפוסים בני מנייה (enum) | |
|---|---|
TYPE_UNSPECIFIED |
ערך ברירת המחדל של ה-enum. אל תשתמשו בהם. |
ADD |
הוספת אפליקציית Chat למרחב. |
INVOKE |
להפעיל פקודה דרך שורת הפקודות במרחב המשותף. |
RichLinkMetadata
קישור עשיר למשאב. אפשר לשייך קישורים עשירים לגוף ההודעה בטקסט פשוט, או לייצג צ'יפים שמקשרים למשאבים של Google Workspace כמו Google Docs או Sheets עם startIndex ו-length של 0.
| ייצוג ב-JSON |
|---|
{ "uri": string, "richLinkType": enum ( |
| שדות | |
|---|---|
uri |
ה-URI של הקישור הזה. |
richLinkType |
סוג הקישור העשיר. |
| נתונים של המשאב המקושר. זו רשימה של שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
driveLinkData |
נתונים של קישור ל-Drive. |
chatSpaceLinkData |
נתונים של קישור למרחב ב-Chat. |
meetSpaceLinkData |
נתונים של קישור למרחב ב-Meet. |
calendarEventLinkData |
נתונים של קישור לאירוע ביומן. |
| סוף השדות שמוציאים זה את זה. | |
RichLinkType
סוג הקישור העשיר. יכול להיות שנוסיף עוד סוגים בעתיד.
| טיפוסים בני מנייה (enum) | |
|---|---|
RICH_LINK_TYPE_UNSPECIFIED |
ערך ברירת המחדל של ה-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 |
DriveDataRef שמפנה לקובץ ב-Google Drive. |
mimeType |
סוג ה-MIME של המשאב המקושר ב-Google Drive. |
ChatSpaceLinkData
נתונים של קישורים למרחבים ב-Chat.
| ייצוג ב-JSON |
|---|
{ "space": string, "thread": string, "message": string } |
| שדות | |
|---|---|
space |
המרחב של המשאב המקושר במרחב המשותף ב-Chat. פורמט: |
thread |
השרשור של המשאב המקושר במרחב ב-Chat. פורמט: |
message |
ההודעה של המשאב המקושר במרחב ב-Chat. פורמט: |
MeetSpaceLinkData
נתונים של קישורים למרחבים ב-Meet.
| ייצוג ב-JSON |
|---|
{ "meetingCode": string, "type": enum ( |
| שדות | |
|---|---|
meetingCode |
קוד הפגישה של המרחב המקושר ב-Meet. |
type |
מציין את סוג המרחב ב-Meet. |
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 |
מזהה היומן של היומן המקושר. |
eventId |
מזהה האירוע של אירוע היומן המקושר. |
CustomEmojiMetadata
מטא-נתונים של הערות לאמוג'י בהתאמה אישית.
| ייצוג ב-JSON |
|---|
{
"customEmoji": {
object ( |
| שדות | |
|---|---|
customEmoji |
האמוג'י בהתאמה אישית. |
חוט תפירה
בשרשור במרחב ב-Google Chat. דוגמה לשימוש מופיעה במאמר התחלת שרשור הודעות או מענה להודעה בשרשור.
אם מציינים שרשור כשיוצרים הודעה, אפשר להגדיר את השדה messageReplyOption כדי לקבוע מה יקרה אם לא יימצא שרשור תואם.
| ייצוג ב-JSON |
|---|
{ "name": string, "threadKey": string } |
| שדות | |
|---|---|
name |
מזהה. שם המשאב של השרשור. לדוגמה: |
threadKey |
אופציונלי. קלט ליצירה או לעדכון של שרשור. אחרת, פלט בלבד. מזהה השרשור. אפשר להזין עד 4,000 תווים. המזהה הזה ייחודי לאפליקציה ל-Chat שהגדירה אותו. לדוגמה, אם כמה אפליקציות ל-Chat יוצרות הודעה באמצעות אותו מפתח שרשור, ההודעות מתפרסמות בשרשורים שונים. כדי לענות בשרשור שנוצר על ידי משתמש או אפליקציית Chat אחרת, צריך לציין את השדה |
ActionResponse
פרמטרים שאפליקציית Chat יכולה להשתמש בהם כדי להגדיר איך התשובה שלה תפורסם.
| ייצוג ב-JSON |
|---|
{ "type": enum ( |
| שדות | |
|---|---|
type |
קלט בלבד. סוג התשובה של האפליקציה ל-Chat. |
url |
קלט בלבד. כתובת URL שבה המשתמשים יכולים לבצע אימות או הגדרה. (רק לסוגי התשובות |
dialogAction |
קלט בלבד. תגובה לאירוע אינטראקציה שקשור לתיבת דו-שיח. חייב להיות מלווה ב- |
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 |
קלט בלבד. תיבת דו-שיח לבקשה. |
| סוף השדות שמוציאים זה את זה. | |
Dialog
רכיב wrapper סביב גוף הכרטיס של תיבת הדו-שיח.
| ייצוג ב-JSON |
|---|
{
"body": {
object ( |
| שדות | |
|---|---|
body |
קלט בלבד. גוף תיבת הדו-שיח, שמוצג במודל. אפליקציות ל-Google Chat לא תומכות בישויות הבאות של כרטיסים: |
ActionStatus
מייצג את הסטטוס של בקשה להפעיל או לשלוח תיבת דו-שיח.
| ייצוג ב-JSON |
|---|
{
"statusCode": enum ( |
| שדות | |
|---|---|
statusCode |
קוד הסטטוס. |
userFacingMessage |
ההודעה שתישלח למשתמשים לגבי סטטוס הבקשה שלהם. אם לא מגדירים את ההודעה, נשלחת הודעה כללית שמבוססת על |
קוד
קודי השגיאה הקנוניים של ממשקי 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 |
שגיאה לא ידועה. לדוגמה, השגיאה הזו יכולה להופיע כשערך מיפוי HTTP: 500 שגיאת שרת פנימית |
INVALID_ARGUMENT |
הלקוח ציין ארגומנט לא חוקי. חשוב לשים לב שהמאפיין הזה שונה מ- מיפוי HTTP: 400 Bad Request |
DEADLINE_EXCEEDED |
המועד האחרון חלף לפני שהפעולה הסתיימה. בפעולות שמשנות את מצב המערכת, יכול להיות שהשגיאה הזו תוחזר גם אם הפעולה הושלמה בהצלחה. לדוגמה, יכול להיות שתגובה מוצלחת מהשרת התעכבה מספיק זמן כדי שהמועד האחרון יחלוף. מיפוי HTTP: 504 Gateway Timeout |
NOT_FOUND |
ישות מסוימת שהתבקשה (למשל, קובץ או ספרייה) לא נמצאה. הערה למפתחי שרתים: אם בקשה נדחית עבור קבוצה שלמה של משתמשים, למשל השקה הדרגתית של תכונה או רשימת היתרים לא מתועדת, אפשר להשתמש ב- מיפוי HTTP: שגיאת 404 |
ALREADY_EXISTS |
הישות שהלקוח ניסה ליצור (למשל, קובץ או ספרייה) כבר קיימת. מיפוי HTTP: 409 Conflict |
PERMISSION_DENIED |
למבצע הקריאה אין הרשאה לבצע את הפעולה שצוינה. אסור להשתמש ב- מיפוי HTTP: 403 Forbidden |
UNAUTHENTICATED |
לבקשה אין פרטי כניסה לאימות תקפים לפעולה. מיפוי HTTP: 401 Unauthorized |
RESOURCE_EXHAUSTED |
משאב מסוים מוצה, אולי מכסה לכל משתמש, או אולי נגמר המקום במערכת הקבצים כולה. מיפוי HTTP: 429 Too Many Requests |
FAILED_PRECONDITION |
הפעולה נדחתה כי המערכת לא במצב שנדרש לביצוע הפעולה. לדוגמה, הספרייה שרוצים למחוק לא ריקה, פעולת rmdir מופעלת על משהו שהוא לא ספרייה וכו'. מפתחי שירותים יכולים להשתמש בהנחיות הבאות כדי להחליט בין מיפוי HTTP: 400 Bad Request |
ABORTED |
הפעולה בוטלה, בדרך כלל בגלל בעיה בו-זמנית כמו כשל בבדיקת רצף או ביטול עסקה. בהנחיות שלמעלה מוסבר איך לבחור בין מיפוי HTTP: 409 Conflict |
OUT_OF_RANGE |
הפעולה בוצעה מחוץ לטווח התקין. לדוגמה, חיפוש או קריאה אחרי סוף הקובץ. בניגוד ל- יש חפיפה מסוימת בין מיפוי HTTP: 400 Bad Request |
UNIMPLEMENTED |
הפעולה לא מוטמעת או לא נתמכת/מופעלת בשירות הזה. מיפוי HTTP: 501 Not Implemented |
INTERNAL |
שגיאות פנימיות. המשמעות היא שחלק מהקבועים שהמערכת הבסיסית מצפה להם הופרו. קוד השגיאה הזה שמור לשגיאות חמורות. מיפוי HTTP: 500 שגיאת שרת פנימית |
UNAVAILABLE |
השירות הזה לא זמין כרגע. בדרך כלל מדובר במצב זמני, ואפשר לפתור אותו על ידי ניסיון חוזר עם השהיה. חשוב לזכור שלא תמיד בטוח לנסות שוב פעולות שהן לא אידמפוטנטיות. בהנחיות שלמעלה מוסבר איך לבחור בין מיפוי HTTP: 503 Service Unavailable |
DATA_LOSS |
אובדן נתונים או פגיעה בנתונים שלא ניתן לשחזר. מיפוי HTTP: 500 שגיאת שרת פנימית |
UpdatedWidget
בווידג'טים מסוג selectionInput, הפונקציה מחזירה הצעות של ההשלמה האוטומטית לתפריט עם אפשרות לבחירת כמה פריטים.
| ייצוג ב-JSON |
|---|
{
"widget": string,
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"suggestions": {
object ( |
| שדות | |
|---|---|
widget |
המזהה של הווידג'ט שעודכן. המזהה חייב להיות זהה למזהה של הווידג'ט שהפעיל את בקשת העדכון. |
| הווידג'ט עודכן בתגובה לפעולה של המשתמש. זו רשימה של שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
suggestions |
רשימת תוצאות של השלמה אוטומטית של ווידג'טים |
| סוף השדות שמוציאים זה את זה. | |
SelectionItems
רשימת תוצאות של השלמה אוטומטית של ווידג'ט.
| ייצוג ב-JSON |
|---|
{
"items": [
{
object ( |
| שדות | |
|---|---|
items[] |
מערך של אובייקטי SelectionItem. |
SlashCommand
מטא-נתונים על פקודה דרך שורת הפקודות ב-Google Chat.
| ייצוג ב-JSON |
|---|
{ "commandId": string } |
| שדות | |
|---|---|
commandId |
המזהה של הפקודה דרך שורת הפקודות. |
MatchedUrl
כתובת URL תואמת בהודעת צ'אט. אפליקציות צ'אט יכולות להציג תצוגה מקדימה של כתובות URL תואמות. מידע נוסף זמין במאמר תצוגה מקדימה של קישורים.
| ייצוג ב-JSON |
|---|
{ "url": string } |
| שדות | |
|---|---|
url |
פלט בלבד. כתובת ה-URL שהותאמה. |
EmojiReactionSummary
מספר האנשים שהגיבו להודעה באמצעות אמוג'י ספציפי.
| ייצוג ב-JSON |
|---|
{
"emoji": {
object ( |
| שדות | |
|---|---|
emoji |
פלט בלבד. אמוג'י שמשויך לתגובות. |
reactionCount |
פלט בלבד. המספר הכולל של התגובות באמצעות האמוג'י המשויך. |
DeletionMetadata
מידע על הודעה שנמחקה. ההודעה נמחקת כשמוגדר deleteTime.
| ייצוג ב-JSON |
|---|
{
"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 ( |
| שדות | |
|---|---|
name |
חובה. שם המשאב של ההודעה המצוטטת. פורמט: |
lastUpdateTime |
חובה. חותמת הזמן של מועד היצירה או העדכון האחרון של ההודעה המצוטטת. אם ההודעה נערכה, משתמשים בשדה הזה, אם הערך של |
quoteType |
אופציונלי. מציין את סוג הציטוט. אם לא מוגדר, ברירת המחדל היא REPLY בנתיב הקריאה/כתיבה של ההודעה לצורך תאימות לדורות קודמים. |
quotedMessageSnapshot |
פלט בלבד. תמונת מצב של תוכן ההודעה המצוטטת. |
forwardedMetadata |
פלט בלבד. מטא-נתונים על המרחב המשותף שממנו צוטטה ההודעה. השדה הזה מאוכלס רק בסוג הצעת המחיר FORWARD. |
QuoteType
סוג הציטוט של ההודעה המצוטטת.
| טיפוסים בני מנייה (enum) | |
|---|---|
QUOTE_TYPE_UNSPECIFIED |
שמורות. הערך הזה לא בשימוש. |
REPLY |
כשההגדרה
|
FORWARD |
כשהערך של
|
QuotedMessageSnapshot
מציגה תמונת מצב של תוכן ההודעה המצוטטת בזמן הציטוט או ההעברה
| ייצוג ב-JSON |
|---|
{ "sender": string, "text": string, "formattedText": string, "annotations": [ { object ( |
| שדות | |
|---|---|
sender |
פלט בלבד. שם המחבר של ההודעה המצוטטת. מאוכלס גם בסוגי הציטוטים REPLY וגם ב-FORWARD. |
text |
פלט בלבד. תמונת מצב של תוכן הטקסט של ההודעה המצוטטת. |
formattedText |
פלט בלבד. מכיל את ההודעה המצוטטת |
annotations[] |
פלט בלבד. הערות שנותחו מגוף הטקסט של ההודעה המצוטטת. השדה הזה מאוכלס רק בסוג הצעת המחיר FORWARD. |
attachments[] |
פלט בלבד. קבצים שצורפו להודעה המצוטטת. אלה עותקים של המטא-נתונים של הקבצים המצורפים להודעה המצוטטת. השדה הזה מאוכלס רק בסוג הצעת המחיר FORWARD. |
ForwardedMetadata
מטא-נתונים על המרחב המקורי שממנו ההודעה הועברה.
| ייצוג ב-JSON |
|---|
{ "space": string, "spaceDisplayName": string } |
| שדות | |
|---|---|
space |
פלט בלבד. שם המשאב של המרחב המשותף המקורי. פורמט: spaces/{space} |
spaceDisplayName |
פלט בלבד. השם המוצג של המרחב המשותף או הצ'אט האישי שממנו הועברה ההודעה, בזמן ההעברה. ב- |
AttachedGif
תמונת GIF שצוינה באמצעות כתובת URL.
| ייצוג ב-JSON |
|---|
{ "uri": string } |
| שדות | |
|---|---|
uri |
פלט בלבד. כתובת ה-URL שבה מתארחת תמונת ה-GIF. |
AccessoryWidget
ווידג'ט אינטראקטיבי אחד או יותר שמופיע בתחתית ההודעה. פרטים נוספים מופיעים במאמר הוספת ווידג'טים אינטראקטיביים בתחתית ההודעה.
| ייצוג ב-JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"buttonList": {
object ( |
| שדות | |
|---|---|
| סוג הפעולה. זו רשימה של שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
buttonList |
רשימה של כפתורים. |
| סוף השדות שמוציאים זה את זה. | |
רכיבים
| ייצוג ב-JSON |
|---|
{ "citedSources": [ { object ( |
| שדות | |
|---|---|
citedSources[] |
רשימה של מקורות שיוצגו מתחת להודעה כקישורים בכותרת התחתונה. הן לא מוזכרות בתוך הטקסט. להפניות בתוך השורה, צריך להשתמש ב- |
citations[] |
רשימה של ציטוטים בגוף הטקסט שמופיעים בטקסט של ההודעה (באמצעות תגי |
CitedSource
| ייצוג ב-JSON |
|---|
{ "title": string, "uri": string, "snippet": { object ( |
| שדות | |
|---|---|
title |
חובה. הכותרת בטקסט פשוט של |
uri |
חובה. ה-URI שמפנה למשאב שאליו מפנה ה- |
snippet |
אופציונלי. תקציר שמכיל מידע ישירות מהמקור. |
footer |
אופציונלי. מידע נוסף שמוצג לצד התקציר בכותרת תחתונה. |
קטע טקסט
| ייצוג ב-JSON |
|---|
{
"text": string,
"imagePreview": {
object ( |
| שדות | |
|---|---|
text |
אופציונלי. קטע קצר בטקסט פשוט ישירות מהקורפוס, שעשוי להופיע ב-Chat. אין תמיכה בפורמט Markdown. |
imagePreview |
אופציונלי. תצוגה מקדימה של התמונה של קטע הטקסט שסופק כקלט כשנוצר הציטוט. |
ElementsImage
| ייצוג ב-JSON |
|---|
{ "imageUri": string } |
| שדות | |
|---|---|
| חובה. אחד מהייצוגים הנתמכים של התמונה. זו רשימה של שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
imageUri |
חובה. כתובת URI של תמונה שנגישה לכולם. |
| סוף השדות שמוציאים זה את זה. | |
ציטוט ביבליוגרפי
<chat-citation data-id="{id}">{text}</chat-citation>. אפשר להוסיף ציטוטים רק אם הערך של markupSyntax בהודעה הוא MARKDOWN.המערכת מתעלמת מציטוטים ללא הפניה ב-Elements.citations (ציטוטים ללא תג <chat-citation> תואם בטקסט של ההודעה), והם לא גורמים לדחיית ההודעה.
| ייצוג ב-JSON |
|---|
{
"id": string,
"citedSources": [
{
object ( |
| שדות | |
|---|---|
id |
חובה. מזהה שמוגדר באפליקציה. הוא צריך להכיל רק אותיות ומספרים ב-ASCII, ופחות מ-63 תווים. |
citedSources[] |
אופציונלי. רשימה של מקורות שרלוונטיים לציטוט. המקורות מוצגים בכרטיס שמופיע כשמציבים את הסמן מעל הציטוט. |
MarkupSyntax
מציין את תחביר התגיות שמשמש לעיצוב הטקסט של הודעת הצ'אט. רלוונטי לשדה text של המשאב Message.
| טיפוסים בני מנייה (enum) | |
|---|---|
MARKUP_SYNTAX_UNSPECIFIED |
מייצג את הערך שלא צוין. |
MARKUP_SYNTAX_CHAT |
משתמש בתחביר של תגי עיצוב ב-Google Chat. מידע נוסף זמין בכתובת https://developers.google.com/workspace/chat/format-messages#format-texts. |
MARKUP_SYNTAX_MARKDOWN |
משתמש בתחביר Markdown. התחביר הזה מבוסס על המפרט של CommonMark, עם תוספות. מידע נוסף זמין בכתובת https://developers.google.com/workspace/chat/format-messages#format-texts. |
Methods |
|
|---|---|
|
יצירת הודעה במרחב ב-Google Chat. |
|
מחיקת הודעה. |
|
מחזירה פרטים על הודעה. |
|
מציגה רשימה של הודעות במרחב שהמתקשר חבר בו, כולל הודעות מחברים ומרחבים חסומים. |
|
מעדכן הודעה. |
|
מחליף את הכרטיסים שכלולים בהודעה. |
|
חיפוש הודעות ב-Google Chat שלמשתמש שמתקשר יש גישה אליהן. |
|
מעדכן הודעה. |