- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- PoiSearchTerms
- BusinessChainSearchTerms
- GeoRegionSearchTerms
- Faça um teste
Procura opções de segmentação de um determinado tipo com base nos termos de pesquisa informados.
Solicitação HTTP
POST https://displayvideo.googleapis.com/v3/targetingTypes/{targetingType}/targetingOptions:search
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
targetingType |
Obrigatório. O tipo de opções de segmentação a serem recuperadas. Os valores aceitos são:
|
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 |
Campos | |
---|---|
advertiserId |
Obrigatório. O anunciante em que a solicitação está sendo feita no contexto. |
pageSize |
Tamanho da página solicitada. O valor precisa estar entre |
pageToken |
Um token que identifica a página de resultados que o servidor retornará. Normalmente, esse é o valor de |
Campo de união search_terms . Consultas pelas quais pesquisar opções de segmentação. Somente um campo em search_terms pode ser preenchido e precisa corresponder a targeting_type . search_terms só pode ser de um dos tipos a seguir: |
|
poiSearchTerms |
Termos de pesquisa para as opções de segmentação de PDIs. Só poderá ser usado quando |
businessChainSearchTerms |
Termos de pesquisa para as opções de segmentação de redes de negócios. Só poderá ser usado quando |
geoRegionSearchTerms |
Termos de pesquisa para opções de segmentação por região geográfica. Só poderá ser usado quando |
Corpo da resposta
Mensagem de resposta para targetingOptions.search
.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{
"targetingOptions": [
{
object ( |
Campos | |
---|---|
targetingOptions[] |
A lista de opções de segmentação que correspondem aos critérios de pesquisa. Esta lista estará ausente se estiver vazia. |
nextPageToken |
Um token para recuperar a próxima página de resultados. Transmita esse valor no campo |
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 |
A consulta de pesquisa pelo 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 as opções de segmentação de redes de negócios.
Preencha pelo menos um campo.
Representação JSON |
---|
{ "businessChainQuery": string, "regionQuery": string } |
Campos | |
---|---|
businessChainQuery |
A consulta de pesquisa para a rede de negócios desejada. A consulta deve ser o nome completo da empresa, por exemplo, "KFC", "mercedes-benz". |
regionQuery |
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 |
A consulta de pesquisa para a região geográfica desejada. A consulta pode ser um prefixo, por exemplo, "New Yor", "Seattle", "USA" etc. |