فضایی ایجاد می کند و کاربران مشخصی را به آن اضافه می کند. کاربر تماس گیرنده به طور خودکار به فضا اضافه می شود و نباید به عنوان عضویت در درخواست مشخص شود. برای مثال، به تنظیم فضایی با اعضای اولیه مراجعه کنید.
برای تعیین اعضای انسانی برای افزودن، عضویت هایی را با member.name
مناسب در SetUpSpaceRequest
اضافه کنید. برای افزودن یک کاربر انسانی، از users/{user}
استفاده کنید، جایی که {user}
میتواند آدرس ایمیل کاربر باشد. برای کاربران در همان سازمان Workspace {user}
همچنین میتواند id
شخص از People API یا id
کاربر در Directory API باشد. برای مثال، اگر شناسه نمایه افراد API People برای user@example.com
123456789
باشد، میتوانید با تنظیم membership.member.name
به users/user@example.com
یا users/123456789
کاربر را به فضا اضافه کنید.
برای چت فضایی یا گروهی، اگر تماس گیرنده مسدود شود یا توسط برخی از اعضا مسدود شود، آن اعضا به فضای ایجاد شده اضافه نمی شوند.
برای ایجاد یک پیام مستقیم (DM) بین کاربر تماس گیرنده و کاربر انسانی دیگر، دقیقاً یک عضویت را برای نشان دادن کاربر انسانی مشخص کنید. اگر یکی از کاربران دیگری را مسدود کند، درخواست با شکست مواجه می شود و DM ایجاد نمی شود.
برای ایجاد DM بین کاربر تماس گیرنده و برنامه تماس گیرنده، Space.singleUserBotDm
را روی true
تنظیم کنید و هیچ عضویتی را مشخص نکنید. شما فقط می توانید از این روش برای تنظیم DM با برنامه تماس استفاده کنید. برای افزودن برنامه تماس به عنوان عضوی از یک فضا یا یک DM موجود بین دو کاربر انسانی، به دعوت کردن یا افزودن یک کاربر یا برنامه به یک فضا مراجعه کنید.
اگر یک DM از قبل بین دو کاربر وجود داشته باشد، حتی زمانی که یک کاربر در زمان درخواست، دیگری را مسدود کند، DM موجود برگردانده می شود.
فضاهای دارای پاسخ رشته ای پشتیبانی نمی شوند. اگر هنگام تنظیم یک فاصله، پیام خطای ALREADY_EXISTS
را دریافت کردید، یک displayName
دیگر را امتحان کنید. فضای موجود در سازمان Google Workspace ممکن است از قبل از این نام نمایشی استفاده کند.
نیاز به احراز هویت کاربر دارد.
درخواست HTTP
POST https://chat.googleapis.com/v1/spaces:setup
URL از دستور GRPC Transcoding استفاده می کند.
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "space": { object ( |
زمینه های | |
---|---|
space | ضروری. فیلد برای ایجاد فاصله، برای ایجاد یک چت گروهی، برای ایجاد مکالمه 1:1 بین انسان ها، برای ایجاد مکالمه 1:1 بین یک انسان و برنامه چت در حال تماس، اگر یک فضای |
requestId | اختیاری. یک شناسه منحصر به فرد برای این درخواست. یک UUID تصادفی توصیه می شود. تعیین شناسه درخواست موجود، به جای ایجاد فضای جدید، فضای ایجاد شده با آن شناسه را برمی گرداند. مشخص کردن شناسه درخواست موجود از همان برنامه چت با کاربر تأیید شده متفاوت، یک خطا برمیگرداند. |
memberships[] | اختیاری. کاربران چت Google را برای پیوستن به فضا دعوت کنند. کاربر تماس گیرنده را حذف کنید، زیرا آنها به طور خودکار اضافه می شوند. این مجموعه در حال حاضر حداکثر 20 عضویت (علاوه بر تماس گیرنده) را امکان پذیر می کند. فیلد هنگام تنظیم هنگام تنظیم هنگام تنظیم هنگام ایجاد مکالمه 1:1 بین یک انسان و برنامه چت در حال تماس، باید خالی باشد (هنگامی که |
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Space
است.
محدوده مجوز
به یکی از حوزه های OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/chat.spaces
-
https://www.googleapis.com/auth/chat.spaces.create
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.