Method: spaces.messages.list

پیام‌های موجود در فضایی که فراخواننده عضو آن است، از جمله پیام‌های اعضای مسدود شده و فضاها را فهرست می‌کند. پیام‌های سیستمی، مانند پیام‌هایی که اعضای فضای جدید را اعلام می‌کنند، شامل نمی‌شوند. اگر پیام‌های یک فضا را بدون هیچ پیامی فهرست کنید، پاسخ یک شیء خالی است. هنگام استفاده از رابط REST/HTTP، پاسخ حاوی یک شیء JSON خالی، {} است. برای مثال، به List messages مراجعه کنید.

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

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

    • https://www.googleapis.com/auth/chat.app.messages.readonly . هنگام استفاده از این محدوده احراز هویت، این متد فقط پیام‌های عمومی را در یک فاصله برمی‌گرداند. این شامل پیام‌های خصوصی نمی‌شود.

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

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (فقط فاصله‌ها در حالت واردات)

درخواست HTTP

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

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

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

پارامترها
parent

string

الزامی. نام منبع فضایی که پیام‌ها از آن فهرست می‌شوند.

قالب: spaces/{space}

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

پارامترها
pageSize

integer

اختیاری. حداکثر تعداد پیام‌های برگشتی. سرویس ممکن است پیام‌های کمتری از این مقدار برگرداند.

اگر مشخص نشده باشد، حداکثر ۲۵ عدد برگردانده می‌شود.

حداکثر مقدار ۱۰۰۰ است. اگر از مقداری بیش از ۱۰۰۰ استفاده کنید، به طور خودکار به ۱۰۰۰ تغییر می‌کند.

مقادیر منفی خطای INVALID_ARGUMENT را برمی‌گردانند.

pageToken

string

اختیاری. یک توکن صفحه که از فراخوانی پیام‌های لیست قبلی دریافت شده است. این پارامتر را برای بازیابی صفحه بعدی ارائه دهید.

هنگام صفحه‌بندی، تمام پارامترهای دیگر ارائه شده باید با فراخوانی که توکن صفحه را ارائه داده است، مطابقت داشته باشند. ارسال مقادیر متفاوت به سایر پارامترها ممکن است منجر به نتایج غیرمنتظره‌ای شود.

filter

string

اختیاری. یک فیلتر پرس‌وجو.

شما می‌توانید پیام‌ها را بر اساس تاریخ ( createTime ) و رشته ( thread.name ) فیلتر کنید.

برای فیلتر کردن پیام‌ها بر اساس تاریخ ایجاد آنها، createTime با یک مهر زمانی در قالب RFC-3339 و علامت نقل قول دوگانه مشخص کنید. به عنوان مثال، "2023-04-21T11:30:00-04:00" . می‌توانید از عملگر بزرگتر از > برای لیست کردن پیام‌هایی که بعد از یک مهر زمانی ایجاد شده‌اند، یا از عملگر کوچکتر از < برای لیست کردن پیام‌هایی که قبل از یک مهر زمانی ایجاد شده‌اند، استفاده کنید. برای فیلتر کردن پیام‌ها در یک بازه زمانی، از عملگر AND بین دو مهر زمانی استفاده کنید.

برای فیلتر کردن بر اساس رشته، thread.name مشخص کنید که به صورت spaces/{space}/threads/{thread} فرمت شده است. شما فقط می‌توانید یک thread.name برای هر پرس‌وجو مشخص کنید.

برای فیلتر کردن بر اساس هر دو مورد thread و date، از عملگر AND در کوئری خود استفاده کنید.

برای مثال، درخواست‌های زیر معتبر هستند:

createTime > "2012-04-21T11:30:00-04:00"

createTime > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

createTime > "2012-04-21T11:30:00+00:00" AND

createTime < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

درخواست‌های نامعتبر توسط سرور با خطای INVALID_ARGUMENT رد می‌شوند.

orderBy

string

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

  • ASC برای صعود.

  • DESC برای نزولی.

ترتیب پیش‌فرض createTime ASC است.

showDeleted

boolean

اختیاری. آیا پیام‌های حذف‌شده را هم شامل شود یا خیر. پیام‌های حذف‌شده شامل زمان حذف و فراداده مربوط به حذفشان می‌شوند، اما محتوای پیام در دسترس نیست.

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

پیام پاسخ برای فهرست کردن پیام‌ها.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
فیلدها
messages[]

object ( Message )

فهرست پیام‌ها.

nextPageToken

string

شما می‌توانید یک توکن به عنوان pageToken ارسال کنید تا صفحه بعدی نتایج را بازیابی کنید. اگر خالی باشد، صفحات بعدی وجود ندارند.

دامنه‌های مجوز

به یکی از حوزه‌های OAuth زیر نیاز دارد:

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

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

