Panoramica sullo sviluppo di estensioni

Uno degli obiettivi principali dei tag in Adobe Experience Platform è la creazione di un ecosistema aperto che consenta anche ai tecnici che non fanno parte di Adobe di pubblicare funzionalità aggiuntive sui loro siti web e sulle loro applicazioni mobili. Questa operazione viene eseguita tramite le estensioni tag. Una volta installata un’estensione su una proprietà tag, la relativa funzionalità diventa disponibile per tutti gli utenti della proprietà.

Questo documento illustra i componenti principali di un’estensione e fornisce i collegamenti a ulteriore documentazione per aiutarti a fornire una guida nel processo di sviluppo.

Struttura delle estensioni

Un’estensione è costituita da una directory di file. In particolare, un’estensione è costituita da un file manifesto, moduli libreria e viste.

File manifesto

Nella directory principale deve esistere un file manifesto (extension.json). Questo file descrive la composizione dell’estensione e la posizione in cui si trovano alcuni file all’interno della directory. Il manifesto funziona in modo simile a un file package.json in un progetto npm.

Moduli libreria

I moduli libreria sono file che descrivono i diversi componenti forniti da un'estensione, ovvero la logica da emettere nella libreria runtime dei tag. Il contenuto di ogni file del modulo libreria deve seguire lo standard del modulo CommonJS.

Ad esempio, se stai creando un tipo di azione denominato "send beacon", devi disporre di un file contenente la logica che invia il beacon. Se si utilizza JavaScript, il file potrebbe essere denominato sendBeacon.js. Il contenuto di questo file verrà emesso nella libreria runtime dei tag.

È possibile inserire i file del modulo libreria in qualsiasi posizione all'interno della directory dell'estensione, purché si descriva la loro posizione in extension.json.

Viste

Una visualizzazione è un file HTML che può essere caricato in un elemento iframe all'interno dell'applicazione dei tag, in particolare tramite l'interfaccia utente di Platform e l'interfaccia utente di Data Collection. Per comunicare con l’applicazione, la vista deve includere uno script fornito dall’estensione e deve essere conforme a una piccola API.

La configurazione è il file di visualizzazione più importante per qualsiasi estensione. Per ulteriori informazioni, consulta la sezione sulle configurazioni delle estensioni.

Non sono previste restrizioni per le modalità di utilizzo delle librerie nelle viste. In altre parole, è possibile utilizzare jQuery, Underscore, React, Angular, Bootstrap o altri. Tuttavia, si consiglia comunque di conferire all’estensione un aspetto simile a quello dell’interfaccia utente.

Si consiglia di inserire tutti i file relativi alla vista (HTML, CSS, JavaScript) in una singola sottodirectory, isolata dai file del modulo libreria. In extension.json è possibile descrivere la posizione di questa sottodirectory di visualizzazione. Platform metterà a disposizione questa sottodirectory (e solo questa sottodirectory) dai propri server web.

Componenti libreria components

Ogni estensione definisce un set di funzionalità. Queste funzionalità vengono implementate includendo una libreria distribuita nel sito Web o nell'app. Le librerie sono una raccolta di singoli componenti, tra cui condizioni, azioni, elementi dati e altro ancora. Ogni componente della libreria è un codice riutilizzabile (fornito da un’estensione) emesso all’interno del runtime dei tag.

A seconda che tu stia sviluppando un’estensione web o un’estensione edge, i tipi di componenti disponibili e i relativi casi d’uso variano. Per una panoramica dei componenti disponibili per ciascun tipo di estensione, fai riferimento alle sottosezioni seguenti.

Componenti per estensioni web web

Nelle estensioni web, le regole vengono attivate attraverso gli eventi, che possono eseguire azioni specifiche se viene soddisfatta una determinata serie di condizioni. Per ulteriori informazioni, consulta la panoramica sul flusso dei moduli nelle estensioni web.

Oltre ai moduli core forniti dall'Adobe, è possibile definire i seguenti componenti libreria nelle estensioni Web:

Componenti per estensioni Edge edge

Nelle estensioni Edge, le regole vengono attivate tramite controlli di condizione che, se vengono superati, eseguono azioni specifiche. Per ulteriori informazioni, consulta la panoramica sul flusso di estensioni Edge.

Nelle estensioni Edge è possibile definire i seguenti componenti libreria:

Configurazione dell'estensione configuration

Per configurazione di un’estensione si intende il modo in cui essa raccoglie le impostazioni globali da un utente. La configurazione è costituita da un componente vista che esporta ed emette le impostazioni all’interno della libreria runtime dei tag come oggetto semplice.

Ad esempio, considera un’estensione che consente all’utente di inviare un beacon utilizzando un’azione "Invia beacon" e che il beacon debba sempre contenere un ID account. Invece di richiedere agli utenti un ID account ogni volta che configurano un’azione "Invia beacon", l’estensione deve richiedere l’ID account una volta dalla vista di configurazione dell’estensione. Ogni volta che un beacon viene inviato, l'azione "Invia beacon" può richiamare l'ID account dalla configurazione dell'estensione e aggiungerlo al beacon.

Quando un utente installa un’estensione su una proprietà nell’interfaccia utente di, viene visualizzata la vista per la configurazione dell’estensione, che deve essere completata per completare l’installazione.

Per ulteriori informazioni, consulta la guida sulle configurazioni delle estensioni.

Invio di estensioni

Una volta completata la creazione dell’estensione, puoi inviarla per essere elencata nel catalogo delle estensioni in Platform. Per ulteriori informazioni, consulta la panoramica del processo di invio dell'estensione.