A partir del
8 de septiembre de 2025, cada elemento de la línea nuevo deberá declarar si publicará anuncios políticos de la Unión Europea (UE). Las cargas de la API de Display & Video 360 y del SDF que no proporcionen declaraciones fallarán. Consulta nuestra
página de bajas para obtener más detalles sobre cómo actualizar tu integración y realizar esta declaración.
Method: customLists.list
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Muestra las listas personalizadas.
El orden se define con el parámetro orderBy
.
Solicitud HTTP
GET https://displayvideo.googleapis.com/v4/customLists
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de consulta
Parámetros |
pageSize |
integer
Indica el tamaño de la página solicitada. Debe estar entre 1 y 200 . Si no se especifica, se establecerá de forma predeterminada como 100 . Muestra el código de error INVALID_ARGUMENT si se especifica un valor no válido.
|
pageToken |
string
Un token que identifica una página de resultados que debe mostrar el servidor. Por lo general, este es el valor de nextPageToken que se muestra de la llamada anterior al método customLists.list . Si no se especifica, se mostrará la primera página de resultados.
|
orderBy |
string
Campo según el cual se ordenan los resultados. Los valores aceptables son:
customListId (predeterminada)
displayName
El orden de clasificación predeterminado es ascendente. Para especificar el orden descendente de un campo, se debe agregar un sufijo "desc" al nombre del campo. Ejemplo: displayName desc .
|
filter |
string
Permite filtrar por campos de listas personalizadas. Sintaxis admitida:
- Las expresiones de filtro para las listas personalizadas solo pueden contener una restricción como máximo.
- Una restricción tiene el formato
{field} {operator} {value} .
- Todos los campos deben usar el operador
HAS (:) .
Campos admitidos:
Ejemplos:
- Todas las listas personalizadas cuyo nombre visible contiene "Google":
displayName:"Google" .
La longitud de este campo no debe superar los 500 caracteres. Consulta nuestra guía de solicitudes de LIST de filtro para obtener más información.
|
Parámetro de unión accessor . Obligatorio. Identifica en qué entidad de DV360 se realiza la solicitud. La solicitud LIST solo mostrará las entidades de lista personalizadas a las que la entidad de DV360 identificada en accessor pueda acceder. accessor puede ser solo uno de los siguientes: |
advertiserId |
string (int64 format)
Es el ID del anunciante de DV360 que tiene acceso a las listas personalizadas recuperadas.
|
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:
Representación JSON |
{
"customLists": [
{
object (CustomList )
}
],
"nextPageToken": string
} |
Campos |
customLists[] |
object (CustomList )
Es la lista de listas personalizadas. Esta lista no aparecerá si está vacía.
|
nextPageToken |
string
Un token para recuperar los resultados de la página siguiente. Pasa este valor en el campo pageToken en la llamada posterior al método customLists.list para recuperar la siguiente página de resultados.
|
Permisos de autorización
Requiere el siguiente alcance de OAuth:
https://www.googleapis.com/auth/display-video
Para obtener más información, consulta OAuth 2.0 Overview.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 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)."]]