Method: users.list

يسرد المستخدمين الذين يمكن للمستخدم الحالي الوصول إليهم. إذا كان لدى مستخدمَين أدوار مستخدمين في حساب الشريك أو المعلِن نفسه، يمكنهما الوصول إلى بعضهما.

تتطلب هذه الطريقة متطلبات مصادقة فريدة. اطّلِع على المتطلبات الأساسية في دليل إدارة المستخدمين قبل استخدام هذه الطريقة.

لا تعمل ميزة "تجربة هذه الطريقة" مع هذه الطريقة.

طلب HTTP

GET https://displayvideo.googleapis.com/v3/users

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

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

المعلمات
pageSize

integer

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

string

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

string

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

  • displayName (تلقائي)

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

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

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

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

نص الطلب

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

نص الاستجابة

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

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

object (User)

قائمة المستخدمين.

لن تظهر هذه القائمة إذا كانت فارغة.
nextPageToken

string

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

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/display-video-user-management

لمزيد من المعلومات، يُرجى الاطِّلاع على نظرة عامة على OAuth 2.0.