Package google.chat.v1

אינדקס

ChatService

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

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

תומך בסוגי האימות הבאים:

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

    • 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 מוצגת כשולחת ההודעה. התוכן של ההודעה יכול לכלול טקסט (text), כרטיסים (cardsV2) ווידג'טים נלווים (accessoryWidgets).

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

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

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

rpc CreateMessagePin(CreateMessagePinRequest) returns (MessagePin)

הצמדת הודעה.

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

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

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

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

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

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

rpc CreateSection(CreateSectionRequest) returns (Section)

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

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

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

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

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

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

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

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

  • הסרת קבוצה ב-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

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

rpc DeleteMessagePin(DeleteMessagePinRequest) returns (Empty)

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

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

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

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

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

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

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

rpc DeleteSection(DeleteSectionRequest) returns (Empty)

מחיקת קטע מסוג CUSTOM_SECTION.

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

פרטים נוספים מופיעים במאמר איך יוצרים חלקים ועושים סדר ב-Google Chat.

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

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

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

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

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

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

rpc FindGroupChats(FindGroupChatsRequest) returns (FindGroupChatsResponse)

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

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

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

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

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

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

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

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

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

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

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

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

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

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

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

rpc GetAvailability(GetAvailabilityRequest) returns (Availability)

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

השיטה הזו מאחזרת רק את הזמינות של המשתמש המאומת.

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

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

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

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

מידע נוסף זמין במדריך ההרשאות.
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.app.spaces
    • https://www.googleapis.com/auth/chat.app.spaces.readonly
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.memberships
    • https://www.googleapis.com/auth/chat.app.memberships.readonly

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

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

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

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

היקפי הרשאות

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

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

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

rpc ListMessagePins(ListMessagePinsRequest) returns (ListMessagePinsResponse)

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

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

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

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

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

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

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

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

תומך בסוגי האימות הבאים:

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

    • 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

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

rpc ListSectionItems(ListSectionItemsRequest) returns (ListSectionItemsResponse)

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

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

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

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

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

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

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

rpc ListSections(ListSectionsRequest) returns (ListSectionsResponse)

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

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

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

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

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

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

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

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

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

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

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

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

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

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

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

היקפי הרשאות

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

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

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

rpc MarkAsActive(MarkAsActiveRequest) returns (Availability)

המשתמש יסומן כACTIVE ב-Google Chat.

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

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

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

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

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

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

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

rpc MarkAsAway(MarkAsAwayRequest) returns (Availability)

המשתמש יסומן כAWAY ב-Google Chat.

הסטטוס של המשתמש מוגדר כ"לא פנוי/ה" ולא מושפע מהפעילות שלו.

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

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

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

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

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

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

rpc MarkAsDoNotDisturb(MarkAsDoNotDisturbRequest) returns (Availability)

המשתמש יסומן כDO_NOT_DISTURB ב-Google Chat.

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

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

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

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

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

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

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

rpc MoveSectionItem(MoveSectionItemRequest) returns (MoveSectionItemResponse)

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

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

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

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

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

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

rpc PositionSection(PositionSectionRequest) returns (PositionSectionResponse)

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

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

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

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

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

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

rpc ReplaceMessageCards(ReplaceMessageCardsRequest) returns (ReplaceMessageCardsResponse)

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

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

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

נדרש אימות של האפליקציה עם היקף ההרשאות: - https://www.googleapis.com/auth/chat.bot

היקפי הרשאות

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

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

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

rpc SearchMessages(SearchMessagesRequest) returns (SearchMessagesResponse)

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

כדי לחפש בכל המרחבים שלמשתמש יש גישה אליהם, מגדירים את parent ל-spaces/-. שימוש בכל ערך אחר בשדה parent יגרום לשגיאה INVALID_ARGUMENT. ההודעות שמוחזרות כוללות את השדה name עם שם המשאב המלא, שכולל את ה-space הספציפי שבו נמצאת ההודעה.

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

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

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

  • 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

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

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

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

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

תומך בסוגי האימות הבאים:

היקפי הרשאות

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

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • 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. לדוגמה, אם מזהה הפרופיל של user@example.com ב-People API הוא 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

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

rpc UpdateAvailability(UpdateAvailabilityRequest) returns (Availability)

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

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

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

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

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

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

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

היקפי הרשאות

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

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

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

rpc UpdateSection(UpdateSectionRequest) returns (Section)

עדכון של קטע. אפשר לעדכן רק קטעים מסוג CUSTOM_SECTION. פרטים נוספים מופיעים במאמר איך יוצרים חלקים ועושים סדר ב-Google Chat.

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

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

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

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

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

סוג הפקודה של אפליקציית הצ'אט.

AppCommandType

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

טיפוסים בני מנייה (enum)
APP_COMMAND_TYPE_UNSPECIFIED ערך ברירת המחדל. לא צוין.
SLASH_COMMAND פקודה דרך שורת הפקודות. המשתמש שולח את הפקודה בהודעת צ'אט.
QUICK_COMMAND פקודה מהירה. המשתמש בוחר את הפקודה מהתפריט של Chat באזור התשובה להודעה.
MESSAGE_ACTION פעולה שקשורה להודעה. המשתמש בוחר את הפקודה מתפריט ההקשר של ההודעה ב-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

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

DriveDataRef

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

מקור

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

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

AttachmentDataRef

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

שדות
resource_name

string

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

string

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

קהל

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

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

שדות
name

string

שם המשאב של קהל היעד שיכול לגלות את המרחב או להצטרף אליו. פרטים נוספים מופיעים במאמר איך הופכים מרחב משותף לגלוי לקהל היעד. פורמט: audiences/{audience}

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

זמינות

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

שדות
name

string

מזהה. שם המשאב של זמינות המשתמש.

פורמט: users/{user}/availability

‫{user} הוא המזהה של האדם ב-People API או ב-Admin SDK Directory API. לדוגמה, users/123456789.

אפשר גם להשתמש בכתובת האימייל של המשתמש או ב-me ככינוי כדי להתייחס למבצע הקריאה החוזרת. לדוגמה, users/user@example.com או users/me.
state

State

פלט בלבד. סטטוס הזמינות הנוכחי של המשתמש.
custom_status

