Method: users.list

Liệt kê những người dùng mà người dùng hiện tại có thể truy cập. Nếu hai người dùng có vai trò người dùng trên cùng một đối tác hoặc nhà quảng cáo, thì họ có thể truy cập vào tài khoản của nhau.

Phương thức này có các yêu cầu xác thực riêng. Hãy đọc các điều kiện tiên quyết trong Hướng dẫn quản lý người dùng trước khi sử dụng phương thức này.

Tính năng "Thử phương thức này" không hoạt động với phương thức này.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số truy vấn

Thông số
pageSize

integer

Kích thước trang được yêu cầu. Phải nằm trong khoảng từ 1 đến 200. Nếu không chỉ định, giá trị mặc định sẽ là 100.
pageToken

string

Mã thông báo xác định trang kết quả mà máy chủ sẽ trả về. Thông thường, đây là giá trị của nextPageToken được trả về từ lệnh gọi trước đó đến phương thức users.list. Nếu không được chỉ định, hệ thống sẽ trả về trang kết quả đầu tiên.
orderBy

string

Trường để sắp xếp danh sách. Các giá trị được chấp nhận là:

  • displayName (mặc định)

Thứ tự sắp xếp mặc định là tăng dần. Để chỉ định thứ tự giảm dần cho một trường, bạn nên thêm hậu tố "desc" vào tên trường. Ví dụ: displayName desc.
filter

string

Cho phép lọc theo các trường người dùng.

Cú pháp được hỗ trợ:

  • Biểu thức lọc bao gồm một hoặc nhiều quy tắc hạn chế.
  • Bạn có thể kết hợp các quy tắc hạn chế bằng toán tử logic AND.
  • Quy tắc hạn chế có dạng {field} {operator} {value}.
  • Các trường displayName và email phải sử dụng toán tử HAS (:).
  • Trường lastLoginTime phải sử dụng toán tử LESS THAN OR EQUAL TO (<=) hoặc GREATER THAN OR EQUAL TO (>=).
  • Tất cả các trường khác phải sử dụng toán tử EQUALS (=).

Các trường được hỗ trợ:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType: Đây là trường tổng hợp của AssignedUserRole dùng để lọc. Xác định loại thực thể được chỉ định vai trò người dùng. Các giá trị hợp lệ là Partner và Advertiser.
  • assignedUserRole.parentPartnerId: Đây là trường tổng hợp của AssignedUserRole dùng để lọc. Xác định đối tác mẹ của pháp nhân được chỉ định vai trò người dùng.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime (đưa vào ở định dạng ISO 8601 hoặc YYYY-MM-DDTHH:MM:SSZ)

Ví dụ:

  • Người dùng có displayName chứa "foo": displayName:"foo"
  • Người dùng có email chứa "bar": email:"bar"
  • Tất cả người dùng có vai trò người dùng tiêu chuẩn: assignedUserRole.userRole="STANDARD"
  • Tất cả người dùng có vai trò người dùng đối với đối tác 123: assignedUserRole.partnerId="123"
  • Tất cả người dùng có vai trò người dùng cho nhà quảng cáo 123: assignedUserRole.advertiserId="123"
  • Tất cả người dùng có vai trò người dùng cấp đối tác: entityType="PARTNER"
  • Tất cả người dùng có vai trò người dùng đối với đối tác 123 và nhà quảng cáo thuộc đối tác 123: parentPartnerId="123"
  • Tất cả người dùng đã đăng nhập gần đây nhất vào hoặc sau ngày 1 tháng 1 năm 2023 lúc 00:00:00 (theo định dạng ISO 8601): lastLoginTime>="2023-01-01T00:00:00Z"

Trường này không được dài quá 500 ký tự.

Tham khảo hướng dẫn lọc các yêu cầu LIST để biết thêm thông tin.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Trường
users[]

object (User)

Danh sách người dùng.

Danh sách này sẽ không xuất hiện nếu trống.
nextPageToken

string

Mã thông báo để truy xuất trang kết quả tiếp theo. Truyền giá trị này trong trường pageToken trong lệnh gọi tiếp theo đến phương thức users.list để truy xuất trang kết quả tiếp theo. Mã thông báo này sẽ không xuất hiện nếu không có kết quả nào khác để trả về.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.