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)
  }
}
الحقول
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. وفقًا للإعدادات التلقائية، تسمح المساحة لأي مستخدم من مستخدمي Google Chat.

  • يتم استخدام المساحة لاستيراد البيانات إلى Google Chat. يجب أن تسمح مساحات وضع الاستيراد للأعضاء من مؤسسة Google Workspace نفسها فقط.

بالنسبة إلى المساحات الحالية، يتم عرض هذا الحقل فقط إخراجًا.

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.

النوع

متوقّفة نهائيًا: يمكنك استخدام 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

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