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

النتائج فقط. بالنسبة إلى مساحات الرسائل المباشرة التي تتضمّن تطبيق 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)

إعداد استخدام @الكل في مساحة
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

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