Method: targetingTypes.targetingOptions.search

Procura opções de segmentação de um determinado tipo com base nos termos de pesquisa fornecidos.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
targetingType

enum (TargetingType)

Obrigatório. O tipo de opções de segmentação a serem recuperadas.

Os valores aceitos são:

  • TARGETING_TYPE_GEO_REGION
  • TARGETING_TYPE_POI
  • TARGETING_TYPE_BUSINESS_CHAIN

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação 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)

Obrigatório. O anunciante em que a solicitação está sendo feita.
pageSize

integer

Tamanho da página solicitada. O valor precisa estar entre 1 e 200. Se não for especificado, o padrão será 100. Retorna o código de erro INVALID_ARGUMENT caso um valor inválido seja especificado.
pageToken

string

Um token que identifica a página de resultados que o servidor retornará. Normalmente, esse é o valor de nextPageToken retornado pela chamada anterior para o método targetingOptions.search. Se não for especificado, a primeira página de resultados será retornada.
Campo de união search_terms. Consultas pelas quais as opções de segmentação serão pesquisadas. Somente um campo em search_terms pode ser preenchido, e ele deve corresponder a targeting_type. search_terms só pode ser de um dos seguintes tipos:
poiSearchTerms

object (PoiSearchTerms)

Termos de pesquisa para as opções de segmentação de PDIs. Só pode ser usado quando targetingType é TARGETING_TYPE_POI.
businessChainSearchTerms

object (BusinessChainSearchTerms)

Termos de pesquisa para opções de segmentação da rede de negócios. Só pode ser usado quando targetingType é TARGETING_TYPE_BUSINESS_CHAIN.
geoRegionSearchTerms

object (GeoRegionSearchTerms)

Termos de pesquisa para opções de segmentação por região geográfica. Só pode ser usado quando targetingType é TARGETING_TYPE_GEO_REGION.

Corpo da resposta

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Mensagem de resposta para targetingOptions.search.

Representação JSON 
{
  "targetingOptions": [
    {
      object (TargetingOption)
    }
  ],
  "nextPageToken": string
}
Campos
targetingOptions[]

object (TargetingOption)

Lista de opções de segmentação que correspondem aos critérios de pesquisa.

Esta lista estará ausente se estiver vazia.
nextPageToken

string

Um token para recuperar a próxima página de resultados. Transmita esse valor no campo pageToken na chamada seguinte para o método targetingOptions.search para recuperar a próxima página de resultados.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.

PoiSearchTerms

Termos de pesquisa para as opções de segmentação de PDIs.

Representação JSON 
{
  "poiQuery": string
}
Campos
poiQuery

string

A consulta de pesquisa para o nome, endereço ou coordenada do PDI desejado. A consulta pode ser um prefixo, por exemplo, "Times squar", "40.7505045,-73.99562", "315 W 44th St" etc.

BusinessChainSearchTerms

Termos de pesquisa para opções de segmentação da rede de negócios.

Preencha pelo menos um dos campos.

Representação JSON 
{
  "businessChainQuery": string,
  "regionQuery": string
}
Campos
businessChainQuery

string

A consulta de pesquisa da cadeia de negócios desejada. A consulta precisa ser o nome completo da empresa, por exemplo, "KFC", "mercedes-benz".
regionQuery

string

A consulta de pesquisa para a região geográfica desejada, por exemplo, "Seattle", "Estado Unidos".

GeoRegionSearchTerms

Termos de pesquisa para opções de segmentação por região geográfica.

Representação JSON 
{
  "geoRegionQuery": string
}
Campos
geoRegionQuery

string

A consulta de pesquisa para a região geográfica desejada. A consulta pode ser um prefixo, como "São Paulo", "Seattle", "EUA" etc.