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 lẫn nhau.

Phương pháp này có các yêu cầu xác thực riêng. Đọ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 pháp này.

Hộp thoại "Thử phương thức này" không hoạt động đối với phương pháp 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

Tham số
pageSize

integer

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

string

Mã thông báo xác định một 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, trang kết quả đầu tiên sẽ được trả về.
orderBy

string

Trường mà bạn sẽ dù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, hãy thêm hậu tố "desc" phải được thêm vào tên trường. Ví dụ: displayName desc.
filter

string

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

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

  • Biểu thức bộ lọc được tạo thành từ một hoặc nhiều giới hạn.
  • Các quy tắc hạn chế có thể được kết hợp bởi toán tử logic AND.
  • 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ò của 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 thực thể được chỉ định vai trò của người dùng.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime (dữ liệu đầu 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 "thanh": 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ò của người dùng đối với đối tác 123: assignedUserRole.partnerId="123"
  • Tất cả người dùng có vai trò của người dùng đối với 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 theo đối tác 123: parentPartnerId="123"
  • Tất cả người dùng đăng nhập lần gần đây nhất vào hoặc sau ngày 2023-01-01T00:00:00Z (định dạng ISO 8601): lastLoginTime>="2023-01-01T00:00:00Z"

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

Hãy tham khảo hướng dẫn về bộ lọc LIST yêu cầu của chúng tôi để 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 có 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 vào 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 có 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 bài viết Tổng quan về OAuth 2.0.