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

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

  • 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.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 ריק.

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

  • 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.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 עבור 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.

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

  • 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 עבור user@example.com הוא 123456789, אפשר להוסיף את המשתמש למרחב על ידי הגדרת membership.member.name ל-users/user@example.com או ל-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/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 עם הרשאה לניהול צ'אטים ושיחות במרחבים.

נדרש 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/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}

GetSpaceNotificationSettingRequest

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

שדות
name

string

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

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

GetSpaceReadStateRequest

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

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

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

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

שדות
url

string

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

MeetSpaceLinkData

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

שדות
meeting_code

string

קוד הפגישה של המרחב ב-Meet שמקושר.
type

Type

מציין את סוג המרחב ב-Meet.
huddle_status

HuddleStatus

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

HuddleStatus

הסטטוס של השיחה המהירה

טיפוסים בני מנייה (enum)
HUDDLE_STATUS_UNSPECIFIED ערך ברירת המחדל של ה-enum. לא לשימוש.
STARTED השיחה המהירה התחילה.
ENDED השיחה המהירה הסתיימה. במקרה כזה, מזהה ה-URI והמזהים של המרחב ב-Meet לא יהיו תקפים יותר.
MISSED השיחה לא נענתה. במקרה כזה, מזהה ה-URI והמזהים של המרחב ב-Meet לא יהיו תקפים יותר.

סוג

סוג המרחב ב-Meet.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED ערך ברירת המחדל של ה-enum. לא לשימוש.
MEETING המרחב ב-Meet הוא פגישה.
HUDDLE המרחב ב-Meet הוא שיחה מהירה.

מינוי

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

שדות
name

string

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

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

MembershipState

פלט בלבד. מצב המינוי.
role

MembershipRole

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

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

Timestamp

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

Timestamp

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

User

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

Group

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

כדי לקרוא או לשנות את חברי הקבוצות ב-Google, נדרש אימות משתמש.

MembershipRole

מייצג את הפעולות שהמשתמש יכול לבצע במרחב ב-Chat. יכול להיות שיתווספו ערכים נוספים של enum בעתיד.

טיפוסים בני מנייה (enum)
MEMBERSHIP_ROLE_UNSPECIFIED ערך ברירת המחדל. לגבי users: המשתמש לא חבר במרחב, אבל אפשר להזמין אותו. ב-Google Groups: התפקיד הזה תמיד מוקצה להם (יכול להיות שבעתיד ייעשה שימוש בערכי enum אחרים).
ROLE_MEMBER משתתף במרחב. למשתמש יש הרשאות בסיסיות, כמו שליחת הודעות במרחב. בשיחות אישיות ובשיחות קבוצתיות ללא שם, לכולם יש את התפקיד הזה.
ROLE_MANAGER המנהל/ת של המרחב. למשתמש יש את כל ההרשאות הבסיסיות, בנוסף להרשאות אדמין שמאפשרות לו לנהל את המרחב, כמו הוספה או הסרה של משתתפים. התכונה הזו נתמכת רק ב-SpaceType.SPACE.

MembershipState

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

טיפוסים בני מנייה (enum)
MEMBERSHIP_STATE_UNSPECIFIED ערך ברירת המחדל. לא לשימוש.
JOINED המשתמש נוסף למרחב ויכול להשתתף בו.
INVITED המשתמש הוזמן להצטרף למרחב, אבל הוא לא הצטרף.
NOT_A_MEMBER המשתמש לא שייך למרחב ואין לו הזמנה בהמתנה להצטרפות למרחב.

MembershipBatchCreatedEventData

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

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

שדות
memberships[]

MembershipCreatedEventData

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

MembershipBatchDeletedEventData

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

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

שדות
memberships[]

MembershipDeletedEventData

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

MembershipBatchUpdatedEventData

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

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

שדות
memberships[]

MembershipUpdatedEventData

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

MembershipCreatedEventData

המטען הייעודי של אירוע למינוי חדש.

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

שדות
membership

Membership

המינוי החדש.

MembershipDeletedEventData

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

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

שדות
membership

Membership

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

MembershipUpdatedEventData

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

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

שדות
membership

Membership

המינוי המעודכן.

הודעה

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

שדות
name

string

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

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

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

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

User

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

Timestamp

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

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

Timestamp

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

Timestamp

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

string

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

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

string

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

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

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

פלט בלבד. אפשר לשייך את ההערות לגוף ההודעה בטקסט פשוט או לצ'יפים שמקשרים למשאבי Google Workspace כמו Google Docs או Sheets עם start_index ו-length של 0.
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

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

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

