Criar controles de exibição

Esta página descreve como criar controles de exibição.

Os controles de veiculação são regras que você define e aplica a configurações de veiculação individuais. Para mais informações sobre as configurações de exibição, consulte Sobre as configurações de exibição.

Os controles de exibição permitem criar regras que personalizam como as configurações de exibição veiculam resultados.

É possível criar um controle de exibição no console da Pesquisa de varejo que consiste em uma condição que aciona o controle e uma ação que ocorre quando a condição é acionada. Depois, é possível anexar o novo controle de exibição a uma configuração de exibição.

As configurações de veiculação têm uma relação de muitos para muitos com os controles. É possível adicionar vários controles a uma configuração de exibição, e um único controle pode ser associado a várias configurações de exibição.

Ao criar controles e configurações de exibição, você seleciona um produto (recomendações ou pesquisa) que pode ser usado. Os controles de veiculação só podem ser associados a configurações de veiculação do mesmo tipo de produto. Por exemplo, um controle de veiculação criado para recomendações não pode ser associado a uma configuração de veiculação criada para pesquisa.

As configurações de exibição gerenciam quais controles são aplicados durante uma pesquisa ou solicitação de previsão. Somente os controles na configuração de veiculação ativa de uma solicitação são considerados no momento da veiculação. Por exemplo, suponha que você tenha criado dois controles: um chamado "gShoe Sale" que aumenta os resultados da marca gShoe quando "shoes" é pesquisado e um controle chamado "More Shoes" que expande as consultas usando o termo "running shoes" para incluir "sport shoes". Se você anexar apenas o controle "gShoe Sale" a uma configuração de veiculação, as solicitações de pesquisa que usam essa configuração vão aumentar os resultados do gShoe para consultas que usam o termo "shoes", mas o controle "More Shoes" não terá efeito porque não está anexado à configuração de veiculação que você está usando.

É possível criar controles e, em seguida, adicioná-los ou trocá-los em uma configuração de exibição ativa.

Crie ou modifique os controles de exibição a qualquer momento na página Controles ou inline usando o método Controls.create. No console, é possível criar controles durante o processo de criação da configuração de disponibilização.

É possível criar até 100 controles de veiculação. Se você precisar de mais controles de veiculação, solicite uma cota adicional. Para saber como solicitar mais cota, consulte Aumentar suas cotas. Uma configuração de veiculação pode ter até 100 controles de veiculação de qualquer tipo, exceto controles de redirecionamento, cujo limite é de 1.000 por configuração de veiculação.

Os controles de exibição estão disponíveis para:

  • Boost/bury: afeta a classificação e a ordem dos resultados na lista de resultados retornada. Disponível para pesquisa e recomendações.
  • Filtro: remove os resultados que não passam no filtro da lista de resultados retornados. Disponível apenas para pesquisa.
  • Redirecionar: redireciona seus usuários para uma página específica, dependendo da consulta de pesquisa. Disponível apenas para pesquisa.
  • Linguística: personaliza a linguística da consulta de pesquisa. Disponível apenas para pesquisa. Vários tipos de controle linguístico estão disponíveis:
    • Sinônimo: expande os sinônimos considerados para uma consulta de pesquisa.
    • Sinônimo unidirecional: expande os sinônimos considerados unidirecionalmente para termos específicos.
    • Não associar: impede que um grupo de termos seja usado na pesquisa quando termos específicos aparecem.
    • Ignorar: impede que um termo seja usado em pesquisas.
    • Substituição: substitui termos na consulta de pesquisa.
  • Fixação: afeta a ordem dos resultados, colocando um resultado em uma posição específica, por exemplo, na posição 4. Disponível para pesquisa e navegação.

Para conferir exemplos desses controles, consulte Sobre os controles de veiculação.

Tutorial de controle de redirecionamento

Este tutorial mostra como usar o controle de redirecionamento.

Para seguir as instruções da tarefa diretamente no editor do Cloud Shell, clique em Orientação:

Orientações

Criar um novo controle de exibição

Crie um novo controle de exibição na página "Controles" no Console do Google Cloud ou inline usando o método Controls.create.

Os controles têm requisitos diferentes, dependendo do tipo. Acesse o procedimento de criação do tipo de controle que você planeja criar:

Criar um controle de otimização/ocultação

Consulte Controles de aumento/início para mais informações sobre esse tipo de controle.

Esse tipo de controle está disponível para pesquisa e recomendações.

Para criar um controle de aumento/ocultamento de pesquisa:

