Extensie manifest

In de basismap van uw extensie moet u een bestand maken met de naam extension.json. Dit bevat belangrijke informatie over uw extensie waarmee Adobe Experience Platform deze correct kan gebruiken. Een deel van de inhoud wordt gevormd na de wijze van npm's package.json.

Een voorbeeld extension.json kan de Hello World-extensie GitHub-opslagplaats.

Een extensiemanifest moet uit het volgende bestaan:

Aanhangsel

Naamgevingsregels naming-rules

De waarde van name veld binnen extension.json moeten voldoen aan de volgende voorschriften:

Deze zijn in overeenstemming met npm-pakketnaam regels.

Eigenschappen van Configuration-objecten config-object

Het configuratieobject moet als volgt zijn gestructureerd:

{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "eigenschappen": { "delay": { "type": "number", "minimum": 1} }, "required": [ "delay" ], "additionalProperties": false }

Typedefinities type-definitions

Een typedefinitie is een voorwerp dat wordt gebruikt om een gebeurtenis, een voorwaarde, een actie, of type van gegevenselement te beschrijven. Het object bestaat uit het volgende:

{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "eigenschappen": { "delay": { "type": "number", "minimum": 1} }, "required": [ "delay" ], "additionalProperties": false }

Transformaties transforms

Voor bepaalde specifieke gebruiksgevallen moeten de instellingsobjecten die zijn opgeslagen vanuit een weergave, door het Platform worden getransformeerd voordat ze worden uitgestraald in de runtimebibliotheek van de tag. U kunt verzoeken dat een of meer van deze transformaties plaatsvinden door het instellen van de transforms eigenschap bij het definiëren van een typedefinitie binnen uw extension.json. De transforms eigenschap is een array van objecten waarin elk object een transformatie vertegenwoordigt die moet plaatsvinden.

Voor alle transformaties is een type en propertyPath. De type moet een van function, remove, en file en beschrijft welk Platform van de transformatie op het montagesobject zou moeten van toepassing zijn. De propertyPath is een door een punt gescheiden tekenreeks die tags opgeeft waar de eigenschap moet worden gevonden die binnen het instellingsobject moet worden gewijzigd. Hier volgt een voorbeeld van een instellingenobject en enkele propertyPaths:

{
  foo: {
    bar: "A string",
    baz: [
      "A",
      "B",
      "C"
    ]
  }
}

Eigenschapspaden kunnen elke combinatie van array- en objectnotatie gebruiken om transformaties toe te passen op elk niveau van het instellingsobject.

In de onderstaande secties worden de beschikbare transformaties beschreven en hoe u deze kunt gebruiken.

Functietransformatie

Met de functietransformatie kan code die door gebruikers van het Platform is geschreven, worden uitgevoerd door een bibliotheekmodule in de uitgestoten runtimebibliotheek.

Laten we aannemen dat we een handelingstype 'aangepast script' willen opgeven. De actieweergave "aangepast script" kan een tekstgebied bevatten waarin de gebruiker code kan invoeren. Laten we aannemen dat een gebruiker de volgende code in het tekstgebied heeft ingevoerd:

console.log('Welcome, ' + username +'. This is ZomboCom.');

Wanneer de gebruiker de regel opslaat, ziet het instellingsobject dat in de weergave is opgeslagen er mogelijk als volgt uit:

{
  foo: {
    bar: "console.log('Welcome, ' + username +'. This is ZomboCom.');"
  }
}

Wanneer een regel die onze actie gebruikt, in de runtimebibliotheek van de tag wordt geactiveerd, willen we de code van de gebruiker uitvoeren en deze een gebruikersnaam doorgeven.

Op het punt dat het instellingsobject wordt opgeslagen vanuit de weergave van het handelingstype, is de code van de gebruiker gewoon een tekenreeks. Dit is goed omdat het behoorlijk aan en van JSON kan worden geserialiseerd; het is echter ook ongeldig omdat het normaal gesproken ook als tekenreeks in de tagruntime-bibliotheek wordt weergegeven in plaats van als een uitvoerbare functie. Hoewel u kon proberen om de code binnen de de bibliotheekmodule van uw actietype uit te voeren gebruikend eval of Constructor Function, is het sterk ontmoedigd vanwege beleid voor inhoudsbeveiliging mogelijk blokkerende uitvoering.

