- درخواست HTTP
- پارامترهای مسیر
- پارامترهای پرس و جو
- درخواست بدن
- بدن پاسخگو
- محدوده مجوز
- آن را امتحان کنید!
رویدادها را از فضای چت Google فهرست می کند. برای هر رویداد، محموله حاوی جدیدترین نسخه منبع چت است. برای مثال، اگر رویدادهای مربوط به اعضای جدید فضایی را فهرست کنید، سرور منابع Membership
را که حاوی آخرین جزئیات عضویت است، برمیگرداند. اگر اعضای جدید در طول دوره درخواستی حذف شوند، بار رویداد حاوی یک منبع Membership
خالی است.
نیاز به احراز هویت کاربر دارد. برای فهرست کردن رویدادها، کاربر احراز هویت شده باید عضوی از فضا باشد.
برای مثال، فهرست رویدادها را از فضای گپ Google ببینید.
درخواست HTTP
GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
پارامترها | |
---|---|
parent | مورد نیاز. نام منبع فضای Google Chat که رویدادها در آن رخ داده است. قالب: |
پارامترهای پرس و جو
پارامترها | |
---|---|
pageSize | اختیاری. حداکثر تعداد رویدادهای فضایی برگردانده شده است. ممکن است این سرویس کمتر از این مقدار را برگرداند. مقادیر منفی یک خطای |
pageToken | یک نشانه صفحه، دریافت شده از تماس رویدادهای فضایی فهرست قبلی. این را برای بازیابی صفحه بعدی ارائه کنید. هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده برای فهرست رویدادهای فضایی باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد. انتقال مقادیر مختلف به سایر پارامترها ممکن است منجر به نتایج غیرمنتظره شود. |
filter | مورد نیاز. یک فیلتر پرس و جو شما باید حداقل یک نوع رویداد ( به صورت اختیاری، میتوانید بر اساس زمان شروع (
برای تعیین زمان شروع یا پایان، از عملگر و فرمت برابر به عنوان مثال، پرس و جوهای زیر معتبر هستند:
جستارهای زیر نامعتبر هستند:
درخواستهای نامعتبر توسط سرور با خطای |
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
پیام پاسخ برای فهرست کردن رویدادهای فضایی.
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{
"spaceEvents": [
{
object ( |
فیلدها | |
---|---|
spaceEvents[] | نتایج به ترتیب زمانی برگردانده می شوند (ابتدا قدیمی ترین رویداد). |
nextPageToken | رمز ادامه برای واکشی رویدادهای بیشتر استفاده می شود. اگر این قسمت حذف شود، هیچ صفحه بعدی وجود ندارد. |
محدوده مجوز
به یکی از حوزه های 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
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.