Method: users.list

کاربرانی را که برای کاربر فعلی قابل دسترسی هستند فهرست می کند. اگر دو کاربر در یک شریک یا تبلیغ کننده نقش کاربری داشته باشند، می توانند به یکدیگر دسترسی داشته باشند.

این روش دارای الزامات احراز هویت منحصر به فردی است. قبل از استفاده از این روش، پیش نیازها را در راهنمای مدیریت کاربران ما بخوانید.

ویژگی «این روش را امتحان کنید» برای این روش کار نمی کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
page Size

integer

اندازه صفحه درخواستی باید بین 1 تا 200 باشد. اگر نامشخص باشد به طور پیش فرض 100 خواهد بود.

page Token

string

نشانه ای که صفحه ای از نتایجی را که سرور باید برگرداند، شناسایی کند. به طور معمول، این مقدار nextPageToken است که از فراخوانی قبلی به متد users.list بازگردانده می شود. اگر مشخص نشده باشد، صفحه اول نتایج برگردانده خواهد شد.

order By

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 )

لیست کاربران.

در صورت خالی بودن این لیست وجود نخواهد داشت.

next Page Token

string

نشانه ای برای بازیابی صفحه بعدی نتایج. این مقدار را در قسمت pageToken در روش فراخوانی بعدی به users.list ارسال کنید تا صفحه بعدی نتایج را بازیابی کنید. اگر نتایج دیگری برای بازگشت وجود نداشته باشد، این نشانه وجود ندارد.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.