REST Resource: spaces

منبع: فضا

فضا در Google Chat. فضاها مکالمه‌هایی بین دو یا چند کاربر یا پیام‌های دونفره بین کاربر و برنامه Chat هستند.

نمایش 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,
  "sessionState": enum (SpaceSessionState),
  "sessionEnableTime": string,
  "importModeExpireTime": string,
  "customer": string,

  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
}
فیلدها
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

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

threaded
(deprecated)

boolean

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

displayName

string

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

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

حداکثر ۱۲۸ نویسه را پشتیبانی می‌کند.

externalUserAllowed

boolean

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

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

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

spaceThreadingState

enum (SpaceThreadingState)

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

spaceDetails

object (SpaceDetails)

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

spaceHistoryState

enum (HistoryState)

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

importMode

boolean

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

ایجاد فضا در Import Mode به اصالت‌سنجی کاربر نیاز دارد.

createTime

string (Timestamp format)

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

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

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

lastActiveTime

string (Timestamp format)

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

adminInstalled

boolean

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

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

membershipCount

object (MembershipCount)

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

accessSettings

object (AccessSettings)

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

spaceUri

string

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

sessionState

enum (SpaceSessionState)

فقط خروجی. وضعیت جلسه فضا.

sessionEnableTime

string (Timestamp format)

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

importModeExpireTime

string (Timestamp format)

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

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

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

customer

string

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

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

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

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

enum (PredefinedPermissionSettings)

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

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

permissionSettings

object (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

string

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

تا ۴۰۹۶ نویسه را پشتیبانی می‌کند.

guidelines

string

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

حداکثر ۵٬۰۰۰ نویسه را پشتیبانی می‌کند.

HistoryState

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

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

MembershipCount

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

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

integer

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

joinedGroupCount

integer

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

AccessSettings

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

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

enum (AccessState)

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

audience

string

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

قالب: audiences/{audience}

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

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

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

تنظیم مخاطب هدف به اصالت‌سنجی کاربر نیاز دارد.

accessPermissionSettings

object (AccessPermissionSettings)

اختیاری. به تنظیمات اجازه دسترسی برای فضا بروید.

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

AccessState

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

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

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

ایجاد فضاهای یافتنی به اصالت‌سنجی کاربر نیاز دارد.

AccessPermissionSettings

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

نمایش JSON
{
  "discoverSpaceSetting": {
    object (AccessPermissionSetting)
  },
  "joinSpaceSetting": {
    object (AccessPermissionSetting)
  },
  "viewSpaceMembershipSetting": {
    object (AccessPermissionSetting)
  }
}
فیلدها
discoverSpaceSetting

object (AccessPermissionSetting)

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

joinSpaceSetting

object (AccessPermissionSetting)

اختیاری. تنظیم اجازه دسترسی برای پیوستن به فضا.

viewSpaceMembershipSetting

object (AccessPermissionSetting)

اختیاری. تنظیم اجازه دسترسی برای مشاهده عضویت فضا. هنگام به‌روزرسانی افرادی که می‌توانند عضویت فضا را مشاهده کنند، باید همراه با PermissionSettings.view_space_membership در ماسک به‌روزرسانی و بدنه درخواست مشخص شود. هنگام اعطای دسترسی مشاهده به مخاطب هدف، باید PermissionSettings.view_space_membership را نیز به همه اعضا در همان درخواست اعطا کنید. برای برداشتن مخاطب هدف موجود (برای مثال، برای محدود کردن دسترسی مشاهده فقط به مدیران فضا یا دستیاران مدیر)، AccessPermissionSetting خالی (بدون principals) را مشخص کنید.

AccessPermissionSetting

تنظیم اجازه دسترسی.

نمایش JSON
{
  "principals": [
    {
      object (Principal)
    }
  ]
}
فیلدها
principals[]

object (Principal)

اختیاری. فهرست مرتب‌نشده. مدیران مجاز برای این اجازه.

مدیر

اصلی‌ای که نشان‌دهنده نهادی است که به آن دسترسی اعطا شده است.

نمایش JSON
{

  "audience": {
    object (Audience)
  }
}
فیلدها
نوع اصلی. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
audience

object (Audience)

مخاطب.

پایان فیلدهای متقابلاً انحصاری.

مخاطبان

مخاطب هدف در Google Chat. مخاطب هدف نشان‌دهنده گروهی از کاربران در سازمان Google Workspace است که توسط سرپرست تعریف شده است. مخاطبان هدف برای پیکربندی تنظیمات دسترسی و رؤیت‌پذیری منابع استفاده می‌شوند، مثلاً برای قابل‌شناسایی کردن فضا برای گروه خاصی از کاربران.

برای جزئیات بیشتر، مخاطبان هدف و یافتنی کردن فضا برای مخاطبان هدف را ببینید.

نمایش JSON
{
  "name": string
}
فیلدها
name

string

نام منبع مخاطبان هدف که می‌توانند فضا را کاوش کنند یا به آن بپیوندند. برای جزئیات، به قابل‌یافتن کردن فضا برای مخاطب هدف مراجعه کنید. قالب: audiences/{audience}

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

PredefinedPermissionSettings

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

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

PermissionSettings

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

برای تنظیم کردن تنظیمات اجازه هنگام ایجاد فضا، فیلد 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)
  },
  "viewSpaceMembership": {
    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)

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

viewSpaceMembership

object (PermissionSetting)

اختیاری. تنظیمات مربوط به مشاهده عضویت فضا. هنگام به‌روزرسانی افرادی که می‌توانند عضویت فضا را مشاهده کنند، باید همراه با AccessPermissionSettings.view_space_membership_setting در ماسک به‌روزرسانی و بدنه درخواست مشخص شود. هنگام محدود کردن دسترسی مشاهده به نقش‌های خاص (برای مثال، فقط مدیران فضا یا دستیاران مدیر)، اجازه‌های نقش موردنظر را در اینجا مشخص کنید و یک AccessPermissionSettings.view_space_membership_setting خالی در همان درخواست ارائه دهید. اگر مخاطب هدف در AccessPermissionSettings.view_space_membership_setting پیکربندی شده باشد، این تنظیم باید به همه اعضا اعطا شود.

PermissionSetting

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

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

boolean

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

membersAllowed

boolean

اختیاری. آیا اعضای پایه فضا (ROLE_MEMBER) این اجازه را دارند.

assistantManagersAllowed

boolean

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

SpaceSessionState

وضعیت جلسه فضا.

شمارشی‌ها
SPACE_SESSION_STATE_UNSPECIFIED نامشخص. استفاده نشود.
NOT_SUPPORTED فضا از جلسه پشتیبانی نمی‌کند.
THREAD «فضا» از جلسه براساس رشته‌ها پشتیبانی می‌کند.

روش‌ها

completeImport

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

create

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

delete

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

findDirectMessage

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

findGroupChats

همه فضاهای دارای spaceType == GROUP_CHAT را که عضویت‌های انسانی آن‌ها دقیقاً شامل کاربر تماس‌گیرنده و کاربران مشخص‌شده در FindGroupChatsRequest.users است برمی‌گرداند.

get

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

list

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

patch

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

setup

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