С
8 сентября 2025 года в каждой новой позиции необходимо будет указывать, будет ли она показывать политическую рекламу Европейского союза (ЕС). Загрузки через Display & Video 360 API и SDF без таких указаний будут отклонены. Подробнее о том, как обновить интеграцию и указать это указание, см.
на странице «Устаревшие функции».
Method: customLists.list
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Списки пользовательских списков.
Порядок определяется параметром orderBy .
HTTP-запрос
GET https://displayvideo.googleapis.com/v4/customLists
URL-адрес использует синтаксис транскодирования gRPC .
Параметры запроса
| Параметры |
|---|
pageSize | integer Запрошенный размер страницы. Должно быть от 1 до 200 . Если не указано, по умолчанию будет 100 . Возвращает код ошибки INVALID_ARGUMENT , если указано недопустимое значение. |
pageToken | string Токен, идентифицирующий страницу результатов, которую должен вернуть сервер. Обычно это значение nextPageToken , возвращенное в результате предыдущего вызова метода customLists.list . Если не указано, будет возвращена первая страница результатов. |
orderBy | string Поле, по которому сортируется список. Приемлемые значения: -
customListId (по умолчанию) -
displayName
По умолчанию порядок сортировки — по возрастанию. Чтобы указать порядок убывания поля, к имени поля следует добавить суффикс «desc». Пример: displayName desc . |
filter | string Позволяет фильтровать по настраиваемым полям списка. Поддерживаемый синтаксис: - Выражения фильтра для настраиваемых списков могут содержать не более одного ограничения.
- Ограничение имеет форму
{field} {operator} {value} . - Во всех полях должен использоваться оператор
HAS (:) .
Поддерживаемые поля: Примеры: - Все настраиваемые списки, отображаемое имя которых содержит "Google":
displayName:"Google" .
Длина этого поля не должна превышать 500 символов. Для получения дополнительной информации обратитесь к нашему руководству по запросам фильтров LIST . |
accessor параметру объединения. Необходимый. Определяет, в рамках какого объекта DV360 делается запрос. Запрос LIST вернет только объекты пользовательского списка, доступные объекту DV360, указанному в accessor . accessor может быть только одним из следующих: |
advertiserId | string ( int64 format) Идентификатор рекламодателя DV360, у которого есть доступ к полученным специальным спискам. |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа содержит данные следующей структуры:
| JSON-представление |
|---|
{
"customLists": [
{
object (CustomList)
}
],
"nextPageToken": string
} |
| Поля |
|---|
customLists[] | object ( CustomList ) Список пользовательских списков. Этот список будет отсутствовать, если он пуст. |
nextPageToken | string Токен для получения следующей страницы результатов. Передайте это значение в поле pageToken при последующем вызове метода customLists.list , чтобы получить следующую страницу результатов. |
Области авторизации
Требуется следующая область действия OAuth:
-
https://www.googleapis.com/auth/display-video
Для получения дополнительной информации см.OAuth 2.0 Overview .
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 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)."]]
