Method: targetingTypes.targetingOptions.search

Busca opciones de segmentación de un tipo determinado según los términos de búsqueda proporcionados.

Solicitud HTTP

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

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 opciones de segmentación que se recuperarán.

Valores aceptados:

  • TARGETING_TYPE_GEO_REGION
  • TARGETING_TYPE_POI
  • TARGETING_TYPE_BUSINESS_CHAIN

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "advertiserId": string,
  "pageSize": integer,
  "pageToken": string,

  // Union field search_terms can be only one of the following:
  "poiSearchTerms": {
    object (PoiSearchTerms)
  },
  "businessChainSearchTerms": {
    object (BusinessChainSearchTerms)
  },
  "geoRegionSearchTerms": {
    object (GeoRegionSearchTerms)
  }
  // End of list of possible types for union field search_terms.
}
Campos
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.search. Si no se especifica, se devolverá la primera página de resultados.
Campo de unión search_terms. Son las búsquedas por las que se buscan opciones de segmentación. Solo se puede completar un campo en search_terms, y debe corresponder a targeting_type. search_terms puede ser uno de los siguientes:
poiSearchTerms

object (PoiSearchTerms)

Son los términos de búsqueda para las opciones de segmentación por LPI. Solo se puede usar cuando targetingType es TARGETING_TYPE_POI.
businessChainSearchTerms

object (BusinessChainSearchTerms)

Son los términos de búsqueda para las opciones de segmentación de la cadena de empresas. Solo se puede usar cuando targetingType es TARGETING_TYPE_BUSINESS_CHAIN.
geoRegionSearchTerms

object (GeoRegionSearchTerms)

Son los términos de búsqueda para las opciones de segmentación por región geográfica. Solo se puede usar cuando targetingType es TARGETING_TYPE_GEO_REGION.

Cuerpo de la respuesta

Mensaje de respuesta para targetingOptions.search.

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 que coinciden con los criterios de búsqueda.

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

PoiSearchTerms

Son los términos de búsqueda para las opciones de segmentación por LPI.

Representación JSON 
{
  "poiQuery": string
}
Campos
poiQuery

string

Es la búsqueda del nombre, la dirección o las coordenadas del LPI deseado. La búsqueda puede ser un prefijo, p.ej., "Times squar", "40.7505045,-73.99562", "315 W 44th St", etcétera.

BusinessChainSearchTerms

Son los términos de búsqueda para las opciones de segmentación de la Cadena de empresas.

Se debe completar al menos uno de los campos.

Representación JSON 
{
  "businessChainQuery": string,
  "regionQuery": string
}
Campos
businessChainQuery

string

Es la búsqueda de la cadena de negocios deseada. La búsqueda debe ser el nombre completo de la empresa, p.ej., "KFC", "mercedes-benz".
regionQuery

string

Es la búsqueda de la región geográfica deseada, p.ej., "Seattle", "Estados Unidos".

GeoRegionSearchTerms

Son los términos de búsqueda para las opciones de segmentación por región geográfica.

Representación JSON 
{
  "geoRegionQuery": string
}
Campos
geoRegionQuery

string

Es la búsqueda de la región geográfica deseada. La búsqueda puede ser un prefijo, p. ej., "Nueva York", "Seattle", "EE.UU.", etcétera.