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 يحتوي على "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 للحصول على مزيد من المعلومات.

نص الطلب

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

نص الاستجابة

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

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