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,

  // 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}
type
(deprecated)

enum (Type)

النتائج فقط. متوقّفة نهائيًا: استخدِم spaceType بدلاً منها. نوع المساحة.
spaceType

enum (SpaceType)

نوع المساحة. مطلوبة عند إنشاء مساحة أو تعديل نوع المساحة الناتج فقط للاستخدامات الأخرى.
singleUserBotDm

boolean

اختياريّ. ما إذا كانت المساحة عبارة عن رسالة مباشرة بين تطبيق Chat وشخص واحد
threaded
(deprecated)

boolean

النتائج فقط. متوقّفة نهائيًا: استخدِم spaceThreadingState بدلاً منها. ما إذا كانت الرسائل سلسلة محادثات في هذه المساحة
displayName

string

الاسم المعروض للمساحة. هذا الحقل مطلوب عند إنشاء مساحة. إذا ظهرت لك رسالة الخطأ ALREADY_EXISTS عند إنشاء مساحة أو تعديل displayName، يمكنك تجربة displayName آخر. قد تستخدم مساحة حالية في مؤسسة Google Workspace هذا الاسم المعروض.

بالنسبة إلى الرسائل المباشرة، قد يكون هذا الحقل فارغًا.

ويدعم حتى 128 حرفًا.
externalUserAllowed

boolean

غير قابل للتغيير. ما إذا كانت هذه المساحة تسمح لأي مستخدم في Google Chat كعضو في هذه المساحة الإدخال عند إنشاء مساحة في مؤسسة Google Workspace احذف هذا الحقل عند إنشاء مساحات في الشروط التالية:

  • يستخدم المستخدم الذي تمت مصادقته حساب مستهلك (حساب مستخدم غير مُدار). وفقًا للإعدادات التلقائية، تسمح المساحة التي ينشئها حساب مستهلك بأي مستخدم في Google Chat.

  • يتم استخدام المساحة لاستيراد البيانات إلى Google Chat لأنّ مساحات وضع الاستيراد يجب أن تسمح فقط بالأعضاء من مؤسسة Google Workspace نفسها. ومع ذلك، وفي إطار برنامج معاينة المطوّر على Google Workspace، يمكن أن تسمح مساحات وضع الاستيراد لأي مستخدم في Google Chat، لإتاحة إمكانية ضبط هذا الحقل بعد ذلك لمساحات وضع الاستيراد.

بالنسبة إلى المساحات الحالية، يكون هذا الحقل ناتجًا فقط.
spaceThreadingState

enum (SpaceThreadingState)

النتائج فقط. حالة سلاسل المحادثات في "مساحة Chat"
spaceDetails

object (SpaceDetails)

تفاصيل حول المساحة بما في ذلك الوصف والقواعد.
spaceHistoryState

enum (HistoryState)

حالة سجلّ الرسائل للرسائل وسلاسل المحادثات في هذه المساحة
importMode

boolean

اختياريّ. ما إذا تم إنشاء هذه المساحة في Import Mode كجزء من عملية نقل البيانات إلى Google Workspace. أثناء استيراد المساحات، لن تظهر للمستخدمين إلى أن تكتمل عملية الاستيراد.
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

النتائج فقط. معرّف الموارد المنتظم (URI) الخاص بالمساحة

حقل الاتحاد space_permission_settings. يمثّل هذا الإعداد إعدادات الأذونات للمساحة. لا تتم تعبئة هذا الحقل إلا عندما تكون قيمة space_type هي SPACE. يمكن أن يكون space_permission_settings واحدًا فقط مما يلي:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

اختياريّ. الإدخال فقط. إعدادات أذونات المساحة حقل إدخال لإنشاء مساحة، يتم إنشاء مساحة تعاون في حال عدم ضبط هذا الحقل. بعد إنشاء المساحة، تتم تعبئة الإعدادات في الحقل PermissionSettings.

permissionSettings

object (PermissionSettings)

