Method: users.list

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

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

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

درخواست HTTP

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

نشانی وب از نحو تراتبدیل 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"
  • همه کاربران با نقش‌های کاربر برای شریک ۱۲۳: assignedUserRole.partnerId="123"
  • همه کاربران با نقش‌های کاربر برای تبلیغ‌کننده ۱۲۳: assignedUserRole.advertiserId="123"
  • همه کاربران با نقش‌های کاربری سطح شریک: entityType="PARTNER"
  • همه کاربران با نقش‌های کاربری برای شریک ۱۲۳ و تبلیغ‌کنندگان تحت شریک ۱۲۳: parentPartnerId="123"
  • همه کاربرانی که آخرین‌بار در تاریخ 2023-01-01T00:00:00Z (قالب ISO 8601) یا پس‌از آن به سیستم وارد شده‌اند: lastLoginTime>="2023-01-01T00:00:00Z"

طول این فیلد نباید بیشتر از ۵۰۰ نویسه باشد.

برای اطلاعات بیشتر، به راهنمای درخواست‌های 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 مراجعه کنید.