Package google.chat.v1

אינדקס

ChatService

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

CompleteImportSpace

rpc CompleteImportSpace(CompleteImportSpaceRequest) returns (CompleteImportSpaceResponse)

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

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

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

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

היקפי הרשאה

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

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

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

rpc CreateCustomEmoji(CreateCustomEmojiRequest) returns (CustomEmoji)

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

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

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

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

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

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

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

rpc CreateMembership(CreateMembershipRequest) returns (Membership)

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

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

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

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

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

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

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

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

לדוגמה לשימוש, אפשר לעיין במאמר:

היקפי הרשאה

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

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

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

rpc CreateMessage(CreateMessageRequest) returns (Message)

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

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

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

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

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

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

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

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

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

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

היקפי הרשאה

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

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

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

rpc CreateReaction(CreateReactionRequest) returns (Reaction)

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

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

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

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

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

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

rpc CreateSpace(CreateSpaceRequest) returns (Space)

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

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

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

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

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

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

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

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

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

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

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

היקפי הרשאה

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

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

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

rpc DeleteCustomEmoji(DeleteCustomEmojiRequest) returns (Empty)

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

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

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

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

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

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

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

rpc DeleteMembership(DeleteMembershipRequest) returns (Membership)

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

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

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

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

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

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

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

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

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

היקפי הרשאה

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

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

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

rpc DeleteMessage(DeleteMessageRequest) returns (Empty)

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

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

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

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

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

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

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

היקפי הרשאה

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

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

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

rpc DeleteReaction(DeleteReactionRequest) returns (Empty)

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

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

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

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

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

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

rpc DeleteSpace(DeleteSpaceRequest) returns (Empty)

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

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

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

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

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

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

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

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

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

rpc FindDirectMessage(FindDirectMessageRequest) returns (Space)

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

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

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

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

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

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

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

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

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

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

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

rpc GetAttachment(GetAttachmentRequest) returns (Attachment)

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

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

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

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

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

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

rpc GetCustomEmoji(GetCustomEmojiRequest) returns (CustomEmoji)

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

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

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

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

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

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

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

rpc GetMembership(GetMembershipRequest) returns (Membership)

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

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

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

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

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

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

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

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

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

rpc GetMessage(GetMessageRequest) returns (Message)

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

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

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

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

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

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

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

היקפי הרשאה

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

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

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

rpc GetSpace(GetSpaceRequest) returns (Space)

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

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

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

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

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

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

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

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

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

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

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

rpc GetSpaceEvent(GetSpaceEventRequest) returns (SpaceEvent)

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

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

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

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

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

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

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

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

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

היקפי הרשאה

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

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

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

rpc GetSpaceNotificationSetting(GetSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

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

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

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

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

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

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

rpc GetSpaceReadState(GetSpaceReadStateRequest) returns (SpaceReadState)

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

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

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

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

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

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

rpc GetThreadReadState(GetThreadReadStateRequest) returns (ThreadReadState)

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

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

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

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

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

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

rpc ListCustomEmojis(ListCustomEmojisRequest) returns (ListCustomEmojisResponse)

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

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

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

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

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

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

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

rpc ListMemberships(ListMembershipsRequest) returns (ListMembershipsResponse)

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

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

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

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

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

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

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

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

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

rpc ListMessages(ListMessagesRequest) returns (ListMessagesResponse)

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

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

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

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

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

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

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

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

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

rpc ListReactions(ListReactionsRequest) returns (ListReactionsResponse)

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

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

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

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

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

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

rpc ListSpaceEvents(ListSpaceEventsRequest) returns (ListSpaceEventsResponse)

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

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

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

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

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

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

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

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

היקפי הרשאה

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

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

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

rpc ListSpaces(ListSpacesRequest) returns (ListSpacesResponse)

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

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

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

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

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

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

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

היקפי הרשאה

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

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

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

rpc SearchSpaces(SearchSpacesRequest) returns (SearchSpacesResponse)

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

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

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

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

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

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

rpc SetUpSpace(SetUpSpaceRequest) returns (Space)

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

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

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

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

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

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

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

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

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

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

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

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

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

rpc UpdateMembership(UpdateMembershipRequest) returns (Membership)

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

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

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

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

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

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

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

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

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

rpc UpdateMessage(UpdateMessageRequest) returns (Message)

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

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

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

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

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

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

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

היקפי הרשאה

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

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

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

rpc UpdateSpace(UpdateSpaceRequest) returns (Space)

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

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

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

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

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

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

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

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

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

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

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

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

rpc UpdateSpaceNotificationSetting(UpdateSpaceNotificationSettingRequest) returns (SpaceNotificationSetting)

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

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

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

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

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

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

rpc UpdateSpaceReadState(UpdateSpaceReadStateRequest) returns (SpaceReadState)

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

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

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

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

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

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

AccessoryWidget

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

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

ButtonList

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

ActionResponse

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

שדות
type

ResponseType

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

string

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

DialogAction

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

UpdatedWidget

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

ResponseType

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

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

SelectionItems

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

שדות
items[]

SelectionItem

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

UpdatedWidget

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

שדות
widget

string

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

SelectionItems

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

ActionStatus

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

שדות
status_code

Code

קוד הסטטוס.
user_facing_message

string

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

הערה

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

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

Hello @FooBot how are you!"

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

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

AnnotationType

סוג ההערה.
length

int32

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

int32

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

UserMentionMetadata

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

SlashCommandMetadata

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

CustomEmojiMetadata

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

AnnotationType

סוג ההערה.

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

AppCommandMetadata

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

שדות
app_command_id

int32

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

AppCommandType

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

AppCommandType

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

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

AttachedGif

תמונת GIF שצוינה באמצעות כתובת URL.

שדות
uri

string

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

קובץ מצורף

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

שדות
name

string

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

string

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

string

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

string

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

string

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

Source

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

AttachmentDataRef

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

DriveDataRef

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

מקור

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

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

AttachmentDataRef

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

שדות
resource_name

string

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

string

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

CalendarEventLinkData

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

שדות
calendar_id

string

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

string

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

CardWithId

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

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

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

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

שדות
card_id

string

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

Card

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

ChatSpaceLinkData

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

שדות
space

string

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

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

string

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

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

string

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

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

CompleteImportSpaceRequest

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

שדות
name

string

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

פורמט: spaces/{space}

CompleteImportSpaceResponse

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

שדות
space

Space

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

ContextualAddOnMarkup

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

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

קלפים

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

שדות
header

CardHeader

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

Section

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

CardAction

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

string

שם הכרטיס.

CardAction

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

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

שדות
action_label

string

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

OnClick

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

CardHeader

שדות
title

string

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

string

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

ImageStyle

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

string

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

ImageStyle

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

קטע

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

שדות
header

string

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

WidgetMarkup

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

CreateCustomEmojiRequest

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

שדות
custom_emoji

CustomEmoji

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

CreateMembershipRequest

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

שדות
parent

string

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

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

Membership

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

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

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

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

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

  • מגדירים את user.type ל-HUMAN, ואת user.name לפורמט users/{user}, כאשר {user} יכול להיות כתובת האימייל של המשתמש. למשתמשים באותו ארגון ב-Workspace,‏ {user} יכול להיות גם id של האדם מ-People API, או id של המשתמש ב-Directory API. לדוגמה, אם מזהה פרופיל האדם ב-People API עבור