אינדקס
ChatService
(ממשק)AccessoryWidget
(הודעה)ActionResponse
(הודעה)ActionResponse.ResponseType
(טיפוס טיפוסים בני מנייה (enum))ActionResponse.SelectionItems
(הודעה)ActionResponse.UpdatedWidget
(הודעה)ActionStatus
(הודעה)Annotation
(הודעה)AnnotationType
(טיפוס טיפוסים בני מנייה (enum))AttachedGif
(הודעה)Attachment
(הודעה)Attachment.Source
(טיפוס טיפוסים בני מנייה (enum))AttachmentDataRef
(הודעה)CardWithId
(הודעה)ChatSpaceLinkData
(הודעה)CompleteImportSpaceRequest
(הודעה)CompleteImportSpaceResponse
(הודעה)ContextualAddOnMarkup
(הודעה)ContextualAddOnMarkup.Card
(הודעה)ContextualAddOnMarkup.Card.CardAction
(הודעה)ContextualAddOnMarkup.Card.CardHeader
(הודעה)ContextualAddOnMarkup.Card.CardHeader.ImageStyle
(טיפוס טיפוסים בני מנייה (enum))ContextualAddOnMarkup.Card.Section
(הודעה)CreateMembershipRequest
(הודעה)CreateMessageRequest
(הודעה)CreateMessageRequest.MessageReplyOption
(טיפוס טיפוסים בני מנייה (enum))CreateReactionRequest
(הודעה)CreateSpaceRequest
(הודעה)CustomEmoji
(הודעה)DeleteMembershipRequest
(הודעה)DeleteMessageRequest
(הודעה)DeleteReactionRequest
(הודעה)DeleteSpaceRequest
(הודעה)DeletionMetadata
(הודעה)DeletionMetadata.DeletionType
(enum)Dialog
(הודעה)DialogAction
(הודעה)DriveDataRef
(הודעה)DriveLinkData
(הודעה)Emoji
(הודעה)EmojiReactionSummary
(הודעה)FindDirectMessageRequest
(הודעה)GetAttachmentRequest
(הודעה)GetMembershipRequest
(הודעה)GetMessageRequest
(הודעה)GetSpaceEventRequest
(הודעה)GetSpaceReadStateRequest
(הודעה)GetSpaceRequest
(הודעה)GetThreadReadStateRequest
(הודעה)Group
(הודעה)HistoryState
(טיפוס טיפוסים בני מנייה (enum))ListMembershipsRequest
(הודעה)ListMembershipsResponse
(הודעה)ListMessagesRequest
(הודעה)ListMessagesResponse
(הודעה)ListReactionsRequest
(הודעה)ListReactionsResponse
(הודעה)ListSpaceEventsRequest
(הודעה)ListSpaceEventsResponse
(הודעה)ListSpacesRequest
(הודעה)ListSpacesResponse
(הודעה)MatchedUrl
(הודעה)Membership
(הודעה)Membership.MembershipRole
(טיפוס טיפוסים בני מנייה (enum))Membership.MembershipState
(טיפוס טיפוסים בני מנייה (enum))MembershipBatchCreatedEventData
(הודעה)MembershipBatchDeletedEventData
(הודעה)MembershipBatchUpdatedEventData
(הודעה)MembershipCreatedEventData
(הודעה)MembershipDeletedEventData
(הודעה)MembershipUpdatedEventData
(הודעה)Message
(הודעה)MessageBatchCreatedEventData
(הודעה)MessageBatchDeletedEventData
(הודעה)MessageBatchUpdatedEventData
(הודעה)MessageCreatedEventData
(הודעה)MessageDeletedEventData
(הודעה)MessageUpdatedEventData
(הודעה)QuotedMessageMetadata
(הודעה)Reaction
(הודעה)ReactionBatchCreatedEventData
(הודעה)ReactionBatchDeletedEventData
(הודעה)ReactionCreatedEventData
(הודעה)ReactionDeletedEventData
(הודעה)RichLinkMetadata
(הודעה)RichLinkMetadata.RichLinkType
(טיפוס טיפוסים בני מנייה (enum))SearchSpacesRequest
(הודעה)SearchSpacesResponse
(הודעה)SetUpSpaceRequest
(הודעה)SlashCommand
(הודעה)SlashCommandMetadata
(הודעה)SlashCommandMetadata.Type
(טיפוס טיפוסים בני מנייה (enum))Space
(הודעה)Space.AccessSettings
(הודעה)Space.AccessSettings.AccessState
(טיפוס טיפוסים בני מנייה (enum))Space.MembershipCount
(הודעה)Space.PermissionSetting
(הודעה)Space.PermissionSettings
(הודעה)Space.PredefinedPermissionSettings
(טיפוס טיפוסים בני מנייה (enum))Space.SpaceDetails
(הודעה)Space.SpaceThreadingState
(טיפוס טיפוסים בני מנייה (enum))Space.SpaceType
(טיפוס טיפוסים בני מנייה (enum))Space.Type
(טיפוס טיפוסים בני מנייה (enum))SpaceBatchUpdatedEventData
(הודעה)SpaceEvent
(הודעה)SpaceReadState
(הודעה)SpaceUpdatedEventData
(הודעה)Thread
(הודעה)ThreadReadState
(הודעה)UpdateMembershipRequest
(הודעה)UpdateMessageRequest
(הודעה)UpdateSpaceReadStateRequest
(הודעה)UpdateSpaceRequest
(הודעה)User
(הודעה)User.Type
(טיפוס טיפוסים בני מנייה (enum))UserMentionMetadata
(הודעה)UserMentionMetadata.Type
(טיפוס טיפוסים בני מנייה (enum))WidgetMarkup
(הודעה)WidgetMarkup.Button
(הודעה)WidgetMarkup.FormAction
(הודעה)WidgetMarkup.FormAction.ActionParameter
(הודעה)WidgetMarkup.Icon
(טיפוס טיפוסים בני מנייה (enum))WidgetMarkup.Image
(הודעה)WidgetMarkup.ImageButton
(הודעה)WidgetMarkup.KeyValue
(הודעה)WidgetMarkup.OnClick
(הודעה)WidgetMarkup.OpenLink
(הודעה)WidgetMarkup.TextButton
(הודעה)WidgetMarkup.TextParagraph
(הודעה)
ChatService
מאפשרת למפתחים ליצור אפליקציות ל-Chat ושילובים בפלטפורמת Google Chat.
CompleteImportSpace |
---|
משלים את תהליך הייבוא של המרחב שצוין והופך אותו לגלוי למשתמשים. נדרש אימות אפליקציה והענקת גישה ברמת הדומיין. מידע נוסף זמין במאמר מתן הרשאה לאפליקציות Google Chat לייבא נתונים.
|
CreateMembership |
---|
יוצרים מינוי לאפליקציית Chat לשיחות, למשתמש או לקבוצה ב-Google. אי אפשר ליצור מינויים לאפליקציות אחרות של Chat. אם מדיניות האישור האוטומטי של חברי המרחב המשותף מושבתת, הם יוזמנו ויצטרכו לאשר את ההזמנה לפני ההצטרפות. אחרת, אם יוצרים מינוי, החבר מתווסף ישירות למרחב המשותף. נדרש אימות משתמש. דוגמאות לשימוש:
|
CreateMessage |
---|
יצירת הודעה במרחב ב-Google Chat. לדוגמה, אפשר להיעזר במאמר שליחת הודעה. השיטה בתמונה הבאה אפשר לראות איך Chat משייך הודעה כשמשתמשים באימות של אפליקציות. במקום לשלוח את ההודעה, אפליקציית Chat תופיע ב-Chat. התוכן של ההודעה יכול להכיל טקסט ( בתמונה הבאה אפשר לראות איך Chat משייך הודעה כשמשתמשים באימות משתמש. אפליקציית Chat מציגה את המשתמש כשולח של ההודעה, ומשייכת את השם שלה להודעה. תוכן ההודעה יכול להכיל רק טקסט ( גודל ההודעה המקסימלי, כולל תוכן ההודעה, הוא 32,000 בייטים.
|
CreateReaction |
---|
אמוג'י יוצר תגובה ומוסיף אותה להודעה. יש תמיכה רק בסמלי אמוג'י בתקן Unicode. דוגמה: הוספת תגובה להודעה נדרש אימות משתמש.
|
CreateSpace |
---|
יצירת מרחב משותף בלי משתתפים. אפשר ליצור מרחב משותף עם שם. אין תמיכה במרחבים משותפים שמחולקים לנושאים. לדוגמה, תוכלו להיעזר במאמר יצירת מרחב משותף. אם מופיעה הודעת השגיאה אם הצטרפתם לתוכנית של התצוגה המקדימה למפתחים, תוכלו ליצור צ'אט קבוצתי במצב ייבוא באמצעות נדרש אימות משתמש.
|
DeleteMembership |
---|
מוחק מינוי. לדוגמה, ראו איך מסירים משתמשים או אפליקציית Google Chat ממרחבים משותפים. נדרש אימות משתמש.
|
DeleteMessage |
---|
מחיקת ההודעה כאן תוכלו לראות איך מוחקים הודעה. נדרש אימות. תמיכה באימות אפליקציות ובאימות משתמש. כשמשתמשים באימות של אפליקציות, הבקשות יכולות למחוק רק הודעות שנוצרו על ידי אפליקציית Chat לשיחות.
|
DeleteReaction |
---|
מחיקת תגובה להודעה. יש תמיכה רק בסמלי אמוג'י בתקן Unicode. ראו דוגמה במאמר מחיקת תגובה. נדרש אימות משתמש.
|
DeleteSpace |
---|
מחיקה של מרחב משותף בעל שם. תמיד מתבצעת מחיקה מדורגת. המשמעות היא שהמשאבים הצאצאים של המרחב המשותף, כמו הודעות שפורסמו במרחב המשותף ורשימת המשתתפים במרחב המשותף, נמחקים גם הם. דוגמה לכך מופיעה במאמר מחיקה של מרחב משותף. נדרשת אימות משתמש על ידי משתמש שיש לו הרשאה למחוק את המרחב המשותף.
|
FindDirectMessage |
---|
הפונקציה מחזירה את הצ'אט האישי הקיים עם המשתמש שצוין. אם לא נמצא מרחב לצ'אט אישי, הפונקציה תחזיר את השגיאה עם אימות משתמש, הפונקציה מחזירה את המרחב של הצ'אט האישי בין המשתמש שצוין לבין המשתמש המאומת. באמצעות אימות אפליקציות, החזרת המרחב של הצ'אט האישי בין המשתמש שצוין לבין אפליקציית Chat לשיחות. נדרש אימות משתמש או אימות אפליקציה.
|
GetAttachment |
---|
קבלת המטא-נתונים של קובץ מצורף להודעה. נתוני הקבצים המצורפים מאוחזרים באמצעות ה-API של המדיה. לדוגמה, ראו קבלת מטא-נתונים על קובץ מצורף להודעה. נדרש אימות אפליקציה.
|
GetMembership |
---|
החזרת פרטים על מינוי. לדוגמה, תוכלו להיעזר במאמר קבלת פרטים על המינוי של משתמש או של אפליקציית Google Chat. נדרש אימות. תמיכה באימות אפליקציות ובאימות משתמש.
|
GetMessage |
---|
להציג פרטים על הודעה. תוכלו להיעזר במאמר קבלת פרטים על הודעות לדוגמה. נדרש אימות. תמיכה באימות אפליקציות ובאימות משתמש. הערה: יכול להיות שההודעות שלכם יוחזרו מחלק מהמשתמשים או מהמרחב המשותף שחסמתם.
|
GetSpace |
---|
הפונקציה מחזירה פרטים על מרחב משותף. לדוגמה, תוכלו להיעזר במאמר איך מקבלים פרטים על מרחבים משותפים. נדרש אימות. תמיכה באימות אפליקציות ובאימות משתמש.
|
GetSpaceEvent |
---|
הפונקציה מחזירה אירוע ממרחב משותף ב-Google Chat. המטען הייעודי (Payload) של האירועים מכיל את הגרסה העדכנית ביותר של המשאב שהשתנה. לדוגמה, אם מבקשים אירוע לגבי הודעה חדשה אבל ההודעה עודכנה מאוחר יותר, השרת יחזיר את המשאב נדרש אימות משתמש. כדי שתוכלו לראות אירוע, המשתמש המאומת צריך להיות חבר במרחב המשותף. לדוגמה, תוכלו להיעזר במאמר קבלת פרטים על אירועים ממרחבים משותפים ב-Google Chat.
|
GetSpaceReadState |
---|
פונקציה זו מחזירה פרטים על מצב הקריאה של המשתמש בתוך מרחב משותף, המשמשים לזיהוי הודעות שנקראו ושלא נקראו. ראו דוגמה במאמר קבלת פרטים על מצב הקריאה במרחב של משתמש. נדרש אימות משתמש.
|
GetThreadReadState |
---|
החזרת פרטים על מצב הקריאה של משתמש בשרשור, המשמשים לזיהוי הודעות שנקראו ושלא נקראו. ראו דוגמה במאמר קבלת פרטים על מצב הקריאה בשרשור של משתמש. נדרש אימות משתמש.
|
ListMemberships |
---|
הצגת רשימת המשתמשים במרחבים משותפים. ראו דוגמה במאמר הצגת רשימת המשתמשים והאפליקציות של Google Chat במרחבים משותפים. בדף אפליקציה עם אימות אפליקציות רשומים מינויים במרחבים משותפים שאליהם יש לאפליקציית Chat גישה, אבל לא כולל מינויים לאפליקציית Chat, כולל החברות שלה. בדף פרטי חברויות באימות משתמשים רשומים חברויות במרחבים משותפים שלמשתמש המאומת יש גישה אליהם. נדרש אימות. תמיכה באימות אפליקציות ובאימות משתמש.
|
ListMessages |
---|
רשימה של הודעות במרחבים משותפים שהצטרפתם אליהם, כולל הודעות ממרחבים משותפים וממרחבים משותפים שחסמתם. אם ברשימה אין הודעות ממרחב משותף בלי הודעות, התשובה תהיה אובייקט ריק. כשמשתמשים בממשק REST/HTTP, התשובה תכיל אובייקט JSON ריק,
|
ListReactions |
---|
כאן אפשר לראות את רשימת התגובות להודעות. ראו דוגמה במאמר רשימת התגובות להודעות. נדרש אימות משתמש.
|
ListSpaceEvents |
---|
הצגת רשימה של אירועים ממרחב משותף ב-Google Chat. לכל אירוע, המטען הייעודי (Payload) מכיל את הגרסה העדכנית ביותר של המשאב ב-Chat. לדוגמה, אם ברשימה אירועים מוצגים משתתפים חדשים במרחב המשותף, השרת מחזיר נדרש אימות משתמש. כדי להציג אירועים, המשתמש המאומת צריך להיות חבר במרחב המשותף. ראו דוגמה במאמר הצגת אירועים ממרחב משותף ב-Google Chat.
|
ListSpaces |
---|
בתיבת הדו-שיח הזו מפורטים המרחבים המשותפים שאליהם המשתמש משתתף. הצ'אטים הקבוצתיים והצ'אטים לא מופיעים עד ששולחים את ההודעה הראשונה. לדוגמה, ראו הצגת מרחבים משותפים. נדרש אימות. תמיכה באימות אפליקציות ובאימות משתמש. הצגת מרחבים משותפים שגלויים למתקשר או למשתמש המאומת. הצ'אטים הקבוצתיים והצ'אטים לא מופיעים עד ששולחים את ההודעה הראשונה. כדי להציג רשימה של כל המרחבים המשותפים עם שם לפי הארגון ב-Google Workspace, צריך להשתמש בשיטה
|
SearchSpaces |
---|
use_admin_access לערך true .
|
SetUpSpace |
---|
יצירת מרחב משותף והוספה של משתמשים ספציפיים אליו. המשתמש שהתקשר יצורף אוטומטית למרחב המשותף ולא צריך לציין אותו ברשימת החברות שלו. תוכלו להיעזר במאמר הגדרת מרחב עם משתתפים ראשוניים. כדי לציין את המשתמשים האנושיים שרוצים להוסיף, צריך להוסיף חברויות במועדון עם מאפיין כדי לציין אילו קבוצות Google להוסיף, מוסיפים חברויות עם המאפיין אם מדובר במרחב משותף או בצ'אט קבוצתי עם שם, אם מי שהתקשר חסם או חסום על ידי חלק מהמשתתפים או אם אין לו הרשאה לצרף אנשים מסוימים, אותם משתמשים לא יתווספו למרחב המשותף שנוצר. כדי ליצור צ'אט אישי בין המשתמש שמתקשר למשתמש אנושי אחר, אתם צריכים לציין בדיוק מינוי אחד לייצוג המשתמש האנושי. אם משתמש אחד יחסום את המשתמש השני, הבקשה תיכשל והצ'אט לא ייווצר. כדי ליצור צ'אט אישי בין המשתמש המתקשר לבין אפליקציית השיחות, צריך להגדיר את אם כבר קיים צ'אט בין שני משתמשים, גם אם משתמש אחד חוסם את השני בזמן שליחת הבקשה, הצ'אט הקיים מוחזר. אי אפשר להשתמש במרחבים משותפים עם שרשורים. אם מופיעה הודעת השגיאה נדרש אימות משתמש.
|
UpdateMembership |
---|
עדכון המינוי. לדוגמה, תוכלו להיעזר במאמר איך מעדכנים את החברות של משתמשים במרחבים משותפים. נדרש אימות משתמש.
|
UpdateMessage |
---|
מעדכנים הודעה. יש הבדל בין השיטה נדרש אימות. תמיכה באימות אפליקציות ובאימות משתמש. כשמשתמשים באימות של אפליקציות, הבקשות יכולות לעדכן רק את ההודעות שנוצרו באפליקציית Chat לשיחות.
|
UpdateSpace |
---|
לעדכן את המרחב המשותף. תוכלו להיעזר במאמר איך משנים את המרחב המשותף. אם אתם מעדכנים את השדה נדרש אימות משתמש.
|
UpdateSpaceReadState |
---|
עדכון מצב הקריאה של המשתמש במרחב משותף שמשמש לזיהוי הודעות שנקראו ושלא נקראו. ראו דוגמה במאמר עדכון מצב הקריאה של מרחב משתמש. נדרש אימות משתמש.
|
AccessoryWidget
ווידג'ט אינטראקטיבי אחד או יותר שמופיעים בחלק התחתון של הודעה. לפרטים נוספים, ראו הוספת ווידג'טים אינטראקטיביים בתחתית הודעה.
שדות | |
---|---|
שדה איחוד action . סוג הפעולה. action יכול להיות רק אחת מהאפשרויות הבאות: |
|
button_list |
רשימת לחצנים. |
ActionResponse
פרמטרים שאפליקציית Chat יכולה להשתמש בהם כדי להגדיר את האופן שבו התשובה שלה תפורסם.
שדות | |
---|---|
type |
קלט בלבד. סוג התשובה מאפליקציית Chat. |
url |
קלט בלבד. כתובת URL שהמשתמשים יכולים לאמת או להגדיר. (רק ל- |
dialog_action |
קלט בלבד. תגובה לאירוע אינטראקציה שקשור לתיבת דו-שיח. חובה לציין בליווי |
updated_widget |
קלט בלבד. התשובה של הווידג'ט המעודכן. |
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 |
שאילתת אפשרויות להשלמה אוטומטית של טקסט בווידג'ט. |
SelectionItems
רשימת תוצאות ההשלמה האוטומטית של ווידג'טים.
שדות | |
---|---|
items[] |
מערך של האובייקטים SelectionItem. |
UpdatedWidget
התשובה של הווידג'ט המעודכן. משמש להצגת אפשרויות השלמה אוטומטית לווידג'ט.
שדות | |
---|---|
widget |
המזהה של הווידג'ט המעודכן. המזהה צריך להתאים לזה של הווידג'ט שהפעיל את בקשת העדכון. |
שדה איחוד updated_widget . הווידג'ט עודכן בתגובה לפעולת משתמש. updated_widget יכול להיות רק אחת מהאפשרויות הבאות: |
|
suggestions |
רשימת תוצאות של השלמה אוטומטית בווידג'טים |
ActionStatus
מייצג את הסטטוס של בקשה להפעלה או לשליחה של תיבת דו-שיח.
שדות | |
---|---|
status_code |
קוד הסטטוס. |
user_facing_message |
ההודעה שצריך לשלוח למשתמשים לגבי סטטוס הבקשה שלהם. אם המדיניות לא מוגדרת, תישלח הודעה גנרית שמבוססת על |
הערה
פלט בלבד. הערות המשויכות לגוף הטקסט הפשוט של ההודעה. כדי להוסיף עיצוב בסיסי להודעת טקסט, ראו עיצוב הודעות טקסט.
דוגמה לגוף הודעת טקסט פשוט:
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"
}
}]
שדות | |
---|---|
type |
סוג ההערה. |
length |
האורך של מחרוזת המשנה בגוף ההודעה של טקסט פשוט שאליו תואמת ההערה. |
start_index |
יצירת אינדקס (מבוסס 0, כולל) בגוף ההודעה בטקסט פשוט שאליו ההערה מתייחסת. |
שדה איחוד metadata . מטא-נתונים נוספים לגבי ההערה. הערך של metadata יכול להיות רק אחת מהאפשרויות הבאות: |
|
user_mention |
המטא-נתונים של אזכור משתמש. |
slash_command |
המטא-נתונים של פקודת לוכסן. |
rich_link_metadata |
מטא-נתונים לקישור עשיר. |
AnnotationType
סוג ההערה.
טיפוסים בני מנייה (enum) | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
ערך ברירת המחדל של enum. אין להשתמש בו. |
USER_MENTION |
משתמש הוזכר. |
SLASH_COMMAND |
בוצעה פקודה של שורת הפקודות. |
RICH_LINK |
הערה עם קישור עשיר. |
AttachedGif
תמונת GIF שצוינה על ידי כתובת URL.
שדות | |
---|---|
uri |
פלט בלבד. כתובת ה-URL שמארחת את תמונת ה-GIF. |
קובץ מצורף
קובץ מצורף ב-Google Chat.
שדות | |
---|---|
name |
שם המשאב של הקובץ המצורף, בפורמט |
content_name |
פלט בלבד. שם הקובץ המקורי של התוכן, לא הנתיב המלא. |
content_type |
פלט בלבד. סוג התוכן (סוג MIME) של הקובץ. |
thumbnail_uri |
פלט בלבד. כתובת ה-URL של התמונה הממוזערת שבה צריך להשתמש כדי לראות תצוגה מקדימה של הקובץ המצורף למשתמש אנושי. אסור להשתמש בכתובת ה-URL הזו כדי להוריד תוכן מצורף באפליקציות צ'אט. |
download_uri |
פלט בלבד. כתובת ה-URL להורדה שבה צריך להשתמש כדי לאפשר למשתמש אנושי להוריד את הקובץ המצורף. אסור להשתמש בכתובת ה-URL הזו כדי להוריד תוכן מצורף באפליקציות צ'אט. |
source |
פלט בלבד. מקור הקובץ המצורף. |
שדה איחוד data_ref . נתוני ההפניה לקובץ המצורף. data_ref יכול להיות רק אחת מהאפשרויות הבאות: |
|
attachment_data_ref |
הפניה לנתונים של הקבצים המצורפים. השדה הזה משמש יחד עם ה-API למדיה כדי להוריד את נתוני הקבצים המצורפים. |
drive_data_ref |
פלט בלבד. הפניה לקובץ המצורף מ-Google Drive. השדה הזה משמש בשילוב עם Google Drive API. |
מקור
מקור הקובץ המצורף.
טיפוסים בני מנייה (enum) | |
---|---|
SOURCE_UNSPECIFIED |
שמור. |
DRIVE_FILE |
הקובץ הוא קובץ Google Drive. |
UPLOADED_CONTENT |
הקובץ הועלה ל-Chat. |
AttachmentDataRef
הפניה לנתונים של הקבצים המצורפים.
שדות | |
---|---|
resource_name |
שם המשאב של הנתונים המצורפים. השדה הזה משמש יחד עם ה-API למדיה כדי להוריד את נתוני הקבצים המצורפים. |
attachment_upload_token |
אסימון אטום שמכיל הפניה לקובץ מצורף שהועלה. התייחסות ללקוחות כמחרוזת אטומה שמשמשת ליצירה או לעדכון של הודעות Chat עם קבצים מצורפים. |
CardWithId
כרטיס בהודעה ב-Google Chat.
רק אפליקציות Chat יכולות ליצור כרטיסים. אם אפליקציית Chat מבצעת אימות כמשתמש, ההודעה לא יכולה להכיל כרטיסים.
עיצוב כרטיסים בתצוגה מקדימה בעזרת הכלי ליצירת כרטיסים.
לפתיחת הכלי ליצירת כרטיסיםשדות | |
---|---|
card_id |
חובה אם ההודעה מכילה כמה כרטיסים. מזהה ייחודי של כרטיס בהודעה. |
card |
כרטיס. הגודל המקסימלי הוא 32KB. |
ChatSpaceLinkData
נתונים של קישורים למרחב משותף ב-Chat.
שדות | |
---|---|
space |
המרחב של משאב המרחב המשותף ב-Chat המקושר. פורמט: |
thread |
השרשור של המשאב המקושר של המרחב המשותף ב-Chat. פורמט: |
message |
ההודעה של המשאב המקושר של המרחב ב-Chat. פורמט: |
CompleteImportSpaceRequest
בקשה לקבלת הודעה להשלמת תהליך הייבוא של מרחב משותף.
שדות | |
---|---|
name |
חובה. שם המשאב של המרחב במצב ייבוא. פורמט: |
CompleteImportSpaceResponse
הודעת תשובה לגבי השלמת תהליך הייבוא של מרחב משותף.
שדות | |
---|---|
space |
המרחב המשותף במצב ייבוא. |
ContextualAddOnMarkup
אין שדות בסוג הזה.
תגי העיצוב למפתחים שמציינים את התוכן של תוסף לפי הקשר.
קלפים
כרטיס הוא רכיב בממשק המשתמש שיכול להכיל ווידג'טים של ממשק המשתמש, כמו טקסט ותמונות.
שדות | |
---|---|
header |
כותרת הכרטיס. כותרת מכילה בדרך כלל כותרת ותמונה. |
sections[] |
החלקים מופרדים באמצעות קו מפריד. |
card_actions[] |
הפעולות בכרטיס הזה. |
name |
שם הכרטיס. |
CardAction
פעולה בכרטיס היא הפעולה שמשויכת לכרטיס. אם יש לכם כרטיס חשבונית, תוכלו לעשות זאת בדרך כלל: מחיקת חשבונית, שליחת חשבונית באימייל או פתיחת החשבונית בדפדפן.
אין תמיכה באפליקציות Google Chat.
שדות | |
---|---|
action_label |
התווית הקודמת שהייתה מופיעה באפשרות של תפריט הפעולות. |
on_click |
הפעולה 'לחיצה' על הפעולה הזו. |
CardHeader
שדות | |
---|---|
title |
צריך לציין כותרת. לכותרת יש גובה קבוע: אם מציינים גם כותרת וגם כותרת משנה, כל אחת מהן תופסת שורה אחת. אם מציינים רק את הכותרת, היא תופסת את שתי השורות. |
subtitle |
כותרת המשנה של כותרת הכרטיס. |
image_style |
סוג התמונה (לדוגמה, גבול מרובע או גבול מעגלי). |
image_url |
כתובת ה-URL של התמונה בכותרת הכרטיס. |
ImageStyle
טיפוסים בני מנייה (enum) | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
גבול מרובע. |
AVATAR |
גבול עגול. |
קטע
קטע מכיל אוסף של ווידג'טים שמעובדים (אנכי) לפי הסדר שבו צוינו. בכל הפלטפורמות, לכרטיסים יש רוחב קבוע צר, לכן אין כרגע צורך במאפייני פריסה (לדוגמה, מספר ממשי (float).
שדות | |
---|---|
header |
הכותרת של הקטע. יש תמיכה בטקסט מעוצב. למידע נוסף על עיצוב טקסט, תוכלו לקרוא את המאמרים עיצוב טקסט באפליקציות ב-Google Chat ועיצוב טקסט בתוספים ל-Google Workspace. |
widgets[] |
קטע חייב להכיל לפחות ווידג'ט אחד. |
CreateMembershipRequest
הודעת בקשה ליצירת מינוי.
שדות | |
---|---|
parent |
חובה. שם המשאב של המרחב המשותף שעבורו רוצים ליצור את החברות. פורמט: Spaces/{space} |
membership |
חובה. קשר החברות שיש ליצור. השדה |
use_admin_access |
true , השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים. נדרש היקף OAuth 2.0 אי אפשר ליצור מינויים לאפליקציות או ליצור מינויים למשתמשים מחוץ לארגון של האדמין ב-Google Workspace באמצעות הרשאת אדמין. |
CreateMessageRequest
יצירת הודעה
שדות | |
---|---|
parent |
חובה. שם המשאב של המרחב המשותף שבו אפשר ליצור הודעה. פורמט: |
message |
חובה. גוף ההודעה. |
thread_key |
זה שינוי אופציונלי. הוצא משימוש: במקומו צריך להשתמש ברכיב |
request_id |
זה שינוי אופציונלי. מזהה בקשה ייחודי של ההודעה הזו. כשמציינים מזהה בקשה קיים, מוצגת ההודעה שנוצרה עם המזהה הזה במקום ליצור הודעה חדשה. |
message_reply_option |
זה שינוי אופציונלי. קובעת אם ההודעה תתחיל שרשור או תענה בשרשור. התכונה נתמכת רק במרחבים משותפים עם שם. |
message_id |
זה שינוי אופציונלי. מזהה מותאם אישית של הודעה. ההגדרה הזו מאפשרת לאפליקציות ל-Chat לקבל, לעדכן או למחוק הודעה בלי לשמור את המזהה שהוקצה על ידי המערכת בשם המשאב של ההודעה (מיוצג בשדה הערך בשדה הזה חייב לעמוד בדרישות הבאות:
מידע נוסף מופיע במאמר בנושא מתן שם להודעה. |
MessageReplyOption
בהגדרה הזו קובעים איך עונים להודעות. יכול להיות שבעתיד יתווספו מדינות נוספות.
טיפוסים בני מנייה (enum) | |
---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
ברירת מחדל. התחלת שרשור חדש. אם בוחרים את האפשרות הזו, המערכת מתעלמת מכל הפרמטרים thread ID או שכלולים בחבילה. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
ההודעה נוצרת כתשובה לשרשור שצוין על ידי thread ID או . אם הפעולה תיכשל, ההודעה תתחיל שרשור חדש. |
REPLY_MESSAGE_OR_FAIL |
ההודעה נוצרת כתשובה לשרשור שצוין על ידי thread ID או . אם משתמשים בשדה thread_key חדש, נוצר שרשור חדש. אם יצירת ההודעה תיכשל, תוחזר השגיאה NOT_FOUND במקום זאת. |
CreateReactionRequest
ייווצר תגובה להודעות.
שדות | |
---|---|
parent |
חובה. ההודעה שבה נוצרה התגובה. פורמט: |
reaction |
חובה. התגובה שצריך ליצור. |
CreateSpaceRequest
בקשה ליצירת מרחב בלי משתתפים.
שדות | |
---|---|
space |
חובה. צריך לאכלס אם מופיעה הודעת השגיאה אם הצטרפתם לתוכנית התצוגה המקדימה למפתחים, אפשר להשתמש ב- המרחב המשותף |
request_id |
זה שינוי אופציונלי. מזהה ייחודי לבקשה הזו. מומלץ להשתמש במזהה ייחודי אוניברסלי (UUID) אקראי. כשמציינים מזהה בקשה קיים, המערכת מחזירה את המרחב המשותף שנוצר עם המזהה הזה במקום ליצור מרחב חדש. אם מציינים מזהה בקשה קיים מאותה אפליקציית Chat עם משתמש מאומת אחר, תוחזר הודעת שגיאה. |
CustomEmoji
מייצג אמוג'י בהתאמה אישית.
שדות | |
---|---|
uid |
פלט בלבד. מפתח ייחודי למשאב האמוג'י בהתאמה אישית. |
DeleteMembershipRequest
לשלוח בקשה למחוק את החברות במרחב המשותף.
שדות | |
---|---|
name |
חובה. שם המשאב של החברות שרוצים למחוק. אפליקציות צ'אט יכולות למחוק משתמשים אנושיים או המינויים של עצמם. אפליקציות צ'אט לא יכולות למחוק אפליקציות אחרות חברויות במועדונים של ערוצים. כדי למחוק מינוי אנושי, צריך להשתמש בהיקף כדי למחוק מינוי לאפליקציה, צריך להשתמש בהיקף פורמט: |
use_admin_access |
true , השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים. נדרש היקף OAuth 2.0 אי אפשר למחוק מינויים לאפליקציות במרחבים משותפים בעזרת הרשאת אדמין. |
DeleteMessageRequest
שליחת בקשה למחיקת הודעה.
שדות | |
---|---|
name |
חובה. שם המשאב של ההודעה. פורמט: אם הגדרתם מזהה מותאם אישית להודעה, תוכלו להשתמש בערך מהשדה |
force |
במצב חלה רק במהלך אימות כמשתמש. אין לכך השפעה על אימות כאפליקציית Chat. |
DeleteReactionRequest
מחיקת תגובה להודעה.
שדות | |
---|---|
name |
חובה. שם התגובה שרוצים למחוק. פורמט: |
DeleteSpaceRequest
בקשה למחיקת מרחב.
שדות | |
---|---|
name |
חובה. שם המשאב של המרחב המשותף שרוצים למחוק. פורמט: |
use_admin_access |
true , השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים. נדרש היקף OAuth 2.0 |
DeletionMetadata
מידע על הודעה שנמחקה. הודעה נמחקת כשמגדירים את delete_time
.
שדות | |
---|---|
deletion_type |
מציין מי מחק את ההודעה. |
DeletionType
מי מחק את ההודעה ואיך היא נמחקה.
טיפוסים בני מנייה (enum) | |
---|---|
DELETION_TYPE_UNSPECIFIED |
הערך הזה לא בשימוש. |
CREATOR |
משתמש מחק הודעה משלו. |
SPACE_OWNER |
הבעלים של המרחב המשותף מחקו את ההודעה. |
ADMIN |
אדמין ב-Google Workspace מחק את ההודעה. |
APP_MESSAGE_EXPIRY |
אפליקציה של Chat מחקה הודעה משלה אחרי שפג התוקף. |
CREATOR_VIA_APP |
אפליקציית Chat מחקה את ההודעה בשם המשתמש. |
SPACE_OWNER_VIA_APP |
אפליקציית Chat מחקה את ההודעה בשם הבעלים של המרחב המשותף. |
תיבת דו-שיח
עטוף סביב גוף הכרטיס של תיבת הדו-שיח.
שדות | |
---|---|
body |
קלט בלבד. גוף תיבת הדו-שיח, שמוצג בחלון מודאלי. אפליקציות Google Chat לא תומכות בישויות הכרטיסים הבאות: |
DialogAction
מכיל תיבת דו-שיח וקוד הסטטוס של הבקשה.
שדות | |
---|---|
action_status |
קלט בלבד. הסטטוס של בקשה להפעלה או לשליחה של תיבת דו-שיח. אם צריך, מציגים סטטוס והודעה למשתמשים. לדוגמה, במקרה של שגיאה או הצלחה. |
שדה איחוד action . הפעולה לביצוע. action יכול להיות רק אחת מהאפשרויות הבאות: |
|
dialog |
קלט בלבד. תיבת דו-שיח לבקשה. |
DriveDataRef
הפניה לנתונים של קובץ מצורף לכונן.
שדות | |
---|---|
drive_file_id |
המזהה של קובץ ה-Drive. שימוש עם Drive API. |
DriveLinkData
נתונים של קישורים ל-Google Drive.
שדות | |
---|---|
drive_data_ref |
DriveDataRef שמפנה לקובץ Google Drive. |
mime_type |
סוג ה-MIME של משאב Google Drive המקושר. |
אמוג'י
אמוג'י שמשמש כתגובה להודעה.
שדות | |
---|---|
שדה איחוד content . תוכן האמוג'י. content יכול להיות רק אחת מהאפשרויות הבאות: |
|
unicode |
אמוג'י בסיסי שמיוצג על ידי מחרוזת Unicode. |
custom_emoji |
פלט בלבד. אמוג'י בהתאמה אישית. |
EmojiReactionSummary
מספר האנשים שהגיבו להודעה באמוג'י ספציפי.
שדות | |
---|---|
emoji |
אמוג'י שמשויכים לתגובות. |
reaction_count |
המספר הכולל של תגובות שכוללות את האמוג'י המשויך. |
FindDirectMessageRequest
בקשה לקבלת מרחב בצ'אט אישי על סמך משאב המשתמש.
שדות | |
---|---|
name |
חובה. שם המשאב של המשתמש לאיתור הצ'אט האישי. פורמט: |
GetAttachmentRequest
בקשה לקבלת קובץ מצורף.
שדות | |
---|---|
name |
חובה. שם המשאב של הקובץ המצורף, בפורמט |
GetMembershipRequest
עליך לשלוח בקשת הצטרפות למרחב המשותף.
שדות | |
---|---|
name |
חובה. שם המשאב של החברות לאחזור. כדי לקבל חברות באפליקציה באמצעות אימות משתמש, אפשר גם להשתמש ב- פורמט: אחרי שבוצע אימות כמשתמש, ניתן להשתמש בכתובת האימייל של המשתמש ככינוי עבור |
use_admin_access |
true , השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים. נדרשים היקפי הרשאות OAuth 2.0: אי אפשר לקבל מינויים לאפליקציות במרחבים משותפים כשמשתמשים בהרשאת אדמין. |
GetMessageRequest
מבקשים לקבל הודעה.
שדות | |
---|---|
name |
חובה. שם המשאב של ההודעה. פורמט: אם הגדרתם מזהה מותאם אישית להודעה, תוכלו להשתמש בערך מהשדה |
GetSpaceEventRequest
בקשה לקבלת הודעה בקשר לאירוע במרחב המשותף.
שדות | |
---|---|
name |
חובה. שם המשאב של האירוע במרחב המשותף. פורמט: |
GetSpaceReadStateRequest
הודעת בקשה לממשק ה-API של GetSpaceReadState.
שדות | |
---|---|
name |
חובה. שם המשאב של מצב הקריאה של המרחב המשותף שצריך לאחזר. התכונה תומכת רק בקבלת מצב קריאה למשתמש שמתקשר. כדי להפנות למשתמש שהתקשרו אליו, תוכלו להגדיר אחת מהאפשרויות הבאות:
פורמט: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
בקשה להחזרת מרחב אחד.
שדות | |
---|---|
name |
חובה. שם המשאב של המרחב המשותף, בפורמט פורמט: |
use_admin_access |
true , השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים. נדרשים היקפי הרשאות OAuth 2.0: |
GetThreadReadStateRequest
הודעת בקשה לממשק API של GetThreadReadStateRequest.
שדות | |
---|---|
name |
חובה. שם המשאב של מצב הקריאה בשרשור שצריך לאחזר. התכונה תומכת רק בקבלת מצב קריאה למשתמש שמתקשר. כדי להפנות למשתמש שהתקשרו אליו, תוכלו להגדיר אחת מהאפשרויות הבאות:
פורמט: users/{user}/spaces/{space}/threads/{thread}/threadReadState |
קבוצה
קבוצה ב-Google Chat.
שדות | |
---|---|
name |
שם המשאב של קבוצה ב-Google. מייצג קבוצה ב-Cloud Identity Groups API. פורמט: groups/{group} |
HistoryState
את מצב ההיסטוריה של ההודעות והמרחבים המשותפים. מציינת למשך כמה זמן ההודעות והשרשורים של השיחות יישמרו אחרי שיוצרים אותם.
טיפוסים בני מנייה (enum) | |
---|---|
HISTORY_STATE_UNSPECIFIED |
ערך ברירת המחדל. אין להשתמש בו. |
HISTORY_OFF |
ההיסטוריה מושבתת. ההודעות והשרשורים נשמרים למשך 24 שעות. |
HISTORY_ON |
ההיסטוריה מופעלת. כללי השמירה ב-Vault של הארגון מגדירים את משך הזמן לשמירת הודעות ושרשורים. |
ListMembershipsRequest
בקשת חברות במועדון של ערוץ.
שדות | |
---|---|
parent |
חובה. שם המשאב של המרחב המשותף שעבורו רוצים לאחזר את רשימת החברים. פורמט: Spaces/{space} |
page_size |
זה שינוי אופציונלי. המספר המקסימלי של חברויות במועדון שאפשר להחזיר. השירות עשוי להחזיר פחות מהערך הזה. אם לא מצוין, המערכת תחזיר עד 100 חברויות. הערך המקסימלי הוא 1,000. אם משתמשים בערך שגבוה מ-1,000, הוא משתנה באופן אוטומטי ל-1,000. ערכים שליליים מחזירים שגיאה מסוג |
page_token |
זה שינוי אופציונלי. אסימון דף, שהתקבל מקריאה קודמת להצגת רשימת חברויות. צריך לספק את הפרמטר הזה כדי לאחזר את הדף הבא. במהלך החלוקה לדפים, כל הפרמטרים האחרים שצוינו צריכים להתאים לקריאה שסיפקה את אסימון הדף. העברה של ערכים שונים לפרמטרים האחרים עלולה להוביל לתוצאות בלתי צפויות. |
filter |
זה שינוי אופציונלי. מסנן שאילתות. אפשר לסנן את המינויים לפי התפקיד של החבר/ה ( כדי לסנן לפי תפקיד, צריך להגדיר את כדי לסנן לפי סוג, צריך להגדיר את כדי לסנן לפי תפקיד וסוג, אפשר להשתמש באופרטור אם המדיניות לדוגמה, השאילתות הבאות תקינות:
השאילתות הבאות לא חוקיות:
שאילתות לא חוקיות נדחות על ידי השרת עם השגיאה |
show_groups |
זה שינוי אופציונלי. כאשר |
show_invited |
זה שינוי אופציונלי. כאשר כרגע נדרש אימות משתמש. |
use_admin_access |
true , השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים. נדרש היקף OAuth 2.0, אי אפשר להציג רשימות של אפליקציות במרחבים משותפים כשמשתמשים בהרשאת אדמין. |
ListMembershipsResponse
תשובה לרשימת המשתתפים במרחב המשותף.
שדות | |
---|---|
memberships[] |
רשימה לא ממוינת. רשימת החברויות בדף המבוקש (או בדף הראשון). |
next_page_token |
אסימון שאפשר לשלוח בתור |
ListMessagesRequest
הצגת רשימה של הודעות במרחב המשותף שהמשתמש חבר בו.
שדות | |
---|---|
parent |
חובה. שם המשאב של המרחב המשותף שממנו רוצים לראות את רשימת ההודעות. פורמט: |
page_size |
המספר המקסימלי של הודעות שהוחזרו. השירות עשוי להחזיר פחות הודעות מהערך הזה. אם לא צוין, יוחזרו 25 לכל היותר. הערך המקסימלי הוא 1,000. אם משתמשים בערך שגבוה מ-1,000, הוא משתנה באופן אוטומטי ל-1,000. ערכים שליליים מחזירים שגיאה מסוג |
page_token |
אופציונלי, אם ממשיכים משאילתה קודמת. אסימון דף שהתקבל משיחה קודמת של הודעות ברשימה. צריך לספק את הפרמטר הזה כדי לאחזר את הדף הבא. במהלך החלוקה לדפים, כל הפרמטרים האחרים שצוינו צריכים להתאים לקריאה שסיפקה את אסימון הדף. העברה של ערכים שונים לפרמטרים האחרים עלולה להוביל לתוצאות בלתי צפויות. |
filter |
מסנן שאילתות. אפשר לסנן הודעות לפי תאריך ( כדי לסנן הודעות לפי התאריך שבו הן נוצרו, צריך לציין את השדה כדי לסנן לפי שרשור, צריך לציין את השדה כדי לסנן לפי שרשור וגם לפי תאריך, אפשר להשתמש באופרטור לדוגמה, השאילתות הבאות תקינות:
שאילתות לא חוקיות נדחות על ידי השרת עם השגיאה |
order_by |
אופציונלי, אם ממשיכים משאילתה קודמת. לפי הסדר של רשימת ההודעות. צריך לציין ערך להזמנה לפי פעולת הזמנה. הערכים החוקיים של פעולת ההזמנה הם:
סדר ברירת המחדל הוא |
show_deleted |
האם לכלול הודעות שנמחקו. הודעות שנמחקו כוללות את הזמן שנמחק ומטא-נתונים לגבי המחיקה שלהן, אבל תוכן ההודעות לא זמין. |
ListMessagesResponse
הודעת תגובה להודעות בנוגע להצגת רשימה.
שדות | |
---|---|
messages[] |
רשימת הודעות. |
next_page_token |
אפשר לשלוח אסימון בתור |
ListReactionsRequest
כאן אפשר לראות את רשימת התגובות להודעות.
שדות | |
---|---|
parent |
חובה. ההודעה שהמשתמשים הגיבו עליה. פורמט: |
page_size |
זה שינוי אופציונלי. המספר המקסימלי של תגובות שהוחזרו. השירות יכול להחזיר פחות תגובות מהערך הזה. אם לא צוין, ערך ברירת המחדל הוא 25. הערך המקסימלי הוא 200; ערכים מעל 200 משתנים ל-200. |
page_token |
זה שינוי אופציונלי. (אם ממשיכים משאילתה קודמת). אסימון דף שהתקבל מקריאה קודמת לתגובות ברשימה. צריך לספק אותה כדי לאחזר את הדף הבא. במהלך החלוקה לדפים, ערך המסנן צריך להתאים לקריאה שסיפקה את אסימון הדף. העברת ערך אחר עלולה להוביל לתוצאות בלתי צפויות. |
filter |
זה שינוי אופציונלי. מסנן שאילתות. אתם יכולים לסנן תגובות לפי אמוג'י ( כדי לסנן תגובות מכמה אמוג'י או משתמשים, אפשר לאחד שדות דומים באמצעות האופרטור כדי לסנן תגובות לפי אמוג'י ולפי משתמש, אפשר להשתמש באופרטור אם בשאילתה נעשה שימוש גם ב- לדוגמה, השאילתות הבאות תקינות:
השאילתות הבאות לא חוקיות:
שאילתות לא חוקיות נדחות על ידי השרת עם השגיאה |
ListReactionsResponse
תשובה לבקשת רשימה עם תגובות.
שדות | |
---|---|
reactions[] |
רשימת התגובות בדף המבוקש (או הראשון). |
next_page_token |
אסימון המשך לאחזור דף התוצאות הבא. היא ריקה עבור הדף האחרון של התוצאות. |
ListSpaceEventsRequest
הודעת בקשה להצגת רשימה של אירועים במרחב המשותף.
שדות | |
---|---|
parent |
חובה. שם המשאב של המרחב המשותף ב-Google Chat שבו התרחשו האירועים. פורמט: |
page_size |
זה שינוי אופציונלי. המספר המקסימלי של אירועים שהוחזרו במרחב המשותף. השירות עשוי להחזיר פחות מהערך הזה. ערכים שליליים מחזירים שגיאה מסוג |
page_token |
אסימון דף, שהתקבל משיחת אירועים קודמת במרחב המשותף ברשימה. צריך לספק אותה כדי לאחזר את הדף הבא. במהלך החלוקה לדפים, כל שאר הפרמטרים שסופקו כדי לכלול אירועים במרחב המשותף חייבים להיות תואמים לקריאה שסיפקה את אסימון הדף. העברה של ערכים שונים לפרמטרים האחרים עלולה להוביל לתוצאות בלתי צפויות. |
filter |
חובה. מסנן שאילתות. צריך לציין סוג אירוע אחד לפחות ( אפשר גם לסנן לפי שעת התחלה (
כדי לציין שעת התחלה או שעת סיום, צריך להשתמש באופרטור ובפורמט RFC-3339 שווים ל- לדוגמה, השאילתות הבאות תקינות:
השאילתות הבאות לא חוקיות:
שאילתות לא חוקיות נדחות על ידי השרת עם השגיאה |
ListSpaceEventsResponse
הודעת התגובה להצגת אירועים במרחב המשותף.
שדות | |
---|---|
space_events[] |
התוצאות מוחזרות בסדר כרונולוגי (מהאירוע הישן ביותר תחילה). |
next_page_token |
אסימון ההמשך משמש לאחזור אירועים נוספים. אם השדה הזה יושמט, אין דפים נוספים. |
ListSpacesRequest
בקשה להצגת רשימה של המרחבים המשותפים שהצטרפת אליהם.
שדות | |
---|---|
page_size |
זה שינוי אופציונלי. המספר המקסימלי של מרחבים שצריך להחזיר. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא צויין ערך, יוחזרו 100 רווחים לכל היותר. הערך המקסימלי הוא 1,000. אם משתמשים בערך שגבוה מ-1,000, הוא משתנה באופן אוטומטי ל-1,000. ערכים שליליים מחזירים שגיאה מסוג |
page_token |
זה שינוי אופציונלי. אסימון דף, שהתקבל מקריאה קודמת במרחב משותף. צריך לספק את הפרמטר הזה כדי לאחזר את הדף הבא. במהלך החלוקה לדפים, ערך המסנן צריך להתאים לקריאה שסיפקה את אסימון הדף. העברת ערך שונה עלולה להוביל לתוצאות בלתי צפויות. |
filter |
זה שינוי אופציונלי. מסנן שאילתות. אפשר לסנן מרחבים לפי סוג המרחב ( כדי לסנן לפי סוג רווח, צריך לציין ערך enum חוקי, למשל לדוגמה, השאילתות הבאות תקינות:
שאילתות לא חוקיות נדחות על ידי השרת עם השגיאה |
ListSpacesResponse
התשובה לבקשת רשימת מרחבים משותפים.
שדות | |
---|---|
spaces[] |
רשימת המרחבים בעמוד המבוקש (או בעמוד הראשון). |
next_page_token |
אפשר לשלוח אסימון בתור |
MatchedUrl
קישור תואם בהודעה ב-Chat. אפליקציות צ'אט יכולות לראות תצוגה מקדימה של כתובות URL שהותאמו. למידע נוסף, ראו תצוגה מקדימה של קישורים.
שדות | |
---|---|
url |
פלט בלבד. כתובת ה-URL שנמצאה לה התאמה. |
מינוי
מייצג את קשרי החברים ב-Google Chat, למשל אם המשתמש או אפליקציית Chat הוזמנו למרחב משותף, חלק ממנו או נעדרו ממנו.
שדות | |
---|---|
name |
שם המשאב של המינוי, שהוקצה על ידי השרת. פורמט: |
state |
פלט בלבד. סטטוס המינוי. |
role |
זה שינוי אופציונלי. תפקיד המשתמש במרחב ב-Chat, שקובע את הפעולות שמותרות למשתמשים במרחב המשותף. ניתן להשתמש בשדה הזה כקלט רק ב- |
create_time |
זה שינוי אופציונלי. בלתי ניתן לשינוי. מועד יצירת החברות במרחב, למשל מתי חבר הצטרף למרחב המשותף או הוזמן להצטרף אליו. השדה הזה הוא פלט בלבד, אבל הוא משמש לייבוא של מינויים היסטוריים במרחבים משותפים של מצב ייבוא. |
delete_time |
זה שינוי אופציונלי. בלתי ניתן לשינוי. מועד המחיקה של החברות, למשל, הזמן שבו חבר עזב את המרחב המשותף או הוסר ממנו. השדה הזה הוא פלט בלבד, אבל הוא משמש לייבוא של מינויים היסטוריים במרחבים משותפים של מצב ייבוא. |
שדה איחוד memberType . חבר המשויך למינוי הזה. יכול להיות שבעתיד תהיה תמיכה בסוגים אחרים של מנויים. memberType יכול להיות רק אחת מהאפשרויות הבאות: |
|
member |
האפליקציה או המשתמש ב-Google Chat שאליהם המינוי מתייחס. אם אפליקציית Chat ביצעה אימות כמשתמש, הפלט יאכלס את המשתמש |
group_member |
קבוצת Google שאליה מתייחסת החברות. |
MembershipRole
הפעולות המותרות של המשתמש במרחב ב-Chat. יכול להיות שבעתיד יתווספו עוד ערכי enum.
טיפוסים בני מנייה (enum) | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED |
ערך ברירת המחדל. בשביל users : הם לא חברים במרחב המשותף, אבל אפשר להזמין אותם. בשביל Google Groups : התפקיד הזה תמיד מוקצה (יכול להיות שייעשה שימוש בערכי enum אחרים בעתיד). |
ROLE_MEMBER |
חבר במרחב המשותף. למשתמש יש הרשאות בסיסיות, כמו שליחת הודעות למרחב המשותף. בשיחות אישיות וקבוצתיות ללא שם, לכולם יש את התפקיד הזה. |
ROLE_MANAGER |
המנהל/ת של המרחב המשותף. למשתמש יש את כל ההרשאות הבסיסיות וגם הרשאות אדמין שמאפשרות לו לנהל את המרחב המשותף, כמו הוספה והסרה של משתתפים. נתמכת רק ב-SpaceType.SPACE . |
MembershipState
ההגדרה קובעת מה הקשר של המשתמש למרחב המשותף. יכול להיות שבעתיד תהיה תמיכה במדינות נוספות במועדון של הערוץ.
טיפוסים בני מנייה (enum) | |
---|---|
MEMBERSHIP_STATE_UNSPECIFIED |
ערך ברירת המחדל. אין להשתמש בו. |
JOINED |
מי שיצורף למרחב המשותף יוכל להשתתף בו. |
INVITED |
המשתמש מוזמן להצטרף למרחב, אבל הוא עדיין לא הצטרף אליו. |
NOT_A_MEMBER |
המשתמש לא שייך למרחב המשותף ואין לו הזמנה בהמתנה להצטרף אליו. |
MembershipBatchCreatedEventData
מטען ייעודי (payload) של אירוע לכמה חברויות חדשות.
סוג האירוע: google.workspace.chat.membership.v1.batchCreated
שדות | |
---|---|
memberships[] |
רשימה של מינויים חדשים. |
MembershipBatchDeletedEventData
מטען ייעודי (payload) של אירוע שכולל כמה מינויים שנמחקו.
סוג האירוע: google.workspace.chat.membership.v1.batchDeleted
שדות | |
---|---|
memberships[] |
רשימה של המינויים שנמחקו. |
MembershipBatchUpdatedEventData
מטען ייעודי (payload) של אירוע שכולל מספר מינויים מעודכנים.
סוג האירוע: google.workspace.chat.membership.v1.batchUpdated
שדות | |
---|---|
memberships[] |
רשימה של חברויות במועדון שעודכנו. |
MembershipCreatedEventData
מטען ייעודי (payload) של אירוע למינוי חדש.
סוג האירוע: google.workspace.chat.membership.v1.created
.
שדות | |
---|---|
membership |
המועדון החדש. |
MembershipDeletedEventData
מטען ייעודי (payload) של אירוע למינוי שנמחק.
סוג האירוע: google.workspace.chat.membership.v1.deleted
שדות | |
---|---|
membership |
המינוי שנמחק. רק השדות |
MembershipUpdatedEventData
מטען ייעודי (payload) של אירוע למינוי מעודכן.
סוג האירוע: google.workspace.chat.membership.v1.updated
שדות | |
---|---|
membership |
המינוי המעודכן. |
הודעה
הודעה במרחב ב-Google Chat.
שדות | |
---|---|
name |
שם המשאב של ההודעה. פורמט:
אם מגדירים מזהה מותאם אישית כשיוצרים הודעה, אפשר להשתמש במזהה הזה כדי לציין את ההודעה בבקשה, על ידי החלפת |
sender |
פלט בלבד. המשתמש שיצר את ההודעה. אם אפליקציית Chat ביצעה אימות כמשתמש, הפלט יאכלס את המשתמש |
create_time |
זה שינוי אופציונלי. בלתי ניתן לשינוי. במרחבים משותפים שנוצרו ב-Chat, השעה שבה נוצרה ההודעה. השדה הזה הוא פלט בלבד, חוץ מבמקרים שבהם נעשה בו שימוש במרחבים משותפים של מצב ייבוא. במרחבים משותפים של מצב ייבוא, צריך להגדיר את השדה הזה לחותמת הזמן ההיסטורית שבה ההודעה נוצרה במקור כדי לשמר את שעת היצירה המקורית. |
last_update_time |
פלט בלבד. השעה שבה המשתמש ערך לאחרונה את ההודעה. אם ההודעה לא נערכה אף פעם, השדה הזה יהיה ריק. |
delete_time |
פלט בלבד. השעה שבה ההודעה נמחקה ב-Google Chat. אם ההודעה לא נמחקת אף פעם, השדה הזה יהיה ריק. |
text |
תוכן טקסט פשוט של ההודעה. הקישור הראשון לתמונה, לסרטון או לדף אינטרנט יוצר צ'יפ של תצוגה מקדימה. אתם יכולים גם לאזכר משתמשים ב-Google Chat באמצעות@ או את כל מי שבמרחב המשותף. למידע נוסף על יצירת הודעות טקסט, ראו שליחת הודעה. |
formatted_text |
פלט בלבד. מכילה את ההודעה
מידע נוסף מופיע במאמר הצגת עיצוב הטקסט שנשלח בהודעה |
cards[] |
הוצא משימוש: במקומו צריך להשתמש ברכיב כרטיסים עשירים, מעוצבים ואינטראקטיביים שאפשר להשתמש בהם כדי להציג רכיבים בממשק המשתמש, כמו טקסטים מעוצבים, לחצנים ותמונות שניתן ללחוץ עליהן. בדרך כלל, הכרטיסים מוצגים מתחת לגוף הטקסט הפשוט של ההודעה. הגודל המקסימלי של קובצי |
cards_v2[] |
מערך של כרטיסים. רק אפליקציות צ'אט יכולות ליצור כרטיסים. אם אפליקציית Chat מבצעת אימות כמשתמש, ההודעות לא יכולות להכיל כרטיסים. למידע נוסף על יצירת הודעה שמכילה כרטיסים, אפשר לעיין במאמר שליחת הודעה. עיצוב כרטיסים בתצוגה מקדימה בעזרת הכלי ליצירת כרטיסים. לפתיחת הכלי ליצירת כרטיסים |
annotations[] |
פלט בלבד. הערות שמשויכות ל |
thread |
השרשור שאליו שייכת ההודעה. לדוגמה, שימוש בקטע התחלת שרשור הודעות או מענה לשרשורים. |
space |
אם אפליקציית Chat ביצעה אימות כמשתמש, הפלט יאכלס את המרחב המשותף |
fallback_text |
תיאור בטקסט פשוט של כרטיסי ההודעה, המשמש כשאי אפשר להציג את הכרטיסים בפועל — לדוגמה, התראות בנייד. |
action_response |
קלט בלבד. פרמטרים שאפליקציית Chat יכולה להשתמש בהם כדי להגדיר את האופן שבו התשובה שלה תפורסם. |
argument_text |
פלט בלבד. גוף ההודעה בטקסט פשוט, וכל האזכורים שלו באפליקציית Chat הוסרו. |
slash_command |
פלט בלבד. אם רלוונטי, פרטי הפקודה נחתכים. |
attachment[] |
קובץ מצורף שהעלה משתמש. |
matched_url |
פלט בלבד. כתובת URL ב- |
thread_reply |
פלט בלבד. כשהערך הוא אם אי אפשר לענות בשרשורים במרחב המשותף, השדה הזה תמיד יהיה |
client_assigned_message_id |
זה שינוי אופציונלי. מזהה מותאם אישית של ההודעה. אתם יכולים להשתמש בשדה כדי לזהות הודעה, או לקבל, למחוק או לעדכן הודעה. כדי להגדיר מזהה מותאם אישית, צריך לציין את השדה |
emoji_reaction_summaries[] |
פלט בלבד. רשימת סיכומי התגובות באמוג'י בהודעה. |
private_message_viewer |
בלתי ניתן לשינוי. קלט ליצירת הודעה. אחרת, פלט בלבד. המשתמש שיכול לצפות בהודעה. אם ההגדרה הזו מוגדרת, ההודעה תהיה פרטית וגלויה רק למשתמש שצוין ולאפליקציית Chat. כדי לכלול את השדה הזה בבקשה, צריך להפעיל את ה-API של Chat באמצעות אימות אפליקציות ולהשמיט את הפרטים הבאים: מידע נוסף מופיע במאמר על שליחת הודעה באופן פרטי. |
deletion_metadata |
פלט בלבד. מידע על הודעה שנמחקה. הודעה נמחקת כשמגדירים את |
quoted_message_metadata |
פלט בלבד. מידע על ההודעה שצוטטה על ידי משתמש ב-Google Chat במרחב משותף. משתמשי Google Chat יכולים לצטט הודעות כדי לענות להן. |
attached_gifs[] |
פלט בלבד. תמונות GIF שמצורפות להודעה. |
accessory_widgets[] |
ווידג'ט אינטראקטיבי אחד או יותר שמופיעים בחלק התחתון של הודעה. אפשר להוסיף ווידג'טים של אביזרים להודעות שמכילות טקסט, כרטיסים או גם טקסט וגם כרטיסים. אין תמיכה בהודעות שמכילות תיבות דו-שיח. לפרטים נוספים, ראו הוספת ווידג'טים אינטראקטיביים בתחתית הודעה. כדי ליצור הודעה עם ווידג'טים של אביזרים, צריך לבצע אימות אפליקציה. |
MessageBatchCreatedEventData
מטען ייעודי (payload) של אירוע עבור כמה הודעות חדשות.
סוג האירוע: google.workspace.chat.message.v1.batchCreated
שדות | |
---|---|
messages[] |
רשימה של הודעות חדשות. |
MessageBatchDeletedEventData
מטען ייעודי (payload) של אירוע עבור כמה הודעות שנמחקו.
סוג האירוע: google.workspace.chat.message.v1.batchDeleted
שדות | |
---|---|
messages[] |
רשימה של ההודעות שנמחקו. |
MessageBatchUpdatedEventData
מטען ייעודי (payload) של אירוע עבור מספר הודעות מעודכנות.
סוג האירוע: google.workspace.chat.message.v1.batchUpdated
שדות | |
---|---|
messages[] |
רשימה של הודעות שעודכנו. |
MessageCreatedEventData
מטען ייעודי (payload) של אירוע להודעה חדשה.
סוג האירוע: google.workspace.chat.message.v1.created
שדות | |
---|---|
message |
ההודעה החדשה. |
MessageDeletedEventData
מטען ייעודי (payload) של אירוע עבור הודעה שנמחקה.
סוג האירוע: google.workspace.chat.message.v1.deleted
שדות | |
---|---|
message |
ההודעה שנמחקה. רק השדות |
MessageUpdatedEventData
מטען ייעודי (payload) של אירוע להודעה מעודכנת.
סוג האירוע: google.workspace.chat.message.v1.updated
שדות | |
---|---|
message |
ההודעה המעודכנת. |
QuotedMessageMetadata
מידע על הודעה מצוטטת.
שדות | |
---|---|
name |
פלט בלבד. שם המשאב של ההודעה המצוטטת. פורמט: |
last_update_time |
פלט בלבד. חותמת הזמן של יצירת ההודעה המצוטטת או המועד האחרון שבו ההודעה המצוטטת עודכנה. |
תגובה
תגובה להודעה.
שדות | |
---|---|
name |
שם מקור המידע של התגובה. פורמט: |
user |
פלט בלבד. המשתמש שיצר את התגובה. |
emoji |
האמוג'י שנעשה בו שימוש בתגובה. |
ReactionBatchCreatedEventData
מטען ייעודי (payload) של אירוע שכולל מספר תגובות חדשות.
סוג האירוע: google.workspace.chat.reaction.v1.batchCreated
שדות | |
---|---|
reactions[] |
רשימה של תגובות חדשות. |
ReactionBatchDeletedEventData
מטען ייעודי (payload) של אירוע שכולל כמה תגובות שנמחקו.
סוג האירוע: google.workspace.chat.reaction.v1.batchDeleted
שדות | |
---|---|
reactions[] |
רשימה של התגובות שנמחקו. |
ReactionCreatedEventData
מטען ייעודי (payload) של אירוע לתגובה חדשה.
סוג האירוע: google.workspace.chat.reaction.v1.created
שדות | |
---|---|
reaction |
התגובה החדשה. |
ReactionDeletedEventData
מטען ייעודי (payload) של אירוע לתגובה שנמחקה.
סוג: google.workspace.chat.reaction.v1.deleted
שדות | |
---|---|
reaction |
התגובה שנמחקה. |
RichLinkMetadata
קישור עשיר למקור מידע.
שדות | |
---|---|
uri |
ה-URI של הקישור הזה. |
rich_link_type |
סוג קישור עשיר. |
שדה איחוד data . נתונים של המשאב המקושר. data יכול להיות רק אחת מהאפשרויות הבאות: |
|
drive_link_data |
נתוני קישור ל-Drive. |
chat_space_link_data |
נתונים של קישור למרחב ב-Chat. |
RichLinkType
סוג קישור עשיר. יכול להיות שיתווספו סוגים נוספים בעתיד.
טיפוסים בני מנייה (enum) | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
ערך ברירת המחדל של enum. אין להשתמש בו. |
DRIVE_FILE |
קישור מסוג 'עשיר' ב-Google Drive. |
CHAT_SPACE |
סוג קישור של מרחב משותף ב-Chat. למשל, צ'יפ חכם של מרחב. |
SearchSpacesRequest
בקשה לחיפוש רשימה של מרחבים משותפים על סמך שאילתה.
שדות | |
---|---|
use_admin_access |
כשהערך הוא המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים. נדרש היקף OAuth 2.0, השיטה הזו תומכת כרגע רק בהרשאת אדמין, ולכן אפשר להשתמש רק ב- |
page_size |
המספר המקסימלי של מרחבים שצריך להחזיר. ייתכן שהשירות יחזיר פחות מהערך הזה. אם לא צויין ערך, יוחזרו 100 רווחים לכל היותר. הערך המקסימלי הוא 1,000. אם משתמשים בערך שגבוה מ-1,000, הוא משתנה באופן אוטומטי ל-1,000. |
page_token |
אסימון שהתקבל מהקריאה הקודמת למרחבי החיפוש. צריך לספק את הפרמטר הזה כדי לאחזר את הדף הבא. במהלך החלוקה לדפים, כל הפרמטרים האחרים שצוינו צריכים להתאים לקריאה שסיפקה את אסימון הדף. העברה של ערכים שונים לפרמטרים האחרים עלולה להוביל לתוצאות בלתי צפויות. |
query |
חובה. שאילתת חיפוש. אפשר לבצע חיפוש באמצעות הפרמטרים הבאים:
השדה
הפונקציה השדה בשדות השונים, יש תמיכה רק באופרטורים באותו שדה, השאילתות לדוגמה הבאות תקינות:
|
order_by |
זה שינוי אופציונלי. לפי הסדר של רשימת המרחבים המשותפים המאפיינים שנתמכים לפי הסדר הם:
הערכים החוקיים של פעולת ההזמנה הם:
התחביר הנתמך הוא:
|
SearchSpacesResponse
תשובה עם רשימה של מרחבים שתואמים לבקשה של המרחבים המשותפים לחיפוש.
שדות | |
---|---|
spaces[] |
דף עם המרחבים המשותפים המבוקשים. |
next_page_token |
אסימון שאפשר להשתמש בו כדי לאחזר את הדף הבא. אם השדה הזה ריק, אין דפים נוספים. |
total_size |
המספר הכולל של הרווחים שתואמים לשאילתה, בכל הדפים. אם התוצאה היא יותר מ-10,000 רווחים, הערך הזה הוא אומדן. |
SetUpSpaceRequest
עליך לשלוח בקשה ליצור מרחב משותף ולהוסיף אליו את המשתמשים שצוינו.
שדות | |
---|---|
space |
חובה. השדה כדי ליצור מרחב משותף, צריך להגדיר את כדי ליצור צ'אט קבוצתי, צריך להגדיר את כדי ליצור שיחה אישית בין אנשים, צריך להגדיר את כדי ליצור שיחה אישית בין אנשים לבין אפליקציית Chat לשיחות, צריך להגדיר את אם כבר קיים מרחב משותף מסוג |
request_id |
זה שינוי אופציונלי. מזהה ייחודי לבקשה הזו. מומלץ להשתמש במזהה ייחודי אוניברסלי (UUID) אקראי. כשמציינים מזהה בקשה קיים, המערכת מחזירה את המרחב המשותף שנוצר עם המזהה הזה במקום ליצור מרחב חדש. אם מציינים מזהה בקשה קיים מאותה אפליקציית Chat עם משתמש מאומת אחר, תוחזר הודעת שגיאה. |
memberships[] |
זה שינוי אופציונלי. המשתמשים או הקבוצות ב-Google Chat שהוזמנתם להצטרף למרחב המשותף. אפשר להשמיט את המשתמש שמתקשר כי הוא מתווסף אוטומטית. הקבוצה מאפשרת כרגע עד 20 חברויות במועדון (בנוסף למבצע הקריאה). כדי להשתמש בתכונה אנושית, השדה עבור חברות בקבוצה ב-Google, השדה אופציונלי כשמגדירים את חובה כשמגדירים את חובה כשמגדירים את חובה להשאיר את השדה ריק כשיוצרים שיחה אישית בין אדם לבין אפליקציית Chat לשיחות (כשמגדירים את |
SlashCommand
פקודה עם קו נטוי ב-Google Chat.
שדות | |
---|---|
command_id |
המזהה של פקודת הלוכסן שהופעלה. |
SlashCommandMetadata
מטא-נתונים של הערות לפקודות לוכסן (/).
שדות | |
---|---|
bot |
אפליקציית Chat שבה הפקודה הופעל. |
type |
סוג הפקודה של שורת הפקודות. |
command_name |
השם של פקודת הלוכסן שהופעלה. |
command_id |
מזהה הפקודה של פקודת הלוכסן שהופעלה. |
triggers_dialog |
מציין אם הפקודה של הקו הנטוי מיועדת לתיבת דו-שיח. |
סוג
טיפוסים בני מנייה (enum) | |
---|---|
TYPE_UNSPECIFIED |
ערך ברירת המחדל של enum. אין להשתמש בו. |
ADD |
צירוף אפליקציית Chat למרחב המשותף. |
INVOKE |
הפעלת פקודה של שורת הפקודות במרחב. |
רווח
מרחב משותף ב-Google Chat. מרחבים הם בעצם שיחות בין שני משתמשים או יותר, או צ'אטים אישיים בין משתמש לבין אפליקציית Chat.
שדות | |
---|---|
name |
שם המשאב של המרחב המשותף. פורמט:
|
type |
פלט בלבד. הוצא משימוש: במקומו צריך להשתמש ברכיב |
space_type |
סוג המרחב. חובה כשיוצרים מרחב משותף או כשמשנים את הסוג של המרחב המשותף. פלט עבור שימוש אחר בלבד. |
single_user_bot_dm |
זה שינוי אופציונלי. האם המרחב המשותף הוא צ'אט בין אפליקציית Chat לבין אדם אחד? |
threaded |
פלט בלבד. הוצא משימוש: במקומו צריך להשתמש ברכיב |
display_name |
השם המוצג של המרחב המשותף. חובה כשיוצרים מרחב עם אם מדובר בצ'אטים אישיים, יכול להיות שהשדה הזה יהיה ריק. אפשר להזין עד 128 תווים. |
external_user_allowed |
בלתי ניתן לשינוי. האם המרחב המשותף הזה מאפשר לכל משתמש ב-Google Chat להצטרף אליו. צריך להזין כאן את הפרטים כשיוצרים מרחב משותף ב-Google Workspace. יש להשמיט את השדה הזה כשיוצרים רווחים בתנאים הבאים:
במרחבים משותפים קיימים, השדה הזה משמש רק כפלט. |
space_threading_state |
פלט בלבד. מצב השרשור במרחב ב-Chat. |
space_details |
פרטים על המרחב המשותף, כולל תיאור וכללים. |
space_history_state |
המצב של היסטוריית ההודעות של ההודעות והשרשורים במרחב המשותף. |
import_mode |
זה שינוי אופציונלי. האם המרחב המשותף הזה נוצר באפליקציה |
create_time |
זה שינוי אופציונלי. בלתי ניתן לשינוי. מידע על מרחבים משותפים שנוצרו ב-Chat: השדה הזה הוא פלט בלבד, חוץ מבמקרים שבהם נעשה בו שימוש במרחבים משותפים של מצב ייבוא. במרחבים משותפים של מצב ייבוא, צריך להגדיר את השדה הזה כחותמת הזמן ההיסטורית שבה המרחב המשותף נוצר במקור כדי שזמן היצירה המקורי יישמר. השדה הזה מאוכלס רק בפלט כשהערך של |
last_active_time |
פלט בלבד. חותמת הזמן של ההודעה האחרונה במרחב המשותף. |
admin_installed |
פלט בלבד. במרחבים משותפים בצ'אטים אישיים באפליקציית Chat, לא משנה אם האדמין ב-Google Workspace יצר את המרחב המשותף. אדמינים יכולים להתקין ולהגדיר צ'אט אישי עם אפליקציית Chat בשם המשתמשים בארגון שלהם. כדי לתמוך בהתקנה של אדמין, אפליקציית Chat צריכה לכלול צ'אט אישי. |
membership_count |
פלט בלבד. מספר החברויות במועדון שהצטרפו לפי סוג החבר. מאוכלס כשהערך בשדה |
access_settings |
זה שינוי אופציונלי. כאן קובעים את הגדרת הגישה של המרחב המשותף. השדה הזה מאוכלס רק כשהערך של |
space_uri |
פלט בלבד. ה-URI של המשתמש לגישה למרחב המשותף. |
שדה איחוד space_permission_settings . השדה הזה מייצג את הגדרות ההרשאות של המרחב המשותף. השדה הזה מאוכלס רק כשהערך של space_type הוא SPACE . space_permission_settings יכול להיות רק אחת מהאפשרויות הבאות: |
|
predefined_permission_settings |
זה שינוי אופציונלי. קלט בלבד. הגדרות ההרשאות במרחב המשותף. אם השדה הזה לא מוגדר, ייווצר מרחב משותף ליצירת מרחב משותף. אחרי שיוצרים את המרחב, ההגדרות יאוכלסו בשדה |
permission_settings |
זה שינוי אופציונלי. הגדרות ההרשאות המדויקות שאפשר להגדיר כדי לעדכן את המרחב המשותף. תיבת טקסט לעדכון המרחב המשותף. אחרת, יתבצע רק פלט. ליצירת מרחב משותף, צריך להשתמש ב- |
AccessSettings
הגדרת הגישה של המרחב המשותף.
שדות | |
---|---|
access_state |
פלט בלבד. מצב הגישה של המרחב המשותף. |
audience |
זה שינוי אופציונלי. שם המשאב של קהל היעד, שיכול לגלות את המרחב המשותף, להצטרף אליו ולראות תצוגה מקדימה של ההודעות במרחב המשותף. אם המדיניות לא מוגדרת, רק משתמשים וקבוצות Google שהוזמנו או נוספו למרחב המשותף בנפרד יכולים לגשת אליו. מידע נוסף מופיע במאמר הגדרת מרחב משותף שגלוי לקהל יעד. פורמט: כדי להשתמש בקהל היעד שמוגדר כברירת מחדל לארגון ב-Google Workspace, צריך להגדיר את הערך |
AccessState
מצב הגישה של המרחב המשותף.
טיפוסים בני מנייה (enum) | |
---|---|
ACCESS_STATE_UNSPECIFIED |
מצב הגישה לא ידוע או שהוא לא נתמך ב-API הזה. |
PRIVATE |
רק משתמשים וקבוצות ב-Google שנוספו או הוזמנו על ידי משתמשים אחרים או אדמינים ב-Google Workspace יכולים למצוא את המרחב המשותף ולגשת אליו. |
DISCOVERABLE |
אחד ממנהלי המרחב המשותף העניק לקהל היעד גישה למרחב המשותף. גם משתמשים וקבוצות Google שנוספו או הוזמנו למרחב המשותף בנפרד יכולים למצוא אותו ולגשת אליו. מידע נוסף זמין במאמר איך מגדירים מרחב משותף כגלוי למשתמשים ספציפיים. |
MembershipCount
שדות | |
---|---|
joined_direct_human_user_count |
מספר המשתמשים האנושיים שהצטרפו ישירות למרחב המשותף, ללא ספירה של משתמשים שהצטרפו באמצעות חברות בקבוצה שהצטרפתם אליה. |
joined_group_count |
מספר הקבוצות שהצטרפו ישירות למרחב המשותף. |
PermissionSetting
מייצג הגדרה של הרשאה למרחב.
שדות | |
---|---|
managers_allowed |
אם למנהלים של המרחבים המשותפים יש את ההרשאה הזו. |
members_allowed |
האם למשתמשים שהם לא בעלי חשבון ניהול יש את ההרשאה הזו. |
PermissionSettings
הגדרות ההרשאות למרחב משותף עם שם. כדי לקבוע את ההגדרות של ההרשאות כשיוצרים מרחב משותף, צריך לציין את השדה PredefinedPermissionSettings
בבקשה.
שדות | |
---|---|
manage_members_and_groups |
הגדרה לניהול רשימת המשתתפים והקבוצות במרחב המשותף. |
modify_space_details |
הגדרה לעדכון השם, הדמות, התיאור וההנחיות של המרחב המשותף. |
toggle_history |
הגדרה להפעלה ולהשבתה של ההיסטוריה של המרחב המשותף. |
use_at_mention_all |
הגדרה לשימוש בתיוג @כולם במרחב המשותף. |
manage_apps |
הגדרה לניהול האפליקציות במרחב המשותף. |
manage_webhooks |
הגדרה לניהול ה-webhooks במרחבים משותפים. |
post_messages |
פלט בלבד. הגדרה לפרסום הודעות במרחב. |
reply_messages |
הגדרה של מענה להודעות במרחב המשותף. |
PredefinedPermissionSettings
הגדרות ההרשאות של המרחב המשותף שאפשר לקבוע כשיוצרים מרחב משותף עם שם. יכול להיות שיתווספו הגדרות נוספות בעתיד. למידע נוסף על ההגדרות של ההרשאות למרחבים משותפים עם שם, אפשר לעיין במאמר מידע על מרחבים משותפים.
טיפוסים בני מנייה (enum) | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
לא צוין. אין להשתמש בו. |
COLLABORATION_SPACE |
הגדרה זו הופכת את המרחב המשותף למרחב משותף שבו כל המשתתפים יכולים לפרסם הודעות. |
ANNOUNCEMENT_SPACE |
הגדרת המרחב המשותף הזה כמרחב הודעות שבו רק מנהלי המרחב המשותף יכולים לפרסם הודעות. |
SpaceDetails
פרטים על המרחב המשותף, כולל תיאור וכללים.
שדות | |
---|---|
description |
זה שינוי אופציונלי. תיאור של המרחב המשותף. למשל, אפשר לתאר את נושא השיחה, המטרה התפעולית או רשימת המשתתפים במרחב המשותף. אפשר להזין עד 150 תווים. |
guidelines |
זה שינוי אופציונלי. הכללים, הציפיות והנימוסים של המרחב. אפשר להזין עד 5,000 תווים. |
SpaceThreadingState
ההגדרה קובעת את סוג השרשור במרחב ב-Chat.
טיפוסים בני מנייה (enum) | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
שמור. |
THREADED_MESSAGES |
מרחבים משותפים עם שם שתומכים בשרשורי הודעות. כשמשתמשים מגיבים להודעה, הם יכולים להשיב בשרשור, והתשובה שלהם נשארת בהקשר של ההודעה המקורית. |
GROUPED_MESSAGES |
במרחבים משותפים עם שמות שבהם השיחות מחולקות לפי נושאים. הנושאים והתשובות שלהם מקובצים יחד. |
UNTHREADED_MESSAGES |
צ'אטים אישיים בין שני אנשים ושיחות קבוצתיות בין 3 אנשים או יותר. |
SpaceType
סוג המרחב. חובה כשיוצרים או מעדכנים מרחב משותף. פלט עבור שימוש אחר בלבד.
טיפוסים בני מנייה (enum) | |
---|---|
SPACE_TYPE_UNSPECIFIED |
שמור. |
SPACE |
מקום שבו אנשים שולחים הודעות, משתפים קבצים ועובדים יחד. SPACE יכול לכלול אפליקציות צ'אט. |
GROUP_CHAT |
שיחות קבוצתיות עם 3 אנשים או יותר. GROUP_CHAT יכול לכלול אפליקציות צ'אט. |
DIRECT_MESSAGE |
צ'אטים אישיים בין שני אנשים או בין שני אנשים לבין אפליקציית Chat. |
סוג
הוצא משימוש: במקומו צריך להשתמש ברכיב SpaceType
.
טיפוסים בני מנייה (enum) | |
---|---|
TYPE_UNSPECIFIED |
שמור. |
ROOM |
שיחות בין שני אנשים או יותר. |
DM |
צ'אט אישי בין משתמשים לבין אפליקציית Chat, שבה כל ההודעות הן שטוחות. שימו לב שהנושא הזה לא כולל צ'אטים אישיים בין שני בני אדם. |
SpaceBatchUpdatedEventData
מטען ייעודי (payload) של אירוע שכולל כמה עדכונים במרחב המשותף.
סוג האירוע: google.workspace.chat.space.v1.batchUpdated
שדות | |
---|---|
spaces[] |
רשימה של המרחבים המשותפים שעודכנו |
SpaceEvent
אירוע שמייצג שינוי או פעילות במרחב משותף ב-Google Chat. מידע נוסף זמין במאמר עבודה עם אירועים מ-Google Chat.
שדות | |
---|---|
name |
שם המשאב של האירוע במרחב המשותף. פורמט: |
event_time |
השעה שבה האירוע התרחש. |
event_type |
סוג האירוע במרחב. לכל סוג אירוע יש גרסה באצווה, שמייצגת כמה מופעים של סוג האירוע שמתרחשים בפרק זמן קצר. בבקשות ל- סוגי האירועים הנתמכים של הודעות:
סוגי האירועים הנתמכים של מועדון החברים:
סוגי האירועים שנתמכים בתגובות:
סוגי האירועים הנתמכים במרחב:
|
שדה איחוד
|
|
message_created_event_data |
מטען ייעודי (payload) של אירוע להודעה חדשה. סוג האירוע: |
message_updated_event_data |
עומס העבודה של האירוע עבור הודעה מעודכנת. סוג האירוע: |
message_deleted_event_data |
מטען ייעודי (payload) של אירוע עבור הודעה שנמחקה. סוג האירוע: |
message_batch_created_event_data |
מטען ייעודי (payload) של אירוע עבור כמה הודעות חדשות. סוג האירוע: |
message_batch_updated_event_data |
מטען ייעודי (payload) של אירוע עבור מספר הודעות מעודכנות. סוג האירוע: |
message_batch_deleted_event_data |
מטען ייעודי (payload) של אירוע עבור כמה הודעות שנמחקו. סוג האירוע: |
space_updated_event_data |
מטען ייעודי (payload) של אירוע לעדכון המרחב המשותף. סוג האירוע: |
space_batch_updated_event_data |
מטען ייעודי (payload) של אירוע שכולל כמה עדכונים במרחב המשותף. סוג האירוע: |
membership_created_event_data |
מטען ייעודי (payload) של אירוע למינוי חדש. סוג האירוע: |
membership_updated_event_data |
נתוני עומס האירוע של מינוי מעודכן. סוג האירוע: |
membership_deleted_event_data |
מטען ייעודי (payload) של אירוע למינוי שנמחק. סוג האירוע: |
membership_batch_created_event_data |
מטען ייעודי (payload) של אירוע לכמה חברויות חדשות. סוג האירוע: |
membership_batch_updated_event_data |
מטען ייעודי (payload) של אירוע שכולל מספר מינויים מעודכנים. סוג האירוע: |
membership_batch_deleted_event_data |
מטען ייעודי (payload) של אירוע שכולל כמה מינויים שנמחקו. סוג האירוע: |
reaction_created_event_data |
מטען ייעודי (payload) של אירוע לתגובה חדשה. סוג האירוע: |
reaction_deleted_event_data |
מטען ייעודי (payload) של אירוע לתגובה שנמחקה. סוג האירוע: |
reaction_batch_created_event_data |
מטען ייעודי (payload) של אירוע שכולל מספר תגובות חדשות. סוג האירוע: |
reaction_batch_deleted_event_data |
מטען ייעודי (payload) של אירוע שכולל כמה תגובות שנמחקו. סוג האירוע: |
SpaceReadState
מצב הקריאה של המשתמש במרחב משותף, שמשמש לזיהוי הודעות שנקראו ושלא נקראו.
שדות | |
---|---|
name |
שם המשאב של מצב הקריאה של המרחב. פורמט: |
last_read_time |
זה שינוי אופציונלי. השעה שבה עודכן מצב הקריאה במרחב של המשתמש. בדרך כלל, הערך הזה תואם לחותמת הזמן של ההודעה האחרונה שנקראה או לחותמת זמן שהמשתמש ציין כדי לסמן את המיקום האחרון שנקרא במרחב. |
SpaceUpdatedEventData
מטען ייעודי (payload) של אירוע למרחב משותף מעודכן.
סוג האירוע: google.workspace.chat.space.v1.updated
שדות | |
---|---|
space |
המרחב המשותף המעודכן. |
שרשור
שרשור במרחב משותף ב-Google Chat. לדוגמה, שימוש בקטע התחלת שרשור הודעות או מענה לשרשורים.
אם אתם מציינים שרשור בזמן יצירת הודעה, תוכלו להגדיר את השדה messageReplyOption
כדי לקבוע מה יקרה אם לא נמצא שרשור תואם.
שדות | |
---|---|
name |
שם המשאב של השרשור. לדוגמה: |
thread_key |
זה שינוי אופציונלי. תיבת טקסט ליצירה או לעדכון של שרשור. אחרת, יתבצע רק פלט. מזהה השרשור. אפשר להזין עד 4,000 תווים. המזהה הזה ייחודי לאפליקציית Chat שמגדירה אותו. לדוגמה, אם כמה אפליקציות של Chat יוצרות הודעה עם אותו מפתח שרשור, ההודעות יפורסמו בשרשורים שונים. כדי לענות בשרשור שנוצרו על ידי מישהו או אפליקציית Chat אחרת, צריך לציין את השדה |
ThreadReadState
מצב הקריאה של משתמש בשרשור, שמשמש לזיהוי הודעות שנקראו ושלא נקראו.
שדות | |
---|---|
name |
שם המשאב של מצב הקריאה של השרשור. פורמט: |
last_read_time |
השעה שבה עודכן מצב הקריאה בשרשור של המשתמש. בדרך כלל הנתון הזה תואם לחותמת הזמן של ההודעה האחרונה שנקראה בשרשור. |
UpdateMembershipRequest
שליחת בקשה לעדכון מינוי.
שדות | |
---|---|
membership |
חובה. המינוי שצריך לעדכן. רק שדות שצוינו על ידי |
update_mask |
חובה. הנתיבים של השדות לעדכון. צריך להפריד בין ערכים באמצעות פסיקים או להשתמש בפונקציה נתיבי השדות שנתמכים כרגע:
|
use_admin_access |
true , השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים. נדרש היקף OAuth 2.0 |
UpdateMessageRequest
מבקשים לעדכן הודעה.
שדות | |
---|---|
message |
חובה. ההודעה בשדות עודכנו. |
update_mask |
חובה. הנתיבים של השדות לעדכון. צריך להפריד בין ערכים באמצעות פסיקים או להשתמש בפונקציה נתיבי השדות שנתמכים כרגע:
|
allow_missing |
זה שינוי אופציונלי. אם |
UpdateSpaceReadStateRequest
הודעת בקשה ל-UpdateSpaceReadState API.
שדות | |
---|---|
space_read_state |
חובה. מצב הקריאה של המרחב המשותף והשדות שצריך לעדכן. התכונה תומכת רק בעדכון מצב הקריאה של המשתמש המתקשר. כדי להפנות למשתמש שהתקשרו אליו, תוכלו להגדיר אחת מהאפשרויות הבאות:
פורמט: users/{user}/spaces/{space}/spaceReadState |
update_mask |
חובה. הנתיבים של השדות לעדכון. נתיבי השדות שנתמכים כרגע:
כשההודעה כדי לסמן שהמרחב המשותף נקרא, צריך להגדיר את |
UpdateSpaceRequest
בקשה לעדכון של מרחב משותף אחד.
שדות | |
---|---|
space |
חובה. מרחב עם שדות לעדכון. צריך לאכלס את השדה |
update_mask |
חובה. נתיבי השדות המעודכנים, מופרדים בפסיקים אם יש יותר. אתם יכולים לעדכן את השדות הבאים במרחב משותף:
|
use_admin_access |
true , השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים. נדרש היקף OAuth 2.0 חלק מהערכים של |
משתמש
משתמש ב-Google Chat. כשמוחזר מפלט כפלט מבקשה, אם אפליקציית Chat ביצעה אימות כמשתמש, הפלט של המשאב User
יאכלס רק את ה-name
וה-type
של המשתמש.
שדות | |
---|---|
name |
השם של משאב פורמט: עבור
|
display_name |
פלט בלבד. השם המוצג של המשתמש. |
domain_id |
המזהה הייחודי של הדומיין של המשתמש ב-Google Workspace. |
type |
סוג המשתמש. |
is_anonymous |
פלט בלבד. כאשר |
סוג
טיפוסים בני מנייה (enum) | |
---|---|
TYPE_UNSPECIFIED |
ערך ברירת המחדל של enum. אין להשתמש בו. |
HUMAN |
משתמש אנושי. |
BOT |
משתמש באפליקציית Chat. |
UserMentionMetadata
מטא-נתונים של הערות לאזכורי משתמשים (@).
שדות | |
---|---|
user |
המשתמש ציין. |
type |
סוג האזכור של המשתמש. |
סוג
טיפוסים בני מנייה (enum) | |
---|---|
TYPE_UNSPECIFIED |
ערך ברירת המחדל של enum. אין להשתמש בו. |
ADD |
הוספת משתמש למרחב המשותף |
MENTION |
הוספת אזכור של משתמש במרחב המשותף. |
WidgetMarkup
ווידג'ט הוא רכיב בממשק המשתמש שמוצגים בו טקסט ותמונות.
שדות | |
---|---|
buttons[] |
רשימת לחצנים. גם הלחצנים הם |
שדה איחוד data . WidgetMarkup יכול להכיל רק אחד מהפריטים הבאים. אפשר להשתמש בכמה שדות של WidgetMarkup כדי להציג יותר פריטים. data יכול להיות רק אחת מהאפשרויות הבאות: |
|
text_paragraph |
הצגה של פסקה טקסט בווידג'ט הזה. |
image |
הצגת תמונה בווידג'ט הזה. |
key_value |
הצגה של פריט בעל ערך מרכזי בווידג'ט הזה. |
לחצן
לחצן. אפשר להשתמש בלחצן טקסט או בלחצן תמונה.
שדות | |
---|---|
שדה איחוד
|
|
text_button |
לחצן עם טקסט והפעולה |
image_button |
לחצן עם תמונה ופעולה |
FormAction
פעולת הטופס מתארת את ההתנהגות בזמן שליחת הטופס. לדוגמה, אפשר להפעיל את Apps Script כדי לטפל בטופס.
שדות | |
---|---|
action_method_name |
שם השיטה משמש לזיהוי החלק בטופס שהפעיל את שליחת הטופס. המידע הזה יוחזר לאפליקציית Chat כחלק מאירוע הקליק על הכרטיס. אפשר להשתמש באותו שם שיטה למספר רכיבים שמפעילים התנהגות נפוצה. |
parameters[] |
רשימת פרמטרים של פעולות. |
ActionParameter
רשימת הפרמטרים של המחרוזת שיש לספק כששיטת הפעולה מופעלת. לדוגמה, שימו לב לשלושה לחצני 'נודניק': 'נודניק', 'נודניק' ביום אחד, 'לטיפול בהמשך' בשבוע הבא. אפשר להשתמש בפונקציה action method = snooze()
כדי לקבוע את סוג הנודניק ואת משך ההפעלה לטיפול בהמשך ברשימת הפרמטרים למחרוזות.
שדות | |
---|---|
key |
שם הפרמטר לסקריפט הפעולה. |
value |
ערך הפרמטר. |
סמל
קבוצת הסמלים הנתמכים.
טיפוסים בני מנייה (enum) | |
---|---|
ICON_UNSPECIFIED |
|
AIRPLANE |
|
BOOKMARK |
|
BUS |
|
CAR |
|
CLOCK |
|
CONFIRMATION_NUMBER_ICON |
|
DOLLAR |
|
DESCRIPTION |
|
EMAIL |
|
EVENT_PERFORMER |
|
EVENT_SEAT |
|
FLIGHT_ARRIVAL |
|
FLIGHT_DEPARTURE |
|
HOTEL |
|
HOTEL_ROOM_TYPE |
|
INVITE |
|
MAP_PIN |
|
MEMBERSHIP |
|
MULTIPLE_PEOPLE |
|
OFFER |
|
PERSON |
|
PHONE |
|
RESTAURANT_ICON |
|
SHOPPING_CART |
|
STAR |
|
STORE |
|
TICKET |
|
TRAIN |
|
VIDEO_CAMERA |
|
VIDEO_PLAY |
תמונה
תמונה שצוינה בכתובת URL ויכולה לכלול פעולה onclick
.
שדות | |
---|---|
image_url |
כתובת האתר של התמונה. |
on_click |
הפעולה |
aspect_ratio |
יחס הגובה-רוחב של התמונה הזו (רוחב וגובה). בשדה הזה אפשר לשמור את הגובה המתאים של התמונה בזמן שממתינים לטעינת התמונה. אין לשנות את יחס הגובה-רוחב המובנה של התמונה. אם המדיניות לא מוגדרת, השרת ממלא אותה על ידי אחזור מראש של התמונה. |
ImageButton
לחצן תמונה עם פעולה onclick
.
שדות | |
---|---|
on_click |
הפעולה |
name |
השם של |
שדה איחוד icons . אפשר לציין את הסמל באמצעות Icon enum או כתובת URL. icons יכול להיות רק אחת מהאפשרויות הבאות: |
|
icon |
הסמל שצוין ב- |
icon_url |
הסמל שצוין על ידי כתובת URL. |
KeyValue
רכיב בממשק המשתמש מכיל מפתח (תווית) וערך (תוכן). הרכיב הזה יכול גם להכיל כמה פעולות, כמו לחצן onclick
.
שדות | |
---|---|
top_label |
הטקסט של התווית העליונה. יש תמיכה בטקסט מעוצב. למידע נוסף על עיצוב טקסט, תוכלו לקרוא את המאמרים עיצוב טקסט באפליקציות ב-Google Chat ועיצוב טקסט בתוספים ל-Google Workspace. |
content |
הטקסט של התוכן. יש תמיכה בטקסט מעוצב ותמיד נדרש. למידע נוסף על עיצוב טקסט, תוכלו לקרוא את המאמרים עיצוב טקסט באפליקציות ב-Google Chat ועיצוב טקסט בתוספים ל-Google Workspace. |
content_multiline |
אם התוכן צריך להיות מרובה שורות. |
bottom_label |
הטקסט של התווית התחתונה. יש תמיכה בטקסט מעוצב. למידע נוסף על עיצוב טקסט, תוכלו לקרוא את המאמרים עיצוב טקסט באפליקציות ב-Google Chat ועיצוב טקסט בתוספים ל-Google Workspace. |
on_click |
הפעולה |
שדה איחוד icons . יש להגדיר לפחות סמל אחד, top_label ו-bottom_label . icons יכול להיות רק אחת מהאפשרויות הבאות: |
|
icon |
ערך enum שמוחלף ב-Chat API עם תמונת הסמל המתאימה. |
icon_url |
הסמל שצוין על ידי כתובת URL. |
שדה איחוד control . ווידג'ט בקרה. אפשר להגדיר button או switch_widget , אבל לא את שניהם. control יכול להיות רק אחת מהאפשרויות הבאות: |
|
button |
לחצן שניתן ללחוץ עליו כדי להפעיל פעולה. |
OnClick
פעולת onclick
(לדוגמה, פתיחת קישור).
שדות | |
---|---|
שדה איחוד
|
|
action |
פעולת ה |
open_link |
פעולת |
OpenLink
קישור שפותח חלון חדש.
שדות | |
---|---|
url |
כתובת ה-URL לפתיחה. |
TextButton
לחצן עם טקסט והפעולה onclick
.
שדות | |
---|---|
text |
הטקסט של הלחצן. |
on_click |
הפעולה |
TextParagraph
פסקת טקסט. יש תמיכה בטקסט מעוצב. למידע נוסף על עיצוב טקסט, תוכלו לקרוא את המאמרים עיצוב טקסט באפליקציות ב-Google Chat ועיצוב טקסט בתוספים ל-Google Workspace.
שדות | |
---|---|
text |
|