CustomStatus

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

DoNotDisturbMetadata

פלט בלבד. מטא-נתונים אם סטטוס המשתמש מוגדר כ"נא לא להפריע".

מדינה (State)

מייצג את מצב הזמינות הנוכחי של המשתמש.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED ערך ברירת המחדל. המצב לא צוין.
ACTIVE המשתמש פעיל כרגע, על סמך הפעילות האחרונה.
IDLE המשתמש לא פעיל כרגע. הסטטוס הזה מציין תקופה של חוסר פעילות אחרי סטטוס "פעיל/ה", לפני מעבר אפשרי לסטטוס "לא זמין/ה".
AWAY המשתמש לא נמצא כרגע. הסטטוס הזה יכול להיות מוגדר באופן אוטומטי אחרי פרק זמן של חוסר פעילות במצב "פעיל" או "לא פעיל", או שהמשתמש יכול להגדיר אותו באופן ידני. כשמגדירים את המצב הזה באופן ידני דרך MarkAsAway, הוא נשאר ללא קשר לפעילות המשתמש.
DO_NOT_DISTURB המשתמש נמצא במצב "נא לא להפריע", שהוגדר באופן ידני.

CalendarEventLinkData

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

שדות
calendar_id

string

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

string

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

CardWithId

כרטיס בהודעת צ'אט ב-Google Chat.

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

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

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

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

שדות
card_id

string

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

Card

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

User

פלט בלבד. האפליקציה שהכרטיס שייך לה.

ChatSpaceLinkData

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

שדות
space

string

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

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

string

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

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

string

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

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

ציטוט ביבליוגרפי

ציטוטים הם הפניות בגוף הטקסט שיכולות לספק למשתמשים מידע מפורט יותר על ההפניה. הציטוטים המוטבעים המתאימים צריכים להופיע בטקסט של ההודעה בפורמט תגי עיצוב של <chat-citation data-id="{id}">{text}</chat-citation>. אפשר להוסיף ציטוטים רק אם הערך של markup_syntax בהודעה הוא MARKDOWN.

המערכת מתעלמת מציטוטים ללא הפניה ב-Elements.citations (ציטוטים ללא תג <chat-citation> תואם בטקסט של ההודעה), והם לא גורמים לדחיית ההודעה.

שדות
id

string

חובה. מזהה שמוגדר באפליקציה. הוא צריך להכיל רק אותיות ומספרים ב-ASCII, ופחות מ-63 תווים.
cited_sources[]

CitedSource

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

CitedSource

הפניה למקור מידע.

שדות
title

string

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

string

חובה. ה-URI שמפנה למשאב שאליו מפנה ה-CitedSource הזה.
snippet

Snippet

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

Footer

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

כותרת תחתונה למקור, שמשמשת לשיוך (Attribution).

שדות
text

string

אופציונלי. הטקסט שיוצג בכותרת התחתונה.

קטע טקסט

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

שדות
text

string

אופציונלי. קטע קצר בטקסט פשוט ישירות מהקורפוס, שעשוי להופיע ב-Chat. אין תמיכה בפורמט Markdown.
image_preview

ElementsImage

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

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

הפעולה 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. לדוגמה, אם מזהה הפרופיל של user@example.com ב-People API הוא 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.

CreateMessageNotificationOptions

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

שדות
notification_type

NotificationType

סוג ההתראה של ההודעה.

NotificationType

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

טיפוסים בני מנייה (enum)
NOTIFICATION_TYPE_NONE פעולת ברירת מחדל. ההתראות פועלות באופן דומה למצב שבו המשתמש האנושי שולח את ההודעה באמצעות ממשק המשתמש של Chat: לא נשלחת התראה לשולח האנושי.
NOTIFICATION_TYPE_FORCE_NOTIFY

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

נדרש אימות של האפליקציה.
NOTIFICATION_TYPE_SILENT

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

נדרש אימות של האפליקציה.

CreateMessagePinRequest

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

שדות
parent

string

חובה. המרחב המשותף הראשי שבו רוצים להצמיד את ההודעה. פורמט: spaces/{space}
message_pin

MessagePin

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

CreateMessageRequest

יצירת הודעה.

שדות
parent

string

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

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

Message

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

string

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

string

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

כדי להשתמש בשדה הזה בצורה יעילה:

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

MessageReplyOption

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

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

string

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

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

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

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

CreateMessageNotificationOptions

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

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

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

CreateSectionRequest

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

שדות
parent

string

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

פורמט: users/{user}
section

Section

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

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

כדי להשתמש בשדה הזה בצורה יעילה:

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

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

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

CustomStatus

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

שדות
text

string

חובה. הטקסט של הסטטוס בהתאמה אישית. הערך הזה יהיה מחרוזת באורך של עד 64 תווים.
emoji

Emoji

חובה. האמוג'י של הסטטוס בהתאמה אישית. יש תמיכה רק באמוג'י בפורמט Unicode, ואין תמיכה באמוג'י בהתאמה אישית.
שדה של איחוד expiration. זמן התפוגה של הסטטוס האישי. אפשר לציין אותו כחותמת זמן מוחלטת או כמשך זמן קצוב. הערך expiration יכול להיות רק אחד מהבאים:
expire_time

Timestamp

חותמת הזמן של מועד התפוגה של הסטטוס האישי.
ttl

Duration

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

DeleteCustomEmojiRequest

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

שדות
name

string

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

פורמט: customEmojis/{customEmoji}

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

DeleteMembershipRequest

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

שדות
name

string

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

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

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

DeleteMessagePinRequest

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

שדות
name

string

חובה. שם המשאב של ההודעה המוצמדת שרוצים להסיר. פורמט: spaces/{space}/messagePins/{message_pin}

DeleteMessageRequest

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

שדות
name

string

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

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

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

bool

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

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

DeleteReactionRequest

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

שדות
name

string

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

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

DeleteSectionRequest

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

שדות
name

string

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

פורמט: users/{user}/sections/{section}

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

Dialog

רכיב wrapper סביב גוף הכרטיס של תיבת הדו-שיח.

שדות
body

Card

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

DialogAction

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

שדות
action_status

ActionStatus

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

Dialog

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

DoNotDisturbMetadata

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

