Package google.chat.v1

אינדקס

ChatService

הפלטפורמה מאפשרת למפתחים ליצור אפליקציות ושילובים של Chat בפלטפורמת Google Chat.

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

השלמת תהליך הייבוא של המרחב המשותף שצוין והפיכתו לגלוי למשתמשים.

נדרשים אימות אפליקציה והענקת גישה ברמת הדומיין. מידע נוסף זמין במאמר מתן הרשאה לאפליקציות של Google Chat לייבא נתונים.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/chat.import

מידע נוסף זמין במדריך ההרשאות.
CreateCustomEmoji

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

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

נדרש אימות משתמש.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/chat.customemojis

מידע נוסף זמין במדריך ההרשאות.
CreateMembership

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

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

יש תמיכה בסוגי האימות הבאים:

דוגמאות לשימוש:

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

מידע נוסף זמין במדריך ההרשאות.
CreateMessage

rpc CreateMessage(CreateMessageRequest) returns (Message)

יצירת הודעה במרחב משותף ב-Google Chat. לדוגמה, ראו שליחת הודעה.

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

בתמונה הבאה אפשר לראות איך Chat משייך הודעה כשמשתמשים באימות באפליקציה. ב-Chat מוצגת אפליקציית Chat כשולח ההודעה. תוכן ההודעה יכול לכלול טקסט (text), כרטיסים (cardsV2) וווידג'טים נלווים (accessoryWidgets).

הודעה שנשלחה עם אימות באפליקציה

בתמונה הבאה אפשר לראות איך מערכת Chat משייכת הודעה כשמשתמשים באימות משתמשים. ב-Chat, המשתמש מוצג כשולח ההודעה, והשם של אפליקציית Chat מוצג בהודעה כדי לשייך אותה לאפליקציה. תוכן ההודעה יכול להכיל רק טקסט (text).

שליחת הודעה עם אימות משתמש

הגודל המקסימלי של הודעה, כולל תוכן ההודעה, הוא 32,000 בייטים.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

מידע נוסף זמין במדריך ההרשאות.
CreateReaction

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

יוצרים תגובה ומוסיפים אותה להודעה. יש תמיכה רק באמוג'י של Unicode. לדוגמה, ראו הוספת תגובה להודעה.

נדרש אימות משתמש.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

מידע נוסף זמין במדריך ההרשאות.
CreateSpace

rpc CreateSpace(CreateSpaceRequest) returns (Space)

יצירת מרחב משותף. אפשר להשתמש בה כדי ליצור מרחב משותף או צ'אט קבוצתי ב-Import mode. לדוגמה, ראו יצירת מרחב משותף.

יש תמיכה בסוגי האימות הבאים:

כשמבצעים אימות כאפליקציה, צריך להגדיר את השדה space.customer בבקשה.

החברים במרחב המשותף בזמן היצירה שלו תלויים במקום שבו הוא נוצר ב-Import mode:

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

אם מופיעה הודעת השגיאה ALREADY_EXISTS כשיוצרים מרחבים משותפים, מנסים displayName אחר. יכול להיות שכבר יש מרחב משותף בארגון ב-Google Workspace עם השם המוצג הזה.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.app.spaces.create
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

מידע נוסף זמין במדריך ההרשאות.
DeleteCustomEmoji

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

מחיקה של אמוג'י בהתאמה אישית.

נדרש אימות משתמש.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/chat.customemojis

מידע נוסף זמין במדריך ההרשאות.
DeleteMembership

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

מחיקה של מינוי. לדוגמה, אפשר לעיין במאמר הסרת משתמש או אפליקציית Google Chat ממרחב משותף.

יש תמיכה בסוגי האימות הבאים:

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

מידע נוסף זמין במדריך ההרשאות.
DeleteMessage

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

מחיקת הודעה. דוגמה לכך מופיעה במאמר מחיקת הודעה.

יש תמיכה בסוגי האימות הבאים:

כשמשתמשים באימות אפליקציה, הבקשות יכולות למחוק רק הודעות שנוצרו על ידי אפליקציית Chat שבה מתבצעת הקריאה.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

מידע נוסף זמין במדריך ההרשאות.
DeleteReaction

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

מחיקת תגובה להודעה. יש תמיכה רק באמוג'י של Unicode. דוגמה לכך מופיעה במאמר מחיקת תגובה.

נדרש אימות משתמש.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

מידע נוסף זמין במדריך ההרשאות.
DeleteSpace

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

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

יש תמיכה בסוגי האימות הבאים:

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.app.delete
  • https://www.googleapis.com/auth/chat.admin.delete
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.delete

מידע נוסף זמין במדריך ההרשאות.
FindDirectMessage

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

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

עם אימות אפליקציה, הפונקציה מחזירה את המרחב של הצ'אט האישי בין המשתמש שצוין לבין אפליקציית Chat שבה מתבצעת הקריאה.

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

// יש תמיכה בסוגי אימות הבאים:

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

מידע נוסף זמין במדריך ההרשאות.
GetAttachment

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

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

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/chat.bot

מידע נוסף זמין במדריך ההרשאות.
GetCustomEmoji

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

הפונקציה מחזירה פרטים על אמוג'י מותאם אישית.

נדרש אימות משתמש.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

מידע נוסף זמין במדריך ההרשאות.
GetMembership

rpc GetMembership(GetMembershipRequest) returns (Membership)

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

יש תמיכה בסוגי האימות הבאים:

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

מידע נוסף זמין במדריך ההרשאות.
GetMessage

rpc GetMessage(GetMessageRequest) returns (Message)

הפונקציה מחזירה פרטים על הודעה. דוגמה לכך מופיעה במאמר איך מוצאים פרטים על הודעה.

יש תמיכה בסוגי האימות הבאים:

הערה: יכול להיות שתקבלו הודעה ממשתמש או ממרחב משותף שחסמתם.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

מידע נוסף זמין במדריך ההרשאות.
GetSpace

rpc GetSpace(GetSpaceRequest) returns (Space)

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

יש תמיכה בסוגי האימות הבאים:

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.spaces

מידע נוסף זמין במדריך ההרשאות.
GetSpaceEvent

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

הפונקציה מחזירה אירוע ממרחבים משותפים ב-Google Chat. המטען הייעודי (Payload) של האירוע מכיל את הגרסה האחרונה של המשאב שהשתנה. לדוגמה, אם מבקשים אירוע לגבי הודעה חדשה אבל ההודעה עודכנה מאוחר יותר, השרת מחזיר את המשאב המעודכן Message בתוכן של האירוע.

הערה: השדה permissionSettings לא מוחזר באובייקט המרחב המשותף של נתוני האירועים במרחב המשותף לבקשה הזו.

נדרש אימות משתמש. כדי לקבל אירוע, המשתמש המאומת צריך להיות חבר במרחב המשותף.

דוגמה לכך מופיעה במאמר איך רואים פרטים על אירוע במרחב משותף ב-Google Chat.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

מידע נוסף זמין במדריך ההרשאות.
GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

הפונקציה מקבלת את הגדרות המצב של התראות במרחב המשותף.

נדרש אימות משתמש.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/chat.users.spacesettings

מידע נוסף זמין במדריך ההרשאות.
GetSpaceReadState

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

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

נדרש אימות משתמש.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

מידע נוסף זמין במדריך ההרשאות.
GetThreadReadState

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

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

נדרש אימות משתמש.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

מידע נוסף זמין במדריך ההרשאות.
ListCustomEmojis

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

רשימה של אמוג'י מותאמים אישית שגלויים למשתמש המאומת.

נדרש אימות משתמש.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

מידע נוסף זמין במדריך ההרשאות.
ListMemberships

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

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

יש תמיכה בסוגי האימות הבאים:

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

מידע נוסף זמין במדריך ההרשאות.
ListMessages

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

הצגת הודעות במרחב משותף שהמבצע של הקריאה הוא חבר בו, כולל הודעות מחברים וממרחבים חסומים. אם תציגו רשימה של הודעות ממרחב משותף בלי הודעות, התגובה תהיה אובייקט ריק. כשמשתמשים בממשק REST/HTTP, התגובה מכילה אובייקט JSON ריק, {}. דוגמה מופיעה בקטע רשימת הודעות.

נדרש אימות משתמש.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

מידע נוסף זמין במדריך ההרשאות.
ListReactions

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

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

נדרש אימות משתמש.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

מידע נוסף זמין במדריך ההרשאות.
ListSpaceEvents

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

הצגת רשימה של אירועים במרחב משותף ב-Google Chat. מטען הייעודי של כל אירוע מכיל את הגרסה האחרונה של משאב Chat. לדוגמה, אם תציגו אירועים לגבי חברים חדשים במרחב המשותף, השרת יחזיר משאבי Membership שמכילים את פרטי החברות העדכניים ביותר. אם חברים חדשים הוסרו במהלך התקופה המבוקשת, המטען הייעודי (payload) של האירוע מכיל משאב Membership ריק.

נדרש אימות משתמש. כדי להציג את האירועים, המשתמש המאומת צריך להיות חבר במרחב המשותף.

דוגמה לכך מופיעה במאמר הצגת רשימת אירועים במרחב משותף ב-Google Chat.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

מידע נוסף זמין במדריך ההרשאות.
ListSpaces

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

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

יש תמיכה בסוגי האימות הבאים:

כדי לקבל רשימה של כל המרחבים המשותפים שנקראו לפי ארגון ב-Google Workspace, צריך להשתמש במקום זאת בשיטה spaces.search() באמצעות הרשאות אדמין ב-Workspace.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

מידע נוסף זמין במדריך ההרשאות.
SearchSpaces

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

הפונקציה מחזירה רשימה של מרחבים משותפים בארגון ב-Google Workspace על סמך חיפוש של אדמין.

נדרשת אימות משתמש עם הרשאות אדמין. בבקשה, מגדירים את use_admin_access ל-true.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

מידע נוסף זמין במדריך ההרשאות.
SetUpSpace

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

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

כדי לציין את חברי הקבוצה האנושיים שרוצים להוסיף, מוסיפים חברויות עם membership.member.name המתאים. כדי להוסיף משתמש אנושי, משתמשים ב-users/{user}, כאשר {user} יכולה להיות כתובת האימייל של המשתמש. למשתמשים באותו ארגון ב-Workspace, הערך של {user} יכול להיות גם הערך של id של האדם מ-People API, או הערך של id של המשתמש ב-Directory API. לדוגמה, אם מזהה פרופיל המשתמש ב-People API של user@example.com הוא 123456789, אפשר להוסיף את המשתמש למרחב המשותף על ידי הגדרת membership.member.name לערך users/user@example.com או users/123456789.

כדי לציין את קבוצות Google שרוצים להוסיף, מוסיפים חברויות באמצעות membership.group_member.name המתאים. כדי להוסיף או להזמין קבוצת Google, משתמשים ב-groups/{group}, כאשר {group} הוא id של הקבוצה מ-Cloud Identity Groups API. לדוגמה, אפשר להשתמש ב-Cloud Identity Groups lookup API כדי לאחזר את המזהה 123456789 של כתובת האימייל הקבוצתית group@example.com, ואז להוסיף את הקבוצה למרחב המשותף על ידי הגדרת membership.group_member.name לערך groups/123456789. אי אפשר לשלוח אימיילים לקבוצות, ואפשר להוסיף קבוצות מקבוצות Google רק כחברים במרחבים משותפים עם שם.

במרחבים משותפים או בצ'אטים קבוצתיים עם שם, אם מבצע הקריאה לחברים חוסם משתתפים מסוימים או שהם חוסמים אותו, או אם אין לו הרשאה להוסיף משתתפים מסוימים, המשתתפים האלה לא מצורפים למרחב המשותף שנוצר.

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

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

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

אין תמיכה במרחבים משותפים עם תשובות בשרשור. אם מופיעה הודעת השגיאה ALREADY_EXISTS כשאתם מגדירים מרחבים משותפים, נסו displayName אחר. יכול להיות שכבר יש מרחב משותף בארגון ב-Google Workspace עם השם המוצג הזה.

נדרש אימות משתמש.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

מידע נוסף זמין במדריך ההרשאות.
UpdateMembership

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

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

יש תמיכה בסוגי האימות הבאים:

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships

מידע נוסף זמין במדריך ההרשאות.
UpdateMessage

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

עדכון הודעה. יש הבדל בין השיטות patch ו-update. בשיטה patch נעשה שימוש בבקשה מסוג patch, ובשיטה update נעשה שימוש בבקשה מסוג put. מומלץ להשתמש בשיטה patch. דוגמה לכך מופיעה במאמר עדכון הודעה.

