Method: spaces.spaceEvents.list

يسرد الأحداث من مساحة Google Chat. بالنسبة إلى كل حدث، تحتوي payload على أحدث إصدار من مرجع 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) باستخدام عامل التشغيل :. للفلترة حسب أنواع أحداث متعدّدة، استخدِم عامل التشغيل 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)

يتم عرض النتائج بترتيب زمني (الحدث الأقدم أولاً).
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

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