שדות
expiration_time

Timestamp

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

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.

רכיבים

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

שדות
cited_sources[]

CitedSource

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

Citation

רשימה של ציטוטים בגוף הטקסט שמופיעים בטקסט של ההודעה (באמצעות תגי <chat-citation>) ומוצגים ככרטיסים אינטראקטיביים כשמעבירים מעליהם את העכבר.

ElementsImage

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

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

string

חובה. כתובת URI של תמונה שנגישה לכולם.

אמוג'י

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

שדות
שדה של איחוד 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.

FindGroupChatsRequest

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

שדות
users[]

string

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

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

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

int32

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

אם לא מציינים ערך, יוחזרו עד 10 מרחבים משותפים.

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

ערכים שליליים מחזירים שגיאת INVALID_ARGUMENT.
page_token

string

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

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

SpaceView

סוג התצוגה המבוקש של המרחב המשותף. אם המדיניות לא מוגדרת, ברירת המחדל היא SPACE_VIEW_RESOURCE_NAME_ONLY. בקשות שמציינות את SPACE_VIEW_EXPANDED חייבות לכלול היקפי הרשאות שמאפשרים לקרוא נתונים של מרחבים משותפים, למשל https://www.googleapis.com/auth/chat.spaces או https://www.googleapis.com/auth/chat.spaces.readonly.

FindGroupChatsResponse

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

שדות
spaces[]

Space

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

string

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

ForwardedMetadata

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

שדות
space

string

פלט בלבד. שם המשאב של המרחב המשותף המקורי. פורמט: spaces/{space}
space_display_name

string

פלט בלבד. השם המוצג של המרחב המשותף או הצ'אט האישי שממנו הועברה ההודעה, בזמן ההעברה. ב-SPACE, זה השם של המרחב. בשדה DIRECT_MESSAGE, זה השם של המשתתף השני (למשל, "משתמש א'"). ב-GROUP_CHAT, השם נוצר באופן אוטומטי על סמך השמות הפרטיים של המשתתפים, עד 5 שמות כולל היוצר (למשל, "משתמש א', משתמש ב'").

GetAttachmentRequest

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

שדות
name

string

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

GetAvailabilityRequest

הודעת בקשה ל-method‏ GetAvailability.

שדות
name

string

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

פורמט: users/{user}/availability

‫{user} הוא המזהה של האדם ב-People API או ב-Admin SDK Directory API. לדוגמה, users/123456789.

אפשר גם להשתמש בכתובת האימייל של המשתמש או ב-me ככינוי כדי להתייחס למבצע הקריאה החוזרת. לדוגמה, users/user@example.com או users/me.

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

MarkupSyntax

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

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 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.
page_token

string

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

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

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

string

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

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

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

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

creator("users/me")

שאילתות לא חוקיות נדחות ומוצגת השגיאה INVALID_ARGUMENT.

ListCustomEmojisResponse

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

שדות
custom_emojis[]

CustomEmoji

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

string

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

ListMembershipsRequest

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

שדות
parent

string

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

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

int32

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

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

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

ערכים שליליים מחזירים שגיאת INVALID_ARGUMENT.
page_token

string

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

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

string

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

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

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

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

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

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

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

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

member.type != "BOT"

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

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

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

bool

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

bool

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

כרגע נדרש אימות משתמש.
use_admin_access

bool

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

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

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

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

ListMembershipsResponse

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

שדות
memberships[]

Membership

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

string

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

ListMessagePinsRequest

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

שדות
parent

string

חובה. המרחב המשותף הראשי שאוסף הפריטים המוצמדים שייך לו. פורמט: spaces/{space}
page_size

int32

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

string

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

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

ListMessagePinsResponse

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

שדות
message_pins[]

MessagePin

ההודעות המוצמדות מהמרחב שצוין.
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

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

MarkupSyntax

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

ListMessagesResponse

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

שדות
messages[]

Message

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

string

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

ListReactionsRequest

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

שדות
parent

string

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

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

int32

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

string

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

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

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

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

ListSectionItemsRequest

הודעת בקשה להצגת פריטים בקטע.

שדות
parent

string

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

כשמסננים לפי מרחב, אפשר להשתמש בתו הכללי לחיפוש - כדי לחפש בכל החלקים. לדוגמה, users/{user}/sections/-.

פורמט: users/{user}/sections/{section}
page_size

int32

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

אם לא מציינים ערך, יוחזרו עד 10 פריטים.

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

ערכים שליליים מחזירים שגיאת INVALID_ARGUMENT.
page_token

string

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

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

string

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

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

לדוגמה, space = spaces/{space}.

שאילתות לא חוקיות נדחות ומוצגת השגיאה INVALID_ARGUMENT.

ListSectionItemsResponse

הודעת תשובה להצגת פריטים בקטע.

שדות
section_items[]

SectionItem

הפריטים מהקטע שצוין.
next_page_token

string

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

ListSectionsRequest

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

שדות
parent

string

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

  • הכינוי me. לדוגמה, users/me.

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

  • מזהה המשתמש שלהם. לדוגמה, users/123456789.

פורמט: users/{user}
page_size

int32

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

אם לא מציינים ערך, יוחזרו עד 10 קטעים.

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

ערכים שליליים מחזירים שגיאת INVALID_ARGUMENT.
page_token

string

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

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

ListSectionsResponse

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

שדות
sections[]

Section

הקטעים של המשתמש שצוין.
next_page_token

string

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

ListSpaceEventsRequest

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

שדות
parent

string

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

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

int32

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

ערכים שליליים מחזירים שגיאת INVALID_ARGUMENT.
page_token

string

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

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

string

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

