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,
  "sessionState": enum (SpaceSessionState),
  "sessionEnableTime": string,
  "importModeExpireTime": string,
  "customer": string,

  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
}
الحقول
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) الذي يتيح للمستخدم الوصول إلى المساحة
sessionState

enum (SpaceSessionState)

النتائج فقط. حالة جلسة المساحة
sessionEnableTime

string (Timestamp format)

النتائج فقط. الطابع الزمني الذي تصبح فيه حالة إتاحة الجلسة في المساحة متاحة. يتم إلغاء الضبط إذا لم تكن ميزة الجلسات مفعَّلة في المساحة.
importModeExpireTime

string (Timestamp format)

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

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

لا تتم تعبئة هذا الحقل إلا للمساحات التي تم إنشاؤها باستخدام وضع الاستيراد.
customer

string

اختيارية: غير قابل للتغيير رقم تعريف العميل لنطاق المساحة يكون هذا الحقل مطلوبًا فقط عند إنشاء مساحة باستخدام مصادقة التطبيق ويكون SpaceType هو SPACE، وإلا يجب عدم ضبطه.

بالتنسيق customers/{customer}، حيث يمثّل customer السمة id من مورد العميل في SDK للمشرف. يمكن للتطبيقات الخاصة أيضًا استخدام الاسم المستعار customers/my_customer لإنشاء المساحة في مؤسسة Google Workspace نفسها التي ينتمي إليها التطبيق.

لا تتم تعبئة هذا الحقل للرسائل المباشرة أو عندما يتم إنشاء المساحة بواسطة مستخدمين غير تابعين لـ Google Workspace.
يمثّل إعدادات الأذونات لمساحة معيّنة. لا تتم تعبئة هذا الحقل إلا عندما تكون قيمة space_type هي SPACE. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
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

المساحات التي لا تتيح سلاسل المحادثات لا يتم استخدام حالة سلاسل المحادثات هذه في المساحة إلا في حالات خاصة، بما في ذلك:

  • مواصلة محادثة الاجتماع حيث يتم إيقاف سلاسل المحادثات عمدًا
  • المحادثات الجماعية القديمة التي تم إنشاؤها قبل عام 2022

SpaceDetails

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

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

string

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

يمكن استخدام ما يصل إلى 4,096 حرفًا.
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,
  "accessPermissionSettings": {
    object (AccessPermissionSettings)
  }
}
الحقول
accessState

enum (AccessState)

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

string

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

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

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

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

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

يتطلب إعداد الجمهور المستهدف مصادقة المستخدم.
accessPermissionSettings

object (AccessPermissionSettings)

اختيارية: الوصول إلى إعدادات الأذونات الخاصة بالمساحة

لضبط الجمهور المستهدف عند إنشاء مساحة، حدِّد الحقل accessSettings.audience في طلبك.

AccessState

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

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

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

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

AccessPermissionSettings

الوصول إلى إعدادات الأذونات الخاصة بمساحة معيّنة

تمثيل JSON 
{
  "discoverSpaceSetting": {
    object (AccessPermissionSetting)
  },
  "joinSpaceSetting": {
    object (AccessPermissionSetting)
  },
  "viewSpaceMembershipSetting": {
    object (AccessPermissionSetting)
  }
}
الحقول
discoverSpaceSetting

object (AccessPermissionSetting)

اختيارية: إعداد إذن الوصول لاكتشاف المساحة
joinSpaceSetting

object (AccessPermissionSetting)

اختيارية: إعداد إذن الوصول للانضمام إلى المساحة
viewSpaceMembershipSetting

object (AccessPermissionSetting)

اختيارية: إعداد إذن الوصول لعرض عضوية المساحة يجب تحديد هذا الحقل مع PermissionSettings.view_space_membership في قناع التعديل ونص الطلب عند تعديل المستخدمين الذين يمكنهم الاطّلاع على عضوية المساحة. عند منح الإذن بالاطّلاع لجمهور مستهدف، يجب أيضًا منح PermissionSettings.view_space_membership لجميع الأعضاء في الطلب نفسه. لإزالة جمهور مستهدف حالي (على سبيل المثال، لتقييد إذن الاطّلاع على مدراء المساحة أو المدراء المساعدين فقط)، حدِّد AccessPermissionSetting فارغًا (بدون principals).

