Method: spaces.spaceEvents.list

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

تتيح الأنواع التالية من المصادقة مع نطاق تفويض مناسب لقراءة البيانات المطلوبة:

  • مصادقة التطبيق من خلال موافقة المشرف في إصدار تجريبي من البرنامج مع أحد نطاقات التفويض التالية:

    • https://www.googleapis.com/auth/chat.app.spaces
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.memberships

  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.messages.reactions.readonly
    • https://www.googleapis.com/auth/chat.messages.reactions
    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships

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

للاطّلاع على مثال، راجِع إدراج أحداث من مساحة في Google Chat.

طلب HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents

يستخدم عنوان URL بنية تحويل الترميز إلى gRPC.

مَعلمات المسار

المعلمات
parent

string

مطلوب. اسم المورد لمساحة Google Chat التي وقعت فيها الأحداث.

التنسيق: spaces/{space}

مَعلمات طلب البحث

المعلمات
pageSize

integer

اختياريّ. تمثّل هذه السمة الحدّ الأقصى لعدد أحداث المساحة التي يتم عرضها. قد تعرض الخدمة عددًا أقل من هذه القيمة.

تعرض القيم السالبة الخطأ INVALID_ARGUMENT.
pageToken

string

اختياريّ. رمز مميّز للصفحة تم استلامه من طلب سابق لعرض أحداث المساحة. قدِّم هذه السلسلة لاسترداد الصفحة التالية.

عند تقسيم المحتوى إلى صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة لأحداث مساحة العرض مع الطلب الذي قدّم رمز الصفحة. قد يؤدي تمرير قيم مختلفة إلى المَعلمات الأخرى إلى نتائج غير متوقّعة.
filter

string

مطلوب. فلتر طلب البحث

يجب تحديد نوع حدث واحد على الأقل (eventType) باستخدام عامل التشغيل has :. للفلترة حسب أنواع أحداث متعدّدة، استخدِم عامل التشغيل OR. احذف أنواع أحداث الدفعات من الفلتر. يعرض الطلب تلقائيًا أي أحداث دفعات ذات صلة. على سبيل المثال، إذا كنت تريد فلترة النتائج حسب التفاعلات الجديدة (google.workspace.chat.reaction.v1.created)، سيعرض الخادم أيضًا أحداث التفاعلات الجديدة المجمّعة (google.workspace.chat.reaction.v1.batchCreated). للاطّلاع على قائمة بأنواع الأحداث المتوافقة، يُرجى الرجوع إلى المستندات المرجعية SpaceEvents.

يمكنك أيضًا فلترة البيانات حسب وقت البدء (startTime) ووقت الانتهاء (endTime):

  • ‫startTime: الطابع الزمني الحصري الذي سيتم بدء إدراج أحداث المساحة منه. يمكنك إدراج الأحداث التي وقعت قبل ما يصل إلى 28 يومًا. في حال عدم تحديدها، تعرض القوائم أحداث المساحة من آخر 28 يومًا.
  • ‫endTime: طابع زمني شامل يتم عرض أحداث المساحة حتى هذا الوقت. في حال عدم تحديدها، يتم عرض الأحداث حتى وقت الطلب.

لتحديد وقت البدء أو الانتهاء، استخدِم عامل التشغيل يساوي = والتنسيق RFC-3339. للفلترة حسب كل من startTime وendTime، استخدِم عامل التشغيل AND.

على سبيل المثال، الاستعلامات التالية صالحة:

startTime="2023-08-23T19:20:33+00:00" AND
endTime="2023-08-23T19:21:54+00:00"

startTime="2023-08-23T19:20:33+00:00" AND
(eventTypes:"google.workspace.chat.space.v1.updated" OR
eventTypes:"google.workspace.chat.message.v1.created")

طلبات البحث التالية غير صالحة:

startTime="2023-08-23T19:20:33+00:00" OR
endTime="2023-08-23T19:21:54+00:00"

eventTypes:"google.workspace.chat.space.v1.updated" AND
eventTypes:"google.workspace.chat.message.v1.created"

يرفض الخادم طلبات البحث غير الصالحة ويعرض الخطأ INVALID_ARGUMENT.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

رسالة الردّ لعرض أحداث المساحة.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "spaceEvents": [
    {
      object (SpaceEvent)
    }
  ],
  "nextPageToken": string
}
الحقول
spaceEvents[]

object (SpaceEvent)

يتم عرض النتائج بترتيب زمني (الحدث الأقدم أولاً). ملاحظة: لا يتم عرض الحقل permissionSettings في عنصر المساحة لطلبات القائمة.
nextPageToken

string

رمز مميز للمتابعة يُستخدَم لجلب المزيد من الأحداث. في حال حذف هذا الحقل، لن تكون هناك صفحات لاحقة.

نطاقات الأذونات

يجب توفير أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

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