צריך לציין לפחות סוג אירוע אחד (event_type) באמצעות האופרטור has :. כדי לסנן לפי כמה סוגי אירועים, משתמשים באופרטור OR. אל תכללו במסנן סוגי אירועים של אצווה. הבקשה מחזירה באופן אוטומטי את כל אירועי ה-Batch הקשורים. לדוגמה, אם מסננים לפי תגובות חדשות (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 לא מוחזר באובייקט Space לבקשות רשימה.
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 לא מוחזר באובייקט Space בבקשות להצגת רשימה.
next_page_token

string

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

MarkAsActiveRequest

הודעת בקשה ל-method‏ MarkAsActive.

שדות
name

string

חובה. שם המשאב של הזמינות שרוצים לסמן כפעילה. פורמט: users/{user}/availability

‫{user} הוא המזהה של האדם ב-People API או ב-Admin SDK Directory API. לדוגמה, users/123456789.

אפשר גם להשתמש בכתובת האימייל של המשתמש או ב-me ככינוי כדי להתייחס למבצע הקריאה החוזרת. לדוגמה, users/user@example.com או users/me.
שדה של איחוד expiration. תאריך התפוגה של סטטוס הזמינות ACTIVE. אחרי שהתוקף יפוג, הסטטוס שלכם ישתנה ל"לא פנוי/ה". אם לא מציינים תאריך תפוגה, המצב ACTIVE יפוג תוך 30 דקות מהשעה הנוכחית. הערך expiration יכול להיות רק אחד מהבאים:
expire_time

Timestamp

חותמת הזמן המוחלטת שבה פג התוקף של המצב ACTIVE.
ttl

Duration

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

MarkAsAwayRequest

הודעת בקשה ל-method‏ MarkAsAway.

שדות
name

string

חובה. שם המשאב של הזמינות שרוצים לסמן כ"לא זמין". פורמט: users/{user}/availability

‫{user} הוא המזהה של האדם ב-People API או ב-Admin SDK Directory API. לדוגמה, users/123456789.

אפשר גם להשתמש בכתובת האימייל של המשתמש או ב-me ככינוי כדי להתייחס למבצע הקריאה החוזרת. לדוגמה, users/user@example.com או users/me.

MarkAsDoNotDisturbRequest

הודעת בקשה ל-method‏ MarkAsDoNotDisturb.

שדות
name

string

חובה. שם המשאב של הזמינות שרוצים לסמן כ"נא לא להפריע". פורמט: users/{user}/availability

‫{user} הוא המזהה של האדם ב-People API או ב-Admin SDK Directory API. לדוגמה, users/123456789.

אפשר גם להשתמש בכתובת האימייל של המשתמש או ב-me ככינוי כדי להתייחס למבצע הקריאה החוזרת. לדוגמה, users/user@example.com או users/me.
שדה של איחוד expiration. חובה. תאריך התפוגה של סטטוס הזמינות "נא לא להפריע". אחרי שהתוקף יפוג, הסטטוס שלכם ישתנה ל"לא פנוי/ה". התאריך יכול להיות עד שנה מהזמן הנוכחי. הערך expiration יכול להיות רק אחד מהבאים:
expire_time

Timestamp

חותמת הזמן המוחלטת שבה פג התוקף של מצב "נא לא להפריע".
ttl

Duration

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

MarkupSyntax

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

טיפוסים בני מנייה (enum)
MARKUP_SYNTAX_UNSPECIFIED מייצג את הערך שלא צוין.
MARKUP_SYNTAX_CHAT משתמש בתחביר של תגי עיצוב ב-Google Chat. מידע נוסף זמין בכתובת https://developers.google.com/workspace/chat/format-messages#format-texts.
MARKUP_SYNTAX_MARKDOWN משתמש בתחביר Markdown. התחביר הזה מבוסס על המפרט של CommonMark, עם תוספות. מידע נוסף זמין בכתובת https://developers.google.com/workspace/chat/format-messages#format-texts.

MatchedUrl

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

שדות
url

string

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

MeetSpaceLinkData

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

שדות
meeting_code

string

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

Type

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

HuddleStatus

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

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

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

Affiliation

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

User

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

Group

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

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

נתונים משויכים

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

טיפוסים בני מנייה (enum)
AFFILIATION_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
INTERNAL חשבון שמנוהל על ידי אותו ארגון ב-Google Workspace שהמרחב שייך לו.
EXTERNAL חשבון שלא שייך לארגון ב-Google Workspace שהמרחב שייך לו (למשל, חשבון פרטי או חשבון שמנוהל על ידי ארגון אחר ב-Workspace).
MANAGED_EXTERNAL חשבון שמנוהל על ידי הארגון ב-Workspace שבבעלותו המרחב, אבל מוקצה למשתמש מחוץ לארגון (למשל, משתמש אורח). מידע נוסף על משתתפים חיצוניים זמין בכתובת https://support.google.com/chat/answer/16997417.

MembershipRole

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

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

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

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

  • להוסיף או להסיר חברים.
  • לשנות את הפרטים של המרחב המשותף.
  • להפעיל או להשבית את ההיסטוריה.
  • לתייג את כל מי שבמרחב המשותף באמצעות @all.
  • לנהל את האפליקציות ל-Chat ואת ה-webhooks שהותקנו במרחב.

בצ'אטים אישיים ובשיחות קבוצתיות ללא שם, לכולם יש את התפקיד הזה.
ROLE_MANAGER

הבעלים של המרחב. בממשק המשתמש של Chat, התפקיד הזה נקרא "בעלים".

למשתמש יש את כל ההרשאות לניהול המרחב, כולל:

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

הפעולה נתמכת רק ב-SpaceType.SPACE (מרחבים משותפים עם שם).

מידע נוסף על התפקידים "בעלים" ו"מנהל/ת של המרחב"
ROLE_ASSISTANT_MANAGER

מנהל/ת המרחב. בממשק המשתמש של Chat, התפקיד הזה נקרא "מנהל/ת".

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

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

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

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

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

  • פריטים ברשימת תבליטים באמצעות כוכביות (*) – לדוגמה, * item.

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

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

SlashCommand

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

Attachment

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

MatchedUrl

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

bool

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

אם במרחב המשותף אי אפשר לשלוח תשובות בשרשור, הערך בשדה הזה הוא תמיד false.
silent

bool

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

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

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

Elements

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

markup_syntax

MarkupSyntax

אופציונלי. מציין איך השרת מפרש את תוכן השדה text של ההודעה.

MessageBatchCreatedEventData

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

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

שדות
messages[]

MessageCreatedEventData

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

MessageBatchDeletedEventData

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

סוג האירוע: 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 ו-deletionMetadata מאוכלסים.

MessagePin

סיכה על הודעת צ'אט. מידע נוסף מופיע במאמר הצמדת הודעה.

שדות
name

string

מזהה. שם המשאב של ההודעה המוצמדת. פורמט: spaces/{space}/messagePins/{message_pin} רכיב מזהה המשאב תואם לרכיב מזהה המשאב של ההודעה. לדוגמה, הודעה עם spaces/AAA/messages/bbb.ccc תואמת להודעה המוצמדת עם שם המשאב spaces/AAA/messagePins/bbb.ccc.
message

string

חובה. לא ניתן לשינוי. שם המשאב של ההודעה המוצמדת. פורמט: spaces/{space}/messages/{message}

MessageUpdatedEventData

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

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

שדות
message

Message

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

MoveSectionItemRequest

הודעת בקשה להעברת פריט בין קטעים.

שדות
name

string

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

פורמט: users/{user}/sections/{section}/items/{item}
target_section

string

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

פורמט: users/{user}/sections/{section}

MoveSectionItemResponse

הודעת תגובה להעברת פריט בחלק.

שדות
section_item

SectionItem

הפריט המעודכן בקטע.

PositionSectionRequest

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

שדות
name

string

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

פורמט: users/{user}/sections/{section}
שדה של איחוד position. חובה. המיקום החדש של החלק. הערך position יכול להיות רק אחד מהבאים:
sort_order

int32

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

Position

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

מיקום

המיקום של הקטע.

טיפוסים בני מנייה (enum)
POSITION_UNSPECIFIED לא צוין מיקום.
START תחילת הרשימה של הקטעים.
END סוף רשימת הקטעים.

PositionSectionResponse

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

שדות
section

Section

הקטע המעודכן.

QuotedMessageMetadata

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

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

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

שדות
name

string

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

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

Timestamp

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

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

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

QuoteType

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

QuotedMessageSnapshot

פלט בלבד. תמונת מצב של תוכן ההודעה המצוטטת.
forwarded_metadata

ForwardedMetadata

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

QuoteType

סוג הציטוט של ההודעה המצוטטת.

טיפוסים בני מנייה (enum)
QUOTE_TYPE_UNSPECIFIED שמורות. הערך הזה לא בשימוש.
REPLY

כשההגדרה quote_type היא REPLY, אפשר לבצע את הפעולות הבאות:

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

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

כשהערך של quote_type הוא FORWARD, אפשר לצטט:

  • הודעה ממרחב אחר.

  • תשובה להודעה משרשור אחר באותו מרחב משותף.

QuotedMessageSnapshot

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

שדות
sender

string

פלט בלבד. שם המחבר של ההודעה המצוטטת. מאוכלס גם בסוגי הציטוטים REPLY וגם ב-FORWARD.
text

string

פלט בלבד. תמונת מצב של תוכן הטקסט של ההודעה המצוטטת.
formatted_text

string

פלט בלבד. מכיל את ההודעה המצוטטת text עם תגי עיצוב שנוספו כדי לתמוך בעיצוב עשיר כמו היפר-קישורים, אמוג'י בהתאמה אישית, תגי עיצוב וכו'. מאוכלס רק עבור סוג הציטוט FORWARD.
annotations[]

Annotation

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

Attachment

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

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

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

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

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

ReplaceMessageCardsRequest

הודעת בקשה ל-method‏ ReplaceMessageCards ב-API.

שדות
name

string

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

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

CardWithId

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

ReplaceMessageCardsResponse

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

הודעת תגובה ל-API של ReplaceMessageCards.

RichLinkMetadata

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

שדות
uri

string

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

RichLinkType

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

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

SearchMessageResult

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

שדות
message

Message

ההודעה שהתאימה.
space_mute_setting

MuteSetting

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

מוחזר רק אם תצוגת הבקשה היא SEARCH_MESSAGES_VIEW_FULL ופרטי הכניסה של הקריאה כוללים את היקף ההרשאה הבא:

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

bool

מציין אם המשתמש שמתקשר קרא את ההודעה התואמת.

מוחזר רק אם תצוגת הבקשה היא SEARCH_MESSAGES_VIEW_FULL ופרטי הכניסה של הקריאה כוללים את אחד מהיקפי ההרשאות הבאים:

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

SearchMessagesRequest

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

שדות
parent

string

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

כדי לחפש בכל המרחבים המשותפים שלמשתמש יש גישה אליהם, מגדירים את השדה הזה לערך spaces/-. שימוש בכל ערך אחר בשדה parent יגרום לשגיאה INVALID_ARGUMENT.

כדי להגביל את החיפוש למרחב אחד או יותר, משתמשים ב-space.name או ב-space.display_name ב-filter.
filter

string

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

השאילתה יכולה לציין מילת מפתח אחת או יותר לחיפוש, שמשמשות לסינון התוצאות,

אפשר גם לסנן את התוצאות לפי שדות ההודעה הבאים:

  • ‫create_time: מקבל חותמת זמן בפורמט RFC-3339, ואופרטורי ההשוואה הנתמכים הם: < ו->=.
  • ‫sender.name: שם המשאב של השולח (users/{user}). תומך רק ב-=. אפשר להשתמש בכתובת האימייל ככתובת אימייל חלופית של {user}. לדוגמה, users/example@gmail.com, כאשר example@gmail.com היא כתובת האימייל של המשתמש ב-Google Chat.
  • ‫space.name: שם המשאב של המרחב המשותף שבו פורסמה ההודעה. (spaces/{space}). תמיכה רק ב-=. אם לא מגדירים את המסנן הזה, החיפוש מתבצע בכל הצ'אטים האישיים והמרחבים המשותפים שלמשתמש יש גישה אליהם כחבר במרחב.
  • ‫space.display_name: תומך באופרטור : (מכיל) ומסנן מרחבים משותפים על סמך התאמה חלקית של השם המוצג שלהם. התוצאות מוגבלות לחמשת המרחבים המשותפים הכי מתאימים. לדוגמה, space.display_name:Project מחפש הודעות בחמשת המרחבים המשותפים הראשונים שהשם שלהם מכיל את המילה "פרויקט".
  • ‫space.space_type: סוג המרחב המשותף. יש תמיכה רק ב-=. לדוגמה, space.space_type="DIRECT_MESSAGE" מחזיר רק הודעות מצ'אטים ישירים. הערכים האפשריים הם DIRECT_MESSAGE,‏ GROUP_CHAT ו-SPACE.
  • ‫attachment: תומך באופרטור :* (יש כלשהו) כדי לבדוק אם יש קבצים מצורפים. אם מציינים את attachment:*, מוחזרות רק הודעות שיש בהן לפחות קובץ מצורף אחד.
  • ‫annotations.user_mentions.user.name: שם המשאב של המשתמש שתוייג (users/{user}). תומך רק ב-: (יש). לדוגמה: annotations.user_mentions.user.name:"users/1234567890" מחזיר רק הודעות שמכילות תיוג של המשתמש שצוין. לחלופין, אפשר להשתמש בכינוי me כדי לסנן הודעות שמאזכרות את המשתמש המתקשר, לדוגמה: annotations.user_mentions.user.name:users/me. אפשר גם להשתמש בכתובת האימייל ככתובת חלופית של {user}, לדוגמה, users/example@gmail.com.

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

  • has_link(): החזרת הודעות שיש בהן לפחות היפר-קישור אחד בטקסט של ההודעה.
  • is_unread(): סינון הודעות שהמשתמש ששלח את הקריאה כבר קרא.

כדי להשתמש במסננים space.display_name או space.space_type, פרטי הכניסה של הקריאה צריכים לכלול את אחד מהיקפי ההרשאות הבאים:

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

כדי להשתמש במסנן is_unread(), פרטי הכניסה של הקריאה צריכים לכלול את אחד מהיקפי ההרשאות הבאים:

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

בשדות שונים, יש תמיכה רק באופרטורים מסוג AND. דוגמה לערך תקין: sender.name = "users/1234567890" AND is_unread(). המילה AND היא אופציונלית, ואם משמיטים אותה, היא משתמעת. לדוגמה, sender.name = "users/1234567890" is_unread() הוא תקין ושווה ערך לדוגמה הקודמת. דוגמה לא חוקית היא sender.name = "users/1234567890" OR is_unread() כי אין תמיכה ב-OR בין שדות שונים.

באותו תחום:

  • ‫create_time תומך רק ב-AND, ואפשר להשתמש בו רק כדי לייצג מרווח זמן, כמו create_time >= "2022-01-01T00:00:00+00:00" AND create_time < "2023-01-01T00:00:00+00:00".
  • השדה sender.name תומך רק באופרטור OR, לדוגמה: sender.name = "users/1234567890" OR sender.name = "users/0987654321".
  • השדה space.name תומך רק באופרטור OR, לדוגמה: space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI".
  • המשתנה space.display_name תומך באופרטורים AND ו-OR, אבל לא בשילוב של שניהם. לדוגמה: space.display_name:Project AND space.display_name:Tasks מחזיר הודעות במרחבים משותפים עם השמות המוצגים שמכילים גם את Project וגם את Tasks, ואילו space.display_name:Project OR space.display_name:Tasks מחזיר הודעות במרחבים משותפים עם השמות המוצגים שמכילים את Project או את Tasks או את שניהם.
  • השדה space.space_type תומך רק באופרטור OR, לדוגמה: space.space_type = "DIRECT_MESSAGE" OR space.space_type = "GROUP_CHAT".
  • המשתנה annotations.user_mentions.user.name תומך באופרטורים AND ו-OR, אבל לא בשילוב של שניהם. לדוגמה: annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321" מחזיר רק הודעות שמוזכרים בהן שני המשתמשים, ואילו annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321" מחזיר הודעות שמוזכר בהן אחד מהמשתמשים או שניהם.

צריך להשתמש בסוגריים כדי להבהיר את סדר הקדימויות של האופרטורים כשמשלבים את האופרטורים AND ו-OR באותה שאילתה. לדוגמה: (sender.name="users/me" OR sender.name="users/123456") AND is_unread(). אחרת, הסוגריים הם אופציונליים.

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

"Pending reports" AND create_time >= "2023-01-01T00:00:00Z"

sender.name = "users/example@gmail.com"

annotations.user_mentions.user.name:"users/0987654321"

attachment:* AND space.name = "spaces/ABCDEFGH"

tasks AND is_unread() AND sender.name = "users/1234567890"

"things to do" "urgent"

(sender.name = "users/1234567890")
AND (create_time < "2023-05-01T00:00:00Z")

tasks AND space.name = "spaces/ABCDEFGH" AND has_link()

"project one" is_unread()

space.display_name:Project tasks

האורך המקסימלי של שאילתה הוא 1,000 תווים.

השרת דוחה שאילתות לא תקינות ומחזיר את השגיאה INVALID_ARGUMENT.
page_size

int32

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

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

הערך המקסימלי הוא 100. אם תזינו ערך גבוה מ-100, הוא ישתנה אוטומטית ל-100.
page_token

string

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

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

string

אופציונלי. איך רשימת התוצאות מסודרת.

המאפיינים הנתמכים לסידור לפי הם:

סדר ברירת המחדל הוא create_time desc. יש תמיכה רק בסדר אחד לכל שאילתה (create_time או relevance). אפשר להשתמש רק בסדר יורד (desc), וצריך לציין אותו אחרי מאפיין הסדר.
markup_syntax

MarkupSyntax

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

SearchMessagesView

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

SearchMessagesView

סוגי התצוגה שנתמכים בתוצאות חיפוש חלקיות.

טיפוסים בני מנייה (enum)
SEARCH_MESSAGES_VIEW_UNSPECIFIED ערך ברירת המחדל / ערך שלא הוגדר. כברירת מחדל, ה-API יציג את התצוגה BASIC.
SEARCH_MESSAGES_VIEW_BASIC התוצאות כוללות רק את ההודעות התואמות, בלי מטא-נתונים נוספים. זהו ערך ברירת המחדל.
SEARCH_MESSAGES_VIEW_FULL כולל את כל מה שמופיע בתוצאות: ההודעות התואמות ומטא-נתונים נוספים.

SearchMessagesResponse

הודעת תשובה לחיפוש הודעות.

שדות
results[]

SearchMessageResult

רשימת תוצאות החיפוש שתאמו לשאילתה.
next_page_token

string

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

SearchSpacesRequest

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

שדות
use_admin_access

bool

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

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

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

int32

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

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

הערך המקסימלי הוא 1,000 כשהפרמטר useAdminAccess מוגדר כ-true. אחרת, הערך המקסימלי הוא 100. אם תזינו ערך גבוה יותר מהערך המקסימלי, הוא ישתנה אוטומטית לערך המקסימלי.
page_token

string

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

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

string

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

אפשר לחפש לפי הפרמטרים הבאים כשמגדירים את useAdminAccess כ-true:

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

כשהערך של useAdminAccess הוא false:

  • display_name
  • external_user_allowed
  • space_type

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

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

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

‫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".

השאילתות לדוגמה הבאות תקינות כש-useAdminAccess מוגדר ל-true:

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")

השאילתות לדוגמה הבאות תקינות כש-useAdminAccess מוגדר ל-false:

display_name:"Hello World" AND space_type = "SPACE"

(display_name:"Hello" OR display_name:"Fun") AND space_type = "SPACE"

(external_user_allowed = "true" AND space_type = "SPACE") // Returns an
empty response.

(external_user_allowed = "true" AND display_name:"Hello" AND space_type =
"SPACE")

האורך המקסימלי של שאילתה הוא 1,000 תווים.

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

string

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

המאפיינים הנתמכים לסידור לפי הם:

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

כשהערך של useAdminAccess הוא false, אפשר להזמין רק את create_time ו-relevance. בחיפושים של משתמשים שאינם אדמינים, השדות האלה תומכים רק ב-DESC.

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

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

  • ‫DESC לסדר יורד.

התחביר הנתמך כש-useAdminAccess מוגדר ל-true:

  • 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

כשהערך של useAdminAccess הוא false:

SearchSpacesResponse

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

שדות
spaces[]
(deprecated)

Space

הוצא משימוש: צריך להשתמש בשדה החדש results במקום זאת. דף של המרחבים המשותפים המבוקשים. השדה הזה יאוכלס רק כש-useAdminAccess מוגדר כ-true, והוא הוצא משימוש לטובת השדה החדש results.
next_page_token

string

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

השדה הזה מאוכלס רק אם הערך של useAdminAccess הוא true.
total_size

int32

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

השדה הזה מאוכלס רק אם הערך של useAdminAccess הוא true.
results[]

SearchSpaceResult

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

SearchSpaceResult

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

שדות
space

Space

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

קטע

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

  1. חלקים של המערכת: אלה חלקים מוגדרים מראש שמנוהלים על ידי Google Chat. שמות המשאבים שלהם קבועים, ואי אפשר ליצור, למחוק או לשנות את ה-display_name שלהם. דוגמאות:

    • users/{user}/sections/default-direct-messages
    • users/{user}/sections/default-spaces
    • users/{user}/sections/default-apps

  2. מדורים בהתאמה אישית: אלה מדורים שהמשתמש יוצר ומנהל. כדי ליצור מדור מותאם אישית באמצעות CreateSection, צריך display_name. אפשר לעדכן מדורים מותאמים אישית באמצעות UpdateSection ולמחוק אותם באמצעות DeleteSection.

שדות
name

string

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

בקטעי מערכת, מזהה הקטע הוא מחרוזת קבועה:

  • DEFAULT_DIRECT_MESSAGES: users/{user}/sections/default-direct-messages
  • DEFAULT_SPACES: users/{user}/sections/default-spaces
  • DEFAULT_APPS: users/{user}/sections/default-apps

פורמט: users/{user}/sections/{section}
display_name

string

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

int32

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

SectionType

חובה. סוג הקטע.

SectionType

סוגי קטעים.

טיפוסים בני מנייה (enum)
SECTION_TYPE_UNSPECIFIED סוג הקטע לא צוין.
CUSTOM_SECTION מדור מותאם אישית.
DEFAULT_DIRECT_MESSAGES מדור ברירת המחדל שמכיל DIRECT_MESSAGE בין שני משתמשים אנושיים או מרחבים של GROUP_CHAT שלא שייכים לאף מדור מותאם אישית.
DEFAULT_SPACES מרחבים משותפים שמוגדרים כברירת מחדל ולא שייכים לאף חלק בהתאמה אישית.
DEFAULT_APPS קטע ברירת המחדל שמכיל את האפליקציות שהמשתמש התקין.

SectionItem

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

שדות
name

string

מזהה. שם המשאב של הפריט בחלק.

פורמט: users/{user}/sections/{section}/items/{item}
שדה של איחוד item. חובה. הפריט בקטע. הערך item יכול להיות רק אחד מהבאים:
space

string

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

פורמט: spaces/{space}

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

כדי להשתמש בשדה הזה בצורה יעילה:

  • חשוב לוודא שהבקשות הבאות זהות ומשתמשות באותם פרטי כניסה לאימות כמו הבקשה המקורית.
  • אם כבר נוצר מרחב עם מזהה הבקשה שצוין, הבקשה מחזירה את המרחב הזה. שימו לב שהמרחב המשותף שמוחזר לא בהכרח מאוכלס במלואו. ה-API מחזיר את המרחב המשותף שבבקשה שלכם, עם שם המשאב שהוקצה על ידי המערכת. כדי לאחזר את המטא-נתונים העדכניים של המרחב, צריך להפעיל את GetSpace.
  • שימוש חוזר במזהה בקשה קיים עם משתמש מאומת אחר גורם לשגיאה.
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} מייצג את המזהה שהמערכת הקצתה למרחב המשותף. כדי לקבל את מזהה המרחב המשותף, אפשר להפעיל את ה-method‏ spaces.list() או להשתמש בכתובת ה-URL של המרחב המשותף. לדוגמה, אם כתובת ה-URL של המרחב היא https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, מזהה המרחב הוא AAAAAAAAA.
type
(deprecated)