Als tussenoplossing voor deze situatie, vertelt het gebruiken van de functietransformatie Platform om de code van de gebruiker in een uitvoerbare functie te verpakken wanneer het in de markering runtime bibliotheek wordt uitgegeven. Om ons voorbeeldprobleem op te lossen, zouden wij de transformatie op de typedefinitie in extension.json als volgt:

{
  "transforms": [
    {
      "type": "function",
      "propertyPath": "foo.bar",
      "parameters": ["username"]
    }
  ]
}

Wanneer het instellingsobject wordt uitgestraald in de tagruntime-bibliotheek, wordt het als volgt getransformeerd:

{
  foo: {
    bar: function(username) {
      console.log('Welcome, ' + username +'. This is ZomboCom.');
    }
  }
}

Uw bibliotheekmodule kan dan de functie aanroepen die de code van de gebruiker bevat en de username argument.

Bestandstransformatie

Met de bestandstransformatie kan code die door gebruikers van het Platform is geschreven, worden verzonden naar een bestand dat losstaat van de runtimebibliotheek van de tag. Het bestand wordt samen met de tagruntime-bibliotheek gehost en kan vervolgens tijdens runtime naar wens door de extensie worden geladen.

Laten we aannemen dat we een handelingstype 'aangepast script' willen opgeven. De weergave van het handelingstype kan een tekstgebied bevatten waarin de gebruiker code kan invoeren. Laten we aannemen dat een gebruiker de volgende code in het tekstgebied heeft ingevoerd:

console.log('This is ZomboCom.');

Wanneer de gebruiker de regel opslaat, ziet het instellingsobject dat in de weergave is opgeslagen er mogelijk als volgt uit:

{
  foo: {
    bar: "console.log('This is ZomboCom.');"
  }
}

We willen dat de code van de gebruiker in een afzonderlijk bestand wordt geplaatst in plaats van in de runtimebibliotheek van de tag. Wanneer een regel die onze actie gebruikt, binnen de tagruntime bibliotheek wordt geactiveerd, willen wij de code van de gebruiker laden door een scriptelement aan de documenttekst toe te voegen. Om ons voorbeeldprobleem op te lossen, zouden wij de transformatie op de definitie van actietype in extension.json als volgt:

{
  "transforms": [
    {
      "type": "file",
      "propertyPath": "foo.bar"
    }
  ]
}

Wanneer het instellingsobject wordt uitgestraald in de tagruntime-bibliotheek, wordt het als volgt getransformeerd:

{
  foo: {
    bar: "//launch.cdn.com/path/abc.js"
  }
}

In dat geval moet de waarde van foo.bar is getransformeerd naar een URL. De exacte URL wordt bepaald op het moment dat de bibliotheek wordt gemaakt. Het bestand krijgt altijd een .js en geleverd met een JavaScript-georiënteerd MIME-type. In de toekomst kunnen we ondersteuning toevoegen voor andere MIME-typen.

Transformatie verwijderen

Standaard worden alle eigenschappen van het instellingsobject weergegeven in de runtimebibliotheek van de tag. Als bepaalde eigenschappen alleen worden gebruikt voor de extensieweergave, vooral als deze vertrouwelijke informatie bevatten (bijvoorbeeld geheime token), moet u de transformatie voor verwijderen gebruiken om te voorkomen dat de informatie wordt uitgestoten in de runtimebibliotheek van de tag.

Laten we aannemen dat we een nieuw actietype willen aanbieden. De weergave van het actietype kan een invoer bevatten waarin de gebruiker een geheime sleutel kan invoeren die verbinding met een specifieke API mogelijk maakt. Laten we aannemen dat een gebruiker de volgende tekst in de invoer heeft ingevoerd:

ABCDEFG

Wanneer de gebruiker de regel opslaat, ziet het instellingsobject dat in de weergave is opgeslagen er mogelijk als volgt uit:

{
  foo: {
    bar: "ABCDEFG"
  }
}

We willen de eigendom niet opnemen bar in de runtimebibliotheek van de tag. Om ons voorbeeldprobleem op te lossen, zouden wij de transformatie op de definitie van actietype in extension.json als volgt:

{
  "transforms": [
    {
      "type": "remove",
      "propertyPath": "foo.bar"
    }
  ]
}

Wanneer het instellingsobject wordt uitgestraald in de tagruntime-bibliotheek, wordt het als volgt getransformeerd:

{
  foo: {
  }
}

In dat geval moet de waarde van foo.bar is verwijderd uit het instellingenobject.