Method: users.list

integer

حجم الصفحة المطلوب يجب أن تتراوح القيمة بين 1 و200. إذا لم يتم تحديدها، سيتم ضبط القيمة التلقائية على 100.

string

رمز مميّز يحدّد صفحة من النتائج التي يجب أن يعرضها الخادم. عادةً، تكون هذه القيمة هي قيمة nextPageToken التي تم عرضها من الطلب السابق إلى طريقة users.list. إذا لم يتم تحديدها، سيتم عرض الصفحة الأولى من النتائج.

string

الحقل الذي سيتم ترتيب القائمة حسبه القيم المقبولة هي:

• displayName (تلقائي)

يكون ترتيب الفرز التلقائي تصاعديًا. لتحديد ترتيب تنازلي لحقل معيّن، يجب إضافة اللاحقة "desc" إلى اسم الحقل. مثلاً: displayName desc

string

تتيح هذه السمة إمكانية الفلترة حسب حقول المستخدمين.

بنية الجملة المتوافقة:

• تتكوّن عبارات الفلتر من قيد واحد أو أكثر.
• يمكن الجمع بين القيود باستخدام عامل التشغيل المنطقي AND.
• يكون الحظر على شكل {field} {operator} {value}.
• يجب أن يستخدم الحقلان displayName وemail عامل التشغيل HAS (:).
• يجب أن يستخدم الحقل lastLoginTime عامل التشغيل LESS THAN OR EQUAL TO (<=) أو GREATER THAN OR EQUAL TO (>=).
• يجب أن تستخدم جميع الحقول الأخرى عامل التشغيل EQUALS (=).

الحقول المتاحة:

• assignedUserRole.advertiserId
• assignedUserRole.entityType: هذا حقل اصطناعي خاص بـ AssignedUserRole يُستخدم في الفلترة. تحدّد هذه السمة نوع الكيان الذي تمّ إسناد دور المستخدم إليه. القيم الصالحة هي Partner وAdvertiser.
• ‫assignedUserRole.parentPartnerId: هذا حقل اصطناعي من AssignedUserRole يُستخدَم في الفلترة. تحدّد هذه السمة الشريك الرئيسي للكيان الذي تمّ إسناد دور المستخدم إليه.
• assignedUserRole.partnerId
• assignedUserRole.userRole
• displayName
• email
• ‫lastLoginTime (الإدخال بتنسيق ISO 8601 أو YYYY-MM-DDTHH:MM:SSZ)

أمثلة:

• المستخدم الذي يحتوي displayName الخاص به على "foo": displayName:"foo"
• المستخدم الذي يتضمّن email "bar": email:"bar"
• جميع المستخدمين الذين لديهم أدوار مستخدم عادية: assignedUserRole.userRole="STANDARD"
• جميع المستخدمين الذين لديهم أدوار مستخدمين للشريك 123: assignedUserRole.partnerId="123"
• جميع المستخدمين الذين لديهم أدوار مستخدمين للمعلِن 123: assignedUserRole.advertiserId="123"
• جميع المستخدمين الذين لديهم أدوار مستخدمين على مستوى الشريك: entityType="PARTNER"
• جميع المستخدمين الذين لديهم أدوار مستخدمين للشريك 123 والمعلِنين التابعين للشريك 123: parentPartnerId="123"
• جميع المستخدمين الذين سجّلوا الدخول آخر مرة في 2023-01-01T00:00:00Z أو بعد هذا التاريخ (تنسيق ISO 8601): lastLoginTime>="2023-01-01T00:00:00Z"

يجب ألا يزيد طول هذا الحقل عن 500 حرف.

يُرجى الرجوع إلى دليل طلبات LISTالفلترة للحصول على مزيد من المعلومات.