Package google.chat.v1

אינדקס

ChatService

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

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

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

נדרש אימות משתמש והענקת גישה ברמת הדומיין עם היקף ההרשאות:

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

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

היקפי הרשאה

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

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

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

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

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

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

נדרש אימות משתמש עם הרשאת הגישה:

  • https://www.googleapis.com/auth/chat.customemojis
היקפי הרשאה

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

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

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

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

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

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

  • אימות אפליקציות עם אישור אדמין והיקף ההרשאה:

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

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (כדי להוסיף את אפליקציית השיחות למרחב)
    • ‫https://www.googleapis.com/auth/chat.import (רווחים במצב ייבוא בלבד)
    • אימות משתמשים מעניק הרשאות אדמין כשחשבון אדמין מאומת, use_admin_access הוא true, ונעשה שימוש בהיקף ההרשאות הבא:
      • https://www.googleapis.com/auth/chat.admin.memberships

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

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

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

  • אימות אפליקציה עם היקף ההרשאה:
    • https://www.googleapis.com/auth/chat.bot
  • אימות משתמשים עם אחת מהרשאות הגישה הבאות:
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • ‫https://www.googleapis.com/auth/chat.import (רווחים במצב ייבוא בלבד)

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

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

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

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

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

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

בבקשות webhook, התגובה לא מכילה את ההודעה המלאה. התשובה מאכלסת רק את השדות name ו-thread.name בנוסף למידע שהיה בבקשה.

היקפי הרשאה

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

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

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

  • https://www.googleapis.com/auth/chat.messages.reactions.create
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • ‫https://www.googleapis.com/auth/chat.import (רווחים במצב ייבוא בלבד)
היקפי הרשאה

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

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

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

rpc CreateSpace(CreateSpaceRequest) returns (Space)

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

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

  • אימות אפליקציות עם אישור אדמין ואחת מהרשאות הגישה הבאות:

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

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

    • https://www.googleapis.com/auth/chat.spaces.create
    • https://www.googleapis.com/auth/chat.spaces
    • ‫https://www.googleapis.com/auth/chat.import (רווחים במצב ייבוא בלבד)

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

כשמבצעים אימות כאפליקציה, אפליקציית Chat מצורפת כחברה במרחב. עם זאת, בניגוד לאימות של משתמשים, אפליקציית Chat לא נוספת כמנהלת המרחב. כברירת מחדל, כל המשתתפים במרחב יכולים להסיר את אפליקציית Chat מהמרחב. כדי לאפשר רק למנהלי המרחב להסיר את האפליקציה מהמרחב, מגדירים את space.permission_settings.manage_apps לערך managers_allowed.

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

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

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

היקפי הרשאה

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

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

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

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

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

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

נדרש אימות משתמש עם הרשאת הגישה:

  • https://www.googleapis.com/auth/chat.customemojis
היקפי הרשאה

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

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

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

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

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

  • אימות אפליקציות עם אישור אדמין והיקף ההרשאה:

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

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.memberships.app (כדי להסיר את אפליקציית השיחות מהמרחב)
    • ‫https://www.googleapis.com/auth/chat.import (רווחים במצב ייבוא בלבד)
    • אימות משתמשים מעניק הרשאות אדמין כשחשבון אדמין מאומת, use_admin_access הוא true, ונעשה שימוש בהיקף ההרשאות הבא:
      • https://www.googleapis.com/auth/chat.admin.memberships

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

  • הסרת קבוצת Google ממרחב.
  • הסרת אפליקציית Chat ממרחב.

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

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

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

  • אימות אפליקציה עם היקף ההרשאה:

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

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

    • https://www.googleapis.com/auth/chat.messages
    • ‫https://www.googleapis.com/auth/chat.import (רווחים במצב ייבוא בלבד)

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

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

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

  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages
  • ‫https://www.googleapis.com/auth/chat.import (רווחים במצב ייבוא בלבד)
היקפי הרשאה

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

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

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

  • אימות אפליקציות עם אישור אדמין והיקף ההרשאה:

    • https://www.googleapis.com/auth/chat.app.delete (רק במרחבים שהאפליקציה יצרה)

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

    • https://www.googleapis.com/auth/chat.delete
    • ‫https://www.googleapis.com/auth/chat.import (רווחים במצב ייבוא בלבד)
    • אימות משתמשים מעניק הרשאות אדמין כשחשבון אדמין מאומת, use_admin_access הוא true, ונעשה שימוש בהיקף ההרשאות הבא:
      • https://www.googleapis.com/auth/chat.admin.delete
היקפי הרשאה

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

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

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

  • אימות אפליקציה עם היקף ההרשאה:

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

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
היקפי הרשאה

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

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

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

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

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

נדרש אימות אפליקציה עם היקף ההרשאה:

  • https://www.googleapis.com/auth/chat.bot
