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

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