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 هذا الاسم المعروض.

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

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

بالنسبة إلى عضوية مجموعة 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

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