במדריך הזה מוסבר איך להשתמש
create()
במשאב Space
ב-Google Chat API כדי ליצור מרחב משותף עם שם.
משאב אחד (Space
)
מייצג מקום שבו אנשים ואפליקציות Chat יכולים לשלוח הודעות,
לשתף קבצים ולשתף פעולה. יש כמה סוגים של מרחבים משותפים:
- צ'אטים אישיים (DM) הם שיחות בין שני משתמשים או בין משתמש לאפליקציית Chat.
- שיחות קבוצתיות הן שיחות בין שלושה משתמשים או יותר באפליקציות Chat.
- מרחבים עם שם הם מקומות קבועים שבהם אנשים שולחים הודעות, משתפים קבצים, ולשתף פעולה.
מרחב משותף עם שם הוא מקום שאנשים שולחים בו הודעות, משתפים קבצים לשתף פעולה. מרחבים משותפים עם שם יכולים לכלול אפליקציות של Chat. מרחבים עם שם כוללות פיצ'רים נוספים של שיחות קבוצתיות וצ'אטים אישיים ללא שם כמו מנהלי מרחב שיכולים להחיל הגדרות ניהול, ותיאורים, ולהוסיף או להסיר אנשים ואפליקציות. אחרי שיוצרים מרחב משותף בעל שם, המשתמש המאומת הוא המשתתף היחיד במרחב המשותף. במרחב המשותף לא כולל אפליקציות או אנשים אחרים. אפילו לא אפליקציית Chat. שיכולה ליצור אותו. איך מוסיפים אנשים למרחב המשותף? יוצרים מינוי.
כדי ליצור מרחב משותף עם שם ומספר משתתפים – שיחה קבוצתית ללא שם עם שלושה אנשים או יותר, שיחה אישית בין שני אנשים או שיחה אישית בין אדם לאפליקציית Chat שמפעילה את Chat API – מגדירים מרחב משותף במקום זאת.
דרישות מוקדמות
Node.js
- עסק או ארגון חשבון Google Workspace עם גישה אל Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- להתקין את Node.js ספריית הלקוח של Cloud.
- יוצרים פרטי כניסה בהתאם לאופן שבו רוצים לבצע אימות בבקשה ל-Google Chat API:
- כדי לבצע אימות כמשתמש ב-Chat, צריך ליצור פרטי כניסה של מזהה לקוח OAuth ולשמור את פרטי הכניסה כקובץ JSON בשם
client_secrets.json
בספרייה המקומית. - כדי לבצע אימות כאפליקציית Chat:
יצירת חשבון שירות
פרטי כניסה ולשמור את פרטי הכניסה כקובץ JSON בשם
credentials.json
.
- כדי לבצע אימות כמשתמש ב-Chat, צריך ליצור פרטי כניסה של מזהה לקוח OAuth ולשמור את פרטי הכניסה כקובץ JSON בשם
- בוחרים היקף הרשאה בהתאם לכך אם רוצים לבצע אימות כמשתמש או כאפליקציית Chat.
Python
- עסק או ארגון חשבון Google Workspace עם גישה אל Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, הסמל והתיאור של אפליקציית Chat.
- להתקין את Python ספריית הלקוח של Cloud.
- יוצרים פרטי כניסה בהתאם לאופן שבו רוצים לבצע אימות בבקשה ל-Google Chat API:
- כדי לבצע אימות כמשתמש ב-Chat, צריך ליצור פרטי כניסה של מזהה לקוח OAuth ולשמור את פרטי הכניסה כקובץ JSON בשם
client_secrets.json
בספרייה המקומית. - כדי לבצע אימות בתור אפליקציית Chat, צריך ליצור פרטי כניסה לחשבון שירות ולשמור את פרטי הכניסה כקובץ JSON בשם
credentials.json
.
- כדי לבצע אימות כמשתמש ב-Chat, צריך ליצור פרטי כניסה של מזהה לקוח OAuth ולשמור את פרטי הכניסה כקובץ JSON בשם
- בוחרים את היקף ההרשאה בהתאם לאופן שבו רוצים לבצע אימות כמשתמשים או אפליקציית Chat.
Java
- עסק או ארגון חשבון Google Workspace עם גישה אל Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, הסמל והתיאור של אפליקציית Chat.
- להתקין את Java ספריית הלקוח של Cloud.
- יוצרים פרטי כניסה בהתאם לאופן שבו רוצים לבצע אימות בבקשה ל-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 המתקדם.
- במדריך זה חובה להשתמש בשני סוגי המשתמשים או אימות אפליקציות. כדי לבצע אימות כאפליקציית Chat, צריך ליצור פרטי הכניסה של חשבון השירות. להוראות, היכנסו למאמר אימות ואישור בתור אפליקציית Google Chat.
- בוחרים את היקף ההרשאה בהתאם לאופן שבו רוצים לבצע אימות כמשתמשים או אפליקציית Chat.
יצירת מרחב משותף בעל שם כמשתמשים
כדי ליצור מרחב משותף עם שם ייחודי אימות משתמש, אישור את הפרטים הבאים בבקשה שלכם:
- מציינים את היקף ההרשאה
chat.spaces.create
אוchat.spaces
. - קוראים לפונקציה
CreateSpace()
מעבירים אתspace
כמופע שלSpace
באמצעות השדות הבאים:spaceType
הוגדרה לערךSPACE
.displayName
מוגדר לשם המרחב המשותף שגלוי למשתמשים.- אפשר להגדיר מאפיינים נוספים, למשל:
spaceDetails
- תיאור הגלוי למשתמש ורשימת הנחיות עבור את המרחב.predefinedPermissionSettings
– הרשאות מוגדרות מראש למרחב המשותף. לדוגמה, אפשר להגדיר שהמרחב המשותף יכלול את כל חברי המועדון או רק את המרחב המשותף מנהלים יכולים לפרסם הודעות.
כדי ליצור מרחב משותף עם שם:
Node.js
Python
Java
Apps Script
יצירת מרחב משותף בשם כאפליקציית Chat
נדרש אימות חד-פעמי של אפליקציות אישור אדמין.
כדי להזמין או להוסיף משתמשים למרחבים משותפים app verification, (אימות אפליקציה) את הפרטים הבאים בבקשה שלכם:
- מציינים את היקף ההרשאה
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, נכנסים לתפריט > ממשקי API ו Services (שירותים) > פרטי כניסה.
- לוחצים על יצירת פרטי כניסה >. API key.
- מפתח ה-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
.
נושאים קשורים
- צירוף אנשים ואפליקציות למרחב המשותף באמצעות יוצרים חברים.
- פרסום הודעה במרחב המשותף מאת יצירת הודעה.
- לקבלת פרטים על מרחב משותף
- הצגת רשימה של מרחבים
- לעדכן מרחב משותף.
- למחוק את המרחב המשותף.
- מגדירים מרחב משותף.
- מחפשים מרחב משותף בצ'אט אישי.
- להגדיר מרחב משותף כגלוי למשתמשים ספציפיים.