يوضّح هذا الدليل كيفية استخدام طريقة
get()
في مورد SpaceEvent ضِمن Google Chat API للحصول على تفاصيل حول
حدث من مساحة Google Chat.
يمثّل المورد
SpaceEvent
تغييرًا في مساحة أو مواردها الفرعية، مثل الرسائل،
والتفاعلات، والاشتراكات. للتعرّف على أنواع الأحداث المتوافقة، يُرجى الاطّلاع على الحقل
eventType في مستندات مرجع المورد SpaceEvent.
يمكنك طلب الأحداث قبل ما يصل إلى 28 يومًا من وقت الطلب. يحتوي الحدث على أحدث إصدار من المورد الذي تم تغييره. على سبيل المثال، إذا طلبت حدثًا بشأن رسالة جديدة ولكن تم تعديل الرسالة لاحقًا، يعرض الخادم مورد Message المعدَّل في بيانات الحدث الأساسية.
لاستدعاء هذه الطريقة، يجب استخدام مصادقة المستخدم. للحصول على حدث، يجب أن يكون المستخدم الذي تم التحقّق من هويته عضوًا في المساحة التي وقع فيها الحدث.
المتطلبات الأساسية
Node.js
- حساب على Google Workspace للأعمال أو Google Workspace Enterprise مع إمكانية الوصول إلى Google Chat
- إعداد البيئة:
- إنشاء مشروع على Google Cloud.
- ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth.
- تفعيل Google Chat API وضبطه باستخدام اسم و رمز ووصف لتطبيق Chat.
- تثبيت مكتبة عميل Google Cloud لنظام Node.js
- إنشاء بيانات اعتماد للوصول استنادًا إلى طريقة المصادقة في طلب Google Chat API
request:
- للمصادقة كمستخدم في Chat،
يمكنك إنشاء بيانات اعتماد لرقم تعريف عميل OAuth وحفظها كملف JSON باسم
credentials.jsonفي الدليل المحلي. - للمصادقة كتطبيق Chat،
يمكنك إنشاء بيانات اعتماد لحساب خدمة وحفظها كملف JSON باسم
credentials.json.
- للمصادقة كمستخدم في Chat،
يمكنك إنشاء بيانات اعتماد لرقم تعريف عميل OAuth وحفظها كملف JSON باسم
- اختيار نطاق تفويض استنادًا إلى ما إذا كنت تريد المصادقة كمستخدم أو كتطبيق Chat.
Python
- إعداد البيئة:
- إنشاء مشروع على Google Cloud.
- ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth.
- تفعيل Google Chat API وضبطه باستخدام اسم و رمز ووصف لتطبيق Chat.
- تثبيت مكتبة عميل Google Cloud لنظام Python.
- إنشاء بيانات اعتماد للوصول استنادًا إلى طريقة المصادقة في طلب Google Chat API
request:
- للمصادقة كمستخدم في Chat،
يمكنك إنشاء بيانات اعتماد لرقم تعريف عميل OAuth وحفظها كملف JSON باسم
credentials.jsonفي الدليل المحلي. - للمصادقة كتطبيق Chat،
يمكنك إنشاء بيانات اعتماد لحساب خدمة وحفظها كملف JSON باسم
credentials.json.
- للمصادقة كمستخدم في Chat،
يمكنك إنشاء بيانات اعتماد لرقم تعريف عميل OAuth وحفظها كملف JSON باسم
- اختيار نطاق تفويض استنادًا إلى ما إذا كنت تريد المصادقة كمستخدم أو كتطبيق Chat.
الحصول على تفاصيل حول حدث في مساحة (مصادقة المستخدم)
للحصول على تفاصيل حول حدث في مساحة على Google Chat، يُرجى تمرير ما يلي في طلبك:
- تحديد نطاق تفويض يتيح نوع الحدث في طلبك من أفضل الممارسات اختيار النطاق الأكثر تقييدًا الذي لا يزال يسمح لتطبيقك بالعمل
- استدعاء الطريقة
GetSpaceEvent()، مع تمريرnameلحدث المساحة المطلوب الحصول عليه
يحصل المثال التالي على حدث في مساحة:
Node.js
يستخدم نموذج عينة تعليمات برمجية Node.js هذا Chat RPC API.
لتشغيل هذا النموذج، يُرجى استبدال ما يلي:
SCOPE_NAME: نطاق تفويض استنادًا إلى نوع الحدث على سبيل المثال، إذا كنت تحصل على حدث في مساحة بشأن اشتراك جديد، استخدِم الن0/} النطاق، بتنسيقhttps://www.googleapis.com/auth/chat.memberships.readonly.chat.memberships.readonlyيمكنك الحصول على نوع الحدث من الـListSpaceEvents()طريقة. لمعرفة كيفية استخدام هذه الطريقة، يُرجى الاطّلاع على مقالة عرض قائمة بالأحداث من مساحة.SPACE_NAME: المعرّف منnameللمساحة يمكنك الحصول على المعرّف من خلال استدعاء الـListSpaces()طريقة أو من عنوان URL للمساحة.SPACE_EVENT_NAME: المعرّف منnameلحدث المساحة. يمكنك الحصول على المعرّف من الـListSpaceEvents()طريقة. لمعرفة كيفية استخدام هذه الطريقة، يُرجى الاطّلاع على مقالة عرض قائمة بالأحداث من مساحة.
تعرض Chat API مثيلاً من
SpaceEvent
يتضمّن تفاصيل حول الحدث.
الحصول على تفاصيل حول حدث في مساحة (مصادقة تطبيق Chat)
تتطلب مصادقة التطبيق موافقة المشرف لمرة واحدة .
للحصول على تفاصيل حول حدث في مساحة من مساحة باستخدام مصادقة التطبيق وChat REST API، يُرجى تمرير ما يلي في طلبك:
- تحديد نطاق تفويض واحد أو أكثر لدعم كل نوع حدث في طلبك من أفضل الممارسات اختيار النطاق الأكثر تقييدًا الذي لا يزال يسمح لتطبيقك بالعمل لمزيد من المعلومات حول اختيار نطاق، يُرجى الاطّلاع على
نظرة عامة على المصادقة والتفويض.
https://www.googleapis.com/auth/chat.app.membershipshttps://www.googleapis.com/auth/chat.app.memberships.readonlyhttps://www.googleapis.com/auth/chat.app.messages.readonlyhttps://www.googleapis.com/auth/chat.app.spaceshttps://www.googleapis.com/auth/chat.app.spaces.readonly
- استدعاء طريقة
getفي موردspaceEvents. - تمرير
nameللمساحة التي تريد الحصول على تفاصيل الحدث منها
كتابة نص برمجي يستدعي Chat API
إليك كيفية الحصول على تفاصيل حول حدث في مساحة باستخدام مصادقة التطبيق و Chat REST API:
Python
يستخدم نموذج رمز Python هذا Chat REST API.
- في دليل العمل، أنشئ ملفًا باسم
chat_spaceevents_get_app.py. أدرِج الرمز التالي في
chat_spaceevents_get_app.py:from google.oauth2 import service_account from apiclient.discovery import build # Define your app's authorization scopes. # Set authorization scopes based on the # event type. For example, if you are getting a space event # about a new membership, use the `chat.app.memberships` scope. # # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.app.memberships", "https://www.googleapis.com/auth/chat.app.memberships.readonly", "https://www.googleapis.com/auth/chat.app.messages.readonly", "https://www.googleapis.com/auth/chat.app.spaces", "https://www.googleapis.com/auth/chat.app.spaces.readonly"] def main(): ''' Authenticates with Chat API using app authentication, then lists space events from a specified 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) # Use the service endpoint to call Chat API. result = chat.spaces().spaceEvents().get( # The space to get event details from. # # Replace SPACE_NAME with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE_NAME/spaceEvents/SPACE_EVENT_NAME', ).execute() # Print Chat API's response in your command line interface. print(result) if __name__ == '__main__': main()في الرمز، استبدِل ما يلي:
SPACE_NAME: اسم مساحة، يمكنك الحصول عليه منspaces.listالطريقة في Chat API أو من عنوان URL لمساحةSPACE_EVENT_NAME: المعرّف منnameلحدث المساحة. يمكنك الحصول على المعرّف من الـListSpaceEvents()طريقة. لمعرفة كيفية استخدام هذه الطريقة، يُرجى الاطّلاع على مقالة عرض قائمة بالأحداث من مساحة.
في دليل العمل، أنشئ النموذج وشغِّله:
python3 chat_spaceevents_get_app.py
تعرض Chat API قائمة مرقّمة بالأحداث في المساحة حول الاشتراكات والرسائل الجديدة.