Method: customLists.list

Enumera las listas personalizadas.

El orden se define con el parámetro orderBy.

Solicitud HTTP

GET https://displayvideo.googleapis.com/v5/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. La hora debe configurarse entre 1 y 200. Si no se especifica, se establecerá de forma predeterminada como 100. Devuelve 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 el servidor debe devolver. 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 devolverá la primera página de resultados.
orderBy

string

Es el campo según el cual se ordenará la lista. 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 el sufijo "desc" al nombre del campo. Ejemplo: displayName desc.
filter

string

Permite filtrar por campos de lista personalizados.

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:

  • displayName

Ejemplos:

  • Todas las listas de clientes 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 filtro LIST para obtener más información.
Obligatorio. Identifica la entidad de DV360 en la que se realiza la solicitud. La solicitud LIST solo devolverá las entidades de lista personalizada a las que pueda acceder la entidad de DV360 identificada en el accessor. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
advertiserId

string (int64 format)

Es el ID del anunciante de DV360 que tiene acceso a las listas de clientes recuperadas.
Fin de los campos mutuamente excluyentes.

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 estará presente 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 permiso de OAuth:

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

Para obtener más información, consulta OAuth 2.0 Overview.