Method: spaces.spaceEvents.list

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

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

على سبيل المثال، راجِع إنشاء قائمة بالأحداث من مساحة 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 في عنصر Space لطلبات القوائم.
nextPageToken

string

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

نطاقات التفويض

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

  • 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

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