Skip to content

Schlüssel-Wert-Paare

Diese Seite beschreibt, wie Sie Schlüssel-Wert-Paare verwenden können, um zusätzliche Daten-Payloads an Nutzergeräte zu senden. Dieses Feature ist über Push-, In-App-, E-Mail- und Content-Card-Messaging-Kanäle verfügbar.

Verwenden Sie Schlüssel-Wert-Paare, um strukturierte Metadaten zu Nachrichten hinzuzufügen. Diese zusätzlichen Daten-Payloads können Nachrichten mit weiteren kontextuellen Informationen anreichern, die beeinflussen können, wie eine Nachricht dargestellt oder verarbeitet wird.

Da Schlüssel-Wert-Paare Metadaten sind, sind diese Daten nicht unbedingt für die Empfänger:innen sichtbar, können aber von Ihren verbundenen Systemen oder Prozessen verwendet werden, um die Nachrichtenverarbeitung anzupassen.

Jedes Paar besteht aus:

  • Schlüssel: Der Bezeichner (Beispiel: utm_source)
  • Wert: Die zugehörigen Daten (Beispiel: newsletter)

Anwendungsfälle

Hier sind einige Beispiel-Anwendungsfälle für das Hinzufügen von Metadaten mit Schlüssel-Wert-Paaren:

  1. Tracking-Parameter: UTM-Parameter zu Analysezwecken anhängen
    • Schlüssel: utm_campaign
    • Wert: spring_sale
  2. Benutzerdefinierte Tags: Tags für internes Routing oder Kategorisierung hinzufügen
    • Schlüssel: priority
    • Wert: high
  3. Verhaltens-Trigger: Metadaten, die zum Auslösen oder Anpassen von In-App-Verhalten verwendet werden
    • Schlüssel: deep_link
    • Wert: app://promo-page

Push-Benachrichtigungen

Schlüssel-Wert-Paare können zu Android-, iOS- und Web-Push-Benachrichtigungen hinzugefügt werden. Sie können Schlüssel-Wert-Paare verwenden, um interne Metriken und App-Inhalte zu aktualisieren oder Eigenschaften von Push-Benachrichtigungen anzupassen, wie z. B. Alert-Priorisierung, Lokalisierung und Töne.

Wählen Sie im Nachrichten-Editor den Tab Einstellungen, wählen Sie Neues Paar hinzufügen und geben Sie Ihre Schlüssel-Wert-Paare an.

Wenn Sie Schlüssel-Wert-Paare im Nachrichten-Editor hinzufügen, werden die Werte als Strings gesendet. Bei iOS-Push werden reservierte Apple Push Notification Service (APNs) Alert-Keys, die Sie über Alert-Optionen hinzufügen (wie z. B. loc-args für Lokalisierungsargumente), mit den korrekten JSON-Typen im Payload formatiert. Bei angepassten Keys empfängt Ihre App String-Werte, sofern Sie diese nicht in Ihrer Integration parsen.

iOS

Der Apple Push Notification Service (APNs) unterstützt das Festlegen von Alert-Einstellungen und das Senden angepasster Daten mithilfe von Schlüssel-Wert-Paaren. APNs nutzt die Apple-reservierte aps-Bibliothek, die vordefinierte Keys und Werte enthält, die Alert-Eigenschaften steuern.

APS-Bibliothek

Key Werttyp Wertbeschreibung
alert String oder Dictionary-Objekt Bei String-Eingaben wird ein Alert mit dem String als Nachricht angezeigt, mit den Buttons „Schließen“ und „Anzeigen“; bei Nicht-String-Eingaben wird ein Alert oder Banner abhängig von den untergeordneten Eigenschaften der Eingabe angezeigt
badge Zahl Steuert die Zahl, die als Badge auf dem App-Symbol angezeigt wird
sound String Der Name der Sounddatei, die als Alert abgespielt wird; muss sich im App-Bundle oder im Ordner Library/Sounds befinden
content-available Zahl Eingabewerte von 1 signalisieren der App die Verfügbarkeit neuer Informationen beim Start oder bei der Wiederaufnahme einer Sitzung
Bibliothek der Alert-Eigenschaften
Key Werttyp Wertbeschreibung
title String Ein kurzer String, den die Apple Watch kurz als Teil einer Benachrichtigung anzeigt
body String Der Inhalt der Push-Benachrichtigung
title-loc-key String oder null Ein Key, der den Titel-String für die aktuelle Lokalisierung aus der Localizable.strings-Datei festlegt
title-loc-args String-Array oder null String-Werte, die anstelle der Titel-Lokalisierungsformat-Spezifizierer in title-loc-key erscheinen können
action-loc-key String-Array oder null Falls vorhanden, legt der angegebene String die Lokalisierung für die Buttons „Schließen“ und „Anzeigen“ fest
loc-key String oder null Ein Key, der die Benachrichtigungsnachricht für die aktuelle Lokalisierung aus der Localizable.strings-Datei festlegt
loc-args String-Array String-Werte, die anstelle der Lokalisierungsformat-Spezifizierer in loc-key erscheinen können
launch-image Strings Der Name einer Bilddatei im App-Bundle, die als Startbild verwendet werden soll, wenn Nutzer:innen den Aktions-Button antippen oder den Aktions-Slider bewegen

