Method: customLists.list

Liệt kê danh sách tuỳ chỉnh.

Thứ tự được xác định bằng tham số orderBy.

Yêu cầu HTTP

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

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. Trả về mã lỗi INVALID_ARGUMENT nếu bạn chỉ định một giá trị không hợp lệ.
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 customLists.list. Nếu không được chỉ định, trang kết quả đầu tiên sẽ được trả về.
orderBy

string

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

  • customListId (mặc định)
  • displayName

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 danh sách tuỳ chỉnh.

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

  • Biểu thức bộ lọc cho danh sách tuỳ chỉnh chỉ có thể chứa tối đa một quy tắc hạn chế.
  • Quy tắc hạn chế có dạng {field} {operator} {value}.
  • Tất cả các trường phải sử dụng toán tử HAS (:).

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

  • displayName

Ví dụ:

  • Tất cả danh sách tuỳ chỉnh có tên hiển thị chứa "Google": displayName:"Google".

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.
Tham số hợp nhất accessor. Bắt buộc. Xác định thực thể DV360 mà yêu cầu đang được thực hiện. Yêu cầu LIST sẽ chỉ trả về các thực thể danh sách tuỳ chỉnh mà thực thể DV360 được xác định trong accessor có thể truy cập. accessor chỉ có thể là một trong những loại sau:
advertiserId

string (int64 format)

Mã nhận dạng của nhà quảng cáo DV360 có quyền truy cập vào danh sách tuỳ chỉnh đã tìm nạp.

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 
{
  "customLists": [
    {
      object (CustomList)
    }
  ],
  "nextPageToken": string
}
Trường
customLists[]

object (CustomList)

Danh sách danh sách tuỳ chỉnh.

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 customLists.list để truy xuất trang kết quả tiếp theo.

Phạm vi uỷ quyền

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

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

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