Method: advertisers.reachForecast.retrievePlannableUserLists

Recupera las listas de usuarios propias y de terceros disponibles para la previsión.

Solicitud HTTP

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:retrievePlannableUserLists

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
advertiserId

string (int64 format)

Obligatorio. Es el ID del anunciante para el que se recuperarán las listas de usuarios planificables.

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. Indica el tamaño de la página solicitada. La hora debe configurarse entre 1 y 5000. Si no se especifica, se establecerá de forma predeterminada como 5000.
pageToken

string

Opcional. 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 devolvió de la llamada anterior al método reachForecast.retrievePlannableUserLists. Si no se especifica, se devolverá la primera página de resultados.
filter

string

Opcional. Permite filtrar por propiedades de la lista de usuarios que se pueden planificar.

Sintaxis admitida:

  • Las expresiones de filtro se componen de una o más restricciones.
  • Las restricciones se pueden combinar con los operadores lógicos AND o OR.
  • Una restricción tiene el formato {field} {operator} {value}.
  • El campo displayName debe usar el operador HAS (:).
  • Todos los demás campos deben usar el operador EQUALS (=).

Campos admitidos:

  • plannableStatus
  • displayName
  • userListType
  • name

Ejemplos:

  • Todas las listas de usuarios planificables: plannableStatus="PLANNABLE"
  • Listas de usuarios planificables con nombre visible que contiene "Shopping": plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • Listas de usuarios propios: userListType="FIRST_PARTY"

La longitud de este campo no debe superar los 500 caracteres.

Para obtener más información, consulta nuestra guía sobre las solicitudes de filtro LIST.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es la respuesta para reachForecast.retrievePlannableUserLists.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "plannableUserLists": [
    {
      object (PlannableUserList)
    }
  ],
  "nextPageToken": string
}
Campos
plannableUserLists[]

object (PlannableUserList)

Solo salida. Es la lista de listas de usuarios que se pueden planificar.
nextPageToken

string

Solo salida. Un token para recuperar los resultados de la página siguiente.

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.

PlannableUserList

Es una lista de usuarios planificable que se usa para la previsión del alcance.

Representación JSON 
{
  "displayName": string,
  "userListType": enum (UserListType),
  "name": string,
  "plannableStatus": enum (PlannableStatus)
}
Campos
displayName

string

Solo salida. Es el nombre visible de la lista de usuarios.
userListType

enum (UserListType)

Solo salida. Es el tipo de lista de usuarios.
name

string

Solo salida. Es el nombre del recurso que identifica la lista de usuarios.

Formato: advertisers/{advertiserId}/userLists/{user_list_id}
plannableStatus

enum (PlannableStatus)

Solo salida. Es el estado de planificación de la lista de usuarios.

UserListType

Son los tipos de listas de usuarios.

Enums
USER_LIST_TYPE_UNSPECIFIED Es un tipo de lista de usuarios sin especificar.
FIRST_PARTY Es una lista de usuarios propios.
THIRD_PARTY Es una lista de usuarios externos.

PlannableStatus

Es el estado que indica si una lista se puede planificar o no.

Enums
PLANNABLE_STATUS_UNSPECIFIED Estado de planificación no especificado.
PLANNABLE La lista de usuarios se puede planificar.
UNPLANNABLE La lista de usuarios no se puede planificar.