Method: users.list

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

طلب HTTP

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

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

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

المَعلمات
pageSize

integer

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

string

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

string

الحقل الذي سيتم ترتيب القائمة بناءً عليه. القيم المقبولة هي:

  • displayName (تلقائي)

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

string

تسمح هذه السياسة بالفلترة حسب خصائص المستخدمين.

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

  • تتألف تعبيرات الفلترة من قيد واحد أو أكثر.
  • يمكن دمج القيود باستخدام عامل التشغيل المنطقي AND.
  • ويكون للقيود الشكل {field} {operator} {value}.
  • يجب أن يكون عامل التشغيل CONTAINS (:) أو EQUALS (=).
  • يجب أن يكون عامل التشغيل CONTAINS (:) للحقول التالية:
    • displayName
    • email
  • يجب أن يكون عامل التشغيل EQUALS (=) للحقول التالية:
    • assignedUserRole.userRole
    • assignedUserRole.partnerId
    • assignedUserRole.advertiserId
    • assignedUserRole.entityType: حقل اصطناعي من AssignedUserRole المُستخدَم للفلترة. تحدد نوع الكيان الذي تم تعيين دور المستخدم له. القيمتان الصالحتان هما Partner وAdvertiser.
    • assignedUserRole.parentPartnerId: حقل اصطناعي من AssignedUserRole المُستخدَم للفلترة. يحدّد الشريك الرئيسي للكيان الذي تم تعيين دور المستخدم له".

أمثلة:

  • المستخدم الذي يحمل اسم DisplayName يتضمّن foo: displayName:"foo"
  • المستخدم الذي يمتلك بريدًا إلكترونيًا يحتوي على bar: email:"bar"
  • جميع المستخدِمين الذين لديهم أدوار عادية للمستخدِمين: assignedUserRole.userRole="STANDARD"
  • جميع المستخدِمين الذين لديهم أدوار المستخدِمِين للشريك 123: assignedUserRole.partnerId="123"
  • جميع المستخدِمين الذين لديهم أدوار المستخدِمِين للمعلِن 123: assignedUserRole.advertiserId="123"
  • جميع المستخدِمين الذين لديهم أدوار المستخدِمِين على مستوى الشريك: entityType="PARTNER"
  • جميع المستخدِمين الذين لديهم أدوار المستخدِمِين للشريك 123 والمعلِنين ضمن الشريك 123: parentPartnerId="123"

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

نص الطلب

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

نص الاستجابة

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

تمثيل 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.