Method: users.list

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

تتطلّب هذه الطريقة متطلبات مصادقة فريدة. يُرجى قراءة المتطلبات الأساسية في دليل المستخدمين قبل استخدام هذه الطريقة.

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

طلب HTTP

GET https://displayvideo.googleapis.com/v5/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 Overview.