Method: spaces.messagePins.list

تعرض هذه الطريقة دبابيس الرسائل في مساحة. يمكن للمستخدمين تثبيت الرسائل المهمة في المساحات للوصول إليها بسهولة. لمزيد من المعلومات، راجِع مقالة تثبيت محادثة أو إزالة تثبيتها في Google Chat.

تتطلب هذه الطريقة مصادقة المستخدم باستخدام أحد نطاقات الأذونات التالية:

  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces

طلب HTTP

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

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

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

المعلمات
parent

string

الحقل مطلوب. المساحة الرئيسية التي تحتوي على مجموعة العناصر المثبّتة التنسيق: spaces/{space}

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

المعلمات
pageSize

integer

اختياريّ. الحد الأقصى لعدد دبابيس الرسائل التي يتم عرضها قد تعرض الخدمة عددًا أقل من هذا العدد. الحد الأقصى هو 100. إذا استخدمت قيمة أكبر من 100، يتم تغييرها تلقائيًا إلى 100. إذا لم يتم تحديد هذه القيمة، سيتم عرض 100 دبوس رسالة على الأكثر. تعرض القيم السلبية الخطأ INVALID_ARGUMENT.
pageToken

string

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

عند التقسيم على صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة مع الطلب الذي قدّم رمز الصفحة المميّز. قد يؤدي تمرير قيم مختلفة إلى المَعلمات الأخرى إلى نتائج غير متوقّعة.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

رسالة الاستجابة لعرض دبابيس الرسائل

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "messagePins": [
    {
      object (MessagePin)
    }
  ],
  "nextPageToken": string
}
الحقول
messagePins[]

object (MessagePin)

الرسائل المثبّتة من المساحة المحدّدة
nextPageToken

string

يمكنك إرسال رمز مميّز كـ pageToken لاسترداد الصفحة التالية من النتائج. إذا كان هذا الحقل فارغًا، ما يعني أنّه لا تتوفّر صفحات لاحقة.

نطاقات الأذونات

يجب توفير أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly

لمزيد من المعلومات، راجِع دليل التفويض.