היקפי הרשאה

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

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

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

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

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

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

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

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis
היקפי הרשאה

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

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

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

rpc GetMembership(GetMembershipRequest) returns (Membership)

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

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

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

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships (נדרש אישור אדמין)

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • אימות משתמשים מעניק הרשאות אדמין כשחשבון אדמין מאומת, use_admin_access הוא true, ואחד מהיקפי ההרשאה הבאים נמצא בשימוש:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
היקפי הרשאה

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

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.memberships
  • 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)

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

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

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

    • ‫https://www.googleapis.com/auth/chat.bot: כשמשתמשים בהיקף ההרשאות הזה, השיטה הזו מחזירה פרטים על הודעה שאפליקציית Chat יכולה לגשת אליה, כמו הודעות ישירות ופקודות סלאש שמפעילות את אפליקציית Chat.
    • ‫https://www.googleapis.com/auth/chat.app.messages.readonly עם אישור אדמין (זמין בתצוגה מקדימה למפתחים). כשמשתמשים בהיקף ההרשאות הזה לאימות, השיטה הזו מחזירה פרטים על הודעה ציבורית במרחב.

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

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

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

היקפי הרשאה

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

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

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

rpc GetSpace(GetSpaceRequest) returns (Space)

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

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

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

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.spaces עם אישור אדמין

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • אימות משתמשים מעניק הרשאות אדמין כשחשבון אדמין מאומת, use_admin_access הוא true, ואחד מהיקפי ההרשאה הבאים נמצא בשימוש:
      • https://www.googleapis.com/auth/chat.admin.spaces.readonly
      • https://www.googleapis.com/auth/chat.admin.spaces

יש כמה מגבלות לאימות אפליקציות:

  • השדה space.access_settings מאוכלס רק כשמשתמשים בהיקף chat.app.spaces.
  • השדות space.predefind_permission_settings ו-space.permission_settings מאוכלסים רק כשמשתמשים בהיקף chat.app.spaces, ורק במרחבים שהאפליקציה יצרה.
היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של 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 המעודכן במטען הייעודי (payload) של האירוע.

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

תומך בסוגי אימות הבאים עם היקף הרשאות שמתאים לקריאת הנתונים המבוקשים:

  • אימות אפליקציות עם אישור אדמין בגרסת Developer Preview עם אחת מהרשאות הגישה הבאות:

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

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

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

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

לדוגמה, אפשר לעיין במאמר איך מקבלים פרטים על אירוע ממרחב ב-Google Chat.

היקפי הרשאה

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

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

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

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

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

נדרש אימות משתמש עם הרשאת הגישה:

  • https://www.googleapis.com/auth/chat.users.spacesettings
היקפי הרשאה

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

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

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

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

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

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

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
היקפי הרשאה

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

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

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

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

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

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

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate
היקפי הרשאה

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

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

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

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

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

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

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

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis
היקפי הרשאה

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

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

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

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

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

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

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

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships (נדרש אישור אדמין)

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • ‫https://www.googleapis.com/auth/chat.import (רווחים במצב ייבוא בלבד)
    • אימות משתמשים מעניק הרשאות אדמין כשחשבון אדמין מאומת, use_admin_access הוא true, ואחד מהיקפי ההרשאה הבאים נמצא בשימוש:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships
היקפי הרשאה

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

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

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

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

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

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

  • אימות אפליקציות עם אישור אדמין בגרסת Developer Preview עם היקף ההרשאה:

    • ‫https://www.googleapis.com/auth/chat.app.messages.readonly. כשמשתמשים בהיקף האימות הזה, השיטה הזו מחזירה רק הודעות ציבוריות במרחב. הוא לא כולל הודעות פרטיות.

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • ‫https://www.googleapis.com/auth/chat.import (רווחים במצב ייבוא בלבד)
היקפי הרשאה

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

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

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

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

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

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

  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages
היקפי הרשאה

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

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

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

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

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

תומך בסוגי אימות הבאים עם היקף הרשאות שמתאים לקריאת הנתונים המבוקשים:

  • אימות אפליקציות עם אישור אדמין בגרסת Developer Preview עם אחת מהרשאות הגישה הבאות:

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

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

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

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

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

היקפי הרשאה

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

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • 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)

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

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

  • אימות אפליקציה עם היקף ההרשאה:

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

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

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

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

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

  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.admin.spaces
היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של 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 עבור [email protected] הוא 123456789, אפשר להוסיף את המשתמש למרחב על ידי הגדרת membership.member.name ל-users/[email protected] או ל-users/123456789.

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

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

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

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

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

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

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

  • https://www.googleapis.com/auth/chat.spaces.create
  • https://www.googleapis.com/auth/chat.spaces
