Helper gs-helpers

Standardwert für Fallback default-value

Der Helper Default Fallback Value wird verwendet, um einen standardmäßigen Fallback-Wert zurückzugeben, wenn ein Attribut leer oder null ist. Dieser Mechanismus funktioniert für Profilattribute und Journey-Ereignisse.

Syntax

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

In diesem Beispiel wird der Wert there angezeigt, wenn das Attribut firstName dieses Profils leer oder null ist.

Bedingungen if-function

Der Helper if wird zum Definieren eines bedingten Blocks verwendet.
Wenn die Auswertung des Ausdrucks „true“ zurückgibt, wird der Block dargestellt, andernfalls wird er übersprungen.

Syntax

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

Nach dem Helper if können Sie eine else-Anweisung einfügen, um einen Code-Block auszuführen, wenn die Auswertung „false“ zurückgibt.
Die elseif-Anweisung gibt eine weitere Bedingung an, die geprüft wird, wenn die erste Anweisung „false“ zurückgibt.

Format

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

Beispiele

Außer unless

Der Helper unless wird zum Definieren eines bedingten Blocks verwendet. Im Gegensatz zur Hilfsfunktion if wird der Block gerendert, wenn die Auswertung des Ausdrucks „falsch“ zurückgibt.

Syntax

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

Beispiel

Darstellung von Inhalt je nach E-Mail-Adressenerweiterung:

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

Jeweils each