،

پیام‌های موجود در فضایی که فراخواننده عضو آن است، از جمله پیام‌های اعضای مسدود شده و فضاها را فهرست می‌کند. پیام‌های سیستمی، مانند پیام‌هایی که اعضای فضای جدید را اعلام می‌کنند، شامل نمی‌شوند. اگر پیام‌های یک فضا را بدون هیچ پیامی فهرست کنید، پاسخ یک شیء خالی است. هنگام استفاده از رابط REST/HTTP، پاسخ حاوی یک شیء JSON خالی، {} است. برای مثال، به List messages مراجعه کنید.

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

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

    • https://www.googleapis.com/auth/chat.app.messages.readonly . هنگام استفاده از این محدوده احراز هویت، این متد فقط پیام‌های عمومی را در یک فاصله برمی‌گرداند. این شامل پیام‌های خصوصی نمی‌شود.

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

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (فقط فاصله‌ها در حالت واردات)

درخواست HTTP

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

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

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

پارامترها
parent

string

الزامی. نام منبع فضایی که پیام‌ها از آن فهرست می‌شوند.

قالب: spaces/{space}

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

پارامترها
pageSize

integer

اختیاری. حداکثر تعداد پیام‌های برگشتی. سرویس ممکن است پیام‌های کمتری از این مقدار برگرداند.

اگر مشخص نشده باشد، حداکثر ۲۵ عدد برگردانده می‌شود.

حداکثر مقدار ۱۰۰۰ است. اگر از مقداری بیش از ۱۰۰۰ استفاده کنید، به طور خودکار به ۱۰۰۰ تغییر می‌کند.

مقادیر منفی خطای INVALID_ARGUMENT را برمی‌گردانند.

pageToken

string

اختیاری. یک توکن صفحه که از فراخوانی پیام‌های لیست قبلی دریافت شده است. این پارامتر را برای بازیابی صفحه بعدی ارائه دهید.

هنگام صفحه‌بندی، تمام پارامترهای دیگر ارائه شده باید با فراخوانی که توکن صفحه را ارائه داده است، مطابقت داشته باشند. ارسال مقادیر متفاوت به سایر پارامترها ممکن است منجر به نتایج غیرمنتظره‌ای شود.

filter

string

اختیاری. یک فیلتر پرس‌وجو.

شما می‌توانید پیام‌ها را بر اساس تاریخ ( createTime ) و رشته ( thread.name ) فیلتر کنید.

برای فیلتر کردن پیام‌ها بر اساس تاریخ ایجاد آنها، createTime با یک مهر زمانی در قالب RFC-3339 و علامت نقل قول دوگانه مشخص کنید. به عنوان مثال، "2023-04-21T11:30:00-04:00" . می‌توانید از عملگر بزرگتر از > برای لیست کردن پیام‌هایی که بعد از یک مهر زمانی ایجاد شده‌اند، یا از عملگر کوچکتر از < برای لیست کردن پیام‌هایی که قبل از یک مهر زمانی ایجاد شده‌اند، استفاده کنید. برای فیلتر کردن پیام‌ها در یک بازه زمانی، از عملگر AND بین دو مهر زمانی استفاده کنید.

برای فیلتر کردن بر اساس رشته، thread.name مشخص کنید که به صورت spaces/{space}/threads/{thread} فرمت شده است. شما فقط می‌توانید یک thread.name برای هر پرس‌وجو مشخص کنید.

برای فیلتر کردن بر اساس هر دو مورد thread و date، از عملگر AND در کوئری خود استفاده کنید.

برای مثال، درخواست‌های زیر معتبر هستند:

createTime > "2012-04-21T11:30:00-04:00"

createTime > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

createTime > "2012-04-21T11:30:00+00:00" AND

createTime < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

درخواست‌های نامعتبر توسط سرور با خطای INVALID_ARGUMENT رد می‌شوند.

orderBy

string

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

  • ASC برای صعود.

  • DESC برای نزولی.

ترتیب پیش‌فرض createTime ASC است.

showDeleted

boolean

اختیاری. آیا پیام‌های حذف‌شده را هم شامل شود یا خیر. پیام‌های حذف‌شده شامل زمان حذف و فراداده مربوط به حذفشان می‌شوند، اما محتوای پیام در دسترس نیست.

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

پیام پاسخ برای فهرست کردن پیام‌ها.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
فیلدها
messages[]

object ( Message )

فهرست پیام‌ها.

nextPageToken

string

شما می‌توانید یک توکن به عنوان pageToken ارسال کنید تا صفحه بعدی نتایج را بازیابی کنید. اگر خالی باشد، صفحات بعدی وجود ندارند.

دامنه‌های مجوز

به یکی از حوزه‌های OAuth زیر نیاز دارد:

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

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