AccessPermissionSetting

إعداد إذن الوصول

تمثيل JSON 
{
  "principals": [
    {
      object (Principal)
    }
  ]
}
الحقول
principals[]

object (Principal)

اختيارية: قائمة بدون ترتيب المستخدمون المسموح لهم بهذا الإذن

أساسي

مستخدِم رئيسي يمثّل جهة تم منحها إذن الوصول

تمثيل JSON 
{

  "audience": {
    object (Audience)
  }
}
الحقول
تمثّل هذه السمة نوع المستخدم المفوَّض. في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الرد:
audience

object (Audience)

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

الجمهور

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

لمزيد من التفاصيل، يُرجى الاطّلاع على الجماهير المستهدفة وإتاحة العثور على مساحة لجمهور مستهدف.

تمثيل JSON 
{
  "name": string
}
الحقول
name

string

اسم المورد للجمهور المستهدف الذي يمكنه العثور على المساحة أو الانضمام إليها. لمعرفة التفاصيل، يُرجى الاطّلاع على إتاحة العثور على مساحة لجمهور مستهدف. التنسيق: audiences/{audience}

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

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)
  },
  "viewSpaceMembership": {
    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)

اختيارية: إعدادات الردّ على الرسائل في مساحة
viewSpaceMembership

object (PermissionSetting)

اختيارية: إعدادات عرض اشتراكات المساحة يجب تحديد هذا الحقل مع AccessPermissionSettings.view_space_membership_setting في قناع التعديل ونص الطلب عند تعديل المستخدمين الذين يمكنهم الاطّلاع على عضوية المساحة. عند حصر إذن الاطّلاع على أدوار معيّنة (على سبيل المثال، مدراء المساحة أو المدراء المساعدون فقط)، حدِّد أذونات الدور المطلوبة هنا وقدِّم AccessPermissionSettings.view_space_membership_setting فارغًا في الطلب نفسه. إذا تم ضبط جمهور مستهدف في AccessPermissionSettings.view_space_membership_setting، يجب منح هذا الإعداد لجميع الأعضاء.

PermissionSetting

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

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

boolean

اختيارية: ما إذا كان مالكو المساحات (ROLE_MANAGER) لديهم هذا الإذن
membersAllowed

boolean

اختيارية: ما إذا كان هذا الإذن متاحًا للأعضاء الأساسيين في المساحة (ROLE_MEMBER).
assistantManagersAllowed

boolean

اختيارية: ما إذا كان مدراء المساحة ROLE_ASSISTANT_MANAGER) لديهم هذا الإذن.

SpaceSessionState

حالة جلسة المساحة

عمليات التعداد
SPACE_SESSION_STATE_UNSPECIFIED غير محدد يجب عدم استخدامها.
NOT_SUPPORTED لا تتوفّر ميزة الجلسات في المساحة.
THREAD تتيح المساحة الجلسات المستندة إلى سلاسل المحادثات.

الطُرق

completeImport

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

create

 تنشئ مساحة.

delete

 لحذف مساحة مُسمّاة

findDirectMessage

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

findGroupChats

 تعرض هذه الطريقة جميع المساحات التي تتضمّن spaceType == GROUP_CHAT، والتي تحتوي عضوياتها البشرية على المستخدم الذي يجري الطلب والمستخدمين المحدّدين في FindGroupChatsRequest.users.

get

 تعرض هذه الطريقة تفاصيل حول مساحة.

list

 تعرض هذه الطريقة قائمة بالمساحات التي يكون المتصل عضوًا فيها.

patch

 تعديل مساحة
تعرض هذه الطريقة قائمة بالمساحات في مؤسسة Google Workspace.

setup

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