Gerenciar controles de veiculação

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

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

Acessar e editar controles de veiculação

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

Acessar e editar controles de veiculação no console

A guia Controles de veiculação da página "Controles" lista todos os controles de exibição e as configurações de veiculação associadas a eles. Clique no ícone Editar controle de um controle para alterar as configurações e as configurações de veiculação associadas no painel Editar controle. Clique no ícone Excluir controle de um controle para excluí-lo, o que também o remove de todas as configurações de veiculação.

Também é possível ver e editar os controles de uma configuração de veiculação específica na página Configurações de veiculação. Clique em uma configuração de exibição para ver a página Detalhes dela, que lista todos os controles de veiculação dessa configuração. Clique no ícone Editar controle de um controle para alterar as configurações no painel Editar controle. Clique no ícone Remover controle para dissociar o controle da configuração de exibição (isso não exclui o 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.

Ver controles de veiculação inline

Para mostrar um único controle de veiculação inline, 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 veiculação inline, use Controls.list.

Se preferir, use 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 uma solicitação list para recuperar a próxima página de resultados.

Se quiser listar somente os controles associados a determinada configuração de veiculação, use o parâmetro de consulta filter para especificar o ID dessa configuraçã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

Aplicar patches de controles de exibição inline

Para atualizar os campos em um controle de disponibilizaçã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 sem definição 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 exibição.

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

Para remover um controle de uma configuração de veiculaçã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

É possível excluir um controle de veiculação no console ou inline usando o método Controls.delete.

Excluir um controle de veiculação no console

Exclua um controle de veiculação para remover esse controle de todas as configurações de exibição em que ele é usado.

1. Acesse a página Controles no console do Search for Retail.
   
   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 inline

Para excluir os controles de veiculaçã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

Visualização

Esse recurso está sujeito aos "Termos de ofertas pré-GA" na seção "Termos de Serviço gerais" dos Termos específicos de serviço. Os recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições da fase de lançamento.

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

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

• Mover controles de veiculação de um projeto para outro.

• Faça 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 arquivo para alterar ou adicionar controles de veiculação.

É possível exportar e importar usando o console da Pesquisa for Retail. Ao exportar controles de veiculação, você exporta todos os controles de veiculação no projeto.

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

1. Acesse a página Controles no console do Search for Retail.
   
   Acessar a página "Controles"

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

3. Na janela Exportar controles de exibição, 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. Após a conclusão da operação de exportação, será possível ver o status da operação na lista Importar, exportar e excluir atividades em massa na janela Exportar atividade. Abra a janela Export activity clicando em Show na janela de mensagens ou seguindo as instruções em Consultar o status de uma operação de integração específica.

Importar controles de veiculação

Visualização

Esse recurso está sujeito aos "Termos de ofertas pré-GA" na seção "Termos de Serviço gerais" dos Termos específicos de serviço. Os recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições da fase de lançamento.

Para adicionar controles de veiculação ou modificar em massa os controles atuais, faça as alterações em um arquivo de controles exportado. Em seguida, é possível importá-los para o projeto original ou para um projeto diferente.

Coisas que você precisa saber 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 os controles de veiculação, todos eles no arquivo são associados à configuração de veiculação especificada na importação. Se um controle de veiculação já estiver associado a outra configuração de exibição no projeto, essa associação também será mantida.

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

1. Editar e revisar um arquivo de controle de exibição exportado e colocar o arquivo em um 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 apenas controles de veiculação de recomendações. Não é possível importar um arquivo que contenha ambos os 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 com que você quer associar os 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 New e os controles que serão modificados são exibidos na guia Modified.

5. Clique em Importar.

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

6. Após a conclusão da operação de importação, é possível ver o status da operação na guia Controles da janela Status da atividade. Abra a janela Activity status clicando em Show na janela de mensagens ou seguindo as instruções em Consultar o status de uma operação de integração específica.