Console

  1. Acesse a página Controles no console da Pesquisa para varejo.

    Acessar a página "Controles"

  2. Na guia Controles de veiculação, clique em Criar controle.

    O painel Criar controle é aberto.

  3. Na seção Preferências, no campo Nome do controle, insira um nome para o novo controle.

  4. Opcional: para mudar o ID de controle criado automaticamente, clique em Editar e insira um novo ID.

  5. Na seção Seleção de produtos, selecione Pesquisar.

  6. Escolha Controles de aumento/início como o tipo de controle. Clique em Continuar.

  7. Na seção Acionadores, selecione o tipo de comportamento do usuário que aciona esse controle.

    • Procurar categorias: a regra é acionada quando um usuário procura categorias no seu site (search.request.query está vazio).

    • Pesquisa: a regra é acionada quando um usuário pesquisa no seu site (search.request.query não está vazio). Para definir esse controle para acionar quando qualquer categoria for navegada ou qualquer consulta for pesquisada, pule a próxima etapa.

  8. Opcional: defina categorias ou consultas específicas que podem acionar esse controle, dependendo se uma categoria específica é navegada ou se uma consulta específica é pesquisada.

    • Se você escolheu Procurar categorias: no campo Categorias, insira as categorias que vão acionar esse controle quando forem procuradas.

    • Se você escolheu Pesquisa: clique no botão Adicionar consulta para adicionar termos de consulta (por exemplo, running shoes) a serem filtrados. Para cada termo, escolha Correspondência parcial ou Correspondência total.

  9. Opcional: clique no botão Adicionar período para incluir um ou mais períodos em que esse controle pode ser aplicado.

  10. Clique em Continuar para acessar a seção Ações.

  11. Adicione filtros para atributos de produtos no campo Boost/bury product.

    Use a sintaxe da expressão de filtro documentada em Como filtrar e ordenar. Por exemplo, para especificar as versões em vermelho e azul de "produto1" e "produto2": (id: ANY("product1","product2")) AND (colorFamily: ANY("Red","Blue"))

  12. Em Valor de otimização/aumento, use o controle deslizante para definir a força do aumento. Valores positivos impulsionam os resultados, e valores negativos os ocultam. Clique em Continuar.

  13. Na seção Configurações de exibição, selecione as configurações de exibição a que aplicar o controle.

  14. Envie suas configurações de controle.

    Leva alguns minutos para que os controles recém-criados ou atualizados estejam prontos para exibir o tráfego em tempo real. É possível testar se as mudanças foram aplicadas na página Avaliar do console.

Agora você pode encontrar o novo controle listado na guia Controles de exibição da página Controles.

curl

Faça uma solicitação Control.create com um ID de controle e uma instância de Control contida no corpo da solicitação.

Para detalhes sobre os campos, consulte a referência da API Controls e a referência da API Controls.create.

Um controle de aumento/ocultamento pode ser acionado quando um usuário navega por categorias no seu site (search.request.query está vazio) ou quando um usuário faz uma pesquisa no seu site (search.request.query não está vazio).

