Method: spaces.setup

فضایی ایجاد می کند و کاربران مشخصی را به آن اضافه می کند. کاربر تماس گیرنده به طور خودکار به فضا اضافه می شود و نباید به عنوان عضویت در درخواست مشخص شود. برای مثال، به تنظیم فضایی با اعضای اولیه مراجعه کنید.

برای تعیین اعضای انسانی برای افزودن، عضویت هایی را با membership.member.name مناسب اضافه کنید. برای افزودن یک کاربر انسانی، 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 ، کاربر را به فضا اضافه کنید.

برای تعیین گروه‌های Google برای افزودن، عضویت‌ها را با membership.group_member.name مناسب اضافه کنید. برای افزودن یا دعوت یک گروه Google، از groups/{group} استفاده کنید، جایی که {group} id گروه از Cloud Identity Groups API است. برای مثال، می‌توانید از API جستجوی Cloud Identity Groups برای بازیابی شناسه 123456789 برای ایمیل گروهی group@example.com استفاده کنید، سپس می‌توانید با تنظیم membership.group_member.name به groups/123456789 گروه را به فضا اضافه کنید. ایمیل گروهی پشتیبانی نمی‌شود و گروه‌های Google را فقط می‌توان به‌عنوان عضو در فضاهای نام‌گذاری شده اضافه کرد.

برای یک فضای نامگذاری شده یا چت گروهی، اگر تماس گیرنده مسدود شود، یا توسط برخی از اعضا مسدود شده باشد، یا اجازه اضافه کردن برخی از اعضا را نداشته باشد، آن اعضا به فضای ایجاد شده اضافه نمی شوند.

برای ایجاد یک پیام مستقیم (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)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
فیلدها
space

object ( Space )

مورد نیاز. فیلد Space.spaceType لازم است.

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

برای ایجاد یک چت گروهی، Space.spaceType روی GROUP_CHAT تنظیم کنید. Space.displayName تنظیم نکنید.

برای ایجاد مکالمه 1:1 بین انسان ها، Space.spaceType را روی DIRECT_MESSAGE و Space.singleUserBotDm را روی false تنظیم کنید. Space.displayName یا Space.spaceDetails را تنظیم نکنید.

برای ایجاد مکالمه 1:1 بین یک انسان و برنامه چت در حال تماس، Space.spaceType را روی DIRECT_MESSAGE و Space.singleUserBotDm را روی true تنظیم کنید. Space.displayName یا Space.spaceDetails را تنظیم نکنید.

اگر یک فضای DIRECT_MESSAGE از قبل وجود داشته باشد، به جای ایجاد یک فضای جدید، آن فضا برگردانده می شود.

request Id

string

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

memberships[]

object ( Membership )

اختیاری. کاربران یا گروه‌های چت Google را دعوت کنید تا به فضا بپیوندند. کاربر تماس گیرنده را حذف کنید، زیرا آنها به طور خودکار اضافه می شوند.

این مجموعه در حال حاضر حداکثر 20 عضویت (علاوه بر تماس گیرنده) را امکان پذیر می کند.

برای عضویت انسانی، فیلد Membership.member باید شامل user با name پر شده (قالب: users/{user} ) و type تنظیم شده روی User.Type.HUMAN باشد. فقط هنگام تنظیم یک فضا می‌توانید کاربران انسانی اضافه کنید (افزودن برنامه‌های چت فقط برای تنظیم پیام مستقیم با برنامه تماس پشتیبانی می‌شود). همچنین می توانید با استفاده از ایمیل کاربر به عنوان نام مستعار برای {user} اعضا اضافه کنید. به عنوان مثال، user.name می تواند users/example@gmail.com باشد. برای دعوت از کاربران Gmail یا کاربران از دامنه های Google Workspace خارجی، ایمیل کاربر باید برای {user} استفاده شود.

برای عضویت در گروه Google، قسمت Membership.group_member باید group با name پر شده باشد ( groups/{group} ). وقتی Space.spaceType را روی SPACE تنظیم کنید، فقط می‌توانید گروه‌های Google را اضافه کنید.

هنگام تنظیم Space.spaceType روی SPACE اختیاری است.

هنگام تنظیم Space.spaceType روی GROUP_CHAT ، همراه با حداقل دو عضویت، ضروری است.

هنگام تنظیم Space.spaceType روی DIRECT_MESSAGE با یک کاربر انسانی، همراه با دقیقاً یک عضویت ضروری است.

هنگام ایجاد مکالمه 1:1 بین یک انسان و برنامه چت در حال تماس، باید خالی باشد (هنگامی که Space.spaceType را روی DIRECT_MESSAGE و Space.singleUserBotDm را روی true تنظیم کنید).

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Space است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

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