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,
  "adminInstalled": boolean,
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string
}
الحقول
name

string

اسم المورد للمساحة

تنسيق الملف: spaces/{space}

type
(deprecated)

enum (Type)

النتائج فقط. مهملة: يمكنك استخدام spaceType بدلاً منها. نوع المساحة.

spaceType

enum (SpaceType)

نوع المساحة. تكون هذه السمة مطلوبة عند إنشاء مساحة أو تعديل نوعها. المخرجات للاستخدامات الأخرى فقط.

singleUserBotDm

boolean

اختياريّ. ما إذا كانت المساحة رسالة مباشرة بين تطبيق Chat ومستخدم واحد

threaded
(deprecated)

boolean

النتائج فقط. مهملة: يمكنك استخدام spaceThreadingState بدلاً منها. ما إذا كانت الرسائل متسلسلة في هذه المساحة

displayName

string

الاسم المعروض للمساحة تكون هذه السمة مطلوبة عند إنشاء مساحة. إذا ظهرت لك رسالة الخطأ ALREADY_EXISTS عند إنشاء مساحة أو تعديل displayName، يُرجى تجربة displayName مختلفة. قد تستخدم مساحة حالية ضمن مؤسسة Google Workspace هذا الاسم المعروض.

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

إمكانية استخدام ما يصل إلى 128 حرفًا

externalUserAllowed

boolean

غير قابل للتغيير. ما إذا كانت هذه المساحة تسمح لأي مستخدم Google Chat كعضو يجب إدخاله عند إنشاء مساحة في مؤسسة Google Workspace. احذف هذا الحقل عند إنشاء مسافات في الحالات التالية:

  • يستخدم المستخدم الذي تمت مصادقته حساب مستهلك (حساب مستخدم غير مُدار). وفقًا للإعدادات التلقائية، تسمح المساحة التي ينشئها حساب المستهلك لأي مستخدم من مستخدمي Google Chat.

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

بالنسبة إلى المساحات الحالية، يكون هذا الحقل ناتجًا فقط.

spaceThreadingState

enum (SpaceThreadingState)

النتائج فقط. حالة سلاسل المحادثات في "مساحة Chat"

spaceDetails

object (SpaceDetails)

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

spaceHistoryState

enum (HistoryState)

حالة سجلّ الرسائل للرسائل وسلاسل المحادثات في هذه المساحة

importMode

boolean

اختياريّ. ما إذا تم إنشاء هذه المساحة في "Import Mode" كجزء من عملية نقل البيانات إلى Google Workspace أثناء استيراد المساحات، لن تكون مرئية للمستخدمين إلى أن تكتمل عملية الاستيراد.

createTime

string (Timestamp format)

اختياريّ. غير قابل للتغيير. وقت إنشائها في المساحات التي تم إنشاؤها في Chat هذا الحقل مخصّص للمخرجات فقط، إلا عند استخدامه في مساحات وضع الاستيراد.

بالنسبة إلى مساحات وضع الاستيراد، يجب ضبط هذا الحقل على الطابع الزمني السابق الذي تم إنشاء المساحة فيه في المصدر من أجل الحفاظ على وقت الإنشاء الأصلي.

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

adminInstalled

boolean

النتائج فقط. ما إذا كان قد تم تثبيت تطبيق Chat من قِبل مشرف Google Workspace. يمكن للمشرفين تثبيت تطبيق Chat لنطاقهم أو وحدتهم التنظيمية أو لمجموعة من المستخدمين.

يمكن للمشرفين تثبيت تطبيقات Chat فقط للمراسلة المباشرة بين المستخدمين والتطبيق. لإتاحة التثبيت من المشرف، يجب أن يتضمّن تطبيقك ميزة المراسلة المباشرة.

accessSettings

object (AccessSettings)

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

spaceUri

string

النتائج فقط. معرّف الموارد المنتظم (URI) للمساحة

النوع

مهملة: يمكنك استخدام 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 الخاصة بالمؤسسة مدة الاحتفاظ بالرسائل وسلاسل المحادثات.

AccessSettings

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

تمثيل JSON
{
  "accessState": enum (AccessState),
  "audience": string
}
الحقول
accessState

enum (AccessState)

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

audience

string

اختياريّ. اسم المورد للجمهور المستهدف الذي يمكنه الوصول إلى المساحة. اضبط هذا الحقل على رقم تعريف جمهور مستهدف صالح لجعل المساحة قابلة للاكتشاف أو استخدِم العنوان البديل للبريد الإلكتروني audiences/default لضبط المساحة باستخدام إعداد الوصول التلقائي في "وحدة تحكّم المشرف". لمزيد من المعلومات، يُرجى الاطّلاع على جعل المساحة قابلة للاكتشاف من الجمهور المستهدف. يجب إلغاء ضبط هذا الحقل لحصر المساحة. تتم تعبئة هذا الحقل فقط عندما تكون المساحة قابلة للاكتشاف. التنسيق: audiences/{audience}، يمكن استخدام audiences/default كاسم مستعار لإعداد مشاركة Chat التلقائي.

AccessState

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

عمليات التعداد
ACCESS_STATE_UNSPECIFIED حالة الوصول غير معروفة أو غير مدعومة في واجهة برمجة التطبيقات هذه.
PRIVATE تكون المساحة قابلة للاكتشاف من خلال الأعضاء أو المجموعات الذين تمت إضافتهم أو دعوتهم.
DISCOVERABLE يمكن للجمهور المستهدف المحدَّد اكتشاف المساحة، بالإضافة إلى الأعضاء أو المجموعات الذين تمت إضافتهم أو دعوتهم.

الطُرق

completeImport

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

create

تنشئ مساحة اسمها.

delete

لحذف مساحة مُعينة

findDirectMessage

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

get

لعرض تفاصيل حول مساحة

list

يسرد المساحات التي ينتمي إليها المتصل.

patch

لتعديل مساحة

setup

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