אינדקס
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
(הודעה)CreateCustomEmojiRequest
(הודעה)CreateMembershipRequest
(הודעה)CreateMessageRequest
(הודעה)CreateMessageRequest.MessageReplyOption
(enum)CreateReactionRequest
(הודעה)CreateSpaceRequest
(הודעה)CustomEmoji
(הודעה)CustomEmoji.CustomEmojiPayload
(הודעה)DeleteCustomEmojiRequest
(הודעה)DeleteMembershipRequest
(הודעה)DeleteMessageRequest
(הודעה)DeleteReactionRequest
(הודעה)DeleteSpaceRequest
(הודעה)DeletionMetadata
(הודעה)DeletionMetadata.DeletionType
(enum)Dialog
(הודעה)DialogAction
(הודעה)DriveDataRef
(הודעה)DriveLinkData
(הודעה)Emoji
(הודעה)EmojiReactionSummary
(הודעה)FindDirectMessageRequest
(הודעה)GetAttachmentRequest
(הודעה)GetCustomEmojiRequest
(הודעה)GetMembershipRequest
(הודעה)GetMessageRequest
(הודעה)GetSpaceEventRequest
(הודעה)GetSpaceNotificationSettingRequest
(הודעה)GetSpaceReadStateRequest
(הודעה)GetSpaceRequest
(הודעה)GetThreadReadStateRequest
(הודעה)Group
(הודעה)HistoryState
(enum)ListCustomEmojisRequest
(הודעה)ListCustomEmojisResponse
(הודעה)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
(הודעה)SpaceNotificationSetting
(הודעה)SpaceNotificationSetting.MuteSetting
(enum)SpaceNotificationSetting.NotificationSetting
(enum)SpaceReadState
(הודעה)SpaceUpdatedEventData
(הודעה)Thread
(הודעה)ThreadReadState
(הודעה)UpdateMembershipRequest
(הודעה)UpdateMessageRequest
(הודעה)UpdateSpaceNotificationSettingRequest
(הודעה)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 לייבא נתונים.
|
CreateCustomEmoji |
---|
נדרש אימות משתמש.
|
CreateMembership |
---|
יוצרת חברות באפליקציית Chat שבה מתבצעת השיחה, במשתמש או בקבוצת Google. אין תמיכה ביצירת מועדוני חברים באפליקציות אחרות של Chat. כשיוצרים חברות, אם המדיניות של החבר הספציפי היא 'לא לאשר אוטומטית', הוא יקבל הזמנה והוא יצטרך לאשר את ההזמנה למרחב המשותף כדי להצטרף אליו. אחרת, יצירת מינוי תוסיף את המשתמש ישירות למרחב המשותף שצוין. יש תמיכה בסוגי אימות הבאים:
דוגמאות לשימוש:
|
CreateMessage |
---|
יצירת הודעה במרחב משותף ב-Google Chat. לדוגמה, ראו שליחת הודעה. בשיטה בתמונה הבאה אפשר לראות איך Chat משייך הודעה כשמשתמשים באימות באפליקציה. ב-Chat מוצגת אפליקציית Chat כשולח ההודעה. תוכן ההודעה יכול לכלול טקסט ( בתמונה הבאה אפשר לראות איך מערכת Chat משייכת הודעה כשמשתמשים באימות משתמשים. ב-Chat, המשתמש מוצג כשולח ההודעה, והשם של אפליקציית Chat מוצג בהודעה כדי לשייך אותה לאפליקציה. תוכן ההודעה יכול להכיל רק טקסט ( הגודל המקסימלי של הודעה, כולל תוכן ההודעה, הוא 32,000 בייטים.
|
CreateReaction |
---|
יוצרים תגובה ומוסיפים אותה להודעה. יש תמיכה רק באמוג'י של Unicode. לדוגמה, ראו הוספת תגובה להודעה. נדרש אימות משתמש.
|
CreateSpace |
---|
יצירת מרחב משותף. אפשר להשתמש בה כדי ליצור מרחב משותף או צ'אט קבוצתי ב- יש תמיכה בסוגי אימות הבאים: כשמבצעים אימות כאפליקציה, צריך להגדיר את השדה החברים במרחב המשותף בזמן היצירה שלו תלויים במקום שבו הוא נוצר ב-
אם מופיעה הודעת השגיאה
|
DeleteCustomEmoji |
---|
נדרש אימות משתמש.
|
DeleteMembership |
---|
מחיקה של מינוי. לדוגמה, אפשר לעיין במאמר הסרת משתמש או אפליקציית Google Chat ממרחב משותף. יש תמיכה בסוגי אימות הבאים:
|
DeleteMessage |
---|
מחיקת הודעה. דוגמה לכך מופיעה במאמר מחיקת הודעה. יש תמיכה בסוגי אימות הבאים: כשמשתמשים באימות אפליקציה, הבקשות יכולות למחוק רק הודעות שנוצרו על ידי אפליקציית Chat שבה מתבצעת הקריאה.
|
DeleteReaction |
---|
מחיקת תגובה להודעה. יש תמיכה רק באמוג'י של Unicode. דוגמה לכך מופיעה במאמר מחיקת תגובה. נדרש אימות משתמש.
|
DeleteSpace |
---|
מחיקה של מרחב משותף בעל שם. תמיד מתבצע מחיקה מדורגת, כלומר גם המשאבים הצאצאים של המרחב המשותף – כמו הודעות שפורסמו במרחב המשותף והרשאות החברות במרחב המשותף – נמחקים. דוגמה לכך מופיעה במאמר מחיקה של מרחב משותף. יש תמיכה בסוגי האימות הבאים:
|
FindDirectMessage |
---|
הפונקציה מחזירה את הצ'אט האישי הקיים עם המשתמש שצוין. אם לא נמצא מקום בצ'אט האישי, הפונקציה מחזירה את השגיאה עם אימות אפליקציה, הפונקציה מחזירה את המרחב של הצ'אט האישי בין המשתמש שצוין לבין אפליקציית Chat שבה מתבצעת הקריאה. עם אימות משתמש, הפונקציה מחזירה את המרחב של הצ'אט הישיר בין המשתמש שצוין לבין המשתמש המאומת. // יש תמיכה בסוגי אימות הבאים:
|
GetAttachment |
---|
אחזור המטא-נתונים של קובץ מצורף להודעה. אחזור נתוני הקובץ המצורף מתבצע באמצעות media API. דוגמה לכך מופיעה במאמר קבלת מטא-נתונים על קובץ מצורף להודעה. נדרש אימות אפליקציה.
|
GetCustomEmoji |
---|
נדרש אימות משתמש.
|
GetMembership |
---|
הפונקציה מחזירה פרטים על מינוי. דוגמה לכך מופיעה במאמר איך מקבלים פרטים על המינוי של משתמש או של אפליקציית Google Chat. יש תמיכה בסוגי אימות הבאים:
|
GetMessage |
---|
הפונקציה מחזירה פרטים על הודעה. דוגמה לכך מופיעה במאמר איך מוצאים פרטים על הודעה. יש תמיכה בסוגי האימות הבאים: הערה: יכול להיות שתקבלו הודעה ממשתמש או ממרחב משותף שחסמתם.
|
GetSpace |
---|
הפונקציה מחזירה פרטים על מרחב משותף. דוגמה לכך מופיעה במאמר הצגת פרטים על מרחבים משותפים. יש תמיכה בסוגי אימות הבאים:
|
GetSpaceEvent |
---|
הפונקציה מחזירה אירוע ממרחבים משותפים ב-Google Chat. המטען הייעודי (Payload) של האירוע מכיל את הגרסה האחרונה של המשאב שהשתנה. לדוגמה, אם מבקשים אירוע לגבי הודעה חדשה אבל ההודעה עודכנה מאוחר יותר, השרת מחזיר את המשאב המעודכן הערה: השדה נדרש אימות משתמש. כדי לקבל אירוע, המשתמש המאומת צריך להיות חבר במרחב המשותף. דוגמה לכך מופיעה במאמר איך רואים פרטים על אירוע במרחב משותף ב-Google Chat.
|
GetSpaceNotificationSetting |
---|
נדרש אימות משתמש.
|
GetSpaceReadState |
---|
הפונקציה מחזירה פרטים על מצב הקריאה של משתמש במרחב משותף, ומשמשת לזיהוי הודעות שקראתם והודעות שעדיין לא קראתם. דוגמה לכך מופיעה במאמר איך מקבלים פרטים על סטטוס הקריאה של משתמש במרחב משותף. נדרש אימות משתמש.
|
GetThreadReadState |
---|
הפונקציה מחזירה פרטים על מצב הקריאה של המשתמש בשרשור, ומשמשת לזיהוי הודעות שנקראו והודעות שלא נקראו. דוגמה לכך מופיעה במאמר איך מקבלים פרטים על מצב הקריאה של משתמש בשרשור. נדרש אימות משתמש.
|
ListCustomEmojis |
---|
נדרש אימות משתמש.
|
ListMemberships |
---|
הצגת רשימה של החברים במרחב המשותף. דוגמה לכך מופיעה במאמר הצגת רשימה של משתמשים ואפליקציות ב-Google Chat במרחב משותף. כשמציגים את החברים באמצעות אימות אפליקציה, מוצגים החברים במרחבים משותפים שיש לאפליקציית Chat גישה אליהם, אבל לא החברים באפליקציית Chat, כולל החברים באפליקציה הזו. כשמציגים את החברויות באמצעות אימות משתמשים, מוצגות החברויות במרחבים המשותפים שלמשתמש המאומת יש גישה אליהם. יש תמיכה בסוגי אימות הבאים:
|
ListMessages |
---|
הצגת הודעות במרחב משותף שהמבצע של הקריאה הוא חבר בו, כולל הודעות מחברים וממרחבים חסומים. אם תציגו רשימה של הודעות ממרחב משותף בלי הודעות, התגובה תהיה אובייקט ריק. כשמשתמשים בממשק REST/HTTP, התגובה מכילה אובייקט JSON ריק, נדרש אימות משתמש.
|
ListReactions |
---|
רשימת התגובות להודעה. דוגמה לכך מופיעה במאמר הצגת רשימת התגובות להודעה. נדרש אימות משתמש.
|
ListSpaceEvents |
---|
הצגת רשימה של אירועים במרחב משותף ב-Google Chat. מטען הייעודי של כל אירוע מכיל את הגרסה העדכנית ביותר של משאב Chat. לדוגמה, אם תציגו אירועים לגבי חברים חדשים במרחב המשותף, השרת יחזיר משאבי נדרש אימות משתמש. כדי להציג את האירועים, המשתמש המאומת צריך להיות חבר במרחב המשותף. דוגמה לכך מופיעה במאמר הצגת רשימת אירועים במרחב משותף ב-Google Chat.
|
ListSpaces |
---|
רשימה של המרחבים המשותפים שבהם המשתמש שמתקשר הוא חבר. שיחות צ'אט קבוצתיות וצ'אטים אישיים לא מופיעים ברשימה עד ששולחים את ההודעה הראשונה. דוגמה לכך מופיעה בקטע רשימת המרחבים המשותפים. יש תמיכה בסוגי אימות הבאים: כדי לקבל רשימה של כל המרחבים המשותפים שנקראו לפי ארגון ב-Google Workspace, צריך להשתמש במקום זאת בשיטה
|
SearchSpaces |
---|
הפונקציה מחזירה רשימה של מרחבים משותפים בארגון ב-Google Workspace על סמך חיפוש של אדמין. נדרשת אימות משתמש עם הרשאות אדמין. בבקשה, מגדירים את
|
SetUpSpace |
---|
יצירת מרחב משותף והוספת משתמשים מסוימים אליו. המשתמש שמבצע את הקריאה מתווסף למרחב המשותף באופן אוטומטי, ואין לציין אותו כחבר בבקשה. דוגמה לכך מופיעה במאמר הגדרת מרחב משותף עם חברים ראשוניים. כדי לציין את חברי הקבוצה האנושיים שרוצים להוסיף, מוסיפים חברויות עם כדי לציין את קבוצות Google שרוצים להוסיף, מוסיפים חברויות באמצעות במרחבים משותפים או בצ'אטים קבוצתיים עם שם, אם מבצע הקריאה לחברים חוסם משתתפים מסוימים או שהם חוסמים אותו, או אם אין לו הרשאה להוסיף משתתפים מסוימים, המשתתפים האלה לא מצורפים למרחב המשותף שנוצר. כדי ליצור הודעה ישירה (DM) בין המשתמש הקורא לבין משתמש אנושי אחר, צריך לציין חברות אחת בלבד שמייצגת את המשתמש האנושי. אם משתמש אחד חוסם את השני, הבקשה נכשלת והצ'אט הפרטי לא נוצר. כדי ליצור שיחה פרטית בין המשתמש הקורא לאפליקציה הקוראת, מגדירים את אם כבר יש שיחה פרטית בין שני משתמשים, גם אם אחד מהם חוסם את השני בזמן שליחת הבקשה, השיחה הפרטית הקיימת תוחזר. אין תמיכה במרחבים משותפים עם תשובות בשרשור. אם מופיעה הודעת השגיאה נדרש אימות משתמש.
|
UpdateMembership |
---|
עדכון של מינוי. דוגמה לכך מופיעה במאמר עדכון החברות של משתמש במרחב משותף. יש תמיכה בסוגי האימות הבאים:
|
UpdateMessage |
---|
עדכון הודעה. יש הבדל בין השיטות יש תמיכה בסוגי אימות הבאים: כשמשתמשים באימות אפליקציה, הבקשות יכולות לעדכן רק הודעות שנוצרו על ידי אפליקציית Chat שבה מתבצעת הקריאה.
|
UpdateSpace |
---|
עדכון של מרחב משותף. דוגמה לכך מופיעה במאמר עדכון מרחבים משותפים. אם מעדכנים את השדה יש תמיכה בסוגי אימות הבאים:
|
UpdateSpaceNotificationSetting |
---|
נדרש אימות משתמש.
|
UpdateSpaceReadState |
---|
עדכון מצב הקריאה של משתמש במרחב משותף, כדי לזהות הודעות שנקראו והודעות שעדיין לא נקראו. דוגמה לכך מופיעה במאמר עדכון סטטוס הקריאה של משתמש במרחב משותף. נדרש אימות משתמש.
|
AccessoryWidget
ווידג'ט אינטראקטיבי אחד או יותר שמופיע בחלק התחתון של הודעה. מידע נוסף זמין במאמר הוספת ווידג'טים אינטראקטיביים בחלק התחתון של הודעה.
שדות | |
---|---|
שדה האיחוד action . סוג הפעולה. הערך של action יכול להיות רק אחת מהאפשרויות הבאות: |
|
button_ |
רשימת לחצנים. |
ActionResponse
פרמטרים שאפשר להשתמש בהם באפליקציית Chat כדי להגדיר את אופן פרסום התשובה.
שדות | |
---|---|
type |
קלט בלבד. סוג התגובה באפליקציית Chat. |
url |
קלט בלבד. כתובת URL שמשמשת את המשתמשים לאימות או להגדרה. (רק לסוגי התשובות |
dialog_ |
קלט בלבד. תגובה לאירוע אינטראקציה שקשור לתיבת דו-שיח. צריך לצרף את |
updated_ |
קלט בלבד. התגובה מהווידג'ט המעודכן. |
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_ |
קוד הסטטוס. |
user_ |
ההודעה שתשלח למשתמשים לגבי סטטוס הבקשה שלהם. אם לא מגדירים את הערך, נשלחת הודעה גנרית על סמך הערך של |
הערה
פלט בלבד. הערות שמשויכות לגוף ההודעה בטקסט פשוט. במאמר עיצוב הודעות טקסט מוסבר איך להוסיף עיצוב בסיסי להודעות טקסט.
דוגמה לגוף הודעה בטקסט פשוט:
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_ |
אינדקס ההתחלה (מתחיל ב-0, כולל) בגוף ההודעה בטקסט פשוט שאליו המטא-נתונים האלה תואמים. |
שדה האיחוד metadata . מטא-נתונים נוספים על ההערה. הערך של metadata יכול להיות רק אחת מהאפשרויות הבאות: |
|
user_ |
המטא-נתונים של אזכור המשתמש. |
slash_ |
המטא-נתונים של פקודה דרך שורת הפקודה. |
rich_ |
המטא-נתונים של קישור עשיר. |
AnnotationType
סוג ההערה.
טיפוסים בני מנייה (enum) | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED |
ערך ברירת המחדל של ה-enum. אין להשתמש. |
USER_MENTION |
משתמש מסוים מוזכר. |
SLASH_COMMAND |
פקודת שורת הפקודה מופעלת. |
RICH_LINK |
הערה על קישור עשיר. |
AttachedGif
קובץ GIF שצוין באמצעות כתובת URL.
שדות | |
---|---|
uri |
פלט בלבד. כתובת ה-URL שמארחת את קובץ ה-GIF. |
קובץ מצורף
קובץ מצורף ב-Google Chat.
שדות | |
---|---|
name |
זה שינוי אופציונלי. שם המשאב של הקובץ המצורף, בפורמט |
content_ |
פלט בלבד. שם הקובץ המקורי של התוכן, ולא הנתיב המלא. |
content_ |
פלט בלבד. סוג התוכן (סוג ה-MIME) של הקובץ. |
thumbnail_ |
פלט בלבד. כתובת ה-URL של התמונה הממוזערת שצריך להשתמש בה כדי להציג למשתמשים תצוגה מקדימה של הקובץ המצורף. אפליקציות צ'אט לא צריכות להשתמש בכתובת ה-URL הזו כדי להוריד את תוכן הקובץ המצורף. |
download_ |
פלט בלבד. כתובת ה-URL להורדה שצריך להשתמש בה כדי לאפשר למשתמש אנושי להוריד את הקובץ המצורף. אפליקציות צ'אט לא צריכות להשתמש בכתובת ה-URL הזו כדי להוריד את תוכן הקובץ המצורף. |
source |
פלט בלבד. המקור של הקובץ המצורף. |
שדה האיחוד data_ref . הנתונים שמפנים לקובץ המצורף. הערך של data_ref יכול להיות רק אחת מהאפשרויות הבאות: |
|
attachment_ |
זה שינוי אופציונלי. הפניה לנתוני הקובץ המצורף. השדה הזה משמש ליצירה או לעדכון של הודעות עם קבצים מצורפים, או עם Media API כדי להוריד את נתוני הקובץ המצורף. |
drive_ |
פלט בלבד. הפניה לקובץ המצורף ב-Google Drive. השדה הזה משמש עם Google Drive API. |
מקור
המקור של הקובץ המצורף.
טיפוסים בני מנייה (enum) | |
---|---|
SOURCE_UNSPECIFIED |
שמור. |
DRIVE_FILE |
הקובץ הוא קובץ ב-Google Drive. |
UPLOADED_CONTENT |
הקובץ הועלה ל-Chat. |
AttachmentDataRef
הפניה לנתוני הקובץ המצורף.
שדות | |
---|---|
resource_ |
זה שינוי אופציונלי. שם המשאב של נתוני הקובץ המצורף. השדה הזה משמש את ה-Media API כדי להוריד את נתוני הקובץ המצורף. |
attachment_ |
זה שינוי אופציונלי. טוקן אטום שמכיל הפניה לקובץ מצורף שהועלה. הלקוחות מתייחסים אליו כמחרוזת אטומה, והוא משמש ליצירה או לעדכון של הודעות ב-Chat עם קבצים מצורפים. |
CardWithId
כרטיס בהודעה ב-Google Chat.
רק אפליקציות Chat יכולות ליצור כרטיסים. אם אפליקציית Chat מאמתת כמשתמש, ההודעה לא יכולה להכיל כרטיסים.
בעזרת הכלי ליצירת כרטיסים תוכלו לעצב כרטיסים ולראות תצוגה מקדימה שלהם.
פתיחת הכלי ליצירת כרטיסיםשדות | |
---|---|
card_ |
חובה לציין אם ההודעה מכילה כמה כרטיסים. מזהה ייחודי של כרטיס בהודעה. |
card |
כרטיס. הגודל המקסימלי הוא 32KB. |
ChatSpaceLinkData
נתונים של קישורים למרחבים משותפים ב-Chat.
שדות | |
---|---|
space |
המרחב של המשאב המקושר של המרחב המשותף ב-Chat. פורמט: |
thread |
השרשור של המשאב המקושר במרחב ב-Chat. פורמט: |
message |
ההודעה של המשאב המקושר של המרחב המשותף ב-Chat. פורמט: |
CompleteImportSpaceRequest
הודעה עם בקשה להשלים את תהליך הייבוא של מרחב משותף.
שדות | |
---|---|
name |
חובה. שם המשאב של המרחב המשותף במצב הייבוא. פורמט: |
CompleteImportSpaceResponse
הודעת תגובה על השלמת תהליך הייבוא של מרחב משותף.
שדות | |
---|---|
space |
המרחב של מצב הייבוא. |
ContextualAddOnMarkup
אין שדות לסוג הזה.
הרכיב המסומן שמאפשר למפתחים לציין את התוכן של תוסף לפי הקשר.
קלפים
כרטיס הוא רכיב בממשק המשתמש שיכול להכיל ווידג'טים של ממשק משתמש, כמו טקסט ותמונות.
שדות | |
---|---|
header |
הכותרת של הכרטיס. בדרך כלל כותרת מכילה שם ותמונה. |
sections[] |
החלקים מופרדים באמצעות קו מפריד. |
card_ |
הפעולות של הכרטיס הזה. |
name |
שם הכרטיס. |
CardAction
פעולת כרטיס היא הפעולה שמשויכת לכרטיס. בכרטיס חשבונית, פעולה אופיינית יכולה להיות: מחיקה של החשבונית, שליחת החשבונית באימייל או פתיחת החשבונית בדפדפן.
אין תמיכה באפליקציות Google Chat.
שדות | |
---|---|
action_ |
התווית הייתה מוצגת באפשרות בתפריט הפעולות. |
on_ |
הפעולה שמתבצעת בלחיצה על פריט הפעולה הזה. |
CardHeader
שדות | |
---|---|
title |
חובה לציין את השם. לגובה הכותרת יש ערך קבוע: אם מציינים גם כותרת וגם כותרת משנה, כל אחת מהן תופסת שורה אחת. אם מציינים רק את השם, הוא תופס את שתי השורות. |
subtitle |
כותרת המשנה של כותרת הכרטיס. |
image_ |
סוג התמונה (לדוגמה, מסגרת ריבועית או מסגרת עגולה). |
image_ |
כתובת ה-URL של התמונה בכותרת הכרטיס. |
ImageStyle
טיפוסים בני מנייה (enum) | |
---|---|
IMAGE_STYLE_UNSPECIFIED |
|
IMAGE |
גבול מרובע. |
AVATAR |
גבול עגול. |
קטע
קטע מכיל אוסף של ווידג'טים שמוצגים (אנכית) לפי הסדר שבו הם צוינו. בכל הפלטפורמות, לכרטיסים יש רוחב קבוע וצר, ולכן אין כרגע צורך במאפייני פריסה (לדוגמה, float).
שדות | |
---|---|
header |
הכותרת של הקטע. יש תמיכה בטקסט מעוצב. מידע נוסף על עיצוב טקסט זמין במאמרים עיצוב טקסט באפליקציות של Google Chat ועיצוב טקסט בתוספים של Google Workspace. |
widgets[] |
כל קטע חייב להכיל לפחות ווידג'ט אחד. |
CreateCustomEmojiRequest
בקשה ליצירת אמוג'י בהתאמה אישית.
שדות | |
---|---|
custom_ |
חובה. האמוג'י בהתאמה אישית שרוצים ליצור. |
CreateMembershipRequest
הודעת הבקשה ליצירת חברות.
שדות | |
---|---|
parent |
חובה. שם המשאב של המרחב המשותף שבו רוצים ליצור את החברות. פורמט: spaces/{space} |
membership |
חובה. הקשר של החברות לקבוצה שיצרתם. השדה כשאפליקציית Chat יוצרת יחסי חברות של משתמש אנושי, היא חייבת להשתמש בהיקפי הרשאה מסוימים ולהגדיר ערכים ספציפיים לשדות מסוימים:
כדי להזמין משתמשים שאינם מהארגון ב-Workspace שבבעלותו המרחב המשותף, צריך לבצע אימות משתמשים. כשאפליקציית Chat יוצרת יחס חברות עבור עצמה, היא צריכה לבצע אימות כמשתמש ולהשתמש בהיקף |
use_ |
זה שינוי אופציונלי. כשהערך של המשתמש הקורא חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים. נדרשת הרשאת OAuth 2.0 אין תמיכה ביצירת מינויים לאפליקציות או ביצירת מינויים למשתמשים מחוץ לארגון של האדמין ב-Google Workspace באמצעות הרשאת אדמין. |
CreateMessageRequest
יצירת הודעה.
שדות | |
---|---|
parent |
חובה. שם המשאב של המרחב המשותף שבו רוצים ליצור הודעה. פורמט: |
message |
חובה. גוף ההודעה. |
thread_key |
זה שינוי אופציונלי. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב- |
request_ |
זה שינוי אופציונלי. מזהה בקשה ייחודי להודעה הזו. ציון מזהה בקשה קיים מחזיר את ההודעה שנוצרה עם המזהה הזה במקום ליצור הודעה חדשה. |
message_ |
זה שינוי אופציונלי. האפשרות הזו קובעת אם ההודעה מתחילה שרשור או עונה לשרשור קיים. התכונה הזו נתמכת רק במרחבים משותפים עם שם. כשמגיבים לאינטראקציות של משתמשים, המערכת מתעלמת מהשדה הזה. באינטראקציות בתוך שרשור, התשובה נוצרת באותו שרשור. אחרת, התשובה תיווצר כשרשור חדש. |
message_ |
זה שינוי אופציונלי. מזהה מותאם אישית להודעה. מאפשר לאפליקציות 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_ |
זה שינוי אופציונלי. מזהה ייחודי של הבקשה הזו. מומלץ להשתמש ב-UUID אקראי. ציון מזהה בקשה קיים מחזיר את המרחב המשותף שנוצר באמצעות המזהה הזה במקום ליצור מרחב משותף חדש. אם מציינים מזהה בקשה קיים מאותה אפליקציית Chat עם משתמש מאומת אחר, מתקבלת הודעת שגיאה. |
CustomEmoji
מייצג אמוג'י בהתאמה אישית.
שדות | |
---|---|
name |
מזהה. שם המשאב של האמוג'י בהתאמה אישית, שהוקצה על ידי השרת. פורמט: |
uid |
פלט בלבד. מפתח ייחודי למשאב האמוג'י בהתאמה אישית. |
emoji_ |
זה שינוי אופציונלי. לא ניתן לשינוי. השם שהמשתמש סיפק לאמוג'י בהתאמה אישית, והוא ייחודי בארגון. חובה כשיוצרים את האמוג'י בהתאמה אישית, פלט בלבד במקרים אחרים. שמות של אמוג'י חייבים להתחיל ולסתיים בנקודתיים, להיות כתובים באותיות קטנות ויכולים להכיל רק תווים אלפאנומריים, מקפים וקווים תחתונים. השימוש במקפים ובקווים תחתונים צריך להיות רק כדי להפריד בין מילים. אי אפשר לכתוב מקפים וקווים תחתונים ברצף. לדוגמה: |
temporary_ |
פלט בלבד. כתובת ה-URL של התמונה של האמוג'י המותאם אישית, שתהיה תקפה למשך 10 דקות לפחות. לתשומת ליבכם: השדה הזה לא מאוכלס בתשובה כשהאמוג'י בהתאמה אישית נוצר. |
payload |
זה שינוי אופציונלי. קלט בלבד. נתונים של מטען ייעודי. נדרש בזמן יצירת האמוג'י בהתאמה אישית. |
CustomEmojiPayload
נתוני עומס העבודה של האמוג'י בהתאמה אישית.
שדות | |
---|---|
file_ |
חובה. קלט בלבד. התמונה שבה נעשה שימוש באמוג'י המותאם אישית. עומס העבודה צריך להיות קטן מ-256KB והמידות של התמונה צריכות להיות בין 64 ל-500 פיקסלים. המגבלות עשויות להשתנות. |
filename |
חובה. קלט בלבד. שם קובץ התמונה. סיומות הקובץ הנתמכות: |
DeleteCustomEmojiRequest
בקשה למחיקת אמוג'י בהתאמה אישית.
שדות | |
---|---|
name |
חובה. שם המשאב של האמוג'י בהתאמה אישית שרוצים למחוק. פורמט: אפשר להשתמש בשם האמוג'י ככתובת אימייל חלופית ל- |
DeleteMembershipRequest
לבקש למחוק מישהו מהמרחב המשותף.
שדות | |
---|---|
name |
חובה. שם המשאב של החברות שרוצים למחוק. אפליקציות צ'אט יכולות למחוק את החברויות של משתמשים או את החברויות שלהן. אפליקציות צ'אט לא יכולות למחוק מינויים של אפליקציות אחרות. כשמוחקים מינוי של משתמש, צריך את ההיקף כדי למחוק חברות באפליקציה, צריך את ההיקף פורמט: |
use_ |
זה שינוי אופציונלי. כשהערך של המשתמש שמבצע את הקריאה חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים. נדרשת הרשאת OAuth 2.0 לא ניתן למחוק את החברויות באפליקציות במרחב משותף באמצעות הרשאת אדמין. |
DeleteMessageRequest
שליחת בקשה למחיקת הודעה.
שדות | |
---|---|
name |
חובה. שם המשאב של ההודעה. פורמט: אם הגדרתם מזהה מותאם אישית להודעה, תוכלו להשתמש בערך מהשדה |
force |
זה שינוי אופציונלי. כשהאפשרות רלוונטי רק כשמבצעים אימות כמשתמשים. אין לה השפעה על אימות כאפליקציית Chat. |
DeleteReactionRequest
מחיקת תגובה להודעה.
שדות | |
---|---|
name |
חובה. השם של התגובה שרוצים למחוק. פורמט: |
DeleteSpaceRequest
בקשה למחיקת מרחב משותף.
שדות | |
---|---|
name |
חובה. שם המשאב של המרחב המשותף שרוצים למחוק. פורמט: |
use_ |
זה שינוי אופציונלי. כשהערך של המשתמש שמבצע את הקריאה חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים. נדרשת הרשאת OAuth 2.0 |
DeletionMetadata
מידע על הודעה שנמחקה. ההודעה נמחקת כשהערך של delete_time
מוגדר.
שדות | |
---|---|
deletion_ |
מי שמחק את ההודעה. |
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_ |
קלט בלבד. הסטטוס של בקשה להפעלה או לשליחה של שיחה. הצגת סטטוס והודעה למשתמשים, במקרה הצורך. לדוגמה, במקרה של שגיאה או הצלחה. |
שדה האיחוד action . הפעולה לביצוע. הערך של action יכול להיות רק אחת מהאפשרויות הבאות: |
|
dialog |
קלט בלבד. Dialog של הבקשה. |
DriveDataRef
הפניה לנתונים של קובץ מצורף ב-Drive.
שדות | |
---|---|
drive_ |
המזהה של קובץ ה-Drive. שימוש ב-Drive API. |
DriveLinkData
נתונים של קישורים ל-Google Drive.
שדות | |
---|---|
drive_ |
DriveDataRef שמפנה לקובץ ב-Google Drive. |
mime_ |
סוג ה-MIME של משאב Google Drive המקושר. |
אמוג'י
אמוג'י שמשמש לתגובה להודעה.
שדות | |
---|---|
שדה האיחוד content . חובה. התוכן של האמוג'י. הערך של content יכול להיות רק אחת מהאפשרויות הבאות: |
|
unicode |
זה שינוי אופציונלי. אמוג'י בסיסי שמיוצג על ידי מחרוזת Unicode. |
custom_ |
פלט בלבד. אמוג'י בהתאמה אישית. |
EmojiReactionSummary
מספר האנשים שהגיבו להודעה באמוג'י ספציפי.
שדות | |
---|---|
emoji |
פלט בלבד. האמוג'י שמשויך לתגובות. |
reaction_ |
פלט בלבד. המספר הכולל של התגובות באמצעות האמוג'י המשויך. |
FindDirectMessageRequest
בקשה לקבלת מרחב של צ'אט אישי על סמך משאב המשתמש.
שדות | |
---|---|
name |
חובה. שם המשאב של המשתמש שרוצים למצוא איתו צ'אט ישיר. הפורמט: |
GetAttachmentRequest
שולחים בקשה לקבלת קובץ מצורף.
שדות | |
---|---|
name |
חובה. שם המשאב של הקובץ המצורף, בפורמט |
GetCustomEmojiRequest
בקשה להחזרת אמוג'י מותאם אישית יחיד.
שדות | |
---|---|
name |
חובה. שם המשאב של האמוג'י המותאם אישית. פורמט: אפשר להשתמש בשם האמוג'י ככתובת אימייל חלופית ל- |
GetMembershipRequest
שליחת בקשה להצטרפות למרחב משותף.
שדות | |
---|---|
name |
חובה. שם המשאב של המינוי שרוצים לאחזר. כדי לקבל את החברות של האפליקציה באמצעות אימות משתמש, אפשר להשתמש ב- פורמט: אפשר להשתמש בכתובת האימייל של המשתמש ככתובת אימייל חלופית ל- |
use_ |
זה שינוי אופציונלי. כשהערך של המשתמש שמבצע את הקריאה חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים. נדרשים היקפי ההרשאות של OAuth 2.0 אי אפשר לקבל חברויות באפליקציות במרחב משותף כשמשתמשים בגישה של אדמין. |
GetMessageRequest
מבקשים לקבל הודעה.
שדות | |
---|---|
name |
חובה. שם המשאב של ההודעה. פורמט: אם הגדרתם מזהה מותאם אישית להודעה, תוכלו להשתמש בערך מהשדה |
GetSpaceEventRequest
הודעה עם בקשה לקבלת אירוע במרחב משותף.
שדות | |
---|---|
name |
חובה. שם המשאב של אירוע המרחב המשותף. פורמט: |
GetSpaceNotificationSettingRequest
הודעה עם בקשה לקבלת הגדרת התראות על המרחב המשותף. התכונה תומכת רק בקבלת הגדרת התראות עבור המשתמש שמבצע את השיחה.
שדות | |
---|---|
name |
חובה. פורמט: users/{user}/spaces/{space}/spaceNotificationSetting
|
GetSpaceReadStateRequest
הודעת בקשה ל-API GetSpaceReadState.
שדות | |
---|---|
name |
חובה. שם המשאב של מצב הקריאה של המרחב המשותף שרוצים לאחזר. התכונה תומכת רק בקבלת סטטוס הקריאה של המשתמש הקורא. כדי להפנות למשתמש הקורא, מגדירים את אחת מהאפשרויות הבאות:
פורמט: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
בקשה להחזרת מרחבים משותפים ספציפיים.
שדות | |
---|---|
name |
חובה. שם המשאב של המרחב המשותף, בפורמט פורמט: |
use_ |
זה שינוי אופציונלי. כשהערך של המשתמש שמבצע את הקריאה חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים. נדרשים היקפי ההרשאות של OAuth 2.0 |
GetThreadReadStateRequest
הודעת בקשה ל-API GetThreadReadStateRequest.
שדות | |
---|---|
name |
חובה. שם המשאב של מצב הקריאה של השרשור שרוצים לאחזר. התכונה תומכת רק בקבלת סטטוס הקריאה של המשתמש הקורא. כדי להפנות למשתמש הקורא, מגדירים את אחת מהאפשרויות הבאות:
פורמט: users/{user}/spaces/{space}/threads/{thread}/threadReadState |
קבוצה
קבוצת Google ב-Google Chat.
שדות | |
---|---|
name |
שם המשאב של קבוצת Google. מייצג קבוצה ב-Cloud Identity Groups API. פורמט: groups/{group} |
HistoryState
מצב ההיסטוריה של הודעות ומרחבים משותפים. קובעת למשך כמה זמן הודעות ושרשראות של שיחות יישמרו אחרי היצירה שלהן.
טיפוסים בני מנייה (enum) | |
---|---|
HISTORY_STATE_UNSPECIFIED |
ערך ברירת המחדל. אין להשתמש בו. |
HISTORY_OFF |
ההיסטוריה מושבתת. ההודעות והשרשורים נשמרים למשך 24 שעות. |
HISTORY_ON |
ההיסטוריה פועלת. כללי השמירה ב-Vault של הארגון קובעים למשך כמה זמן הודעות ושרשורות יישמרו. |
ListCustomEmojisRequest
בקשה להחזרת רשימה של אמוג'י בהתאמה אישית.
שדות | |
---|---|
page_ |
זה שינוי אופציונלי. המספר המקסימלי של סמלי אמוג'י בהתאמה אישית שיוחזרו. השירות יכול להחזיר פחות סמלי אמוג'י בהתאמה אישית מהערך הזה. אם לא מציינים ערך, ערך ברירת המחדל הוא 25. הערך המקסימלי הוא 200. ערכים מעל 200 משתנים ל-200. |
page_ |
זה שינוי אופציונלי. (אם ממשיכים משאילתה קודמת). אסימון דף שהתקבל מבקשה קודמת להצגת רשימה של אמוג'י בהתאמה אישית. יש לספק אותו כדי לאחזר את הדף הבא. כשמחלקים לדפים, ערך המסנן צריך להתאים לקריאה שסיפקה את אסימון הדף. העברת ערך שונה עלולה להוביל לתוצאות בלתי צפויות. |
filter |
זה שינוי אופציונלי. מסנן שאילתות. תמיכה בסינון לפי יוצר. כדי לסנן לפי יוצר, צריך לציין ערך חוקי. בשלב הזה, רק לדוגמה, השאילתה הבאה מחזירה אמוג'י בהתאמה אישית שנוצר על ידי מבצע הקריאה החוזרת:
שאילתות לא חוקיות נדחות על ידי השרת עם שגיאה מסוג |
ListCustomEmojisResponse
תגובה לרשימת אמוג'י בהתאמה אישית.
שדות | |
---|---|
custom_ |
רשימה לא ממוינת. רשימת אמוג'י בהתאמה אישית בדף המבוקש (או בדף הראשון). |
next_ |
אסימון שאפשר לשלוח כ- |
ListMembershipsRequest
הודעת בקשה להצטרפות למועדון החברים של דף העסק.
שדות | |
---|---|
parent |
חובה. שם המשאב של המרחב המשותף שעבורו רוצים לאחזר רשימת חברים. פורמט: spaces/{space} |
page_ |
זה שינוי אופציונלי. המספר המקסימלי של החברויות שאפשר להחזיר. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מצוין, המערכת תחזיר עד 100 חברויות. הערך המקסימלי הוא 1,000. אם משתמשים בערך גבוה מ-1,000, הוא ישתנה באופן אוטומטי ל-1,000. ערכי שליליים מחזירים שגיאה מסוג |
page_ |
זה שינוי אופציונלי. טוקן דף, שהתקבל משיחה קודמת להצגת רשימת החברויות. צריך לציין את הפרמטר הזה כדי לאחזר את הדף הבא. כשמחלקים את הדפים, כל שאר הפרמטרים שצוינו צריכים להתאים לקריאה שסיפקה את אסימון הדף. העברת ערכים שונים לפרמטרים האחרים עלולה להוביל לתוצאות לא צפויות. |
filter |
זה שינוי אופציונלי. מסנן שאילתות. אפשר לסנן את החברויות לפי התפקיד ( כדי לסנן לפי תפקיד, מגדירים את כדי לסנן לפי סוג, מגדירים את כדי לסנן לפי תפקיד וסוג, משתמשים באופרטור צריך להגדיר את לדוגמה, השאילתות הבאות תקינות:
השאילתות הבאות לא תקינות:
שאילתות לא חוקיות נדחות על ידי השרת עם שגיאה |
show_ |
זה שינוי אופציונלי. כשהערך הוא |
show_ |
זה שינוי אופציונלי. כשהערך הוא בשלב הזה נדרש אימות משתמש. |
use_ |
זה שינוי אופציונלי. כשהערך של המשתמש שמבצע את הקריאה חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים. נדרש היקף הרשאות OAuth 2.0 אי אפשר להציג את החברויות באפליקציות במרחב משותף כשמשתמשים בגישה של אדמין. |
ListMembershipsResponse
תגובה לרשימה של חברי המרחב המשותף.
שדות | |
---|---|
memberships[] |
רשימה לא ממוינת. רשימת החברויות בדף המבוקש (או בדף הראשון). |
next_ |
אסימון שאפשר לשלוח כ- |
ListMessagesRequest
הצגת רשימה של ההודעות במרחב המשותף שצוין, שהמשתמש הוא חבר בו.
שדות | |
---|---|
parent |
חובה. שם המשאב של המרחב שבו רוצים להציג את ההודעות. פורמט: |
page_ |
זה שינוי אופציונלי. המספר המקסימלי של ההודעות שיוחזרו. יכול להיות שהשירות יחזיר פחות הודעות מהערך הזה. אם לא מצוין, יוחזרו עד 25 פריטים. הערך המקסימלי הוא 1,000. אם משתמשים בערך גבוה מ-1,000, הוא ישתנה באופן אוטומטי ל-1,000. ערכי שליליים מחזירים שגיאה מסוג |
page_ |
זה שינוי אופציונלי. אסימון דף שהתקבל מבקשת 'רשימת הודעות' קודמת. צריך לציין את הפרמטר הזה כדי לאחזר את הדף הבא. כשמחלקים את הדפים, כל שאר הפרמטרים שצוינו צריכים להתאים לקריאה שסיפקה את אסימון הדף. העברת ערכים שונים לפרמטרים האחרים עלולה להוביל לתוצאות לא צפויות. |
filter |
זה שינוי אופציונלי. מסנן שאילתות. אפשר לסנן הודעות לפי תאריך ( כדי לסנן הודעות לפי התאריך שבו נוצרו, מציינים את השדה כדי לסנן לפי שרשור, מציינים את כדי לסנן לפי שרשור ותאריך, צריך להשתמש באופרטור לדוגמה, השאילתות הבאות תקינות:
שאילתות לא חוקיות נדחות על ידי השרת עם שגיאה מסוג |
order_ |
זה שינוי אופציונלי. סדר הרשימה של ההודעות. מציינים ערך כדי למיין לפי פעולת מיון. הערכים החוקיים של פעולת ההזמנה הם:
סדר ברירת המחדל הוא |
show_ |
זה שינוי אופציונלי. אם לכלול הודעות שנמחקו. הודעות שנמחקו כוללות את זמן המחיקה ומטא-נתונים לגבי המחיקה שלהן, אבל תוכן ההודעות לא זמין. |
ListMessagesResponse
הודעת תגובה להודעות במודעות.
שדות | |
---|---|
messages[] |
רשימת ההודעות. |
next_ |
אפשר לשלוח אסימון כ- |
ListReactionsRequest
רשימת התגובות להודעה.
שדות | |
---|---|
parent |
חובה. ההודעה שהמשתמשים הגיבו עליה. פורמט: |
page_ |
זה שינוי אופציונלי. המספר המקסימלי של התגובות שיתקבלו. השירות יכול להחזיר פחות תגובות מהערך הזה. אם לא מציינים ערך, ערך ברירת המחדל הוא 25. הערך המקסימלי הוא 200. ערכים מעל 200 משתנים ל-200. |
page_ |
זה שינוי אופציונלי. (אם ממשיכים משאילתה קודמת). אסימון דף שקיבלתם מבקשת קודמת להצגת רשימת התגובות. יש לספק אותו כדי לאחזר את הדף הבא. כשמחלקים לדפים, ערך המסנן צריך להתאים לקריאה שסיפקה את אסימון הדף. העברת ערך שונה עלולה להוביל לתוצאות בלתי צפויות. |
filter |
זה שינוי אופציונלי. מסנן שאילתות. אפשר לסנן את התגובות לפי אמוג'י ( כדי לסנן תגובות של כמה אמוג'י או משתמשים, משלבים שדות דומים באמצעות האופרטור כדי לסנן תגובות לפי אמוג'י ומשתמש, משתמשים באופרטור אם בשאילתה נעשה שימוש גם ב- לדוגמה, השאילתות הבאות תקינות:
השאילתות הבאות לא תקינות:
שאילתות לא חוקיות נדחות על ידי השרת עם שגיאה |
ListReactionsResponse
תגובה לבקשה להציג רשימה של תגובות.
שדות | |
---|---|
reactions[] |
רשימה של התגובות בדף המבוקש (או בדף הראשון). |
next_ |
אסימון המשך לאחזור של דף התוצאות הבא. הוא ריק בדף התוצאות האחרון. |
ListSpaceEventsRequest
הודעה לבקשת הוספת אירועים למרחב המשותף.
שדות | |
---|---|
parent |
חובה. שם המשאב של המרחבים המשותפים ב-Google Chat שבהם התרחשו האירועים. פורמט: |
page_ |
זה שינוי אופציונלי. המספר המקסימלי של אירועי מרחבים משותפים שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. ערכי שליליים מחזירים שגיאה מסוג |
page_ |
זה שינוי אופציונלי. אסימון דף, שהתקבל מבקשת אירועים קודמת של מרחב משותף. צריך לספק אותו כדי לאחזר את הדף הבא. כשמחלקים את הרשימה לדפים, כל הפרמטרים האחרים שסיפקתם לאירועים של מרחב משותף חייבים להתאים לקריאה שסיפק את אסימון הדף. העברת ערכים שונים לפרמטרים האחרים עלולה להוביל לתוצאות לא צפויות. |
filter |
חובה. מסנן שאילתות. צריך לציין לפחות סוג אירוע אחד ( אפשר גם לסנן לפי שעת ההתחלה (
כדי לציין זמן התחלה או זמן סיום, משתמשים באופרטור השוויון לדוגמה, השאילתות הבאות תקינות:
השאילתות הבאות לא תקינות:
שאילתות לא חוקיות נדחות על ידי השרת עם שגיאה |
ListSpaceEventsResponse
הודעת תגובה להצגת אירועים במרחב המשותף.
שדות | |
---|---|
space_ |
התוצאות מוחזרות בסדר כרונולוגי (האירוע הישן ביותר מופיע קודם). הערה: השדה |
next_ |
אסימון המשך שמשמש לאחזור אירועים נוספים. אם השדה הזה לא יצוין, לא יהיו דפים נוספים. |
ListSpacesRequest
בקשה להציג רשימה של המרחבים המשותפים שהמבצע של הקריאה הוא חבר בהם.
שדות | |
---|---|
page_ |
זה שינוי אופציונלי. המספר המקסימלי של מרחבים משותפים להחזרה. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא צוין, המערכת תחזיר עד 100 מקומות פנויים. הערך המקסימלי הוא 1,000. אם משתמשים בערך גבוה מ-1,000, הוא ישתנה באופן אוטומטי ל-1,000. ערכי שליליים מחזירים שגיאה מסוג |
page_ |
זה שינוי אופציונלי. אסימון דף, שהתקבל משיחה קודמת של list spaces. צריך לציין את הפרמטר הזה כדי לאחזר את הדף הבא. כשמחלקים לדפים, ערך המסנן צריך להתאים לקריאה שסיפקה את אסימון הדף. העברת ערך שונה עלולה להוביל לתוצאות בלתי צפויות. |
filter |
זה שינוי אופציונלי. מסנן שאילתות. אפשר לסנן את המרחבים המשותפים לפי סוג המרחב ( כדי לסנן לפי סוג המרחב המשותף, צריך לציין ערך enum תקין, כמו לדוגמה, השאילתות הבאות תקינות:
שאילתות לא חוקיות נדחות על ידי השרת עם שגיאה מסוג |
ListSpacesResponse
התשובה לבקשה להצגת רשימת המרחבים המשותפים.
שדות | |
---|---|
spaces[] |
רשימת המרחבים בעמוד המבוקש (או בעמוד הראשון). הערה: השדה |
next_ |
אפשר לשלוח אסימון כ- |
MatchedUrl
כתובת URL תואמת בהודעה ב-Chat. אפליקציות צ'אט יכולות להציג תצוגה מקדימה של כתובות URL תואמות. מידע נוסף זמין במאמר תצוגה מקדימה של קישורים.
שדות | |
---|---|
url |
פלט בלבד. כתובת ה-URL שהותאמה. |
מינוי
מייצג יחס חברות ב-Google Chat, למשל אם משתמש או אפליקציית Chat מוזמנים למרחב משותף, אם הם חברים בו או אם הם לא חברים בו.
שדות | |
---|---|
name |
מזהה. שם המשאב של המינוי, שהוקצה על ידי השרת. פורמט: |
state |
פלט בלבד. סטטוס החברות. |
role |
זה שינוי אופציונלי. התפקיד של המשתמש במרחב המשותף ב-Chat, שמגדיר את הפעולות שמותר לו לבצע במרחב. אפשר להשתמש בשדה הזה כקלט רק ב- |
create_ |
זה שינוי אופציונלי. לא ניתן לשינוי. מועד היצירה של החברות, למשל מועד ההצטרפות של חבר או מועד ההזמנה שלו למרחב משותף. השדה הזה מיועד לפלט בלבד, למעט כשמשתמשים בו כדי לייבא חברויות היסטוריות במרחבים משותפים במצב ייבוא. |
delete_ |
זה שינוי אופציונלי. לא ניתן לשינוי. מועד המחיקה של החברות, למשל כשמשתמש עזב או הוסרה ממנו חברות במרחב משותף. השדה הזה מיועד לפלט בלבד, למעט כשמשתמשים בו כדי לייבא חברויות היסטוריות במרחבים משותפים במצב ייבוא. |
שדה האיחוד memberType . החבר שמשויך לחברות הזו. יכול להיות שנוסיף תמיכה בסוגי חברים אחרים בעתיד. הערך של memberType יכול להיות רק אחת מהאפשרויות הבאות: |
|
member |
זה שינוי אופציונלי. המשתמש או האפליקציה ב-Google Chat שהמינוי תואם אליהם. אם אפליקציית Chat מבצעת אימות כמשתמש, הפלט מאכלס את המשתמש |
group_ |
זה שינוי אופציונלי. קבוצת Google שהמינוי תואם אליה. כדי לקרוא את החברים בקבוצות 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
עומס העבודה של האירוע עבור כמה חברויות חדשות.
סוג האירוע: google.workspace.chat.membership.v1.batchCreated
שדות | |
---|---|
memberships[] |
רשימה של מינויים חדשים. |
MembershipBatchDeletedEventData
נתוני עומס האירוע של כמה מינויים שנמחקו.
סוג האירוע: google.workspace.chat.membership.v1.batchDeleted
שדות | |
---|---|
memberships[] |
רשימה של חברויות במועדון שנמחקו. |
MembershipBatchUpdatedEventData
עומס העבודה של האירוע עבור כמה מינויים מעודכנים.
סוג האירוע: google.workspace.chat.membership.v1.batchUpdated
שדות | |
---|---|
memberships[] |
רשימה של החברויות המעודכנות. |
MembershipCreatedEventData
נתוני עומס האירוע עבור חברות חדשה במועדון.
סוג האירוע: google.workspace.chat.membership.v1.created
.
שדות | |
---|---|
membership |
המועדון החדש. |
MembershipDeletedEventData
עומס העבודה של האירוע עבור מינוי שנמחק.
סוג האירוע: google.workspace.chat.membership.v1.deleted
שדות | |
---|---|
membership |
החברות במועדון של הערוץ שנמחקה. רק השדות |
MembershipUpdatedEventData
נתוני עומס האירוע של מינוי מעודכן.
סוג האירוע: google.workspace.chat.membership.v1.updated
שדות | |
---|---|
membership |
החברות המעודכנת. |
הודעה
הודעה במרחב משותף ב-Google Chat.
שדות | |
---|---|
name |
מזהה. שם המשאב של ההודעה. פורמט: כאשר אם מגדירים מזהה בהתאמה אישית בזמן יצירת ההודעה, אפשר להשתמש במזהה הזה כדי לציין את ההודעה בבקשה. לשם כך, מחליפים את |
sender |
פלט בלבד. המשתמש שיצר את ההודעה. אם אפליקציית Chat מבצעת אימות כמשתמש, הפלט מאכלס את המשתמש |
create_ |
זה שינוי אופציונלי. לא ניתן לשינוי. במרחבים משותפים שנוצרו ב-Chat, השעה שבה נוצרה ההודעה. השדה הזה מיועד לפלט בלבד, למעט כשמשתמשים בו במרחבים משותפים במצב ייבוא. במרחבים משותפים במצב ייבוא, צריך להגדיר את השדה הזה לחותמת הזמן ההיסטורית שבה ההודעה נוצרה במקור, כדי לשמור את זמן היצירה המקורי. |
last_ |
פלט בלבד. השעה שבה המשתמש ערך את ההודעה בפעם האחרונה. אם ההודעה לא נערכה אף פעם, השדה הזה יהיה ריק. |
delete_ |
פלט בלבד. השעה שבה ההודעה נמחקה ב-Google Chat. אם ההודעה לא נמחקת אף פעם, השדה הזה יהיה ריק. |
text |
זה שינוי אופציונלי. גוף ההודעה בטקסט פשוט. הקישור הראשון לתמונה, לסרטון או לדף אינטרנט יוצר צ'יפ תצוגה מקדימה. אפשר גם לציין משתמש ב-Google Chat באמצעות@ או את כל המשתתפים במרחב המשותף. מידע נוסף על יצירת הודעות טקסט זמין במאמר שליחת הודעה. |
formatted_ |
פלט בלבד. מכילה את ההודעה
מידע נוסף זמין במאמר הצגת עיצוב הטקסט שנשלח בהודעה. |
cards[] |
האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב- כרטיסים עשירים, בפורמט ובעלי יכולות אינטראקטיביות, שבהם אפשר להציג רכיבי ממשק משתמש כמו טקסטים בפורמט, לחצנים ותמונות שניתן ללחוץ עליהן. בדרך כלל הכרטיסים מוצגים מתחת לגוף ההודעה בטקסט פשוט. הגודל המקסימלי של |
cards_ |
זה שינוי אופציונלי. מערך של כרטיסים. רק אפליקציות Chat יכולות ליצור כרטיסים. אם אפליקציית Chat מאמתת כמשתמש, ההודעות לא יכולות להכיל כרטיסים. במאמר שליחת הודעה מוסבר איך יוצרים הודעה שמכילה כרטיסים. בעזרת הכלי ליצירת כרטיסים תוכלו לעצב כרטיסים ולראות תצוגה מקדימה שלהם. פתיחת הכלי ליצירת כרטיסים |
annotations[] |
פלט בלבד. ההערות שמשויכות ל- |
thread |
השרשור שאליו שייכת ההודעה. דוגמאות לשימוש מפורטות במאמר התחלת שרשור הודעות או מענה לשרשור. |
space |
פלט בלבד. אם אפליקציית Chat מאמתת כמשתמש, הפלט מאכלס רק את המרחבים |
fallback_ |
זה שינוי אופציונלי. תיאור של הכרטיסים בהודעה בטקסט ללא עיצוב. התיאור הזה משמש כשאי אפשר להציג את הכרטיסים בפועל – לדוגמה, התראות לנייד. |
action_ |
קלט בלבד. פרמטרים שאפשר להשתמש בהם באפליקציית Chat כדי להגדיר את אופן פרסום התשובה. |
argument_ |
פלט בלבד. גוף ההודעה כטקסט פשוט, בלי כל האזכורים של אפליקציית Chat. |
slash_ |
פלט בלבד. מידע על פקודות דרך שורת הפקודה, אם רלוונטי. |
attachment[] |
זה שינוי אופציונלי. קובץ מצורף שהמשתמש העלאה. |
matched_ |
פלט בלבד. כתובת URL ב- |
thread_ |
פלט בלבד. כשהערך הוא אם אין תמיכה בתשובות בשרשורים במרחב המשותף, השדה הזה תמיד יהיה |
client_ |
זה שינוי אופציונלי. מזהה בהתאמה אישית להודעה. אפשר להשתמש בשדה כדי לזהות הודעה, או כדי לקבל, למחוק או לעדכן הודעה. כדי להגדיר מזהה בהתאמה אישית, מציינים את השדה |
emoji_ |
פלט בלבד. רשימת הסיכומים של התגובות באמוג'י להודעה. |
private_ |
זה שינוי אופציונלי. לא ניתן לשינוי. קלט ליצירת הודעה, אחרת פלט בלבד. המשתמש שיכול לראות את ההודעה. כשהשדה הזה מוגדר, ההודעה פרטית וגלויה רק למשתמש שצוין ולאפליקציית Chat. כדי לכלול את השדה הזה בבקשה, צריך לבצע קריאה ל-Chat API באמצעות אימות אפליקציה ולהשמיט את הפרטים הבאים: פרטים נוספים זמינים במאמר שליחת הודעה באופן פרטי. |
deletion_ |
פלט בלבד. מידע על הודעה שנמחקה. ההודעה נמחקת כשהערך של |
quoted_ |
פלט בלבד. מידע על הודעה שמשתמש ב-Google Chat ציטט במרחב משותף. משתמשי Google Chat יכולים לצטט הודעה כדי להשיב לה. |
attached_ |
פלט בלבד. תמונות GIF שמצורפות להודעה. |
accessory_ |
זה שינוי אופציונלי. ווידג'ט אינטראקטיבי אחד או יותר שמופיע בחלק התחתון של הודעה. אפשר להוסיף ווידג'טים נלווים להודעות שמכילות טקסט, כרטיסים או גם טקסט וגם כרטיסים. אין תמיכה בהודעות שמכילות תיבת דו-שיח. מידע נוסף זמין במאמר הוספת ווידג'טים אינטראקטיביים בחלק התחתון של הודעה. כדי ליצור הודעה עם ווידג'טים נלווים, צריך לבצע אימות אפליקציה. |
MessageBatchCreatedEventData
עומס נתונים של אירוע לכמה הודעות חדשות.
סוג האירוע: google.workspace.chat.message.v1.batchCreated
שדות | |
---|---|
messages[] |
רשימה של הודעות חדשות. |
MessageBatchDeletedEventData
עומס העבודה של האירוע עבור כמה הודעות שנמחקו.
סוג האירוע: google.workspace.chat.message.v1.batchDeleted
שדות | |
---|---|
messages[] |
רשימה של הודעות שנמחקו. |
MessageBatchUpdatedEventData
עומס העבודה של האירוע עבור מספר הודעות מעודכנות.
סוג האירוע: google.workspace.chat.message.v1.batchUpdated
שדות | |
---|---|
messages[] |
רשימה של ההודעות המעודכנות. |
MessageCreatedEventData
עומס הנתונים של אירוע להודעה חדשה.
סוג האירוע: google.workspace.chat.message.v1.created
שדות | |
---|---|
message |
ההודעה החדשה. |
MessageDeletedEventData
עומס העבודה של האירוע עבור הודעה שנמחקה.
סוג האירוע: google.workspace.chat.message.v1.deleted
שדות | |
---|---|
message |
ההודעה שנמחקה. רק השדות |
MessageUpdatedEventData
עומס העבודה של האירוע עבור הודעה מעודכנת.
סוג האירוע: google.workspace.chat.message.v1.updated
שדות | |
---|---|
message |
ההודעה המעודכנת. |
QuotedMessageMetadata
מידע על הודעה שצוינה.
שדות | |
---|---|
name |
פלט בלבד. שם המשאב של ההודעה שצוינה. פורמט: |
last_ |
פלט בלבד. חותמת הזמן של מועד היצירה או מועד העדכון האחרון של ההודעה שצוינה. |
תגובה
תגובה להודעה.
שדות | |
---|---|
name |
מזהה. שם המשאב של התגובה. פורמט: |
user |
פלט בלבד. המשתמש שיצר את התגובה. |
emoji |
חובה. האמוג'י ששימש בתגובה. |
ReactionBatchCreatedEventData
נתוני עומס האירוע של מספר תגובות חדשות.
סוג האירוע: google.workspace.chat.reaction.v1.batchCreated
שדות | |
---|---|
reactions[] |
רשימה של תגובות חדשות. |
ReactionBatchDeletedEventData
עומס העבודה של האירוע עבור מספר תגובות שנמחקו.
סוג האירוע: google.workspace.chat.reaction.v1.batchDeleted
שדות | |
---|---|
reactions[] |
רשימה של התגובות שנמחקו. |
ReactionCreatedEventData
נתוני העומס של האירוע לתגובה חדשה.
סוג האירוע: google.workspace.chat.reaction.v1.created
שדות | |
---|---|
reaction |
התגובה החדשה. |
ReactionDeletedEventData
נתוני העומס של האירוע לתגובה שנמחקה.
סוג: google.workspace.chat.reaction.v1.deleted
שדות | |
---|---|
reaction |
התגובה שנמחקה. |
RichLinkMetadata
קישור עשיר למשאב.
שדות | |
---|---|
uri |
ה-URI של הקישור הזה. |
rich_ |
סוג הקישור המתקדם. |
שדה האיחוד data . נתונים של המשאב המקושר. הערך של data יכול להיות רק אחת מהאפשרויות הבאות: |
|
drive_ |
נתונים של קישור ל-Drive. |
chat_ |
נתונים של קישור למרחב משותף ב-Chat. |
RichLinkType
סוג הקישור המתקדם. יכול להיות שיתווספו עוד סוגים בעתיד.
טיפוסים בני מנייה (enum) | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED |
ערך ברירת המחדל של ה-enum. אין להשתמש. |
DRIVE_FILE |
סוג של קישור עשיר ב-Google Drive. |
CHAT_SPACE |
סוג קישור עשיר למרחב משותף ב-Chat. לדוגמה, צ'יפ חכם של מרחב משותף. |
SearchSpacesRequest
בקשה לחיפוש רשימה של מרחבים משותפים על סמך שאילתה.
שדות | |
---|---|
use_ |
כשהערך של המשתמש שמבצע את הקריאה חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים. נדרש היקף הרשאות OAuth 2.0 בשלב הזה, השיטה הזו תומכת רק בגישה של אדמין, ולכן רק הערך |
page_ |
המספר המקסימלי של מרחבים משותפים להחזרה. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא צוין, המערכת תחזיר עד 100 מקומות פנויים. הערך המקסימלי הוא 1,000. אם משתמשים בערך גבוה מ-1,000, הוא ישתנה באופן אוטומטי ל-1,000. |
page_ |
טוקן, שהתקבל מהקריאה הקודמת של מרחבי החיפוש. צריך לציין את הפרמטר הזה כדי לאחזר את הדף הבא. כשמחלקים את הדפים, כל שאר הפרמטרים שצוינו צריכים להתאים לקריאה שסיפקה את אסימון הדף. העברת ערכים שונים לפרמטרים האחרים עלולה להוביל לתוצאות לא צפויות. |
query |
חובה. שאילתת חיפוש. אפשר לחפש לפי הפרמטרים הבאים:
השדות השדה
אפשר להזין ב-
השדה בשדות שונים, יש תמיכה רק באופרטור באותו שדה, השאילתות לדוגמה הבאות תקינות:
|
order_ |
זה שינוי אופציונלי. סדר הרשימה של המרחבים המשותפים. המאפיינים הנתמכים להזמנה הם:
הערכים החוקיים של פעולת ההזמנה הם:
אלה תחבירי ה-JSON הנתמכים:
|
SearchSpacesResponse
תגובה עם רשימה של מרחבים משותפים שתואמים לבקשה לחיפוש מרחבים משותפים.
שדות | |
---|---|
spaces[] |
דף של המרחבים המשותפים המבוקשים. |
next_ |
אסימון שאפשר להשתמש בו כדי לאחזר את הדף הבא. אם השדה הזה ריק, אין דפים נוספים. |
total_ |
המספר הכולל של המרחבים המשותפים שתואמים לשאילתה, בכל הדפים. אם התוצאה היא יותר מ-10,000 מקומות, הערך הזה הוא אומדן. |
SetUpSpaceRequest
לבקש ליצור מרחב משותף ולהוסיף אליו משתמשים ספציפיים.
שדות | |
---|---|
space |
חובה. השדה כדי ליצור מרחב משותף, מגדירים את כדי ליצור צ'אט קבוצתי, מגדירים את כדי ליצור שיחה אישית בין בני אדם, מגדירים את כדי ליצור שיחה אישית בין אדם לאפליקציית Chat, מגדירים את אם כבר קיים מרחב משותף בשם |
request_ |
זה שינוי אופציונלי. מזהה ייחודי של הבקשה הזו. מומלץ להשתמש ב-UUID אקראי. ציון מזהה בקשה קיים מחזיר את המרחב המשותף שנוצר באמצעות המזהה הזה במקום ליצור מרחב משותף חדש. אם מציינים מזהה בקשה קיים מאותה אפליקציית Chat עם משתמש מאומת אחר, מתקבלת הודעת שגיאה. |
memberships[] |
זה שינוי אופציונלי. המשתמשים או הקבוצות ב-Google Chat שרוצים להזמין למרחב המשותף. לא לכלול את המשתמש מבצע הקריאה, כי הוא מתווסף באופן אוטומטי. בשלב הזה, אפשר להוסיף לקבוצה עד 20 חברים (בנוסף למבצע הקריאה החוזרת). עבור מינוי של משתמש, השדה כדי להוסיף חברות בקבוצות Google, השדה אופציונלי כשמגדירים את נדרש כשמגדירים את נדרשת כשמגדירים את השדה חייב להיות ריק כשיוצרים שיחה אישית בין אדם לאפליקציית Chat שביצעה את הקריאה (כשמגדירים את |
SlashCommand
פקודה דרך שורת הפקודה ב-Google Chat.
שדות | |
---|---|
command_ |
המזהה של פקודת ה-slash שהופעל. |
SlashCommandMetadata
מטא-נתונים של הערות לפקודות קו נטוי (/).
שדות | |
---|---|
bot |
אפליקציית Chat שבה הפקודה הופעל. |
type |
הסוג של פקודה דרך שורת הפקודה. |
command_ |
השם של פקודת ה-slash שהופעל. |
command_ |
מזהה הפקודה של פקודת ה-slash שהופעל. |
triggers_ |
מציין אם פקודת הפסיק היא לתיבת דו-שיח. |
סוג
טיפוסים בני מנייה (enum) | |
---|---|
TYPE_UNSPECIFIED |
ערך ברירת המחדל של ה-enum. אין להשתמש. |
ADD |
מוסיפים את אפליקציית Chat למרחב המשותף. |
INVOKE |
להפעיל פקודה של שורת הפקודות במרחב המשותף. |
רווח
במרחבים משותפים ב-Google Chat. מרחבים משותפים הם שיחות בין שני משתמשים או יותר, או הודעות אישיות בין משתמש לאפליקציית Chat.
שדות | |
---|---|
name |
מזהה. שם המשאב של המרחב המשותף. פורמט: כאשר |
type |
פלט בלבד. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב- |
space_ |
זה שינוי אופציונלי. סוג המרחב המשותף. חובה כשיוצרים מרחב משותף או מעדכנים את סוג המרחב המשותף. פלט רק לשימוש אחר. |
single_ |
זה שינוי אופציונלי. אם המרחב הוא צ'אט אישי בין אפליקציית Chat לבין אדם אחד. |
threaded |
פלט בלבד. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב- |
display_ |
זה שינוי אופציונלי. השם המוצג של המרחב המשותף. חובה כשיוצרים מרחב משותף עם בהודעות ישירות, השדה הזה עשוי להיות ריק. תמיכה ב-128 תווים לכל היותר. |
external_ |
זה שינוי אופציונלי. לא ניתן לשינוי. האם כל משתמש ב-Google Chat יכול להצטרף למרחב המשותף. מזינים כשיוצרים מרחב משותף בארגון ב-Google Workspace. מומלץ להשמיט את השדה הזה כשיוצרים מרחבים משותפים בתנאים הבאים:
במרחבים משותפים קיימים, השדה הזה הוא פלט בלבד. |
space_ |
פלט בלבד. מצב השרשורים במרחב המשותף ב-Chat. |
space_ |
זה שינוי אופציונלי. פרטים על המרחב המשותף, כולל תיאור וכללים. |
space_ |
זה שינוי אופציונלי. המצב של היסטוריית ההודעות של ההודעות והשרשורים במרחב המשותף. |
import_ |
זה שינוי אופציונלי. אם המרחב המשותף הזה נוצר ב- כדי ליצור מרחבים משותפים ב- |
create_ |
זה שינוי אופציונלי. לא ניתן לשינוי. במרחבים משותפים שנוצרו ב-Chat, השעה שבה המרחב נוצר. השדה הזה מיועד לפלט בלבד, למעט כשמשתמשים בו במרחבים משותפים במצב ייבוא. במרחבים משותפים במצב ייבוא, צריך להגדיר את השדה הזה לחותמת הזמן ההיסטורית שבה המרחב המשותף נוצר במקור, כדי לשמור על שעת היצירה המקורית. מאוכלס בפלט רק כאשר הערך של |
last_ |
פלט בלבד. חותמת הזמן של ההודעה האחרונה במרחב המשותף. |
admin_ |
פלט בלבד. במרחבים משותפים של צ'אט אישי (DM) באפליקציית Chat, אם המרחב נוצר על ידי אדמין ב-Google Workspace. אדמינים יכולים להתקין ולהגדיר צ'אט אישי עם אפליקציית Chat בשם המשתמשים בארגון שלהם. כדי לתמוך בהתקנה על ידי אדמין, אפליקציית Chat צריכה לכלול צ'אטים אישיים. |
membership_ |
פלט בלבד. מספר החברויות במועדון שמקובצות לפי סוג החבר. המאפיין מאוכלס כשהערך של |
access_ |
זה שינוי אופציונלי. מציין את הגדרת הגישה של המרחב המשותף. השדה מאוכלס רק כשהערך של |
space_ |
פלט בלבד. ה-URI של המשתמש כדי לגשת למרחב המשותף. |
import_ |
פלט בלבד. המועד שבו המערכת תמחק את המרחב באופן אוטומטי אם הוא יישאר במצב ייבוא. כל מרחבים משותפים שנוצרים במצב ייבוא צריכים לצאת מהמצב הזה לפני זמן התפוגה באמצעות השדה הזה מתמלא רק במרחבים משותפים שנוצרו באמצעות מצב הייבוא. |
customer |
זה שינוי אופציונלי. לא ניתן לשינוי. מספר הלקוח של הדומיין של המרחב המשותף. חובה רק כשיוצרים מרחב משותף עם אימות באפליקציה ו- בפורמט בשיחות אישיות, השדה הזה לא מאוכלס. |
שדה האיחוד נדרש אימות משתמש. הערך של |
|
predefined_ |
זה שינוי אופציונלי. קלט בלבד. הגדרות מוגדרות מראש של הרשאות במרחב המשותף, שאפשר להזין רק כשיוצרים מרחב משותף. אם השדה לא מוגדר, נוצר מרחב שיתוף פעולה. אחרי שתיצרו את המרחב המשותף, ההגדרות יאוכלסו בשדה |
permission_ |
זה שינוי אופציונלי. הגדרות ההרשאות במרחבים משותפים קיימים. קלט לעדכון ההגדרות המדויקות של הרשאות המרחב המשותף, שבו הגדרות ההרשאות הקיימות מוחלפות. הפלט מציג את הגדרות ההרשאות הנוכחיות. |
AccessSettings
מייצג את הגדרת הגישה של המרחב המשותף.
שדות | |
---|---|
access_ |
פלט בלבד. מציין את סטטוס הגישה למרחב המשותף. |
audience |
זה שינוי אופציונלי. שם המשאב של קהל היעד שיכול למצוא את המרחב המשותף, להצטרף אליו ולראות תצוגה מקדימה של ההודעות במרחב המשותף. אם לא תגדירו את ההגדרה הזו, רק משתמשים או קבוצות Google שהוזמנו או נוספו למרחב המשותף בנפרד יוכלו לגשת אליו. מידע נוסף זמין במאמר איך הופכים מרחב משותף לגלוי לקהל יעד. פורמט: כדי להשתמש בקהל היעד שמוגדר כברירת מחדל לארגון ב-Google Workspace, צריך להגדיר את הערך קריאת קהל היעד תומכת באפשרויות הבאות:
השדה הזה לא מאוכלס כשמשתמשים בהיקף כדי להגדיר את קהל היעד, נדרש אימות משתמש. |
AccessState
מייצג את סטטוס הגישה למרחב המשותף.
טיפוסים בני מנייה (enum) | |
---|---|
ACCESS_STATE_UNSPECIFIED |
סטטוס הגישה לא ידוע או לא נתמך ב-API הזה. |
PRIVATE |
רק משתמשים או קבוצות מ-Google Groups שנוספו או הוזמנו בנפרד על ידי משתמשים אחרים או אדמינים ב-Google Workspace יכולים לגלות את המרחב המשותף ולגשת אליו. |
DISCOVERABLE |
מנהל המרחב המשותף העניק לקהל היעד גישה למרחב. גם משתמשים או קבוצות Google שנוספו או הוזמנו למרחב המשותף בנפרד יכולים לגלות אותו ולגשת אליו. מידע נוסף זמין במאמר הצגת המרחב המשותף למשתמשים ספציפיים. כדי ליצור מרחבים משותפים שגלויים לכולם, צריך לבצע אימות משתמש. |
MembershipCount
מספר החברים במרחב המשותף, שמקובצים לקטגוריות.
שדות | |
---|---|
joined_ |
פלט בלבד. מספר המשתמשים האנושיים שהצטרפו למרחב המשותף ישירות, לא כולל משתמשים שהצטרפו כי הם חברים בקבוצה שהצטרפה למרחב המשותף. |
joined_ |
פלט בלבד. מספר כל הקבוצות שהצטרפו ישירות למרחב המשותף. |
PermissionSetting
מייצג הגדרת הרשאה במרחב משותף.
שדות | |
---|---|
managers_ |
זה שינוי אופציונלי. אם למנהלי המרחבים המשותפים יש את ההרשאה הזו. |
members_ |
זה שינוי אופציונלי. אם לחברים שאינם מנהלים יש את ההרשאה הזו. |
PermissionSettings
הגדרות הרשאות שאפשר לציין כשמעדכנים מרחב משותף קיים בעל שם.
כדי להגדיר את הגדרות ההרשאות כשיוצרים מרחב משותף, מציינים את השדה PredefinedPermissionSettings
בבקשה.
שדות | |
---|---|
manage_ |
זה שינוי אופציונלי. הגדרה לניהול המשתתפים והקבוצות במרחב המשותף. |
modify_ |
זה שינוי אופציונלי. הגדרה לעדכון השם, התמונה, התיאור וההנחיות של המרחב המשותף. |
toggle_ |
זה שינוי אופציונלי. ההגדרה להפעלה או להשבתה של היסטוריית המרחב המשותף. |
use_ |
זה שינוי אופציונלי. ההגדרה של השימוש ב-'הכול' במרחב משותף. |
manage_ |
זה שינוי אופציונלי. הגדרה לניהול האפליקציות במרחב משותף. |
manage_ |
זה שינוי אופציונלי. הגדרה לניהול webhooks במרחב משותף. |
post_ |
פלט בלבד. ההגדרה הזו קובעת אם אפשר לפרסם הודעות במרחב המשותף. |
reply_ |
זה שינוי אופציונלי. ההגדרה הזו קובעת איך משיבים להודעות במרחב משותף. |
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 |
צ'אטים אישיים (DM) בין שני אנשים ושיחות קבוצתיות עם 3 אנשים או יותר. |
SpaceType
סוג המרחב המשותף. חובה כשיוצרים או מעדכנים מרחב משותף. פלט רק לשימוש אחר.
טיפוסים בני מנייה (enum) | |
---|---|
SPACE_TYPE_UNSPECIFIED |
שמור. |
SPACE |
מקום שבו אנשים שולחים הודעות, משתפים קבצים ועובדים יחד. SPACE יכול לכלול אפליקציות של Chat. |
GROUP_CHAT |
שיחות קבוצתיות עם 3 אנשים או יותר. GROUP_CHAT יכול לכלול אפליקציות Chat. |
DIRECT_MESSAGE |
הודעות אישיות בין שני אנשים או בין אדם לאפליקציית Chat. |
סוג
האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-SpaceType
.
טיפוסים בני מנייה (enum) | |
---|---|
TYPE_UNSPECIFIED |
שמור. |
ROOM |
שיחות בין שני אנשים או יותר. |
DM |
צ'אט אישי בין אדם לאפליקציית Chat, שבו כל ההודעות מוצגות ברצף. חשוב לזכור שההגדרה הזו לא כוללת צ'אטים אישיים בין שני בני אדם. |
SpaceBatchUpdatedEventData
נתוני עומס האירוע עבור מספר עדכונים במרחב משותף.
סוג האירוע: google.workspace.chat.space.v1.batchUpdated
שדות | |
---|---|
spaces[] |
רשימה של מרחבים משותפים מעודכנים. |
SpaceEvent
אירוע שמייצג שינוי או פעילות במרחב משותף ב-Google Chat. מידע נוסף זמין במאמר עבודה עם אירועים מ-Google Chat.
שדות | |
---|---|
name |
שם המשאב של אירוע המרחב המשותף. פורמט: |
event_ |
השעה שבה התרחש האירוע. |
event_ |
סוג האירוע במרחב המשותף. לכל סוג אירוע יש גרסה של קבוצה, שמייצגת מספר מופעים של סוג האירוע שמתרחשים בפרק זמן קצר. בבקשות סוגי האירועים הנתמכים להודעות:
סוגי האירועים הנתמכים למינויים:
סוגי האירועים הנתמכים לתגובות:
סוגי האירועים הנתמכים לגבי המרחבים המשותפים:
|
שדה האיחוד הערך של |
|
message_ |
עומס הנתונים של אירוע להודעה חדשה. סוג האירוע: |
message_ |
עומס העבודה של האירוע עבור הודעה מעודכנת. סוג האירוע: |
message_ |
עומס העבודה של האירוע עבור הודעה שנמחקה. סוג האירוע: |
message_ |
עומס נתונים של אירוע לכמה הודעות חדשות. סוג האירוע: |
message_ |
עומס העבודה של האירוע עבור מספר הודעות מעודכנות. סוג האירוע: |
message_ |
עומס העבודה של האירוע עבור כמה הודעות שנמחקו. סוג האירוע: |
space_ |
נתוני עומס האירוע לעדכון של מרחב משותף. סוג האירוע: |
space_ |
נתוני עומס האירוע עבור מספר עדכונים במרחב משותף. סוג האירוע: |
membership_ |
נתוני עומס האירוע עבור חברות חדשה במועדון. סוג האירוע: |
membership_ |
נתוני עומס האירוע של מינוי מעודכן. סוג האירוע: |
membership_ |
עומס העבודה של האירוע עבור מינוי שנמחק. סוג האירוע: |
membership_ |
עומס העבודה של האירוע עבור כמה חברויות חדשות. סוג האירוע: |
membership_ |
עומס העבודה של האירוע עבור כמה מינויים מעודכנים. סוג האירוע: |
membership_ |
נתוני עומס האירוע של כמה מינויים שנמחקו. סוג האירוע: |
reaction_ |
נתוני העומס של האירוע לתגובה חדשה. סוג האירוע: |
reaction_ |
נתוני העומס של האירוע לתגובה שנמחקה. סוג האירוע: |
reaction_ |
נתוני עומס האירוע של מספר תגובות חדשות. סוג האירוע: |
reaction_ |
נתוני עומס האירוע של מספר תגובות שנמחקו. סוג האירוע: |
SpaceNotificationSetting
הגדרות ההתראות של משתמש במרחב משותף.
שדות | |
---|---|
name |
מזהה. שם המשאב של הגדרת ההתראות של המרחב המשותף. פורמט: |
notification_ |
הגדרת ההתראות. |
mute_ |
ההגדרה של השתקת ההתראות במרחב המשותף. |
MuteSetting
סוגי ההגדרות להשתקת ההתראות במרחב המשותף.
טיפוסים בני מנייה (enum) | |
---|---|
MUTE_SETTING_UNSPECIFIED |
שמור. |
UNMUTED |
המשתמש יקבל התראות על המרחב המשותף בהתאם להגדרת ההתראות. |
MUTED |
המשתמש לא יקבל התראות על המרחב המשותף, ללא קשר להגדרת ההתראות. |
NotificationSetting
סוגי ההגדרות של ההתראות.
טיפוסים בני מנייה (enum) | |
---|---|
NOTIFICATION_SETTING_UNSPECIFIED |
שמור. |
ALL |
התראות מופעלות על ידי אזכורים עם @, שרשורים במעקב, ההודעה הראשונה בשרשורים חדשים. כל השרשורים החדשים יתווספו באופן אוטומטי למעקב, אלא אם המשתמש יבטל את המעקב אחריהם באופן ידני. |
MAIN_CONVERSATIONS |
ההתראה מופעלת על ידי אזכורים, שרשורים במעקב, ההודעה הראשונה בשרשורים חדשים. האפשרות לא זמינה בצ'אטים אישיים. |
FOR_YOU |
ההתראה מופעלת על ידי אזכורים ב-@ ושרשורים שבמעקב. האפשרות לא זמינה בצ'אטים אישיים. |
OFF |
ההתראה מושבתת. |
SpaceReadState
מצב הקריאה של משתמש במרחב משותף, שמאפשר לזהות הודעות שקראתם והודעות שעדיין לא קראתם.
שדות | |
---|---|
name |
שם המשאב של מצב הקריאה של המרחב המשותף. פורמט: |
last_ |
זה שינוי אופציונלי. השעה שבה עודכן סטטוס הקריאה של המשתמש במרחב המשותף. בדרך כלל, היא תואמת לחותמת הזמן של ההודעה האחרונה שקראתם, או לחותמת זמן שציין המשתמש כדי לסמן את מיקום הקריאה האחרון במרחב המשותף. |
SpaceUpdatedEventData
נתוני המטען של האירוע למרחב משותף מעודכן.
סוג האירוע: google.workspace.chat.space.v1.updated
שדות | |
---|---|
space |
המרחב המשותף המעודכן. |
שרשור
שרשור במרחב משותף ב-Google Chat. דוגמאות לשימוש מפורטות במאמר התחלת שרשור הודעות או מענה לשרשור.
אם מציינים שיחה כשיוצרים הודעה, אפשר להגדיר את השדה messageReplyOption
כדי לקבוע מה יקרה אם לא תמצא שיחה תואמת.
שדות | |
---|---|
name |
מזהה. שם המשאב של השרשור. לדוגמה: |
thread_ |
זה שינוי אופציונלי. קלט ליצירה או לעדכון של שרשור. אחרת, פלט בלבד. המזהה של השרשור. אפשר להזין עד 4,000 תווים. המזהה הזה ייחודי לאפליקציית Chat שמגדירה אותו. לדוגמה, אם כמה אפליקציות Chat יוצרות הודעה באמצעות אותו מפתח שרשור, ההודעות יפורסמו בשרשורים שונים. כדי לענות בשרשור שנוצר על ידי אדם או על ידי אפליקציית Chat אחרת, צריך לציין במקום זאת את השדה |
ThreadReadState
מצב הקריאה של המשתמש בשרשור, המשמש לזיהוי הודעות שקראתם והודעות שעדיין לא קראתם.
שדות | |
---|---|
name |
שם המשאב של מצב הקריאה של השרשור. פורמט: |
last_ |
המועד שבו סטטוס הקריאה של המשתמש בשרשור עודכן. בדרך כלל, היא תואמת לחותמת הזמן של ההודעה האחרונה שנקראה בשרשור. |
UpdateMembershipRequest
הודעה עם בקשה לעדכון של חברות בקבוצה.
שדות | |
---|---|
membership |
חובה. החברות שרוצים לעדכן. רק השדות שצוינו על ידי |
update_ |
חובה. נתיבי השדות שרוצים לעדכן. כדי להפריד בין ערכים מרובים, צריך להשתמש בפסיקים או להשתמש ב- נכון לעכשיו, אלה נתיבי השדות הנתמכים:
|
use_ |
זה שינוי אופציונלי. כשהערך של המשתמש שמבצע את הקריאה חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים. נדרשת הרשאת OAuth 2.0 |
UpdateMessageRequest
שליחת בקשה לעדכון הודעה.
שדות | |
---|---|
message |
חובה. הודעה עם השדות המעודכנים. |
update_ |
חובה. נתיבי השדות שרוצים לעדכן. כדי להפריד בין ערכים מרובים, צריך להשתמש בפסיקים או להשתמש ב- נכון לעכשיו, אלה נתיבי השדות הנתמכים:
|
allow_ |
זה שינוי אופציונלי. אם |
UpdateSpaceNotificationSettingRequest
מבקשים לעדכן את הגדרות ההתראות של המרחב המשותף. התכונה תומכת רק בעדכון של הגדרת ההתראות של המשתמש שמבצע את השיחה.
שדות | |
---|---|
space_ |
חובה. שם המשאב של הגדרות ההתראות של המרחב צריך להיות מאוכלס בפורמט |
update_ |
חובה. נתיבי שדות נתמכים: - |
UpdateSpaceReadStateRequest
הודעת בקשה ל-UpdateSpaceReadState API.
שדות | |
---|---|
space_ |
חובה. מצב הקריאה של המרחב המשותף והשדות שרוצים לעדכן. תומכת רק בעדכון של סטטוס הקריאה של המשתמש הקורא. כדי להפנות למשתמש הקורא, מגדירים את אחת מהאפשרויות הבאות:
פורמט: users/{user}/spaces/{space}/spaceReadState |
update_ |
חובה. נתיבי השדות שרוצים לעדכן. נכון לעכשיו, אלה נתיבי השדות הנתמכים:
אם הערך של כדי לסמן את המרחב המשותף כנקרא, מגדירים את |
UpdateSpaceRequest
בקשה לעדכון מרחב משותף אחד.
שדות | |
---|---|
space |
חובה. מרחב משותף עם שדות שרוצים לעדכן. צריך לאכלס את |
update_ |
חובה. נתיבים של שדות מעודכנים, מופרדים בפסיקים אם יש כמה. אתם יכולים לעדכן את השדות הבאים במרחב המשותף:
|
use_ |
זה שינוי אופציונלי. כשהערך של המשתמש שמבצע את הקריאה חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים. נדרשת הרשאת OAuth 2.0 חלק מהערכים של |
משתמש
משתמש ב-Google Chat. כשהפלט מוחזר מבקשה, אם אפליקציית Chat מאמתת כמשתמש, הפלט של משאב User
מאכלס רק את name
ו-type
של המשתמש.
שדות | |
---|---|
name |
שם המשאב של פורמט: עבור
|
display_ |
פלט בלבד. השם המוצג של המשתמש. |
domain_ |
המזהה הייחודי של הדומיין של המשתמש ב-Google Workspace. |
type |
סוג המשתמש. |
is_ |
פלט בלבד. כשהערך של |
סוג
טיפוסים בני מנייה (enum) | |
---|---|
TYPE_UNSPECIFIED |
ערך ברירת המחדל של ה-enum. אין להשתמש בו. |
HUMAN |
משתמש אנושי. |
BOT |
משתמש באפליקציית Chat. |
UserMentionMetadata
מטא-נתונים של הערות לגבי אזכורים של משתמשים (@).
שדות | |
---|---|
user |
המשתמש שצוין. |
type |
סוג האזכור של המשתמש. |
סוג
טיפוסים בני מנייה (enum) | |
---|---|
TYPE_UNSPECIFIED |
ערך ברירת המחדל של ה-enum. אין להשתמש. |
ADD |
מוסיפים את המשתמש למרחב המשותף. |
MENTION |
להזכיר את המשתמש במרחב המשותף. |
WidgetMarkup
ווידג'ט הוא רכיב בממשק המשתמש שמוצגים בו טקסט ותמונות.
שדות | |
---|---|
buttons[] |
רשימת לחצנים. Buttons הוא גם |
שדה האיחוד data . אפשר להוסיף ל-WidgetMarkup רק אחד מהפריטים הבאים. אפשר להשתמש במספר שדות WidgetMarkup כדי להציג יותר פריטים. הערך של data יכול להיות רק אחת מהאפשרויות הבאות: |
|
text_ |
הצגת פסקה של טקסט בווידג'ט הזה. |
image |
הצגת תמונה בווידג'ט הזה. |
key_ |
הצגת פריט של ערך מפתח בווידג'ט הזה. |
לחצן
לחצן. יכול להיות לחצן טקסט או לחצן תמונה.
שדות | |
---|---|
שדה האיחוד הערך של |
|
text_ |
לחצן עם טקסט ופעולה |
image_ |
לחצן עם תמונה ופעולה |
FormAction
פעולת טופס מתארת את ההתנהגות כששולחים את הטופס. לדוגמה, אפשר להפעיל את Apps Script כדי לטפל בטופס.
שדות | |
---|---|
action_ |
שם השיטה משמש לזיהוי החלק בטופס שהפעיל את שליחת הטופס. המידע הזה מוחזר לאפליקציית 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_ |
כתובת האתר של התמונה. |
on_ |
הפעולה |
aspect_ |
יחס הגובה-רוחב של התמונה הזו (רוחב וגובה). השדה הזה מאפשר לכם להקצות את הגובה הנכון לתמונה בזמן ההמתנה לטעינה שלה. הוא לא נועד לשנות את יחס הגובה-רוחב המובנה של התמונה. אם לא מגדירים את הפרמטר, השרת ממלא אותו על ידי אחזור מראש של התמונה. |
ImageButton
לחצן תמונה עם פעולה onclick
.
שדות | |
---|---|
on_ |
הפעולה |
name |
השם של |
שדה האיחוד icons . אפשר לציין את הסמל באמצעות Icon enum או כתובת URL. הערך של icons יכול להיות רק אחת מהאפשרויות הבאות: |
|
icon |
הסמל שצוין על ידי |
icon_ |
הסמל שצוין באמצעות כתובת URL. |
KeyValue
רכיב בממשק המשתמש מכיל מפתח (תווית) וערך (תוכן). הרכיב הזה יכול להכיל גם פעולות מסוימות, כמו לחצן onclick
.
שדות | |
---|---|
top_ |
הטקסט של התווית העליונה. יש תמיכה בטקסט מעוצב. מידע נוסף על עיצוב טקסט זמין במאמרים עיצוב טקסט באפליקציות של Google Chat ועיצוב טקסט בתוספים של Google Workspace. |
content |
הטקסט של התוכן. יש תמיכה בטקסט מעוצב ותמיד צריך להשתמש בטקסט כזה. מידע נוסף על עיצוב טקסט זמין במאמרים עיצוב טקסט באפליקציות של Google Chat ועיצוב טקסט בתוספים של Google Workspace. |
content_ |
אם התוכן צריך להיות בכמה שורות. |
bottom_ |
הטקסט של התווית התחתונה. יש תמיכה בטקסט מעוצב. מידע נוסף על עיצוב טקסט זמין במאמרים עיצוב טקסט באפליקציות של Google Chat ועיצוב טקסט בתוספים של Google Workspace. |
on_ |
הפעולה |
שדה האיחוד icons . צריך להגדיר לפחות אחד מהסמלים, top_label ו-bottom_label . הערך של icons יכול להיות רק אחת מהאפשרויות הבאות: |
|
icon |
ערך enum שמוחליף על ידי Chat API בתמונה המתאימה של הסמל. |
icon_ |
הסמל שצוין באמצעות כתובת URL. |
שדה האיחוד control . ווידג'ט בקרה. אפשר להגדיר את הערך button או את הערך switch_widget , אבל לא את שניהם. הערך של control יכול להיות רק אחת מהאפשרויות הבאות: |
|
button |
לחצן שאפשר ללחוץ עליו כדי להפעיל פעולה. |
OnClick
פעולה onclick
(לדוגמה, פתיחת קישור).
שדות | |
---|---|
שדה האיחוד הערך של |
|
action |
אם מציינים את הפעולה |
open_ |
הפעולה |
OpenLink
קישור שפותח חלון חדש.
שדות | |
---|---|
url |
כתובת ה-URL שרוצים לפתוח. |
TextButton
לחצן עם טקסט ופעולה onclick
.
שדות | |
---|---|
text |
הטקסט של הלחצן. |
on_ |
הפעולה |
TextParagraph
פסקה של טקסט. יש תמיכה בטקסט מעוצב. מידע נוסף על עיצוב טקסט זמין במאמרים עיצוב טקסט באפליקציות של Google Chat ועיצוב טקסט בתוספים של Google Workspace.
שדות | |
---|---|
text |
|