Method: spaces.setup

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

لتحديد الأعضاء المطلوب إضافتهم، أضِف عضويات باستخدام السمة member.name المناسبة في SetUpSpaceRequest. لإضافة مستخدم، استخدِم users/{user}، حيث يجب أن تكون السمة {user} هي السمة {person_id} للمستخدم من واجهة برمجة التطبيقات الخاصة بالأشخاص أو واجهة برمجة التطبيقات id للمستخدم المستخدم في واجهة برمجة التطبيقات Admin SDK Directory API. على سبيل المثال، إذا كانت واجهة برمجة التطبيقات الخاصة بالأشخاص Person resourceName هي people/123456789، يمكنك إضافة المستخدم إلى مساحة العمل من خلال تضمين عضوية مع users/123456789 باعتبارها member.name.

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

لإنشاء رسالة مباشرة (DM) بين مستخدم الاتصال ومستخدم بشري آخر، حدِّد عضوًا واحدًا بالضبط لتمثيل المستخدم البشري. وإذا حظر أحد المستخدمين الآخر، سيتعذّر تنفيذ الطلب ولن يتم إنشاء الرسالة المباشرة.

لإنشاء رسالة مباشرة بين مستخدم الاتصال وتطبيق الاتصال، يجب ضبط Space.singleUserBotDm على true وعدم تحديد أي اشتراكات. يمكنك استخدام هذه الطريقة لإعداد رسالة مباشرة مع تطبيق "الاتصال". لإضافة تطبيق الاتصال كعضو في مساحة أو رسالة مباشرة حالية بين مستخدمَين، اطّلِع على إنشاء اشتراك.

في حال توفّر رسالة مباشرة بين مستخدمَين، حتى إذا حظر أحد المستخدمين الآخر في وقت تقديم الطلب، سيتم عرض الرسالة المباشرة الحالية.

لا تتوفّر المساحات التي تتضمن ردودًا في سلاسل منفصلة أو تتيح إمكانية وصول الضيوف.

يتطلب مصادقة المستخدم ونطاق chat.spaces.create أو chat.spaces.

طلب HTTP

POST https://chat.googleapis.com/v1/spaces:setup

يستخدم عنوان URL بنية gRPC Transcode.

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON
{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
الحقول
space

object (Space)

مطلوبة. الحقل Space.spaceType مطلوب.

لإنشاء مساحة، يجب ضبط Space.spaceType على SPACE وضبط Space.displayName.

لإنشاء محادثة جماعية، يُرجى ضبط Space.spaceType على GROUP_CHAT. عدم ضبط Space.displayName

لإنشاء محادثة بين شخصين بين مجموعة واحدة، يجب ضبط Space.spaceType على DIRECT_MESSAGE وضبط Space.singleUserBotDm على false. لا تضبط السمة Space.displayName أو Space.spaceDetails.

لإنشاء محادثة بين شخصين وتطبيق الاتصال عبر Chat، اضبط Space.spaceType على DIRECT_MESSAGE وSpace.singleUserBotDm على true. لا تضبط السمة Space.displayName أو Space.spaceDetails.

في حال توفُّر مساحة DIRECT_MESSAGE، يتم عرض هذه المساحة بدلاً من إنشاء مساحة جديدة.

requestId

string

اختياريّ. معرِّف فريد لهذا الطلب. ويُفضَّل استخدام معرّف فريد عشوائي (UUID). يؤدي تحديد معرّف طلب حالي إلى عرض المساحة التي تم إنشاؤها باستخدام هذا المعرّف بدلاً من إنشاء مساحة جديدة. يؤدي تحديد معرّف طلب حالي من تطبيق Chat نفسه مع مستخدم مختلف تمت مصادقته إلى ظهور خطأ.

memberships[]

object (Membership)

اختياريّ. المجموعة الأولية من المستخدمين في النطاق الذين تمت دعوتهم للانضمام إلى المساحة. تتم إضافة المستخدم المتصل تلقائيًا إلى مساحة العمل، ويجب عدم تحديده كعضو.

تسمح المجموعة حاليًا بما يصل إلى 20 اشتراكًا (بالإضافة إلى المتصل).

يجب أن يتضمّن الحقل Membership.member مستخدمًا تمت تعبئته بـ name وUser.Type.HUMAN. ويتم تجاهل جميع الحقول الأخرى.

هذه السمة اختيارية عند ضبط Space.spaceType على SPACE.

مطلوبة عند ضبط Space.spaceType على GROUP_CHAT، إلى جانب اشتراكَين على الأقل.

مطلوبة عند ضبط Space.spaceType على DIRECT_MESSAGE مع مستخدم عادي، إلى جانب اشتراك واحد بالضبط.

يجب أن يكون فارغًا عند إنشاء محادثة بين مستخدمَين وتطبيق Chat المخصّص للاتصال (عند ضبط Space.spaceType على DIRECT_MESSAGE وSpace.singleUserBotDm إلى true).

غير متوافق: دعوة مستخدمين ضيف أو إضافة تطبيقات Chat أخرى

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Space.

نطاقات الأذونات

يتطلب ذلك أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

لمزيد من المعلومات، اطّلِع على دليل التفويض.