Assistants gs-helpers

Valeur de secours par défaut default-value

L’helper Default Fallback Value est utilisé pour renvoyer une valeur de secours par défaut si un attribut est vide ou nul. Ce mécanisme fonctionne pour les attributs de profil et les événements de parcours.

Syntaxe

Hello {%=profile.personalEmail.name.firstName ?: "there" %}!

Dans cet exemple, la valeur there s'affiche si l'attribut firstName de ce profil est vide ou nul.

Conditions if-function

L'helper if est utilisé pour définir un bloc conditionnel.
Si l'évaluation de l'expression renvoie true, le bloc est rendu, sinon il est ignoré.

Syntaxe

{%#if contains(profile.personalEmail.address, ".edu")%}
<a href="https://www.adobe.com/academia">Check out this link</a>

À la suite de l'helper if, vous pouvez saisir une instruction else pour spécifier un bloc de code à exécuter, si la même condition est false.
L'instruction elseif spécifie une nouvelle condition à tester si la première instruction renvoie false.

Format

{
    {
        {%#if condition1%} element_1
        {%else if condition2%} element_2
        {%else%} default_element
        {%/if%}
    }
}

Exemples

Unless unless

L'helper unless est utilisé pour définir un bloc conditionnel. Par opposition à l’assistant if, si l’évaluation de l’expression renvoie false, le bloc est rendu.

Syntaxe

{%#unless unlessCondition%} element_1 {%else%} default_element {%/unless%}

Exemple

Générer du contenu en fonction de l'extension d'adresse e-mail :

{%#unless endsWith(profile.personalEmail.address, ".edu")%}
Some Normal Content
{%else%}
Some edu specific content
{%/unless%}

Each each

L'helper each est utilisé pour effectuer une itération sur un tableau.
La syntaxe de l’assistant est {{#each ArrayName}} YourContent {{/each}}
Il est possible de se référer aux éléments individuels du tableau en utilisant le mot-clé this à l’intérieur du bloc. L’index de l’élément du tableau peut être rendu à l’aide de {{@index}}.

Syntaxe

{{#each profile.productsInCart}}
    <li>{{this.name}}</li>
{{/each}}

Exemple

{{#each profile.homeAddress.city}}
  {{@index}} : {{this}}<br>
{{/each}}

Exemple

Générer une liste de produits que cet utilisateur a dans son panier :

{{#each profile.products as |product|}}
    <li>{{product.productName}} {{product.productRating}}</li>
{{/each}}

Avec with

L'helper with permet de modifier le jeton d'évaluation d'une partie de modèle.

Syntaxe

{{#with profile.person.name}}
{{this.firstName}} {{this.lastName}}
{{/with}}

L'helper with est utile pour définir également une variable de raccourci.

Exemple

Utiliser l'option avec pour attribuer un alias aux noms de variables longs par rapport aux noms plus courts :

{{#with profile.person.name as |name|}}
 Hi {{name.firstName}} {{name.lastName}}!
 Checkout our trending products for today!
{{/with}}

Let let

La fonction let permet à une expression d'être stockée en tant que variable et d'être utilisé ultérieurement dans une requête.

Syntaxe

{% let variable = expression %} {{variable}}

Exemple

L'exemple suivant permet de calculer la somme totale des prix des produits du panier dont les prix sont compris entre 100 et 1 000.

{% let sum = 0%}
    {{#each profile.productsInCart as |p|}}
        {%#if p.price>100 and p.price<1000%}
            {%let sum = sum + p.price %}
        {%/if%}
    {{/each}}
{{sum}}

Métadonnées d’exécution execution-metadata

L’assistant executionMetadata permet de capturer et de stocker dynamiquement des paires clé-valeur personnalisées dans le contexte d’exécution du message.

Syntaxe

{{executionMetadata key="your_key" value="your_value"}}

Dans cette syntaxe, key fait référence au nom des métadonnées et value correspond aux métadonnées à conserver.

Cas d’utilisation

Cette fonction vous permet d’ajouter des informations contextuelles à toute action native de vos campagnes ou parcours. Vous pouvez ainsi exporter des données contextuelles de diffusion en temps réel vers des systèmes externes à diverses fins telles que le suivi, l’analyse, la personnalisation et le traitement en aval.

Par exemple, vous pouvez utiliser l’assistant Métadonnées d’exécution pour ajouter un ID spécifique à chaque diffusion envoyée à chaque profil. Ces informations sont générées lors de l’exécution, puis vous pouvez importer les métadonnées d’exécution enrichies pour la réconciliation en aval à l’aide d’une plateforme de création de rapports externe.

Fonctionnement

Sélectionnez n’importe quel élément du contenu de votre canal dans une campagne ou un parcours et, à l’aide de l’éditeur de personnalisation, ajoutez l’assistant executionMetadata à cet élément.

Lors de l’exécution, la valeur des métadonnées est ajoutée au jeu de données d’événement de retour de message existant avec le schéma suivant :

"_experience": {
  "customerJourneyManagement": {
    "messageExecution": {
      "metadata": {
        "your_key": "your_value"
      }
    }
  }
}

Limitations

La limite supérieure est de 2 Ko sur les paires clé-valeur par action. Si vous dépassez la limite de 2 Ko, le message est toujours diffusé, mais toutes les paires clé-valeur peuvent être tronquées.

Les métadonnées ne sont pas capturées pour les profils exclus de l’action. Lorsqu’un profil est exclu de la réception d’un message, aucune entrée de métadonnées n’est créée pour ce profil dans le jeu de données.

Exemple

{{executionMetadata key="firstName" value=profile.person.name.firstName}}

Dans cet exemple, en supposant que profile.person.name.firstName = « Alex », l’entité obtenue est :

{
  "key": "firstName",
  "value": "Alex"
}

Chiffrer url-parameter-encryption-helper

La fonction Encrypt vous permet de chiffrer n’importe quelle valeur d’expression au moment du rendu (généralement un attribut de profil, un jeton ou même une structure JSON rigidifiée que vous créez dans l’expression) avant qu’elle ne soit écrite dans un paramètre de requête sur les liens de suivi ou les pages de destination.

Les valeurs qui apparaissent en tant que texte brut dans l’URL (y compris les PII ou d’autres données sensibles) ne sont pas lisibles lorsque le lien est inspecté ou transféré. Seules les valeurs que vous encapsulez avec cet helper sont chiffrées ; le reste de l’URL reste inchangé.

Cas d’utilisation

Cet helper vous permet de protéger les données de profil sensibles (PII) avant de les inclure dans la sortie rendue.

Condition requise

Un administrateur doit créer au moins une clé active dans le registre des clés au niveau du sandbox. Découvrez comment créer et gérer des clés

Syntaxe

{{encrypt dataPath keyName="keyName" version="version" result="variableName"}}

Utilisation

Cet helper chiffre les données sensibles et stocke le résultat dans une variable de modèle.

Vous pouvez appliquer l’assistant à un, plusieurs ou tous les paramètres d’un lien, selon la conception de l’URL et les contraintes de longueur.

Exemples

Mécanismes de sécurisation