حجم الصفحة المطلوب. يجب أن تتراوح القيمة بين 1 و200. وفي حال عدم تحديد ذلك، سيتم ضبط القيمة التلقائية على 100.
pageToken
string
يشير هذا المصطلح إلى رمز مميّز يحدّد صفحة من النتائج التي يجب أن يعرضها الخادم. عادةً ما تكون هذه هي قيمة nextPageToken التي تم إرجاعها من الاستدعاء السابق إلى طريقة users.list. إذا لم يتم تحديد ذلك، سيتم عرض الصفحة الأولى من النتائج.
orderBy
string
الحقل الذي سيتم ترتيب القائمة بناءً عليه. القيم المقبولة هي:
displayName (تلقائي)
يكون ترتيب الترتيب التلقائي تصاعديًا. لتحديد ترتيب تنازلي لأحد الحقول، يجب إضافة اللاحقة "desc" إلى اسم الحقل. مثلاً: displayName desc
filter
string
تسمح هذه السياسة بالفلترة حسب حقول المستخدم.
البنية المتوافقة:
تتألف تعبيرات الفلترة من قيد واحد أو أكثر.
يمكن دمج القيود باستخدام عامل التشغيل المنطقي AND.
ويكون للقيود الشكل {field} {operator} {value}.
يجب أن يستخدم الحقل budget.budget_segments.date_range.end_date عامل التشغيل LESS THAN (<).
عامل تشغيل displayName andالبريد الإلكترونيfield must use theHAS (:)`.
ويجب أن تستخدم جميع الحقول الأخرى عامل التشغيل EQUALS (=).
الحقول المتاحة:
assignedUserRole.advertiserId
assignedUserRole.entityType
هذا حقل اصطناعي لـ AssignedUserRole ويتم استخدامه للفلترة. تحدد نوع الكيان الذي تم تعيين دور المستخدم له. القيمتان الصالحتان هما Partner وAdvertiser.
assignedUserRole.parentPartnerId
هذا حقل اصطناعي من AssignedUserRole يُستخدم للفلترة. تحدّد الشريك الرئيسي للكيان الذي تم تعيين دور المستخدم له.
assignedUserRole.partnerId
assignedUserRole.userRole
displayName
email
أمثلة:
المستخدم الذي يتضمّن displayName يحتوي على كلمة "foo": displayName:"foo"
المستخدم الذي يتضمّن "email" يحتوي على كلمة "شريط": email:"bar"
جميع المستخدِمين الذين لديهم أدوار عادية للمستخدِمين: assignedUserRole.userRole="STANDARD"
جميع المستخدِمين الذين لديهم أدوار المستخدِمِين للشريك 123: assignedUserRole.partnerId="123"
جميع المستخدِمين الذين لديهم أدوار المستخدِمِين للمعلِن 123: assignedUserRole.advertiserId="123"
جميع المستخدِمين الذين لديهم أدوار المستخدِمِين على مستوى الشريك: entityType="PARTNER"
جميع المستخدِمين الذين لديهم أدوار المستخدِمِين للشريك 123 والمعلِنين ضمن الشريك 123: parentPartnerId="123"
رمز مميز لاسترداد الصفحة التالية من النتائج. مرِّر هذه القيمة في الحقل pageToken في الاستدعاء التالي إلى طريقة users.list لاسترداد الصفحة التالية من النتائج. لن يظهر هذا الرمز المميّز في حال عدم توفّر نتائج أخرى لعرضها.