- منبع: فضا
- روشها
منبع: فضا
فضا در Google Chat. فضاها مکالمههایی بین دو یا چند کاربر یا پیامهای دونفره بین کاربر و برنامه Chat هستند.
| نمایش JSON |
|---|
{ "name": string, "type": enum ( |
| فیلدها | |
|---|---|
name |
شناسه. نام منبع فضا. قالب: که |
type |
فقط خروجی. منسوخشده: درعوض از |
spaceType |
اختیاری. نوع فضا. هنگام ایجاد فضا یا بهروزرسانی نوع فضا الزامی است. برونداد فقط برای استفادههای دیگر. |
singleUserBotDm |
اختیاری. اینکه آیا فضا یک پیام مستقیم بین برنامه Chat و یک انسان است یا نه. |
threaded |
فقط خروجی. منسوخشده: درعوض از |
displayName |
اختیاری. نام نمایشی فضا. هنگام ایجاد فضا با برای پیامهای مستقیم، این فیلد ممکن است خالی باشد. حداکثر ۱۲۸ نویسه را پشتیبانی میکند. |
externalUserAllowed |
اختیاری. تغییرناپذیر. اینکه آیا این فضا به هر کاربر Google Chat اجازه میدهد عضو شود یا نه. ورودی هنگام ایجاد فضا در سازمان Google Workspace. هنگام ایجاد فضا در شرایط زیر، این فیلد را حذف کنید:
برای فضاهای موجود، این فیلد فقط خروجی است. |
spaceThreadingState |
فقط خروجی. وضعیت رشتهبندی در فضای Chat. |
spaceDetails |
اختیاری. جزئیات مربوط به فضا ازجمله شرح و قوانین. |
spaceHistoryState |
اختیاری. وضعیت سابقه پیام برای پیامها و رشتهها در این فضا. |
importMode |
اختیاری. اینکه این فضا در ایجاد فضا در |
createTime |
اختیاری. تغییرناپذیر. برای فضاهای ایجادشده در Chat، زمان ایجاد فضا. این فیلد فقط خروجی است، بهجز زمانی که در فضاهای حالت وارد کردن استفاده میشود. برای فضاهای حالت وارد کردن، این فیلد را روی مُهر زمان تاریخی که فضا در منبع ایجاد شده است تنظیم کنید تا زمان ایجاد اصلی حفظ شود. فقط زمانی در خروجی درج میشود که |
lastActiveTime |
فقط خروجی. مُهر زمان آخرین پیام در فضا. |
adminInstalled |
فقط خروجی. برای فضاهای پیام مستقیم (DM) با برنامه Chat، اینکه فضا توسط سرپرست Google Workspace ایجاد شده است یا نه. سرپرستان میتوانند ازطرف کاربران سازمانشان، پیام مستقیم با برنامه Chat را نصب و راهاندازی کنند. برای پشتیبانی از نصب سرپرست، برنامه Chat شما باید دارای پیامرسانی مستقیم باشد. |
membershipCount |
فقط خروجی. تعداد عضویتهای پیوسته گروهبندیشده براساس نوع عضو. وقتی |
accessSettings |
اختیاری. تنظیم دسترسی فضا را مشخص میکند. فقط زمانی درج میشود که |
spaceUri |
فقط خروجی. شناسه منبع یکسان برای دسترسی کاربر به فضا. |
sessionState |
فقط خروجی. وضعیت جلسه فضا. |
sessionEnableTime |
فقط خروجی. مُهر زمان که در آن وضعیت پشتیبانی جلسه فضا به پشتیبانیشده تبدیل میشود. اگر فضا پشتیبانی از جلسه را فعال نکرده باشد، تنظیم نشده است. |
importModeExpireTime |
فقط خروجی. زمانی که اگر فضا در حالت وارد کردن باقی بماند، سیستم آن را بهطور خودکار حذف میکند. هر فضایی که در حالت وارد کردن ایجاد شده است باید قبلاز این زمان انقضا بااستفاده از این فیلد فقط برای فضاهایی که با حالت وارد کردن ایجاد شدهاند درج میشود. |
customer |
اختیاری. تغییرناپذیر. شناسه مشتری دامنه فضا. فقط هنگام ایجاد فضا با اصالتسنجی برنامه لازم است و در قالب این فیلد برای پیامهای مستقیم (DM) یا زمانی که فضا توسط کاربران غیر Google Workspace ایجاد شده باشد، پر نمیشود. |
تنظیمات اجازه فضا را نشان میدهد. فقط زمانی درج میشود که space_type برابر با SPACE باشد. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد: |
|
predefinedPermissionSettings |
اختیاری. فقط ورودی. تنظیمات ازپیش تعریفشده اجازه فضا، فقط هنگام ایجاد فضا وارد میشود. اگر این فیلد تنظیم نشده باشد، فضای مشارکتی ایجاد میشود. بعداز ایجاد فضا، تنظیمات در فیلد تنظیم تنظیمات اجازه ازپیش تعریفشده از موارد زیر پشتیبانی میکند:
|
permissionSettings |
اختیاری. تنظیمات اجازه فضا برای فضاهای موجود. ورودی برای بهروزرسانی تنظیمات دقیق اجازه فضا، که در آن تنظیمات اجازه موجود جایگزین میشود. خروجی تنظیمات اجازه فعلی را فهرست میکند. خواندن و بهروزرسانی تنظیمات اجازه از موارد زیر پشتیبانی میکند:
|
| پایان فیلدهای متقابلاً انحصاری. | |
نوع
منسوخشده: درعوض از SpaceType استفاده کنید.
| شمارشیها | |
|---|---|
TYPE_UNSPECIFIED |
رزروشده. |
ROOM |
مکالمه بین دو یا چند انسان. |
DM |
پیام مستقیم یکبهیک بین انسان و برنامه Chat، که در آن همه پیامها مسطح هستند. توجه داشته باشید که این شامل پیامهای مستقیم بین دو انسان نمیشود. |
SpaceType
نوع فضا. هنگام ایجاد یا بهروزرسانی فضا الزامی است. برونداد فقط برای استفادههای دیگر.
| شمارشیها | |
|---|---|
SPACE_TYPE_UNSPECIFIED |
رزروشده. |
SPACE |
مکانی که افراد در آن پیام ارسال میکنند، فایل همرسانی میکنند، و مشارکت میکنند. SPACE میتواند شامل برنامههای Chat باشد. |
GROUP_CHAT |
مکالمههای گروهی بین ۳ نفر یا بیشتر. GROUP_CHAT میتواند شامل برنامههای Chat باشد. |
DIRECT_MESSAGE |
پیامهای دونفره بین دو انسان یا یک انسان و برنامه Chat. |
SpaceThreadingState
نوع وضعیت رشتهای را در فضای Chat مشخص میکند.
| شمارشیها | |
|---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
رزروشده. |
THREADED_MESSAGES |
فضاهایی که از رشته پیام پشتیبانی میکنند. وقتی کاربران به پیامی پاسخ میدهند، میتوانند در رشته پاسخ دهند که باعث میشود پاسخشان در بافت پیام اصلی باقی بماند. |
GROUPED_MESSAGES |
فضاهای نامگذاریشدهای که مکالمه در آنها براساس موضوع سازماندهی شده است. موضوعات و پاسخهای آنها باهم گروهبندی میشوند. |
UNTHREADED_MESSAGES |
فضاهایی که از رشتهای کردن پیام پشتیبانی نمیکنند. این وضعیت رشتهسازی فضا فقط برای موارد خاصی استفاده میشود، ازجمله:
|
SpaceDetails
جزئیات مربوط به فضا ازجمله شرح و قوانین.
| نمایش JSON |
|---|
{ "description": string, "guidelines": string } |
| فیلدها | |
|---|---|
description |
اختیاری. شرح فضا. برای مثال، موضوع بحث، هدف کاربردی، یا شرکتکنندگان فضا را شرح دهید. تا ۴۰۹۶ نویسه را پشتیبانی میکند. |
guidelines |
اختیاری. قوانین، انتظارات، و آداب فضا. حداکثر ۵٬۰۰۰ نویسه را پشتیبانی میکند. |
HistoryState
وضعیت سابقه برای پیامها و فضاها. مشخص میکند پیامها و رشتههای مکالمه تا چه مدت پساز ایجاد نگهداری شوند.
| شمارشیها | |
|---|---|
HISTORY_STATE_UNSPECIFIED |
مقدار پیشفرض. استفاده نکنید. |
HISTORY_OFF |
سابقه خاموش است. پیامها و رشتهها بهمدت ۲۴ ساعت نگهداری میشوند. |
HISTORY_ON |
سابقه روشن است. قوانین نگهداری Vault سازمان مشخص میکند که پیامها و رشتهها تا چه مدت نگهداری شوند. |
MembershipCount
نشاندهنده تعداد عضویتهای یک فضا است که در دستههایی گروهبندی شدهاند.
| نمایش JSON |
|---|
{ "joinedDirectHumanUserCount": integer, "joinedGroupCount": integer } |
| فیلدها | |
|---|---|
joinedDirectHumanUserCount |
فقط خروجی. تعداد کاربران انسانی که مستقیماً به فضا پیوستهاند، بدون احتساب کاربرانی که با داشتن عضویت در گروه پیوستهشده به فضا پیوستهاند. |
joinedGroupCount |
فقط خروجی. تعداد همه گروههایی که مستقیماً به فضا پیوستهاند. |
AccessSettings
تنظیم دسترسی فضا را نشان میدهد.
| نمایش JSON |
|---|
{ "accessState": enum ( |
| فیلدها | |
|---|---|
accessState |
فقط خروجی. وضعیت دسترسی فضا را نشان میدهد. |
audience |
اختیاری. نام منبع مخاطبان هدف که میتوانند فضا را کاوش کنند، به فضا بپیوندند، و پیامهای فضا را پیشدید کنند. اگر تنظیم نشده باشد، فقط کاربران یا «گروههای Google» که بهطور جداگانه به فضا دعوت یا اضافه شدهاند میتوانند به آن دسترسی داشته باشند. برای جزئیات، به قابلیافتن کردن فضا برای مخاطب هدف مراجعه کنید. قالب: برای استفاده از مخاطب هدف پیشفرض برای سازمان Google Workspace، روی خواندن پشتیبانیهای مخاطب هدف:
این فیلد هنگام استفاده از دامنه تنظیم مخاطب هدف به اصالتسنجی کاربر نیاز دارد. |
accessPermissionSettings |
اختیاری. به تنظیمات اجازه دسترسی برای فضا بروید. برای تنظیم مخاطب هدف هنگام ایجاد فضا، فیلد |
AccessState
وضعیت دسترسی به فضا را نشان میدهد.
| شمارشیها | |
|---|---|
ACCESS_STATE_UNSPECIFIED |
وضعیت دسترسی در این میانای برنامهسازی کاربردی نامشخص است یا پشتیبانی نمیشود. |
PRIVATE |
فقط کاربران یا «گروههای Google» که بهطور جداگانه توسط کاربران دیگر یا سرپرستان Google Workspace اضافه یا دعوت شدهاند میتوانند فضا را کاوش کنند و به آن دسترسی داشته باشند. |
DISCOVERABLE |
مدیر فضا به مخاطب هدف اجازه دسترسی به فضا را داده است. کاربران یا «گروههای Google» که بهطور جداگانه به فضا اضافه یا دعوت شدهاند نیز میتوانند فضا را پیدا کنند و به آن دسترسی داشته باشند. برای کسب اطلاعات بیشتر، یافتنی کردن فضا برای کاربران خاص را ببینید. ایجاد فضاهای یافتنی به اصالتسنجی کاربر نیاز دارد. |
AccessPermissionSettings
تنظیمات اجازه دسترسی برای فضا.
| نمایش JSON |
|---|
{ "discoverSpaceSetting": { object ( |
| فیلدها | |
|---|---|
discoverSpaceSetting |
اختیاری. تنظیم اجازه دسترسی برای کاوش فضا. |
joinSpaceSetting |
اختیاری. تنظیم اجازه دسترسی برای پیوستن به فضا. |
viewSpaceMembershipSetting |
اختیاری. تنظیم اجازه دسترسی برای مشاهده عضویت فضا. هنگام بهروزرسانی افرادی که میتوانند عضویت فضا را مشاهده کنند، باید همراه با |
AccessPermissionSetting
تنظیم اجازه دسترسی.
| نمایش JSON |
|---|
{
"principals": [
{
object ( |
| فیلدها | |
|---|---|
principals[] |
اختیاری. فهرست مرتبنشده. مدیران مجاز برای این اجازه. |
مدیر
اصلیای که نشاندهنده نهادی است که به آن دسترسی اعطا شده است.
| نمایش JSON |
|---|
{
"audience": {
object ( |
| فیلدها | |
|---|---|
| نوع اصلی. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد: | |
audience |
مخاطب. |
| پایان فیلدهای متقابلاً انحصاری. | |
مخاطبان
مخاطب هدف در Google Chat. مخاطب هدف نشاندهنده گروهی از کاربران در سازمان Google Workspace است که توسط سرپرست تعریف شده است. مخاطبان هدف برای پیکربندی تنظیمات دسترسی و رؤیتپذیری منابع استفاده میشوند، مثلاً برای قابلشناسایی کردن فضا برای گروه خاصی از کاربران.
برای جزئیات بیشتر، مخاطبان هدف و یافتنی کردن فضا برای مخاطبان هدف را ببینید.
| نمایش JSON |
|---|
{ "name": string } |
| فیلدها | |
|---|---|
name |
نام منبع مخاطبان هدف که میتوانند فضا را کاوش کنند یا به آن بپیوندند. برای جزئیات، به قابلیافتن کردن فضا برای مخاطب هدف مراجعه کنید. قالب: برای استفاده از مخاطب هدف پیشفرض برای سازمان Google Workspace، روی |
PredefinedPermissionSettings
تنظیمات اجازه ازپیشتعریفشده که فقط هنگام ایجاد فضای نامگذاریشده میتوانید مشخص کنید. ممکن است در آینده تنظیمات بیشتری اضافه شود. برای جزئیات مربوط به تنظیمات اجازه برای فضاهای نامگذاریشده، آشنایی با فضاها را ببینید.
| شمارشیها | |
|---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
نامشخص. استفاده نشود. |
COLLABORATION_SPACE |
تنظیماتی برای تبدیل فضا به فضای مشارکتی که همه اعضا بتوانند در آن پیام پست کنند. |
ANNOUNCEMENT_SPACE |
تنظیماتی برای تبدیل فضا به فضای اعلامیه که در آن فقط مدیران فضا میتوانند پیام پست کنند. |
PermissionSettings
تنظیمات اجازه که میتوانید هنگام بهروزرسانی فضای نامدار موجود مشخص کنید.
برای تنظیم کردن تنظیمات اجازه هنگام ایجاد فضا، فیلد PredefinedPermissionSettings را در درخواستتان مشخص کنید.
| نمایش JSON |
|---|
{ "manageMembersAndGroups": { object ( |
| فیلدها | |
|---|---|
manageMembersAndGroups |
اختیاری. تنظیمات مدیریت اعضا و گروهها در فضا. |
modifySpaceDetails |
اختیاری. تنظیمات بهروزرسانی نام، چهرهنما، شرح، و دستورالعملهای فضا. |
toggleHistory |
اختیاری. تنظیم برای روشن و خاموش کردن سابقه فضا. |
useAtMentionAll |
اختیاری. تنظیم استفاده از all @در فضا. |
manageApps |
اختیاری. تنظیمات مدیریت برنامهها در فضا. |
manageWebhooks |
اختیاری. تنظیمات مدیریت وبقلابها در فضا. |
postMessages |
فقط خروجی. تنظیمات پست کردن پیام در فضا. |
replyMessages |
اختیاری. تنظیمات پاسخ دادن به پیامها در فضا. |
viewSpaceMembership |
اختیاری. تنظیمات مربوط به مشاهده عضویت فضا. هنگام بهروزرسانی افرادی که میتوانند عضویت فضا را مشاهده کنند، باید همراه با |
PermissionSetting
تنظیم اجازه فضا را نشان میدهد.
| نمایش JSON |
|---|
{ "managersAllowed": boolean, "membersAllowed": boolean, "assistantManagersAllowed": boolean } |
| فیلدها | |
|---|---|
managersAllowed |
اختیاری. اینکه آیا مالکان فضا ( |
membersAllowed |
اختیاری. آیا اعضای پایه فضا ( |
assistantManagersAllowed |
اختیاری. آیا مدیران فضا |
SpaceSessionState
وضعیت جلسه فضا.
| شمارشیها | |
|---|---|
SPACE_SESSION_STATE_UNSPECIFIED |
نامشخص. استفاده نشود. |
NOT_SUPPORTED |
فضا از جلسه پشتیبانی نمیکند. |
THREAD |
«فضا» از جلسه براساس رشتهها پشتیبانی میکند. |
روشها |
|
|---|---|
|
فرایند وارد کردن را برای فضای مشخصشده تکمیل میکند و آن را برای کاربران نمایان میکند. |
|
فضایی ایجاد میکند. |
|
فضای نامگذاریشده را حذف میکند. |
|
پیام مستقیم موجود با کاربر مشخصشده را برمیگرداند. |
|
همه فضاهای دارای spaceType == GROUP_CHAT را که عضویتهای انسانی آنها دقیقاً شامل کاربر تماسگیرنده و کاربران مشخصشده در FindGroupChatsRequest.users است برمیگرداند. |
|
جزئیات مربوط به فضا را برمیگرداند. |
|
فهرست فضاهایی که تماسگیرنده عضو آنها است. |
|
فضایی را بهروز میکند. |
|
فهرستی از فضاهای موجود در سازمان Google Workspace را برمیگرداند. |
|
فضایی ایجاد میکند و کاربران مشخصشده را به آن اضافه میکند. |