Method: users.sections.items.list

تعرض هذه السمة العناصر في قسم.

يمكن أن تكون المساحات فقط عناصر أقسام. لمعرفة التفاصيل، يُرجى الاطّلاع على إنشاء أقسام وتنظيمها في Google Chat.

يتطلّب مصادقة المستخدم باستخدام نطاق التفويض:

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

طلب HTTP

GET https://chat.googleapis.com/v1/{parent=users/*/sections/*}/items

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

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

المعلمات
parent

string

الحقل مطلوب. تمثّل هذه السمة القسم الرئيسي، وهو اسم مورد القسم الذي يملك هذه المجموعة من عناصر القسم. لا يتيح سوى عناصر قسم قائمة المستخدم الذي يجري الاتصال.

عند الفلترة حسب المساحة، استخدِم حرف البدل - للبحث في جميع الأقسام. مثلاً: users/{user}/sections/-

التنسيق: users/{user}/sections/{section}

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

المعلمات
pageSize

integer

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

إذا لم يتم تحديدها، سيتم عرض 10 عناصر من الأقسام كحدّ أقصى.

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

تعرض القيم السالبة الخطأ INVALID_ARGUMENT.
pageToken

string

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

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

string

اختياريّ. فلتر طلب البحث

لا يتيح حاليًا سوى الفلترة حسب المساحة.

مثلاً: space = spaces/{space}

يتم رفض طلبات البحث غير الصالحة مع ظهور الخطأ INVALID_ARGUMENT.

نص الطلب

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

نص الاستجابة

رسالة الردّ على عناصر قسم بيانات المؤسسة

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

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

object (SectionItem)

عناصر القسم من القسم المحدّد
nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/chat.users.sections
  • https://www.googleapis.com/auth/chat.users.sections.readonly

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