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,
  "importModeExpireTime": 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

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

لتفعيل ميزة "التثبيت من خلال المشرف"، يجب أن يتضمّن تطبيق Chat ميزة المراسلة المباشرة.
membershipCount

object (MembershipCount)

النتائج فقط. عدد العضويات التي تم الانضمام إليها مجمّعة حسب نوع العضو تتم تعبئة هذه السمة عندما يكون spaceType هو SPACE أو DIRECT_MESSAGE أو GROUP_CHAT.
accessSettings

object (AccessSettings)

اختيارية: تُحدِّد إعداد الوصول إلى المساحة. لا تتم تعبئة هذا الحقل إلا عندما يكون spaceType هو SPACE.
spaceUri

string

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

string (Timestamp format)

النتائج فقط. الوقت الذي سيحذف فيه النظام المساحة تلقائيًا إذا بقيت في وضع الاستيراد

يجب أن تخرج كل مساحة تم إنشاؤها في وضع الاستيراد من هذا الوضع قبل انتهاء صلاحيته باستخدام spaces.completeImport.

لا تتم تعبئة هذا الحقل إلا للمساحات التي تم إنشاؤها باستخدام وضع الاستيراد.
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

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