Der Braze Nachrichten-Editor erstellt automatisch die folgenden Keys: alert und seine Eigenschaften, content-available, sound und category.

Diese Werte können im Tab Einstellungen beim Erstellen einer Push-Nachricht eingegeben werden. Wählen Sie Alert-Optionen und wählen Sie einen Alert-Dictionary-Key aus, damit der Key automatisch in einem neuen Schlüssel-Wert-Eintrag vorausgefüllt wird.

Diese Werte können im Tab „Einstellungen“ beim Erstellen einer Push-Nachricht eingegeben werden. Wählen Sie „Alert-Optionen“ und wählen Sie einen Alert-Dictionary-Key aus, damit der Key automatisch in einem neuen Schlüssel-Wert-Eintrag vorausgefüllt wird.

Wenn Braze eine Push-Benachrichtigung an APNs sendet, wird der Payload als JSON formatiert.

Einfacher Payload

1
2
3

{
    "aps" : { "alert" : "Message received from Spencer" },
}

Komplexer Payload

1
2
3
4
5
6
7
8
9
10
11
12

{
    "aps" : {
        "alert" : {
            "body" : "Hi, welcome to our app!",
            "loc-key" : "France",
            "loc-args" : ["Bonjour", "bienvenue"],
            "action-loc-key" : "Button_Type_1",
            "launch-image" : "Paris"
      },
        "content-available" : 1
    },
}
Angepasste Schlüssel-Wert-Paare

Zusätzlich zu den aps-Bibliothek-Payload-Werten können Sie angepasste Schlüssel-Wert-Paare an das Gerät von Nutzer:innen senden. Die Werte in diesen Paaren sind auf primitive Typen beschränkt: Dictionary (Objekt), Array, String, Zahl und Boolean.

Screenshot zu angepassten Schlüssel-Wert-Paaren.

Anwendungsfälle für angepasste Schlüssel-Wert-Paare umfassen unter anderem die Pflege interner Metriken und das Festlegen des Kontexts für die Benutzeroberfläche. Braze ermöglicht es Ihnen, zusätzliche Schlüssel-Wert-Paare zusammen mit einer Push-Benachrichtigung zu senden, die über Ihre Anwendung im Extras-Key genutzt werden können. Wenn Sie einen anderen Key bevorzugen, stellen Sie sicher, dass Ihre App diesen angepassten Key verarbeiten kann.

Apple empfiehlt, keine Kund:inneninformationen oder sensiblen Daten als angepasste Payload-Daten aufzunehmen. Darüber hinaus empfiehlt Apple, dass keine mit einer Alert-Nachricht verbundene Aktion Daten auf einem Gerät löschen sollte.

API-getriggerte Campaigns

