يشرح هذا الدليل كيفية استخدام
create()
على المورد Space
من Google Chat API لإنشاء مساحة مُعنوَنة.
يمثّل
مورد Space
مكانًا يمكن فيه للمستخدمين وتطبيقات Chat إرسال الرسائل
ومشاركة الملفات والتعاون. هناك عدة أنواع من المساحات:
- الرسائل المباشرة هي محادثات بين مستخدمَين أو مستخدم وأحد تطبيقات Chat.
- المحادثات الجماعية هي محادثات بين ثلاثة مستخدمين أو أكثر وتطبيقات Chat.
- المساحات المُعنونة هي أماكن دائمة يرسل من خلالها المستخدمون الرسائل ويشاركون الملفات والتعاون.
المساحة المعنوَنة هي مكان يرسل فيه الأشخاص الرسائل ويشاركون الملفات والتعاون. يمكن أن تتضمّن المساحات المُسمّاة تطبيقات Chat. المساحات المُعنونة تضمين ميزات إضافية لا تتضمن المحادثات الجماعية والرسائل المباشرة غير متاحة لهم، مثل مدراء المساحات الذين يمكنهم تطبيق الإعدادات الإدارية والأوصاف وإضافة أو إزالة الأشخاص والتطبيقات. بعد إنشاء مساحة مُعنوَنة، ويكون العضو الوحيد في المساحة هو المستخدم الذي تمت مصادقته. لا تشمل المساحة مستخدمين أو تطبيقات أخرى، ولا حتى تطبيق Chat الذي أنشأها. لإضافة أعضاء إلى مساحة، يمكنك الاطّلاع على أنشئ عضوية.
لإنشاء مساحة مُسمّاة تضم عدة أعضاء، وهي محادثة جماعية بدون اسم بين أو ثلاثة أشخاص أو أكثر، أو محادثة مباشرة بين شخصين، أو الشخص وتطبيق Chat الذي يتصل Chat API: إعداد مساحة بدلاً من ذلك.
المتطلبات الأساسية
Node.js
- حساب على Google Workspace من فئة Business أو Enterprise يتيح الوصول إلى Google Chat
- إعداد بيئتك:
- أنشِئ مشروعًا على Google Cloud.
- ضبط شاشة موافقة OAuth
- تفعيل Google Chat API وضبطه باستخدام اسم ورمزه ووصفه لتطبيق Chat.
- ثبِّت مكتبة برامج Cloud Client Library لنظام التشغيل Node.js.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد المصادقة بها في طلب Google Chat API:
- لمصادقة مستخدم Chat،
أنشئ بيانات اعتماد معرّف العميل لبروتوكول OAuth
واحفظ بيانات الاعتماد كملف JSON باسم
client_secrets.json
في الدليل المحلي. - لمصادقة تطبيق Chat،
أنشئ بيانات اعتماد
حساب الخدمة واحفظ بيانات الاعتماد كملف JSON باسم
credentials.json
.
- لمصادقة مستخدم Chat،
أنشئ بيانات اعتماد معرّف العميل لبروتوكول OAuth
واحفظ بيانات الاعتماد كملف JSON باسم
- اختَر نطاق التفويض استنادًا إلى ما إذا كنت تريد المصادقة بصفتك مستخدمًا أو تطبيق Chat.
Python
- حساب على Google Workspace من فئة Business أو Enterprise يتيح الوصول إلى Google Chat
- إعداد بيئتك:
- أنشئ مشروعًا على Google Cloud.
- ضبط شاشة موافقة OAuth
- فعِّل Google Chat API وضبطها باستخدام اسم و رمز ووصف لتطبيق Chat.
- ثبِّت مكتبة Cloud Client Library لـ Python.
- إنشاء بيانات اعتماد الوصول استنادًا إلى طريقة المصادقة في Google Chat API
الطلب:
- للمصادقة كمستخدم Chat،
إنشاء معرِّف عميل OAuth
بيانات الاعتماد وحفظ بيانات الاعتماد كملف JSON
client_secrets.json
إلى الدليل المحلي. - للمصادقة كتطبيق Chat، اتّبِع الخطوات التالية:
إنشاء حساب خدمة
بيانات الاعتماد وحفظ بيانات الاعتماد كملف JSON
credentials.json
- للمصادقة كمستخدم Chat،
إنشاء معرِّف عميل OAuth
بيانات الاعتماد وحفظ بيانات الاعتماد كملف JSON
- اختَر نطاق التفويض استنادًا إلى ما إذا كنت تريد المصادقة بصفتك مستخدمًا أو تطبيق Chat.
Java
- حساب على Google Workspace من فئة Business أو Enterprise يتيح الوصول إلى Google Chat
- إعداد البيئة:
- أنشِئ مشروعًا على Google Cloud.
- ضبط شاشة موافقة OAuth
- فعِّل Google Chat API وضبطها باستخدام اسم و رمز ووصف لتطبيق Chat.
- ثبِّت مكتبة Cloud Client Library لـ Java.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد المصادقة بها في طلب Google Chat API:
- لمصادقة مستخدم Chat،
أنشئ بيانات اعتماد معرّف العميل لبروتوكول OAuth
واحفظ بيانات الاعتماد كملف JSON باسم
client_secrets.json
في الدليل المحلي. - لمصادقة تطبيق Chat،
أنشئ بيانات اعتماد
حساب الخدمة واحفظ بيانات الاعتماد كملف JSON باسم
credentials.json
.
- لمصادقة مستخدم Chat،
أنشئ بيانات اعتماد معرّف العميل لبروتوكول OAuth
واحفظ بيانات الاعتماد كملف JSON باسم
- اختر نطاق تفويض استنادًا إلى ما إذا كنت تريد المصادقة كمستخدم أو تطبيق Chat
برمجة تطبيقات
- نشاط تجاري أو مؤسسة حساب Google Workspace لديه إذن بالوصول إلى Google Chat
- إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- ضبط شاشة موافقة OAuth
- فعِّل Google Chat API وضبطها باستخدام اسم و رمز ووصف لتطبيق Chat.
- إنشاء مشروع "برمجة تطبيقات Google" مستقل وفعِّل خدمة المحادثة المتقدّمة.
- في هذا الدليل، يجب عليك استخدام أي من أو مصادقة التطبيقات للمصادقة بصفتك تطبيق Chat، أنشئ بيانات اعتماد حساب الخدمة. لمعرفة الخطوات، يُرجى الاطّلاع على المصادقة والتفويض تطبيق Google Chat
- اختر نطاق تفويض استنادًا إلى ما إذا كنت تريد المصادقة كمستخدم أو تطبيق Chat
إنشاء مساحة مُعنوَنة كمستخدم
لإنشاء مساحة مُسمّاة باستخدام مصادقة المستخدم، ضبط ما يلي في طلبك:
- حدِّد نطاق التفويض
chat.spaces.create
أوchat.spaces
. - عليك استدعاء
CreateSpace()
لتمريرspace
كمثيلSpace
مع الحقول التالية:- تم ضبط
spaceType
على SPACE
. displayName
تم ضبطه على اسم المساحة المرئي للمستخدم- يمكنك اختياريًا ضبط سمات أخرى، مثل ما يلي:
spaceDetails
- وصف مرئي للمستخدم ومجموعة من الإرشادات المساحة.predefinedPermissionSettings
: الأذونات المحدّدة مسبقًا للمساحة على سبيل المثال، يمكنك ضبط الإعدادات بحيث يتمكّن جميع الأعضاء أو مديرو المساحة فقط من نشر الرسائل.
- تم ضبط
في ما يلي كيفية إنشاء مساحة مُسمّاة:
Node.js
Python
Java
برمجة تطبيقات
إنشاء مساحة مُسمّاة كتطبيق Chat
تتطلّب مصادقة التطبيق الحصول على موافقة المشرف لمرة واحدة.
لدعوة مستخدم أو إضافته إلى مساحة باستخدام مصادقة التطبيق، Pass ما يلي في طلبك:
- حدِّد نطاق التفويض
chat.app.spaces.create
أوchat.app.spaces
. - استخدِم
طريقة
create
في موردSpace
. - اضبط
spaceType
علىSPACE
. - ضبط
displayName
إلى اسم المساحة المرئي للمستخدمين في المثال التالي،displayName
تم ضبطها علىAPI-made
. - حدِّد رقم تعريف العميل لنطاق Google Workspace باستخدام الحقل
customer
. - يمكنك اختياريًا ضبط سمات أخرى للمساحة، مثل
spaceDetails
(وصف يظهر للمستخدم ومجموعة من الإرشادات للمساحة).
إنشاء مفتاح واجهة برمجة التطبيقات
لاستدعاء طريقة واجهة برمجة التطبيقات في "معاينة المطوّر"، يجب استخدام إصدار غير متاح للجميع من "معاينة المطوّر" لمستند استكشاف واجهة برمجة التطبيقات. لمصادقة الطلب، يجب إدخال مفتاح واجهة برمجة التطبيقات.
لإنشاء مفتاح واجهة برمجة التطبيقات، افتح مشروع تطبيقك على Google Cloud واتّبِع الخطوات التالية:
- في وحدة التحكّم في Google Cloud، انتقِل إلى القائمة > واجهات برمجة التطبيقات الخدمات > بيانات الاعتماد. .
- انقر على إنشاء بيانات الاعتماد >. مفتاح واجهة برمجة التطبيقات.
- يتم عرض مفتاح واجهة برمجة التطبيقات الجديد.
- انقر على "نسخ ". لنسخ مفتاح واجهة برمجة التطبيقات لاستخدامه في رمز تطبيقك يمكن أيضًا أن يكون مفتاح واجهة برمجة التطبيقات التي تم العثور عليها في "مفاتيح واجهة برمجة التطبيقات" في بيانات اعتماد مشروعك.
- انقر على تقييد المفتاح لتعديل الإعدادات المتقدّمة والحد من الاستخدام. لمفتاح واجهة برمجة التطبيقات. لمزيد من التفاصيل، يُرجى الاطّلاع على فرض قيود على مفاتيح واجهة برمجة التطبيقات.
كتابة نص برمجي يستدعي Chat API
إليك كيفية إنشاء مساحة مُعنوَنة:
Python
- في دليل العمل، أنشِئ ملفًا باسم "
chat_space_create_named_app.py
". أدرِج الرمز التالي في
chat_space_create_named_app.py
:from google.oauth2 import service_account from apiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.app.spaces.create"] def main(): ''' Authenticates with Chat API using app authentication, then creates a Chat space. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # Use the service endpoint to call Chat API. result = chat.spaces().create( # Details about the space to create. body = { # To create a named space, set spaceType to SPACE. 'spaceType': 'SPACE', # The user-visible name of the space. 'displayName': 'API-made', # The customer ID of the Workspace domain. 'customer': 'CUSTOMER' } ).execute() # Prints details about the created space. print(result) if __name__ == '__main__': main()
في الرمز، استبدِل ما يلي:
API_KEY
: مفتاح واجهة برمجة التطبيقات الذي أنشأته لإنشاء نقطة نهاية الخدمة لواجهة برمجة التطبيقات Chat API.CUSTOMER
: رقم تعريف العميل لنطاق ال مساحة بالتنسيقcustomer/{customer}
حيث يكون{customer}
هوID
من مرجع العميل في حزمة SDK للمشرف. لإنشاء مساحة في مؤسسة Google Workspace نفسها تطبيق Chat، استخدِم "customers/my_customer
".
في دليل العمل، أنشئ النموذج وشغِّله:
python3 chat_space_create_named_app.py
فتح المساحة في Google Chat
للانتقال إلى المساحة، استخدِم رقم تعريف المورد الخاص بالمساحة.
لإنشاء عنوان URL للمساحة. يمكنك العثور على رقم تعريف المورد من المساحة.
name
في نص استجابة Google Chat. على سبيل المثال، إذا كان
name
لمساحة معيّنة هو spaces/1234567
، يمكنك الانتقال إلى المساحة باستخدام
عنوان URL التالي: https://mail.google.com/chat/u/0/#chat/space/1234567
.
مواضيع ذات صلة
- أضِف مستخدمين وتطبيقات إلى المساحة من خلال إنشاء أعضاء.
- يمكنك نشر رسالة في المساحة من خلال إنشاء رسالة
- الحصول على تفاصيل عن مساحة
- إدراج المساحات:
- تعديل مساحة
- حذف مساحة
- إعداد مساحة
- العثور على مساحة رسائل مباشرة
- إتاحة مساحة للاكتشاف من قِبل مستخدمين محدّدين