כשמעדכנים הודעה, אי אפשר להוסיף או להחליף את השדה quotedMessageMetadata, אבל אפשר להסיר אותו.

דוגמאות לשימוש מופיעות במאמר ציטוט של הודעה אחרת.
attached_gifs[]

AttachedGif

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

AccessoryWidget

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

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

MessageBatchCreatedEventData

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

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

שדות
messages[]

MessageCreatedEventData

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

MessageBatchDeletedEventData

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

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

שדות
messages[]

MessageDeletedEventData

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

MessageBatchUpdatedEventData

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

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

שדות
messages[]

MessageUpdatedEventData

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

MessageCreatedEventData

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

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

שדות
message

Message

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

MessageDeletedEventData

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

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

שדות
message

Message

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

MessageUpdatedEventData

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

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

שדות
message

Message

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

QuotedMessageMetadata

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

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

כשמעדכנים הודעה, אי אפשר להוסיף או להחליף את השדה quotedMessageMetadata, אבל אפשר להסיר אותו.

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

שדות
name

string

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

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

Timestamp

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

אם ההודעה נערכה, צריך להשתמש בשדה הזה, last_update_time. אם ההודעה לא נערכה אף פעם, משתמשים ב-create_time.

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

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

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

שדות
name

string

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

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

User

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

Emoji

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

ReactionBatchCreatedEventData

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

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

שדות
reactions[]

ReactionCreatedEventData

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

ReactionBatchDeletedEventData

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

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

שדות
reactions[]

ReactionDeletedEventData

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

ReactionCreatedEventData

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

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

שדות
reaction

Reaction

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

ReactionDeletedEventData

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

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

שדות
reaction

Reaction

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

RichLinkMetadata

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

שדות
uri

string

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

RichLinkType

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

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

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

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

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

כרגע, המערכת מאפשרת עד 49 חברים (בנוסף למתקשר).

במינוי של משתמשים, השדה 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

המזהה של הפקודה דרך שורת הפקודות.

SlashCommandMetadata

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

שדות
bot

User

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

Type

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

string

השם של פקודת הסלאש שהופעלה.
command_id

int64

המזהה של הפקודה דרך שורת הפקודות שהופעלה.
triggers_dialog

bool

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

סוג

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

רווח

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

שדות
name

string

מזהה. שם המשאב של המרחב.

פורמט: spaces/{space}

כאשר {space} מייצג את המזהה שהוקצה למרחב על ידי המערכת. אפשר לקבל את מזהה המרחב באמצעות הפעלת השיטה 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

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

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

MembershipCount

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

AccessSettings

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

string

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

Timestamp

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

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

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

string

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

בפורמט customers/{customer}, כאשר customer הוא id ממשאב הלקוח של Admin SDK. אפליקציות פרטיות יכולות גם להשתמש בכינוי 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

אופציונלי. הגדרה לשימוש בתיוג @all במרחב.
manage_apps

PermissionSetting

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

PermissionSetting

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

PermissionSetting

פלט בלבד. הגדרה לפרסום הודעות במרחב.
reply_messages

PermissionSetting

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

PredefinedPermissionSettings

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

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

SpaceDetails

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

שדות
description

string

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

אפשר להזין עד 150 תווים.
guidelines

string

אופציונלי. הכללים, הציפיות וכללי ההתנהגות במרחב.

אפשר להזין עד 5,000 תווים.

SpaceThreadingState

מציין את סוג השרשור במרחב ב-Chat.

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

SpaceType

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

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

סוג

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

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

SpaceBatchUpdatedEventData

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

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

שדות
spaces[]

SpaceUpdatedEventData

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

SpaceEvent

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

שדות
name

string

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

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

Timestamp

השעה שבה התרחש האירוע.
event_type

string

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

סוגי האירועים הנתמכים עבור הודעות:

  • הודעה חדשה: google.workspace.chat.message.v1.created
  • ההודעה המעודכנת: google.workspace.chat.message.v1.updated
  • ההודעה שנמחקה: google.workspace.chat.message.v1.deleted
  • כמה הודעות חדשות: google.workspace.chat.message.v1.batchCreated
  • כמה הודעות מעודכנות: google.workspace.chat.message.v1.batchUpdated
  • כמה הודעות שנמחקו: google.workspace.chat.message.v1.batchDeleted

