Di seguito troverai le informazioni necessarie per implementare le API Experience e iniziare a lanciare le tue campagne. È fondamentale garantire un'implementazione completa e corretta prima di iniziare a lanciare campagne di produzione. Questa guida presume che tu stia utilizzando il nostro DYID per reinviare l'utente che visita il sito o l'app. Se stai pianificando un'implementazione solo API con ID utente generati da te, ignora questa sezione.
Prima di iniziare:
- se stai pianificando di implementare lo script di Dynamic Yield nel tuo sito Web e non lo hai ancora fatto, esegui prima quell'azione e poi ritorna a consultare questa guida.
-
Assicurati che il tuo feed di prodotto sia attivo e funzionante.
Il feed di un prodotto è un file che contiene il tuo catalogo di prodotti (tutti i tuoi prodotti con i metadati corrispondenti). Permette la personalizzazione in base all'affinità, attraverso appositi consigli sui prodotti, messaggistica a prova di social e molto altro.
Puoi creare e sincronizzare il tuo feed di prodotto dalla console Experience OS o tramite API.
Passaggio 1: generazione delle chiavi API
Crea le chiavi API per la tua applicazione.
Se desideri richiamare l'API direttamente dal lato client, utilizza una chiave API lato client o, in alternativa, fai in modo che il lato server funga da proxy per il client, in modo che esegua tutti i rapporti per conto dei client. Quest'ultima opzione comporta più lavoro, ma è molto diffusa: si presta bene a centralizzare la segnalazione delle azioni degli utenti a più sistemi a valle e a nascondere i dettagli dell'implementazione e le chiavi al client.
Passaggio 2: effettuare una chiamata Choose per ottenere le varianti della campagna
Tutte le tue campagne devono avere un Nome del selettore API che utilizzerai nella chiamata API Choose per ottenere la variazione desiderata.
La risposta includerà i dati necessari sul prodotto per le campagne di raccomandazione o le varianti per le campagne con codice personalizzato. In aggiunta, Dynamic Yield invierà gli attributi DecisionID o SlotID (rispettivamente per il codice personalizzato o le campagne di raccomandazione) che a tua volta dovrai comunicarci nella chiamata API Engagement se l'utente dovesse fare clic su una campagna.
Chiamata Choose in modo asincrono
Dopo il rendering iniziale della pagina, puoi anche richiedere in modo asincrono tutte le campagne che si possono visualizzare dopo il rendering della pagina (in particolare, per gli elementi visivi non immediatamente visibili). In queste chiamate Choose , assicurati di impostare "options": { "isImplicitPageview": false } nel corpo della richiesta.
Passaggio 3: aggiunta degli ID utente e di sessione alle richieste API
Questa operazione viene eseguita usando i cookie di Dynamic Yield cooki. Puoi aggiungere cookie come dyid, _dyid_server, e dyjsession alla tua chiamata API in modo che Dynamic Yield possa riconoscere l'utente.
Dynamic Yield scriverà i cookie una volta caricati gli script. Se devi inviare una richiesta Choose per una pagina in cui gli script non sono in esecuzione, e l'utente non dispone di ID utente e di sessione esistenti dalle pagine precedenti, devi puoi inviarci valori vuoti e noi genereremo nuovi ID utente e di sessione e li restituiremo al sistema.
Tieni presente che, se hai abilitato la modalità Consenso ai cookie attivo, devi includere il parametro active_consent_accepted. Per maggiori informazioni, consulta la sezione dedicata alla Modalità Consenso ai cookie attivo per la gestione della privacy dei dati degli utenti.
Scopri di più sui cookie di Dynamic Yield e su come implementarli.
Passaggio 4: segnalazione di eventi
Puoi segnalare qualsiasi azione significativa intrapresa da un utente sul tuo sito o sulla tua app. Ciò include in genere le operazioni legate al carrello e all'acquisto tramite e-commerce, l'avvio e l'invio di richieste a istituti finanziari, le visualizzazioni di video nel mondo dei media e qualsiasi altro evento personalizzato in base alle tue esigenze. Puoi usare questi approfondimenti più tardi, per il targeting comportamentale, i report e molto altro ancora. Tieni presente che se dovessi segnalare solo eventi dal lato server, sarà più facile evitare il "rumore" generato da bot e simili.
Scopri di più sulla segnalazione di eventi.
Passaggio 5: monitoraggio e segnalazione del coinvolgimento degli utenti rispetto alle varianti
Quando lanci una campagna API sulla pagina, devi memorizzare gli identificatori univoci restituiti nella risposta dalla chiamata Choose. Questa operazione viene in genere eseguita sul lato client. Se un utente dovesse fare clic su una variante o su uno specifico prodotto consigliato, dovrai restituirci questi identificatori.
- Per un clic su una variante con codice personalizzato, l'identificatore corrisponde a parametri come decisionId (o anche variationIds solo in caso di campagne multivariante come gli slider).
- Per un clic su un articolo consigliato, corrisponde a parametri come slotId.
Sul web è comune memorizzare tali parametri come attributi di dati nell'elemento DOM che esegue il rendering della variante, ad esempio, <div id= ... data-dy-decision-id="d512ae8f">.
Puoi impostare un listener al clic per tutte le varianti renderizzate e segnalare eventuali clic a Dynamic Yield utilizzando gli identificatori univoci forniti. Questo passaggio si avvia quasi sempre dal lato client, ma si può attivare tramite proxy dal lato server alla nostra API per evitare di avere troppi passaggi logici (o chiavi) nei client.
Scopri di più sulla segnalazione del coinvolgimento degli utenti
Implementazione solo tramite API
Identificatori utente e di sessione
Con l'implementazione basata solo sulle API, devi decidere quali identificatori utente & di sessione usare. usare. Esistono già identificatori di questo tipo nella tua domanda che si possono riutilizzare? Qual è il loro tempo di vita? Corrisponde alle tue aspettative?
In caso di dubbi, consulta le nostre Best practice Il codice di esempio per la gestione di questi ID è disponibile anche nel tutorial Petshop.
Segnalazione delle visualizzazioni di pagina
In modalità solo API, devi segnalare una nuova visualizzazione di pagina per tutte le pagine del tuo sito Web. Per una latenza minima, di solito questa operazione si esegue insieme al recupero delle varianti della campagna API scelte per quella pagina, in un unico roundtrip al nostro endpoint API Choose
Puoi integrare una chiamata Choose in tutti i tipi di pagine nella tua applicazione con il contesto di pagina appropriato, anche senza fare ancora riferimento a nessuna campagna.
Abilitazione del supporto per l'anteprima
Sebbene non sia tecnicamente richiesto, ti consigliamo vivamente di aggiungere anche il codice per supportare l' anteprima dei contenuti direttamente dalla console di Experience OS.