Esta é a documentação do Recommendations AI, da Pesquisa de varejo e do novo Console do Retail.

Gerenciar configurações de exibição

Nesta página, descrevemos como excluir, editar e listar configurações de exibição, além de estatísticas de revisão sobre cada configuração.

Para ajuda com a criação de uma nova configuração de exibição, consulte Criar configurações de exibição.

Se você tiver posições ou criar novas posições, a API Retail criará automaticamente uma configuração de exibição associada a cada veiculação. Criar uma configuração de exibição não cria uma posição correspondente. A exclusão de uma configuração de exibição remove a posição correspondente e a exclusão de uma veiculação exclui a configuração de exibição correspondente.

Editar configurações de exibição

É possível editar as configurações de exibição usando o Console do varejo ou a API Retail.

Editar configurações de exibição no console

É possível ver e editar os controles de cada configuração de exibição na página Configurações de exibição. Clique em uma configuração de exibição para ver a página Detalhes, que lista todos os controles de veiculação e de todo o site dessa configuração.

Nesta página, é possível editar controles, criar novos ou aplicar controles existentes à configuração.

Leva alguns minutos para que as configurações de exibição recém-criadas ou atualizadas estejam prontas para exibir o tráfego ativo. É possível testar as mudanças imediatamente na página Avaliar.

Editar configurações de exibição in-line

É possível atualizar os campos de configuração de exibição, adicionar controles de veiculação e removê-los inline usando os métodos da API Retail.

Aplicar patch nas configurações de exibição in-line

Para atualizar campos em uma configuração de exibição, use ServingConfig.patch e inclua uma instância de ServingConfig no corpo da solicitação. Especifique os campos a serem atualizados com o parâmetro updateMask ou deixe-os indefinidos para atualizar todos os campos compatíveis.

Para mais informações sobre esse método, consulte a referência da API ServingConfig.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/servingConfigs/SERVING_CONFIG_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/servingConfigs/SERVING_CONFIG_ID?updateMask=FIELD_NAME_1,FIELD_NAME_2'

Adicionar controles às configurações de exibição in-line

Para adicionar um controle a uma configuração de exibição, use ServingConfig.addControl. O controle é adicionado na última posição da lista de controles a que ele pertence. Por exemplo, um controle facetSpec é aplicado na última posição de servingConfig.facetSpecIds.

Para mais informações sobre esse método, consulte a referência da API ServingConfig.addControl.

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

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

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

Para mais informações sobre esse método, consulte a referência da API ServingConfig.removeControl.

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

Ver configurações de exibição

É possível ver as configurações de exibição usando o Console do varejo ou a API Retail.

Visualizar configurações de exibição no console

É possível ver todas as configurações de exibição na página Configurações de exibição.

Ver configurações de exibição in-line

Para ver uma única configuração de exibição in-line, use ServingConfig.get.

Para mais informações sobre esse método, consulte a referência da API ServingConfig.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/servingConfigs/SERVING_CONFIG_ID'

Para listar todas as configurações de exibição in-line, use ServingConfig.list.

Opcionalmente, 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 de list incluirá um token de página. Você pode transmitir um token de página no parâmetro pageToken de uma solicitação list para recuperar a próxima página de resultados.

Para mais informações sobre esse método, consulte a referência da API ServingConfig.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/servingConfigs?pageSize=PAGE_SIZE&pageToken=PAGE_TOKEN'

Excluir uma configuração de exibição

É possível excluir as configurações de exibição usando o Console do varejo ou a API Retail.

Excluir configurações de exibição no console

Para excluir uma configuração de exibição no console, faça o seguinte:

  1. Acesse a página "Configurações de exibição de varejo" no Console do Google Cloud.

    Acessar a página "Configurações de exibição"

  2. Clique na configuração de veiculação que você quer excluir para abrir a página de detalhes.

  3. Clique em Excluir na barra de botões na parte superior da página.

  4. Se a configuração de exibição for considerada ativa, insira novamente o ID e clique em Confirmar para concluir a exclusão.

Excluir uma configuração de exibição in-line

Para excluir uma única configuração de exibição in-line, use ServingConfig.delete.

Para mais informações sobre esse método, consulte a referência da API ServingConfig.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/servingConfigs/SERVING_CONFIG_ID'

Como revisar as estatísticas de configuração do serviço

Veja os detalhes de cada configuração de exibição na página Configurações de exibição. Para qualquer configuração na tabela, clique em Visualizar análise para ver suas estatísticas.

A taxa de cliques mostra os cliques por pesquisa para a configuração de veiculação. Taxa de conversão indica as compras por pesquisa para a configuração.