יש תמיכה בסוגי האימות הבאים:

כשמשתמשים באימות אפליקציה, הבקשות יכולות לעדכן רק הודעות שנוצרו על ידי אפליקציית Chat שבה מתבצעת הקריאה.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

מידע נוסף זמין במדריך ההרשאות.
UpdateSpace

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

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

אם מעדכנים את השדה displayName ומופיעה הודעת השגיאה ALREADY_EXISTS, מנסים שם לתצוגה אחר. יכול להיות שכבר יש מרחב משותף בארגון ב-Google Workspace עם השם המוצג הזה.

יש תמיכה בסוגי האימות הבאים:

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

מידע נוסף זמין במדריך ההרשאות.
UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

עדכון ההגדרות של מצב ההתראות במרחב המשותף.

נדרש אימות משתמש.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/chat.users.spacesettings

מידע נוסף זמין במדריך ההרשאות.
UpdateSpaceReadState

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

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

נדרש אימות משתמש.

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

  • https://www.googleapis.com/auth/chat.users.readstate

מידע נוסף זמין במדריך ההרשאות.

AccessoryWidget

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

שדות
שדה האיחוד action. סוג הפעולה. הערך של action יכול להיות רק אחת מהאפשרויות הבאות:
button_list

ButtonList

רשימת לחצנים.

ActionResponse

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

שדות
type

ResponseType

קלט בלבד. סוג התגובה באפליקציית Chat.
url

string

קלט בלבד. כתובת URL שמשמשת את המשתמשים לאימות או להגדרה. (רק לסוגי תשובות מסוג REQUEST_CONFIG).
dialog_action

DialogAction

קלט בלבד. תגובה לאירוע אינטראקציה שקשור לתיבת דו-שיח. צריך לצרף את ResponseType.Dialog.
updated_widget

UpdatedWidget

קלט בלבד. התגובה מהווידג'ט המעודכן.

ResponseType

סוג התגובה באפליקציית Chat.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED סוג ברירת המחדל שמטופל כ-NEW_MESSAGE.
NEW_MESSAGE מפרסמים הודעה חדשה בנושא.
UPDATE_MESSAGE מעדכנים את ההודעה באפליקציית Chat. אפשר לעשות זאת רק באירוע CARD_CLICKED שבו סוג השולח של ההודעה הוא BOT.
UPDATE_USER_MESSAGE_CARDS עדכון הכרטיסים בהודעה של משתמש. הדבר מותר רק בתגובה לאירוע MESSAGE עם כתובת URL תואמת, או לאירוע CARD_CLICKED שבו סוג השולח של ההודעה הוא HUMAN. המערכת מתעלמת מהטקסט.
REQUEST_CONFIG לבקש מהמשתמש לבצע אימות או הגדרה נוספים באופן פרטי.
DIALOG הצגת תיבת דו-שיח.
UPDATE_WIDGET שאילתה של אפשרויות להשלמה אוטומטית של טקסט בווידג'ט.

SelectionItems

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

שדות
items[]

SelectionItem

מערך של אובייקטים מהטיפוס SelectionItem.

UpdatedWidget

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

שדות
widget

string

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

SelectionItems

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

ActionStatus

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

שדות
status_code

Code

קוד הסטטוס.
user_facing_message

string

ההודעה שתשלח למשתמשים לגבי סטטוס הבקשה שלהם. אם לא מגדירים את הערך, נשלחת הודעה גנרית על סמך הערך של status_code.

הערה

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

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

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

AnnotationType

סוג ההערה.
length

int32

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

int32

אינדקס ההתחלה (מתחיל ב-0, כולל) בגוף ההודעה בטקסט פשוט שאליו המטא-נתונים האלה תואמים.
שדה האיחוד metadata. מטא-נתונים נוספים על ההערה. הערך של metadata יכול להיות רק אחת מהאפשרויות הבאות:
user_mention

UserMentionMetadata

המטא-נתונים של אזכור המשתמש.
slash_command

SlashCommandMetadata

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

AnnotationType

סוג ההערה.

טיפוסים בני מנייה (enum)
ANNOTATION_TYPE_UNSPECIFIED ערך ברירת המחדל של ה-enum. אין להשתמש.
USER_MENTION משתמש מסוים מוזכר.
SLASH_COMMAND פקודת שורת הפקודה מופעלת.

AttachedGif

קובץ GIF שצוין באמצעות כתובת URL.

שדות
uri

string

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

קובץ מצורף

קובץ מצורף ב-Google Chat.

שדות
name

string

זה שינוי אופציונלי. שם המשאב של הקובץ המצורף, בפורמט spaces/{space}/messages/{message}/attachments/{attachment}.
content_name

string

פלט בלבד. שם הקובץ המקורי של התוכן, ולא הנתיב המלא.
content_type

string

פלט בלבד. סוג התוכן (סוג ה-MIME) של הקובץ.
thumbnail_uri

string

פלט בלבד. כתובת ה-URL של התמונה הממוזערת שצריך להשתמש בה כדי להציג למשתמשים תצוגה מקדימה של הקובץ המצורף. אפליקציות צ'אט לא צריכות להשתמש בכתובת ה-URL הזו כדי להוריד את תוכן הקובץ המצורף.
download_uri

string

פלט בלבד. כתובת ה-URL להורדה שצריך להשתמש בה כדי לאפשר למשתמש אנושי להוריד את הקובץ המצורף. אפליקציות צ'אט לא צריכות להשתמש בכתובת ה-URL הזו כדי להוריד את תוכן הקובץ המצורף.
source

Source

פלט בלבד. המקור של הקובץ המצורף.
שדה האיחוד data_ref. הנתונים שמפנים לקובץ המצורף. הערך של data_ref יכול להיות רק אחת מהאפשרויות הבאות:
attachment_data_ref

AttachmentDataRef

זה שינוי אופציונלי. הפניה לנתוני הקובץ המצורף. השדה הזה משמש ליצירה או לעדכון של הודעות עם קבצים מצורפים, או עם Media API כדי להוריד את נתוני הקובץ המצורף.
drive_data_ref

DriveDataRef

פלט בלבד. הפניה לקובץ המצורף ב-Google Drive. השדה הזה משמש עם Google Drive API.

מקור

המקור של הקובץ המצורף.

טיפוסים בני מנייה (enum)
SOURCE_UNSPECIFIED שמור.
DRIVE_FILE הקובץ הוא קובץ ב-Google Drive.
UPLOADED_CONTENT הקובץ הועלה ל-Chat.

AttachmentDataRef

הפניה לנתוני הקובץ המצורף.

שדות
resource_name

string

זה שינוי אופציונלי. שם המשאב של נתוני הקובץ המצורף. השדה הזה משמש את ה-Media API כדי להוריד את נתוני הקובץ המצורף.
attachment_upload_token

string

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

CardWithId

כרטיס בהודעה ב-Google Chat.

רק אפליקציות Chat יכולות ליצור כרטיסים. אם אפליקציית Chat מאמתת כמשתמש, ההודעה לא יכולה להכיל כרטיסים.

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

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

שדות
card_id

string

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

Card

כרטיס. הגודל המקסימלי הוא 32KB.

ChatSpaceLinkData

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

שדות
space

string

המרחב של המשאב המקושר של המרחב המשותף ב-Chat.

פורמט: spaces/{space}
thread

string

השרשור של המשאב המקושר במרחב ב-Chat.

פורמט: spaces/{space}/threads/{thread}
message

string

ההודעה של המשאב המקושר של המרחב המשותף ב-Chat.

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

CompleteImportSpaceRequest

הודעה עם בקשה להשלים את תהליך הייבוא של מרחב משותף.

שדות
name

string

חובה. שם המשאב של המרחב המשותף במצב הייבוא.

פורמט: spaces/{space}

CompleteImportSpaceResponse

הודעת תגובה על השלמת תהליך הייבוא של מרחב משותף.

שדות
space

Space

המרחב של מצב הייבוא.

ContextualAddOnMarkup

אין שדות לסוג הזה.

הרכיב המסומן שמאפשר למפתחים לציין את התוכן של תוסף לפי הקשר.

קלפים

כרטיס הוא רכיב בממשק המשתמש שיכול להכיל ווידג'טים של ממשק משתמש, כמו טקסט ותמונות.

שדות
header

CardHeader

הכותרת של הכרטיס. בדרך כלל כותרת מכילה שם ותמונה.
sections[]

Section

החלקים מופרדים באמצעות קו מפריד.
card_actions[]

CardAction

הפעולות של הכרטיס הזה.
name

string

שם הכרטיס.

CardAction

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

אין תמיכה באפליקציות Google Chat.

שדות
action_label

string

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

OnClick

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

CardHeader

שדות
title

string

חובה לציין את השם. לגובה הכותרת יש ערך קבוע: אם מציינים גם כותרת וגם כותרת משנה, כל אחת מהן תופסת שורה אחת. אם מציינים רק את השם, הוא תופס את שתי השורות.
subtitle

string

כותרת המשנה של כותרת הכרטיס.
image_style

ImageStyle

סוג התמונה (לדוגמה, מסגרת ריבועית או מסגרת עגולה).
image_url

string

כתובת ה-URL של התמונה בכותרת הכרטיס.

ImageStyle

טיפוסים בני מנייה (enum)
IMAGE_STYLE_UNSPECIFIED
IMAGE גבול מרובע.
AVATAR גבול עגול.

קטע

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

שדות
header

string

הכותרת של הקטע. יש תמיכה בטקסט מעוצב. מידע נוסף על עיצוב טקסט זמין במאמרים עיצוב טקסט באפליקציות של Google Chat ועיצוב טקסט בתוספים של Google Workspace.
widgets[]

WidgetMarkup

כל קטע חייב להכיל לפחות ווידג'ט אחד.

CreateCustomEmojiRequest

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

שדות
custom_emoji

CustomEmoji

חובה. האמוג'י בהתאמה אישית שרוצים ליצור.

CreateMembershipRequest

הודעת בקשה ליצירת חברות בקבוצה.

שדות
parent

string

חובה. שם המשאב של המרחב המשותף שבו רוצים ליצור את החברות.

פורמט: spaces/{space}
membership

Membership

חובה. הקשר של החברות לקבוצה שיצרתם.

השדה memberType חייב להכיל משתמש עם שדות user.name ו-user.type מאוכלסים. השרת יקצה שם למשאב ויחליף כל דבר שצוין.

כשאפליקציית Chat יוצרת יחסי חברות של משתמש אנושי, היא חייבת להשתמש בהיקפי הרשאה מסוימים ולהגדיר ערכים ספציפיים לשדות מסוימים:

  • כשמבצעים אימות כמשתמש, נדרש היקף ההרשאה chat.memberships.

  • כשמבצעים אימות כאפליקציה, נדרש היקף ההרשאה chat.app.memberships. אפשר לבצע אימות כאפליקציה ב-

  • מגדירים את user.type כ-HUMAN ומגדירים את user.name בפורמט users/{user}, כאשר {user} יכולה להיות כתובת האימייל של המשתמש. למשתמשים באותו ארגון ב-Workspace, הערך של {user} יכול להיות גם הערך של id של האדם מ-People API, או הערך של id של המשתמש ב-Directory API. לדוגמה, אם מזהה פרופיל המשתמש ב-People API של user@example.com הוא 123456789, אפשר להוסיף את המשתמש למרחב המשותף על ידי הגדרת membership.member.name לערך users/user@example.com או users/123456789.

כדי להזמין משתמשים שאינם מהארגון ב-Workspace שבבעלותו המרחב המשותף, צריך לבצע אימות משתמשים.

כשאפליקציית צ'אט יוצרת יחס חברות עבור עצמה, היא צריכה לבצע אימות כמשתמש ולהשתמש בהיקף chat.memberships.app, להגדיר את user.type כ-BOT ולהגדיר את user.name כ-users/app.
use_admin_access

bool

זה שינוי אופציונלי. כשהערך של true הוא true, השיטה פועלת באמצעות הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמש שמבצע את הקריאה חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים.

נדרשת הרשאת OAuth 2.0 chat.admin.memberships.

אין תמיכה ביצירת מינויים לאפליקציות או ביצירת מינויים למשתמשים מחוץ לארגון של האדמין ב-Google Workspace באמצעות הרשאת אדמין.

CreateMessageRequest

יצירת הודעה.

שדות
parent

string

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

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

Message

