يوضّح هذا الدليل كيفية استخدام الأسلوب
patch()
في مورد Space
من Google Chat API لتعديل مساحة. يمكنك تعديل
مساحة لتغيير سمات عن المساحة، مثل الاسم المعروض الذي يظهر للمستخدمين
ووصف المساحة وإرشاداتها.
إذا كنت مشرفًا في Google Workspace، يمكنك استدعاء طريقة patch()
لتعديل أي مساحة حالية في مؤسستك على Google Workspace.
تشير رسالة الأشكال البيانية
مرجع Space
يمثّل مكانًا يمكن فيه للمستخدمين والتطبيقات في Chat إرسال رسائل
ومشاركتها والتعاون. هناك عدة أنواع من المساحات:
- الرسائل المباشرة هي محادثات بين مستخدمَين أو مستخدم وأحد تطبيقات Chat.
- الدردشات الجماعية هي محادثات بين ثلاثة مستخدمين أو أكثر تطبيقات Chat
- المساحات المُعنونة هي أماكن دائمة يرسل من خلالها المستخدمون الرسائل ويشاركون الملفات والتعاون.
المتطلبات الأساسية
Node.js
- نشاط تجاري أو مؤسسة حساب Google Workspace لديه إذن بالوصول إلى Google Chat
- إعداد بيئتك:
- أنشِئ مشروعًا على Google Cloud.
- إعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل Google Chat API وضبطها باستخدام اسم و رمز ووصف لتطبيق Chat.
- تثبيت Node.js Cloud Client Library.
-
أنشئ بيانات اعتماد معرِّف عميل OAuth لتطبيق متوافق مع الكمبيوتر المكتبي. لتنفيذ العيّنة الواردة في
هذا الدليل، احفظ بيانات الاعتماد كملف JSON باسم
client_secrets.json
في الدليل المحلي.
- اختَر نطاق تفويض يتيح مصادقة المستخدمين.
- مساحة في Google Chat لإنشاء مساحة باستخدام Google Chat API، اطّلِع على مقالة إنشاء مساحة. لإنشاء تطبيق في Chat، اتّبِع الخطوات التالية: يُرجى زيارة مستندات مركز المساعدة
Python
- نشاط تجاري أو مؤسسة حساب Google Workspace لديه إذن بالوصول إلى Google Chat
- إعداد بيئتك:
- أنشئ مشروعًا على Google Cloud.
- ضبط شاشة موافقة OAuth
- تفعيل Google Chat API وضبطه باستخدام اسم ورمزه ووصفه لتطبيق Chat.
- تثبيت بايثون Cloud Client Library.
-
أنشئ بيانات اعتماد معرِّف عميل OAuth لتطبيق متوافق مع الكمبيوتر المكتبي. لتنفيذ العيّنة الواردة في
هذا الدليل، احفظ بيانات الاعتماد كملف JSON باسم
client_secrets.json
في الدليل المحلي.
- اختر نطاق تفويض يتيح مصادقة المستخدم.
- مساحة Google Chat لإنشاء مساحة باستخدام Google Chat API، اطّلِع على مقالة إنشاء مساحة. لإنشاء حساب في Chat، انتقِل إلى مستندات مركز المساعدة.
Java
- حساب على Google Workspace من فئة Business أو Enterprise يتيح الوصول إلى Google Chat
- إعداد البيئة:
- أنشِئ مشروعًا على Google Cloud.
- ضبط شاشة موافقة OAuth
- تفعيل Google Chat API وضبطه باستخدام اسم ورمزه ووصفه لتطبيق Chat.
- ثبِّت مكتبة Cloud Client Library لـ Java.
-
أنشئ بيانات اعتماد معرِّف عميل OAuth لتطبيق متوافق مع الكمبيوتر المكتبي. لتنفيذ العيّنة الواردة في
هذا الدليل، احفظ بيانات الاعتماد كملف JSON باسم
client_secrets.json
في الدليل المحلي.
- اختَر نطاق تفويض يتيح مصادقة المستخدمين.
- مساحة في Google Chat لإنشاء حساب باستخدام Google Chat API، يُرجى الاطّلاع على أنشئ مساحة. لإنشاء حساب في Chat، انتقِل إلى مستندات مركز المساعدة.
برمجة تطبيقات
- حساب على Google Workspace من فئة Business أو Enterprise يتيح الوصول إلى Google Chat
- إعداد بيئتك:
- أنشِئ مشروعًا على Google Cloud.
- ضبط شاشة موافقة OAuth
- فعِّل Google Chat API وضبطها باستخدام اسم و رمز ووصف لتطبيق Chat.
- أنشئ مشروعًا مستقلاً في Apps Script، وفعِّل خدمة Chat المتقدّمة.
- اختر نطاق تفويض يتيح مصادقة المستخدم.
- مساحة Google Chat لإنشاء مساحة باستخدام Google Chat API، اطّلِع على مقالة إنشاء مساحة. لإنشاء حساب في Chat، انتقِل إلى مستندات مركز المساعدة.
تعديل مساحة كمستخدم
لتعديل مساحة حالية في Google Chat باستخدام مصادقة المستخدم، عليك إرسال المعلومات التالية في طلبك:
- حدِّد نطاق تفويض
chat.spaces
. - عليك استدعاء
UpdateSpace()
. يمكنك في طلبك تحديد الحقلname
للمسافة وupdateMask
حقلاً يحتوي على حقل واحد أو أكثر مطلوب تعديله، وعلىbody
بالمساحة المعدّلة المعلومات.
يمكنك تعديل عناصر مثل الاسم المعروض ونوع المساحة وحالة السجلّ أخرى. للاطّلاع على جميع الحقول التي يمكنك تعديلها، اطّلِع على المستندات المرجعية.
في ما يلي كيفية تعديل حقل displayName
لمساحة حالية:
Node.js
Python
Java
برمجة تطبيقات
لتنفيذ هذا المثال، استبدِل SPACE_NAME
برقم التعريف من حقل
name
المجموعة. ويمكنك الحصول على المعرّف من خلال استدعاء
ListSpaces()
أو من عنوان URL الخاص بالمساحة.
تعرض Google Chat API مثيلاً
Space
تعكس
التحديثات.
تعديل مساحة بصفتك مشرفًا في Google Workspace
إذا كنت مشرفًا في Google Workspace، يمكنك استدعاء UpdateSpace()
لتعديل أي مساحة في مؤسستك على Google Workspace.
لطلب هذه الطريقة بصفتك مشرف Google Workspace، عليك إجراء ما يلي:
- استخدِم طريقة المصادقة للمستخدم لطلب الإجراء، وحدِّد نطاق التفويض الذي يتيح طلب الإجراء باستخدام امتيازات المشرف.
- في طلبك، حدِّد معلَمة طلب البحث من
useAdminAccess
إلىtrue
.
للاطلاع على المزيد من المعلومات والأمثلة، يُرجى مراجعة إدارة مساحات Google Chat بصفتك مشرفًا في Google Workspace
تعديل مساحة كتطبيق Chat
تتطلّب مصادقة التطبيق الحصول على موافقة المشرف لمرة واحدة.
لتعديل مساحة حالية في Google Chat باستخدام مصادقة التطبيقات قم بتمرير ما يلي في طلبك:
- حدِّد نطاق تفويض
chat.app.spaces
. باستخدام مصادقة التطبيقات، يمكنك تعديل المساحات التي تم إنشاؤها فقط من تطبيقات Chat - عليك استدعاء
طريقة
patch
في مرجعSpace
. في طلبك، حدِّد حقل المساحةname
وحقلupdateMask
الذي يتضمّن حقلًا واحدًا أو أكثر لتعديله وحقلbody
الذي يتضمّن معلومات المساحة المعدَّلة.
يمكنك تعديل عناصر مثل الاسم المعروض ونوع المساحة وحالة السجلّ وإعدادات الأذونات والمزيد. للاطِّلاع على جميع الحقول التي يمكنك تعديلها، يُرجى مراجعة المستندات المرجعية
إنشاء مفتاح واجهة برمجة التطبيقات
لطلب طريقة استخدام واجهة برمجة التطبيقات لمعاينة المطوّر، يجب استخدام إصدار معاينة مطوِّر غير متاح للجميع لمستند Discovery عن واجهة برمجة التطبيقات. ولمصادقة الطلب، عليك تمرير مفتاح واجهة برمجة التطبيقات.
لإنشاء مفتاح واجهة برمجة التطبيقات، افتح مشروع Google Cloud لتطبيقك ونفِّذ ما يلي:
- في وحدة تحكّم Google Cloud، انتقِل إلى رمز القائمة > واجهات برمجة التطبيقات والخدمات > بيانات الاعتماد.
- انقر على إنشاء بيانات اعتماد > مفتاح واجهة برمجة التطبيقات.
- يتم عرض مفتاح واجهة برمجة التطبيقات الجديد.
- انقر على رمز النسخ لنسخ مفتاح واجهة برمجة التطبيقات لاستخدامه في رمز تطبيقك. يمكن أيضًا العثور على مفتاح واجهة برمجة التطبيقات في قسم "مفاتيح واجهة برمجة التطبيقات" ضمن بيانات اعتماد مشروعك.
- انقر على تقييد المفتاح لتعديل الإعدادات المتقدّمة والحد من الاستخدام. لمفتاح واجهة برمجة التطبيقات. لمزيد من التفاصيل، يُرجى الاطّلاع على فرض قيود على مفاتيح واجهة برمجة التطبيقات.
كتابة نص برمجي يستدعي Chat API
في ما يلي كيفية تعديل حقل spaceDetails
لمساحة حالية:
Python
- في دليل العمل، أنشِئ ملفًا باسم "
chat_space_update_app.py
". أدرِج الرمز التالي في
chat_space_update_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"] def main(): ''' Authenticates with Chat API using app authentication, then updates the specified space description and guidelines. ''' # 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().patch( # The space to update, and the updated space details. # # Replace {space} with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE', updateMask='spaceDetails', body={ 'spaceDetails': { 'description': 'This description was updated with Chat API!', 'guidelines': 'These guidelines were updated with Chat API!' } } ).execute() # Prints details about the updated space. print(result) if __name__ == '__main__': main()
في الرمز، استبدِل ما يلي:
API_KEY
: مفتاح واجهة برمجة التطبيقات الذي أنشأته لإنشاء نقطة نهاية الخدمة لواجهة برمجة تطبيقات Chat.- "
SPACE
" باسم مساحة التي يمكنك الحصول عليها من طريقة واحدة (spaces.list
) في Chat API أو من عنوان URL للمساحة.
في دليل العمل، أنشئ النموذج وشغِّله:
python3 chat_space_update_app.py
تعرض Google Chat API مثيلاً
مورد واحد (Space
) يعكس
التحديثات.
مواضيع ذات صلة
- الحصول على تفاصيل عن مساحة
- قائمة المساحات
- حذف المساحة
- إعداد مساحة
- العثور على مساحة رسائل مباشرة
- إتاحة مساحة للاكتشاف من قِبل مستخدمين محدّدين