Method: spaces.spaceEvents.list

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

از انواع احراز هویت زیر با دامنه مجوز مناسب برای خواندن داده‌های درخواستی پشتیبانی می‌کند:

  • احراز هویت برنامه با تأیید مدیر با یکی از حوزه‌های مجوز زیر:

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

  • احراز هویت کاربر با یکی از حوزه‌های مجوز زیر:

    • 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

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

برای مثال، به فهرست کردن رویدادها از فضای چت گوگل مراجعه کنید.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
parent

string

الزامی. نام منبع فضای چت گوگل که رویدادها در آن رخ داده‌اند.

قالب: 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 : یک مهر زمانی اختصاصی که از آن می‌توانید فهرست رویدادهای فضایی را شروع کنید. می‌توانید رویدادهایی را که تا ۲۸ روز پیش رخ داده‌اند فهرست کنید. اگر مشخص نشده باشد، رویدادهای فضایی از ۲۸ روز گذشته را فهرست می‌کند.
  • 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.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • 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

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

،

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

از انواع احراز هویت زیر با دامنه مجوز مناسب برای خواندن داده‌های درخواستی پشتیبانی می‌کند:

  • احراز هویت برنامه با تأیید مدیر با یکی از حوزه‌های مجوز زیر:

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

  • احراز هویت کاربر با یکی از حوزه‌های مجوز زیر:

    • 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

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

برای مثال، به فهرست کردن رویدادها از فضای چت گوگل مراجعه کنید.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
parent

string

الزامی. نام منبع فضای چت گوگل که رویدادها در آن رخ داده‌اند.

قالب: 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 : یک مهر زمانی اختصاصی که از آن می‌توانید فهرست رویدادهای فضایی را شروع کنید. می‌توانید رویدادهایی را که تا ۲۸ روز پیش رخ داده‌اند فهرست کنید. اگر مشخص نشده باشد، رویدادهای فضایی از ۲۸ روز گذشته را فهرست می‌کند.
  • 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.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • 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

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