חובה. גוף ההודעה.
thread_key
(deprecated)

string

זה שינוי אופציונלי. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-thread.thread_key. המזהה של השרשור. אפשר להזין עד 4,000 תווים. כדי להתחיל שרשור או להוסיף הודעה לשרשור קיים, יוצרים הודעה ומציינים את threadKey או את thread.name. דוגמאות לשימוש מפורטות במאמר התחלת שרשור הודעות או מענה לשרשור.
request_id

string

זה שינוי אופציונלי. מזהה בקשה ייחודי של ההודעה הזו. ציון מזהה בקשה קיים מחזיר את ההודעה שנוצרה עם המזהה הזה במקום ליצור הודעה חדשה.
message_reply_option

MessageReplyOption

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

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

string

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

הערך בשדה הזה חייב לעמוד בדרישות הבאות:

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

מידע נוסף זמין במאמר מתן שם להודעה.

MessageReplyOption

מציין איך עונים להודעה. יכול להיות שיתווספו עוד מדינות בעתיד.

טיפוסים בני מנייה (enum)
MESSAGE_REPLY_OPTION_UNSPECIFIED ברירת מחדל. התחלת שרשור חדש. אם משתמשים באפשרות הזו, המערכת מתעלמת מכל thread ID או thread_key שכלולים.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD יצירת ההודעה כתשובה לשרשור שצוין על ידי thread ID או thread_key. אם הניסיון נכשל, ההודעה תתחיל שרשור חדש במקום זאת.
REPLY_MESSAGE_OR_FAIL יצירת ההודעה כתשובה לשרשור שצוין על ידי thread ID או thread_key. אם משתמשים ב-thread_key חדש, נוצר שרשור חדש. אם יצירת ההודעה נכשלת, תוחזר במקום זאת שגיאה מסוג NOT_FOUND.

CreateReactionRequest

יצירת תגובה להודעה.

שדות
parent

string

חובה. ההודעה שבה נוצרת התגובה.

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

Reaction

חובה. התגובה שרוצים ליצור.

CreateSpaceRequest

בקשה ליצירת מרחב משותף בשם ללא חברים.

שדות
space

Space

חובה. צריך לאכלס את השדות displayName ו-spaceType. יש תמיכה רק ב-SpaceType.SPACE וב-SpaceType.GROUP_CHAT. אפשר להשתמש ב-SpaceType.GROUP_CHAT רק אם importMode מוגדר כ-True.

אם מופיעה הודעת השגיאה ALREADY_EXISTS, נסו displayName אחר. יכול להיות שכבר יש מרחב משותף בארגון ב-Google Workspace עם השם המוצג הזה.

המרחב המשותף name מוקצה בשרת, ולכן המערכת תתעלם מכל מה שיצוין בשדה הזה.
request_id

string

זה שינוי אופציונלי. מזהה ייחודי של הבקשה הזו. מומלץ להשתמש ב-UUID אקראי. ציון מזהה בקשה קיים מחזיר את המרחב המשותף שנוצר באמצעות המזהה הזה במקום ליצור מרחב משותף חדש. אם מציינים מזהה בקשה קיים מאותה אפליקציית Chat עם משתמש מאומת אחר, מתקבלת הודעת שגיאה.

CustomEmoji

מייצג אמוג'י בהתאמה אישית.

שדות
name

string

מזהה. שם המשאב של האמוג'י בהתאמה אישית, שהוקצה על ידי השרת.

פורמט: customEmojis/{customEmoji}

uid

string

פלט בלבד. מפתח ייחודי למשאב האמוג'י בהתאמה אישית.
emoji_name

string

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

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

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

לדוגמה: :valid-emoji-name:

temporary_image_uri

string

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

payload

CustomEmojiPayload

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

CustomEmojiPayload

נתוני עומס העבודה של האמוג'י בהתאמה אישית.

שדות
file_content

bytes

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

עומס העבודה צריך להיות קטן מ-256KB והמידות של התמונה צריכות להיות בין 64 ל-500 פיקסלים. המגבלות עשויות להשתנות.
filename

string

חובה. קלט בלבד. שם קובץ התמונה.

סיומות הקובץ הנתמכות: .png, ‏ .jpg, ‏ .gif.

DeleteCustomEmojiRequest

בקשה למחיקת אמוג'י בהתאמה אישית.

שדות
name

string

חובה. שם המשאב של האמוג'י בהתאמה אישית שרוצים למחוק.

פורמט: customEmojis/{customEmoji}

אפשר להשתמש בשם האמוג'י ככתובת אימייל חלופית ל-{customEmoji}. לדוגמה, customEmojis/:example-emoji:, כאשר :example-emoji: הוא שם האמוג'י בהתאמה אישית.

DeleteMembershipRequest

לבקש למחוק מישהו מהמרחב המשותף.

שדות
name

string

חובה. שם המשאב של החברות שרוצים למחוק. אפליקציות צ'אט יכולות למחוק את החברויות של משתמשים אנושיים או את החברויות שלהן. אפליקציות צ'אט לא יכולות למחוק מינויים של אפליקציות אחרות.

כשמוחקים מינוי של משתמש, צריך לציין את ההיקף chat.memberships והפורמט spaces/{space}/members/{member}. אפשר להשתמש בכתובת האימייל ככתובת חלופית ל-{member}. לדוגמה, spaces/{space}/members/example@gmail.com, כאשר example@gmail.com היא כתובת האימייל של המשתמש ב-Google Chat.

כדי למחוק חברות באפליקציה, צריך את ההיקף chat.memberships.app והפורמט spaces/{space}/members/app.

פורמט: spaces/{space}/members/{member} או spaces/{space}/members/app.
use_admin_access

bool

זה שינוי אופציונלי. כשהערך של true הוא true, השיטה פועלת באמצעות הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמש שמבצע את הקריאה חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים.

נדרשת הרשאת OAuth 2.0 chat.admin.memberships.

לא ניתן למחוק את החברויות באפליקציות במרחב משותף באמצעות הרשאת אדמין.

DeleteMessageRequest

שליחת בקשה למחיקת הודעה.

שדות
name

string

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

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

אם הגדרתם מזהה מותאם אישית להודעה, תוכלו להשתמש בערך מהשדה clientAssignedMessageId עבור {message}. מידע נוסף זמין במאמר מתן שם להודעה.
force

bool

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

רלוונטי רק כשמבצעים אימות כמשתמשים. אין לה השפעה על אימות כאפליקציית Chat.

DeleteReactionRequest

מחיקת תגובה להודעה.

שדות
name

string

חובה. השם של התגובה שרוצים למחוק.

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

DeleteSpaceRequest

בקשה למחיקת מרחב משותף.

שדות
name

string

חובה. שם המשאב של המרחב המשותף שרוצים למחוק.

פורמט: spaces/{space}
use_admin_access

bool

זה שינוי אופציונלי. כשהערך של true הוא true, השיטה פועלת באמצעות הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמש שמבצע את הקריאה חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים.

נדרשת הרשאת OAuth 2.0 chat.admin.delete.

DeletionMetadata

מידע על הודעה שנמחקה. ההודעה נמחקת כשהערך של delete_time מוגדר.

שדות
deletion_type

DeletionType

מי שמחק את ההודעה.

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

Card

קלט בלבד. גוף תיבת הדו-שיח, שמוצג בחלון מודאלי. אפליקציות Google Chat לא תומכות באובייקטים הבאים של כרטיסים: DateTimePicker, ‏ OnChangeAction.

DialogAction

מכיל תיבת דו-שיח וקוד סטטוס הבקשה.

שדות
action_status

ActionStatus

קלט בלבד. הסטטוס של בקשה להפעלה או לשליחה של שיחה. הצגת סטטוס והודעה למשתמשים, במקרה הצורך. לדוגמה, במקרה של שגיאה או הצלחה.
שדה האיחוד action. הפעולה לביצוע. הערך של action יכול להיות רק אחת מהאפשרויות הבאות:
dialog

Dialog

קלט בלבד. Dialog של הבקשה.

DriveDataRef

הפניה לנתונים של קובץ מצורף ב-Drive.

שדות
drive_file_id

string

המזהה של קובץ ה-Drive. שימוש ב-Drive API.

DriveLinkData

נתונים של קישורים ל-Google Drive.

שדות
drive_data_ref

DriveDataRef

DriveDataRef שמפנה לקובץ ב-Google Drive.
mime_type

string

סוג ה-MIME של משאב Google Drive המקושר.

אמוג'י

אמוג'י שמשמש לתגובה להודעה.

שדות
שדה האיחוד content. חובה. התוכן של האמוג'י. הערך של content יכול להיות רק אחת מהאפשרויות הבאות:
unicode

string

זה שינוי אופציונלי. אמוג'י בסיסי שמיוצג על ידי מחרוזת Unicode.
custom_emoji

CustomEmoji

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

EmojiReactionSummary

מספר האנשים שהגיבו להודעה באמוג'י ספציפי.

שדות
emoji

Emoji

פלט בלבד. האמוג'י שמשויך לתגובות.
reaction_count

int32

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

FindDirectMessageRequest

בקשה לקבלת מרחב של צ'אט אישי על סמך משאב המשתמש.

שדות
name

string

חובה. שם המשאב של המשתמש שרוצים למצוא את הצ'אט האישי איתו.

הפורמט: users/{user}, כאשר {user} הוא id של האדם מ-People API, או id של המשתמש ב-Directory API. לדוגמה, אם מזהה הפרופיל ב-People API הוא 123456789, אפשר למצוא הודעה ישירה עם אותו אדם באמצעות users/123456789 כ-name. כשמתבצעת אימות כמשתמש, אפשר להשתמש בכתובת האימייל ככתובת חלופית ל-{user}. לדוגמה, users/example@gmail.com, כאשר example@gmail.com היא כתובת האימייל של המשתמש ב-Google Chat.

GetAttachmentRequest

שולחים בקשה לקבלת קובץ מצורף.

שדות
name

string

חובה. שם המשאב של הקובץ המצורף, בפורמט spaces/{space}/messages/{message}/attachments/{attachment}.

GetCustomEmojiRequest

בקשה להחזרת אמוג'י מותאם אישית יחיד.

שדות
name

string

חובה. שם המשאב של האמוג'י המותאם אישית.

פורמט: customEmojis/{customEmoji}

אפשר להשתמש בשם האמוג'י ככתובת אימייל חלופית ל-{customEmoji}. לדוגמה, customEmojis/:example-emoji:, כאשר :example-emoji: הוא שם האמוג'י בהתאמה אישית.

GetMembershipRequest

שליחת בקשה להצטרפות למרחב משותף.

שדות
name

string

חובה. שם המשאב של המינוי שרוצים לאחזר.

כדי לקבל את החברות של האפליקציה באמצעות אימות משתמש, אפשר להשתמש ב-spaces/{space}/members/app.

פורמט: spaces/{space}/members/{member} או spaces/{space}/members/app

אפשר להשתמש בכתובת האימייל של המשתמש ככתובת חלופית ל-{member}. לדוגמה, spaces/{space}/members/example@gmail.com, כאשר example@gmail.com היא כתובת האימייל של המשתמש ב-Google Chat.
use_admin_access

bool

זה שינוי אופציונלי. כשהערך של true הוא true, השיטה פועלת באמצעות הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמש שמבצע את הקריאה חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים.

נדרשים היקפי ההרשאות של OAuth 2.0 chat.admin.memberships או chat.admin.memberships.readonly.

אי אפשר לקבל חברויות באפליקציות במרחב משותף כשמשתמשים בגישה של אדמין.

GetMessageRequest

מבקשים לקבל הודעה.

שדות
name

string

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

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

אם הגדרתם מזהה מותאם אישית להודעה, תוכלו להשתמש בערך מהשדה clientAssignedMessageId עבור {message}. מידע נוסף זמין במאמר מתן שם להודעה.

GetSpaceEventRequest

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

שדות
name

string

חובה. שם המשאב של אירוע המרחב המשותף.

פורמט: spaces/{space}/spaceEvents/{spaceEvent}

GetSpaceNotificationSettingRequest

הודעה עם בקשה לקבלת הגדרת התראות על המרחב המשותף. התכונה תומכת רק בקבלת הגדרת התראות עבור המשתמש שמבצע את השיחה.

שדות
name

string