Type

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

SpaceType

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

bool

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

bool

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

string

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

בצ'אטים אישיים, יכול להיות שהשדה הזה יהיה ריק.

תומך בעד 128 תווים.
external_user_allowed

bool

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

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

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

SpaceThreadingState

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

SpaceDetails

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

HistoryState

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

bool

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

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

Timestamp

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

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

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

Timestamp

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

bool

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

השדה הזה לא מאוכלס בצ'אטים ישירים או כשמשתמשים שאין להם חשבון Google Workspace יוצרים את המרחב המשותף.
שדה של איחוד space_permission_settings. מייצג את הגדרות ההרשאות של מרחב. השדה הזה מאוכלס רק כשהערך של space_type הוא SPACE. הערך space_permission_settings יכול להיות רק אחד מהבאים:
predefined_permission_settings

PredefinedPermissionSettings

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

הגדרת הרשאות מוגדרות מראש תומכת באפשרויות הבאות:
permission_settings

PermissionSettings

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

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

AccessPermissionSetting

הגדרה של הרשאת גישה.

שדות
principals[]

Principal

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

AccessPermissionSettings

איך פותחים את הגדרות ההרשאות במרחב.

שדות
discover_space_setting

AccessPermissionSetting

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

AccessPermissionSetting

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

AccessPermissionSetting

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

