Kể từ
ngày 8 tháng 9 năm 2025, mỗi mục hàng mới sẽ cần phải khai báo xem mục hàng đó có phân phát quảng cáo chính trị ở Liên minh Châu Âu (EU) hay không. Display & Video 360 API và các tệp SDF được tải lên mà không cung cấp thông tin khai báo sẽ không thành công. Hãy xem
trang thông báo về những nội dung không dùng nữa để biết thêm thông tin về cách cập nhật quy trình tích hợp để đưa ra nội dung khai báo này.
Method: customLists.list
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
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/v4/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ợ:
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.
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2025-07-25 UTC.
[null,null,["Cập nhật lần gần đây nhất: 2025-07-25 UTC."],[],[],null,["# Method: customLists.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCustomListsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists custom lists.\n\nThe order is defined by the [orderBy](/display-video/api/reference/rest/v4/customLists/list#body.QUERY_PARAMETERS.order_by) parameter.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v4/customLists`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |\n| `pageToken` | `string` A token identifying a page of results the server should return. Typically, this is the value of [nextPageToken](/display-video/api/reference/rest/v4/customLists/list#body.ListCustomListsResponse.FIELDS.next_page_token) returned from the previous call to `customLists.list` method. If not specified, the first page of results will be returned. |\n| `orderBy` | `string` Field by which to sort the list. Acceptable values are: - `customListId` (default) - `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`. |\n| `filter` | `string` Allows filtering by custom list fields. Supported syntax: - Filter expressions for custom lists can only contain at most one restriction. - A restriction has the form of `{field} {operator} {value}`. - All fields must use the `HAS (:)` operator. Supported fields: - `displayName` Examples: - All custom lists for which the display name contains \"Google\": `displayName:\"Google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |\n| Union parameter `accessor`. Required. Identifies which DV360 entity the request is being made within. The LIST request will only return custom list entities that are accessible to the DV360 entity identified within the `accessor`. `accessor` can be only one of the following: ||\n| `advertiserId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the DV360 advertiser that has access to the fetched custom lists. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"customLists\": [ { object (/display-video/api/reference/rest/v4/customLists#CustomList) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customLists[]` | `object (`[CustomList](/display-video/api/reference/rest/v4/customLists#CustomList)`)` The list of custom lists. This list will be absent if empty. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [pageToken](/display-video/api/reference/rest/v4/customLists/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `customLists.list` method to retrieve the next page of results. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/display-video`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]