סוגי האירועים הנתמכים עבור חברות:

  • מינוי חדש: google.workspace.chat.membership.v1.created
  • מינוי מעודכן: google.workspace.chat.membership.v1.updated
  • מינוי שנמחק: google.workspace.chat.membership.v1.deleted
  • כמה חברויות חדשות: google.workspace.chat.membership.v1.batchCreated
  • כמה מינויים מעודכנים: google.workspace.chat.membership.v1.batchUpdated
  • כמה חברויות שנמחקו: google.workspace.chat.membership.v1.batchDeleted

סוגי האירועים הנתמכים עבור תגובות:

  • תגובה חדשה: google.workspace.chat.reaction.v1.created
  • התגובה באמוג'י נמחקה: google.workspace.chat.reaction.v1.deleted
  • תגובות חדשות מרובות: google.workspace.chat.reaction.v1.batchCreated
  • כמה תגובות שנמחקו: google.workspace.chat.reaction.v1.batchDeleted

סוגי האירועים הנתמכים לגבי המרחב:

  • המרחב המשותף עודכן: google.workspace.chat.space.v1.updated
  • כמה עדכונים במרחבים: google.workspace.chat.space.v1.batchUpdated

שדה איחוד payload.

הערך payload יכול להיות רק אחד מהערכים הבאים:
message_created_event_data

MessageCreatedEventData

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

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

MessageUpdatedEventData

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

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

MessageDeletedEventData

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

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

MessageBatchCreatedEventData

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

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

MessageBatchUpdatedEventData

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

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

MessageBatchDeletedEventData

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

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

SpaceUpdatedEventData

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

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

SpaceBatchUpdatedEventData

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

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

MembershipCreatedEventData

המטען הייעודי של אירוע למינוי חדש.

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

MembershipUpdatedEventData

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

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

MembershipDeletedEventData

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

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

MembershipBatchCreatedEventData

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

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

MembershipBatchUpdatedEventData

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

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

MembershipBatchDeletedEventData

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

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

ReactionCreatedEventData

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

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

ReactionDeletedEventData

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

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

ReactionBatchCreatedEventData

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

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

ReactionBatchDeletedEventData

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

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

SpaceNotificationSetting

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

שדות
name

string

מזהה. שם המשאב של הגדרת ההתראות במרחב. פורמט: users/{user}/spaces/{space}/spaceNotificationSetting
notification_setting

NotificationSetting

הגדרת ההתראות.
mute_setting

MuteSetting

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

MuteSetting

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

טיפוסים בני מנייה (enum)
MUTE_SETTING_UNSPECIFIED שמורות.
UNMUTED המשתמש יקבל התראות לגבי המרחב בהתאם להגדרת ההתראות.
MUTED המשתמש לא יקבל התראות לגבי המרחב, ללא קשר להגדרת ההתראות.

NotificationSetting

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

טיפוסים בני מנייה (enum)
NOTIFICATION_SETTING_UNSPECIFIED שמורות.
ALL ההתראות מופעלות על ידי תיוגים ב-@, שרשורים במעקב וההודעה הראשונה בשרשורים חדשים. כל השרשורים החדשים יתווספו אוטומטית לרשימת המעקב, אלא אם המשתמש יבטל את המעקב אחריהם באופן ידני.
MAIN_CONVERSATIONS ההתראה מופעלת על ידי אזכורים, שרשורים במעקב או ההודעה הראשונה בשרשורים חדשים. לא זמין בצ'אטים אישיים.
FOR_YOU ההתראה מופעלת על ידי אזכורים באמצעות @ושרשורים שבמעקב. לא זמין בצ'אטים אישיים.
OFF ההתראות מושבתות.

SpaceReadState

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

שדות
name

string

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

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

Timestamp

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

SpaceUpdatedEventData

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

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

שדות
space

Space

המרחב המעודכן.

חוט תפירה

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

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

שדות
name

string

מזהה. שם המשאב של השרשור.

לדוגמה: spaces/{space}/threads/{thread}
thread_key

string

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

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

ThreadReadState

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

שדות
name

string

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

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

Timestamp

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

UpdateMembershipRequest

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

שדות
membership

Membership

חובה. החברות שרוצים לעדכן. רק השדות שצוינו על ידי update_mask יעודכנו.
update_mask

FieldMask

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

נכון לעכשיו, אלה נתיבי השדות שנתמכים:

  • role
use_admin_access

bool

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

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

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

UpdateMessageRequest

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

שדות
message

Message

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

FieldMask

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

