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,
  "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.
}
فیلدها
name

string

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

قالب: spaces/{space}

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

type
(deprecated)

enum ( Type )

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

space Type

enum ( SpaceType )

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

single User Bot Dm

boolean

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

threaded
(deprecated)

boolean

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

display Name

string

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

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

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

external User Allowed

boolean

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

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

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

space Threading State

enum ( SpaceThreadingState )

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

space Details

object ( SpaceDetails )

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

space History State

enum ( HistoryState )

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

import Mode

boolean

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

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

create Time

string ( Timestamp format)

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

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

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

last Active Time

string ( Timestamp format)

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

admin Installed

boolean

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

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

membership Count

object ( MembershipCount )

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

access Settings

object ( AccessSettings )

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

space Uri

string

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

customer

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 ها، این فیلد پر نیست.

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

نیاز به احراز هویت کاربر دارد. space_permission_settings فقط می تواند یکی از موارد زیر باشد:

predefined Permission Settings

enum ( PredefinedPermissionSettings )

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

permission Settings

object ( PermissionSettings )

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

تایپ کنید

منسوخ شده: به جای آن از 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 سازمان، مدت زمان نگهداری پیام ها و رشته ها را مشخص می کند.

تعداد عضویت

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

نمایندگی JSON 
{
  "joinedDirectHumanUserCount": integer,
  "joinedGroupCount": integer
}
فیلدها
joined Direct Human User Count

integer

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

joined Group Count

integer

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

AccessSettings

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

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

enum ( AccessState )

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

audience

string

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

قالب: audiences/{audience}

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

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

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

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

AccessState

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

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

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

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

PredefinedPermissionSettings

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

Enums
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)
  }
}
فیلدها
manage Members And Groups

object ( PermissionSetting )

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

modify Space Details

object ( PermissionSetting )

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

toggle History

object ( PermissionSetting )

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

use At Mention All

object ( PermissionSetting )

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

manage Apps

object ( PermissionSetting )

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

manage Webhooks

object ( PermissionSetting )

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

post Messages

object ( PermissionSetting )

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

reply Messages

object ( PermissionSetting )

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

PermissionSetting

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

نمایندگی JSON 
{
  "managersAllowed": boolean,
  "membersAllowed": boolean
}
فیلدها
managers Allowed

boolean

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

members Allowed

boolean

اختیاری. آیا اعضای غیر مدیر این مجوز را دارند.

روش ها

complete Import

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

create

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

delete

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

find Direct Message

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

get

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

list

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

patch

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

setup

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