Method: spaces.create

יצירת מרחב. אפשר להשתמש בה כדי ליצור מרחב עם שם או צ'אט קבוצתי ב-Import mode. דוגמה מופיעה במאמר יצירת מרחב.

יש תמיכה בסוגי האימות הבאים:

  • אימות אפליקציה עם אישור אדמין ואחת מהרשאות הגישה הבאות:

    • https://www.googleapis.com/auth/chat.app.spaces.create
    • https://www.googleapis.com/auth/chat.app.spaces
  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

    • https://www.googleapis.com/auth/chat.spaces.create
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (רווחים במצב ייבוא בלבד)

כשמבצעים אימות כאפליקציה, צריך להגדיר את השדה space.customer בבקשה.

כשמבצעים אימות כאפליקציה, אפליקציית Chat נוספת כחברה במרחב. עם זאת, בניגוד לאימות של משתמשים, אפליקציית Chat לא מתווספת כמנהלת המרחב. כברירת מחדל, כל המשתתפים במרחב יכולים להסיר את אפליקציית Chat מהמרחב. כדי לאפשר רק למנהלי המרחב להסיר את האפליקציה מהמרחב, מגדירים את space.permission_settings.manage_apps ל-managersAllowed.

החברות במרחב אחרי שהוא נוצר תלויה במיקום שבו הוא נוצר ב-Import mode:

  • מצב ייבוא: לא נוצרים חברים.
  • כל המצבים האחרים: המשתמש שמתקשר מתווסף כמשתתף. הכוונה היא:
    • האפליקציה עצמה כשמשתמשים באימות אפליקציה.
    • המשתמש האנושי כשמשתמשים באימות משתמש.

אם מופיעה הודעת השגיאה ALREADY_EXISTS כשיוצרים מרחב, כדאי לנסות displayName אחר. יכול להיות ששם מוצג כזה כבר נמצא בשימוש במרחב קיים בארגון Google Workspace.

בקשת HTTP

POST https://chat.googleapis.com/v1/spaces

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של שאילתה

פרמטרים
requestId

string

אופציונלי. מזהה ייחודי לבקשה. מומלץ להשתמש במזהה ייחודי אוניברסלי (UUID) אקראי. ציון מזהה בקשה הופך את הבקשה לאידמפוטנטית, וכך אפשר לוודא שמספר בקשות זהות עם אותו מזהה בקשה יובילו ליצירת מרחב אחד בלבד. בקשות עוקבות עם אותו מזהה בקשה מחזירות את המרחב הקיים ולא מעדכנות אותו, גם אם הפרטים המבוקשים שונים מהמצב הנוכחי.

כדי להשתמש בשדה הזה בצורה יעילה:

  • חשוב לוודא שהבקשות הבאות זהות ומשתמשות באותם פרטי אימות כמו הבקשה המקורית.
  • אם כבר נוצר מרחב עם מזהה הבקשה שצוין, הבקשה מחזירה את המרחב הזה. שימו לב: יכול להיות שהמרחב שיוחזר לא יאוכלס במלואו. ה-API משקף את המרחב בבקשה שלכם עם שם המשאב שהוקצה על ידי המערכת. כדי לאחזר את המטא-נתונים העדכניים של המרחב, קוראים ל-spaces.get.
  • שימוש חוזר במזהה בקשה קיים עם משתמש מאומת אחר מוביל לשגיאה.

גוף הבקשה

גוף הבקשה מכיל מופע של Space.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של Space.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.app.spaces.create
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

מידע נוסף זמין במדריך ההרשאות.