Braze ermöglicht es Ihnen, benutzerdefinierte String-Schlüssel-Wert-Paare zu senden, die als extras bekannt sind. Um auf Ihre Extras in API-getriggerten und geplanten API-getriggerten Campaigns zuzugreifen, legen Sie im Dashboard einen Key als „example_key“ und einen Wert als "$json:{"foo": 1, "bar": 1}" fest. Dies ergibt eine Entwicklungskonsolen-Ausgabe von "extras": { "test": { "foo": 1, "bar": 1 }.

Android

Braze ermöglicht es Ihnen, zusätzliche Daten-Payloads in Push-Benachrichtigungen mithilfe von Schlüssel-Wert-Paaren zu senden.

Daten-Payload

Ähnlich wie bei iOS-Push können Sie angepasste Schlüssel-Wert-Paare an das Gerät von Nutzer:innen senden.

Einige Anwendungsfälle für angepasste Schlüssel-Wert-Paare umfassen die Pflege interner Metriken und das Festlegen des Kontexts für die Benutzeroberfläche, können jedoch für jeden beliebigen Zweck verwendet werden.

API-getriggerte Campaigns

Braze ermöglicht es Ihnen, benutzerdefinierte String-Schlüssel-Wert-Paare zu senden, die als extras bekannt sind. Um auf Ihre Extras in API-getriggerten und geplanten API-getriggerten Campaigns zuzugreifen, legen Sie im Dashboard einen Key als „example_key“ und einen Wert als "$json:{"foo": 1, "bar": 1}" fest. Dies ergibt eine Entwicklungskonsolen-Ausgabe von "extras": { "test": { "foo": 1, "bar": 1 }.

FCM-Nachrichtenoptionen

Android-Push-Benachrichtigungen können mit FCM-Nachrichtenoptionen weiter angepasst werden. Dazu gehören Benachrichtigungspriorität, Sound, Verzögerung, Lebensdauer und Zusammenlegbarkeit. Diese Werte können im Tab Einstellungen beim Erstellen einer Push-Nachricht angegeben werden. Weitere Anweisungen zum Festlegen dieser Optionen im Braze Nachrichten-Editor finden Sie unter Erweiterte Push-Benachrichtigungseinstellungen.

Screenshot zu FCM-Nachrichtenoptionen.

Stille Push-Benachrichtigungen

Eine stille Push-Benachrichtigung ist eine Push-Benachrichtigung ohne Alert-Nachricht oder Sound, die dazu dient, die Benutzeroberfläche oder den Inhalt Ihrer App im Hintergrund zu aktualisieren. Diese Benachrichtigungen nutzen Schlüssel-Wert-Paare, um diese Hintergrund-App-Aktionen auszulösen. Stille Push-Benachrichtigungen unterstützen auch unser Uninstall-Tracking.

Marketer sollten testen, ob stille Push-Benachrichtigungen das erwartete Verhalten auslösen, bevor sie diese an die Nutzer:innen ihrer App senden. Nachdem Sie Ihre stille Push-Benachrichtigung für iOS oder Android erstellt haben, stellen Sie sicher, dass Sie nur Testnutzer:innen ansprechen, indem Sie nach externer Nutzer-ID oder E-Mail-Adresse filtern.

Nach dem Campaign-Start sollten Sie prüfen, ob Sie keine sichtbare Push-Benachrichtigung auf Ihrem Testgerät erhalten haben.

In-App-Nachrichten

Fügen Sie Schlüssel-Wert-Paare zu In-App-Nachrichten hinzu, die Sie mit dem traditionellen Editor erstellen.

  1. Erstellen oder bearbeiten Sie in Ihrer Campaign oder Ihrem Canvas eine In-App-Nachricht und wählen Sie den traditionellen Editor aus (nicht Drag-and-Drop).
  2. Wählen Sie im Nachrichten-Editor den Tab Settings aus.
  3. Wählen Sie unter Key value pairs die Option Add new pair aus.
  4. Geben Sie für jedes Paar einen Schlüssel und einen Wert ein. Um ein weiteres Paar hinzuzufügen, wählen Sie erneut Add new pair aus.

API-getriggerte Campaigns

Braze ermöglicht es Ihnen, benutzerdefinierte String-Schlüssel-Wert-Paare zu senden, die als extras bezeichnet werden. Um auf Ihre Extras in API-getriggerten und geplanten API-getriggerten Campaigns zuzugreifen, legen Sie im Dashboard einen Schlüssel als „example_key“ und einen Wert als "$json:{"foo": 1, "bar": 1}" fest. Dies führt zu einer Ausgabe in der Entwicklungskonsole von "extras": { "test": { "foo": 1, "bar": 1 }.

E-Mails

Sowohl SparkPost als auch SendGrid unterstützen Schlüssel-Wert-Paare in E-Mails. Wenn Sie SendGrid verwenden, werden Schlüssel-Wert-Paare als Unique Arguments gesendet. SendGrid erlaubt es Ihnen, eine unbegrenzte Anzahl von Schlüssel-Wert-Paaren mit bis zu 10.000 Bytes an Daten anzuhängen. Diese Schlüssel-Wert-Paare können in Posts vom SendGrid Event Webhook eingesehen werden.

Tab „Sendeinformationen“ des E-Mail-Nachrichten-Editors in Braze.

Content Cards

Um ein Schlüssel-Wert-Paar zu einer Content Card hinzuzufügen, gehen Sie zum Tab Settings im Braze-Nachrichten-Editor und wählen Sie Add New Pair.

Schlüssel-Wert-Paar zu Content Card hinzufügen
New Stuff!