במדריך הזה מוסבר איך להשתמש בשיטה patch() במשאב Space של Google Chat API כדי לעדכן מרחב. אפשר לעדכן את המרחב כדי לשנות מאפיינים שלו, כמו השם המוצג שגלוי למשתמשים, התיאור וההנחיות.
אדמינים ב-Google Workspace יכולים להתקשר לשיטת patch() כדי לעדכן חלל קיים בארגון שלהם ב-Google Workspace.
משאב Space מייצג מקום שבו אנשים ואפליקציות ל-Chat יכולים לשלוח הודעות, לשתף קבצים ולשתף פעולה. יש כמה סוגים של מרחבים:
- צ'אטים ישירים הם שיחות בין שני משתמשים או בין משתמש לבין אפליקציית Chat.
- צ'אטים קבוצתיים הם שיחות בין שלושה משתמשים או יותר לבין אפליקציות ל-Chat.
- מרחבים משותפים עם שם הם מקומות קבועים שבהם אנשים יכולים לשלוח הודעות, לשתף קבצים ולעבוד יחד.
דרישות מוקדמות
Node.js
- חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud ל-Node.js.
-
יצירת פרטי כניסה של מזהה לקוח OAuth לאפליקציה למחשב. כדי להריץ את הדוגמה במדריך הזה, צריך לשמור את פרטי הכניסה כקובץ JSON בשם
credentials.jsonבספרייה המקומית.
- בוחרים היקף הרשאה שתומך באימות משתמשים.
- מרחב ב-Google Chat. במאמר יצירת מרחב מוסבר איך ליצור מרחב באמצעות Google Chat API. כדי ליצור מרחב ב-Chat, אפשר לעיין במסמכי מרכז העזרה.
Python
- חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud לשימוש ב-Python.
-
יצירת פרטי כניסה של מזהה לקוח OAuth לאפליקציה למחשב. כדי להריץ את הדוגמה במדריך הזה, צריך לשמור את פרטי הכניסה כקובץ JSON בשם
credentials.jsonבספרייה המקומית.
- בוחרים היקף הרשאה שתומך באימות משתמשים.
- מרחב ב-Google Chat. במאמר יצירת מרחב מוסבר איך ליצור מרחב באמצעות Google Chat API. כדי ליצור מרחב ב-Chat, אפשר לעיין במסמכי מרכז העזרה.
Java
- חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud ל-Java.
-
יצירת פרטי כניסה של מזהה לקוח OAuth לאפליקציה למחשב. כדי להריץ את הדוגמה במדריך הזה, צריך לשמור את פרטי הכניסה כקובץ JSON בשם
credentials.jsonבספרייה המקומית.
- בוחרים היקף הרשאה שתומך באימות משתמשים.
- מרחב ב-Google Chat. במאמר יצירת מרחב מוסבר איך ליצור מרחב באמצעות Google Chat API. כדי ליצור מרחב ב-Chat, אפשר לעיין במסמכי מרכז העזרה.
Apps Script
- חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- יוצרים פרויקט עצמאי של Apps Script ומפעילים את שירות Chat מתקדם.
- בוחרים היקף הרשאה שתומך באימות משתמשים.
- מרחב ב-Google Chat. במאמר יצירת מרחב מוסבר איך ליצור מרחב באמצעות Google Chat API. כדי ליצור מרחב ב-Chat, אפשר לעיין במסמכי מרכז העזרה.
עדכון מרחב כמשתמש
כדי לעדכן מרחב קיים ב-Google Chat עם אימות משתמשים, צריך להעביר את הפרטים הבאים בבקשה:
- מציינים את
chat.spacesהיקף ההרשאה. - מבצעים קריאה ל-method
UpdateSpace(). בבקשה, מציינים את השדהname, את השדהupdateMaskעם שדה אחד או יותר לעדכון ואת השדהbodyעם פרטי המרחב המעודכנים.
אתם יכולים לעדכן פרטים כמו השם המוצג, סוג המרחב, סטטוס ההיסטוריה ועוד. כדי לראות את כל השדות שאפשר לעדכן, אפשר לעיין במסמכי העזרה.
כך מעדכנים את השדה displayName של מרחב קיים:
Node.js
Python
Java
Apps Script
כדי להריץ את הדוגמה הזו, מחליפים את SPACE_NAME במזהה מהשדה name של המרחב. אפשר לקבל את המזהה על ידי הפעלת השיטה ListSpaces() או מכתובת ה-URL של המרחב.
Google Chat API מחזיר מופע של Space שמשקף את העדכונים.
עדכון המרחב כאדמינים ב-Google Workspace
אדמינים ב-Google Workspace יכולים להתקשר לשיטה UpdateSpace() כדי לעדכן כל חלל בארגון שלהם ב-Google Workspace.
כדי להפעיל את ה-method הזה כאדמינים ב-Google Workspace, צריך לבצע את הפעולות הבאות:
- קוראים ל-method באמצעות אימות משתמש, ומציינים היקף הרשאות שתומך בקריאה ל-method באמצעות הרשאות אדמין.
- בבקשה, מציינים את פרמטר השאילתה
useAdminAccessכ-true.
מידע נוסף ודוגמאות זמינים במאמר ניהול מרחבים ב-Google Chat כאדמינים ב-Google Workspace.
עדכון מרחב כאפליקציית Chat
כדי לאמת אפליקציה, צריך אישור אדמין חד-פעמי.
כדי לעדכן מרחב קיים ב-Google Chat עם אימות אפליקציה, צריך להעביר את הפרטים הבאים בבקשה:
- מציינים את
chat.app.spacesהיקף ההרשאה. באמצעות אימות אפליקציות, אפשר לעדכן רק מרחבים שנוצרו על ידי אפליקציות ל-Chat. - מפעילים את השיטה
patchבמשאבSpace. בבקשה, מציינים את השדהnameשל המרחב, את השדהupdateMaskעם שדה אחד או יותר לעדכון ואתbodyעם פרטי המרחב המעודכנים.
אתם יכולים לעדכן דברים כמו השם המוצג, סוג המרחב, סטטוס ההיסטוריה, הגדרות ההרשאות ועוד. כדי לראות את כל השדות שאפשר לעדכן, אפשר לעיין במסמכי העזרה.
כתיבת סקריפט שקורא ל-Chat API
כך מעדכנים את השדה spaceDetails של מרחב קיים:
Python
- בספריית העבודה, יוצרים קובץ בשם
chat_space_update_app.py. מוסיפים את הקוד הבא אל
chat_space_update_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"] def main(): ''' Authenticates with Chat API using app authentication, then updates the specified space description and guidelines. ''' # 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) # Use the service endpoint to call Chat API. result = chat.spaces().patch( # The space to update, and the updated space details. # # Replace {space} with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE', updateMask='spaceDetails', body={ 'spaceDetails': { 'description': 'This description was updated with Chat API!', 'guidelines': 'These guidelines were updated with Chat API!' } } ).execute() # Prints details about the updated space. print(result) if __name__ == '__main__': main()בקוד, מחליפים את מה שכתוב בשדות הבאים:
SPACEעם שם המרחב, שאפשר לקבל באמצעות השיטהspaces.listב-Chat API או מכתובת ה-URL של המרחב.
בספריית העבודה, מבצעים build ומריצים את הדוגמה:
python3 chat_space_update_app.py
Google Chat API מחזיר מופע של Space resource שמשקף את העדכונים.
מגבלות ושיקולים
- באמצעות אימות אפליקציות, אפליקציות ל-Chat:
- יכולים לעדכן רק את
predefinedPermissionSettingsאו אתpermissionSettingsבמרחבים שהם יצרו. - לא ניתן לעדכן את
accessSettings.audience.
- יכולים לעדכן רק את
נושאים קשורים
- איך מקבלים פרטים על מרחב
- רשימת מרחבים.
- מחיקת מרחבים
- איך יוצרים מרחבים
- איך מחפשים מרחבים עם צ'אטים ישירים
- איך יוצרים מרחב שגלוי למשתמשים ספציפיים