Method: spaces.setup

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

لتحديد الأعضاء الذين تريد إضافتهم، أضِف العضويات باستخدام السمة member.name المناسبة في SetUpSpaceRequest. لإضافة مستخدم، يجب استخدام users/{user}، حيث يمكن أن يكون {user} عنوان البريد الإلكتروني للمستخدم. بالنسبة إلى المستخدمين في مؤسسة Workspace نفسها، يمكن أن يكون {user} أيضًا id للمستخدم من People API، أو id للمستخدم في Directory API. على سبيل المثال، إذا كان رقم تعريف الملف الشخصي للشخص في واجهة برمجة تطبيقات الأشخاص في user@example.com هو 123456789، يمكنك إضافة المستخدم إلى المساحة من خلال ضبط membership.member.name على users/user@example.com أو users/123456789.

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

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

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

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

لا تتوفّر المساحات التي تتضمّن ردودًا في سلاسل منفصلة. إذا ظهرت رسالة الخطأ ALREADY_EXISTS عند إعداد مساحة، جرِّب إدخال displayName آخر. قد تستخدم مساحة حالية ضمن مؤسسة Google Workspace هذا الاسم المعروض.

يتطلب مصادقة المستخدم.

طلب HTTP

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

يستخدم عنوان URL بنية تحويل الترميز gRPC.

نص الطلب

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

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

object (Space)

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

لإنشاء مساحة، اضبط Space.spaceType على SPACE واضبط Space.displayName. إذا ظهرت رسالة الخطأ ALREADY_EXISTS عند إعداد مساحة، جرِّب إدخال displayName آخر. قد تستخدم مساحة حالية ضمن مؤسسة Google Workspace هذا الاسم المعروض.

لإنشاء محادثة جماعية، اضبط 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)

اختياريّ. مستخدمو Google Chat الذين ستتم دعوتهم للانضمام إلى المساحة. حذف المستخدم المتصل، حيث تتم إضافته تلقائيًا.

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

يجب أن يحتوي الحقل Membership.member على user مع تعبئة name (التنسيق: users/{user}) وtype على User.Type.HUMAN. يمكنك إضافة مستخدمين فقط عند إعداد مساحة (لا تتوفّر إضافة تطبيقات Chat إلا في عملية إعداد الرسائل المباشرة باستخدام تطبيق الاتصال). يمكنك أيضًا إضافة أعضاء باستخدام عنوان البريد الإلكتروني للمستخدم كاسم مستعار لـ {user}. على سبيل المثال، يمكن أن يكون user.name هو users/example@gmail.com." لدعوة مستخدمي Gmail أو المستخدمين من نطاقات Google Workspace الخارجية، يجب استخدام عنوان البريد الإلكتروني للمستخدم في {user}.

وتكون اختيارية عند ضبط Space.spaceType على SPACE.

هذه السمة مطلوبة عند ضبط السمة Space.spaceType على GROUP_CHAT، بالإضافة إلى عضويتَين على الأقل.

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

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

نص الاستجابة

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

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

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