במדריך הזה מוסבר איך להשתמש בשיטה create()
במשאב Membership
ב-Google Chat API כדי להזמין או להוסיף משתמשים, קבוצות Google או אפליקציית Chat למרחב משותף מסוים, שנקרא גם יצירת מינוי. כשיוצרים חברות, אם המדיניות של החבר או החברה שציינתם היא 'לא לאשר אוטומטית', הם יקבלו הזמנה והם יצטרכו לאשר את ההזמנה למרחב המשותף כדי להצטרף אליו. אחרת, יצירת מינוי תוסיף את המשתמש ישירות למרחב המשותף שצוין.
אדמינים ב-Google Workspace יכולים להוסיף משתמשים, קבוצות ב-Google או אפליקציות של Chat לכל מרחב משותף בארגון ב-Google Workspace.
המשאבים מסוג Membership
מייצגים אם משתמש אנושי או אפליקציית Google Chat מוזמנים למרחב משותף, אם הם חלק ממנו או אם הם לא נמצאים בו.
דרישות מוקדמות
Node.js
- חשבון Google Workspace בתוכנית Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור של אפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud ל-Node.js.
- יוצרים פרטי כניסה בהתאם לאופן שבו רוצים לבצע אימות בבקשת Google Chat API:
- כדי לבצע אימות כמשתמש ב-Chat, צריך ליצור פרטי כניסה של מזהה לקוח OAuth ולשמור את פרטי הכניסה כקובץ JSON בשם
client_secrets.json
בספרייה המקומית. - כדי לבצע אימות בתור אפליקציית Chat, צריך ליצור פרטי כניסה לחשבון שירות ולשמור את פרטי הכניסה כקובץ JSON בשם
credentials.json
.
- כדי לבצע אימות כמשתמש ב-Chat, צריך ליצור פרטי כניסה של מזהה לקוח OAuth ולשמור את פרטי הכניסה כקובץ JSON בשם
- בוחרים היקף הרשאה בהתאם לכך אם רוצים לבצע אימות כמשתמש או כאפליקציית Chat.
Python
- חשבון Google Workspace בתוכנית Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud ב-Python.
- יוצרים את פרטי הכניסה בהתאם לאופן שבו רוצים לבצע אימות בבקשה ל-Google Chat API:
- כדי לבצע אימות כמשתמש ב-Chat, צריך ליצור פרטי כניסה של מזהה לקוח OAuth ולשמור את פרטי הכניסה כקובץ JSON בשם
client_secrets.json
בספרייה המקומית. - כדי לבצע אימות בתור אפליקציית Chat, צריך ליצור פרטי כניסה לחשבון שירות ולשמור את פרטי הכניסה כקובץ JSON בשם
credentials.json
.
- כדי לבצע אימות כמשתמש ב-Chat, צריך ליצור פרטי כניסה של מזהה לקוח OAuth ולשמור את פרטי הכניסה כקובץ JSON בשם
- בוחרים היקף הרשאה בהתאם לכך אם רוצים לבצע אימות כמשתמש או כאפליקציית Chat.
Java
- חשבון Google Workspace בתוכנית Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud עבור Java.
- יוצרים את פרטי הכניסה בהתאם לאופן שבו רוצים לבצע אימות בבקשה ל-Google Chat API:
- כדי לבצע אימות כמשתמש ב-Chat, צריך ליצור פרטי כניסה של מזהה לקוח OAuth ולשמור את פרטי הכניסה כקובץ JSON בשם
client_secrets.json
בספרייה המקומית. - כדי לבצע אימות בתור אפליקציית Chat, צריך ליצור פרטי כניסה לחשבון שירות ולשמור את פרטי הכניסה כקובץ JSON בשם
credentials.json
.
- כדי לבצע אימות כמשתמש ב-Chat, צריך ליצור פרטי כניסה של מזהה לקוח OAuth ולשמור את פרטי הכניסה כקובץ JSON בשם
- בוחרים היקף הרשאה בהתאם לכך אם רוצים לבצע אימות כמשתמש או כאפליקציית Chat.
Apps Script
- חשבון Google Workspace מסוג Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- יוצרים פרויקט נפרד של Apps Script ומפעילים את שירות הצ'אט המתקדם.
- במדריך הזה, צריך להשתמש באימות משתמשים או אימות אפליקציות. כדי לבצע אימות כאפליקציית Chat, צריך ליצור פרטי כניסה לחשבון שירות. במאמר אימות והרשאה כאפליקציה של Google Chat מוסבר איך לעשות זאת.
- בוחרים היקף הרשאה בהתאם לכך אם רוצים לבצע אימות כמשתמש או כאפליקציית Chat.
הזמנת משתמש למרחב משותף כמשתמש
כדי להזמין או להוסיף משתמש למרחב משותף עם אימות משתמש, צריך להעביר את הפרטים הבאים בבקשה:
- מציינים את היקף ההרשאה
chat.memberships
. - קוראים ל-method
CreateMembership()
. - מעבירים את
parent
בתור שם המשאב של המרחב המשותף שבו רוצים ליצור חברות. - מעבירים את
membership
כמופע שלMembership
כשהשדהmember
מוגדר כך:- השדה
type
מוגדר ל-HUMAN
. - השדה
name
מוגדר כ-users/{user}
, כאשר{user}
הוא המשתמש שרוצים להוסיף למרחב המשותף. כדי לציין את המשתמש ב-Chat, מחליפים את{user}
באחת מהאפשרויות הבאות:- המזהה של האדם ב-People API. לדוגמה, אם הערך של person ב-People API הוא
people/123456789
, צריך להשתמש בערךusers/123456789
.resourceName
- המזהה של המשתמש ב-Directory API.
- כתובת האימייל של המשתמש. לדוגמה,
users/222larabrown@gmail.com
אוusers/larabrown@cymbalgroup.com
. אם המשתמש משתמש בחשבון Google או שייך לארגון אחר ב-Google Workspace, צריך להשתמש בכתובת האימייל שלו.
- המזהה של האדם ב-People API. לדוגמה, אם הערך של person ב-People API הוא
- השדה
בדוגמה הבאה מתווסף משתמש למרחב משותף עם אימות משתמשים:
Node.js
Python
Java
Apps Script
כדי להריץ את הדוגמה, מחליפים את הפרטים הבאים:
SPACE_NAME
: המזהה שמופיע ב-name
של המרחב המשותף. אפשר לקבל את המזהה על ידי קריאה ל-methodListSpaces()
או מכתובת ה-URL של המרחב המשותף.USER_NAME
: מזהה משתמש.
Chat API מחזיר מופע של Membership
שמפרט את החברות של המשתמש שנוצרה.
איך מזמינים קבוצות מ'קבוצות Google' למרחבים משותפים
כדי להזמין או להוסיף קבוצה מ'קבוצות Google' למרחב משותף עם אימות משתמשים (לא ניתן להזמין או להוסיף קבוצות מ'קבוצות Google' למרחבים משותפים' באמצעות אימות אפליקציות), עליכם לבצע את הפרטים הבאים בבקשה:
- מציינים את היקף ההרשאה
chat.memberships
. - קוראים ל-method
CreateMembership()
. - מעבירים את
parent
בתור שם המשאב של המרחב המשותף שבו רוצים ליצור את החברות. - מעבירים את
membership
כמכונה שלMembership
, כאשר השדהname
שלgroupMember
מוגדר כ-groups/{group}
, כאשר{group}
הוא מזהה הקבוצה שבה רוצים ליצור חברות. אפשר לאחזר את מזהה הקבוצה באמצעות Cloud Identity API.
אי אפשר לצרף קבוצות Google לצ'אטים קבוצתיים או לצ'אטים אישיים, אלא רק למרחב משותף עם שם.
בדוגמה הבאה מוסיפה קבוצה למרחב משותף בעל שם עם אימות משתמשים:
Node.js
Python
Java
Apps Script
כדי להריץ את הדוגמה, מחליפים את הפרטים הבאים:
SPACE_NAME
: המזהה מ-name
של המרחב המשותף. אפשר לקבל את המזהה על ידי קריאה ל-methodListSpaces()
או מכתובת ה-URL של המרחב המשותף.GROUP_NAME
: מזהה קבוצה.
Chat API מחזיר מופע של Membership
שמציין את פרטי המינוי של המשתמש שנוצר.
איך מוסיפים אפליקציות של Chat למרחבים משותפים
אי אפשר לצרף למרחב המשותף אפליקציות של Chat באמצעות אפליקציות אחרות. כדי להוסיף אפליקציית Chat למרחב משותף או לצ'אט ישיר בין שני משתמשים אנושיים, צריך להעביר את הפרטים הבאים בבקשה עם אימות משתמש (אימות אפליקציה לא תומך בהזמנה או בהוספה של אפליקציית Chat למרחב משותף):
- מציינים את היקף ההרשאה
chat.memberships.app
. - קוראים ל-method
CreateMembership()
. - מעבירים את
parent
בתור שם המשאב של המרחב המשותף שבו רוצים ליצור את החברות. - מעבירים את
membership
כמכונה שלMembership
, כשהשדהmember
מוגדר כך:- השדה
type
מוגדר ל-BOT
. - השדה
name
מוגדר כ-users/app
, כינוי שמייצג את האפליקציה שמפעילה את Chat API.
- השדה
בדוגמה הבאה מוסיפה אפליקציית Chat למרחב משותף:
Node.js
Python
Java
Apps Script
כדי להריץ את הדוגמה, מחליפים את SPACE_NAME
במזהה מהמזהה name
של המרחב המשותף.
כדי לאתר אותו, אפשר לשלוח קריאה ל-method ListSpaces()
או לכתובת ה-URL של המרחב המשותף.
Chat API מחזיר מופע של Membership
שמפרט את החברות של המשתמש שנוצרה.
איך מזמינים או מוסיפים משתמשים למרחב משותף דרך אפליקציית Chat
כדי לאמת אפליקציה, נדרש אישור אדמין חד-פעמי.
כדי להזמין או להוסיף משתמשים למרחבים משותפים באמצעות אימות אפליקציות, צריך להעביר את הפרטים הבאים בבקשה:
- מציינים את היקף ההרשאה
chat.app.memberships
. - קוראים לשיטה
create
במשאבmembership
. - מגדירים את
parent
לשם המשאב של המרחב המשותף שבו רוצים ליצור את החברות. - מגדירים את
member
כ-users/{user}
, כאשר{user}
הוא האדם שעבורו רוצים ליצור את החברות, והוא יכול להיות:- המזהה של האדם ב-People API. לדוגמה, אם הערך של person ב-People API הוא
people/123456789
, צריך להגדיר אתmembership.member.name
לערךusers/123456789
.resourceName
- המזהה של המשתמש ב-Directory API.
- כתובת האימייל של המשתמש. לדוגמה,
users/222larabrown@gmail.com
אוusers/larabrown@cymbalgroup.com
. אם המשתמש משתמש בחשבון Google או שייך לארגון אחר ב-Google Workspace, צריך להשתמש בכתובת האימייל שלו.
- המזהה של האדם ב-People API. לדוגמה, אם הערך של person ב-People API הוא
יצירה של מפתח API
כדי לקרוא ל-method של API בתצוגה מקדימה למפתחים, צריך להשתמש בגרסה לא ציבורית של מסמך חשיפת ה-API בתצוגה מקדימה למפתחים. כדי לאמת את הבקשה, צריך להעביר מפתח API.
כדי ליצור את מפתח ה-API, פותחים את הפרויקט של האפליקציה ב-Google Cloud ומבצעים את הפעולות הבאות:
- במסוף Google Cloud, נכנסים לתפריט > APIs & Services > Credentials.
- לוחצים על Create credentials (יצירת פרטי כניסה) > API key (מפתח API).
- מפתח ה-API החדש מוצג.
- לוחצים על סמל ההעתקה כדי להעתיק את מפתח ה-API לשימוש בקוד של האפליקציה. תוכלו למצוא את מפתח ה-API גם בקטע API Keys (מפתחות API) בפרטי הכניסה של הפרויקט.
- לוחצים על Restrict key כדי לעדכן את ההגדרות המתקדמות ולהגביל את השימוש במפתח ה-API. פרטים נוספים זמינים במאמר החלת הגבלות על מפתחות API.
כתיבת סקריפט שמפעיל את Chat API
בדוגמה הבאה מוסיפים משתמש למרחב משותף באמצעות אימות באפליקציה:
Python
- בספריית העבודה, יוצרים קובץ בשם
chat_membership_app_create.py
. צריך לכלול את הקוד הבא ב-
chat_membership_app_create.py
:from google.oauth2 import service_account from apiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.app.memberships"] def main(): ''' Authenticates with Chat API using app authentication, then adds a user to a Chat space by creating a membership. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # Use the service endpoint to call Chat API. result = chat.spaces().members().create( # The space in which to create a membership. parent = 'spaces/SPACE', # Specify which user the membership is for. body = { 'member': { 'name':'users/USER', 'type': 'HUMAN' } } ).execute() # Prints details about the created membership. print(result) if __name__ == '__main__': main()
בקוד, מחליפים את מה שכתוב בשדות הבאים:
API_KEY
: מפתח ה-API שיצרתם כדי ליצור את נקודת הקצה של השירות ל-Chat API.SPACE
: שם של מרחבים משותפים, שאפשר לקבל מהשיטהspaces.list
ב-Chat API או מכתובת ה-URL של המרחב המשותף.USER
: מזהה משתמש.
בספריית העבודה, יוצרים ומריצים את הדוגמה:
python3 chat_membership_app_create.py
הוספת משתמשים או קבוצות Google למרחב משותף כאדמינים ב-Google Workspace
אדמינים ב-Google Workspace יכולים להפעיל את השיטה create()
כדי להוסיף משתמשים, קבוצות Google או אפליקציות של Chat לכל מרחב משותף בארגון שלהם ב-Google Workspace.
כדי להפעיל את השיטה הזו כאדמינים ב-Google Workspace:
- קוראים לשיטה באמצעות אימות משתמש, ומציינים היקף הרשאה שתומך בקריאה לשיטה באמצעות הרשאות אדמין.
- בבקשה שלכם, מציינים את פרמטר השאילתה
useAdminAccess
עדtrue
.
למידע נוסף ולדוגמאות, ראו ניהול מרחבים משותפים ב-Google Chat כאדמינים ב-Google Workspace.
מגבלות ושיקולים
- כשמשתמשים באימות אפליקציה, אפשר להזמין או להוסיף משתמשים מאפליקציית Chat, אבל לא מקבוצות Google או מאפליקציות Chat. כדי להוסיף את עצמה, אפליקציית Chat צריכה להשתמש באימות משתמש עם היקף ההרשאה
chat.memberships
.
נושאים קשורים
- מידע נוסף על המינוי של משתמש או של אפליקציית Chat
- הצגת רשימת המשתתפים במרחב המשותף
- איך מעדכנים את פרטי החברות של משתמשים במרחב משותף ב-Google Chat
- להסיר משתמש או את אפליקציית Chat ממרחב משותף.