منبع: فضا
فضایی در چت گوگل. Spaces مکالمه بین دو یا چند کاربر یا پیام های 1:1 بین یک کاربر و یک برنامه چت است.
نمایندگی JSON |
---|
{ "name": string, "type": enum ( |
فیلدها | |
---|---|
name | شناسه. نام منبع فضا قالب: جایی که |
type | فقط خروجی منسوخ شده: به جای آن از |
space Type | اختیاری. نوع فضا. هنگام ایجاد یک فضا یا به روز رسانی نوع فضای یک فضا مورد نیاز است. خروجی فقط برای استفاده های دیگر. |
single User Bot Dm | اختیاری. این که آیا فضای یک DM بین یک برنامه چت و یک انسان مجرد است. |
threaded | فقط خروجی منسوخ شده: به جای آن از |
display Name | اختیاری. نام نمایشی فضا هنگام ایجاد فضایی با برای پیام های مستقیم، این قسمت ممکن است خالی باشد. پشتیبانی از 128 کاراکتر |
external User Allowed | اختیاری. تغییرناپذیر. آیا این فضا به هر کاربر گپ Google اجازه عضویت می دهد یا خیر. ورودی هنگام ایجاد یک فضا در سازمان Google Workspace. هنگام ایجاد فضا در شرایط زیر این فیلد را حذف کنید:
برای فضاهای موجود، این فیلد فقط خروجی است. |
space Threading State | فقط خروجی حالت رشته در فضای چت. |
space Details | اختیاری. جزئیات در مورد فضا از جمله توضیحات و قوانین. |
space History State | اختیاری. وضعیت تاریخچه پیام برای پیام ها و رشته ها در این فضا. |
import Mode | اختیاری. آیا این فضا در ایجاد یک فضا در |
create Time | اختیاری. تغییرناپذیر. برای فضاهای ایجاد شده در چت، زمان ایجاد فضا. این فیلد فقط خروجی است، مگر زمانی که در فضاهای حالت واردات استفاده می شود. برای فضاهای حالت واردات، این قسمت را روی مهر زمانی تاریخی که در آن فضا در منبع ایجاد شده است، تنظیم کنید تا زمان ایجاد اصلی حفظ شود. فقط زمانی در خروجی پر می شود که |
last Active Time | فقط خروجی مهر زمانی آخرین پیام در فضا. |
admin Installed | فقط خروجی برای فضاهای پیام مستقیم (DM) با برنامه چت، خواه این فضا توسط سرپرست Google Workspace ایجاد شده باشد. مدیران میتوانند یک پیام مستقیم را با یک برنامه چت از طرف کاربران سازمان خود نصب و راهاندازی کنند. برای پشتیبانی از نصب سرپرست، برنامه چت شما باید پیامرسانی مستقیم داشته باشد. |
membership Count | فقط خروجی تعداد عضویت های پیوسته گروه بندی شده بر اساس نوع عضو. زمانی که |
access Settings | اختیاری. تنظیمات دسترسی فضا را مشخص می کند. فقط زمانی پر می شود که |
space Uri | فقط خروجی URI برای دسترسی کاربر به فضا. |
import Mode Expire Time | فقط خروجی زمانی که این فضا در صورت باقی ماندن در حالت ایمپورت به طور خودکار توسط سیستم حذف می شود. هر فضای ایجاد شده در حالت واردات باید قبل از این زمان انقضا با استفاده از این فیلد فقط برای فضاهایی که با حالت import ایجاد شده اند پر می شود. |
customer | اختیاری. تغییرناپذیر. شناسه مشتری دامنه فضا. فقط هنگام ایجاد فضایی با تأیید اعتبار برنامه و در قالب برای DM ها، این فیلد پر نیست. |
فیلد اتحادیه نیاز به احراز هویت کاربر دارد. | |
predefined Permission Settings | اختیاری. فقط ورودی تنظیمات مجوز فضا از پیش تعریف شده، ورودی فقط هنگام ایجاد یک فضا. اگر فیلد تنظیم نشده باشد، فضای همکاری ایجاد می شود. پس از ایجاد فضا، تنظیمات در قسمت |
permission Settings | اختیاری. تنظیمات مجوز فضا برای فضاهای موجود. ورودی برای بهروزرسانی تنظیمات دقیق مجوز فضا، جایی که تنظیمات مجوز موجود جایگزین میشوند. خروجی تنظیمات مجوز فعلی را فهرست می کند. |
تایپ کنید
منسوخ شده: به جای آن از 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 | اختیاری. توضیحاتی در مورد فضا به عنوان مثال، موضوع بحث فضا، هدف عملکردی یا شرکت کنندگان را شرح دهید. تا 150 کاراکتر را پشتیبانی می کند. |
guidelines | اختیاری. قوانین، انتظارات و آداب فضا. پشتیبانی از 5000 کاراکتر |
History State
وضعیت تاریخ برای پیام ها و فضاها. مشخص میکند که پیامها و رشتههای مکالمه چه مدت پس از ایجاد نگهداری میشوند.
Enums | |
---|---|
HISTORY_STATE_UNSPECIFIED | مقدار پیش فرض استفاده نکنید. |
HISTORY_OFF | تاریخچه خاموش است. پیام ها و موضوعات به مدت 24 ساعت نگهداری می شوند . |
HISTORY_ON | تاریخ روشن است. قوانین نگهداری Vault سازمان، مدت زمان نگهداری پیام ها و رشته ها را مشخص می کند. |
تعداد عضویت
تعداد عضویتهای یک فضا را نشان میدهد که در دستهها گروهبندی شدهاند.
نمایندگی JSON |
---|
{ "joinedDirectHumanUserCount": integer, "joinedGroupCount": integer } |
فیلدها | |
---|---|
joined Direct Human User Count | فقط خروجی تعداد کاربران انسانی که مستقیماً به فضا ملحق شده اند، بدون احتساب کاربرانی که با عضویت در یک گروه ملحق شده اند. |
joined Group Count | فقط خروجی تعداد تمام گروه هایی که مستقیماً به فضا پیوسته اند. |
AccessSettings
نشان دهنده تنظیمات دسترسی به فضا است.
نمایندگی JSON |
---|
{
"accessState": enum ( |
فیلدها | |
---|---|
access State | فقط خروجی وضعیت دسترسی فضا را نشان می دهد. |
audience | اختیاری. نام منبع مخاطب هدف که میتواند فضا را کشف کند، به فضا بپیوندد و پیامهای موجود در فضا را پیشنمایش کند. اگر تنظیم نشود، فقط کاربران یا گروههای Google که به صورت جداگانه دعوت شده یا به فضا اضافه شدهاند میتوانند به آن دسترسی داشته باشند. برای جزئیات، به ایجاد فضای قابل کشف برای مخاطب هدف مراجعه کنید. قالب: برای استفاده از مخاطبان هدف پیشفرض برای سازمان Google Workspace، روی خواندن مخاطب هدف پشتیبانی می کند:
این فیلد هنگام استفاده از محدوده تنظیم مخاطب هدف نیاز به احراز هویت کاربر دارد. |
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 ( |
فیلدها | |
---|---|
manage Members And Groups | اختیاری. تنظیم برای مدیریت اعضا و گروه ها در یک فضا. |
modify Space Details | اختیاری. تنظیم برای بهروزرسانی نام فضا، آواتار، توضیحات و دستورالعملها. |
toggle History | اختیاری. تنظیم برای روشن و خاموش کردن تاریخچه فضا. |
use At Mention All | اختیاری. تنظیم برای استفاده از @all در یک فاصله. |
manage Apps | اختیاری. تنظیم برای مدیریت برنامه ها در یک فضا. |
manage Webhooks | اختیاری. تنظیماتی برای مدیریت وب هوک ها در یک فضا. |
post Messages | فقط خروجی تنظیم برای ارسال پیام در یک فضا. |
reply Messages | اختیاری. تنظیم برای پاسخ دادن به پیام ها در یک فاصله. |
PermissionSetting
یک تنظیم مجوز فضا را نشان می دهد.
نمایندگی JSON |
---|
{ "managersAllowed": boolean, "membersAllowed": boolean } |
فیلدها | |
---|---|
managers Allowed | اختیاری. آیا مدیران فضاها این مجوز را دارند یا خیر. |
members Allowed | اختیاری. آیا اعضای غیر مدیر این مجوز را دارند. |
روش ها | |
---|---|
| فرآیند واردات فضای مشخص شده را تکمیل می کند و آن را برای کاربران قابل مشاهده می کند. |
| فضا ایجاد می کند. |
| فضای نامگذاری شده را حذف می کند. |
| پیام مستقیم موجود با کاربر مشخص شده را برمی گرداند. |
| جزئیات یک فضا را برمیگرداند. |
| فضاهایی را که تماس گیرنده عضوی از آنها است را فهرست می کند. |
| یک فضا را به روز می کند. |
| فهرستی از فضاهای یک سازمان Google Workspace را بر اساس جستجوی سرپرست برمیگرداند. |
| فضایی ایجاد می کند و کاربران مشخصی را به آن اضافه می کند. |
منبع: فضا
فضایی در چت گوگل. Spaces مکالمه بین دو یا چند کاربر یا پیام های 1:1 بین یک کاربر و یک برنامه چت است.
نمایندگی JSON |
---|
{ "name": string, "type": enum ( |
فیلدها | |
---|---|
name | شناسه. نام منبع فضا قالب: جایی که |
type | فقط خروجی منسوخ شده: به جای آن از |
space Type | اختیاری. نوع فضا. هنگام ایجاد یک فضا یا به روز رسانی نوع فضای یک فضا مورد نیاز است. خروجی فقط برای استفاده های دیگر. |
single User Bot Dm | اختیاری. این که آیا فضای یک DM بین یک برنامه چت و یک انسان مجرد است. |
threaded | فقط خروجی منسوخ شده: به جای آن از |
display Name | اختیاری. نام نمایشی فضا هنگام ایجاد فضایی با برای پیام های مستقیم، این قسمت ممکن است خالی باشد. پشتیبانی از 128 کاراکتر |
external User Allowed | اختیاری. تغییرناپذیر. آیا این فضا به هر کاربر گپ Google اجازه عضویت می دهد یا خیر. ورودی هنگام ایجاد یک فضا در سازمان Google Workspace. هنگام ایجاد فضا در شرایط زیر این فیلد را حذف کنید:
برای فضاهای موجود، این فیلد فقط خروجی است. |
space Threading State | فقط خروجی حالت رشته در فضای چت. |
space Details | اختیاری. جزئیات در مورد فضا از جمله توضیحات و قوانین. |
space History State | اختیاری. وضعیت تاریخچه پیام برای پیام ها و رشته ها در این فضا. |
import Mode | اختیاری. آیا این فضا در ایجاد یک فضا در |
create Time | اختیاری. تغییرناپذیر. برای فضاهای ایجاد شده در چت، زمان ایجاد فضا. این فیلد فقط خروجی است، مگر زمانی که در فضاهای حالت واردات استفاده می شود. برای فضاهای حالت واردات، این قسمت را روی مهر زمانی تاریخی که در آن فضا در منبع ایجاد شده است، تنظیم کنید تا زمان ایجاد اصلی حفظ شود. فقط زمانی در خروجی پر می شود که |
last Active Time | فقط خروجی مهر زمانی آخرین پیام در فضا. |
admin Installed | فقط خروجی برای فضاهای پیام مستقیم (DM) با برنامه چت، خواه این فضا توسط سرپرست Google Workspace ایجاد شده باشد. مدیران میتوانند یک پیام مستقیم را با یک برنامه چت از طرف کاربران سازمان خود نصب و راهاندازی کنند. برای پشتیبانی از نصب سرپرست، برنامه چت شما باید پیامرسانی مستقیم داشته باشد. |
membership Count | فقط خروجی تعداد عضویت های پیوسته گروه بندی شده بر اساس نوع عضو. زمانی که |
access Settings | اختیاری. تنظیمات دسترسی فضا را مشخص می کند. فقط زمانی پر می شود که |
space Uri | فقط خروجی URI برای دسترسی کاربر به فضا. |
import Mode Expire Time | فقط خروجی زمانی که این فضا در صورت باقی ماندن در حالت ایمپورت به طور خودکار توسط سیستم حذف می شود. هر فضای ایجاد شده در حالت واردات باید قبل از این زمان انقضا با استفاده از این فیلد فقط برای فضاهایی که با حالت import ایجاد شده اند پر می شود. |
customer | اختیاری. تغییرناپذیر. شناسه مشتری دامنه فضا. فقط هنگام ایجاد فضایی با تأیید اعتبار برنامه و در قالب برای DM ها، این فیلد پر نیست. |
فیلد اتحادیه نیاز به احراز هویت کاربر دارد. | |
predefined Permission Settings | اختیاری. فقط ورودی تنظیمات مجوز فضا از پیش تعریف شده، ورودی فقط هنگام ایجاد یک فضا. اگر فیلد تنظیم نشده باشد، فضای همکاری ایجاد می شود. پس از ایجاد فضا، تنظیمات در قسمت |
permission Settings | اختیاری. تنظیمات مجوز فضا برای فضاهای موجود. ورودی برای بهروزرسانی تنظیمات دقیق مجوز فضا، جایی که تنظیمات مجوز موجود جایگزین میشوند. خروجی تنظیمات مجوز فعلی را فهرست می کند. |
تایپ کنید
منسوخ شده: به جای آن از 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 | اختیاری. توضیحاتی در مورد فضا به عنوان مثال، موضوع بحث فضا، هدف عملکردی یا شرکت کنندگان را شرح دهید. تا 150 کاراکتر را پشتیبانی می کند. |
guidelines | اختیاری. قوانین، انتظارات و آداب فضا. پشتیبانی از 5000 کاراکتر |
History State
وضعیت تاریخ برای پیام ها و فضاها. مشخص میکند که پیامها و رشتههای مکالمه چه مدت پس از ایجاد نگهداری میشوند.
Enums | |
---|---|
HISTORY_STATE_UNSPECIFIED | مقدار پیش فرض استفاده نکنید. |
HISTORY_OFF | تاریخچه خاموش است. پیام ها و موضوعات به مدت 24 ساعت نگهداری می شوند . |
HISTORY_ON | تاریخ روشن است. قوانین نگهداری Vault سازمان، مدت زمان نگهداری پیام ها و رشته ها را مشخص می کند. |
تعداد عضویت
تعداد عضویتهای یک فضا را نشان میدهد که در دستهها گروهبندی شدهاند.
نمایندگی JSON |
---|
{ "joinedDirectHumanUserCount": integer, "joinedGroupCount": integer } |
فیلدها | |
---|---|
joined Direct Human User Count | فقط خروجی تعداد کاربران انسانی که مستقیماً به فضا ملحق شده اند، بدون احتساب کاربرانی که با عضویت در یک گروه ملحق شده اند. |
joined Group Count | فقط خروجی تعداد تمام گروه هایی که مستقیماً به فضا پیوسته اند. |
AccessSettings
نشان دهنده تنظیمات دسترسی به فضا است.
نمایندگی JSON |
---|
{
"accessState": enum ( |
فیلدها | |
---|---|
access State | فقط خروجی وضعیت دسترسی فضا را نشان می دهد. |
audience | اختیاری. نام منبع مخاطب هدف که میتواند فضا را کشف کند، به فضا بپیوندد و پیامهای موجود در فضا را پیشنمایش کند. اگر تنظیم نشود، فقط کاربران یا گروههای Google که به صورت جداگانه دعوت شده یا به فضا اضافه شدهاند میتوانند به آن دسترسی داشته باشند. برای جزئیات، به ایجاد فضای قابل کشف برای مخاطب هدف مراجعه کنید. قالب: برای استفاده از مخاطبان هدف پیشفرض برای سازمان Google Workspace، روی خواندن مخاطب هدف پشتیبانی می کند:
این فیلد هنگام استفاده از محدوده تنظیم مخاطب هدف نیاز به احراز هویت کاربر دارد. |
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 ( |
فیلدها | |
---|---|
manage Members And Groups | اختیاری. تنظیم برای مدیریت اعضا و گروه ها در یک فضا. |
modify Space Details | اختیاری. تنظیم برای بهروزرسانی نام فضا، آواتار، توضیحات و دستورالعملها. |
toggle History | اختیاری. تنظیم برای روشن و خاموش کردن تاریخچه فضا. |
use At Mention All | اختیاری. تنظیم برای استفاده از @all در یک فاصله. |
manage Apps | اختیاری. تنظیم برای مدیریت برنامه ها در یک فضا. |
manage Webhooks | اختیاری. تنظیماتی برای مدیریت وب هوک ها در یک فضا. |
post Messages | فقط خروجی تنظیم برای ارسال پیام در یک فضا. |
reply Messages | اختیاری. تنظیم برای پاسخ دادن به پیام ها در یک فاصله. |
PermissionSetting
یک تنظیم مجوز فضا را نشان می دهد.
نمایندگی JSON |
---|
{ "managersAllowed": boolean, "membersAllowed": boolean } |
فیلدها | |
---|---|
managers Allowed | اختیاری. آیا مدیران فضاها این مجوز را دارند یا خیر. |
members Allowed | اختیاری. آیا اعضای غیر مدیر این مجوز را دارند. |
روش ها | |
---|---|
| فرآیند واردات فضای مشخص شده را تکمیل می کند و آن را برای کاربران قابل مشاهده می کند. |
| فضا ایجاد می کند. |
| فضای نامگذاری شده را حذف می کند. |
| پیام مستقیم موجود با کاربر مشخص شده را برمی گرداند. |
| جزئیات یک فضا را برمیگرداند. |
| فضاهایی را که تماس گیرنده عضوی از آنها است را فهرست می کند. |
| یک فضا را به روز می کند. |
| فهرستی از فضاهای یک سازمان Google Workspace را بر اساس جستجوی سرپرست برمیگرداند. |
| فضایی ایجاد می کند و کاربران مشخصی را به آن اضافه می کند. |
منبع: فضا
فضایی در Google Chat. Spaces مکالمه بین دو یا چند کاربر یا پیام های 1:1 بین یک کاربر و یک برنامه چت است.
نمایندگی JSON |
---|
{ "name": string, "type": enum ( |
فیلدها | |
---|---|
name | شناسه. نام منبع فضا قالب: جایی که |
type | فقط خروجی منسوخ شده: به جای آن از |
space Type | اختیاری. نوع فضا. هنگام ایجاد یک فضا یا به روز رسانی نوع فضای یک فضا مورد نیاز است. خروجی فقط برای استفاده های دیگر. |
single User Bot Dm | اختیاری. این که آیا فضای یک DM بین یک برنامه چت و یک انسان مجرد است. |
threaded | فقط خروجی منسوخ شده: به جای آن از |
display Name | اختیاری. نام نمایشی فضا هنگام ایجاد فضایی با برای پیام های مستقیم، این قسمت ممکن است خالی باشد. پشتیبانی از 128 کاراکتر |
external User Allowed | اختیاری. تغییرناپذیر. آیا این فضا به هر کاربر گپ Google اجازه عضویت می دهد یا خیر. ورودی هنگام ایجاد یک فضا در سازمان Google Workspace. هنگام ایجاد فضا در شرایط زیر این فیلد را حذف کنید:
برای فضاهای موجود، این فیلد فقط خروجی است. |
space Threading State | فقط خروجی حالت رشته در فضای چت. |
space Details | اختیاری. جزئیات در مورد فضا از جمله توضیحات و قوانین. |
space History State | اختیاری. وضعیت تاریخچه پیام برای پیام ها و رشته ها در این فضا. |
import Mode | اختیاری. آیا این فضا در ایجاد یک فضا در |
create Time | اختیاری. تغییرناپذیر. برای فضاهای ایجاد شده در چت، زمان ایجاد فضا. این فیلد فقط خروجی است، مگر زمانی که در فضاهای حالت واردات استفاده می شود. برای فضاهای حالت واردات، این قسمت را روی مهر زمانی تاریخی که در آن فضا در منبع ایجاد شده است، تنظیم کنید تا زمان ایجاد اصلی حفظ شود. فقط زمانی در خروجی پر می شود که |
last Active Time | فقط خروجی مهر زمانی آخرین پیام در فضا. |
admin Installed | فقط خروجی برای فضاهای پیام مستقیم (DM) با برنامه چت، خواه این فضا توسط سرپرست Google Workspace ایجاد شده باشد. مدیران میتوانند یک پیام مستقیم را با یک برنامه چت از طرف کاربران سازمان خود نصب و راهاندازی کنند. برای پشتیبانی از نصب سرپرست، برنامه چت شما باید پیامرسانی مستقیم داشته باشد. |
membership Count | فقط خروجی تعداد عضویت های پیوسته گروه بندی شده بر اساس نوع عضو. زمانی که |
access Settings | اختیاری. تنظیمات دسترسی فضا را مشخص می کند. فقط زمانی پر می شود که |
space Uri | فقط خروجی URI برای دسترسی کاربر به فضا. |
import Mode Expire Time | فقط خروجی زمانی که این فضا در صورت باقی ماندن در حالت ایمپورت به طور خودکار توسط سیستم حذف می شود. هر فضای ایجاد شده در حالت واردات باید قبل از این زمان انقضا با استفاده از این فیلد فقط برای فضاهایی که با حالت import ایجاد شده اند پر می شود. |
customer | اختیاری. تغییرناپذیر. شناسه مشتری دامنه فضا. فقط هنگام ایجاد فضایی با تأیید اعتبار برنامه و در قالب برای DM ها، این فیلد پر نیست. |
فیلد اتحادیه نیاز به احراز هویت کاربر دارد. | |
predefined Permission Settings | اختیاری. فقط ورودی تنظیمات مجوز فضا از پیش تعریف شده، ورودی فقط هنگام ایجاد یک فضا. اگر فیلد تنظیم نشده باشد، فضای همکاری ایجاد می شود. پس از ایجاد فضا، تنظیمات در قسمت |
permission Settings | اختیاری. تنظیمات مجوز فضا برای فضاهای موجود. ورودی برای بهروزرسانی تنظیمات دقیق مجوز فضا، جایی که تنظیمات مجوز موجود جایگزین میشوند. خروجی تنظیمات مجوز فعلی را فهرست می کند. |
تایپ کنید
منسوخ شده: به جای آن از 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 | اختیاری. توضیحاتی در مورد فضا به عنوان مثال، موضوع بحث فضا، هدف عملکردی یا شرکت کنندگان را شرح دهید. تا 150 کاراکتر را پشتیبانی می کند. |
guidelines | اختیاری. قوانین، انتظارات و آداب فضا. پشتیبانی از 5000 کاراکتر |
History State
وضعیت تاریخ برای پیام ها و فضاها. مشخص میکند که پیامها و رشتههای مکالمه چه مدت پس از ایجاد نگهداری میشوند.
Enums | |
---|---|
HISTORY_STATE_UNSPECIFIED | مقدار پیش فرض استفاده نکنید. |
HISTORY_OFF | تاریخچه خاموش است. پیام ها و موضوعات به مدت 24 ساعت نگهداری می شوند . |
HISTORY_ON | تاریخ روشن است. قوانین نگهداری Vault سازمان، مدت زمان نگهداری پیام ها و رشته ها را مشخص می کند. |
تعداد عضویت
تعداد عضویتهای یک فضا را نشان میدهد که در دستهها گروهبندی شدهاند.
نمایندگی JSON |
---|
{ "joinedDirectHumanUserCount": integer, "joinedGroupCount": integer } |
فیلدها | |
---|---|
joined Direct Human User Count | فقط خروجی تعداد کاربران انسانی که مستقیماً به فضا ملحق شده اند، بدون احتساب کاربرانی که با عضویت در یک گروه ملحق شده اند. |
joined Group Count | فقط خروجی تعداد تمام گروه هایی که مستقیماً به فضا پیوسته اند. |
AccessSettings
تنظیم دسترسی فضا را نشان می دهد.
نمایندگی JSON |
---|
{
"accessState": enum ( |
فیلدها | |
---|---|
access State | فقط خروجی وضعیت دسترسی فضا را نشان می دهد. |
audience | اختیاری. نام منبع مخاطب هدف که میتواند فضا را کشف کند، به فضا بپیوندد و پیامهای موجود در فضا را پیشنمایش کند. اگر تنظیم نشود، فقط کاربران یا گروههای Google که به صورت جداگانه دعوت شده یا به فضا اضافه شدهاند میتوانند به آن دسترسی داشته باشند. برای جزئیات، به ایجاد فضای قابل کشف برای مخاطب هدف مراجعه کنید. قالب: برای استفاده از مخاطبان هدف پیشفرض برای سازمان Google Workspace، روی خواندن مخاطب هدف پشتیبانی می کند:
این فیلد هنگام استفاده از محدوده تنظیم مخاطب هدف نیاز به احراز هویت کاربر دارد. |
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 ( |
فیلدها | |
---|---|
manage Members And Groups | اختیاری. تنظیم برای مدیریت اعضا و گروه ها در یک فضا. |
modify Space Details | اختیاری. تنظیم برای بهروزرسانی نام فضا، آواتار، توضیحات و دستورالعملها. |
toggle History | اختیاری. تنظیم برای روشن و خاموش کردن تاریخچه فضا. |
use At Mention All | اختیاری. تنظیم برای استفاده از @all در یک فاصله. |
manage Apps | اختیاری. تنظیم برای مدیریت برنامه ها در یک فضا. |
manage Webhooks | اختیاری. تنظیماتی برای مدیریت وب هوک ها در یک فضا. |
post Messages | فقط خروجی تنظیم برای ارسال پیام در یک فضا. |
reply Messages | اختیاری. تنظیم برای پاسخ دادن به پیام ها در یک فاصله. |
PermissionSetting
یک تنظیم مجوز فضا را نشان می دهد.
نمایندگی JSON |
---|
{ "managersAllowed": boolean, "membersAllowed": boolean } |
فیلدها | |
---|---|
managers Allowed | اختیاری. آیا مدیران فضاها این مجوز را دارند یا خیر. |
members Allowed | اختیاری. آیا اعضای غیر مدیر این مجوز را دارند. |
روش ها | |
---|---|
| فرآیند واردات فضای مشخص شده را تکمیل می کند و آن را برای کاربران قابل مشاهده می کند. |
| فضا ایجاد می کند. |
| فضای نامگذاری شده را حذف می کند. |
| پیام مستقیم موجود با کاربر مشخص شده را برمی گرداند. |
| جزئیات یک فضا را برمیگرداند. |
| فضاهایی را که تماس گیرنده عضوی از آنها است را فهرست می کند. |
| یک فضا را به روز می کند. |
| فهرستی از فضاهای یک سازمان Google Workspace را بر اساس جستجوی سرپرست برمیگرداند. |
| فضایی ایجاد می کند و کاربران مشخصی را به آن اضافه می کند. |