Method: spaces.setup

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

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

لتحديد "مجموعات Google" التي تريد إضافتها، أضِف الاشتراكات مع membership.group_member.name المناسب. لإضافة "مجموعة Google" أو دعوتها، استخدِم groups/{group}، حيث يكون {group} هو id للمجموعة من Cloud Identity Groups API. على سبيل المثال، يمكنك استخدام Cloud Identity Groups lookup API لاسترداد المعرّف 123456789 للبريد الإلكتروني للمجموعة group@example.com، ثم يمكنك إضافة المجموعة إلى المساحة من خلال ضبط membership.group_member.name على groups/123456789. لا يتمّ دعم البريد الإلكتروني للمجموعة، ولا يمكن إضافة "مجموعات Google" إلا كأعضاء في المساحات التي تحمل اسمًا.

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

لإنشاء رسالة مباشرة بين المستخدم الذي يطلب هذا الإجراء ومستخدم بشري آخر، حدِّد اشتراكًا واحدًا فقط لتمثيل المستخدم البشري. إذا حظر أحد المستخدمَين الآخر، سيفشل الطلب ولن يتم إنشاء الرسالة المباشرة.

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

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

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

يتطلب مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

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

طلب 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

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

لاستخدام هذا الحقل بفعالية:

  • تأكَّد من أنّ الطلبات اللاحقة متطابقة وتستخدم بيانات المصادقة نفسها المستخدَمة في الطلب الأصلي.
  • إذا سبق إنشاء مساحة باستخدام رقم تعريف الطلب المقدَّم، يعرض الطلب هذه المساحة. يُرجى العِلم أنّ المساحة المعروضة قد لا تكون مكتملة، إذ تعرض واجهة برمجة التطبيقات المساحة في طلبك مع اسم المورد الذي يحدّده النظام. لاسترداد أحدث البيانات الوصفية للمساحة، اتّصِل بـ spaces.get.
  • يؤدي إعادة استخدام رقم تعريف طلب حالي مع مستخدم مصادَق مختلف إلى حدوث خطأ.
memberships[]

object (Membership)

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

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

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

بالنسبة إلى انتساب في مجموعة Google، يجب أن يحتوي الحقل Membership.group_member على group مع name الذي تم تعبئته (التنسيق groups/{group}). لا يمكنك إضافة مجموعات Google إلا عند ضبط Space.spaceType على SPACE.

اختياريّ عند ضبط 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

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