- משאב: Message
- ייצוג ב-JSON
- Card
- CardHeader
- ImageStyle
- Section
- WidgetMarkup
- TextParagraph
- Image
- OnClick
- FormAction
- ActionParameter
- OpenLink
- KeyValue
- סמל
- Button
- TextButton
- ImageButton
- CardAction
- CardWithId
- Card
- CardHeader
- ImageType
- Section
- ווידג'ט
- TextParagraph
- TextSyntax
- Image
- OnClick
- פעולה
- ActionParameter
- LoadIndicator
- אינטראקציה
- OpenLink
- OpenAs
- OnClose
- OverflowMenu
- OverflowMenuItem
- סמל
- MaterialIcon
- DecoratedText
- VerticalAlignment
- Button
- צבע
- סוג
- 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
- פריסה
- Chip
- קרוסלה
- CarouselCard
- NestedWidget
- חשיפה
- EventAction
- Trigger
- 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
- Snippet
- ElementsImage
- Footer
- ציטוט
- 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 בשדה ההודעה ב-Chat |
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. |
הערה
אפשר לשייך את ההערות לגוף ההודעה בטקסט פשוט או לצ'יפים שמקשרים למשאבי 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 |
שיחת ה-Huddle לא נענתה. במקרה כזה, מזהה ה-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 |
ההודעה שתישלח למשתמשים לגבי סטטוס הבקשה שלהם. אם לא מוגדרת הודעה, נשלחת הודעה גנרית על סמך |
קוד
קודי השגיאה הקנוניים של gRPC APIs.
לפעמים יכולים להיות כמה קודי שגיאה רלוונטיים. השירותים צריכים להחזיר את קוד השגיאה הספציפי ביותר שרלוונטי. לדוגמה, אם שני הקודים חלים, המערכת תעדיף את OUT_OF_RANGE על פני FAILED_PRECONDITION. באופן דומה, מעדיפים את NOT_FOUND או ALREADY_EXISTS על פני FAILED_PRECONDITION.
| טיפוסים בני מנייה (enum) | |
|---|---|
OK |
זו לא שגיאה, הערך הזה מוחזר אם הפעולה הצליחה. מיפוי HTTP: 200 OK |
CANCELLED |
הפעולה בוטלה, בדרך כלל על ידי המתקשר. מיפוי HTTP: 499 בקשה נסגרה על ידי הלקוח |
UNKNOWN |
שגיאה לא ידועה. לדוגמה, השגיאה הזו יכולה לחזור כשערך מיפוי HTTP: 500 שגיאת שרת פנימית |
INVALID_ARGUMENT |
הלקוח ציין ארגומנט לא תקין. שימו לב שהערך הזה שונה מ- מיפוי HTTP: 400 בקשה לא תקינה |
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 בקשה לא תקינה |
ABORTED |
הפעולה בוטלה, בדרך כלל בגלל בעיה של בו-זמניות (concurrency), כמו כשל בבדיקת רצף או ביטול טרנזקציה. בהנחיות שלמעלה מוסבר איך קובעים מהו השיוך המתאים ביותר מבין מיפוי HTTP: 409 Conflict |
OUT_OF_RANGE |
הניסיון לבצע את הפעולה היה מחוץ לטווח התקין. לדוגמה, ניסיון להגיע למיקום מסוים או לקרוא אחרי סוף הקובץ. בניגוד לשגיאה יש חפיפה משמעותית בין מיפוי HTTP: 400 בקשה לא תקינה |
UNIMPLEMENTED |
הפעולה לא מיושמת או לא אפשרית/מופעלת בשירות הזה. מיפוי HTTP: 501 Not Implemented |
INTERNAL |
שגיאות פנימיות. המשמעות היא שחלק מהאינווריאנטים שהמערכת הבסיסית מצפה להם נשברו. קוד השגיאה הזה שמור לשגיאות חמורות. מיפוי HTTP: 500 שגיאת שרת פנימית |
UNAVAILABLE |
השירות הזה לא זמין כרגע. כנראה שמדובר במצב זמני, שאפשר לתקן אותו באמצעות ניסיון חוזר עם השהיה. חשוב לזכור שלא תמיד בטוח לנסות שוב פעולות שהן לא אידמפוטנטיות. בהנחיות שלמעלה מוסבר איך קובעים מהו השיוך המתאים ביותר מבין מיפוי HTTP: 503 השירות לא זמין |
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 תואמת בהודעת צ'אט. אפליקציות ל-Chat יכולות להציג תצוגה מקדימה של כתובות 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 שהמשתמש המתקשר יכול לגשת אליהן. |
|
עדכון הודעה. |