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

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