اختياريّ. إعدادات الأذونات الدقيقة التي يمكن ضبطها لتعديل المساحة حقل إدخال لتعديل المساحة في الحالات الأخرى، يتم عرض الناتج فقط. لإنشاء مساحة، استخدِم predefinedPermissionSettings بدلاً من ذلك.

النوع

متوقّفة نهائيًا: استخدِم SpaceType بدلاً منها.

عمليات التعداد
TYPE_UNSPECIFIED محجوز.
ROOM المحادثات بين شخصين أو أكثر.
DM رسالة مباشرة بين مستخدم وتطبيق Chat، تكون فيها جميع الرسائل مسطحة يُرجى العلم أنّ هذا الخيار لا يشمل الرسائل المباشرة بين شخصين.

SpaceType

نوع المساحة. هذا الحقل مطلوب عند إنشاء مساحة أو تعديلها. الناتج فقط للاستخدامات الأخرى.

عمليات التعداد
SPACE_TYPE_UNSPECIFIED محجوز.
SPACE مكان يمكن للأشخاص من خلاله إرسال الرسائل ومشاركة الملفات والتعاون معهم. يمكن أن تتضمّن السمة SPACE تطبيقات Chat.
GROUP_CHAT محادثات جماعية بين 3 أشخاص أو أكثر. يمكن أن تتضمّن السمة GROUP_CHAT تطبيقات Chat.
DIRECT_MESSAGE الرسائل الفردية بين مستخدمَين أو مستخدم وتطبيق Chat

SpaceThreadingState

تُحدِّد هذه السياسة نوع حالة سلاسل المحادثات في مساحة Chat.

عمليات التعداد
SPACE_THREADING_STATE_UNSPECIFIED محجوز.
THREADED_MESSAGES المساحات المُعنونة التي تتيح سلاسل الرسائل عند رد المستخدمين على رسالة، يمكنهم الرد في سلسلة محادثات، ما يجعل الرد في سياق الرسالة الأصلية.
GROUPED_MESSAGES المساحات المُعنونة التي يتم فيها تنظيم المحادثة حسب الموضوع. ويتم تجميع المواضيع وردودها معًا.
UNTHREADED_MESSAGES هي رسائل مباشرة بين شخصين ومحادثات جماعية بين 3 أشخاص أو أكثر.

SpaceDetails

تفاصيل حول المساحة بما في ذلك الوصف والقواعد.

تمثيل JSON 
{
  "description": string,
  "guidelines": string
}
الحقول
description

string

اختياريّ. وصف للمساحة. على سبيل المثال، يمكنك وصف موضوع مناقشة المساحة أو الغرض الوظيفي أو المشاركين.

يمكن استخدام أكثر من 150 حرفًا.
guidelines

string

اختياريّ. قواعد المساحة وتوقعاتها وآدابها.

يمكن استخدام ما يصل إلى 5,000 حرف.

HistoryState

حالة السجلّ للرسائل والمساحات تحدِّد هذه السياسة مدة الاحتفاظ بالرسائل وسلاسل المحادثات بعد الإنشاء.

عمليات التعداد
HISTORY_STATE_UNSPECIFIED القيمة التلقائية. يُرجى عدم استخدامها.
HISTORY_OFF السجلّ غير مفعّل. يتم الاحتفاظ بالرسائل وسلاسل المحادثات لمدة 24 ساعة.
HISTORY_ON السجلّ مفعّل. تحدِّد قواعد الاحتفاظ بالبيانات في Vault للمؤسسة مدة الاحتفاظ بالرسائل وسلاسل المحادثات.

MembershipCount

يمثل هذا العدد عدد العضويات في مساحة، مجمَّعة ضمن فئات.

تمثيل JSON 
{
  "joinedDirectHumanUserCount": integer,
  "joinedGroupCount": integer
}
الحقول
joinedDirectHumanUserCount

integer

عدد المستخدمين الذين انضموا مباشرةً إلى المساحة، ولا يتم احتساب عدد المستخدمين الذين انضموا من خلال العضوية في مجموعة
joinedGroupCount

