במדריך הזה מוסבר איך להשתמש ב-method patch()
במשאב Space
של Google Chat API כדי לעדכן מרחב משותף. אתם יכולים לעדכן את המרחב המשותף כדי לשנות את המאפיינים שלו, כמו השם המוצג, התיאור וההנחיות שגלויים למשתמשים.
אדמינים ב-Google Workspace יכולים להפעיל את השיטה patch()
כדי לעדכן כל מרחב משותף קיים בארגון ב-Google Workspace.
המשאבים מסוג Space
מייצגים מקום שבו אנשים ואפליקציות Chat יכולים לשלוח הודעות, לשתף קבצים ולשתף פעולה. יש כמה סוגים של מרחבים משותפים:
- צ'אטים אישיים (DM) הם שיחות בין שני משתמשים או בין משתמש לאפליקציית Chat.
- שיחות קבוצתיות הן שיחות בין שלושה משתמשים או יותר באפליקציות Chat.
- מרחבים משותפים עם שם הם מקומות קבועים שבהם אנשים שולחים הודעות, משתפים קבצים ועובדים יחד.
דרישות מוקדמות
Node.js
- חשבון Google Workspace בתוכנית Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud ל-Node.js.
-
יצירת פרטי כניסה של מזהה לקוח OAuth לאפליקציה למחשב. כדי להריץ את הדוגמה במדריך הזה, שומרים את פרטי הכניסה כקובץ JSON בשם
client_secrets.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 בשם
client_secrets.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 בשם
client_secrets.json
בספרייה המקומית.
- בחירת היקף הרשאה שתומך באימות משתמשים.
- מרחב משותף ב-Google Chat. במאמר יצירת מרחב משותף מוסבר איך ליצור מרחב משותף באמצעות Google Chat API. כדי ליצור קבוצה ב-Chat, תוכלו לעיין במסמכי העזרה.
Apps Script
- חשבון Google Workspace בתוכנית Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- יוצרים פרויקט נפרד של Apps Script ומפעילים את שירות הצ'אט המתקדם.
- בחירת היקף הרשאה שתומך באימות משתמשים.
- מרחב משותף ב-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
של המרחב המשותף. אפשר לקבל את המזהה על ידי קריאה ל-method ListSpaces()
או מכתובת ה-URL של המרחב המשותף.
Google Chat API מחזיר מופע של Space
שמשקף את העדכונים.
עדכון מרחב משותף כאדמינים ב-Google Workspace
אדמינים ב-Google Workspace יכולים להפעיל את השיטה UpdateSpace()
כדי לעדכן כל מרחב משותף בארגון שלהם ב-Google Workspace.
כדי לקרוא ל-method הזה כאדמינים ב-Google Workspace:
- קוראים לשיטה באמצעות אימות משתמש, ומציינים היקף הרשאה שתומך בקריאה לשיטה באמצעות הרשאות אדמין.
- בבקשה, מציינים את פרמטר השאילתה
useAdminAccess
עדtrue
.
למידע נוסף ולדוגמאות, ראו ניהול מרחבים משותפים ב-Google Chat כאדמינים ב-Google Workspace.
עדכון מרחב משותף כאפליקציה ב-Chat
כדי לאמת אפליקציה, נדרש אישור אדמין חד-פעמי.
כדי לעדכן מרחב משותף קיים ב-Google Chat עם אימות באפליקציה, צריך להעביר את הפרטים הבאים בבקשה:
- מציינים את היקף ההרשאה
chat.app.spaces
. כשמשתמשים באימות באפליקציה, אפשר לעדכן רק מרחבים משותפים שנוצרו על ידי אפליקציות של Chat. - קוראים לשיטה
patch
במשאבSpace
. בבקשה, מציינים את השדהname
של המרחב המשותף, את השדהupdateMask
עם שדה אחד או יותר לעדכון ואת השדהbody
עם פרטי המרחב המשותף המעודכנים.
אתם יכולים לעדכן פרטים כמו השם המוצג, סוג המרחב המשותף, מצב ההיסטוריה, הגדרות ההרשאות ועוד. כדי לראות את כל השדות שאפשר לעדכן, עיינו במסמכי העזרה.
יצירה של מפתח 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
כך מעדכנים את השדה 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, 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().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()
בקוד, מחליפים את הפרטים הבאים:
API_KEY
: מפתח ה-API שיצרתם כדי ליצור את נקודת הקצה של השירות ל-Chat API.SPACE
בשם של המרחב המשותף. אפשר לקבל את השם מהשיטהspaces.list
ב-Chat API או מכתובת ה-URL של המרחב המשותף.
בספריית העבודה, יוצרים ומריצים את הדוגמה:
python3 chat_space_update_app.py
Google Chat API מחזיר מופע של משאב Space
שמשקף את העדכונים.
נושאים קשורים
- לקבלת פרטים על מרחב משותף
- רשימת המרחבים המשותפים.
- למחוק מרחב משותף.
- מגדירים מרחב משותף.
- מחפשים מרחב משותף בצ'אט אישי.
- להגדיר מרחב משותף כגלוי למשתמשים ספציפיים.