Overzicht van de ontwikkeling van extensies

Een van de belangrijkste doelstellingen van tags in Adobe Experience Platform is het creëren van een open ecosysteem waar ingenieurs buiten de Adobe extra functies op hun websites en mobiele toepassingen kunnen blootstellen. Dit wordt gedaan door markeringsuitbreidingen. Nadat een extensie op een eigenschap tag is geïnstalleerd, wordt de functionaliteit van die extensie beschikbaar voor gebruik door alle gebruikers van de eigenschap.

In dit document worden de primaire componenten van een extensie beschreven en vindt u koppelingen naar verdere documentatie die u helpen bij het ontwikkelen van extensies.

Extensiestructuur

Een extensie bestaat uit een map met bestanden. Specifiek, bestaat een uitbreiding uit een manifestdossier, bibliotheekmodules, en meningen.

Manifest-bestand

Een manifestdossier (extension.json) moet bij de wortel van de folder bestaan. In dit bestand wordt de samenstelling van de extensie beschreven en wordt aangegeven waar bepaalde bestanden zich in de map bevinden. De duidelijke functies zo ook aan a package.jsondossier in een npmproject.

Bibliotheekmodules

De modules van de bibliotheek zijn de dossiers die de verschillende componentenbeschrijven die een uitbreiding (met andere woorden, de logica die binnen de bibliotheek van de markeringsruntime moet worden uitgegeven) verstrekt. De inhoud van elk dossier van de bibliotheekmodule moet de CommonJS modulenormvolgen.

Bijvoorbeeld, als u een actietype genoemd "verzend baken"bouwt, moet u een dossier hebben dat de logica bevat die het baken verzendt. Als u JavaScript gebruikt, kan het bestand sendBeacon.js worden genoemd. De inhoud van dit bestand wordt weergegeven in de runtimebibliotheek van de tag.

U kunt bibliotheekmodulebestanden op elke gewenste locatie in de extensiemap plaatsen, op voorwaarde dat u de locatie van de bestanden in extension.json beschrijft.

Weergaven

Een mening is een dossier van HTML geschikt om in iframe elementbinnen de markeringstoepassing, specifiek door Platform UI en de Inzameling UI van Gegevens worden geladen. De weergave moet een script bevatten dat door de extensie wordt aangeboden en moet een kleine API bevatten om te kunnen communiceren met de toepassing.

Het belangrijkste meningsdossier voor om het even welke uitbreiding is zijn configuratie. Zie de sectie over uitbreidingsconfiguratiesvoor meer informatie.

Er gelden geen beperkingen ten aanzien van de bibliotheken die in uw weergaven worden gebruikt. Met andere woorden, u kunt jQuery, Onderstreping, Reageren, Angular, Bootstrap of andere gebruiken. Het wordt echter nog steeds aangeraden om uw extensie er net zo uit te laten zien als de interface.

U wordt aangeraden alle weergavegerelateerde bestanden (HTML, CSS, JavaScript) in één submap te plaatsen die is gescheiden van de bibliotheekmodulebestanden. In extension.json kunt u beschrijven waar deze submap voor de weergave zich bevindt. Het platform zal dan deze subdirectory (en slechts deze subdirectory) van zijn Webservers dienen.

Bibliotheekcomponenten components

Elke extensie definieert een reeks functies. Deze functies worden uitgevoerd door in a bibliotheekworden omvat die aan uw website of app wordt opgesteld. Bibliotheken zijn een verzameling afzonderlijke componenten, waaronder voorwaarden, handelingen, gegevenselementen en meer. Elke bibliotheekcomponent is een stuk herbruikbare code (verstrekt door een uitbreiding) die binnen markeringstruntime wordt uitgegeven.

Afhankelijk van het feit of u een webextensie of een randextensie ontwikkelt, verschillen de beschikbare typen componenten en de gebruikte toepassingen. Raadpleeg de onderstaande subsecties voor een overzicht van de componenten die beschikbaar zijn voor elk extensietype.

Componenten voor webextensies web

In webextensies worden regels geactiveerd via gebeurtenissen, die vervolgens specifieke acties kunnen uitvoeren als aan een bepaalde set voorwaarden wordt voldaan. Zie het overzicht op modulestroom in Webuitbreidingenvoor meer informatie.

Naast de kernmodulesdie door Adobe worden verstrekt, kunt u de volgende bibliotheekcomponenten in uw Webuitbreidingen bepalen:

Componenten voor randextensies edge

In randuitbreidingen worden de regels geactiveerd door voorwaardencontroles, die vervolgens specifieke acties uitvoeren als die controles slagen. Zie het overzicht op de stroom van de randuitbreidingvoor meer informatie.

U kunt de volgende bibliotheekcomponenten in uw randuitbreidingen bepalen:

Extensieconfiguratie configuration

De configuratie van een extensie verwijst naar de manier waarop algemene instellingen van een gebruiker worden verzameld. De configuratie bestaat uit een weergavecomponent die instellingen in de runtimebibliotheek van de tag als een onbewerkt object exporteert en uitgeeft.

Neem bijvoorbeeld een extensie die de gebruiker toestaat een baken te verzenden met de actie "Send Beacon" en die het baken altijd een account-id moet bevatten. In plaats van gebruikers elke keer om een account-id te vragen wanneer zij een actie "Send Beacon" configureren, moet de extensie eenmaal om de account-id vragen vanuit de configuratieweergave van de extensie. Telkens wanneer een baken moet worden verzonden, kan de actie "Send Beacon"rekeningsidentiteitskaart van de uitbreidingsconfiguratie trekken en het toevoegen aan het baken.

Wanneer gebruikers een uitbreiding aan een bezit in UI installeren, worden zij getoond de mening van de uitbreidingsconfiguratie, die zij moeten voltooien om de installatie te voltooien.

Meer leren, zie de gids op uitbreidingsconfiguraties.

Extensies verzenden

Nadat u de extensie hebt gemaakt, kunt u deze verzenden voor een lijst in de extensiecatalogus in Platform. Zie het overzicht van het proces van de uitbreidingsvoorleggingvoor meer informatie.