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

Einstein Recommendations API ha due funzioni principali: ricevere attività e generare suggerimenti. Per una maggiore flessibilità, i clienti possono scambiare i suggerimenti senza apportare modifiche al codice utilizzando i componenti Zona.

Questa documentazione API è destinata principalmente ai clienti Salesforce Commerce Cloud.

Per abilitare l'accesso ad Einstein Recommendations API, passare ad Einstein Configurator e inserire il proprio ID client Commerce Cloud Account Manager nella pagina dell'API. Utilizzando l'accesso Amministratore del sito, è possibile creare l'ID client necessario nella pagina Account Manager. Per ulteriori informazioni, vedere Add an API Client ID (Aggiunta di un ID di client API).

Se è abilitata, l'API funziona in tutti gli ambienti, comprese le istanze Production, Staging, Development e Sandbox, a condizione che venga passato l'ID client corretto.

Ogni chiamata API deve passare l'intestazione x-cq-client-id per l'autenticazione della chiave API.

L'implementazione dell'API sul lato client o sul lato server comporta qualche compromesso. Per garantire che l'ID client rimanga segreto, si consiglia di implementare l'API sul lato server per maggiore sicurezza. L'implementazione sul lato client può esporre l'ID client ad attori dannosi.

Le richieste per ottenere suggerimenti e determinate attività utente, come viewProduct, viewReco e clickReco, implicano alcune considerazioni sul caching se implementate sul lato server. Ad esempio, nel caso di un utente che visualizza una pagina di prodotto memorizzata nella cache, l'attività viewProduct deve comunque essere inviata. È importante che Einstein riceva tutti gli eventi e che i suggerimenti non vengano memorizzati nella cache.

Questa Einstein Recommendations API non è progettata per il caso di utilizzo dei suggerimenti email. Non supporta l'incorporamento dei suggerimenti di Einstein nelle email.

Il nostro servizio è distribuito a livello globale ed è caratterizzato da scalabilità verticale e orizzontale automatica in base al traffico, per cui i test di carico risultano inutili. Si consiglia di evitare i test di carico perché influiscono negativamente sui risultati dei suggerimenti.

Per generare suggerimenti di prodotto pertinenti per ogni acquirente, Einstein Recommendations API fornisce parametri per l'identificazione dell'acquirente.

Per evitare attività potenzialmente dannose, i parametri degli identificatori utente non devono essere sequenziali. I parametri non devono includere sequenze, modelli, indirizzi IP, indirizzi email, nomi o altri elementi collegati a una persona specifica. Tutti i parametri degli identificatori utente devono essere conformi con il GDPR (General Data Protection Regulation) mediante hashing o altri metodi.

  • cookieId (obbligatorio) - Identificatore univoco di un acquirente anonimo. Di norma, cookieId è il valore di un cookie proprietario.
    • Quando si effettuano richieste API da uno storefront Commerce Cloud tradizionale, passare il valore cookie cqcid per la corrispondenza con il monitoraggio delle attività automatiche nello storefront tradizionale. Per ulteriori informazioni, vedere Archiviazione dati locale basata su browser.
    • Quando si utilizzano Salesforce Commerce API, passare il valore USID disponibile come parte del processo di recupero del token. Per ulteriori informazioni, consultare la documentazione su Shopper Login and API Access Service.
    • Quando si utilizza OCAPI, passare il valore visit_id della risposta di accesso utente ospite per la corrispondenza con le attività automatiche. Per ulteriori informazioni, vedere il documento cliente OCAPI.
  • userId (consigliato) - Identificatore univoco di un acquirente che ha eseguito l'accesso. Questo parametro consente ad Einstein di collegare lo stesso utente che ha eseguito l'accesso su più dispositivi.
    • Quando si effettuano richieste API da uno storefront Commerce Cloud tradizionale, passare il valore cookie cquid per la corrispondenza con il monitoraggio delle attività automatiche nello storefront tradizionale. Per ulteriori informazioni, vedere Archiviazione dati locale basata su browser.
    • Quando si utilizzano Salesforce Commerce API, passare il valore hashed_login della risposta di accesso utente registrato per la corrispondenza con le attività automatiche. Per ulteriori informazioni, consultare la documentazione su Shopper Login and API Access Service.
    • Quando si utilizza OCAPI, passare il valore hashed_login della risposta di accesso utente registrato per la corrispondenza con le attività automatiche. Per ulteriori informazioni, vedere il documento cliente OCAPI.

I report standard sul rendimento per i Recommender utilizzati attraverso Einstein API sono gli stessi che per altri Recommender utilizzati sui siti Digital. È possibile visualizzare i report in Reports & Dashboards di Einstein (per ulteriori informazioni su Reports & Dashboards, consultare questo documento).

Per semplificare la generazione di report separati e la risoluzione dei problemi, si consiglia di creare Recommender distinti per Einstein API. Ad esempio, se a un Recommender viene attribuito il nome "API-mobile-pdp", significa che viene utilizzato sulla pagina dettagli prodotto di un'app mobile.

Le metriche dei report sono basate sulle attività. Se un'applicazione che utilizza Einstein Recommendations API non riesce a inviare attività, tutte le metriche relative al Recommender dell'API hanno valore zero (0).

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