Der Helper each wird verwendet, um die Elemente eines Arrays zu verarbeiten.
Die Syntax des Helpers lautet {{#each ArrayName}} IhrInhalt {{/each}}.
Die einzelnen Array-Elemente werden durch die Verwendung des Keywords this innerhalb des Blocks referenziert. Der Index des Array-Elements kann mithilfe von {{@index}} gerendert werden.

Syntax

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

Beispiel

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

Beispiel

So wird eine Liste von Produkten dargestellt, die dieser Benutzer in den Warenkorb gelegt hat:

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

Mit with

Der Helper with wird verwendet, um das Auswertungs-Token des Vorlagenteils zu ändern.

Syntax

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

Der Helper with ist auch nützlich, um die Kurzform einer Variable zu definieren.

Beispiel

Verwenden Sie „with“ zur Definition eines kurzen Aliasnamens für einen langen Variablennamen:

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

Zulassen let

Die let-Funktion ermöglicht das Speichern eines Ausdrucks als Variable, die später in einer Abfrage verwendet werden kann.

Syntax

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

Beispiel

Im folgenden Beispiel können Sie die Gesamtsumme der Preise für Produkte im Warenkorb mit Preisen zwischen 100 und 1000 berechnen.

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

abort abort

Der abort-Helper stoppt den Nachrichtenversand, wenn er während des Renderings erreicht wird.

Verwenden Sie einen bedingten Block wie {%#if%}, um zu steuern, wann der Helper ausgeführt wird. Bei Ausführung von abort wird der Versand abgebrochen.

Syntax

{{abort code='code' description='description'}}

Parameter

Beispiel

{%#if profile.person.email = ""%}
  {{abort code='ERR_001' description='Missing email'}}
{%/if%}
Hello {{profile.person.name.firstName}}!

In diesem Beispiel wird das Rendering fortgesetzt, wenn email vorhanden ist. Wenn die Bedingung erfüllt ist, wird der Versand mit der angegebenen code und description abgebrochen.

JSON analysieren parse-json

Der parseJson analysiert eine JSON-Zeichenfolge und speichert das analysierte Objekt in einer Vorlagenvariablen, damit Sie direkt auf Felder in Personalisierungsausdrücken zugreifen können.

Syntax

{{parseJson jsonStr=jsonStringPath result="variableName"}}

Parameter

Beispiel

{{parseJson jsonStr=targetResponse.options.content result="offerContent"}}
{{offerContent.title}}

Wert unter dem Pfad value-at-path

Der valueAtPath-Helper weist einer Vorlagenvariablen einen Wert aus einem Datenpfad zu. Sie können optional einen Index verwenden, um ein bestimmtes Element aus Arrays oder Sammlungen zu extrahieren.

Syntax

{{valueAtPath path idx=indexPath result="value"}}

Parameter

Beispiel

{{valueAtPath targetResponse.prefetch.mboxes idx=0 result="firstMbox"}}
{{firstMbox.name}}

URL url

Der url-Helper wird verwendet, um Links nachzuverfolgen, URLs zu kürzen und Deeplinks in den Inhalt Ihrer SMS-Nachricht einzufügen.

Syntax

{{url originalUrl='<your_url>' type='<DEEPLINK>' action='CLICK'}}

Parameter

Beispiel

  {{url originalUrl='https://www.mybusiness.com/offers/summer-sale' type='DEEPLINK' action='CLICK'}}

Datensatzsuche dataset-lookup

Der datasetLookup-Helper ruft während der Personalisierung Daten aus Adobe Experience Platform-Eintragsdatensätzen ab, damit Sie Feldwerte verwenden können, die nicht im Profil oder in der Ereignis-Payload gespeichert sind.

Syntax

{{datasetLookup datasetId="datasetId" id="key" result="store" required=false}}

Referenzieren Sie die abgerufenen Felder mit {{result.fieldId}}, wobei result der Wert ist, den Sie an den result-Parameter übergeben.

Informationen zur Aktivierung von Datensätzen, Parameterdetails, Beispiele und Tests finden Sie unter Verwenden von Adobe Experience Platform-Daten für die Personalisierung.

Ausführungsmetadaten execution-metadata

Die Hilfsfunktion executionMetadata ermöglicht die dynamische Erfassung und Speicherung benutzerdefinierter Schlüssel-Wert-Paare im Ausführungskontext der Nachricht.

Syntax

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

In dieser Syntax bezieht sich key auf den Metadatennamen und value sind die beizubehaltenden Metadaten.

Anwendungsfall

Mit dieser Funktion können Sie kontextuelle Informationen an beliebige native Aktionen Ihrer Kampagnen oder Journeys anhängen. Dadurch können Sie kontextuelle Versanddaten in Echtzeit für verschiedene Zwecke wie Tracking, Analyse, Personalisierung und nachgelagerte Verarbeitung in externe Systeme exportieren.

Sie können beispielsweise die Hilfsfunktion „Ausführungsmetadaten“ verwenden, um eine bestimmte ID an jeden Versand anzuhängen, der an jedes Profil gesendet wird. Diese Informationen werden zur Laufzeit generiert und die angereicherten Ausführungsmetadaten können dann zur nachgelagerten Abstimmung mit einer externen Reporting-Plattform exportiert werden.

Funktionsweise

Wählen Sie in einer Kampagne oder Journey ein beliebiges Element aus Ihrem Kanalinhalt aus und fügen Sie mithilfe des Personalisierungseditors diesem Element die Hilfsfunktion executionMetadata hinzu.

Zur Laufzeit wird der Metadatenwert dem vorhandenen Nachrichten-Feedback-Ereignisdatensatz hinzugefügt, wobei das folgende Schema hinzugefügt wird:

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

Einschränkungen

Beispiel

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

In diesem Beispiel ist unter der Annahme profile.person.name.firstName = „Alex“ die resultierende Entität:

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

Verschlüsseln url-parameter-encryption-helper

Mit der Funktion Encrypt können Sie jeden Ausdruckswert zum Zeitpunkt des Renderns verschlüsseln – normalerweise ein Profilattribut, ein Token oder eine in eine Zeichenfolge umgewandelte JSON-Struktur, die Sie im Ausdruck erstellen –, bevor er in einen Abfrageparameter auf Tracking-Links oder Landingpages geschrieben wird.

Werte, die in der URL als einfacher Text angezeigt würden (einschließlich PII oder anderen vertraulichen Daten), sind nicht lesbar, wenn der Link geprüft oder weitergeleitet wird. Nur die mit diesem Helper umschlossenen Werte werden verschlüsselt. Der Rest der URL bleibt unverändert.

Anwendungsfall

Mit diesem Helper können Sie vertrauliche Profildaten (PII) schützen, bevor Sie sie in die gerenderte Ausgabe aufnehmen.

Voraussetzung

Admins müssen mindestens einen aktiven Schlüssel in der Schlüsselregistrierung auf Sandbox-Ebene erstellen. Weitere Informationen zum Erstellen und Verwalten von Listen

Syntax

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

Verwendung

Dieser Helper verschlüsselt vertrauliche Daten und speichert das Ergebnis in einer Vorlagenvariablen.

Sie können den Helper je nach URL-Design und Längenbeschränkungen auf einen, mehrere oder alle Parameter in einem Link anwenden.

Beispiele

Schutzmechanismen