REST Resource: spaces

منبع: فضا

فضایی در چت گوگل. Spaces مکالمه بین دو یا چند کاربر یا پیام های 1:1 بین یک کاربر و یک برنامه چت است.

نمایندگی JSON
{
  "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,
  "adminInstalled": boolean,
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string
}
زمینه های
name

string

نام منبع فضا

قالب: spaces/{space}

type
(deprecated)

enum ( Type )

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

spaceType

enum ( SpaceType )

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

singleUserBotDm

boolean

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

threaded
(deprecated)

boolean

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

displayName

string

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

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

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

externalUserAllowed

boolean

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

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

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

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

spaceThreadingState

enum ( SpaceThreadingState )

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

spaceDetails

object ( SpaceDetails )

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

spaceHistoryState

enum ( HistoryState )

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

importMode

boolean

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

createTime

string ( Timestamp format)

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

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

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

adminInstalled

boolean

فقط خروجی آیا برنامه Chat توسط سرپرست Google Workspace نصب شده است یا خیر. مدیران می توانند یک برنامه چت را برای دامنه، واحد سازمانی یا گروهی از کاربران خود نصب کنند.

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

accessSettings

object ( AccessSettings )

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

spaceUri

string

فقط خروجی URI فضا

تایپ کنید

منسوخ شده: به جای آن از SpaceType استفاده کنید.

Enums
TYPE_UNSPECIFIED رزرو شده است.
ROOM مکالمات بین دو یا چند انسان.
DM 1:1 پیام مستقیم بین یک انسان و یک برنامه چت، که در آن همه پیام ها مسطح هستند. توجه داشته باشید که این شامل پیام های مستقیم بین دو انسان نمی شود.

SpaceType

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

Enums
SPACE_TYPE_UNSPECIFIED رزرو شده است.
SPACE مکانی که در آن افراد پیام می فرستند، فایل ها را به اشتراک می گذارند و با هم همکاری می کنند. یک SPACE می تواند شامل برنامه های چت باشد.
GROUP_CHAT مکالمات گروهی بین 3 نفر یا بیشتر. یک GROUP_CHAT می‌تواند شامل برنامه‌های چت باشد.
DIRECT_MESSAGE پیام های 1:1 بین دو انسان یا یک انسان و یک برنامه چت.

SpaceThreadingState

نوع حالت threading را در فضای چت مشخص می کند.

Enums
SPACE_THREADING_STATE_UNSPECIFIED رزرو شده است.
THREADED_MESSAGES فضاهای نامگذاری شده که از رشته های پیام پشتیبانی می کنند. هنگامی که کاربران به یک پیام پاسخ می‌دهند، می‌توانند در درون رشته پاسخ دهند، که پاسخ آنها را در متن پیام اصلی نگه می‌دارد.
GROUPED_MESSAGES فضاهای نامگذاری شده که مکالمه بر اساس موضوع سازماندهی می شود. موضوعات و پاسخ های آنها با هم گروه بندی می شوند.
UNTHREADED_MESSAGES پیام های مستقیم (DM) بین دو نفر و مکالمات گروهی بین 3 نفر یا بیشتر.

جزئیات فضایی

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

نمایندگی JSON
{
  "description": string,
  "guidelines": string
}
زمینه های
description

string

اختیاری. توضیحاتی در مورد فضا به عنوان مثال، موضوع بحث فضا، هدف عملکردی یا شرکت کنندگان را شرح دهید.

تا 150 کاراکتر را پشتیبانی می کند.

guidelines

string

اختیاری. قوانین، انتظارات و آداب فضا.

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

History State

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

Enums
HISTORY_STATE_UNSPECIFIED مقدار پیش فرض. استفاده نکن.
HISTORY_OFF تاریخچه خاموش است. پیام ها و موضوعات به مدت 24 ساعت نگهداری می شوند .
HISTORY_ON تاریخ روشن است. قوانین نگهداری Vault سازمان، مدت زمان نگهداری پیام ها و رشته ها را مشخص می کند.

AccessSettings

نشان دهنده تنظیمات دسترسی به فضا است.

نمایندگی JSON
{
  "accessState": enum (AccessState),
  "audience": string
}
زمینه های
accessState

enum ( AccessState )

فقط خروجی وضعیت دسترسی فضا را نشان می دهد.

audience

string

اختیاری. نام منبع مخاطب هدف که می تواند به فضا دسترسی داشته باشد. این فیلد را روی یک شناسه مخاطب هدف معتبر تنظیم کنید تا فضا قابل کشف باشد یا از audiences/default برای تنظیم فضا با تنظیمات دسترسی پیش فرض در Admin Console استفاده کنید، برای کسب اطلاعات بیشتر، به ایجاد فضای قابل کشف برای مخاطب هدف مراجعه کنید. این فیلد را برای محدود کردن فضا از حالت تنظیم خارج کنید. فقط زمانی پر می شود که فضا قابل کشف باشد. قالب: audiences/{audience} ، audiences/default می‌توانند به عنوان نام مستعار تنظیمات اشتراک‌گذاری گپ پیش‌فرض استفاده شوند.

AccessState

وضعیت دسترسی فضا را نشان می دهد.

Enums
ACCESS_STATE_UNSPECIFIED وضعیت دسترسی ناشناخته است یا در این API پشتیبانی نمی شود.
PRIVATE فضا توسط اعضا یا گروه های اضافه شده یا دعوت شده قابل کشف است.
DISCOVERABLE فضا توسط مخاطبان هدف انتخاب شده و همچنین اعضا یا گروه های اضافه شده یا دعوت شده قابل کشف است.

مواد و روش ها

completeImport

 فرآیند واردات فضای مشخص شده را تکمیل می کند و آن را برای کاربران قابل مشاهده می کند.

create

 فضایی با نام ایجاد می کند.

delete

 فضای نامگذاری شده را حذف می کند.

findDirectMessage

 پیام مستقیم موجود با کاربر مشخص شده را برمی گرداند.

get

 جزئیات یک فضا را برمی‌گرداند.

list

 فضاهایی را که تماس گیرنده عضوی از آنها است را فهرست می کند.

patch

 یک فضا را به روز می کند.

setup

 فضایی ایجاد می کند و کاربران مشخصی را به آن اضافه می کند.