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 beispielhafte Anwendungsfälle für das Hinzufügen von Metadaten mit Schlüssel-Wert-Paaren:

  1. Tracking-Parameter: UTM-Parameter für Analytics-Zwecke 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 verwendet werden, um In-App-Verhalten zu triggern oder anzupassen
    • 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. Alarmpriorisierung, Lokalisierung und Sounds.

Wählen Sie im Nachrichten-Editor den Tab Settings, wählen Sie Add New Pair 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)-Alarmschlüssel, die Sie über Alert Options hinzufügen (wie z. B. loc-args für Lokalisierungsargumente), mit den korrekten JSON-Typen im Payload formatiert. Bei benutzerdefinierten Schlüsseln empfängt Ihre App String-Werte, es sei denn, Sie parsen diese in Ihrer Integration.

iOS

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

APS-Bibliothek
Schlüssel Werttyp Wertbeschreibung
alert String oder Dictionary-Objekt Bei String-Eingaben wird ein Alarm mit dem String als Nachricht mit den Buttons „Schließen“ und „Anzeigen“ angezeigt; bei Nicht-String-Eingaben wird je nach den untergeordneten Eigenschaften der Eingabe ein Alarm oder Banner angezeigt
badge Zahl Steuert die Zahl, die als Badge auf dem App-Symbol angezeigt wird
sound String Der Name der Sounddatei, die als Alarm 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 Alarmeigenschaften
Schlüssel 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 Schlüssel, der den Titel-String für die aktuelle Lokalisierung aus der Datei Localizable.strings festlegt
title-loc-args String-Array oder null String-Werte, die anstelle der Lokalisierungsformat-Spezifizierer im 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 Schlüssel, der die Benachrichtigungsnachricht für die aktuelle Lokalisierung aus der Datei Localizable.strings festlegt
loc-args String-Array String-Werte, die anstelle der Lokalisierungsformat-Spezifizierer im loc-key erscheinen können
launch-image Strings Der Name einer Bilddatei im App-Bundle, die als Startbild verwendet werden soll, wenn Nutzer:innen auf den Aktions-Button tippen oder den Aktions-Slider bewegen

Der Braze-Nachrichten-Editor übernimmt automatisch die Erstellung der folgenden Schlüssel: alert und seine Eigenschaften, content-available, sound und category.

Diese Werte können im Tab Settings beim Erstellen einer Push-Nachricht eingegeben werden. Wählen Sie Alert Options und wählen Sie einen Alarm-Dictionary-Schlüssel, damit der Schlüssel automatisch in einem neuen Schlüssel-Wert-Eintrag ausgefü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
    },
}
Benutzerdefinierte Schlüssel-Wert-Paare

Zusätzlich zu den aps-Bibliotheks-Payload-Werten können Sie benutzerdefinierte Schlüssel-Wert-Paare an das Gerät einer Nutzerin oder eines Nutzers senden. Die Werte in diesen Paaren sind auf primitive Typen beschränkt: Dictionary (Objekt), Array, String, Zahl und Boolescher Wert.

Anwendungsfälle für benutzerdefinierte Schlüssel-Wert-Paare umfassen unter anderem die interne Metrik-Erfassung 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 den Extras-Schlüssel in Ihrer Anwendung verwendet werden können. Wenn Sie einen anderen Schlüssel bevorzugen, stellen Sie sicher, dass Ihre App diesen benutzerdefinierten Schlüssel verarbeiten kann.

Apple empfiehlt Clients, keine Kundeninformationen oder sensiblen Daten als benutzerdefinierte Payload-Daten einzuschließen. Darüber hinaus empfiehlt Apple, dass keine mit einer Alarmnachricht verbundene Aktion Daten auf einem Gerät löschen sollte.

API-getriggerte Kampagnen

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 Kampagnen zuzugreifen, setzen Sie im Dashboard einen Schlüssel als „example_key“ und einen Wert als "$json:{"foo": 1, "bar": 1}". Dies führt zu einer 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 benutzerdefinierte Schlüssel-Wert-Paare an das Gerät einer Nutzerin oder eines Nutzers senden.

Einige Anwendungsfälle für benutzerdefinierte Schlüssel-Wert-Paare umfassen die interne Metrik-Erfassung und das Festlegen des Kontexts für die Benutzeroberfläche, sie können jedoch für jeden beliebigen Zweck verwendet werden.

API-getriggerte Kampagnen

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 Kampagnen zuzugreifen, setzen Sie im Dashboard einen Schlüssel als „example_key“ und einen Wert als "$json:{"foo": 1, "bar": 1}". Dies führt zu einer Entwicklungskonsolen-Ausgabe von "extras": { "test": { "foo": 1, "bar": 1 }.

FCM-Messaging-Optionen

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

Stille Push-Benachrichtigungen

Eine stille Push-Benachrichtigung ist eine Push-Benachrichtigung ohne Alarmnachricht oder Sound, die verwendet wird, um die Oberfläche oder den Inhalt Ihrer App im Hintergrund zu aktualisieren. Diese Benachrichtigungen nutzen Schlüssel-Wert-Paare, um diese Hintergrund-App-Aktionen zu triggern. 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 eine Testnutzerin oder einen Testnutzer ansprechen, indem Sie nach externer Nutzer-ID oder E-Mail-Adresse filtern.

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

In-App-Nachrichten

Sie können ein Schlüssel-Wert-Paar zu einer In-App-Nachricht im traditionellen Editor hinzufügen, indem Sie den Tab Settings auswählen, Add New Pair wählen und dann Ihre Schlüssel-Wert-Paare angeben.

API-getriggerte Kampagnen

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 Kampagnen zuzugreifen, setzen Sie im Dashboard einen Schlüssel als „example_key“ und einen Wert als "$json:{"foo": 1, "bar": 1}". Dies führt zu einer Entwicklungskonsolen-Ausgabe 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 ermöglicht 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!