AccessSettings

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

שדות
access_state

AccessState

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

string

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

פורמט: audiences/{audience}

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

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

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

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

AccessPermissionSettings

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

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

AccessState

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

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

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

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

MembershipCount

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

שדות
joined_direct_human_user_count

int32

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

int32

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

PermissionSetting

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

שדות
managers_allowed

bool

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

bool

אופציונלי. אם למשתמשים רגילים במרחב (ROLE_MEMBER) יש את ההרשאה הזו.
assistant_managers_allowed

bool

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

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

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

PermissionSetting

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

PredefinedPermissionSettings

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

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

חשבון משתמש

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

שדות
שדה של איחוד principal_type. סוג חשבון המשתמש. הערך principal_type יכול להיות רק אחד מהבאים:
audience

Audience

קהל.

SpaceDetails

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

שדות
description

string

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

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

string

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

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

SpaceThreadingState

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

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

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

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

SpaceType

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

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

סוג

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

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

SpaceBatchUpdatedEventData

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

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

שדות
spaces[]

SpaceUpdatedEventData

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

SpaceEvent

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

שדות
name

string

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

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

Timestamp

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

string

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

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

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

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

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

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

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

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

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

שדה של איחוד payload.

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

MessageCreatedEventData

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

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

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

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

SpaceUpdatedEventData

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

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