O exemplo a seguir mostra campos para um controle acionado pela navegação, em que searchSolutionUseCase é definido como SEARCH_SOLUTION_USE_CASE_BROWSE.

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "searchSolutionUseCase": [
                "SEARCH_SOLUTION_USE_CASE_BROWSE"
              ],
              "rule": {
                "condition": {
                  "pageCategories": [
                      "CATEGORY_ABC",
                      "CATEGORY_XYZ"
                  ],
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "boostAction": {
                  "boost": BOOST_NUMBER,
                  "productsFilter": "FILTER_EXPRESSION"
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"

O exemplo a seguir mostra campos para um controle acionado por pesquisa, em que searchSolutionUseCase é definido como SEARCH_SOLUTION_USE_CASE_SEARCH.

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "searchSolutionUseCase": [
                "SEARCH_SOLUTION_USE_CASE_SEARCH"
              ],
              "rule": {
                "condition": {
                  "queryTerms": [
                    {
                      "value": "VALUE_1",
                      "fullMatch": "FULLMATCH_BOOLEAN_1"
                    },
                    {
                      "value": "VALUE_2",
                      "fullMatch": "FULLMATCH_BOOLEAN_2"
                    }
                  ],
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "boostAction": {
                  "boost": BOOST_NUMBER,
                  "productsFilter": "FILTER_EXPRESSION"
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"

Leva alguns minutos para que os controles recém-criados ou atualizados estejam prontos para exibir o tráfego em tempo real. É possível testar se as mudanças foram aplicadas na página Avaliar do console.

Para adicionar um controle a uma configuração de veiculação, use o método ServingConfig.addControl:

Criar um controle de otimização/ocultação de recomendações

Para criar um controle de otimização/inserção de recomendações:

Console

  1. Acesse a página Controles no console da Pesquisa para varejo.

    Acessar a página "Controles"

  2. Na guia Controles de veiculação, clique em Criar controle.

    O painel Criar controle é aberto.

  3. Na seção Preferências, no campo Nome do controle, insira um nome para o novo controle.

  4. (Opcional) Para mudar o ID de controle criado automaticamente, clique em Editar e insira um novo ID.

  5. Na seção Seleção de produtos, selecione Recomendação.

  6. Escolha Controles de aumento/início como o tipo de controle.

  7. Clique em Continuar para acessar a seção Ações.

  8. Adicione filtros para atributos de produtos no campo Boost/bury product.

    Use a sintaxe da expressão de filtro documentada em Filtrar recomendações.

    Por exemplo, para especificar as versões em vermelho e azul de "produto1" e "produto2": (id: ANY("product1","product2")) AND (colorFamily: ANY("Red","Blue"))

  9. Em Valor de otimização/aumento, use o controle deslizante para definir a força do aumento. Valores positivos impulsionam os resultados, e valores negativos os ocultam.

  10. Clique em Continuar para acessar a seção Configurações de veiculação.

  11. Selecione as configurações de exibição a que aplicar o controle.

  12. Envie suas configurações de controle.

    Leva alguns minutos para que os controles recém-criados ou atualizados estejam prontos para exibir o tráfego em tempo real. É possível testar se as mudanças foram aplicadas na página Avaliar do console.

Encontre o novo controle listado na guia Controles de exibição da página Controles.

curl

Faça uma solicitação Control.create com um ID de controle e uma instância de Control contida no corpo da solicitação.

Para detalhes sobre os campos, consulte a referência da API Controls e a referência da API Controls.create.

Para criar uma expressão de filtro, use a sintaxe documentada em Recomendações de filtro.

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_RECOMMENDATION" ],
                "boostAction": {
                  "boost": BOOST_NUMBER,
                  "productsFilter": "FILTER_EXPRESSION"
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"

Leva alguns minutos para que os controles recém-criados ou atualizados estejam prontos para exibir o tráfego em tempo real. É possível testar se as mudanças foram aplicadas na página Avaliar do console.

Para adicionar um controle a uma configuração de veiculação, use o método ServingConfig.addControl:

Criar um controle de filtro

Consulte Controles de filtro para saber mais sobre esse tipo de controle.

Console

  1. Acesse a página Controles no console da Pesquisa para varejo.

    Acessar a página "Controles"

  2. Na guia Controles de veiculação, clique em Criar controle.

    O painel Criar controle é aberto.

  3. Na seção Preferências, no campo Nome do controle, insira um nome para o novo controle.

  4. Opcional: para mudar o ID de controle criado automaticamente, clique em Editar e insira um novo ID.

  5. Escolha Controles de filtro como o tipo de controle.

  6. Clique em "Continuar" para acessar a seção Acionadores.

  7. Selecione o tipo de comportamento do usuário que aciona esse controle:

    • Procurar categorias: a regra é acionada quando um usuário procura categorias no seu site (search.request.query está vazio).

    • Pesquisa: a regra é acionada quando um usuário pesquisa no seu site (search.request.query não está vazio).

  8. Opcional: defina uma condição de controle que acione a regra com base na categoria que é navegada ou na consulta que é pesquisada. A opção disponível depende se você escolheu Procurar categorias ou Pesquisar:

    • Se você escolheu Procurar categorias: no campo Categorias, insira quais categorias vão acionar esse controle quando forem procuradas.

    • Se você tiver escolhido Pesquisa: clique no botão Adicionar consulta para adicionar termos de consulta (por exemplo, running shoes) a serem filtrados e selecione uma das seguintes opções para cada termo:

      • Correspondência parcial: esse controle se aplica quando uma consulta contém uma correspondência parcial para esse termo.
      • Correspondência completa: esse controle se aplica somente quando uma consulta contém uma correspondência completa a esse termo.

      Quando um desses termos é incluído em uma consulta, o controle é aplicado.

  9. Opcional: clique no botão Adicionar período para incluir um ou mais períodos em que esse controle pode ser aplicado.

  10. Clique em Continuar para acessar a seção Ações.

  11. Adicione filtros para atributos de produtos no campo Ação de filtro.

    Use a sintaxe da expressão de filtro documentada em Como filtrar e ordenar.

    Por exemplo, para especificar as versões em vermelho e azul de "produto1" e "produto2": (id: ANY("product1","product2")) AND (colorFamily: ANY("Red","Blue"))

  12. Clique em Continuar para acessar a seção Configurações de veiculação.

  13. Selecione as configurações de exibição a que aplicar o controle.

  14. Envie suas configurações de controle.

    Leva alguns minutos para que os controles recém-criados ou atualizados estejam prontos para exibir o tráfego em tempo real. É possível testar se as mudanças foram aplicadas na página Avaliar do console.

Encontre o novo controle listado na guia Controles de exibição da página Controles.

curl

Faça uma solicitação Control.create com um ID de controle e uma instância de Control contida no corpo da solicitação.

Para detalhes sobre os campos, consulte a referência da API Controls e a referência da API Controls.create.

Um controle de filtro pode ser acionado quando um usuário navega por categorias no seu site (search.request.query está vazio) ou quando um usuário faz uma pesquisa no seu site (search.request.query não está vazio).

O exemplo a seguir mostra campos para um controle acionado pela navegação, em que searchSolutionUseCase é definido como SEARCH_SOLUTION_USE_CASE_BROWSE.

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "searchSolutionUseCase": [
                "SEARCH_SOLUTION_USE_CASE_BROWSE"
              ],
              "rule": {
                "condition": {
                  "pageCategories": [
                      "CATEGORY_ABC",
                      "CATEGORY_XYZ"
                  ],
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "filterAction": {
                  "filter": "FILTER_EXPRESSION"
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"

O exemplo a seguir mostra campos para um controle acionado por pesquisa, em que searchSolutionUseCase é definido como SEARCH_SOLUTION_USE_CASE_SEARCH.

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "searchSolutionUseCase": [
                "SEARCH_SOLUTION_USE_CASE_SEARCH"
              ],
              "rule": {
                "condition": {
                  "pageCategories": [
                      "CATEGORY_ABC",
                      "CATEGORY_XYZ"
                  ],
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "filterAction": {
                  "filter": "FILTER_EXPRESSION"
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"

Para adicionar um controle a uma configuração de veiculação, use o método ServingConfig.addControl:

Criar um controle de redirecionamento

Consulte Controles de redirecionamento para saber mais sobre esse tipo de controle.

Console

  1. Acesse a página Controles no console da Pesquisa para varejo.

    Acessar a página "Controles"

  2. Na guia Controles de veiculação, clique em Criar controle.

    O painel Criar controle é aberto.

  3. Na seção Preferências, no campo Nome do controle, insira um nome para o novo controle.

  4. Opcional: para mudar o ID de controle criado automaticamente, clique em Editar e insira um novo ID.

  5. Escolha Controles de redirecionamento como o tipo de controle.

  6. Clique em "Continuar" para acessar a seção Acionadores.

  7. Crie pelo menos um acionador de termo de consulta ou de período. Os controles de redirecionamento exigem pelo menos um acionador:

  8. Selecione o tipo de comportamento do usuário que aciona esse controle:

    • Procurar categorias: a regra é acionada quando um usuário procura categorias no seu site (search.request.query está vazio).

    • Pesquisa: a regra é acionada quando um usuário pesquisa no seu site (search.request.query não está vazio).

  9. Defina uma condição de controle que acione a regra com base na categoria que é navegada ou na consulta que é pesquisada. A opção disponível depende se você escolheu Procurar categorias ou Pesquisar:

    • Se você escolheu Procurar categorias: no campo Categorias, insira quais categorias vão acionar esse controle quando forem procuradas.

    • Se você tiver escolhido Pesquisa: clique no botão Adicionar consulta para adicionar termos de consulta (por exemplo, running shoes) a serem filtrados e selecione uma das seguintes opções para cada termo:

      • Correspondência parcial: esse controle se aplica quando uma consulta contém uma correspondência parcial para esse termo.
      • Correspondência completa: esse controle se aplica somente quando uma consulta contém uma correspondência completa a esse termo.

      Quando um desses termos é incluído em uma consulta, o controle é aplicado.

  10. Clique no botão Adicionar período para incluir um ou mais períodos em que esse controle pode ser aplicado.

  11. Clique em Continuar para acessar a seção Ações.

  12. Insira o URI para redirecionar quando esse controle for acionado.

  13. Clique em Continuar para acessar a seção Configurações de veiculação.

  14. Selecione as configurações de exibição a que aplicar o controle.

  15. Envie suas configurações de controle.

    Leva alguns minutos para que os controles recém-criados ou atualizados estejam prontos para exibir o tráfego em tempo real. É possível testar se as mudanças foram aplicadas na página Avaliar do console.

Encontre o novo controle listado na guia Controles de exibição da página "Controles".

curl

Faça uma solicitação Control.create com um ID de controle e uma instância de Control contida no corpo da solicitação.

Para detalhes sobre os campos, consulte a referência da API Controls e a referência da API Controls.create.

Um controle de redirecionamento pode ser acionado quando um usuário navega por categorias no seu site (search.request.query está vazio) ou quando um usuário faz uma pesquisa no seu site (search.request.query não está vazio).

O exemplo a seguir mostra campos para um controle acionado pela navegação, em que searchSolutionUseCase é definido como SEARCH_SOLUTION_USE_CASE_BROWSE.

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "searchSolutionUseCase": [
                "SEARCH_SOLUTION_USE_CASE_BROWSE"
              ],
              "rule": {
                "condition": {
                  "queryTerms": [
                    {
                      "value": "VALUE_1",
                      "fullMatch": "FULLMATCH_BOOLEAN_1"
                    },
                    {
                      "value": "VALUE_2",
                      "fullMatch": "FULLMATCH_BOOLEAN_2"
                    }
                  ],
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "redirectAction": {
                  "redirectUri": "REDIRECT_URI",
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"

O exemplo a seguir mostra campos para um controle acionado por pesquisa, em que searchSolutionUseCase é definido como SEARCH_SOLUTION_USE_CASE_SEARCH.

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "searchSolutionUseCase": [
                "SEARCH_SOLUTION_USE_CASE_SEARCH"
              ],
              "rule": {
                "condition": {
                  "queryTerms": [
                    {
                      "value": "VALUE_1",
                      "fullMatch": "FULLMATCH_BOOLEAN_1"
                    },
                    {
                      "value": "VALUE_2",
                      "fullMatch": "FULLMATCH_BOOLEAN_2"
                    }
                  ],
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "redirectAction": {
                  "redirectUri": "REDIRECT_URI",
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"

Para adicionar um controle a uma configuração de veiculação, use o método ServingConfig.addControl:

Criar um controle de sinônimos bidirecional

Consulte Controles de sinônimos bidirecionais para mais informações sobre esse tipo de controle.

Console

  1. Acesse a página Controles no console da Pesquisa para varejo.

    Acessar a página "Controles"

  2. Na guia Controles de veiculação, clique em Criar controle.

  3. No campo Nome do controle, insira um nome para o novo controle.

    O painel Criar controle é aberto.

  4. Você vai estar na seção Preferências.

  5. Opcional: para mudar o ID de controle criado automaticamente, clique em Editar e insira um novo ID.

  6. Escolha Controle de sinônimos bidirecional como o tipo de controle.

  7. Clique em "Continuar" para acessar a seção Acionadores.

  8. Opcional: clique no botão Adicionar período para incluir um ou mais períodos em que esse controle pode ser aplicado.

  9. Clique em Continuar para acessar a seção Ações.

  10. No campo Synonyms, insira de 2 a 100 termos de consulta (por exemplo, shirt e top) que sejam sinônimos entre si.

    Quando qualquer um desses termos é incluído em uma consulta, a pesquisa considera os outros termos como sinônimos do termo incluído.

  11. Clique em Continuar para acessar a seção Configurações de veiculação.

  12. Selecione as configurações de exibição a que aplicar o controle.

  13. Envie suas configurações de controle.

    Leva alguns minutos para que os controles recém-criados ou atualizados estejam prontos para exibir o tráfego em tempo real. É possível testar se as mudanças foram aplicadas na página Avaliar do console.

Encontre o novo controle listado na guia Controles de exibição da página "Controles".

curl

Faça uma solicitação Control.create com um ID de controle e uma instância de Control contida no corpo da solicitação.

Para detalhes sobre os campos, consulte a referência da API Controls e a referência da API Controls.create.

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "rule": {
                "condition": {
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                    ]
                },
                "twoWaySynonymAction": {
                  "synonyms": [
                    "SYNONYM_1",
                    "SYNONYM_2"
                  ]
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"

Para adicionar um controle a uma configuração de veiculação, use o método ServingConfig.addControl. Consulte Adicionar controles às configurações de exibição inline.

Criar um controle de sinônimos unidirecional

Consulte Controles de sinônimos unidirecionais para mais informações sobre esse tipo de controle.

Console

  1. Acesse a página Controles no console da Pesquisa para varejo.

    Acessar a página "Controles"

  2. Na guia Controles de veiculação, clique em Criar controle.

    O painel Criar controle é aberto.

  3. Na seção Preferências, no campo Nome do controle, insira um nome para o novo controle.

  4. Opcional: para mudar o ID de controle criado automaticamente, clique em Editar e insira um novo ID.

  5. Escolha Controle de sinônimo unidirecional como o tipo de controle.

  6. Clique em "Continuar" para acessar a seção Acionadores.

  7. Opcional: clique no botão Adicionar período para incluir um ou mais períodos em que esse controle pode ser aplicado.

  8. Clique em Continuar para acessar a seção Ações.

  9. No campo Termos da consulta, insira termos (por exemplo, shoes) que devem ter sinônimos associados quando qualquer um deles for incluído em uma consulta.

  10. No campo Synonyms, insira os termos que devem ser usados como sinônimos dos termos de consulta especificados. Por exemplo, sneakers e sandals como sinônimos unidirecionais do termo de consulta shoes.

  11. Clique em Continuar para acessar a seção Configurações de veiculação.

  12. Selecione as configurações de exibição a que aplicar o controle.

  13. Envie suas configurações de controle.

    Leva alguns minutos para que os controles recém-criados ou atualizados estejam prontos para exibir o tráfego em tempo real. É possível testar se as mudanças foram aplicadas na página Avaliar do console.

Encontre o novo controle listado na guia Controles de exibição da página "Controles".

curl

Faça uma solicitação Control.create com um ID de controle e uma instância de Control contida no corpo da solicitação.

Para detalhes sobre os campos, consulte a referência da API Controls e a referência da API Controls.create.

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "rule": {
                "condition": {
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "oneWaySynonymAction": {
                  "synonyms": [
                    "queryTerms": [
                      "QUERY_TERM_1",
                      "QUERY_TERM_2"
                    ],
                    "synonyms": [
                      "SYNONYM_1",
                      "SYNONYM_2"
                    ]
                  ]
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"

Para adicionar um controle a uma configuração de veiculação, use o método ServingConfig.addControl:

Criar um controle de não associação

Consulte Controles de não associação para mais informações sobre esse tipo de controle.

Console

  1. Acesse a página Controles no console da Pesquisa para varejo.

    Acessar a página "Controles"

  2. Na guia Controles de veiculação, clique em Criar controle.

    O painel Criar controle é aberto.

  3. Na seção Preferências, no campo Nome do controle, insira um nome para o novo controle.

  4. Opcional: para mudar o ID de controle criado automaticamente, clique em Editar e insira um novo ID.

  5. Escolha Não associar controle como o tipo de controle.

  6. Clique em "Continuar" para acessar a seção Acionadores.

  7. Opcional: clique no botão Adicionar período para incluir um ou mais períodos em que esse controle pode ser aplicado.

  8. Clique em Continuar para acessar a seção Ações.

  9. No campo Termos da consulta, insira os termos (por exemplo, gShoe) que você quer diferenciar explicitamente de outros.

  10. No campo Termos dissociados, insira os termos que serão removidos dos resultados da pesquisa com os termos de consulta especificados.

    Por exemplo, é possível separar o termo de consulta gShoe do termo cheap.

  11. Clique em Continuar para acessar a seção Configurações de veiculação.

  12. Selecione as configurações de exibição a que aplicar o controle.

  13. Envie suas configurações de controle.

    Leva alguns minutos para que os controles recém-criados ou atualizados estejam prontos para exibir o tráfego em tempo real. É possível testar se as mudanças foram aplicadas na página Avaliar do console.

Encontre o novo controle listado na guia Controles de exibição da página "Controles".

curl

Faça uma solicitação Control.create com um ID de controle e uma instância de Control contida no corpo da solicitação.

Para detalhes sobre os campos, consulte a referência da API Controls e a referência da API Controls.create.

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "rule": {
                "condition": {
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "doNotAssociateAction": {
                    "queryTerms": [
                      "QUERY_TERM_1",
                      "QUERY_TERM_2"
                    ],
                    "doNotAssociateTerms": [
                      "DISSOCIATED_TERM_1",
                      "DISSOCIATED_TERM_2"
                    ]
                  ]
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"

Para adicionar um controle a uma configuração de veiculação, use o método ServingConfig.addControl:

Criar um controle de ignora

Consulte Ignorar controles para saber mais sobre esse tipo de controle.

Console

  1. Acesse a página Controles no console da Pesquisa para varejo.

    Acessar a página "Controles"

  2. Na guia Controles de veiculação, clique em Criar controle.

    O painel Criar controle é aberto.

  3. Na seção Preferências, no campo Nome do controle, insira um nome para o novo controle.

  4. Opcional: para mudar o ID de controle criado automaticamente, clique em Editar e insira um novo ID.

  5. Escolha Não associar controle como o tipo de controle.

  6. Clique em "Continuar" para acessar a seção Acionadores.

  7. Opcional: clique no botão Adicionar período para incluir um ou mais períodos em que esse controle pode ser aplicado.

  8. Clique em Continuar para acessar a seção Ações.

  9. No campo Ignorar termos, insira os termos (por exemplo, shoddy) que você quer que uma pesquisa ignore quando eles forem inseridos como termos de consulta.

  10. Clique em Continuar para acessar a seção Configurações de veiculação.

  11. Selecione as configurações de exibição a que aplicar o controle.

  12. Envie suas configurações de controle.

    Leva alguns minutos para que os controles recém-criados ou atualizados estejam prontos para exibir o tráfego em tempo real. É possível testar se as mudanças foram aplicadas na página Avaliar do console.

Encontre o novo controle listado na guia Controles de exibição da página "Controles".

curl

Faça uma solicitação Control.create com um ID de controle e uma instância de Control contida no corpo da solicitação.

Para detalhes sobre os campos, consulte a referência da API Controls e a referência da API Controls.create.

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "rule": {
                "condition": {
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "ignoreAction": {
                  "ignoreTerms": [
                      "IGNORE_TERM_1",
                      "IGNORE_TERM_2"
                    ]
                  ]
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"

Para adicionar um controle a uma configuração de veiculação, use o método ServingConfig.addControl:

Criar um controle substituto

Consulte Controles de substituição para mais informações sobre esse tipo de controle.

Console

  1. Acesse a página Controles no console da Pesquisa para varejo.

    Acessar a página "Controles"

  2. Na guia Controles de veiculação, clique em Criar controle.

    O painel Criar controle é aberto.

  3. Na seção Preferências, no campo Nome do controle, insira um nome para o novo controle.

  4. Opcional: para mudar o ID de controle criado automaticamente, clique em Editar e insira um novo ID.

  5. Escolha Controle de substituição como o tipo de controle.

  6. Clique em "Continuar" para acessar a seção Acionadores.

  7. Opcional: clique no botão Adicionar período para incluir um ou mais períodos em que esse controle pode ser aplicado.

  8. Clique em Continuar para acessar a seção Ações.

  9. No campo Termos da consulta, insira os termos da consulta (por exemplo, gShoe) que você quer substituir pelo termo de substituição.

  10. No campo Termo de substituição, insira o termo que precisa substituir os termos de consulta especificados.

    Por exemplo, você pode substituir o termo da consulta gShoe pelo termo de substituição Google Shoe.

  11. Clique em Continuar para acessar a seção Configurações de veiculação.

  12. Selecione as configurações de exibição a que aplicar o controle.

  13. Envie suas configurações de controle.

    Leva alguns minutos para que os controles recém-criados ou atualizados estejam prontos para exibir o tráfego em tempo real. É possível testar se as mudanças foram aplicadas na página Avaliar do console.

Encontre o novo controle listado na guia Controles de exibição da página "Controles".

curl

Faça uma solicitação Control.create com um ID de controle e uma instância de Control contida no corpo da solicitação.

Para detalhes sobre os campos, consulte a referência da API Controls e a referência da API Controls.create.

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "rule": {
                "condition": {
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "replacementAction": {
                    "queryTerms": [
                      "QUERY_TERM_1",
                      "QUERY_TERM_2"
                    ],
                    "replacementTerm": "REPLACEMENT_TERM"
                  }
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"

Para adicionar um controle a uma configuração de veiculação, use o método ServingConfig.addControl:

Criar um controle de fixação

Para criar um controle de fixação:

Console

  1. Acesse a página Controles no console da Pesquisa para varejo.

    Acessar a página "Controles"

  2. Na guia Controles de veiculação, clique em Criar controle.

    O painel Criar controle é aberto.

  3. No campo Nome do controle da seção Preferências, insira um nome para o novo controle.

  4. Opcional: para mudar o ID de controle criado automaticamente, clique em Editar e insira um novo ID.

  5. Na seção Seleção de produtos, selecione Pesquisar ou navegar.

  6. Escolha Fixar controle como o tipo de controle. Clique em Continuar.

  7. Na seção Acionadores, escolha o comportamento do usuário que aciona esse controle:

    • Categorias de navegação: as solicitações de navegação precisam ter o campo page_categories preenchido, além de search.request.query vazio.

    • Pesquisa: as solicitações de pesquisa exigem que apenas o search.request.query seja preenchido.

      Por padrão, todas as categorias e consultas pesquisadas acionam esse controle.

  8. Opcional: defina uma condição que acione a regra com base em uma categoria específica ou consulta pesquisada:

    • Procurar categorias: no campo Categorias, insira quais categorias acionarão o controle.

    • Pesquisa: para adicionar termos de consulta a serem filtrados (por exemplo, running shoes), clique em Adicionar consulta. Para cada termo, escolha Correspondência parcial ou Correspondência total.

  9. Opcional: clique em Adicionar período ou Adicionar período para incluir um ou mais períodos em que esse controle pode ser aplicado.

  10. Clique em Continuar para acessar a seção Ações. Em Fixar local, use o controle deslizante para especificar a posição em que os produtos serão fixados. O controle deslizante de valor do pino não aceita valores de 0, números negativos ou não inteiros.

    A Vertex AI Search para varejo permite 10 alfinetes no mapa de alfinetes de qualquer controle. A posição pode ser qualquer valor entre 1 e 120 (o tamanho máximo da página de solicitação).

  11. Clique em Continuar para acessar a seção Configurações de veiculação. Selecione as configurações de veiculação a que aplicar o controle e envie as configurações de controle.

    Leva alguns minutos para que os controles recém-criados ou atualizados estejam prontos para exibir o tráfego em tempo real. É possível testar se as mudanças foram aplicadas na página Avaliar do console.

Encontre o novo controle listado na guia Controles de exibição da página Controles.

curl

Faça uma solicitação Control.create com um ID de controle e uma instância de Control contida no corpo da solicitação.

Para detalhes sobre os campos, consulte a referência da API Controls e a referência da API Controls.create.

curl -X POST \
 -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
 -H "Content-Type: application/json; charset=utf-8" \
 -H "X-Goog-User-Project: PROJECT_NUMBER" \
 --data '{
          "displayName": "DisplayName",
          "solutionTypes": "SOLUTION_TYPE_SEARCH",
          "searchSolutionUseCase": ["SEARCH_SOLUTION_USE_CASE_SEARCH"],
     "rule": {
            "condition": {
 "queryTerms": [
                {
                  "value": "Term1",
                  "fullMatch": "boolean: true / false"
                },
                {
                  "value": "Term2",
                  "fullMatch": "boolean: true / false"
                },
             ],
             "activeTimeRange": [
               {
                 "startTime": timestamp1,
                 "endTime": timestamp2
               },
               {
                 "startTime": timestamp3,
                 "endTime": timestamp4
               }
             ]
            },
            "pinAction": {
               "pinMap" :  {
                        "pin_position1": "product_id",
                      "pin_position2": "product_id>"
                    }
            }
              }
}' \
"https://retail.googleapis.com/v2alpha/projects/PROJECT_NUMBER/locations/LOCATION/catalogs/default_catalog/controls?controlId=CONTROL_ID"

O pin_position precisa ser um número inteiro entre [1,10], incluindo esses valores, e product_id precisa existir no seu catálogo. O número máximo de elementos permitidos no mapa de alfinetes é 10 para cada controle.

Em seguida, anexe o controle de fixação à configuração de exibição:

curl -X POST \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-H "X-Goog-User-Project: PROJECT_NUMBER" \
-d '{
      "controlId": "CONTROL_ID"
  }' \
'https://retail.googleapis.com/v2alpha/projects/PROJECT_NUMBER/locations/LOCATION/catalogs/default_catalog/servingConfigs/SERVING_CONFIG_ID:addControl'

Nesse caso, CONTROL_ID precisa ser o controle de fixação id que você criou anteriormente.

Para adicionar um controle a uma configuração de veiculação, use o método ServingConfig.addControl:

Por fim, para testar a configuração, faça uma solicitação de pesquisa. Para garantir que o controle de fixação seja aplicado a uma solicitação, use termos de consulta (na pesquisa) ou categorias de página (na navegação) que correspondam aos termos/categorias fornecidos no controle criado nas etapas anteriores.

Console

  1. Acesse a página Avaliar no console da Pesquisa para varejo.

    Acessar a página "Avaliar"

  2. Acesse a guia Pesquisar.

  3. Digite uma consulta de teste no campo de consulta de pesquisa.

  4. Clique em Visualização da pesquisa.

  5. Confira os resultados para garantir que os produtos escolhidos estão fixados.

curl 

curl -s -X POST -H "Authorization: Bearer " -H "Content-Type: application/json"
--data "{'query': '','visitorId': ''}" \ "https://retail.googleapis.com/v2/projects/PROJECT/locations/global/catalogs/CATALOG/placements/default_search:search"

Restrições para a verificação de erros

Para a verificação de erros, considere estas restrições:

  • Dois produtos não podem ser fixados na mesma posição. Ou seja, os produtos "a" e "b" não podem ocupar a posição 2.
  • Por outro lado, um produto não pode ser fixado em mais de um local. Ou seja, o produto "a" não pode ser fixado nas posições 2 e 3 ao mesmo tempo para a mesma consulta.
  • O product_id precisa existir como um produto no catálogo, supondo que nenhum filtro ou classificação seja aplicado.