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)

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