الحصول على تفاصيل عن حدث في مساحة Google Chat

يوضِّح هذا الدليل طريقة استخدام طريقة get في مورد SpaceEvent Google Chat API للحصول على تفاصيل حول حدث من مساحة في Google Chat.

يمثِّل المورد SpaceEvent تغييرًا في مساحة أو في الموارد الفرعية، مثل الرسائل والتفاعلات والاشتراكات. لمزيد من المعلومات عن أنواع الأحداث المتوافقة، يُرجى الاطّلاع على الحقل eventType في المستندات المرجعية لموارد SpaceEvent.

يمكنك طلب أحداث قبل 28 يومًا من وقت الطلب كحد أقصى. يحتوي الحدث على أحدث إصدار من المورد الذي تم تغييره. على سبيل المثال، إذا طلبت حدثًا حول رسالة جديدة ولكن تم تعديل الرسالة لاحقًا، يعرض الخادم مورد Message المعدّل في حمولة الحدث.

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

المتطلبات الأساسية

Python

  • Python 3.6 أو أحدث
  • تتيح لك أداة إدارة الحِزم pip

  • أحدث مكتبات عملاء Google للغة Python. لتثبيتها أو تحديثها، شغّل الأمر التالي في واجهة سطر الأوامر:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • مشروع على Google Cloud تم فيه تفعيل Google Chat API وضبطه لمعرفة الخطوات، يُرجى الاطّلاع على مقالة إنشاء تطبيق Google Chat.

  • تم ضبط التفويض لتطبيق Chat. يتطلب الحصول على حدث مساحة مصادقة المستخدم مع نطاق يتوافق مع نوع الحدث. لاختيار نطاق، يُرجى الاطّلاع على نظرة عامة على المصادقة والترخيص.

الحصول على تفاصيل عن حدث في مساحة

للحصول على تفاصيل عن "SpaceEvent" في Google Chat، يمكنك اتّباع الخطوات التالية:

  • عليك استدعاء طريقة get في SpaceEvent المورد.
  • عليك اجتياز اختبارَي name من SpaceEvent للحصول على العرض. احصل على اسم SpaceEvent من SpaceEvent مورد Google Chat.
  • باستخدام مصادقة المستخدم، حدِّد نطاق تفويض يتيح نوع الحدث في طلبك. من بين أفضل الممارسات، اختر النطاق الأكثر تقييدًا الذي لا يزال يسمح لتطبيقك بالعمل.

إليك كيفية الحصول على SpaceEvent باستخدام مصادقة المستخدم:

Python

  1. في دليل العمل، أنشِئ ملفًا باسم chat_space_event_get.py.

  2. ضمِّن الرمز التالي في chat_space_event_get.py:

    """Gets a SpaceEvent resource from the Chat API."""

from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ['SCOPE']

# Authenticate with Google Workspace
# and get user authorization.
flow = InstalledAppFlow.from_client_secrets_file('client_secrets.json', SCOPES)
creds = flow.run_local_server()

# 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 event to get.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        #
        # Replace SPACE_EVENT with a SpaceEvent name.
        # Obtain the spaceEvent name from the SpaceEvent resource of
        # Chat API.
        name='spaces/SPACE/spaceEvents/SPACE_EVENT'
    )
    .execute()
)

# Prints details about the created spaceEvent.
print(result)

  3. في التعليمة البرمجية، استبدل ما يلي:

    • SCOPE: نطاق تفويض استنادًا إلى نوع الحدث. على سبيل المثال، إذا كنت ستنظم حدثًا في مساحة بشأن اشتراك جديد، استخدِم نطاق chat.memberships.readonly، المنسّق على النحو التالي: https://www.googleapis.com/auth/chat.memberships.readonly. يمكنك الحصول على نوع الحدث من طريقة spaces.spaceEvents.list. للتعرّف على طريقة استخدام هذه الطريقة، يمكنك الاطّلاع على إدراج أحداث من مساحة.
    • SPACE: اسم مساحة يمكنك الحصول عليه من خلال طريقة spaces.list في Chat API أو من عنوان URL الخاص بالمساحة
    • SPACE_EVENT: اسم حدث الفضاء الذي يمكنك الحصول عليه من طريقة spaces.spaceEvents.list.

  4. في دليل العمل، أنشئ النموذج وقم بتشغيله:

    python3 chat_space_event_get.py

تعرض Chat API مثيل SpaceEvent مع تفاصيل عن الحدث.