Method: spaces.messages.list

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

يتيح الأنواع التالية من المصادقة:

  • مصادقة التطبيق من خلال موافقة المشرف مع نطاق التفويض:

    • 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 بنية تحويل الترميز إلى gRPC.

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

المعلمات
parent

string

الحقل مطلوب. اسم المورد للمساحة التي سيتم عرض الرسائل منها.

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

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

المعلمات
pageSize

integer

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

إذا لم يتم تحديدها، سيتم عرض 25 نتيجة على الأكثر.

الحد الأقصى للقيمة هو 1,000. إذا استخدمت قيمة أكبر من 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
  • https://www.googleapis.com/auth/chat.app.messages.readonly

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