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

Configurar atributos

A pesquisa de varejo pode aproveitar os atributos do produto para indexação, reconhecimento dinâmico e capacidade de pesquisa. Nesta página, você verá como definir essas configurações e como elas são tratadas pela pesquisa de varejo, dependendo do método e da configuração usados.

Tipos de atributo

Os atributos do produto podem ter diferentes configurações padrão e opções permitidas, dependendo do tipo.

  • Atributos do sistema: os atributos predefinidos do sistema são campos Product atuais que fornecem mais informações sobre o produto. Eles incluem atributos de produto, como marca, disponibilidade, cor e tamanho. Para todos os atributos de sistema disponíveis para produtos, consulte a documentação de referência Product.

  • Atributos personalizados: são atributos extras definidos usando o campo Product.attributes. Isso pode incluir, por exemplo, nomes de lojas, fornecedores ou estilo. Para exemplos e limites de atributos personalizados, consulte a documentação de referência Product.attributes.

  • Atributos de nível de inventário: atributos personalizados ou do sistema que fornecem informações no nível da loja sobre o produto. É possível usar atributos no nível do inventário para produtos com propriedades que variam significativamente entre lojas e regiões, como itens de mercearia ou produtos que têm promoções específicas da loja.

    inventories.price e inventories.originalPrice são atributos numéricos de sistema predefinidos pela API Retail. É possível criar atributos personalizados no nível do inventário, que podem ser textuais ou numéricos. Os atributos no nível de inventário são indexáveis por padrão. A definição de atributos pesquisáveis e dinâmicos não é compatível com atributos no nível de inventário.

Configurações disponíveis

É possível ativar e desativar os seguintes tipos de configurações de atributos:

  • Indexável: a pesquisa de varejo pode filtrar e atributos usando esse atributo.
  • Atributos dinâmicos: a pesquisa de varejo pode usar automaticamente esse atributo como um atributo dinâmico com base no comportamento anterior do usuário, como cliques e visualizações de atributos. Para ativar o atributo dinâmico para um atributo, Indexable precisa ser definido como verdadeiro para esse atributo.
  • Pesquisável: esse atributo pode ser pesquisado pelas consultas de pesquisa de varejo, o que aumenta o recall dele. Esse controle é aplicável apenas a atributos de texto.

Indexável

Se um atributo for definido como indexável, a pesquisa de varejo poderá filtrar e atributos usando o atributo.

  • Atributos do sistema: a indexação está sempre ativada para atributos predefinidos do sistema. Não é possível desativar essa configuração para atributos do sistema.
  • Atributos personalizados: ativados por padrão. É possível desativar a indexação em qualquer atributo personalizado. Se você pretende tornar um atributo personalizado indexável, ele precisa seguir o padrão regex [a-zA-Z0-9][a-zA-Z0-9_]*. Por exemplo, key0LikeThis ou KEY_1_LIKE_THIS.
  • Atributos de nível de inventário: sempre ativado para atributos de nível de inventário do sistema. Essa configuração não pode ser alterada. Ativado por padrão para atributos personalizados de nível de inventário. Essa configuração pode ser desativada.
  • Dependências: N/A

As mudanças nas configurações de atributos para indexação entram em vigor em até 12 horas ou imediatamente no seu próximo processamento de catálogo. É possível testar se as alterações foram aplicadas na página Avaliar.

Atributos dinâmicos

Quando um atributo é configurado como dinâmico, a pesquisa de varejo pode usá-lo como um atributo dinâmico. Os atributos dinâmicos podem ser adicionados automaticamente a uma pesquisa com base no comportamento anterior do usuário, como cliques e visualizações.

  • Atributos do sistema: ativado por padrão se a indexabilidade estiver definida como verdadeira. É possível desativar o atributo dinâmico de qualquer atributo do sistema.
  • Atributos personalizados: são ativados por padrão quando a indexabilidade está definida como verdadeira. Você pode desativar o atributo dinâmico de qualquer atributo personalizado.
  • Atributos de nível de inventário: não compatível.
  • Dependências: para ativar o atributo dinâmico de um atributo, primeiro é preciso ativar a indexabilidade dele.

A definição do atributo dinâmico para um atributo sempre global. A configuração de atributos dinâmicos aplicada a esse atributo é usada por produtos no catálogo que o utilizam.

As mudanças na configuração do atributo dinâmico levam até dois dias. É possível testar se as alterações foram aplicadas na página Avaliar.

Para atributos numéricos numéricos, os buckets precisam ser especificados na solicitação. Os valores numéricos não são agrupados automaticamente.

Pesquisável

Se um atributo for definido como pesquisável, o recall dele nas consultas de pesquisa de varejo será melhorado.

