במדריך הזה מוסבר איך ליצור מרחב משותף בעל שם באמצעות השיטה create()
במשאב Space
של Google Chat API.
מרחב משותף בעל שם (שבו spaceType
הוא SPACE
) הוא מקום שבו אנשים שולחים הודעות, משתפים קבצים ועובדים יחד.
מרחבים משותפים עם שם יכולים לכלול אפליקציות של Chat. במרחבים משותפים עם שם יש מנהלי מרחבים משותפים שיכולים להחיל הגדרות ניהוליות, תיאורים, להוסיף או להסיר אנשים ואפליקציות.
כדי ליצור סוגים שונים של מרחבים משותפים ב-Chat (כולל צ'אטים אישיים או קבוצתיים), משתמשים בשיטה setUp()
במשאב Space
כדי ליצור את המרחב המשותף ולהוסיף לו משתמשים בו-זמנית. מידע נוסף זמין במאמר הגדרת מרחב משותף.
אחרי שיוצרים מרחב משותף עם שם, המשתמש המאומת הוא המשתתף היחיד במרחב המשותף. כדי להוסיף משתמשים למרחב המשותף, צריך להפעיל את השיטה create()
במשאב Membership
לכל אדם או אפליקציה שרוצים להוסיף. לחלופין, אפשר להשתמש ב-method setUp()
כדי ליצור מרחב משותף בעל שם ולהוסיף אליו משתמשים בו-זמנית.
דרישות מוקדמות
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.spaces.create
אוchat.spaces
. - קוראים ל-method
CreateSpace()
ומעבירים אתspace
כמכונה שלSpace
עם השדות הבאים:spaceType
הוגדרה לערךSPACE
.displayName
מוגדר לשם המרחב המשותף שגלוי למשתמשים.- אפשר גם להגדיר מאפיינים אחרים, כמו:
spaceDetails
– תיאור שגלוי למשתמשים וכללי ההתנהגות במרחב המשותף.predefinedPermissionSettings
– הרשאות מוגדרות מראש למרחב המשותף. לדוגמה, אפשר להגדיר שרק מנהלי המרחב המשותף או כל המשתתפים יוכלו לפרסם הודעות.
כך יוצרים מרחב משותף עם שם:
Node.js
Python
Java
Apps Script
יצירת מרחב משותף בשם כאפליקציית Chat
כדי לאמת אפליקציה, נדרש אישור אדמין חד-פעמי.
כדי להזמין או להוסיף משתמש למרחב משותף עם אימות באפליקציה, צריך להעביר את הפרטים הבאים בבקשה:
- מציינים את היקף ההרשאה
chat.app.spaces.create
אוchat.app.spaces
. - קוראים לשיטה
create
במשאבSpace
. - מגדירים את
spaceType
לערךSPACE
. - מגדירים את
displayName
לשם המרחב המשותף שגלוי למשתמשים. בדוגמה הבאה, הערך שלdisplayName
מוגדר ל-API-made
. - מציינים את מספר הלקוח של דומיין Google Workspace באמצעות השדה
customer
. - אפשר גם להגדיר מאפיינים אחרים של המרחב המשותף, כמו
spaceDetails
(תיאור גלוי למשתמשים וקבוצת הנחיות למרחב המשותף).
יצירה של מפתח API
כדי לקרוא ל-method של API בתצוגה מקדימה למפתחים, צריך להשתמש בגרסה לא ציבורית של מסמך חשיפת ה-API בתצוגה מקדימה למפתחים. כדי לאמת את הבקשה, צריך להעביר מפתח API.
כדי ליצור את מפתח ה-API, פותחים את הפרויקט של האפליקציה ב-Google Cloud ומבצעים את הפעולות הבאות:
- במסוף Google Cloud, נכנסים לתפריט > APIs & Services > Credentials.
- לוחצים על Create credentials (יצירת פרטי כניסה) > API key (מפתח API).
- מפתח ה-API החדש מוצג.
- לוחצים על סמל ההעתקה כדי להעתיק את מפתח ה-API לשימוש בקוד של האפליקציה. אפשר למצוא את מפתח ה-API גם בקטע 'מפתחות API' בפרטי הכניסה של הפרויקט.
- לוחצים על Restrict key כדי לעדכן את ההגדרות המתקדמות ולהגביל את השימוש במפתח ה-API. פרטים נוספים זמינים במאמר החלת הגבלות על מפתחות API.
כתיבת סקריפט שמפעיל את Chat API
כך יוצרים מרחב משותף עם שם:
Python
- בספריית העבודה, יוצרים קובץ בשם
chat_space_create_named_app.py
. מוסיפים את הקוד הבא ב-
chat_space_create_named_app.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.spaces.create"] def main(): ''' Authenticates with Chat API using app authentication, then creates a Chat space. ''' # 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().create( # Details about the space to create. body = { # To create a named space, set spaceType to SPACE. 'spaceType': 'SPACE', # The user-visible name of the space. 'displayName': 'API-made', # The customer ID of the Workspace domain. 'customer': 'CUSTOMER' } ).execute() # Prints details about the created space. print(result) if __name__ == '__main__': main()
בקוד, מחליפים את הפרטים הבאים:
API_KEY
: מפתח ה-API שיצרתם כדי ליצור את נקודת הקצה של השירות ל-Chat API.CUSTOMER
: מזהה הלקוח של הדומיין של המרחב המשותף בפורמטcustomer/{customer}
, כאשר{customer}
הוא הערך שלID
ממשאב הלקוח של Admin SDK. כדי ליצור מרחב משותף באותו ארגון ב-Google Workspace שבו נמצאת אפליקציית Chat, משתמשים ב-customers/my_customer
.
בספריית העבודה, יוצרים ומריצים את הדוגמה:
python3 chat_space_create_named_app.py
פתיחת המרחב המשותף ב-Google Chat
כדי לנווט למרחב המשותף, משתמשים במזהה המשאב שלו כדי ליצור את כתובת ה-URL שלו. מזהה המשאב של המרחב המשותף name
מופיע בגוף התשובה ב-Google Chat. לדוגמה, אם הערך של name
במרחב המשותף הוא spaces/1234567
, אפשר לעבור למרחב המשותף באמצעות כתובת ה-URL הבאה: https://mail.google.com/chat/u/0/#chat/space/1234567
.
נושאים קשורים
- יוצרים חברים כדי להוסיף אנשים ואפליקציות למרחב המשותף.
- יוצרים הודעה כדי לפרסם אותה במרחב המשותף.
- לקבלת פרטים על מרחב משותף
- רשימת המרחבים המשותפים.
- לעדכן מרחב משותף.
- למחוק את המרחב המשותף.
- מגדירים מרחב משותף.
- מחפשים מרחב משותף בצ'אט אישי.
- להגדיר מרחב משותף כגלוי למשתמשים ספציפיים.