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 (تلقائي)

يكون ترتيب الترتيب التلقائي تصاعديًا. لتحديد ترتيب تنازلي لأحد الحقول، يجب إضافة اللاحقة "تنازلي" إلى اسم الحقل. مثلاً: 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"
  • جميع المستخدمين الذين سجّلوا الدخول آخر مرة في 2023-01-01T00: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.