היקפי הרשאה

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

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

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

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

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

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

  • אימות אפליקציות עם אישור אדמין והיקף ההרשאה:

    • https://www.googleapis.com/auth/chat.app.memberships (רק במרחבים שהאפליקציה יצרה)

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

    • https://www.googleapis.com/auth/chat.memberships
    • ‫https://www.googleapis.com/auth/chat.import (רווחים במצב ייבוא בלבד)
    • אימות משתמשים מעניק הרשאות אדמין כשחשבון אדמין מאומת, use_admin_access הוא true, ונעשה שימוש בהיקף ההרשאות הבא:
      • https://www.googleapis.com/auth/chat.admin.memberships
היקפי הרשאה

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

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

  • אימות אפליקציה עם היקף ההרשאה:

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

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

    • https://www.googleapis.com/auth/chat.messages
    • ‫https://www.googleapis.com/auth/chat.import (רווחים במצב ייבוא בלבד)

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

היקפי הרשאה

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

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

  • אימות אפליקציות עם אישור אדמין ואחת מהרשאות הגישה הבאות:

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

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

    • https://www.googleapis.com/auth/chat.spaces
    • ‫https://www.googleapis.com/auth/chat.import (רווחים במצב ייבוא בלבד)
    • אימות משתמשים מעניק הרשאות אדמין כשחשבון אדמין מאומת, use_admin_access הוא true, והיקפי ההרשאה הבאים נמצאים בשימוש:
      • https://www.googleapis.com/auth/chat.admin.spaces

יש כמה מגבלות לאימות אפליקציות:

  • כדי לעדכן את space.predefined_permission_settings או את space.permission_settings, האפליקציה צריכה להיות יוצרת המרחב.
  • אי אפשר לעדכן את space.access_settings.audience לצורך אימות באפליקציה.
היקפי הרשאה

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

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

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

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

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

נדרש אימות משתמש עם הרשאת הגישה:

  • https://www.googleapis.com/auth/chat.users.spacesettings
היקפי הרשאה

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

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

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

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

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

נדרש אימות משתמש עם הרשאת הגישה:

  • https://www.googleapis.com/auth/chat.users.readstate
היקפי הרשאה

נדרש היקף ההרשאות הבא של 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

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

שדות
widget

string

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

SelectionItems

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

ActionStatus

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

שדות
status_code

Code

קוד הסטטוס.
user_facing_message

string

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

הערה

פלט בלבד. אפשר לשייך את ההערות לגוף ההודעה בטקסט פשוט או לצ'יפים שמקשרים למשאבי Google Workspace כמו Google Docs או Sheets עם start_index ו-length של 0. כדי להוסיף עיצוב בסיסי להודעת טקסט, אפשר לעיין במאמר בנושא עיצוב הודעות טקסט.

דוגמה לגוף הודעה בטקסט רגיל:

Hello @FooBot how are you!"

המטא-נתונים של ההערות המתאימות:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
שדות
type

AnnotationType

סוג ההערה.
length

int32

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

int32

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

UserMentionMetadata

המטא-נתונים של תיוג המשתמש.
slash_command

SlashCommandMetadata

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

CustomEmojiMetadata

המטא-נתונים של אמוג'י בהתאמה אישית.

AnnotationType

סוג ההערה.

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

AppCommandMetadata

מטא-נתונים על פקודה באפליקציית Chat.

שדות
app_command_id

int32

המזהה של הפקודה שצוינה בהגדרות של Chat API.
app_command_type

AppCommandType

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

AppCommandType

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

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

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 עם קבצים מצורפים.

CalendarEventLinkData

נתונים של קישורים לאירועים ביומן.

שדות
calendar_id

string

מזהה היומן של היומן המקושר.
event_id

string

מזהה האירוע של האירוע המקושר ביומן.

CardWithId

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

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

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

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

שדות
card_id

string

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

Card

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

ChatSpaceLinkData

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

שדות
space

string

המרחב של מקור המידע המקושר של המרחב ב-Chat.

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

string

השרשור של מקור המידע המקושר במרחב ב-Chat.

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

string

ההודעה של מקור המידע המקושר של המרחב ב-Chat.

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

CompleteImportSpaceRequest

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

שדות
name

string

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

פורמט: spaces/{space}

CompleteImportSpaceResponse

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

שדות
space

Space

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

ContextualAddOnMarkup

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

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

קלפים

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

שדות
header

CardHeader

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

Section

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

CardAction

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

string

שם הכרטיס.

CardAction

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

לא נתמך באפליקציות ל-Google Chat.

שדות
action_label

string

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

OnClick

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

CardHeader

שדות
title

string

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

string

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

ImageStyle

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

string

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

ImageStyle

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

קטע

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

שדות
header

string

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

WidgetMarkup

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

CreateCustomEmojiRequest

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

