REST Resource: spaces

{
  "name": string,
  "type": enum (Type),
  "spaceType": enum (SpaceType),
  "singleUserBotDm": boolean,
  "threaded": boolean,
  "displayName": string,
  "externalUserAllowed": boolean,
  "spaceThreadingState": enum (SpaceThreadingState),
  "spaceDetails": {
    object (SpaceDetails)
  },
  "spaceHistoryState": enum (HistoryState),
  "importMode": boolean,
  "createTime": string,
  "lastActiveTime": string,
  "adminInstalled": boolean,
  "membershipCount": {
    object (MembershipCount)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string,
  "customer": string,

  // Union field space_permission_settings can be only one of the following:
  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
  // End of list of possible types for union field space_permission_settings.
}

string

نام منبع فضا

قالب: spaces/{space}

جایی که {space} شناسه اختصاص داده شده توسط سیستم برای فضا را نشان می دهد. شما می توانید ID space را با فراخوانی متد spaces.list() یا از URL space بدست آورید. به عنوان مثال، اگر URL فاصله https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA باشد، شناسه فاصله AAAAAAAAA است.

enum ( Type )

فقط خروجی منسوخ شده: به جای آن از spaceType استفاده کنید. نوع یک فضا.

enum ( SpaceType )

نوع فضا. هنگام ایجاد یک فضا یا به روز رسانی نوع فضای یک فضا مورد نیاز است. خروجی فقط برای استفاده های دیگر.

boolean

اختیاری. این که آیا فضای یک DM بین یک برنامه چت و یک انسان مجرد است.

boolean

فقط خروجی منسوخ شده: به جای آن از spaceThreadingState استفاده کنید. آیا پیام ها در این فضا قرار می گیرند یا خیر.

string

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

برای پیام های مستقیم، این قسمت ممکن است خالی باشد.

پشتیبانی از 128 کاراکتر

boolean

تغییرناپذیر. آیا این فضا به هر کاربر گپ Google اجازه عضویت می دهد یا خیر. ورودی هنگام ایجاد یک فضا در سازمان Google Workspace. هنگام ایجاد فضا در شرایط زیر این فیلد را حذف کنید:

• کاربر احراز هویت شده از یک حساب مصرف کننده (حساب کاربری مدیریت نشده) استفاده می کند. به‌طور پیش‌فرض، فضایی که توسط حساب مصرف‌کننده ایجاد می‌شود، به هر کاربر چت Google اجازه می‌دهد.

برای فضاهای موجود، این فیلد فقط خروجی است.

enum ( SpaceThreadingState )

فقط خروجی حالت رشته در فضای چت.

object ( SpaceDetails )

جزئیات در مورد فضا از جمله توضیحات و قوانین.

enum ( HistoryState )

وضعیت تاریخچه پیام برای پیام ها و رشته ها در این فضا.

boolean

اختیاری. آیا این فضا در Import Mode به عنوان بخشی از انتقال داده به Google Workspace ایجاد شده است یا خیر. وقتی فضاها وارد می‌شوند، تا زمانی که وارد کردن کامل نشود برای کاربران قابل مشاهده نیستند.

ایجاد یک فضا در Import Mode نیاز به احراز هویت کاربر دارد.

string ( Timestamp format)

اختیاری. تغییرناپذیر. برای فضاهای ایجاد شده در چت، زمان ایجاد فضا. این فیلد فقط خروجی است، مگر زمانی که در فضاهای حالت واردات استفاده می شود.

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

فقط زمانی در خروجی پر می شود که spaceType GROUP_CHAT یا SPACE باشد.

string ( Timestamp format)

فقط خروجی مهر زمانی آخرین پیام در فضا.

boolean

فقط خروجی برای فضاهای پیام مستقیم (DM) با برنامه چت، خواه این فضا توسط سرپرست Google Workspace ایجاد شده باشد. مدیران می‌توانند یک پیام مستقیم را با یک برنامه چت از طرف کاربران سازمان خود نصب و راه‌اندازی کنند.

برای پشتیبانی از نصب سرپرست، برنامه چت شما باید پیام‌رسانی مستقیم داشته باشد.

object ( MembershipCount )

فقط خروجی تعداد عضویت های پیوسته گروه بندی شده بر اساس نوع عضو. زمانی که spaceType SPACE ، DIRECT_MESSAGE یا GROUP_CHAT باشد، پر می شود.

object ( AccessSettings )

اختیاری. تنظیمات دسترسی فضا را مشخص می کند. فقط زمانی پر می شود که spaceType SPACE باشد.

string

فقط خروجی URI برای دسترسی کاربر به فضا.

string

اختیاری. تغییرناپذیر. شناسه مشتری دامنه فضا. فقط هنگام ایجاد فضایی با تأیید اعتبار برنامه و SpaceType SPACE است، در غیر این صورت نباید تنظیم شود.

در قالب customers/{customer} ، که در آن customer id [منبع مشتری SDK مدیریت] ( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) است. برنامه‌های خصوصی همچنین می‌توانند از نام مستعار customers/my_customer برای ایجاد فضا در همان سازمان Google Workspace به عنوان برنامه استفاده کنند.

برای DM ها، این فیلد پر نیست.

enum ( PredefinedPermissionSettings )

اختیاری. فقط ورودی تنظیمات مجوز فضا از پیش تعریف شده، ورودی فقط هنگام ایجاد یک فضا. اگر فیلد تنظیم نشده باشد، فضای همکاری ایجاد می شود. پس از ایجاد فضا، تنظیمات در قسمت PermissionSettings پر می شوند.

object ( PermissionSettings )

اختیاری. تنظیمات مجوز فضا برای فضاهای موجود. ورودی برای به‌روزرسانی تنظیمات دقیق مجوز فضا، جایی که تنظیمات مجوز موجود جایگزین می‌شوند. خروجی تنظیمات مجوز فعلی را فهرست می کند.