חובה. פורמט: users/{user}/spaces/{space}/spaceNotificationSetting

  • users/me/spaces/{space}/spaceNotificationSetting, או
  • users/user@example.com/spaces/{space}/spaceNotificationSetting, או
  • users/123456789/spaces/{space}/spaceNotificationSetting. הערה: רק מזהה המשתמש או כתובת האימייל של מבצע הקריאה החוזרת מותרים בנתיבים.

GetSpaceReadStateRequest

הודעת בקשה ל-API GetSpaceReadState.

שדות
name

string

חובה. שם המשאב של מצב הקריאה של המרחב המשותף שרוצים לאחזר.

התכונה תומכת רק בקבלת סטטוס הקריאה של המשתמש הקורא.

כדי להפנות למשתמש הקורא, מגדירים את אחת מהאפשרויות הבאות:

  • הכינוי me. לדוגמה, users/me/spaces/{space}/spaceReadState.

  • כתובת האימייל שלהם ב-Workspace. לדוגמה, users/user@example.com/spaces/{space}/spaceReadState.

  • מזהה המשתמש שלהם. לדוגמה, users/123456789/spaces/{space}/spaceReadState.

פורמט: users/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

בקשה להחזרת מרחבים משותפים ספציפיים.

שדות
name

string

חובה. שם המשאב של המרחב המשותף, בפורמט spaces/{space}.

פורמט: spaces/{space}
use_admin_access

bool

זה שינוי אופציונלי. כשהערך של true הוא true, השיטה פועלת באמצעות הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמש שמבצע את הקריאה חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים.

נדרשים היקפי ההרשאות של OAuth 2.0 chat.admin.spaces או chat.admin.spaces.readonly.

GetThreadReadStateRequest

הודעת בקשה ל-API GetThreadReadStateRequest.

שדות
name

string

חובה. שם המשאב של מצב הקריאה של השרשור שרוצים לאחזר.

התכונה תומכת רק בקבלת סטטוס הקריאה של המשתמש הקורא.

כדי להפנות למשתמש הקורא, מגדירים את אחת מהאפשרויות הבאות:

  • הכינוי me. לדוגמה, users/me/spaces/{space}/threads/{thread}/threadReadState.

  • כתובת האימייל שלהם ב-Workspace. לדוגמה, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState.

  • מזהה המשתמש שלהם. לדוגמה, users/123456789/spaces/{space}/threads/{thread}/threadReadState.

פורמט: users/{user}/spaces/{space}/threads/{thread}/threadReadState

קבוצה

קבוצת Google ב-Google Chat.

שדות
name

string

שם המשאב של קבוצת Google.

מייצג קבוצה ב-Cloud Identity Groups API.

פורמט: groups/{group}

HistoryState

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

טיפוסים בני מנייה (enum)
HISTORY_STATE_UNSPECIFIED ערך ברירת המחדל. אין להשתמש בו.
HISTORY_OFF ההיסטוריה מושבתת. ההודעות והשרשורים נשמרים למשך 24 שעות.
HISTORY_ON ההיסטוריה פועלת. כללי השמירה ב-Vault של הארגון קובעים למשך כמה זמן ההודעות והשרשורים יישמרו.

ListCustomEmojisRequest

בקשה להחזרת רשימה של אמוג'י בהתאמה אישית.

שדות
page_size

int32

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

string

זה שינוי אופציונלי. (אם ממשיכים משאילתה קודמת).

אסימון דף שהתקבל מבקשת קוד אמוג'י בהתאמה אישית קודמת של רשימה. צריך לספק אותו כדי לאחזר את הדף הבא.

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

string

זה שינוי אופציונלי. מסנן שאילתות.

תמיכה בסינון לפי יוצר.

כדי לסנן לפי יוצר, צריך לציין ערך חוקי. בשלב הזה, רק creator("users/me") ו-NOT creator("users/me") יתקבלו כדי לסנן אמוג'י בהתאמה אישית לפי הקריטריון 'אם הם נוצרו על ידי המשתמש המתקשר או לא'.

לדוגמה, השאילתה הבאה מחזירה אמוג'י בהתאמה אישית שנוצר על ידי מבצע הקריאה החוזרת:

creator("users/me")

שאילתות לא חוקיות נדחות על ידי השרת עם שגיאה מסוג INVALID_ARGUMENT.

ListCustomEmojisResponse

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

שדות
custom_emojis[]

CustomEmoji

רשימה לא ממוינת. רשימת אמוג'י בהתאמה אישית בדף המבוקש (או בדף הראשון).
next_page_token

string

אסימון שאפשר לשלוח כ-pageToken כדי לאחזר את דף התוצאות הבא. אם השדה ריק, אין דפים נוספים.

ListMembershipsRequest

הודעת בקשה להצטרפות למועדון החברים של דף העסק.

שדות
parent

string

חובה. שם המשאב של המרחב המשותף שעבורו רוצים לאחזר רשימת חברים.

פורמט: spaces/{space}
page_size

int32

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

אם לא מציינים ערך, המערכת מחזירה עד 100 חברויות.

הערך המקסימלי הוא 1,000. אם משתמשים בערך גבוה מ-1,000, הוא ישתנה באופן אוטומטי ל-1,000.

ערכי שליליים מחזירים שגיאה מסוג INVALID_ARGUMENT.
page_token

string

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

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

string

זה שינוי אופציונלי. מסנן שאילתות.

אפשר לסנן את החברויות לפי התפקיד (role) והסוג (member.type) של החברים.

כדי לסנן לפי תפקיד, מגדירים את role לערך ROLE_MEMBER או ROLE_MANAGER.

כדי לסנן לפי סוג, מגדירים את member.type לערך HUMAN או BOT. אפשר גם לסנן לפי member.type באמצעות האופרטור !=.

כדי לסנן לפי תפקיד וסוג, משתמשים באופרטור AND. כדי לסנן לפי תפקיד או סוג, משתמשים באופרטור OR.

צריך להגדיר את member.type = "HUMAN" או את member.type != "BOT" כשהערך של use_admin_access מוגדר כ-true. מסננים אחרים של סוגי חברים ייפסלו.

לדוגמה, השאילתות הבאות תקינות:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

השאילתות הבאות לא תקינות:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

שאילתות לא חוקיות נדחות על ידי השרת עם שגיאה INVALID_ARGUMENT.
show_groups

bool

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

bool

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

בשלב הזה נדרש אימות משתמש.
use_admin_access

bool

זה שינוי אופציונלי. כשהערך של true הוא true, השיטה פועלת באמצעות הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמש שמבצע את הקריאה חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים.

נדרש היקף הרשאות OAuth 2.0 chat.admin.memberships.readonly או chat.admin.memberships.

אי אפשר להציג את החברויות באפליקציות במרחב משותף כשמשתמשים בגישה של אדמין.

ListMembershipsResponse

תגובה לרשימה של חברי המרחב המשותף.

שדות
memberships[]

Membership

רשימה לא ממוינת. רשימת החברויות בדף המבוקש (או בדף הראשון).
next_page_token

string

אסימון שאפשר לשלוח כ-pageToken כדי לאחזר את דף התוצאות הבא. אם השדה ריק, אין דפים נוספים.

ListMessagesRequest

הצגת רשימה של ההודעות במרחב המשותף שצוין, שהמשתמש הוא חבר בו.

שדות
parent

string

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

פורמט: spaces/{space}
page_size

int32

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

אם לא מצוין, יוחזרו עד 25 פריטים.

הערך המקסימלי הוא 1,000. אם משתמשים בערך גבוה מ-1,000, הוא ישתנה באופן אוטומטי ל-1,000.

ערכי שליליים מחזירים שגיאה מסוג INVALID_ARGUMENT.
page_token

string

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

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

string

זה שינוי אופציונלי. מסנן שאילתות.

אפשר לסנן הודעות לפי תאריך (create_time) ושרשור (thread.name).

כדי לסנן הודעות לפי התאריך שבו נוצרו, מציינים את השדה create_time עם חותמת זמן בפורמט RFC-3339 ומרכאות כפולות. לדוגמה, "2023-04-21T11:30:00-04:00". אפשר להשתמש באופרטור 'גדול מ' > כדי לקבל רשימה של הודעות שנוצרו אחרי חותמת זמן מסוימת, או באופרטור 'קטן מ' < כדי לקבל רשימה של הודעות שנוצרו לפני חותמת זמן מסוימת. כדי לסנן הודעות בתוך טווח זמן, משתמשים באופרטור AND בין שתי חותמות זמן.

כדי לסנן לפי שרשור, מציינים את thread.name בפורמט spaces/{space}/threads/{thread}. אפשר לציין רק thread.name אחד לכל שאילתה.

כדי לסנן לפי שרשור ותאריך, צריך להשתמש באופרטור AND בשאילתה.

לדוגמה, השאילתות הבאות תקינות:

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

שאילתות לא חוקיות נדחות על ידי השרת עם שגיאה מסוג INVALID_ARGUMENT.
order_by

string

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

  • ASC לסדר עולה.

  • DESC לסדר יורד.

סדר ברירת המחדל הוא create_time ASC.
show_deleted

bool

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

ListMessagesResponse

הודעת תגובה להודעות במודעות.

שדות
messages[]

Message

רשימת ההודעות.
next_page_token

string

אפשר לשלוח אסימון כ-pageToken כדי לאחזר את דף התוצאות הבא. אם השדה ריק, אין דפים נוספים.

ListReactionsRequest

רשימת התגובות להודעה.

שדות
parent

string

חובה. ההודעה שהמשתמשים הגיבו עליה.

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

int32

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

string

זה שינוי אופציונלי. (אם ממשיכים משאילתה קודמת).

אסימון דף שקיבלתם מבקשת קודמת להצגת רשימת התגובות. צריך לספק אותו כדי לאחזר את הדף הבא.

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

string

זה שינוי אופציונלי. מסנן שאילתות.

אפשר לסנן את התגובות לפי אמוג'י (emoji.unicode או emoji.custom_emoji.uid) ומשתמש (user.name).

כדי לסנן תגובות של כמה אמוג'י או משתמשים, משלבים שדות דומים באמצעות האופרטור OR, כמו emoji.unicode = "🙂" OR emoji.unicode = "👍" ו-user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

כדי לסנן תגובות לפי אמוג'י ומשתמש, משתמשים באופרטור AND, למשל emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

אם בשאילתה נעשה שימוש גם ב-AND וגם ב-OR, צריך לקבץ אותם בסוגריים.

לדוגמה, השאילתות הבאות תקינות:

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

השאילתות הבאות לא תקינות:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

שאילתות לא חוקיות נדחות על ידי השרת עם שגיאה מסוג INVALID_ARGUMENT.

ListReactionsResponse

תגובה לבקשה להציג רשימה של תגובות.

שדות
reactions[]

Reaction

רשימת התגובות בדף המבוקש (או בדף הראשון).
next_page_token

string

אסימון המשך לאחזור של דף התוצאות הבא. הוא ריק בדף התוצאות האחרון.

ListSpaceEventsRequest

הודעה לבקשת הוספת אירועים למרחב המשותף.

שדות
parent

string

חובה. שם המשאב של המרחבים המשותפים ב-Google Chat שבהם התרחשו האירועים.

פורמט: spaces/{space}
page_size

int32

זה שינוי אופציונלי. המספר המקסימלי של אירועי המרחב המשותף שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה.

ערכי שליליים מחזירים שגיאה מסוג INVALID_ARGUMENT.
page_token

string

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

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

string

חובה. מסנן שאילתות.

צריך לציין לפחות סוג אירוע אחד (event_type) באמצעות האופרטור has :. כדי לסנן לפי כמה סוגי אירועים, משתמשים באופרטור OR. להשמיט מסננים של סוגי אירועים של קבוצות. הבקשה מחזירה באופן אוטומטי את כל אירועי האצווה הקשורים. לדוגמה, אם מסננים לפי תגובות חדשות (google.workspace.chat.reaction.v1.created), השרת מחזיר גם אירועי תגובות חדשות באצווה (google.workspace.chat.reaction.v1.batchCreated). רשימה של סוגי האירועים הנתמכים מופיעה במסמכי העזרה של SpaceEvents.

אפשר גם לסנן לפי שעת ההתחלה (start_time) ושעת הסיום (end_time):

  • start_time: חותמת זמן בלעדית שממנה מתחילים לרשום אירועים במרחב המשותף. אפשר להציג אירועים שהתרחשו עד לפני 28 יום. אם לא צוין תאריך, יוצגו אירועים במרחב המשותף מ-28 הימים האחרונים.
  • end_time: חותמת זמן מקיפה עד שתוצג רשימה של אירועים במרחב המשותף. אם לא צוין תאריך, יוצגו אירועים עד למועד הבקשה.

כדי לציין זמן התחלה או זמן סיום, משתמשים באופרטור השוויון = ובפורמט RFC-3339. כדי לסנן לפי start_time וגם לפי end_time, משתמשים באופרטור AND.

לדוגמה, השאילתות הבאות תקינות:

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

השאילתות הבאות לא תקינות:

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

שאילתות לא חוקיות נדחות על ידי השרת עם שגיאת INVALID_ARGUMENT.

ListSpaceEventsResponse

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

שדות
space_events[]

SpaceEvent

התוצאות מוחזרות בסדר כרונולוגי (האירוע הישן ביותר מופיע קודם). הערה: השדה permissionSettings לא מוחזר באובייקט המרחב המשותף לבקשות רשימה.
next_page_token

string

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

ListSpacesRequest

בקשה להציג רשימה של המרחבים המשותפים שהמתקשר חבר בהם.

שדות
page_size

int32

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

אם לא צוין, המערכת תחזיר עד 100 מקומות פנויים.

הערך המקסימלי הוא 1,000. אם משתמשים בערך גבוה מ-1,000, הוא ישתנה באופן אוטומטי ל-1,000.

ערכי שליליים מחזירים שגיאה מסוג INVALID_ARGUMENT.
page_token

string

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

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

string

זה שינוי אופציונלי. מסנן שאילתות.

אפשר לסנן את המרחבים המשותפים לפי סוג המרחב (space_type).

כדי לסנן לפי סוג מרחב משותף, צריך לציין ערך enum תקין, כמו SPACE או GROUP_CHAT (הערך של space_type לא יכול להיות SPACE_TYPE_UNSPECIFIED). כדי לשלוח שאילתה לגבי כמה סוגי מרחבים משותפים, משתמשים באופרטור OR.

לדוגמה, השאילתות הבאות תקינות:

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

שאילתות לא חוקיות נדחות על ידי השרת עם שגיאת INVALID_ARGUMENT.

ListSpacesResponse

התשובה לבקשה להצגת רשימת המרחבים המשותפים.

שדות
spaces[]

Space

רשימת המרחבים בעמוד המבוקש (או בעמוד הראשון). הערה: השדה permissionSettings לא מוחזר באובייקט המרחב המשותף לבקשות רשימה.
next_page_token

string

אפשר לשלוח אסימון כ-pageToken כדי לאחזר את דף התוצאות הבא. אם השדה ריק, אין דפים נוספים.

MatchedUrl

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

שדות
url

string

פלט בלבד. כתובת ה-URL שתואמה.

מינוי

מייצג יחס חברות ב-Google Chat, למשל אם משתמש או אפליקציית Chat מוזמנים למרחב משותף, אם הם חברים בו או אם הם לא חברים בו.

שדות
name

string

מזהה. שם המשאב של המינוי, שהוקצה על ידי השרת.

פורמט: spaces/{space}/members/{member}
state

MembershipState

פלט בלבד. סטטוס החברות.
role

MembershipRole

זה שינוי אופציונלי. התפקיד של המשתמש במרחב המשותף ב-Chat, שמגדיר את הפעולות שמותר לו לבצע במרחב.

אפשר להשתמש בשדה הזה כקלט רק ב-UpdateMembership.
create_time

Timestamp

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

Timestamp

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

User

זה שינוי אופציונלי. המשתמש או האפליקציה ב-Google Chat שהמינוי תואם אליהם. אם אפליקציית Chat מבצעת אימות כמשתמש, הפלט מאכלס את השדות name ו-type של המשתמש.
group_member

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[]

MembershipCreatedEventData

רשימה של מינויים חדשים.

MembershipBatchDeletedEventData

נתוני עומס האירוע של כמה מינויים שנמחקו.

סוג האירוע: google.workspace.chat.membership.v1.batchDeleted

שדות
memberships[]

MembershipDeletedEventData

רשימה של חברויות במועדון שנמחקו.

MembershipBatchUpdatedEventData

עומס העבודה של האירוע עבור כמה מינויים מעודכנים.

סוג האירוע: google.workspace.chat.membership.v1.batchUpdated

שדות
memberships[]

MembershipUpdatedEventData

רשימה של החברויות המעודכנות.

MembershipCreatedEventData

נתוני עומס האירוע עבור חברות חדשה במועדון.

סוג האירוע: google.workspace.chat.membership.v1.created.

שדות
membership

Membership

המועדון החדש.

MembershipDeletedEventData

עומס העבודה של האירוע עבור מינוי שנמחק.

סוג האירוע: google.workspace.chat.membership.v1.deleted

שדות
membership

Membership

החברות במועדון של הערוץ שנמחקה. רק השדות name ו-state מאוכלסים.

MembershipUpdatedEventData

נתוני עומס האירוע של מינוי מעודכן.

סוג האירוע: google.workspace.chat.membership.v1.updated

שדות
membership

Membership

החברות המעודכנת.

הודעה

הודעה במרחב משותף ב-Google Chat.

שדות
name

string

מזהה. שם המשאב של ההודעה.

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

כאשר {space} הוא המזהה של המרחב שבו ההודעה פורסמה, ו-{message} הוא מזהה שהמערכת הקצה להודעה. לדוגמה, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

אם מגדירים מזהה בהתאמה אישית בזמן יצירת ההודעה, אפשר להשתמש במזהה הזה כדי לציין את ההודעה בבקשה. לשם כך, מחליפים את {message} בערך מהשדה clientAssignedMessageId. לדוגמה, spaces/AAAAAAAAAAA/messages/client-custom-name. מידע נוסף זמין במאמר מתן שם להודעה.
sender

User

פלט בלבד. המשתמש שיצר את ההודעה. אם אפליקציית Chat מבצעת אימות כמשתמש, הפלט מאכלס את השדות name ו-type של המשתמש.
create_time

Timestamp

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

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

Timestamp

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

Timestamp

פלט בלבד. השעה שבה ההודעה נמחקה ב-Google Chat. אם ההודעה לא נמחקת אף פעם, השדה הזה יהיה ריק.
text

string

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

מידע נוסף על יצירת הודעות טקסט זמין במאמר שליחת הודעה.
formatted_text

string

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

  • תחביר של סימון לטקסט מודגש, נטוי, מחוק, מודפס בגופן monospace, מודפס בגופן monospace בבלוק ורשימת תבליטים.

  • אזכורים של משתמשים בפורמט <users/{user}>.

  • היפר-קישורים מותאמים אישית בפורמט <{url}|{rendered_text}>, שבו המחרוזת הראשונה היא כתובת ה-URL והשנייה היא הטקסט שעבר עיבוד – לדוגמה, <http://example.com|custom text>.

  • אמוג'י בהתאמה אישית בפורמט :{emoji_name}: – לדוגמה, :smile:. הכלל הזה לא חל על אמוג'י של Unicode, כמו U+1F600 לאמוג'י של פנים צוחק.

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

Card

האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-cards_v2.

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

CardWithId

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

רק אפליקציות Chat יכולות ליצור כרטיסים. אם אפליקציית Chat מאמתת כמשתמש, ההודעות לא יכולות להכיל כרטיסים.

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

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

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

Annotation

פלט בלבד. ההערות שמשויכות ל-text בהודעה הזו.
thread

Thread

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

Space

פלט בלבד. אם אפליקציית Chat מאמתת כמשתמש, הפלט מאכלס רק את המרחבים name.
fallback_text

string

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

ActionResponse

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

string

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

SlashCommand

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

Attachment

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

MatchedUrl

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

bool

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

אם אין תמיכה בתשובות בשרשורים במרחב המשותף, השדה הזה תמיד יהיה false.
client_assigned_message_id

string

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

EmojiReactionSummary

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

User

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

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

DeletionMetadata

פלט בלבד. מידע על הודעה שנמחקה. ההודעה נמחקת כשהערך של delete_time מוגדר.
quoted_message_metadata

QuotedMessageMetadata

פלט בלבד. מידע על הודעה שמשתמש ב-Google Chat ציטט במרחב משותף. משתמשי Google Chat יכולים לצטט הודעה כדי להשיב לה.
attached_gifs[]

AttachedGif

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

AccessoryWidget

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

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

MessageBatchCreatedEventData

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

סוג האירוע: google.workspace.chat.message.v1.batchCreated

שדות
messages[]

MessageCreatedEventData

רשימה של הודעות חדשות.

MessageBatchDeletedEventData

עומס העבודה של האירוע עבור כמה הודעות שנמחקו.

סוג האירוע: google.workspace.chat.message.v1.batchDeleted

שדות
messages[]

MessageDeletedEventData

רשימה של הודעות שנמחקו.

MessageBatchUpdatedEventData

עומס העבודה של האירוע עבור מספר הודעות מעודכנות.

סוג האירוע: google.workspace.chat.message.v1.batchUpdated

שדות
messages[]

MessageUpdatedEventData

רשימה של ההודעות המעודכנות.

MessageCreatedEventData

עומס הנתונים של אירוע להודעה חדשה.

סוג האירוע: google.workspace.chat.message.v1.created

שדות
message

Message

ההודעה החדשה.

MessageDeletedEventData

עומס העבודה של האירוע עבור הודעה שנמחקה.

סוג האירוע: google.workspace.chat.message.v1.deleted

שדות
message

Message

ההודעה שנמחקה. רק השדות name,‏ createTime,‏ deleteTime ו-deletionMetadata מאוכלסים.

MessageUpdatedEventData

עומס העבודה של האירוע עבור הודעה מעודכנת.

סוג האירוע: google.workspace.chat.message.v1.updated

שדות
message

Message

ההודעה המעודכנת.

QuotedMessageMetadata

מידע על הודעה שצוינה.

שדות
name

string

פלט בלבד. שם המשאב של ההודעה שצוינה.

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

Timestamp

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

תגובה

תגובה להודעה.

שדות
name

string

מזהה. שם המשאב של התגובה.

פורמט: spaces/{space}/messages/{message}/reactions/{reaction}
user

User

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

Emoji

חובה. האמוג'י ששימש בתגובה.

ReactionBatchCreatedEventData

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

סוג האירוע: google.workspace.chat.reaction.v1.batchCreated

שדות
reactions[]

ReactionCreatedEventData

רשימה של תגובות חדשות.

ReactionBatchDeletedEventData

עומס העבודה של האירוע עבור מספר תגובות שנמחקו.

סוג האירוע: google.workspace.chat.reaction.v1.batchDeleted

שדות
reactions[]

ReactionDeletedEventData

רשימה של התגובות שנמחקו.

ReactionCreatedEventData

נתוני העומס של האירוע לתגובה חדשה.

סוג האירוע: google.workspace.chat.reaction.v1.created

שדות
reaction

Reaction

התגובה החדשה.

ReactionDeletedEventData

נתוני העומס של האירוע לתגובה שנמחקה.

סוג: google.workspace.chat.reaction.v1.deleted

שדות
reaction

Reaction

התגובה שנמחקה.

RichLinkMetadata

קישור עשיר למשאב.

שדות
uri

string

ה-URI של הקישור הזה.
שדה האיחוד data. נתונים של המשאב המקושר. הערך של data יכול להיות רק אחת מהאפשרויות הבאות:

RichLinkType

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

טיפוסים בני מנייה (enum)
DRIVE_FILE סוג של קישור עשיר ב-Google Drive.
CHAT_SPACE סוג קישור עשיר למרחב משותף ב-Chat. לדוגמה, צ'יפ חכם של מרחב משותף.

SearchSpacesRequest

בקשה לחיפוש רשימה של מרחבים משותפים על סמך שאילתה.

שדות
use_admin_access

bool

כשהערך של true הוא true, השיטה פועלת באמצעות הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמש שמבצע את הקריאה חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים.

נדרש היקף הרשאות OAuth 2.0 chat.admin.spaces.readonly או chat.admin.spaces.

בשלב הזה, השיטה הזו תומכת רק בגישה של אדמין, ולכן רק הערך true מקובל בשדה הזה.
page_size

int32

המספר המקסימלי של מרחבים משותפים להחזרה. יכול להיות שהשירות יחזיר פחות מהערך הזה.

אם לא צוין, המערכת תחזיר עד 100 מקומות פנויים.

הערך המקסימלי הוא 1,000. אם משתמשים בערך גבוה מ-1,000, הוא ישתנה באופן אוטומטי ל-1,000.
page_token

string

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

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

string

חובה. שאילתת חיפוש.

אפשר לחפש לפי הפרמטרים הבאים:

  • create_time
  • customer
  • display_name
  • external_user_allowed
  • last_active_time
  • space_history_state
  • space_type

השדות create_time ו-last_active_time מקבלים חותמת זמן בפורמט RFC-3339, ואלה אופרטורי ההשוואה הנתמכים: =,‏ <,‏ >,‏ <=,‏ >=.

השדה customer נדרש והוא משמש לציון מלקוח איזה מרחבים משותפים צריך לאחזר. customers/my_customer הוא הערך הנתמך היחיד.

display_name מקבל רק את האופרטור HAS (:). הטקסט להתאמה מומר קודם לאסימונים, וכל אסימון מתאים לתחילית באופן עצמאי ללא קשר לאותיות רישיות, כמחרוזת משנה בכל מקום ב-display_name של המרחב. לדוגמה, Fun Eve תואם ל-Fun event או ל-The evening was fun, אבל לא ל-notFun event או ל-even.

‫external_user_allowed מקבל את הערכים true או false.

space_history_state מקבל רק ערכים מהשדה historyState של משאב space.

השדה space_type הוא שדה חובה, והערך החוקי היחיד הוא SPACE.

בשדות שונים, יש תמיכה רק באופרטור AND. דוגמה תקינה היא space_type = "SPACE" AND display_name:"Hello" ודוגמה לא תקינה היא space_type = "SPACE" OR display_name:"Hello".

באותו שדה, space_type לא תומך באופרטור AND או OR. השדות display_name,‏ 'space_history_state' ו-'external_user_allowed' תומכים רק באופרטור OR. ב-last_active_time וב-create_time יש תמיכה גם באופרטור AND וגם באופרטור OR. אפשר להשתמש ב-AND רק כדי לייצג מרווח זמן, כמו last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00".

השאילתות לדוגמה הבאות תקינות:

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_by

string

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

המאפיינים הנתמכים להזמנה הם:

  • membership_count.joined_direct_human_user_count – מציין את מספר המשתמשים האנושיים שהצטרפו ישירות למרחב המשותף.
  • last_active_time — מציין את המועד שבו נוסף הפריט האחרון שעומד בדרישות לכל נושא במרחב המשותף הזה.
  • create_time — מציין את הזמן שבו נוצר המרחב המשותף.

הערכים החוקיים של פעולת ההזמנה הם:

  • ASC לסדר עולה. ערך ברירת המחדל.

  • DESC לסדר יורד.

אלה תחבירי ה-JSON הנתמכים:

  • membership_count.joined_direct_human_user_count DESC
  • membership_count.joined_direct_human_user_count ASC
  • last_active_time DESC
  • last_active_time ASC
  • create_time DESC
  • create_time ASC

SearchSpacesResponse

תגובה עם רשימה של מרחבים משותפים שתואמים לבקשה לחיפוש מרחבים משותפים.

שדות
spaces[]

Space

דף של המרחבים המשותפים המבוקשים.
next_page_token

string

אסימון שאפשר להשתמש בו כדי לאחזר את הדף הבא. אם השדה הזה ריק, אין דפים נוספים.
total_size

int32

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

SetUpSpaceRequest

לבקש ליצור מרחב משותף ולהוסיף אליו משתמשים ספציפיים.

שדות
space

Space

חובה. השדה Space.spaceType הוא חובה.

כדי ליצור מרחב משותף, מגדירים את Space.spaceType כ-SPACE ומגדירים את Space.displayName. אם מופיעה הודעת השגיאה ALREADY_EXISTS כשאתם מגדירים מרחבים משותפים, נסו displayName אחר. יכול להיות שכבר יש מרחב משותף בארגון ב-Google Workspace עם השם המוצג הזה.

כדי ליצור צ'אט קבוצתי, מגדירים את Space.spaceType כ-GROUP_CHAT. לא מגדירים את Space.displayName.

כדי ליצור שיחה אישית בין בני אדם, מגדירים את Space.spaceType כ-DIRECT_MESSAGE ואת Space.singleUserBotDm כ-false. לא מגדירים את Space.displayName או את Space.spaceDetails.

כדי ליצור שיחה אישית בין אדם לאפליקציית Chat, מגדירים את Space.spaceType כ-DIRECT_MESSAGE ואת Space.singleUserBotDm כ-true. לא מגדירים את Space.displayName או את Space.spaceDetails.

אם כבר קיים מרחב משותף בשם DIRECT_MESSAGE, הוא מוחזר במקום ליצור מרחב חדש.
request_id

string

זה שינוי אופציונלי. מזהה ייחודי של הבקשה הזו. מומלץ להשתמש ב-UUID אקראי. ציון מזהה בקשה קיים מחזיר את המרחב המשותף שנוצר באמצעות המזהה הזה במקום ליצור מרחב משותף חדש. אם מציינים מזהה בקשה קיים מאותה אפליקציית Chat עם משתמש מאומת אחר, מתקבלת הודעת שגיאה.
memberships[]

Membership

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

בשלב הזה, אפשר להוסיף לקבוצה עד 20 חברים (בנוסף למבצע הקריאה החוזרת).

עבור מינוי של משתמש, השדה Membership.member חייב להכיל user עם name מאוכלס (פורמט: users/{user}) ו-type מוגדר כ-User.Type.HUMAN. אפשר להוסיף משתמשים רק כשמגדירים מרחב משותף (הוספת אפליקציות Chat נתמכת רק להגדרת הודעות ישירות באפליקציית השיחות). אפשר גם להוסיף חברים באמצעות כתובת האימייל של המשתמש ככתובת חלופית עבור {user}. לדוגמה, הערך של user.name יכול להיות users/example@gmail.com. כדי להזמין משתמשי Gmail או משתמשים מדומיינים חיצוניים של Google Workspace, צריך להשתמש בכתובת האימייל של המשתמש בשדה {user}.

כדי להוסיף חברות בקבוצות Google, השדה Membership.group_member צריך להכיל group עם name מאוכלס (בפורמט groups/{group}). אפשר להוסיף קבוצות Google רק כשמגדירים את Space.spaceType לערך SPACE.

אופציונלי כשמגדירים את Space.spaceType כ-SPACE.

נדרש כשמגדירים את Space.spaceType כ-GROUP_CHAT, יחד עם לפחות שתי חברויות.

נדרשת כשמגדירים את Space.spaceType כ-DIRECT_MESSAGE עם משתמש אנושי, יחד עם מינוי אחד בלבד.

השדה חייב להיות ריק כשיוצרים שיחה אישית בין אדם לאפליקציית Chat שביצעה את הקריאה (כשמגדירים את Space.spaceType כ-DIRECT_MESSAGE ואת Space.singleUserBotDm כ-true).

SlashCommand

פקודה דרך שורת הפקודה ב-Google Chat.

שדות
command_id

int64

המזהה של פקודת ה-slash שהופעל.

SlashCommandMetadata

מטא-נתונים של הערות לפקודות קו נטוי (/).

שדות
bot

User

אפליקציית Chat שבה הפקודה הופעל.
type

Type

סוג הפקודה דרך שורת הפקודה.
command_name

string

השם של פקודת ה-slash שהופעל.
command_id

int64

מזהה הפקודה של פקודת ה-slash שהופעל.
triggers_dialog

bool

מציין אם פקודת הפסיק היא לתיבת דו-שיח.

סוג

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED ערך ברירת המחדל של ה-enum. אין להשתמש.
ADD מוסיפים את אפליקציית Chat למרחב המשותף.
INVOKE להפעיל פקודה של שורת הפקודות במרחב המשותף.

רווח

במרחבים משותפים ב-Google Chat. מרחבים משותפים הם שיחות בין שני משתמשים או יותר, או הודעות אישיות בין משתמש לאפליקציית Chat.

שדות
name

string

מזהה. שם המשאב של המרחב המשותף.

פורמט: spaces/{space}

כאשר {space} מייצג את המזהה שהמערכת הקצה למרחב המשותף. אפשר לקבל את מזהה המרחב באמצעות קריאה ל-method‏ spaces.list() או מכתובת ה-URL של המרחב. לדוגמה, אם כתובת ה-URL של המרחב המשותף היא https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, מזהה המרחב המשותף הוא AAAAAAAAA.
type
(deprecated)

Type

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

SpaceType

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

bool

זה שינוי אופציונלי. אם המרחב הוא צ'אט אישי בין אפליקציית Chat לבין אדם אחד.
threaded
(deprecated)

bool

פלט בלבד. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-spaceThreadingState. אם ההודעות במרחב המשותף מחולקות לשרשורים.
display_name

string

זה שינוי אופציונלי. השם המוצג של המרחב המשותף. חובה כשיוצרים מרחב משותף עם spaceType של SPACE. אם מופיעה הודעת השגיאה ALREADY_EXISTS כשיוצרים מרחבים משותפים או מעדכנים את displayName, מנסים displayName אחר. יכול להיות שכבר יש מרחב משותף בארגון ב-Google Workspace עם השם המוצג הזה.

בהודעות ישירות, השדה הזה עשוי להיות ריק.

תמיכה ב-128 תווים לכל היותר.
external_user_allowed

bool

זה שינוי אופציונלי. לא ניתן לשינוי. האם כל משתמש ב-Google Chat יכול להצטרף למרחב המשותף. מזינים כשיוצרים מרחב משותף בארגון ב-Google Workspace. מומלץ להשמיט את השדה הזה כשיוצרים מרחבים משותפים בתנאים הבאים:

  • המשתמש המאומת משתמש בחשבון של צרכן (חשבון משתמש לא מנוהל). כברירת מחדל, כל משתמש ב-Google Chat יכול להצטרף למרחב משותף שנוצר באמצעות חשבון פרטי.

במרחבים משותפים קיימים, השדה הזה הוא פלט בלבד.
space_threading_state

SpaceThreadingState

פלט בלבד. מצב השרשורים במרחב המשותף ב-Chat.
space_details

SpaceDetails

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

HistoryState

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

bool

זה שינוי אופציונלי. אם המרחב המשותף הזה נוצר ב-Import Mode כחלק מהעברת נתונים ל-Google Workspace. בזמן הייבוא, המרחבים לא גלויים למשתמשים עד שהוא מסתיים.

כדי ליצור מרחב משותף ב-Import Mode, צריך לבצע אימות משתמש.
create_time

Timestamp

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

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

מאוכלס בפלט רק כאשר הערך של spaceType הוא GROUP_CHAT או SPACE.
last_active_time

Timestamp

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

admin_installed

bool

פלט בלבד. במרחבים משותפים של צ'אט אישי (DM) באפליקציית Chat, אם המרחב נוצר על ידי אדמין ב-Google Workspace. אדמינים יכולים להתקין ולהגדיר צ'אט אישי עם אפליקציית Chat בשם המשתמשים בארגון שלהם.

כדי לתמוך בהתקנה על ידי אדמין, אפליקציית Chat צריכה לכלול צ'אטים אישיים.
membership_count

MembershipCount

פלט בלבד. מספר החברויות במועדון שמקובצות לפי סוג החבר. המאפיין מאוכלס כשהערך של space_type הוא SPACE, ‏ DIRECT_MESSAGE או GROUP_CHAT.

access_settings

AccessSettings

זה שינוי אופציונלי. מציין את הגדרת הגישה של המרחב המשותף. השדה מאוכלס רק כשהערך של space_type הוא SPACE.
space_uri

string

פלט בלבד. ה-URI של המשתמש כדי לגשת למרחב המשותף.
import_mode_expire_time

Timestamp

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

כל מרחבים משותפים שנוצרים במצב ייבוא צריכים לצאת מהמצב הזה לפני זמן התפוגה באמצעות spaces.completeImport.

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

string

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

בפורמט customers/{customer}, כאשר customer הוא הערך של id מתוך [משאב הלקוח של Admin SDK]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). אפליקציות פרטיות יכולות גם להשתמש בכתובת החלופית customers/my_customer כדי ליצור את המרחב המשותף באותו ארגון ב-Google Workspace שבו נמצאת האפליקציה.

בשיחות אישיות, השדה הזה לא מאוכלס.

שדה האיחוד space_permission_settings. מייצג את הגדרות ההרשאות של המרחב המשותף. השדה מאוכלס רק כשהערך של space_type הוא SPACE.

נדרש אימות משתמש. הערך של space_permission_settings יכול להיות רק אחת מהאפשרויות הבאות:
predefined_permission_settings

PredefinedPermissionSettings

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

PermissionSettings

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

AccessSettings

מייצג את הגדרת הגישה של המרחב המשותף.

שדות
access_state

AccessState

פלט בלבד. מציין את סטטוס הגישה למרחב המשותף.
audience

string

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

פורמט: audiences/{audience}

כדי להשתמש בקהל היעד שמוגדר כברירת מחדל לארגון ב-Google Workspace, צריך להגדיר את הערך audiences/default.

קריאת קהל היעד תומכת באפשרויות הבאות:

השדה הזה לא מאוכלס כשמשתמשים בהיקף chat.bot עם אימות אפליקציה.

כדי להגדיר את קהל היעד, נדרש אימות משתמש.

AccessState

מייצג את סטטוס הגישה למרחב המשותף.

טיפוסים בני מנייה (enum)
ACCESS_STATE_UNSPECIFIED סטטוס הגישה לא ידוע או לא נתמך ב-API הזה.
PRIVATE רק משתמשים או קבוצות מ-Google Groups שנוספו או הוזמנו בנפרד על ידי משתמשים אחרים או אדמינים ב-Google Workspace יכולים לגלות את המרחב המשותף ולגשת אליו.
DISCOVERABLE

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

כדי ליצור מרחבים משותפים שגלויים לכולם, צריך לבצע אימות משתמש.

MembershipCount

מספר החברים במרחב המשותף, שמקובצים לקטגוריות.

שדות
joined_direct_human_user_count

int32

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

int32

פלט בלבד. מספר הקבוצות שהצטרפו ישירות למרחב המשותף.

PermissionSetting

מייצג הגדרת הרשאה במרחב משותף.

שדות
managers_allowed

bool

זה שינוי אופציונלי. אם למנהלי המרחבים המשותפים יש את ההרשאה הזו.
members_allowed

bool

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

PermissionSettings

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

כדי להגדיר את הגדרות ההרשאות כשיוצרים מרחב משותף, מציינים את השדה PredefinedPermissionSettings בבקשה.

שדות
manage_members_and_groups

PermissionSetting

זה שינוי אופציונלי. הגדרה לניהול המשתתפים והקבוצות במרחב המשותף.
modify_space_details

PermissionSetting

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

PermissionSetting

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

PermissionSetting

זה שינוי אופציונלי. ההגדרה של השימוש ב-'הכול' במרחב משותף.
manage_apps

PermissionSetting

זה שינוי אופציונלי. הגדרה לניהול האפליקציות במרחב המשותף.
manage_webhooks

PermissionSetting

זה שינוי אופציונלי. הגדרה לניהול webhooks במרחב משותף.
post_messages

PermissionSetting

פלט בלבד. ההגדרה הזו קובעת אם אפשר לפרסם הודעות במרחב המשותף.
reply_messages

PermissionSetting

זה שינוי אופציונלי. ההגדרה הזו קובעת איך משיבים להודעות במרחב משותף.

PredefinedPermissionSettings

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

טיפוסים בני מנייה (enum)
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED לא צוין. אין להשתמש.
COLLABORATION_SPACE הגדרה שמאפשרת להפוך את המרחב המשותף למרחב שיתופי שבו כל המשתתפים יכולים לפרסם הודעות.
ANNOUNCEMENT_SPACE הגדרה שמאפשרת להפוך את המרחב המשותף למרחב משותף לעדכונים, שבו רק מנהלי המרחב המשותף יכולים לפרסם הודעות.

SpaceDetails

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

שדות
description

string

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

יש תמיכה ב-150 תווים לכל היותר.
guidelines

string

זה שינוי אופציונלי. הכללים, הציפיות והנימוס במרחב המשותף.

האורך המקסימלי הוא 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[]

SpaceUpdatedEventData

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

SpaceEvent

אירוע שמייצג שינוי או פעילות במרחב משותף ב-Google Chat. מידע נוסף זמין במאמר עבודה עם אירועים מ-Google Chat.

שדות
name

string

שם המשאב של אירוע המרחב המשותף.

פורמט: spaces/{space}/spaceEvents/{spaceEvent}
event_time

Timestamp

השעה שבה התרחש האירוע.
event_type

string

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

סוגי האירועים הנתמכים להודעות:

  • הודעה חדשה: google.workspace.chat.message.v1.created
  • ההודעה המעודכנת: google.workspace.chat.message.v1.updated
  • ההודעה google.workspace.chat.message.v1.deleted נמחקה
  • כמה הודעות חדשות: google.workspace.chat.message.v1.batchCreated
  • מספר הודעות מעודכנות: google.workspace.chat.message.v1.batchUpdated
  • כמה הודעות שנמחקו: google.workspace.chat.message.v1.batchDeleted

סוגי האירועים הנתמכים למינויים:

  • מינוי חדש: google.workspace.chat.membership.v1.created
  • המינוי המעודכן: google.workspace.chat.membership.v1.updated
  • המינוי שנמחק: google.workspace.chat.membership.v1.deleted
  • כמה חברויות חדשות: google.workspace.chat.membership.v1.batchCreated
  • מספר חברויות מעודכנות: google.workspace.chat.membership.v1.batchUpdated
  • כמה חברויות שנמחקו: google.workspace.chat.membership.v1.batchDeleted

סוגי האירועים הנתמכים לתגובות:

  • תגובה חדשה: google.workspace.chat.reaction.v1.created
  • התגובה שנמחקה: google.workspace.chat.reaction.v1.deleted
  • תגובות חדשות רבות: google.workspace.chat.reaction.v1.batchCreated
  • מספר תגובות נמחקו: google.workspace.chat.reaction.v1.batchDeleted

סוגי האירועים הנתמכים לגבי המרחבים המשותפים:

  • המרחב המשותף המעודכן: google.workspace.chat.space.v1.updated
  • מספר עדכונים במרחב המשותף: google.workspace.chat.space.v1.batchUpdated

שדה האיחוד payload.

הערך של payload יכול להיות רק אחת מהאפשרויות הבאות:
message_created_event_data

MessageCreatedEventData

עומס הנתונים של אירוע להודעה חדשה.

סוג האירוע: google.workspace.chat.message.v1.created
message_updated_event_data

MessageUpdatedEventData

עומס העבודה של האירוע עבור הודעה מעודכנת.

סוג האירוע: google.workspace.chat.message.v1.updated
message_deleted_event_data

MessageDeletedEventData

עומס העבודה של האירוע עבור הודעה שנמחקה.

סוג האירוע: google.workspace.chat.message.v1.deleted
message_batch_created_event_data

MessageBatchCreatedEventData

עומס נתונים של אירוע לכמה הודעות חדשות.

סוג האירוע: google.workspace.chat.message.v1.batchCreated
message_batch_updated_event_data

MessageBatchUpdatedEventData

עומס העבודה של האירוע עבור מספר הודעות מעודכנות.

סוג האירוע: google.workspace.chat.message.v1.batchUpdated
message_batch_deleted_event_data

MessageBatchDeletedEventData

עומס העבודה של האירוע עבור כמה הודעות שנמחקו.

סוג האירוע: google.workspace.chat.message.v1.batchDeleted
space_updated_event_data

SpaceUpdatedEventData

נתוני עומס האירוע לעדכון של מרחב משותף.

סוג האירוע: google.workspace.chat.space.v1.updated
space_batch_updated_event_data

SpaceBatchUpdatedEventData

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

סוג האירוע: google.workspace.chat.space.v1.batchUpdated
membership_created_event_data

MembershipCreatedEventData

נתוני עומס האירוע עבור חברות חדשה במועדון.

סוג האירוע: google.workspace.chat.membership.v1.created
membership_updated_event_data

MembershipUpdatedEventData

נתוני עומס האירוע של מינוי מעודכן.

סוג האירוע: google.workspace.chat.membership.v1.updated
membership_deleted_event_data

MembershipDeletedEventData

עומס העבודה של האירוע עבור מינוי שנמחק.

סוג האירוע: google.workspace.chat.membership.v1.deleted
membership_batch_created_event_data

MembershipBatchCreatedEventData

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

סוג האירוע: google.workspace.chat.membership.v1.batchCreated
membership_batch_updated_event_data

MembershipBatchUpdatedEventData

עומס העבודה של האירוע עבור כמה מינויים מעודכנים.

סוג האירוע: google.workspace.chat.membership.v1.batchUpdated
membership_batch_deleted_event_data

MembershipBatchDeletedEventData

עומס העבודה של האירוע עבור כמה מינויים שנמחקו.

סוג האירוע: google.workspace.chat.membership.v1.batchDeleted
reaction_created_event_data

ReactionCreatedEventData

נתוני העומס של האירוע לתגובה חדשה.

סוג האירוע: google.workspace.chat.reaction.v1.created
reaction_deleted_event_data

ReactionDeletedEventData

נתוני העומס של האירוע לתגובה שנמחקה.

סוג האירוע: google.workspace.chat.reaction.v1.deleted
reaction_batch_created_event_data

ReactionBatchCreatedEventData

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

סוג האירוע: google.workspace.chat.reaction.v1.batchCreated
reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

עומס העבודה של האירוע עבור מספר תגובות שנמחקו.

סוג האירוע: google.workspace.chat.reaction.v1.batchDeleted

SpaceNotificationSetting

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

שדות
name

string

מזהה. שם המשאב של הגדרת ההתראות של המרחב המשותף. פורמט: users/{user}/spaces/{space}/spaceNotificationSetting
notification_setting

NotificationSetting

הגדרת ההתראות.
mute_setting

MuteSetting

ההגדרה של השתקת ההתראות במרחב המשותף.

MuteSetting

סוגי ההגדרות להשתקת ההתראות במרחב המשותף.

טיפוסים בני מנייה (enum)
MUTE_SETTING_UNSPECIFIED שמור.
UNMUTED המשתמש יקבל התראות על המרחב המשותף בהתאם להגדרת ההתראות.
MUTED המשתמש לא יקבל התראות על המרחב המשותף, ללא קשר להגדרת ההתראות.

NotificationSetting

סוגי ההגדרות של ההתראות.

טיפוסים בני מנייה (enum)
NOTIFICATION_SETTING_UNSPECIFIED שמור.
ALL התראות מופעלות על ידי אזכורים עם @, שרשורים במעקב, ההודעה הראשונה בשרשורים חדשים. כל השרשורים החדשים יתווספו באופן אוטומטי למעקב, אלא אם המשתמש יבטל את המעקב אחריהם באופן ידני.
MAIN_CONVERSATIONS ההתראה מופעלת על ידי אזכורים, שרשורים במעקב, ההודעה הראשונה בשרשורים חדשים. האפשרות לא זמינה בצ'אטים אישיים.
FOR_YOU ההתראה מופעלת על ידי אזכורים ב-@ ושרשורים שבמעקב. האפשרות לא זמינה בצ'אטים אישיים.
OFF ההתראה מושבתת.

SpaceReadState

מצב הקריאה של המשתמש במרחב המשותף, שמאפשר לזהות הודעות שקראתם והודעות שעדיין לא קראתם.

שדות
name

string

שם המשאב של מצב הקריאה של המרחב המשותף.

פורמט: users/{user}/spaces/{space}/spaceReadState
last_read_time

Timestamp

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

SpaceUpdatedEventData

נתוני המטען של האירוע לגבי מרחב משותף מעודכן.

סוג האירוע: google.workspace.chat.space.v1.updated

שדות
space

Space

המרחב המשותף המעודכן.

שרשור

שרשור במרחב משותף ב-Google Chat. דוגמאות לשימוש מפורטות במאמר התחלת שרשור הודעות או מענה לשרשור.

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

שדות
name

string

מזהה. שם המשאב של השרשור.

לדוגמה: spaces/{space}/threads/{thread}
thread_key

string

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

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

ThreadReadState

מצב הקריאה של המשתמש בשרשור, המשמש לזיהוי הודעות שקרא והודעות שעדיין לא קרא.

שדות
name

string

שם המשאב של מצב הקריאה של השרשור.

פורמט: users/{user}/spaces/{space}/threads/{thread}/threadReadState
last_read_time

Timestamp

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

UpdateMembershipRequest

הודעה עם בקשה לעדכון של חברות בקבוצה.

שדות
membership

Membership

חובה. החברות שרוצים לעדכן. רק השדות שצוינו על ידי update_mask מתעדכנים.
update_mask

FieldMask

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

נכון לעכשיו, אלה נתיבי השדות הנתמכים:

  • role
use_admin_access

bool

