Method: customLists.list

Muestra listas personalizadas.

El orden se define con el parámetro orderBy.

Solicitud HTTP

GET https://displayvideo.googleapis.com/v3/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. El valor debe estar comprendido 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 el servidor debe mostrar. Por lo general, este es el valor de nextPageToken que se muestra en 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 un orden descendente para 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:

  • displayName

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 personalizada a las que puede acceder la entidad de DV360 identificada en accessor. 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.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.