The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

Einstein Recommendations

A Einstein Recommendations API tem duas funções principais: receber atividades e oferecer recomendações. Nossos clientes também podem ter flexibilidade ao alternar recommenders sem modificar códigos usando nossos componentes de Zona.

A documentação dessa API visa inicialmente os clientes do Salesforce Commerce Cloud.

Para habilitar o acesso à Einstein Recommendations API, acesse Einstein Configurator e insira o ID de cliente do Commerce Cloud Account Manager na página da API. Usando o acesso de Administrador do site, você pode criar o ID de cliente necessário na página do Account Manager. Para obter mais informações, consulte Adicionar uma ID de cliente.

Quando ativada, e sempre e quando o ID de cliente correto tiver sido transmitido, a API funciona em todos os ambientes, incluindo nas instâncias de Production, Staging, Development e Sandbox.

Cada chamada da API deve transmitir o cabeçalho x-cq-client-id para a autenticação da chave de API.

A implementação de nossa API no lado do cliente ou do servidor traz algumas vantagens e desvantagens. Para garantir a privacidade do seu ID de cliente, recomendamos que você implemente nossa API no lado do servidor para maior segurança. A implementação no lado do cliente corre o risco de expor seu ID de cliente a pessoas mal-intencionadas.

As solicitações para conseguir recomendações, e certas atividades do usuário como viewProduct, viewReco e clickReco, requerem considerações de cache se implementadas no lado do servidor. Por exemplo, no caso de um usuário vendo uma página de produto armazenada em cache, a atividade viewProduct ainda deveria ser enviada. É importante que o Einstein receba todos os eventos, e que as recomendações não sejam armazenadas em cache.

Essa Einstein Recommendations API não foi projetada para casos de uso onde as recomendações são enviadas por e-mail, pois não é compatível com a integração de Einstein Recommendations com e-mails.

Nosso serviço é globalmente distribuído, escalável horizontalmente e pode ser dimensionado de acordo com o tráfego, então os testes de carga são desnecessários. Recomendamos que você evite realizar testes de carga porque isso afeta os resultados das recomendações.

Para ajudar a gerar recomendações de produtos relevantes para cada comprador, a Einstein Recommendations API fornece parâmetros para a identificação do comprador.

Para evitar atividades potencialmente maliciosas, os parâmetros de identificador do usuário não devem ser sequenciais. Eles não devem incluir sequências, padrões, endereços IP, endereços de e-mail, nomes nem nada vinculado a uma determinada pessoa. Todos os parâmetros de identificador do usuário devem atender à General Data Protection Regulation (GDPR, Norma geral de proteção de dados) através de hash ou outros métodos.

  • cookieId (necessário): identificador único de um comprador anônimo. Geralmente, o cookieId é o valor de um cookie próprio.
    • Ao fazer solicitações de API de uma loja (virtual) tradicional do Commerce Cloud, transmita o valor cqcid do cookie para corresponder ao rastreamento automático de atividades na loja (virtual) tradicional. Para obter mais informações, consulte Armazenamento local de dados baseado no navegador.
    • Ao usar as Salesforce Commerce APIs, transmita o valor USID disponível como parte do processo de recuperação do token. Para obter mais informações, consulte a documentação do Shopper Login and API Access Service (SLAS).
    • Ao usar OCAPI, transmita o valor visit_id da resposta de login de convidado para corresponder às atividades automáticas. Para obter mais informações, consulte a Documentação do cliente OCAPI.
  • userId (uso incentivado): identificador único de um comprador conectado. Esse parâmetro permite que o Einstein vincule o mesmo usuário conectado a diferentes dispositivos.
    • Ao fazer solicitações de API de uma loja (virtual) tradicional do Commerce Cloud, transmita o valor cquid do cookie para corresponder ao rastreamento automático de atividades na loja (virtual) tradicional. Para obter mais informações, consulte Armazenamento local de dados baseado no navegador.
    • Ao usar Salesforce Commerce APIs do Salesforce Commerce, transmita o valor hashed_login da resposta de login de registrado para corresponder às atividades automáticas. Para obter mais informações, consulte a documentação do Shopper Login and API Access Service (SLAS).
    • Ao usar OCAPI, transmita o valor hashed_login da resposta de login registrado para corresponder às atividades automáticas. Para obter mais informações, consulte a Documentação do cliente OCAPI.

Os relatórios de desempenho padrão dos Recommenders usados por meio da Einstein API são os mesmos que para outros recommenders usados em seus sites digitais. Você pode ver os relatórios em Reports & Dashboards do Einstein (veja este documento para saber mais sobre Reports & Dashboards do Einstein).

Para simplificar a criação de relatórios separados e a solução de problemas, recomendamos criar diferentes recommenders para a Einstein API. Por exemplo, nomear um recommender como “pdp-mobile-API” indica que o recommender é usado na página de detalhes do produto em um aplicativo móvel.

: as métricas dos relatórios se baseiam em atividades. Se um aplicativo usando a Einstein Recommendations API não enviar atividades, todas as métricas para o recommender da API aparecerá como zero (0).

Rights of ALBERT EINSTEIN are used with permission of The Hebrew University of Jerusalem. Represented exclusively by Greenlight.