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)

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

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

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

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

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

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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)

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

היקפי הרשאה

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

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

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

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

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

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

היקפי הרשאה

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

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

מידע נוסף זמין במדריך ההרשאות.
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

מידע נוסף זמין במדריך להרשאות.
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

מידע נוסף זמין במדריך ההרשאות.
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. לכל אירוע, המטען הייעודי (Payload) מכיל את הגרסה העדכנית ביותר של המשאב ב-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

מידע נוסף זמין במדריך להרשאות.
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 מבצעת אימות כמשתמש, ההודעה לא יכולה להכיל כרטיסים.

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

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

שדות
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.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.

כשאפליקציית צ'אט יוצרת לעצמה יחס חברות, היא צריכה לבצע אימות כמשתמש ולהשתמש בהיקף 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.

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

אם אתם חברים בתוכנית Developer Preview, תוכלו להשתמש ב-SpaceType.GROUP_CHAT אם הערך של importMode מוגדר כ-true.

המרחב המשותף 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

נתוני מטען ייעודי (payload) של האמוג'י בהתאמה אישית.

שדות
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, השיטה תפעל עם הרשאות האדמין של המשתמש ב-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, השיטה תפעל עם הרשאות האדמין של המשתמש ב-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

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

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, השיטה תפעל עם הרשאות האדמין של המשתמש ב-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}

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, השיטה תפעל עם הרשאות האדמין של המשתמש ב-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 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

כתובת URL תואמת בהודעה ב-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

מטען ייעודי (payload) של אירוע לכמה חברויות חדשות.

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

שדות
memberships[]

MembershipCreatedEventData

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

MembershipBatchDeletedEventData

מטען ייעודי (payload) של אירוע שכולל כמה מינויים שנמחקו.

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

שדות
memberships[]

MembershipDeletedEventData

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

MembershipBatchUpdatedEventData

מטען ייעודי (payload) של אירוע שכולל מספר מינויים מעודכנים.

סוג האירוע: 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

מטען ייעודי (payload) של אירוע למינוי מעודכן.

סוג האירוע: 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 עם סימני סימון שנוספו כדי להעביר את העיצוב. יכול להיות שהשדה הזה לא יתעד את כל העיצובים שמוצגים בממשק המשתמש, אבל הוא כולל את הפרטים הבאים:

  • תחביר תגי עיצוב לטקסט מודגש, נטוי, קו חוצה, Unicode, בלוק Unicode ורשימה עם תבליטים.

  • אזכורים של משתמשים בפורמט <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

מטען ייעודי (payload) של אירוע עבור כמה הודעות חדשות.

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

שדות
messages[]

MessageCreatedEventData

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

MessageBatchDeletedEventData

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

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

שדות
messages[]

MessageDeletedEventData

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

MessageBatchUpdatedEventData

מטען ייעודי (payload) של אירוע עבור מספר הודעות מעודכנות.

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

שדות
messages[]

MessageUpdatedEventData

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

MessageCreatedEventData

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

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

שדות
message

Message

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

MessageDeletedEventData

מטען ייעודי (payload) של אירוע עבור הודעה שנמחקה.

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

שדות
message

Message

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

MessageUpdatedEventData

מטען ייעודי (payload) של אירוע להודעה מעודכנת.

סוג האירוע: 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

מטען ייעודי (payload) של אירוע לתגובה חדשה.

סוג האירוע: 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, השיטה תפעל עם הרשאות האדמין של המשתמש ב-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 לסדר יורד.

התחביר הנתמך הוא:

  • 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

השם של פקודה שהופעלה באמצעות קו נטוי.
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 של המשתמש לגישה למרחב המשותף.
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 צ'אטים אישיים בין שני אנשים ושיחות קבוצתיות בין 3 אנשים או יותר.

SpaceType

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

טיפוסים בני מנייה (enum)
SPACE_TYPE_UNSPECIFIED שמור.
SPACE מקום שבו אנשים שולחים הודעות, משתפים קבצים ועובדים יחד. SPACE יכול לכלול אפליקציות צ'אט.
GROUP_CHAT שיחות קבוצתיות עם 3 אנשים או יותר. GROUP_CHAT יכול לכלול אפליקציות של Chat.
DIRECT_MESSAGE צ'אטים אישיים בין שני אנשים או בין שני אנשים לבין אפליקציית Chat.

סוג

הוצא משימוש: במקומו צריך להשתמש ברכיב SpaceType.

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

SpaceBatchUpdatedEventData

מטען ייעודי (payload) של אירוע שכולל כמה עדכונים במרחב המשותף.

סוג האירוע: 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

מטען ייעודי (payload) של אירוע להודעה חדשה.

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

MessageUpdatedEventData

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

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

MessageDeletedEventData

מטען ייעודי (payload) של אירוע עבור הודעה שנמחקה.

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

MessageBatchCreatedEventData

מטען ייעודי (payload) של אירוע עבור כמה הודעות חדשות.

סוג האירוע: 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

מטען ייעודי (payload) של אירוע לעדכון המרחב המשותף.

סוג האירוע: 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

מטען ייעודי (payload) של אירוע לכמה חברויות חדשות.

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

MembershipBatchUpdatedEventData

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

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

MembershipBatchDeletedEventData

מטען ייעודי (payload) של אירוע שכולל כמה מינויים שנמחקו.

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

ReactionCreatedEventData

מטען ייעודי (payload) של אירוע לתגובה חדשה.

סוג האירוע: 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

מטען ייעודי (payload) של אירוע שכולל כמה תגובות שנמחקו.

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

SpaceReadState

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

שדות
name

string

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

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

Timestamp

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

SpaceUpdatedEventData

מטען ייעודי (payload) של אירוע למרחב משותף מעודכן.

סוג האירוע: 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, השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.

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

נדרש היקף OAuth 2.0 chat.admin.memberships.

UpdateMessageRequest

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

שדות
message

Message

חובה. ההודעה בשדות עודכנו.
update_mask

FieldMask

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

נתיבי השדות שנתמכים כרגע:
allow_missing

bool

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

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, המשתמש נמחק או שהפרופיל שלו לא גלוי.

סוג

טיפוסים בני מנייה (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