SpaceBatchUpdatedEventData

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

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

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

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

שדות
space

Space

המרחב המשותף המעודכן.

SpaceView

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

טיפוסים בני מנייה (enum)
SPACE_VIEW_UNSPECIFIED ערך ברירת המחדל / ערך שלא הוגדר.
SPACE_VIEW_RESOURCE_NAME_ONLY מאכלס רק את שם המשאב של המרחב המשותף.
SPACE_VIEW_EXPANDED מאכלס את השדות של המשאב Space. הערה: השדה permissionSettings לא יאוכלס. בקשות שמציינות את SPACE_VIEW_EXPANDED חייבות לכלול היקפי הרשאות שמאפשרים לקרוא נתונים של מרחבים משותפים, למשל https://www.googleapis.com/auth/chat.spaces או https://www.googleapis.com/auth/chat.spaces.readonly.

חוט תפירה

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

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

UpdateAvailabilityRequest

הודעת בקשה ל-method‏ UpdateAvailability.

שדות
availability

Availability

חובה. הזמינות לעדכון.
update_mask

FieldMask

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

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

UpdateSectionRequest

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

שדות
section

Section

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

FieldMask

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

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

  • display_name

UpdateSpaceNotificationSettingRequest

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

שדות
space_notification_setting

SpaceNotificationSetting

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