שדות
custom_emoji

CustomEmoji

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

CreateMembershipRequest

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

שדות
parent

string

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

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

Membership

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

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

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

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

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

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

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

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

bool

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

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

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

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

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

MessageReplyOption

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

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

CreateReactionRequest

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

שדות
parent

string

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

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

Reaction

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

CreateSpaceRequest

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

שדות
space

Space

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

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

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

string

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

CustomEmoji

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

שדות
name

string

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

פורמט: customEmojis/{customEmoji}
uid

string

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

string

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

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

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

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

string

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

CustomEmojiPayload

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

CustomEmojiPayload

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

שדות
file_content

bytes

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

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

string

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

סיומות קבצים נתמכות: .png, .jpg, .gif.

CustomEmojiMetadata

מטא-נתונים של הערות לסמלי אמוג'י מותאמים אישית.

שדות
custom_emoji

CustomEmoji

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

DeleteCustomEmojiRequest

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

שדות
name

string

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

פורמט: customEmojis/{customEmoji}

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

DeleteMembershipRequest

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

שדות
name

string

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

כשמוחקים חברות של אדם, נדרש היקף ההרשאות chat.memberships עם אימות משתמש או היקף ההרשאות chat.memberships.app עם אימות אפליקציה והפורמט spaces/{space}/members/{member}. אפשר להשתמש בכתובת האימייל ככתובת חלופית ל-{member}. לדוגמה, spaces/{space}/members/[email protected] כאשר [email protected] היא כתובת האימייל של המשתמש ב-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 עם הרשאה לניהול צ'אטים ושיחות במרחבים.

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

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

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 עם הרשאה לניהול צ'אטים ושיחות במרחבים.

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

DeletionMetadata

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

שדות
deletion_type

DeletionType

מצוין מי מחק את ההודעה.

DeletionType

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

טיפוסים בני מנייה (enum)
DELETION_TYPE_UNSPECIFIED הערך הזה לא בשימוש.
CREATOR המשתמש מחק את ההודעה שלו.
SPACE_OWNER אחד ממנהלי המרחב מחק את ההודעה.
ADMIN אדמין ב-Google Workspace מחק את ההודעה. אדמינים יכולים למחוק כל הודעה במרחב, כולל הודעות שנשלחו על ידי משתתפים במרחב או על ידי אפליקציית Chat.
APP_MESSAGE_EXPIRY אפליקציית Chat מחקה את ההודעה שלה כשהתוקף שלה פג.
CREATOR_VIA_APP אפליקציית Chat מחקה את ההודעה בשם היוצר (באמצעות אימות משתמש).
SPACE_OWNER_VIA_APP אפליקציית Chat מחקה את ההודעה בשם מנהל/ת המרחב (באמצעות אימות משתמש).
SPACE_MEMBER אחד מהמשתתפים במרחב מחק את ההודעה. המשתמשים יכולים למחוק הודעות שנשלחו על ידי אפליקציות.

תיבת דו-שיח

רכיב Wrapper מסביב לתוכן של כרטיס תיבת הדו-שיח.

שדות
body

Card

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

DialogAction

מכיל dialog וקוד סטטוס של הבקשה.

שדות
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/[email protected] כאשר [email protected] היא כתובת האימייל של המשתמש ב-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/[email protected] כאשר [email protected] היא כתובת האימייל של המשתמש ב-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}

GetSpaceNotificationSettingRequest

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

שדות
name

string

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

  • users/me/spaces/{space}/spaceNotificationSetting, או
  • users/[email protected]/spaces/{space}/spaceNotificationSetting, או
  • ‫users/123456789/spaces/{space}/spaceNotificationSetting. הערה: רק מזהה המשתמש או כתובת האימייל של המתקשר מותרים בנתיב.

GetSpaceReadStateRequest

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

שדות
name

string

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

האפשרות הזו תומכת רק בקבלת מצב הקריאה של המשתמש המתקשר.

כדי להתייחס למשתמש המתקשר, מגדירים את אחד מהערכים הבאים:

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

  • כתובת האימייל שלהם ב-Workspace. לדוגמה, users/[email protected]/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/[email protected]/spaces/{space}/threads/{thread}/threadReadState.

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

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

קבוצה

קבוצת Google ב-Google Chat.

שדות
name

string

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

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

פורמט: groups/{group}

HistoryState

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

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

ListCustomEmojisRequest

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

שדות
page_size

int32

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

string

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

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

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

string

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

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

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

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

creator("users/me")

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

ListCustomEmojisResponse

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

שדות
custom_emojis[]

CustomEmoji

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

string

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

ListMembershipsRequest

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

שדות
parent

string

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

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

int32

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

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

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

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

string

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

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

string

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

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

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

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

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

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

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

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

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

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

אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של list space events. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

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

string

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

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