REST Resource: spaces

منبع: فضا

یک فاصله در گوگل چت. فاصله‌ها مکالمات بین دو یا چند کاربر یا پیام‌های یک به یک بین یک کاربر و یک برنامه چت هستند.

نمایش 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,
  "lastActiveTime": string,
  "adminInstalled": boolean,
  "membershipCount": {
    object (MembershipCount)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string,
  "importModeExpireTime": 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.
}
فیلدها
name

string

شناسه. نام منبع فضا.

قالب: spaces/{space}

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

type
(deprecated)

enum ( Type )

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

spaceType

enum ( SpaceType )

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

singleUserBotDm

boolean

اختیاری. اینکه آیا این فضا، یک پیام مستقیم بین یک برنامه چت و یک انسان است یا خیر.

threaded
(deprecated)

boolean

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

displayName

string

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

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

تا ۱۲۸ کاراکتر را پشتیبانی می‌کند.

externalUserAllowed

boolean

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

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

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

spaceThreadingState

enum ( SpaceThreadingState )

فقط خروجی. وضعیت threading در فضای چت.

spaceDetails

object ( SpaceDetails )

اختیاری. جزئیات مربوط به فضا شامل توضیحات و قوانین.

spaceHistoryState

enum ( HistoryState )

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

importMode

boolean

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

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

createTime

string ( Timestamp format)

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

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

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

lastActiveTime

string ( Timestamp format)

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

adminInstalled

boolean

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

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

membershipCount

object ( MembershipCount )

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

accessSettings

object ( AccessSettings )

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

spaceUri

string

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

importModeExpireTime

string ( Timestamp format)

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

هر فضای ایجاد شده در حالت import باید قبل از انقضای این زمان با استفاده از spaces.completeImport از این حالت خارج شود.

این فیلد فقط برای فضاهایی که با حالت واردات ایجاد شده‌اند، پر می‌شود.

customer

string

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

در قالب customers/{customer} ، که در آن customer id منبع مشتری Admin SDK است. برنامه‌های خصوصی همچنین می‌توانند از نام مستعار customers/my_customer برای ایجاد فضا در همان سازمان Google Workspace به عنوان برنامه استفاده کنند.

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

فیلد اتحادیه space_permission_settings . تنظیمات مجوز یک فضا را نشان می‌دهد. فقط زمانی پر می‌شود که space_type SPACE باشد. space_permission_settings فقط می‌تواند یکی از موارد زیر باشد:
predefinedPermissionSettings

enum ( PredefinedPermissionSettings )

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

تنظیم تنظیمات مجوز از پیش تعریف شده پشتیبانی می‌کند:

permissionSettings

object ( PermissionSettings )

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

تنظیمات مجوز خواندن و به‌روزرسانی از موارد زیر پشتیبانی می‌کند:

نوع

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

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

نوع فضا

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

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

حالت ریسمانی فضا

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

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

جزئیات فضا

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

نمایش JSON 
{
  "description": string,
  "guidelines": string
}
فیلدها
description

string

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

تا ۱۵۰ کاراکتر را پشتیبانی می‌کند.

guidelines

string

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

پشتیبانی از حداکثر ۵۰۰۰ کاراکتر.

تاریخچه ایالت

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

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

تعداد عضویت

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

نمایش JSON 
{
  "joinedDirectHumanUserCount": integer,
  "joinedGroupCount": integer
}
فیلدها
joinedDirectHumanUserCount

integer

فقط خروجی. تعداد کاربران انسانی که مستقیماً به فضا پیوسته‌اند، بدون احتساب کاربرانی که با عضویت در یک گروه عضو شده‌اند.

joinedGroupCount

integer

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

تنظیمات دسترسی

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

نمایش JSON 
{
  "accessState": enum (AccessState),
  "audience": string
}
فیلدها
accessState

enum ( AccessState )

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

audience

string

اختیاری. نام منبع مخاطب هدف که می‌تواند فضا را کشف کند، به فضا بپیوندد و پیام‌های موجود در فضا را پیش‌نمایش کند. در صورت تنظیم نشدن، فقط کاربران یا گروه‌های گوگل که به صورت جداگانه دعوت یا به فضا اضافه شده‌اند می‌توانند به آن دسترسی داشته باشند. برای جزئیات بیشتر، به «قابل کشف کردن یک فضا برای مخاطب هدف» مراجعه کنید.

قالب: audiences/{audience}

برای استفاده از مخاطب هدف پیش‌فرض برای سازمان‌دهی Google Workspace، audiences/default را تنظیم کنید.

خواندن مخاطب هدف از موارد زیر پشتیبانی می‌کند:

این فیلد هنگام استفاده از دامنه chat.bot با احراز هویت برنامه، پر نمی‌شود.