Somente valores de atributos textuais podem ter recursos de pesquisa ativados. Ele não se aplica a atributos numéricos.

  • Atributos do sistema: os atributos textuais de sistema predefinidos do Product são sempre pesquisáveis. Não é possível alterar essa configuração.
  • Atributos personalizados: desativados por padrão. É possível ativar essa configuração para qualquer atributo personalizado textual.
  • Atributos de nível de inventário: não compatível.
  • Dependências: N/A

Não há garantia de que os produtos com um atributo pesquisável aparecerão nos resultados da pesquisa desse atributo.

Modos de configuração

O modo de configuração da API Retail define como as configurações de atributos são tratadas e quais configurações de atributos podem ser definidas.

  • Modo de configuração de nível de catálogo (padrão): nesse modo, as configurações de atributos no nível de catálogo são usadas como fonte de verdade.
  • Modo de configuração no nível do produto (descontinuado): nesse modo, as configurações de atributo no nível do produto são usadas como fonte da verdade.

Anteriormente, a configuração no nível do produto era o modo padrão. Se você ainda está no modo de configuração no nível do produto e precisa alternar para o modo de configuração no nível do catálogo, entre em contato com o suporte do Retail. Após fazer a troca, a pesquisa de varejo não é compatível com o modo de configuração no nível do produto.

Para verificar o modo de configuração, acesse a página Controles do Console do varejo. Se a opção Indexável estiver disponível como uma coluna na guia Controles de todo o site, a API Retail estará no modo de configuração no nível do catálogo. Se a coluna Indexável não estiver disponível na guia Controles de todo o site, a API Retail estará no modo de configuração no nível do produto.

Métodos de configuração

Você pode definir as configurações de atributos das seguintes maneiras:

  • Console do Cloud de varejo: defina configurações de atributos no nível do catálogo usando o Console do Cloud. Isso configura os atributos globalmente em todos os produtos. Qual dessas configurações está disponível no console depende do modo de configuração da API Retail.

  • O método Product da API (obsoleto): defina atributos personalizados no nível do produto usando o método da API Product. Não é recomendado definir atributos com esse método para novos usuários da API Retail.

Configurar atributos no console

É possível definir opções globais de atributos em todos os produtos na página Controles do Console do varejo, na guia Controles em todo o site. Para mais detalhes sobre como definir isso no console, consulte Definir controles de atributos para todo o site.

A API Retail precisa estar no modo de configuração no nível de catálogo para usar esse recurso.

As alterações nas configurações de atributos para indexação e pesquisa entram em vigor em até 12 horas ou imediatamente no seu próximo processamento de catálogo. As mudanças na configuração de reconhecimento dinâmico levam até dois dias. É possível testar se as alterações foram aplicadas na página Avaliar.

Configurar atributos com AttributesConfig

O recurso da API AttributesConfig permite gerenciar configurações de atributos no nível do catálogo.

Os campos a seguir definem opções de atributos no nível do catálogo:

Para recuperar todas as configurações de atributos, use o método GetAttributesConfig.

Atualizar vários atributos

Use o método updateAttributesConfig para atualizar vários atributos no nível do catálogo.

Os atributos de catálogo que você inclui na solicitação são atualizados no catálogo ou inseridos se não existirem. Se não houver valor para um campo de atributo do catálogo, um valor padrão será atribuído a ele.

O número máximo de atributos de catálogo permitidos em uma solicitação é 1.000.

Atualizar um atributo individual

Os métodos a seguir são usados para atualizar atributos de catálogo individuais.

AddCatalogAttribute: adiciona uma configuração de atributo individual a um atributo de catálogo.

Consulte a documentação de referência da API para AddCatalogAttribute.

ReplaceCatalogAttribute: modifica uma configuração de atributo individual. Isso substitui a CatalogAttribute especificada no AttributesConfig atualizando o atributo de catálogo com o mesmo CatalogAttribute.key.

Consulte a documentação de referência da API para ReplaceCatalogAttribute.

RemoveCatalogAttribute: remove uma configuração de atributo individual de AttributesConfig.

Somente os CatalogAttributes que não estão sendo usados pelos produtos podem ser excluídos. Se um CatalogAttribute estiver em uso, RemoveCatalogAttribute não o excluirá, mas redefinirá as propriedades de configuração para os valores padrão. CatalogAttribute.inUse será definido como True se o atributo estiver sendo usado por algum produto.

Consulte a documentação de referência da API para RemoveCatalogAttribute.

Configurar atributos com o método Product (descontinuado)

Não é recomendado definir atributos com esse método para novos usuários da API Retail.

Os campos a seguir definem configurações indexáveis e pesquisáveis para um produto específico usando o método de API Product:

Configurar atributos com o método Product (descontinuado)

Não é recomendado definir atributos com esse método para novos usuários da API Retail.

Os campos a seguir definem configurações indexáveis e pesquisáveis para um produto específico usando o método de API Product: