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 باید در درخواست تنظیم شود.

هنگام احراز هویت به عنوان یک برنامه، برنامه چت به عنوان عضوی از فضا اضافه می‌شود. با این حال، برخلاف احراز هویت انسانی، برنامه چت به عنوان مدیر فضا اضافه نمی‌شود. به طور پیش‌فرض، برنامه چت می‌تواند توسط همه اعضای فضا از فضا حذف شود. برای اینکه فقط مدیران فضا بتوانند برنامه را از یک فضا حذف کنند، space.permission_settings.manage_apps را روی managersAllowed تنظیم کنید.

عضویت در فضا هنگام ایجاد، به این بستگی دارد که آیا فضا در Import mode ایجاد شده است یا خیر:

  • حالت وارد کردن: هیچ عضوی ایجاد نمی‌شود.
  • تمام حالت‌های دیگر: کاربر فراخواننده به عنوان عضو اضافه می‌شود. این حالت به صورت زیر است:
    • خود برنامه هنگام استفاده از احراز هویت برنامه.
    • کاربر انسانی هنگام استفاده از احراز هویت کاربر.

اگر هنگام ایجاد یک فضا، پیام خطای ALREADY_EXISTS را دریافت کردید، displayName دیگری را امتحان کنید. ممکن است یک فضای موجود در سازمان Google Workspace از قبل از این نام نمایشی استفاده کند.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای پرس و جو

پارامترها
requestId

string

اختیاری. یک شناسه منحصر به فرد برای این درخواست. یک UUID تصادفی توصیه می‌شود. تعیین شناسه درخواست، درخواست را به صورت خودتوان (idempotent) در می‌آورد، که تضمین می‌کند چندین درخواست یکسان با شناسه درخواست یکسان، فقط منجر به ایجاد یک فضای واحد می‌شوند. درخواست‌های بعدی با شناسه درخواست یکسان، فضای موجود را برمی‌گردانند و فضا را به‌روزرسانی نمی‌کنند، حتی اگر جزئیات درخواستی با وضعیت فعلی متفاوت باشد.

برای استفاده موثر از این فیلد:

  • اطمینان حاصل کنید که درخواست‌های بعدی یکسان هستند و از همان اعتبارنامه‌های احراز هویت درخواست اصلی استفاده می‌کنند.
  • اگر فضایی از قبل با شناسه درخواست ارائه شده ایجاد شده باشد، درخواست آن فضا را برمی‌گرداند. توجه داشته باشید که فضای برگردانده شده ممکن است به طور کامل پر نشده باشد؛ 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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.