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,
  "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() أو من عنوان URL للمساحة. على سبيل المثال، إذا كان عنوان URL للمساحة هو 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. إذا ظهرت لك رسالة الخطأ ALREADY_EXISTS عند إنشاء مساحة أو تعديل displayName، يُرجى تجربة displayName آخر. قد تستخدم مساحة حالية في مؤسسة Google Workspace هذا الاسم المعروض.

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

ويدعم حتى 128 حرفًا.
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

النتائج فقط. معرّف الموارد المنتظم (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 نفسها التي يستخدمها التطبيق.

لا تتم تعبئة هذا الحقل للرسائل المباشرة.

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

يتطلب مصادقة المستخدم. يمكن أن يكون space_permission_settings واحدًا فقط مما يلي:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

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

object (PermissionSettings)

اختياريّ. إعدادات أذونات المساحة للمساحات الحالية حقل لتعديل إعدادات أذونات المساحة بالضبط، حيث يتم استبدال إعدادات الأذونات الحالية قوائم الإخراج إعدادات الأذونات الحالية

النوع

تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام 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

اختياريّ. اسم المورد للجمهور المستهدف الذي يمكنه الاطّلاع على المساحة والانضمام إليها ومعاينة الرسائل في المساحة. في حال ترك هذه السياسة بدون ضبط، يمكن فقط للمستخدمين أو "مجموعات Google" الذين تمت دعوتهم أو تمت إضافتهم إلى المساحة بشكل فردي الوصول إليها. لمعرفة التفاصيل، يُرجى الاطّلاع على إتاحة مساحة للاكتشاف من قِبل جمهور مستهدف.

التنسيق: audiences/{audience}

لاستخدام الجمهور المستهدَف التلقائي لمؤسّسة Google Workspace، اضبط القيمة على audiences/default.

تدعم قراءة الجمهور المستهدف ما يلي:

لا يتمّ ملء هذا الحقل عند استخدام نطاق chat.bot مع مصادقة التطبيق.

يتطلب ضبط الجمهور المستهدَف مصادقة المستخدِم.

AccessState

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

عمليات التعداد
ACCESS_STATE_UNSPECIFIED حالة الوصول غير معروفة أو غير متاحة في واجهة برمجة التطبيقات هذه.
PRIVATE يمكن فقط للمستخدمين أو "مجموعات Google" التي أضافها مستخدمون آخرون أو أرسلوا دعوة إليها بشكل فردي أو مشرفي Google Workspace اكتشاف المساحة والوصول إليها.
DISCOVERABLE

منَح مدير المساحة إذن الوصول إلى المساحة لجمهور مستهدف. يمكن أيضًا للمستخدمين أو "مجموعات Google" الذين تمت إضافتهم أو دعوتهم إلى المساحة بشكل فردي العثور عليها والوصول إليها. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة جعل مساحة قابلة للاكتشاف من مستخدمين محدّدين.

يتطلّب إنشاء مساحات قابلة للاكتشاف مصادقة المستخدم.

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)

اختياريّ. إعدادات استخدام @all في مساحة
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

 يتم تعديل مساحة.
تعرض قائمة المساحات في مؤسسة Google Workspace استنادًا إلى بحث المشرف.

setup

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