Method: targetingTypes.targetingOptions.list

Enumera las opciones de segmentación de un tipo determinado.

Solicitud HTTP

GET https://displayvideo.googleapis.com/v3/targetingTypes/{targetingType}/targetingOptions

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

Parámetros de ruta de acceso

Parámetros
targetingType

enum (TargetingType)

Obligatorio. Es el tipo de opción de segmentación que se incluirá en la lista.

Valores aceptados:

  • TARGETING_TYPE_APP_CATEGORY
  • TARGETING_TYPE_AGE_RANGE
  • TARGETING_TYPE_GENDER
  • TARGETING_TYPE_VIDEO_PLAYER_SIZE
  • TARGETING_TYPE_USER_REWARDED_CONTENT
  • TARGETING_TYPE_PARENTAL_STATUS
  • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
  • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
  • TARGETING_TYPE_DEVICE_TYPE
  • TARGETING_TYPE_BROWSER
  • TARGETING_TYPE_HOUSEHOLD_INCOME
  • TARGETING_TYPE_ON_SCREEN_POSITION
  • TARGETING_TYPE_CARRIER_AND_ISP
  • TARGETING_TYPE_OPERATING_SYSTEM
  • TARGETING_TYPE_DEVICE_MAKE_MODEL
  • TARGETING_TYPE_ENVIRONMENT
  • TARGETING_TYPE_CATEGORY
  • TARGETING_TYPE_VIEWABILITY
  • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
  • TARGETING_TYPE_LANGUAGE
  • TARGETING_TYPE_GEO_REGION
  • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
  • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
  • TARGETING_TYPE_EXCHANGE
  • TARGETING_TYPE_SUB_EXCHANGE
  • TARGETING_TYPE_NATIVE_CONTENT_POSITION
  • TARGETING_TYPE_OMID

Parámetros de consulta

Parámetros
advertiserId

string (int64 format)

Obligatorio. Es el anunciante en el contexto del que se realiza esta solicitud.
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 devolvió de la llamada anterior al método targetingOptions.list. Si no se especifica, se devolverá la primera página de resultados.
orderBy

string

Campo según el cual se ordenará la lista. Los valores aceptables son:

  • targetingOptionId (predeterminada)

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: targetingOptionId desc.
filter

string

Permite filtrar por campos de opciones de segmentación.

Sintaxis admitida:

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

Campos admitidos:

  • carrierAndIspDetails.type
  • geoRegionDetails.geoRegionType
  • targetingOptionId

Ejemplos:

  • Todas las opciones de segmentación de GEO REGION que pertenecen al subtipo GEO_REGION_TYPE_COUNTRY o GEO_REGION_TYPE_STATE: geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails.geoRegionType="GEO_REGION_TYPE_STATE"
  • Todas las opciones de segmentación de CARRIER AND ISP que pertenecen al subtipo CARRIER_AND_ISP_TYPE_CARRIER: carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"

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

Consulta nuestra guía sobre cómo solicitar el filtro LIST para obtener más información.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para targetingOptions.list.

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

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

object (TargetingOption)

Es la lista de opciones de segmentación.

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 targetingOptions.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.