تعیین مخاطب هدف نیاز به احراز هویت کاربر دارد.

وضعیت دسترسی

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

انوم‌ها
ACCESS_STATE_UNSPECIFIED وضعیت دسترسی ناشناخته است یا در این API پشتیبانی نمی‌شود.
PRIVATE فقط کاربران یا گروه‌های گوگل که به‌صورت جداگانه توسط سایر کاربران یا مدیران Google Workspace اضافه یا دعوت شده‌اند، می‌توانند این فضا را کشف و به آن دسترسی داشته باشند.
DISCOVERABLE

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

ایجاد فضاهای قابل کشف نیاز به احراز هویت کاربر دارد.

تنظیمات دسترسی از پیش تعریف شده

تنظیمات مجوز از پیش تعریف‌شده که فقط می‌توانید هنگام ایجاد یک فضای نامگذاری‌شده مشخص کنید. ممکن است تنظیمات بیشتری در آینده اضافه شود. برای جزئیات بیشتر در مورد تنظیمات مجوز برای فضاهای نامگذاری‌شده، به «درباره فضاها بیشتر بدانید» مراجعه کنید.

انوم‌ها
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED نامشخص. استفاده نکنید.
COLLABORATION_SPACE تنظیم برای تبدیل فضا به یک فضای همکاری که در آن همه اعضا بتوانند پیام ارسال کنند.
ANNOUNCEMENT_SPACE تنظیم برای تبدیل این فضا به یک فضای اعلانات که فقط مدیران فضا بتوانند در آن پیام ارسال کنند.

تنظیمات مجوز

تنظیمات مجوزی که می‌توانید هنگام به‌روزرسانی یک فضای نامگذاری‌شده‌ی موجود مشخص کنید.

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

نمایش JSON 
{
  "manageMembersAndGroups": {
    object (PermissionSetting)
  },
  "modifySpaceDetails": {
    object (PermissionSetting)
  },
  "toggleHistory": {
    object (PermissionSetting)
  },
  "useAtMentionAll": {
    object (PermissionSetting)
  },
  "manageApps": {
    object (PermissionSetting)
  },
  "manageWebhooks": {
    object (PermissionSetting)
  },
  "postMessages": {
    object (PermissionSetting)
  },
  "replyMessages": {
    object (PermissionSetting)
  }
}
فیلدها
manageMembersAndGroups

object ( PermissionSetting )

اختیاری. تنظیم برای مدیریت اعضا و گروه‌ها در یک فضا.

modifySpaceDetails

object ( PermissionSetting )

اختیاری. تنظیم برای به‌روزرسانی نام فضا، آواتار، توضیحات و دستورالعمل‌ها.

toggleHistory

object ( PermissionSetting )

اختیاری. تنظیم برای فعال و غیرفعال کردن تاریخچه فضا.

useAtMentionAll

object ( PermissionSetting )

اختیاری. تنظیم برای استفاده از @all در یک فاصله.

manageApps

object ( PermissionSetting )

اختیاری. تنظیم برای مدیریت برنامه‌ها در یک فضا.

manageWebhooks

object ( PermissionSetting )

اختیاری. تنظیم برای مدیریت وب‌هوک‌ها در یک فضا.

postMessages

object ( PermissionSetting )

فقط خروجی. تنظیم برای ارسال پیام در یک فضا.

replyMessages

object ( PermissionSetting )

اختیاری. تنظیم برای پاسخ دادن به پیام‌ها در یک فضا.

تنظیمات مجوز

نشان‌دهنده‌ی تنظیمات مجوز فضا است.

نمایش JSON 
{
  "managersAllowed": boolean,
  "membersAllowed": boolean,
  "assistantManagersAllowed": boolean
}
فیلدها
managersAllowed

boolean

اختیاری. اینکه آیا مالکان فضا ( ROLE_MANAGER ) این مجوز را دارند یا خیر.

membersAllowed

boolean

اختیاری. اینکه آیا اعضای فاصله پایه ( ROLE_MEMBER ) این مجوز را دارند یا خیر.

assistantManagersAllowed

boolean

اختیاری. اینکه آیا مدیران فضا ROLE_ASSISTANT_MANAGER این مجوز را دارند یا خیر.

روش‌ها

completeImport

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

create

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

delete

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

findDirectMessage

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

get

 جزئیات مربوط به یک فاصله (space) را برمی‌گرداند.

list

 فضاهایی را که فراخواننده عضو آنهاست، فهرست می‌کند.

patch

 یک فضا را به‌روزرسانی می‌کند.
بر اساس جستجوی مدیر، فهرستی از فضاهای موجود در یک سازمان Google Workspace را برمی‌گرداند.

setup

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