FieldMask

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

  • notification_setting

  • mute_setting

UpdateSpaceReadStateRequest

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

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

‫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.

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

  • access_settings.access_permission_settings.discoverSpaceSetting
  • access_settings.access_permission_settings.joinSpaceSetting
  • access_settings.access_permission_settings.viewSpaceMembershipSetting

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

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

bool

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

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

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

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

משתמש

משתמש ב-Google Chat.

כשמוחזר פלט מבקשה, אם האפליקציה ל-Chat מאומתת כמשתמש, הפלט של משאב User (כמו בממשקי ה-API של ההודעות והמינויים) מאכלס רק את השדות 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. לדוגמה, אם מזהה הפרופיל האישי של user@example.com ב-People API הוא 123456789, אפשר להשתמש ב-users/user@example.com ככינוי כדי להפנות אל users/123456789. רק שם המשאב הקנוני (לדוגמה users/123456789) יוחזר מה-API.
display_name

string

פלט בלבד. השם המוצג של המשתמש.

מאוכלס גם לאימות אפליקציה וגם לאימות משתמש. השדה הזה תמיד מאוכלס בבקשות שבוצעו באמצעות אימות אפליקציה. כשקוראים לממשקי ה-API של ההודעות והמינויים באמצעות אימות משתמש, השדה הזה מאוכלס גם למשתמשים פנימיים וגם למשתמשים חיצוניים ב-sender של הודעה, למשתמשים בתוך annotations (כמו תיוגי משתמשים) ובתוך משאבי Membership, בתנאי שהמשתמש הוא חבר במרחב המשותף או שיש לו זיקה קודמת למשתמש שקורא לממשק ה-API.
avatar_url

string

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

כשמפעילים את ממשקי ה-API של ההודעות והמינויים באמצעות אימות משתמש, השדה הזה מאוכלס גם למשתמשים פנימיים וגם למשתמשים חיצוניים בשביל sender של הודעה, משתמשים בתוך annotations (כמו תיוגי משתמשים) ובתוך משאבי Membership, בתנאי שהמשתמש הוא חבר במרחב המשותף או שיש לו זיקה קודמת למשתמש שמפעיל את ה-API.
email

string

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

כשמפעילים את ממשקי ה-API של ההודעות והמינויים באמצעות אימות משתמש, השדה הזה מאוכלס גם למשתמשים פנימיים וגם למשתמשים חיצוניים בשביל sender של הודעה, משתמשים בתוך annotations (כמו תיוגי משתמשים) ובתוך משאבי Membership, בתנאי שהמשתמש הוא חבר במרחב המשותף או שיש לו זיקה קודמת למשתמש שמפעיל את ה-API.
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

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