Method: targetingTypes.targetingOptions.search

Busca opciones de segmentación de un tipo determinado en función de los términos de búsqueda especificados.

Solicitud HTTP

POST https://displayvideo.googleapis.com/v1/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. 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 al que se realiza esta solicitud en el contexto.
pageSize

integer

Indica el tamaño de la página solicitada. Debe ser un valor entre 1 y 200. Si no se especifica, el valor predeterminado será 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, es el valor de nextPageToken que se muestra en la llamada anterior al método targetingOptions.search. Si no se especifica, se mostrará la primera página de resultados.
Campo de unión search_terms. Consultas para buscar opciones de segmentación. Solo se puede completar un campo en search_terms, que debe corresponder a targeting_type. search_terms puede ser una de las siguientes opciones:
poiSearchTerms

object (PoiSearchTerms)

Términos de búsqueda para las opciones de segmentación de lugares de interés. Solo se puede usar cuando targetingType es TARGETING_TYPE_POI.
businessChainSearchTerms

object (BusinessChainSearchTerms)

Términos de búsqueda para opciones de segmentación de Cadena comercial. Solo se puede usar cuando targetingType es TARGETING_TYPE_BUSINESS_CHAIN.
geoRegionSearchTerms

object (GeoRegionSearchTerms)

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

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

Mensaje de respuesta para targetingOptions.search.

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á disponible 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.

Alcances de la 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.

PoiSearchTerms

Términos de búsqueda para las opciones de segmentación de lugares de interés.

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

string

Es la búsqueda del nombre del lugar de interés, la dirección o la coordenada del lugar de interés deseado. La consulta puede ser un prefijo; p.ej., “Times squar”, “40.7505045,-73.99562”, “315 W 44th St”, etcétera.

BusinessChainSearchTerms

Términos de búsqueda para opciones de segmentación de Cadena comercial.

Se debe propagar al menos uno de los campos.

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

string

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

string

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

GeoRegionSearchTerms

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 consulta puede ser un prefijo; p. ej., “New Yor”, “Seattle”, “EE.UU.”, etcétera.