Gerenciar controles de veiculação

Esta página descreve como visualizar, editar, excluir, exportar e importar controles de veiculação.

Para informações gerais sobre os controles de exibição e instruções sobre como criar controles de exibição, consulte Sobre os controles de exibição e Criar controles de exibição.

Acessar e editar controles de exibição

É possível conferir os controles de veiculação da Vertex AI para Pesquisa para Retail usando o console e a API.

Conferir e editar controles de exibição no console

A guia Controles de exibição da página "Controles" lista todos os seus controles de exibição e as configurações de exibição associadas. Clique no botão Ícone Editar controle que pode ser alterado por um controle as configurações e as configurações de veiculação associadas em Editar controle do painel de controle. Clique no ícone Excluir controle para excluir um controle, o que também o remove de todas as configurações de exibição.

Você também pode ver e editar os controles de uma configuração de veiculação específica no a página Configurações de exibição. Clique em uma configuração de veiculação para ver a página Detalhes, que lista todos de veiculação para essa configuração. Clique no ícone Editar controle para mudar as configurações no painel Editar controle. Clique no botão Remover controle para dissociar o controle da configuração de veiculação (isso não exclui a controle).

Leva alguns minutos para que os controles recém-criados ou atualizados estejam prontos para exibir o tráfego em tempo real. Você pode testar se as alterações foram aplicadas na página Avaliar do console.

Exibir controles de veiculação inline

Para ver um único controle de veiculação in-line, use Control.get.

Para saber mais sobre esse método, consulte a Referência da API Control.get.

curl -X GET \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
'https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls/CONTROL_ID'

Para listar vários controles de exibição inline, use Controls.list.

Também é possível usar o parâmetro pageSize para definir um número máximo de resultados a serem retornados. Se mais resultados estiverem disponíveis, a resposta list incluirá um token de página. É possível transmitir um token de página no parâmetro pageToken de um list para recuperar a próxima página de resultados.

Para listar apenas os controles associados a uma determinada configuração de exibição, use o parâmetro de consulta filter para especificar o ID da configuração de exibição.

Para saber mais sobre esse método, consulte a Referência da API Control.list.

curl -X GET \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
'https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?pageSize=PAGE_SIZE&pageToken=PAGE_TOKEN&filter=servingConfig=SERVING_CONFIG_ID

Controles de veiculação de patch inline

Para atualizar campos em um controle de veiculação, use Controls.patch e inclua uma instância de Control no corpo da solicitação. Especifique os campos a serem atualizados com o parâmetro updateMask ou deixe-o indefinido para atualizar todos os campos com suporte.

Para saber mais sobre esse método, consulte a referência da API Controls.patch.

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d '{
      "name": "projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls/CONTROL_ID",
      "FIELD_NAME_1": "NEW_FIELD_VALUE_1"
      "FIELD_NAME_2": "NEW_FIELD_VALUE_2"
    }' \
'https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls/CONTROL_ID?updateMask=FIELD_NAME_1,FIELD_NAME_2'

Adicionar controles às configurações de exibição inline

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

Para saber mais sobre esse método, consulte a referência da API ServingConfig.addControl.

Para conferir um exemplo desse método, consulte Gerenciar configurações de veiculação.

Remover controles das configurações de exibição inline

Para remover um controle de uma configuração de exibição, use ServingConfig.removeControl.

Para saber mais sobre esse método, consulte a Referência da API ServingConfig.addControl.

Para conferir um exemplo desse método, consulte Gerenciar configurações de exibição.

Excluir um controle de exibição

Você pode excluir um controle de exibição do console ou in-line usando a propriedade Controls.delete.

Excluir um controle de exibição no console

Excluir um controle de exibição para removê-lo de todas as configurações de exibição que o estão usando.

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

    Acessar a página "Controles"

  2. Na linha da tabela do controle que você pretende remover, clique em Excluir.

  3. Na janela de confirmação, clique em Excluir para concluir o processo.

Excluir um controle de veiculação in-line

Para excluir controles de exibição inline, use Controls.delete.

Para saber mais sobre esse método, consulte a Referência da API Controls.delete.

curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
'https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls/SERVING_CONTROL_ID'

Exportar controles de veiculação

É possível exportar os controles de veiculação para um arquivo em um bucket do Cloud Storage.

Há dois motivos para exportar e importar controles de veiculação:

  • Para mover os controles de veiculação de um projeto para outro.

  • Para realizar uma edição em massa em todos ou em alguns controles de veiculação. Exporte os controles de veiculação, edite o arquivo exportado e importe-o para mudar ou adicionar controles de veiculação.

É possível exportar e importar usando o console do Search for Retail. Ao exportar controles de veiculação, você exporta todos eles na projeto.

Para exportar os controles de veiculação, faça o seguinte:

  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 Exportar controles.

  3. Na janela Export Serving Controls, selecione o bucket do Cloud Storage para o qual você quer exportar o arquivo de controles.

  4. Clique em Exportar.

    Os controles exportados são salvos em um arquivo NDJSON no bucket selecionado com um nome no seguinte formato:

    projects_PROJECT_ID_TIMESTAMP_exported_controls.ndjson
  5. Depois que a operação de exportação for concluída, você poderá conferir o status da operação na lista Importação, exportação e exclusão em massa na janela Atividade de exportação. Abra a janela Export activity clicando em Show. na janela da mensagem ou seguindo as instruções em Consultar o status de um operação de integração específica.

Importar controles de veiculação

Para adicionar controles de exibição ou modificar os atuais em massa, faça as mudanças em um arquivo de controles exportado. Você pode importá-los para projeto original ou em uma outra projeto.

Informações importantes sobre a importação de controles de veiculação:

  • Não é possível importar um arquivo de controle de veiculação se ele tiver controles de veiculação de pesquisa e recomendações.

  • Quando você importa controles de veiculação, todos os controles de veiculação no arquivo se tornam associadas à configuração de veiculação especificada na importação. Se um controle de veiculação já estiver associado a outra configuração de veiculação no projeto, essa associação também será mantida.

Para importar controles de veiculação, faça o seguinte:

  1. Edite e analise um arquivo de controle de veiculação exportado e coloque-o em um do bucket do Cloud Storage. Para exportar os controles de veiculação, consulte a tarefa anterior Exportar controles de veiculação.)

    Verifique se o arquivo contém apenas controles de veiculação de pesquisa ou somente recomendações. Não é possível importar um arquivo que contenha os dois tipos.

  2. Acesse a página Controles no console do Search for Retail.

    Acessar a página "Controles"

  3. Na guia Controles de veiculação, clique em Importar controles.

  4. Na janela Importar controles de veiculação:

    1. Procure e selecione o bucket do Cloud Storage e o arquivo NDJSON que contém os controles que você quer importar.

    2. Selecione a configuração de veiculação que você quer associar aos controles de veiculação importados.

    3. Revise o plano de visualização de importação. Os controles que serão criados são exibidos na guia Novo e os controles que serão modificados são exibidos na guia Modificado.

  5. Clique em Importar.

    Uma operação de longa duração é iniciada para importar os controles novos e modificados.

  6. Depois que a operação de importação for concluída, você poderá conferir o status da operação na guia Controles da janela Status da atividade. Abra a janela Status da atividade clicando em Mostrar na janela de mensagem ou seguindo as instruções em Conferir o status de uma operação de integração específica.