נכון לעכשיו, אלה נתיבי השדות שנתמכים:
allow_missing

bool

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

UpdateSpaceNotificationSettingRequest

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

שדות
space_notification_setting

SpaceNotificationSetting

חובה. צריך למלא את שם המשאב של הגדרות ההתראות במרחב בפורמט users/{user}/spaces/{space}/spaceNotificationSetting. רק השדות שצוינו על ידי update_mask יעודכנו.
update_mask

FieldMask

חובה. נתיבי שדות נתמכים:

  • notification_setting

  • mute_setting

UpdateSpaceReadStateRequest

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

שדות
space_read_state

SpaceReadState

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

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

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

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

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

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

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

FieldMask

חובה. נתיבי השדות לעדכון. נכון לעכשיו, אלה נתיבי השדות שנתמכים:

  • last_read_time

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

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

UpdateSpaceRequest

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

שדות
space

Space

חובה. מרחב עם שדות שצריך לעדכן. צריך למלא את הערך Space.name בפורמט spaces/{space}. רק השדות שצוינו על ידי update_mask יעודכנו.
update_mask

FieldMask

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

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

‫space_details: עדכון התיאור של המרחב. אפשר להזין עד 150 תווים.

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

‫space_type: אפשר לשנות רק את סוג המרחב GROUP_CHAT ל-SPACE. כוללים את display_name יחד עם space_type במסכת העדכון, ומוודאים שלמרחב שצוין יש שם מוצג לא ריק וסוג המרחב הוא SPACE. אם המרחב הקיים כבר כולל את הסוג SPACE, אפשר לא לכלול את המסכה space_type ואת הסוג SPACE במרחב שצוין כשמעדכנים את השם לתצוגה. ניסיון לעדכן את סוג המרחב בדרכים אחרות יגרום לשגיאה של ארגומנט לא חוקי. אין תמיכה ב-space_type עם useAdminAccess.

‫space_history_state: עדכון הגדרות ההיסטוריה של המרחב על ידי הפעלה או השבתה של ההיסטוריה במרחב. האפשרות הזו נתמכת רק אם הגדרות ההיסטוריה מופעלות בארגון ב-Google Workspace. כדי לעדכן את מצב ההיסטוריה של המרחב, צריך להשמיט את כל מסכות השדות האחרות בבקשה. אין תמיכה ב-space_history_state עם useAdminAccess.

‫access_settings.audience: מעדכן את הגדרת הגישה של מי יכול לגלות את המרחב, להצטרף למרחב ולצפות בתצוגה מקדימה של ההודעות במרחב עם שם, כאשר השדה spaceType הוא SPACE. אם למרחב הקיים יש קהל יעד, אפשר להסיר את הקהל ולהגביל את הגישה למרחב על ידי השמטת ערך למסיכת השדה הזו. כדי לעדכן את הגדרות הגישה למרחב, המשתמש המאומת צריך להיות מנהל המרחב ולהשמיט את כל מסכות השדות האחרות בבקשה. אי אפשר לעדכן את השדה הזה אם המרחב נמצא במצב ייבוא. מידע נוסף זמין במאמר בנושא הגדרת מרחב כגלוי למשתמשים ספציפיים. אין תמיכה ב-access_settings.audience עם useAdminAccess.

‫permission_settings: תומך בשינוי הגדרות ההרשאות של מרחב. כשמעדכנים את הגדרות ההרשאות, אפשר לציין רק מסכות שדות של permissionSettings. אי אפשר לעדכן מסכות שדות אחרות בו-זמנית. אין תמיכה ב-permissionSettings עם useAdminAccess. מסכות השדות הנתמכות כוללות:

  • permission_settings.manageMembersAndGroups
  • permission_settings.modifySpaceDetails
  • permission_settings.toggleHistory
  • permission_settings.useAtMentionAll
  • permission_settings.manageApps
  • permission_settings.manageWebhooks
  • permission_settings.replyMessages
use_admin_access

bool

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

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

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

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

משתמש

משתמש ב-Google Chat. אם אפליקציית Chat שלכם מאומתת כמשתמש, הפלט של משאב User יכלול רק את name ו-type של המשתמש.

שדות
name

string

שם המשאב של user ב-Google Chat.

פורמט: users/{user} אפשר להשתמש ב-users/app ככינוי למשתמש באפליקציית השיחות bot.

במקרה של human users, המזהה של המשתמש {user} זהה למזהה של:

  • ‫id של Person ב-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