integer

عدد جميع المجموعات التي انضمت مباشرةً إلى المساحة

AccessSettings

يمثل هذا الإعداد إعدادات الوصول للمساحة.

تمثيل JSON 
{
  "accessState": enum (AccessState),
  "audience": string
}
الحقول
accessState

enum (AccessState)

النتائج فقط. يشير إلى حالة الوصول إلى المساحة.
audience

string

اختياريّ. اسم المورد للجمهور المستهدف الذي يمكنه الوصول إلى المساحة. اضبط هذا الحقل على رقم تعريف صالح للجمهور المستهدف لجعل المساحة قابلة للاكتشاف أو استخدِم الاسم المستعار "audiences/default" لضبط المساحة باستخدام إعداد الوصول التلقائي في "وحدة تحكّم المشرف". لمزيد من المعلومات، يُرجى الاطّلاع على مقالة جعل مساحة قابلة للاكتشاف لدى جمهور مستهدف. يجب إلغاء ضبط هذا الحقل لفرض قيود على المساحة. لا تتم تعبئة هذا الحقل إلا عندما تكون المساحة قابلة للاكتشاف. التنسيق: audiences/{audience}، يمكن استخدام audiences/default كاسم مستعار لإعداد مشاركة Chat التلقائي.

AccessState

يمثل حالة الوصول إلى المساحة.

عمليات التعداد
ACCESS_STATE_UNSPECIFIED حالة الوصول غير معروفة أو غير متاحة في واجهة برمجة التطبيقات هذه.
PRIVATE يمكن للأعضاء أو المجموعات الذين تمت إضافتهم أو دعوتهم أو العثور على المساحة.
DISCOVERABLE يمكن أن تكون المساحة قابلة للاكتشاف من قِبل الجمهور المستهدَف المحدّد، بالإضافة إلى الأعضاء أو المجموعات المُضافة أو المدعوين.

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)
  }
}
الحقول
manageMembersAndGroups

object (PermissionSetting)

إعداد لإدارة الأعضاء والمجموعات في المساحة.
modifySpaceDetails

object (PermissionSetting)

إعداد لتعديل اسم المساحة وصورتها الرمزية ووصفها وإرشاداتها
toggleHistory

object (PermissionSetting)

إعداد للتبديل بين تفعيل سجلّ المساحات وإيقافه.
useAtMentionAll

object (PermissionSetting)

إعداد استخدام @الكل في مساحة
manageApps

object (PermissionSetting)

إعداد لإدارة التطبيقات في مساحة
manageWebhooks

object (PermissionSetting)

إعداد لإدارة الردود التلقائية على الويب في مساحة
postMessages

object (PermissionSetting)

النتائج فقط. خيار لنشر الرسائل في مساحة
replyMessages

object (PermissionSetting)

إعداد للرد على الرسائل في مساحة

PermissionSetting

يمثّل هذا الإعداد إعدادًا لإذن المساحة.

تمثيل JSON 
{
  "managersAllowed": boolean,
  "membersAllowed": boolean
}
الحقول
managersAllowed

boolean

ما إذا كان مدراء المساحات لديهم هذا الإذن
membersAllowed

boolean

ما إذا كان الأعضاء غير الإداريين لديهم هذا الإذن أم لا.

الطُرق

completeImport

 تُكمل عملية الاستيراد للمساحة المحدَّدة وتجعلها مرئية للمستخدمين.

create

 يتم إنشاء مساحة مُعنوَنة.

delete

 حذف مساحة مُعنوَنة

findDirectMessage

 لعرض الرسالة المباشرة الحالية مع المستخدم المحدّد.

get

 لعرض تفاصيل حول مساحة

list

 يسرد المساحات التي ينتمي إليها المتصل.

patch

 يتم تعديل مساحة.

setup

 يتم إنشاء مساحة وإضافة مستخدمين محدّدين إليها.