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 من مورد العميل في Admin SDK. يمكن للتطبيقات الخاصة أيضًا استخدام الاسم المستعار customers/my_customer لإنشاء المساحة في مؤسسة Google Workspace نفسها التي يتوفّر فيها التطبيق.

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

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

boolean

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

الطُرق

completeImport

 تُكمل هذه الطريقة عملية الاستيراد للمساحة المحدّدة وتتيحها للمستخدمين.

create

 تنشئ هذه الطريقة مساحة.

delete

 يحذف هذا الإجراء مساحة مُسمّاة.

findDirectMessage

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

get

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

list

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

patch

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

setup

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