Method: spaces.messages.list

تعرض هذه البطاقة الرسائل في مساحة يكون المتصل عضوًا فيها، بما في ذلك الرسائل الواردة من الأعضاء والمساحات المحظورة. إذا أدرجت رسائل من مساحة لا تحتوي على رسائل، سيكون الردّ عنصرًا فارغًا. عند استخدام واجهة REST/HTTP، يحتوي الردّ على عنصر JSON فارغ، {}. على سبيل المثال، يمكنك الاطّلاع على قائمة الرسائل.

يتطلب مصادقة المستخدم.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
parent

string

مطلوب. اسم المورد للمساحة التي تريد إدراج الرسائل منها.

التنسيق: spaces/{space}

مَعلمات طلب البحث

المعلمات
pageSize

integer

اختياريّ. الحد الأقصى لعدد الرسائل المعروضة قد تعرض الخدمة عددًا أقل من الرسائل مقارنةً بهذه القيمة.

إذا لم يتم تحديد عدد، يتم عرض 25 عنصرًا بحد أقصى.

الحد الأقصى للقيمة هو 1000. إذا استخدمت قيمة أكبر من 1000، سيتم تغييرها تلقائيًا إلى 1000.

تعرِض القيم السلبية خطأ 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 واحدة فقط لكل طلب بحث.

لفلترة الرسائل حسب سلسلة المحادثات والتاريخ معًا، استخدِم عامل التشغيل 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

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