Method: spaces.spaceEvents.list

رویدادها را از فضای چت Google فهرست می کند. برای هر رویداد، محموله حاوی جدیدترین نسخه منبع چت است. برای مثال، اگر رویدادهای مربوط به اعضای جدید فضایی را فهرست کنید، سرور منابع Membership را که حاوی آخرین جزئیات عضویت است، برمی‌گرداند. اگر اعضای جدید در طول دوره درخواستی حذف شوند، بار رویداد حاوی یک منبع Membership خالی است.

نیاز به احراز هویت کاربر دارد. برای فهرست کردن رویدادها، کاربر احراز هویت شده باید عضوی از فضا باشد.

برای مثال، فهرست رویدادها را از فضای گپ Google ببینید.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
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 )

نتایج به ترتیب زمانی برگردانده می شوند (ابتدا قدیمی ترین رویداد).

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.