זה שינוי אופציונלי. כשהערך של true הוא true, השיטה פועלת באמצעות הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמש שמבצע את הקריאה חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים.

נדרשת הרשאת OAuth 2.0 chat.admin.memberships.

UpdateMessageRequest

שליחת בקשה לעדכון הודעה.

שדות
message

Message

חובה. הודעה עם השדות המעודכנים.
update_mask

FieldMask

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

נכון לעכשיו, אלה נתיבי השדות הנתמכים:
allow_missing

bool

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

UpdateSpaceNotificationSettingRequest

מבקשים לעדכן את הגדרות ההתראות של המרחב המשותף. התכונה תומכת רק בעדכון של הגדרת ההתראות של המשתמש שמבצע את השיחה.

שדות
space_notification_setting

SpaceNotificationSetting

חובה. שם המשאב של הגדרות ההתראות של המרחב צריך להיות מאוכלס בפורמט users/{user}/spaces/{space}/spaceNotificationSetting. רק השדות שצוינו על ידי update_mask מתעדכנים.
update_mask

FieldMask

חובה. נתיבי שדות נתמכים: - notification_setting - mute_setting

UpdateSpaceReadStateRequest

הודעת בקשה ל-UpdateSpaceReadState API.

שדות
space_read_state

SpaceReadState

חובה. מצב הקריאה של המרחב המשותף והשדות שרוצים לעדכן.

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

כדי להפנות למשתמש הקורא, מגדירים את אחת מהאפשרויות הבאות:

  • הכינוי me. לדוגמה, users/me/spaces/{space}/spaceReadState.

  • כתובת האימייל שלהם ב-Workspace. לדוגמה, users/user@example.com/spaces/{space}/spaceReadState.

  • מזהה המשתמש שלהם. לדוגמה, users/123456789/spaces/{space}/spaceReadState.

פורמט: users/{user}/spaces/{space}/spaceReadState
update_mask

FieldMask

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

  • last_read_time

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

כדי לסמן את המרחב המשותף כנקרא, מגדירים את last_read_time לערך מאוחר יותר (גדול יותר) מהשעה שבה נוצרה ההודעה האחרונה. הערך של last_read_time יאולץ להתאים לשעת היצירה של ההודעה האחרונה. חשוב לזכור שמצב הקריאה במרחב המשותף משפיע רק על מצב הקריאה של הודעות שגלויות בשיחה ברמה העליונה של המרחב המשותף. תשובות בשרשורים לא מושפעות מחותמת הזמן הזו, אלא מסתמכות על מצב הקריאה של השרשור.

UpdateSpaceRequest

בקשה לעדכון מרחב משותף אחד.

שדות
space

Space

חובה. מרחב משותף עם שדות שרוצים לעדכן. צריך לאכלס את Space.name בפורמט spaces/{space}. רק השדות שצוינו על ידי update_mask מתעדכנים.
update_mask

FieldMask

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

אתם יכולים לעדכן את השדות הבאים במרחב המשותף:

space_details: עדכון התיאור של המרחב המשותף. יש תמיכה ב-150 תווים לכל היותר.

display_name: תמיכה בעדכון השם המוצג רק במרחבים שבהם השדה spaceType הוא SPACE. אם מופיעה הודעת השגיאה ALREADY_EXISTS, נסו ערך אחר. יכול להיות שכבר יש מרחב משותף בארגון ב-Google Workspace עם השם המוצג הזה.

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

space_history_state: מעדכנים את הגדרות ההיסטוריה של המרחב המשותף על ידי הפעלה או השבתה של ההיסטוריה במרחב המשותף. התכונה נתמכת רק אם הגדרות ההיסטוריה מופעלות בארגון ב-Google Workspace. כדי לעדכן את המצב של היסטוריית המרחב המשותף, צריך להשמיט את כל שאר מסכות השדות בבקשה. אין תמיכה ב-space_history_state עם useAdminAccess.

access_settings.audience: מעדכן את הגדרת הגישה של מי שיכול לגלות את המרחב המשותף, להצטרף אליו ולראות תצוגה מקדימה של ההודעות במרחב משותף בעל שם, כאשר השדה spaceType הוא SPACE. אם למרחב המשותף הקיים יש קהל יעד, אפשר להסיר את הקהל ולהגביל את הגישה למרחב המשותף על ידי השמטת ערך ממסכת השדה הזו. כדי לעדכן את הגדרות הגישה למרחב משותף, המשתמש שמבצע את האימות צריך להיות מנהל המרחב המשותף, והוא צריך להשמיט את כל שאר מסכות השדות מהבקשה. אי אפשר לעדכן את השדה הזה אם המרחב המשותף נמצא במצב ייבוא. מידע נוסף זמין במאמר הצגת המרחב המשותף למשתמשים ספציפיים. אין תמיכה ב-access_settings.audience עם useAdminAccess.

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

  • permission_settings.manageMembersAndGroups
  • permission_settings.modifySpaceDetails
  • permission_settings.toggleHistory
  • permission_settings.useAtMentionAll
  • permission_settings.manageApps
  • permission_settings.manageWebhooks
  • permission_settings.replyMessages
use_admin_access

bool

זה שינוי אופציונלי. כשהערך של true הוא true, השיטה פועלת באמצעות הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמש שמבצע את הקריאה חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים.

נדרשת הרשאת OAuth 2.0 chat.admin.spaces.

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

משתמש

משתמש ב-Google Chat. כשהפלט מוחזר מבקשה, אם אפליקציית Chat מאמתת כמשתמש, הפלט של משאב User מאכלס רק את name ו-type של המשתמש.

שדות
name

string

שם המשאב של user ב-Google Chat.

פורמט: users/{user} אפשר להשתמש ב-users/app ככינוי למשתמש bot באפליקציית השיחה.

עבור human users, הערך של {user} זהה למזהה המשתמש של:

  • id של האדם ב-People API. לדוגמה, הערך users/123456789 ב-Chat API מייצג את אותו אדם כמו מזהה פרופיל האדם 123456789 ב-People API.

  • השדה id של משתמש ב-Admin SDK Directory API.

  • אפשר להשתמש בכתובת האימייל של המשתמש ככתובת חלופית ל-{user} בבקשות API. לדוגמה, אם מזהה פרופיל האדם ב-People API עבור user@example.com הוא 123456789, אפשר להשתמש ב-users/user@example.com ככינוי כדי להפנות אל users/123456789. רק שם המשאב הקנוני (לדוגמה users/123456789) יוחזר מה-API.
display_name

string

פלט בלבד. השם המוצג של המשתמש.
domain_id

string

המזהה הייחודי של הדומיין של המשתמש ב-Google Workspace.
type

Type

סוג המשתמש.
is_anonymous

bool

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

סוג

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED ערך ברירת המחדל של ה-enum. אין להשתמש בו.
HUMAN משתמש אנושי.
BOT משתמש באפליקציית Chat.

UserMentionMetadata

מטא-נתונים של הערות לגבי אזכורים של משתמשים (@).

שדות
user

User

המשתמש שצוין.
type

Type

סוג האזכור של המשתמש.

סוג

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED ערך ברירת המחדל של ה-enum. אין להשתמש.
ADD מוסיפים את המשתמש למרחב המשותף.
MENTION להזכיר את המשתמש במרחב המשותף.

WidgetMarkup

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

שדות
buttons[]

Button

רשימת לחצנים. Buttons הוא גם oneof data, וצריך להגדיר רק אחד מהשדות האלה.
שדה האיחוד data. אפשר להוסיף ל-WidgetMarkup רק אחד מהפריטים הבאים. אפשר להשתמש במספר שדות WidgetMarkup כדי להציג יותר פריטים. הערך של data יכול להיות רק אחת מהאפשרויות הבאות:
text_paragraph

TextParagraph

הצגת פסקה של טקסט בווידג'ט הזה.
image

Image

הצגת תמונה בווידג'ט הזה.
key_value

KeyValue

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

לחצן

לחצן. יכול להיות לחצן טקסט או לחצן תמונה.

שדות

שדה האיחוד type.

הערך של type יכול להיות רק אחת מהאפשרויות הבאות:
text_button

TextButton

לחצן עם טקסט ופעולה onclick.
image_button

ImageButton

לחצן עם תמונה ופעולה onclick.

FormAction

פעולת טופס מתארת את ההתנהגות כשהטופס נשלח. לדוגמה, אפשר להפעיל את Apps Script כדי לטפל בטופס.

שדות
action_method_name

string

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

ActionParameter

רשימת הפרמטרים של הפעולה.

ActionParameter

רשימת פרמטרים של מחרוזות שצריך לספק כשמפעילים את שיטת הפעולה. לדוגמה, אפשר להציג שלושה לחצני השהיה: השהיה עכשיו, השהיה ליום אחד, השהיה לשבוע הבא. אפשר להשתמש ב-action method = snooze(), ולהעביר את סוג ההשהיה ואת משך ההשהיה ברשימה של פרמטרים של מחרוזות.

שדות
key

string

שם הפרמטר של סקריפט הפעולה.
value

string

הערך של הפרמטר.

סמל

קבוצת הסמלים הנתמכים.

טיפוסים בני מנייה (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

string

כתובת האתר של התמונה.
on_click

OnClick

הפעולה onclick.
aspect_ratio

double

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

ImageButton

לחצן תמונה עם פעולה onclick.

שדות
on_click

OnClick

הפעולה onclick.
name

string

השם של image_button הזה שמשמש לנגישות. אם לא מציינים את השם הזה, מערכת תביא ערך ברירת מחדל.
שדה האיחוד icons. אפשר לציין את הסמל באמצעות Icon enum או כתובת URL. הערך של icons יכול להיות רק אחת מהאפשרויות הבאות:
icon

Icon

הסמל שצוין על ידי enum שמצביע על סמל שסופק על ידי Chat API.
icon_url

string

הסמל שצוין באמצעות כתובת URL.

KeyValue

רכיב בממשק המשתמש מכיל מפתח (תווית) וערך (תוכן). הרכיב הזה יכול להכיל גם פעולות מסוימות, כמו לחצן onclick.

שדות
top_label

string

הטקסט של התווית העליונה. יש תמיכה בטקסט מעוצב. מידע נוסף על עיצוב טקסט זמין במאמרים עיצוב טקסט באפליקציות של Google Chat ועיצוב טקסט בתוספים של Google Workspace.
content

string

הטקסט של התוכן. יש תמיכה בטקסט מעוצב ותמיד צריך להשתמש בטקסט כזה. מידע נוסף על עיצוב טקסט זמין במאמרים עיצוב טקסט באפליקציות של Google Chat ועיצוב טקסט בתוספים של Google Workspace.
content_multiline

bool

אם התוכן צריך להיות בכמה שורות.
bottom_label

string

הטקסט של התווית התחתונה. יש תמיכה בטקסט מעוצב. מידע נוסף על עיצוב טקסט זמין במאמרים עיצוב טקסט באפליקציות של Google Chat ועיצוב טקסט בתוספים של Google Workspace.
on_click

OnClick

הפעולה onclick. אפשר ללחוץ רק על התווית העליונה, התווית התחתונה ואזור התוכן.
שדה האיחוד icons. צריך להגדיר לפחות אחד מהסמלים, top_label ו-bottom_label. הערך של icons יכול להיות רק אחת מהאפשרויות הבאות:
icon

Icon

ערך enum שמוחליף על ידי Chat API בתמונה המתאימה של הסמל.
icon_url

string

הסמל שצוין באמצעות כתובת URL.
שדה האיחוד control. ווידג'ט בקרה. אפשר להגדיר את הערך button או את הערך switch_widget, אבל לא את שניהם. הערך של control יכול להיות רק אחת מהאפשרויות הבאות:
button

Button

לחצן שאפשר ללחוץ עליו כדי להפעיל פעולה.

OnClick

פעולה onclick (לדוגמה, פתיחת קישור).

שדות

שדה האיחוד data.

הערך של data יכול להיות רק אחת מהאפשרויות הבאות:
action

FormAction

אם מציינים את הפעולה onclick, היא מפעילה פעולת טופס.

TextButton

לחצן עם טקסט ופעולה onclick.

שדות
text

string

הטקסט של הלחצן.
on_click

OnClick

הפעולה onclick של הלחצן.

TextParagraph

פסקה של טקסט. יש תמיכה בטקסט מעוצב. מידע נוסף על עיצוב טקסט זמין במאמרים עיצוב טקסט באפליקציות של Google Chat ועיצוב טקסט בתוספים של Google Workspace.

שדות
text

string