Zum Inhalt springen

Push-Benachrichtigungen

Push-Benachrichtigungen ermöglichen es Ihnen, von Ihrer App aus Benachrichtigungen über wichtige Ereignisse zu versenden. Sie können eine Push-Benachrichtigung senden, wenn Sie neue Sofortnachrichten zustellen möchten, aktuelle Eilmeldungen versenden oder die neueste Folge der Lieblingssendung Ihrer Nutzer:innen zum Herunterladen für die Offline-Nutzung bereitsteht. Sie sind auch effizienter als Hintergrundabrufe, da Ihre Anwendung nur bei Bedarf gestartet wird.

Voraussetzungen

Bevor Sie dieses Feature nutzen können, müssen Sie das Braze Web SDK integrieren.

Push-Protokolle

Web-Push-Benachrichtigungen werden mithilfe des W3C-Push-Standards implementiert, der von den meisten gängigen Browsern unterstützt wird. Weitere Informationen zu spezifischen Push-Protokollstandards und Browser-Unterstützung finden Sie in den Ressourcen von Apple, Mozilla und Microsoft.

Push-Benachrichtigungen einrichten

Schritt 1: Service Worker konfigurieren

Fügen Sie in der service-worker.js-Datei Ihres Projekts das folgende Snippet hinzu und setzen Sie die Initialisierungsoption manageServiceWorkerExternally auf true, wenn Sie das Web SDK initialisieren.

Schritt 2: Browser registrieren

Um sofort Push-Berechtigungen von Nutzer:innen anzufordern, damit deren Browser Push-Benachrichtigungen empfangen kann, rufen Sie braze.requestPushPermission() auf. Um zunächst zu prüfen, ob Push im Browser unterstützt wird, rufen Sie braze.isPushSupported() auf.

Sie können den Nutzer:innen auch einen Soft-Push-Prompt senden, bevor Sie die Push-Berechtigung anfordern, um Ihre eigene Push-bezogene UI anzuzeigen.

Schritt 3: skipWaiting deaktivieren (optional)

Die Braze-Service-Worker-Datei ruft bei der Installation automatisch skipWaiting auf. Wenn Sie diese Funktionalität deaktivieren möchten, fügen Sie den folgenden Code zu Ihrer Service-Worker-Datei hinzu, nachdem Sie Braze importiert haben:

Nutzer:innen abmelden

Um eine:n Nutzer:in abzumelden, rufen Sie braze.unregisterPush() auf.

Alternative Domains

Um Web-Push zu integrieren, muss Ihre Domain sicher sein, was in der Regel https, localhost und andere Ausnahmen gemäß dem W3C-Push-Standard bedeutet. Außerdem müssen Sie in der Lage sein, einen Service Worker im Stammverzeichnis Ihrer Domain zu registrieren oder zumindest die HTTP-Header für diese Datei zu kontrollieren. Dieser Artikel beschreibt, wie Sie Braze Web-Push auf einer alternativen Domain integrieren können.

Anwendungsfälle

Wenn Sie nicht alle im W3C-Push-Standard beschriebenen Kriterien erfüllen können, können Sie diese Methode verwenden, um stattdessen einen Push-Berechtigungsdialog auf Ihrer Website hinzuzufügen. Dies kann hilfreich sein, wenn Sie Ihren Nutzer:innen das Opt-in von einer http-Website oder einem Browser-Erweiterungs-Popup ermöglichen möchten, das die Anzeige Ihrer Push-Aufforderung verhindert.

Überlegungen

Bedenken Sie, dass Browser sich – wie bei vielen Workarounds im Web – ständig weiterentwickeln und diese Methode in Zukunft möglicherweise nicht mehr funktioniert. Stellen Sie vor dem Fortfahren sicher, dass:

  • Sie eine separate sichere Domain (https://) besitzen und die Berechtigung haben, einen Service Worker auf dieser Domain zu registrieren.
  • Nutzer:innen auf Ihrer Website eingeloggt sind, damit Push-Token dem richtigen Profil zugeordnet werden.

Eine alternative Push-Domain einrichten

Um das folgende Beispiel zu verdeutlichen, verwenden wir http://insecure.com und https://secure.com als unsere beiden Domains mit dem Ziel, Besucher:innen auf http://insecure.com für Push zu registrieren. Dieses Beispiel könnte auch auf ein chrome-extension://-Schema für die Popup-Seite einer Browser-Erweiterung angewendet werden.

Schritt 1: Aufforderungsablauf starten

Öffnen Sie auf insecure.com ein neues Fenster zu Ihrer sicheren Domain und übergeben Sie dabei die externe Braze-ID der aktuell eingeloggten Nutzer:innen über einen URL-Parameter.

http://insecure.com

<button id="opt-in">Opt-In For Push</button>
<script>
// the same ID you would use with `braze.changeUser`:
const user_id = getUserIdSomehow();
// pass the user ID into the secure domain URL:
const secure_url = `https://secure.com/push-registration.html?external_id=${user_id}`;

// when the user takes some action, open the secure URL in a new window
document.getElementById("opt-in").onclick = function(){
    if (!window.open(secure_url, 'Opt-In to Push', 'height=500,width=600,left=150,top=150')) {
        window.alert('The popup was blocked by your browser');
    } else {
        // user is shown a popup window
        // and you can now prompt for push in this window
    }
}
</script>

Schritt 2: Für Push registrieren

An diesem Punkt öffnet secure.com ein Popup-Fenster, in dem Sie das Braze Web SDK für dieselbe Nutzer-ID initialisieren und die Berechtigung der Nutzer:innen für Web-Push anfordern können.

https://secure.com/push-registration.html

Schritt 3: Zwischen Domains kommunizieren (optional)

Da Nutzer:innen sich nun über diesen Ablauf von insecure.com aus anmelden können, möchten Sie Ihre Website möglicherweise abhängig davon anpassen, ob sich die Nutzer:innen bereits angemeldet haben oder nicht. Es macht keinen Sinn, Nutzer:innen zur Push-Registrierung aufzufordern, wenn sie dies bereits getan haben.

Sie können iFrames und die postMessage-API verwenden, um zwischen Ihren beiden Domains zu kommunizieren.

insecure.com

Auf unserer insecure.com-Domain fragen wir bei der sicheren Domain (auf der Push tatsächlich registriert ist) Informationen über die Push-Registrierung der aktuellen Nutzer:innen ab:

<!-- Create an iframe to the secure domain and run getPushStatus onload-->
<iframe id="push-status" src="https://secure.com/push-status.html" onload="getPushStatus()" style="display:none;"></iframe>

<script>
function getPushStatus(event){
    // send a message to the iframe asking for push status
    event.target.contentWindow.postMessage({type: 'get_push_status'}, 'https://secure.com');
    // listen for a response from the iframe's domain
    window.addEventListener("message", (event) => {
        if (event.origin === "http://insecure.com" && event.data.type === 'set_push_status') {
            // update the page based on the push permission we're told
            window.alert(`Is user registered for push? ${event.data.isPushPermissionGranted}`);
        }
    }
}
</script>

secure.com/push-status.html

Häufig gestellte Fragen (FAQ)

Service Worker

Was kann ich tun, wenn ich keinen Service Worker im Stammverzeichnis registrieren kann?

Standardmäßig kann ein Service Worker nur innerhalb desselben Verzeichnisses verwendet werden, in dem er registriert ist. Wenn sich Ihre Service-Worker-Datei beispielsweise unter /assets/service-worker.js befindet, kann sie nur innerhalb von example.com/assets/* oder einem Unterverzeichnis des assets-Ordners registriert werden, nicht jedoch auf Ihrer Startseite (example.com/). Aus diesem Grund wird empfohlen, den Service Worker im Stammverzeichnis zu hosten und zu registrieren (z. B. https://example.com/service-worker.js).

Wenn Sie keinen Service Worker in Ihrer Stammdomäne registrieren können, besteht eine alternative Möglichkeit darin, den HTTP-Header Service-Worker-Allowed beim Bereitstellen Ihrer Service-Worker-Datei zu verwenden. Indem Sie Ihren Server so konfigurieren, dass er in der Antwort für den Service Worker Service-Worker-Allowed: / zurückgibt, weisen Sie den Browser an, den Geltungsbereich zu erweitern und die Verwendung aus einem anderen Verzeichnis heraus zu ermöglichen.

Kann ich einen Service Worker mit einem Tag Manager erstellen?

Nein, Service Worker müssen auf dem Server Ihrer Website gehostet werden und können nicht über einen Tag Manager geladen werden.

Website-Sicherheit

Ist HTTPS erforderlich?

Ja. Webstandards erfordern, dass die Domain, die die Berechtigung für Push-Benachrichtigungen anfordert, sicher sein muss.

Wann gilt eine Website als „sicher“?

Eine Website gilt als sicher, wenn sie einem der folgenden Secure-Origin-Muster entspricht. Braze Web-Push-Benachrichtigungen basieren auf diesem offenen Standard, sodass Man-in-the-Middle-Angriffe verhindert werden.

  • (https, , *)
  • (wss, *, *)
  • (, localhost, )
  • (, .localhost, *)
  • (, 127/8, )
  • (, ::1/128, *)
  • (file, *, —)
  • (chrome-extension, *, —)

Was ist, wenn keine sichere Website verfügbar ist?

Obwohl es eine branchenweit bewährte Vorgehensweise ist, Ihre gesamte Website sicher zu machen, können Kund:innen, die ihre Website-Domain nicht absichern können, die Anforderung umgehen, indem sie ein sicheres Modal verwenden. Lesen Sie mehr in unserem Leitfaden zur Verwendung einer alternativen Push-Domain oder sehen Sie sich eine funktionierende Demo an.

Voraussetzungen

Bevor Sie dieses Feature nutzen können, müssen Sie das Android Braze SDK integrieren.

Integrierte Features

Die folgenden Features sind im Braze Android SDK integriert. Um weitere Push-Benachrichtigungs-Features zu nutzen, müssen Sie Push-Benachrichtigungen einrichten für Ihre App.

Feature Beschreibung
Push Stories Android Push Stories sind standardmäßig im Braze Android SDK integriert. Weitere Informationen finden Sie unter Push Stories.
Push-Primer Push-Primer-Campaigns ermutigen Ihre Nutzer:innen, Push-Benachrichtigungen auf ihrem Gerät für Ihre App zu aktivieren. Dies ist ohne SDK-Anpassung möglich, indem Sie unseren No-Code-Push-Primer verwenden.

Über den Lebenszyklus der Push-Benachrichtigung

Das folgende Flussdiagramm zeigt, wie Braze den Lebenszyklus der Push-Benachrichtigung handhabt, z. B. die Aufforderung zur Erteilung von Berechtigungen, die Generierung von Token und die Zustellung von Nachrichten.

---
config:
  theme: neutral
---
flowchart TD

%% Permission flow
subgraph Permission[Push Permissions]
    B{Android version of the device?}
    B -->|Android 13+| C["requestPushPermissionPrompt() called"]
    B -->|Android 12 and earlier| D[No permissions required]

    %% Connect Android 12 path to Braze state
    D --> H3[Braze: user subscription state]
    H3 --> J3[Defaults to 'subscribed' when user profile created]

    C --> E{Did the user grant push permission?}
    E -->|Yes| F[POST_NOTIFICATIONS permission granted]
    E -->|No| G[POST_NOTIFICATIONS permission denied]

    %% Braze subscription state updates
    F --> H1[Braze: user subscription state]
    G --> H2[Braze: user subscription state]

    H1 --> I1{Automatically opt in after permission granted?}
    I1 -->|true| J1[Set to 'opted-in']
    I1 -->|false| J2[Remains 'subscribed']

    H2 --> K1[Remains 'subscribed'<br/>or 'unsubscribed']

    %% Subscription state legend
    subgraph BrazeStates[Braze subscription states]
        L1['Subscribed' - default state<br/>when user profile created]
        L2['Opted-in' - user explicitly<br/>wants push notifications]
        L3['Unsubscribed' - user explicitly<br/>opted out of push]
    end

    %% Note about user-level states
    note1[Note: These states are user-level<br/>and apply across all devices for the user]

    %% Connect states to legend
    J1 -.-> L2
    J2 -.-> L1
    J3 -.-> L1
    K1 -.-> L3
    note1 -.-> BrazeStates
end

%% Styling
classDef permissionClass fill:#e3f2fd,stroke:#1565c0,stroke-width:2px
classDef tokenClass fill:#e8f5e9,stroke:#2e7d32,stroke-width:2px
classDef sdkClass fill:#fff3e0,stroke:#e65100,stroke-width:2px
classDef configClass fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px
classDef displayClass fill:#ffebee,stroke:#c62828,stroke-width:2px
classDef deliveryClass fill:#fce4ec,stroke:#c2185b,stroke-width:2px
classDef brazeClass fill:#e8f5e9,stroke:#2e7d32,stroke-width:3px

class A,B,C,E,F,G permissionClass
class H,I tokenClass
class J,K sdkClass
class N,O,P configClass
class R,S,S1,T,U,V displayClass
class W,X,X1,X2,Y,Z deliveryClass
class H1,H2,H3,I1,J1,J2,J3,K1,L1,L2,L3,note1 brazeClass
---
config:
  theme: neutral
---
flowchart TD

%% Token generation flow
subgraph Token[Token Generation]
    H["Braze SDK initialized"] --> Q{Is FCM auto-registration enabled?}
    Q -->|Yes| L{Is required configuration present?}
    Q -->|No| M[No FCM token generated]
    L -->|Yes| I[Generate FCM token]
    L -->|No| M
    I --> K[Register token with Braze]

    %% Configuration requirements
    subgraph Config[Required configuration]
        N['google-services.json' file is present]
        O['com.google.firebase:firebase-messaging' in gradle]
        P['com.google.gms.google-services' plugin in gradle]
    end

    %% Connect config to check
    N -.-> L
    O -.-> L
    P -.-> L
end

%% Styling
classDef permissionClass fill:#e3f2fd,stroke:#1565c0,stroke-width:2px
classDef tokenClass fill:#e8f5e9,stroke:#2e7d32,stroke-width:2px
classDef sdkClass fill:#fff3e0,stroke:#e65100,stroke-width:2px
classDef configClass fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px
classDef displayClass fill:#ffebee,stroke:#c62828,stroke-width:2px
classDef deliveryClass fill:#fce4ec,stroke:#c2185b,stroke-width:2px
classDef brazeClass fill:#e8f5e9,stroke:#2e7d32,stroke-width:3px

class A,B,C,E,F,G permissionClass
class H,I tokenClass
class J,K sdkClass
class N,O,P configClass
class R,S,S1,T,U,V displayClass
class W,X,X1,X2,Y,Z deliveryClass
class H1,H2,H3,I1,J1,J2,J3,K1,L1,L2,L3,note1 brazeClass
---
config:
  theme: neutral
  fontSize: 10
---
flowchart TD

subgraph Display[Push Display]
    %% Push delivery flow
    W[Push sent to FCM servers] --> X{Did FCM receive push?}
    X -->|App is terminated| Y[FCM cannot deliver push to the app]
    X -->|Delivery conditions met| X1[App receives push from FCM]
    X1 --> X2[Braze SDK receives push]
    X2 --> R[Push type?]

    %% Push Display Flow
    R -->|Standard push| S{Is push permission required?}
    R -->|Silent push| T[Braze SDK processes silent push]
    S -->|Yes| S1{Did the user grant push permission?}
    S -->|No| V[Notification is shown to the user]
    S1 -->|Yes| V
    S1 -->|No| U[Notification is not shown to the user]
end

%% Styling
classDef permissionClass fill:#e3f2fd,stroke:#1565c0,stroke-width:2px
classDef tokenClass fill:#e8f5e9,stroke:#2e7d32,stroke-width:2px
classDef sdkClass fill:#fff3e0,stroke:#e65100,stroke-width:2px
classDef configClass fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px
classDef displayClass fill:#ffebee,stroke:#c62828,stroke-width:2px
classDef deliveryClass fill:#fce4ec,stroke:#c2185b,stroke-width:2px
classDef brazeClass fill:#e8f5e9,stroke:#2e7d32,stroke-width:3px

class A,B,C,E,F,G permissionClass
class H,I tokenClass
class J,K sdkClass
class N,O,P configClass
class R,S,S1,T,U,V displayClass
class W,X,X1,X2,Y,Z deliveryClass
class H1,H2,H3,I1,J1,J2,J3,K1,L1,L2,L3,note1 brazeClass

Push-Benachrichtigungen einrichten

Rate-Limits

Die Firebase Cloud Messaging (FCM) API hat ein standardmäßiges Rate-Limit von 600.000 Anfragen pro Minute. Wenn Sie dieses Limit erreichen, versucht Braze es automatisch in wenigen Minuten erneut. Um eine Erhöhung anzufordern, wenden Sie sich an den Firebase Support.

Schritt 1: Firebase zu Ihrem Projekt hinzufügen

Fügen Sie zunächst Firebase zu Ihrem Android-Projekt hinzu. Eine Schritt-für-Schritt-Anleitung finden Sie in Googles Firebase-Einrichtungsleitfaden.

Schritt 2: Cloud Messaging zu Ihren Abhängigkeiten hinzufügen

Fügen Sie als Nächstes die Cloud-Messaging-Bibliothek zu den Abhängigkeiten Ihres Projekts hinzu. Öffnen Sie in Ihrem Android-Projekt die Datei build.gradle und fügen Sie die folgende Zeile zu Ihrem dependencies-Block hinzu.

implementation "google.firebase:firebase-messaging:+"

Ihre Abhängigkeiten sollten in etwa wie folgt aussehen:

dependencies {
  implementation project(':android-sdk-ui')
  implementation "com.google.firebase:firebase-messaging:+"
}

Schritt 3: Die Firebase Cloud Messaging API aktivieren

Wählen Sie in Google Cloud das Projekt aus, das Ihre Android-App verwendet, und aktivieren Sie dann die Firebase Cloud Messaging API.

Aktivierte Firebase Cloud Messaging API

Schritt 4: Ein Dienstkonto erstellen

Erstellen Sie als Nächstes ein neues Dienstkonto, damit Braze autorisierte API-Aufrufe bei der Registrierung von FCM-Tokens durchführen kann. Navigieren Sie in Google Cloud zu Service Accounts und wählen Sie dann Ihr Projekt aus. Wählen Sie auf der Seite Service Accounts die Option Create Service Account.

Die Startseite des Dienstkontos eines Projekts mit hervorgehobener Option „Create Service Account“.

Geben Sie einen Namen, eine ID und eine Beschreibung für das Dienstkonto ein und wählen Sie dann Create and continue.

Suchen Sie im Feld Role den Eintrag Firebase Cloud Messaging API Admin in der Rollenliste und wählen Sie ihn aus. Für einen eingeschränkteren Zugriff erstellen Sie eine benutzerdefinierte Rolle mit der Berechtigung cloudmessaging.messages.create und wählen Sie diese stattdessen aus der Liste aus. Wenn Sie fertig sind, wählen Sie Done.

Das Formular „Grant this service account access to project“ mit „Firebase Cloud Messaging API Admin“ als ausgewählter Rolle.

Schritt 5: JSON-Zugangsdaten generieren

Generieren Sie als Nächstes JSON-Zugangsdaten für Ihr FCM-Dienstkonto. Navigieren Sie unter Google Cloud IAM & Admin zu Service Accounts und wählen Sie dann Ihr Projekt aus. Suchen Sie das FCM-Dienstkonto, das Sie zuvor erstellt haben, und wählen Sie dann  Actions > Manage Keys.

Die Startseite des Dienstkontos des Projekts mit geöffnetem Menü „Actions“.

Wählen Sie Add Key > Create new key.

Das ausgewählte Dienstkonto mit geöffnetem Menü „Add Key“.

Wählen Sie JSON und dann Create. Wenn Sie Ihr Dienstkonto mit einer anderen Google-Cloud-Projekt-ID als Ihrer FCM-Projekt-ID erstellt haben, müssen Sie den Wert von project_id in Ihrer JSON-Datei manuell aktualisieren.

Merken Sie sich unbedingt, wohin Sie den Schlüssel heruntergeladen haben—Sie benötigen ihn im nächsten Schritt.

Das Formular zum Erstellen eines privaten Schlüssels mit ausgewählter Option „JSON“.

Schritt 6: Ihre JSON-Zugangsdaten in Braze hochladen

Laden Sie als Nächstes Ihre JSON-Zugangsdaten in Ihr Braze-Dashboard hoch. Wählen Sie in Braze  Einstellungen > App-Einstellungen.

Das geöffnete Menü „Einstellungen“ in Braze mit hervorgehobener Option „App-Einstellungen“.

Wählen Sie unter den Push Notification Settings Ihrer Android-App Firebase aus, wählen Sie dann Upload JSON File und laden Sie die Zugangsdaten hoch, die Sie zuvor generiert haben. Wenn Sie fertig sind, wählen Sie Save.

Das Formular für „Push Notification Settings“ mit „Firebase“ als ausgewähltem Push-Anbieter.

Schritt 7: Automatische Token-Registrierung einrichten

Wenn sich Nutzer:innen für Push-Benachrichtigungen anmelden, muss Ihre App ein FCM-Token auf deren Gerät generieren, bevor Sie ihnen Push-Benachrichtigungen senden können. Mit dem Braze SDK können Sie die automatische FCM-Token-Registrierung für jedes Gerät Ihrer Nutzer:innen in den Braze-Konfigurationsdateien Ihres Projekts aktivieren.

Gehen Sie zunächst zur Firebase Console, öffnen Sie Ihr Projekt und wählen Sie dann  Settings > Project settings.

Das Firebase-Projekt mit geöffnetem Menü „Settings“.

Wählen Sie Cloud Messaging und kopieren Sie dann unter Firebase Cloud Messaging API (V1) die Nummer im Feld Sender ID.

Die Seite „Cloud Messaging“ des Firebase-Projekts mit hervorgehobener „Sender ID“.

Öffnen Sie als Nächstes Ihr Android-Studio-Projekt und verwenden Sie Ihre Firebase Sender ID, um die automatische FCM-Token-Registrierung in Ihrer braze.xml oder BrazeConfig zu aktivieren.

Um die automatische FCM-Token-Registrierung zu konfigurieren, fügen Sie die folgenden Zeilen zu Ihrer braze.xml-Datei hinzu:

<bool translatable="false" name="com_braze_firebase_cloud_messaging_registration_enabled">true</bool>
<string translatable="false" name="com_braze_firebase_cloud_messaging_sender_id">FIREBASE_SENDER_ID</string>

Ersetzen Sie FIREBASE_SENDER_ID durch den Wert, den Sie aus Ihren Firebase-Projekteinstellungen kopiert haben. Ihre braze.xml sollte in etwa wie folgt aussehen:

<?xml version="1.0" encoding="utf-8"?>
<resources>
  <string translatable="false" name="com_braze_api_key">12345ABC-6789-DEFG-0123-HIJK456789LM</string>
  <bool translatable="false" name="com_braze_firebase_cloud_messaging_registration_enabled">true</bool>
<string translatable="false" name="com_braze_firebase_cloud_messaging_sender_id">603679405392</string>
</resources>

Um die automatische FCM-Token-Registrierung zu konfigurieren, fügen Sie die folgenden Zeilen zu Ihrer BrazeConfig hinzu:

.setIsFirebaseCloudMessagingRegistrationEnabled(true)
.setFirebaseCloudMessagingSenderIdKey("FIREBASE_SENDER_ID")
.setIsFirebaseCloudMessagingRegistrationEnabled(true)
.setFirebaseCloudMessagingSenderIdKey("FIREBASE_SENDER_ID")

Ersetzen Sie FIREBASE_SENDER_ID durch den Wert, den Sie aus Ihren Firebase-Projekteinstellungen kopiert haben. Ihre BrazeConfig sollte in etwa wie folgt aussehen:

BrazeConfig brazeConfig = new BrazeConfig.Builder()
  .setApiKey("12345ABC-6789-DEFG-0123-HIJK456789LM")
  .setCustomEndpoint("sdk.iad-01.braze.com")
  .setSessionTimeout(60)
  .setHandlePushDeepLinksAutomatically(true)
  .setGreatNetworkDataFlushInterval(10)
  .setIsFirebaseCloudMessagingRegistrationEnabled(true)
  .setFirebaseCloudMessagingSenderIdKey("603679405392")
  .build();
Braze.configure(this, brazeConfig);
val brazeConfig = BrazeConfig.Builder()
  .setApiKey("12345ABC-6789-DEFG-0123-HIJK456789LM")
  .setCustomEndpoint("sdk.iad-01.braze.com")
  .setSessionTimeout(60)
  .setHandlePushDeepLinksAutomatically(true)
  .setGreatNetworkDataFlushInterval(10)
  .setIsFirebaseCloudMessagingRegistrationEnabled(true)
  .setFirebaseCloudMessagingSenderIdKey("603679405392")
  .build()
Braze.configure(this, brazeConfig)

Mehrere Firebase-Projekte verwenden

Wenn Ihre App mehrere Firebase-Projekte verwendet, gehen Sie wie folgt vor:

  1. Belassen Sie Braze-Push im Standard-Firebase-Projekt, das über die google-services.json Ihrer App initialisiert wird.
  2. Wenn Sie einen benutzerdefinierten Firebase-Messaging-Dienst verwenden, führen Sie Installations-IDs in benutzerdefinierten Firebase-Messaging-Diensten registrieren durch.
  3. Wenn Ihre App ein Push-Token auf anderem Weg erhält, setzen Sie registeredPushToken manuell, wie im vorherigen Tipp gezeigt.

Versionsdetails finden Sie in den SDK-Changelogs.

Schritt 8: Automatische Anfragen in Ihrer Application-Klasse entfernen

Um zu verhindern, dass Braze bei jedem Senden stiller Push-Benachrichtigungen unnötige Netzwerkanfragen auslöst, entfernen Sie alle automatischen Netzwerkanfragen, die in der onCreate()-Methode Ihrer Application-Klasse konfiguriert sind. Weitere Informationen finden Sie unter Android Developer Reference: Application.

Benachrichtigungen anzeigen

Schritt 1: Braze Firebase Messaging Service registrieren

Sie können einen neuen, vorhandenen oder einen Nicht-Braze Firebase Messaging Service erstellen. Wählen Sie die Option, die Ihren spezifischen Anforderungen am besten entspricht.

Braze enthält einen Service zur Verarbeitung von Push-Empfangs- und Öffnungs-Intents. Unser BrazeFirebaseMessagingService muss in Ihrer AndroidManifest.xml registriert werden:

<service android:name="com.braze.push.BrazeFirebaseMessagingService"
  android:exported="false">
  <intent-filter>
    <action android:name="com.google.firebase.MESSAGING_EVENT" />
  </intent-filter>
</service>

Unser Benachrichtigungscode verwendet ebenfalls BrazeFirebaseMessagingService, um Öffnungs- und Klick-Aktions-Tracking zu verarbeiten. Dieser Service muss in der AndroidManifest.xml registriert werden, damit er korrekt funktioniert. Beachten Sie außerdem, dass Braze Benachrichtigungen aus unserem System mit einem eindeutigen Schlüssel versieht, sodass nur Benachrichtigungen gerendert werden, die von unseren Systemen gesendet wurden. Sie können weitere Services separat registrieren, um Benachrichtigungen von anderen FCM-Services zu rendern. Siehe AndroidManifest.xml in der Firebase-Push-Beispiel-App.

Wenn Sie bereits einen Firebase Messaging Service registriert haben, können Sie RemoteMessage-Objekte über BrazeFirebaseMessagingService.handleBrazeRemoteMessage() an Braze übergeben. Diese Methode zeigt nur dann eine Benachrichtigung an, wenn das RemoteMessage-Objekt von Braze stammt, und ignoriert es andernfalls sicher.

Installations-IDs in benutzerdefiniertem Firebase Messaging Service registrieren

Wenn Sie firebase-messaging v25.1.0 oder höher verwenden, nutzt die Firebase-Registrierung die Firebase-Installations-ID. Überschreiben Sie in Ihrem benutzerdefinierten Firebase Messaging Service onRegistered und setzen Sie registeredPushToken.

public class MyFirebaseMessagingService extends FirebaseMessagingService {
  @Override
  public void onRegistered(String installationId) {
    super.onRegistered(installationId);
    Braze.getInstance(this).setRegisteredPushToken(installationId);
  }

  @Override
  public void onMessageReceived(RemoteMessage remoteMessage) {
    super.onMessageReceived(remoteMessage);
    if (BrazeFirebaseMessagingService.handleBrazeRemoteMessage(this, remoteMessage)) {
      // This Remote Message originated from Braze and a push notification was displayed.
      // No further action is needed.
    } else {
      // This Remote Message did not originate from Braze.
      // No action was taken and you can safely pass this Remote Message to other handlers.
    }
  }
}
class MyFirebaseMessagingService : FirebaseMessagingService() {
  override fun onRegistered(installationId: String) {
    super.onRegistered(installationId)
    Braze.getInstance(this).registeredPushToken = installationId
  }

  override fun onMessageReceived(remoteMessage: RemoteMessage?) {
    super.onMessageReceived(remoteMessage)
    if (BrazeFirebaseMessagingService.handleBrazeRemoteMessage(this, remoteMessage)) {
      // This Remote Message originated from Braze and a push notification was displayed.
      // No further action is needed.
    } else {
      // This Remote Message did not originate from Braze.
      // No action was taken and you can safely pass this Remote Message to other handlers.
    }
  }
}

Wenn Sie einen weiteren Firebase Messaging Service verwenden möchten, können Sie auch einen Fallback-Firebase-Messaging-Service angeben, der aufgerufen wird, wenn Ihre Anwendung eine Push-Benachrichtigung empfängt, die nicht von Braze stammt.

Geben Sie in Ihrer braze.xml Folgendes an:

<bool name="com_braze_fallback_firebase_cloud_messaging_service_enabled">true</bool>
<string name="com_braze_fallback_firebase_cloud_messaging_service_classpath">com.company.OurFirebaseMessagingService</string>

oder legen Sie es über die Laufzeitkonfiguration fest:

BrazeConfig brazeConfig = new BrazeConfig.Builder()
        .setFallbackFirebaseMessagingServiceEnabled(true)
        .setFallbackFirebaseMessagingServiceClasspath("com.company.OurFirebaseMessagingService")
        .build();
Braze.configure(this, brazeConfig);
val brazeConfig = BrazeConfig.Builder()
        .setFallbackFirebaseMessagingServiceEnabled(true)
        .setFallbackFirebaseMessagingServiceClasspath("com.company.OurFirebaseMessagingService")
        .build()
Braze.configure(this, brazeConfig)

Schritt 2: Kleine Symbole an Design-Richtlinien anpassen

Allgemeine Informationen zu Android-Benachrichtigungssymbolen finden Sie in der Übersicht über Benachrichtigungen.

Ab Android N sollten Sie kleine Benachrichtigungssymbol-Assets, die Farben enthalten, aktualisieren oder entfernen. Das Android-System (nicht das Braze SDK) ignoriert alle Nicht-Alpha- und Transparenzkanäle in Aktionssymbolen und dem kleinen Benachrichtigungssymbol. Mit anderen Worten: Android konvertiert alle Teile Ihres kleinen Benachrichtigungssymbols in Monochrom, mit Ausnahme transparenter Bereiche.

So erstellen Sie ein kleines Benachrichtigungssymbol-Asset, das korrekt angezeigt wird:

  • Entfernen Sie alle Farben aus dem Bild mit Ausnahme von Weiß.
  • Alle anderen nicht-weißen Bereiche des Assets sollten transparent sein.

Die folgenden großen und kleinen Symbole sind Beispiele für korrekt gestaltete Symbole:

Ein kleines Symbol, das in der unteren Ecke eines großen Symbols neben einer Nachricht erscheint, die „Hey I'm on my way to the bar but..“ lautet

Schritt 3: Benachrichtigungssymbole konfigurieren

Symbole in braze.xml angeben

Braze ermöglicht es Ihnen, Ihre Benachrichtigungssymbole durch die Angabe von Drawable-Ressourcen in Ihrer braze.xml zu konfigurieren:

<drawable name="com_braze_push_small_notification_icon">REPLACE_WITH_YOUR_ICON</drawable>
<drawable name="com_braze_push_large_notification_icon">REPLACE_WITH_YOUR_ICON</drawable>

Die Angabe eines kleinen Benachrichtigungssymbols ist erforderlich. Wenn Sie keines festlegen, verwendet Braze standardmäßig das App-Symbol als kleines Benachrichtigungssymbol, was möglicherweise nicht optimal aussieht.

Die Angabe eines großen Benachrichtigungssymbols ist optional, wird aber empfohlen.

Akzentfarbe des Symbols festlegen

Die Akzentfarbe des Benachrichtigungssymbols kann in Ihrer braze.xml überschrieben werden. Wenn keine Farbe angegeben wird, ist die Standardfarbe dasselbe Grau, das Lollipop für Systembenachrichtigungen verwendet.

<integer name="com_braze_default_notification_accent_color">0xFFf33e3e</integer>

Optional können Sie auch eine Farbreferenz verwenden:

<color name="com_braze_default_notification_accent_color">@color/my_color_here</color>

Um Braze das automatische Öffnen Ihrer App und aller Deeplinks beim Klicken auf eine Push-Benachrichtigung zu ermöglichen, setzen Sie com_braze_handle_push_deep_links_automatically in Ihrer braze.xml auf true:

<bool name="com_braze_handle_push_deep_links_automatically">true</bool>

Dieses Flag kann auch über die Laufzeitkonfiguration gesetzt werden:

BrazeConfig brazeConfig = new BrazeConfig.Builder()
        .setHandlePushDeepLinksAutomatically(true)
        .build();
Braze.configure(this, brazeConfig);
val brazeConfig = BrazeConfig.Builder()
        .setHandlePushDeepLinksAutomatically(true)
        .build()
Braze.configure(this, brazeConfig)

Wenn Sie Deeplinks benutzerdefiniert verarbeiten möchten, müssen Sie einen Push-Callback erstellen, der auf Push-Empfangs- und Öffnungs-Intents von Braze lauscht. Weitere Informationen finden Sie unter Einen Callback für Push-Ereignisse verwenden.

Vordergrund-Benachrichtigungen verarbeiten

Wenn eine Push-Benachrichtigung unter Android eintrifft, während Ihre App im Vordergrund ist, zeigt das System sie standardmäßig automatisch an. Damit Braze den Payload der Push-Benachrichtigung verarbeitet (für Analytics-Tracking, Deeplink-Verarbeitung und benutzerdefinierte Verarbeitung), leiten Sie die eingehenden Push-Daten in Ihrer FirebaseMessagingService.onMessageReceived-Methode an Braze weiter.

Funktionsweise

Wenn Sie BrazeFirebaseMessagingService.handleBrazeRemoteMessage aufrufen, prüft Braze, ob es sich beim Payload um eine Braze-Push-Benachrichtigung handelt, und erstellt und zeigt die Benachrichtigung gegebenenfalls mit der NotificationManagerCompat-Methode an. Anders als bei iOS zeigt Android Benachrichtigungen unabhängig davon an, ob sich die App im Vordergrund oder Hintergrund befindet.

package com.example.push;

import com.braze.push.BrazeFirebaseMessagingService;
import com.google.firebase.messaging.FirebaseMessagingService;
import com.google.firebase.messaging.RemoteMessage;

public class MyFirebaseMessagingService extends FirebaseMessagingService {
    @Override
    public void onMessageReceived(RemoteMessage remoteMessage) {
        super.onMessageReceived(remoteMessage);

        // Let Braze process the payload and display the notification
        if (BrazeFirebaseMessagingService.handleBrazeRemoteMessage(this, remoteMessage)) {
            // Braze successfully handled the push notification
        } else {
            // Handle non-Braze messages
        }
    }
}
package com.example.push

import com.braze.push.BrazeFirebaseMessagingService
import com.google.firebase.messaging.FirebaseMessagingService
import com.google.firebase.messaging.RemoteMessage

class MyFirebaseMessagingService : FirebaseMessagingService() {
    override fun onMessageReceived(remoteMessage: RemoteMessage) {
        super.onMessageReceived(remoteMessage)

        // Let Braze process the payload and display the notification
        if (BrazeFirebaseMessagingService.handleBrazeRemoteMessage(this, remoteMessage)) {
            // Braze successfully handled the push notification
        } else {
            // Handle non-Braze messages
        }
    }
}

Weitere Informationen finden Sie im Firebase-Integrations-Beispiel im Braze Android SDK Repository.

Vordergrundverhalten anpassen

Wenn Sie ein benutzerdefiniertes Vordergrundverhalten wünschen, z. B. die Systembenachrichtigung unterdrücken oder stattdessen eine In-App-Oberfläche anzeigen, können Sie Folgendes tun:

  • Verwenden Sie subscribeToPushNotificationEvents, um auf Push-Ereignisse zu reagieren, und die Methode BrazeNotificationUtils.routeUserWithNotificationOpenedIntent, um Deeplinks zu verarbeiten. Weitere Informationen finden Sie im Firebase-Push-Beispiel.
  • Erstellen und veröffentlichen Sie Ihre eigene Benachrichtigung mit einer benutzerdefinierten IBrazeNotificationFactory, oder unterdrücken Sie die Benachrichtigung, indem Sie notificationManager.notify in Ihrem Verarbeitungspfad nicht aufrufen.

Weitere Informationen zum Anpassen von Benachrichtigungen finden Sie unter Benutzerdefinierte Benachrichtigungs-Factory.

Folgen Sie den Anweisungen in der Android-Entwicklerdokumentation zum Deeplinking, falls Sie Ihrer App noch keine Deeplinks hinzugefügt haben. Um mehr darüber zu erfahren, was Deeplinks sind, lesen Sie unseren FAQ-Artikel.

Das Braze-Dashboard unterstützt das Festlegen von Deeplinks oder Web-URLs in Push-Benachrichtigungs-Campaigns und Canvases, die beim Klicken auf die Benachrichtigung geöffnet werden.

Die Einstellung „On Click Behavior“ im Braze-Dashboard mit der Option „Deep Link Into Application“ im Dropdown.

Back-Stack-Verhalten anpassen

Das Android SDK platziert standardmäßig die Hauptstartaktivität Ihrer Host-App im Back-Stack, wenn Push-Deeplinks aufgerufen werden. Braze ermöglicht es Ihnen, eine benutzerdefinierte Aktivität festzulegen, die anstelle Ihrer Hauptstartaktivität im Back-Stack geöffnet wird, oder den Back-Stack vollständig zu deaktivieren.

Um beispielsweise eine Aktivität namens YourMainActivity als Back-Stack-Aktivität über die Laufzeitkonfiguration festzulegen:

BrazeConfig brazeConfig = new BrazeConfig.Builder()
        .setPushDeepLinkBackStackActivityEnabled(true)
        .setPushDeepLinkBackStackActivityClass(YourMainActivity.class)
        .build();
Braze.configure(this, brazeConfig);
val brazeConfig = BrazeConfig.Builder()
        .setPushDeepLinkBackStackActivityEnabled(true)
        .setPushDeepLinkBackStackActivityClass(YourMainActivity.class)
        .build()
Braze.configure(this, brazeConfig)

Die entsprechende Konfiguration finden Sie in Ihrer braze.xml. Beachten Sie, dass der Klassenname mit dem von Class.forName() zurückgegebenen übereinstimmen muss.

<bool name="com_braze_push_deep_link_back_stack_activity_enabled">true</bool>
<string name="com_braze_push_deep_link_back_stack_activity_class_name">your.package.name.YourMainActivity</string>

Schritt 5: Benachrichtigungskanäle definieren

Das Braze Android SDK unterstützt Android-Benachrichtigungskanäle. Wenn eine Braze-Benachrichtigung keine ID für einen Benachrichtigungskanal enthält oder eine ungültige Kanal-ID aufweist, zeigt Braze die Benachrichtigung mit dem im SDK definierten Standard-Benachrichtigungskanal an. Nutzer:innen verwenden Android-Benachrichtigungskanäle innerhalb der Plattform, um Benachrichtigungen zu gruppieren.

Um den für Nutzer:innen sichtbaren Namen des Standard-Braze-Benachrichtigungskanals festzulegen, verwenden Sie BrazeConfig.setDefaultNotificationChannelName().

Um die für Nutzer:innen sichtbare Beschreibung des Standard-Braze-Benachrichtigungskanals festzulegen, verwenden Sie BrazeConfig.setDefaultNotificationChannelDescription().

Aktualisieren Sie alle API-Campaigns mit dem Parameter Android-Push-Objekt, um das Feld notification_channel einzuschließen. Wenn dieses Feld nicht angegeben wird, sendet Braze den Benachrichtigungs-Payload mit der Kanal-ID des Dashboard-Fallbacks.

Abgesehen vom Standard-Benachrichtigungskanal erstellt Braze keine weiteren Kanäle. Alle anderen Kanäle müssen programmatisch von der Host-App definiert und anschließend im Braze-Dashboard eingegeben werden.

Der Standard-Kanalname und die Beschreibung können auch in braze.xml konfiguriert werden.

<string name="com_braze_default_notification_channel_name">Your channel name</string>
<string name="com_braze_default_notification_channel_description">Your channel description</string>

Schritt 6: Benachrichtigungsanzeige und Analytics testen

Anzeige testen

An diesem Punkt sollten Sie Benachrichtigungen sehen können, die von Braze gesendet werden. Um dies zu testen, gehen Sie zur Seite Campaigns in Ihrem Braze-Dashboard und erstellen Sie eine Push Notification-Campaign. Wählen Sie Android Push und gestalten Sie Ihre Nachricht. Klicken Sie dann auf das Augensymbol im Composer, um den Testsender aufzurufen. Geben Sie die Nutzer-ID oder E-Mail-Adresse Ihrer aktuellen Nutzerin bzw. Ihres aktuellen Nutzers ein und klicken Sie auf Send Test. Die Push-Benachrichtigung sollte auf Ihrem Gerät erscheinen.

Der Tab „Test“ einer Push-Benachrichtigungs-Campaign im Braze-Dashboard.

Bei Problemen mit der Push-Anzeige lesen Sie unseren Leitfaden zur Fehlerbehebung.

Analytics testen

An diesem Punkt sollte auch das Analytics-Logging für das Öffnen von Push-Benachrichtigungen funktionieren. Wenn Sie auf die Benachrichtigung beim Eintreffen klicken, sollte der Wert für Direct Opens auf Ihrer Campaign-Ergebnisseite um 1 steigen. Weitere Informationen zu Push-Analytics finden Sie in unserem Artikel zu Push-Berichten.

Bei Problemen mit Push-Analytics lesen Sie unseren Leitfaden zur Fehlerbehebung.

Über die Befehlszeile testen

Wenn Sie In-App- und Push-Benachrichtigungen über die Befehlszeile testen möchten, können Sie eine einzelne Benachrichtigung über das Terminal mit cURL und der Messaging-API senden. Sie müssen die folgenden Felder durch die korrekten Werte für Ihren Testfall ersetzen:

  • YOUR_API_KEY (Gehen Sie zu Settings > API Keys.)
  • YOUR_EXTERNAL_USER_ID (Suchen Sie auf der Seite Search Users nach einem Profil.)
  • YOUR_KEY1 (optional)
  • YOUR_VALUE1 (optional)
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer {YOUR_API_KEY}" -d '{
  "external_user_ids":["YOUR_EXTERNAL_USER_ID"],
  "messages": {
    "android_push": {
      "title":"Test push title",
      "alert":"Test push",
      "extra": {
        "YOUR_KEY1":"YOUR_VALUE1"
      }
    }
  }
}' https://rest.iad-01.braze.com/messages/send

Dieses Beispiel verwendet die US-01-Instanz. Wenn Sie sich nicht auf dieser Instanz befinden, ersetzen Sie den US-01-Endpunkt durch Ihren Endpunkt.

Push-Benachrichtigungen für Unterhaltungen

Android-Benachrichtigungsleiste mit einem Bereich „Unterhaltungen“, in dem drei gruppierte Unterhaltungsbenachrichtigungen von verschiedenen Kontakten angezeigt werden.

Die People-and-Conversations-Initiative ist eine mehrjährige Android-Initiative, die darauf abzielt, Personen und Unterhaltungen auf den Systemoberflächen des Telefons hervorzuheben. Diese Priorisierung basiert auf der Tatsache, dass die Kommunikation und Interaktion mit anderen Menschen nach wie vor der wertvollste und wichtigste Funktionsbereich für die Mehrheit der Android-Nutzer:innen über alle demografischen Gruppen hinweg ist.

Nutzungsvoraussetzungen

  • Dieser Benachrichtigungstyp erfordert das Braze Android SDK v15.0.0+ und Geräte mit Android 11+.
  • Nicht unterstützte Geräte oder SDKs fallen auf eine standardmäßige Push-Benachrichtigung zurück.

Dieses Feature ist nur über die Braze REST API verfügbar. Weitere Informationen finden Sie im Android-Push-Objekt.

FCM-Kontingentüberschreitungsfehler

Wenn Ihr Limit für Firebase Cloud Messaging (FCM) überschritten wird, gibt Google „Kontingent überschritten“-Fehler zurück. Das Standardlimit für FCM beträgt 600.000 Anfragen pro Minute. Braze versucht den Versand gemäß den von Google empfohlenen Best Practices erneut. Ein hohes Volumen dieser Fehler kann die Zustellzeit jedoch um mehrere Minuten verlängern. Um mögliche Auswirkungen abzumildern, sendet Braze Ihnen eine Benachrichtigung, dass das Rate-Limit überschritten wird, sowie Maßnahmen, die Sie ergreifen können, um die Fehler zu vermeiden.

Um Ihr aktuelles Limit zu überprüfen, gehen Sie zu Google Cloud Console > APIs & Services > Firebase Cloud Messaging API > Quotas & System Limits oder besuchen Sie die FCM-API-Kontingentseite.

Best Practices

Wir empfehlen die folgenden Best Practices, um das Volumen dieser Fehler gering zu halten.

Eine Rate-Limit-Erhöhung bei FCM beantragen

Um eine Rate-Limit-Erhöhung bei FCM zu beantragen, können Sie sich direkt an den Firebase Support wenden oder wie folgt vorgehen:

  1. Gehen Sie zur FCM-API-Kontingentseite.
  2. Suchen Sie das Kontingent Send requests per minute.
  3. Wählen Sie Edit Quota aus.
  4. Geben Sie einen neuen Wert ein und senden Sie Ihre Anfrage ab.

Ein Workspace-Rate-Limit anwenden

Sie können ein Workspace-Rate-Limit für Android-Push-Benachrichtigungen anwenden. Dies kann helfen, die Zustellrate Ihrer ausgehenden Nachrichten zu regulieren. Weitere Informationen finden Sie unter Workspace-Messaging-Rate-Limits.

Rate-Limits

Push-Benachrichtigungen unterliegen Rate-Limits – senden Sie also ruhig so viele, wie Ihre Anwendung benötigt. iOS und die Apple Push Notification Service (APNs)-Server steuern, wie oft sie zugestellt werden, und Sie bekommen keine Probleme, wenn Sie zu viele senden. Wenn Ihre Push-Benachrichtigungen gedrosselt werden, werden sie möglicherweise verzögert, bis das Gerät das nächste Mal ein Keep-Alive-Paket sendet oder eine andere Benachrichtigung empfängt.

Push-Benachrichtigungen einrichten

Schritt 1: APNs-Token hochladen

Bevor Sie eine iOS-Push-Benachrichtigung mit Braze senden können, müssen Sie Ihre .p8-Push-Benachrichtigungsdatei hochladen, wie in der Entwicklerdokumentation von Apple beschrieben:

  1. Gehen Sie in Ihrem Apple-Entwickler-Account zu Certificates, Identifiers & Profiles.
  2. Wählen Sie unter Keys die Option All aus und klicken Sie auf die Schaltfläche „Hinzufügen“ (+) oben auf der Seite.
  3. Geben Sie unter Key Description einen eindeutigen Namen für den Signierschlüssel ein.
  4. Aktivieren Sie unter Key Services das Kontrollkästchen Apple Push Notification service (APNs) und klicken Sie dann auf Continue. Klicken Sie auf Confirm.
  5. Notieren Sie sich die Key-ID. Klicken Sie auf Download, um den Schlüssel zu generieren und herunterzuladen. Stellen Sie sicher, dass Sie die heruntergeladene Datei an einem sicheren Ort speichern, da Sie sie nur einmal herunterladen können.
  6. Gehen Sie in Braze zu Einstellungen > App-Einstellungen und laden Sie die .p8-Datei unter Apple Push Certificate hoch. Sie können entweder Ihr Entwicklungs- oder Ihr Produktions-Push-Zertifikat hochladen. Um Push-Benachrichtigungen zu testen, nachdem Ihre App im App Store live ist, empfiehlt es sich, einen separaten Workspace für die Entwicklungsversion Ihrer App einzurichten.
  7. Wenn Sie dazu aufgefordert werden, geben Sie die Bundle-ID, die Key-ID und die Team-ID Ihrer App ein. Sie müssen außerdem angeben, ob Benachrichtigungen an die Entwicklungs- oder die Produktionsumgebung Ihrer App gesendet werden sollen. Dies wird durch das Bereitstellungsprofil Ihrer App festgelegt.
  8. Wenn Sie fertig sind, wählen Sie Speichern aus.

Schritt 2: Push-Funktionen aktivieren

Gehen Sie in Xcode zum Abschnitt Signing & Capabilities des Hauptziels Ihrer App und fügen Sie die Push-Benachrichtigungsfunktion hinzu.

Der Abschnitt „Signing & Capabilities“ in einem Xcode-Projekt.

Schritt 3: Push-Verarbeitung einrichten

Sie können das Swift SDK verwenden, um die Verarbeitung von Remote-Benachrichtigungen, die von Braze empfangen werden, zu automatisieren. Dies ist die einfachste Methode zur Verarbeitung von Push-Benachrichtigungen und die empfohlene Vorgehensweise.

Schritt 3.1: Automatisierung in der Push-Eigenschaft aktivieren

Um die automatische Push-Integration zu aktivieren, setzen Sie die Eigenschaft automation der push-Konfiguration auf true:

let configuration = Braze.Configuration(apiKey: "{YOUR-BRAZE-API-KEY}", endpoint: "{YOUR-BRAZE-API-ENDPOINT}")
configuration.push.automation = true
BRZConfiguration *configuration = [[BRZConfiguration alloc] initWithApiKey:@"{YOUR-BRAZE-API-KEY}" endpoint:@"{YOUR-BRAZE-API-ENDPOINT}"];
configuration.push.automation = [[BRZConfigurationPushAutomation alloc] initEnablingAllAutomations:YES];

Dies weist das SDK an:

  • Ihre Anwendung für Push-Benachrichtigungen beim System zu registrieren.
  • Die Push-Benachrichtigungsberechtigung bei der Initialisierung anzufordern.
  • Dynamisch Implementierungen für die systembezogenen Delegate-Methoden für Push-Benachrichtigungen bereitzustellen.

Schritt 3.2: Einzelne Konfigurationen überschreiben (optional)

Für eine feinere Steuerung kann jeder Automatisierungsschritt einzeln aktiviert oder deaktiviert werden:

// Enable all automations and disable the automatic notification authorization request at launch.
configuration.push.automation = true
configuration.push.automation.requestAuthorizationAtLaunch = false
// Enable all automations and disable the automatic notification authorization request at launch.
configuration.push.automation = [[BRZConfigurationPushAutomation alloc] initEnablingAllAutomations:YES];
configuration.push.automation.requestAuthorizationAtLaunch = NO;

Unter Braze.Configuration.Push.Automation finden Sie alle verfügbaren Optionen und unter automation weitere Informationen zum Automatisierungsverhalten.

Schritt 3.1: Für Push-Benachrichtigungen bei APNs registrieren

Fügen Sie das entsprechende Codebeispiel in die application:didFinishLaunchingWithOptions:-Delegate-Methode Ihrer App ein, damit die Geräte Ihrer Nutzer:innen sich bei APNs registrieren können. Stellen Sie sicher, dass Sie den gesamten Push-Integrationscode auf dem Hauptthread Ihrer Anwendung aufrufen.

Braze bietet außerdem standardmäßige Push-Kategorien zur Unterstützung von Push-Action-Buttons, die manuell zu Ihrem Push-Registrierungscode hinzugefügt werden müssen. Weitere Integrationsschritte finden Sie unter Push-Action-Buttons.

Fügen Sie den folgenden Code zur Methode application:didFinishLaunchingWithOptions: Ihres App-Delegates hinzu.

application.registerForRemoteNotifications()
let center = UNUserNotificationCenter.current()
center.setNotificationCategories(Braze.Notifications.categories)
center.delegate = self
var options: UNAuthorizationOptions = [.alert, .sound, .badge]
if #available(iOS 12.0, *) {
  options = UNAuthorizationOptions(rawValue: options.rawValue | UNAuthorizationOptions.provisional.rawValue)
}
center.requestAuthorization(options: options) { granted, error in
  print("Notification authorization, granted: \(granted), error: \(String(describing: error))")
}
[application registerForRemoteNotifications];
UNUserNotificationCenter *center = UNUserNotificationCenter.currentNotificationCenter;
[center setNotificationCategories:BRZNotifications.categories];
center.delegate = self;
UNAuthorizationOptions options = UNAuthorizationOptionAlert | UNAuthorizationOptionSound | UNAuthorizationOptionBadge;
if (@available(iOS 12.0, *)) {
  options = options | UNAuthorizationOptionProvisional;
}
[center requestAuthorizationWithOptions:options
                      completionHandler:^(BOOL granted, NSError *_Nullable error) {
                        NSLog(@"Notification authorization, granted: %d, "
                              @"error: %@)",
                              granted, error);
}];

Schritt 3.2: Push-Token bei Braze registrieren

Sobald die APNs-Registrierung abgeschlossen ist, übergeben Sie das resultierende deviceToken an Braze, um Push-Benachrichtigungen für die Nutzer:innen zu aktivieren.

Fügen Sie den folgenden Code zur Methode application(_:didRegisterForRemoteNotificationsWithDeviceToken:) Ihrer App hinzu:

AppDelegate.braze?.notifications.register(deviceToken: deviceToken)

Fügen Sie den folgenden Code zur Methode application:didRegisterForRemoteNotificationsWithDeviceToken: Ihrer App hinzu:

[AppDelegate.braze.notifications registerDeviceToken:deviceToken];

Schritt 3.3: Push-Verarbeitung aktivieren

Leiten Sie als Nächstes die empfangenen Push-Benachrichtigungen an Braze weiter. Dieser Schritt ist für das Protokollieren von Push-Analytics und die Link-Verarbeitung notwendig. Stellen Sie sicher, dass Sie den gesamten Push-Integrationscode auf dem Hauptthread Ihrer Anwendung aufrufen.

Standardmäßige Push-Verarbeitung

Um die standardmäßige Push-Verarbeitung von Braze zu aktivieren, fügen Sie den folgenden Code zur Methode application(_:didReceiveRemoteNotification:fetchCompletionHandler:) Ihrer App hinzu:

if let braze = AppDelegate.braze, braze.notifications.handleBackgroundNotification(
  userInfo: userInfo,
  fetchCompletionHandler: completionHandler
) {
  return
}
completionHandler(.noData)

Fügen Sie als Nächstes den folgenden Code zur Methode userNotificationCenter(_:didReceive:withCompletionHandler:) Ihrer App hinzu:

if let braze = AppDelegate.braze, braze.notifications.handleUserNotification(
  response: response,
  withCompletionHandler: completionHandler
) {
  return
}
completionHandler()

Um die standardmäßige Push-Verarbeitung von Braze zu aktivieren, fügen Sie den folgenden Code zur Methode application:didReceiveRemoteNotification:fetchCompletionHandler: Ihrer Anwendung hinzu:

BOOL processedByBraze = AppDelegate.braze != nil && [AppDelegate.braze.notifications handleBackgroundNotificationWithUserInfo:userInfo
                                                                                                       fetchCompletionHandler:completionHandler];
if (processedByBraze) {
  return;
}

completionHandler(UIBackgroundFetchResultNoData);

Fügen Sie als Nächstes den folgenden Code zur Methode (void)userNotificationCenter:didReceiveNotificationResponse:withCompletionHandler: Ihrer App hinzu:

BOOL processedByBraze = AppDelegate.braze != nil && [AppDelegate.braze.notifications handleUserNotificationWithResponse:response
                                                                                                  withCompletionHandler:completionHandler];
if (processedByBraze) {
  return;
}

completionHandler();
Vordergrund-Push-Verarbeitung

Um Vordergrund-Push-Benachrichtigungen zu aktivieren und Braze deren Empfang erkennen zu lassen, implementieren Sie UNUserNotificationCenter.userNotificationCenter(_:willPresent:withCompletionHandler:). Wenn Nutzer:innen auf Ihre Vordergrund-Benachrichtigung tippen, wird der Push-Delegate userNotificationCenter(_:didReceive:withCompletionHandler:) aufgerufen und Braze protokolliert das Push-Klick-Ereignis.

func userNotificationCenter(
  _ center: UNUserNotificationCenter,
  willPresent notification: UNNotification,
  withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions
) -> Void) {
  if let braze = AppDelegate.braze {
    // Forward notification payload to Braze for processing.
    braze.notifications.handleForegroundNotification(notification: notification)
  }

  // Configure application's foreground notification display options.
  if #available(iOS 14.0, *) {
    completionHandler([.list, .banner])
  } else {
    completionHandler([.alert])
  }
}

Um Vordergrund-Push-Benachrichtigungen zu aktivieren und Braze deren Empfang erkennen zu lassen, implementieren Sie userNotificationCenter:willPresentNotification:withCompletionHandler:. Wenn Nutzer:innen auf Ihre Vordergrund-Benachrichtigung tippen, wird der Push-Delegate userNotificationCenter:didReceiveNotificationResponse:withCompletionHandler: aufgerufen und Braze protokolliert das Push-Klick-Ereignis.

- (void)userNotificationCenter:(UNUserNotificationCenter *)center
       willPresentNotification:(UNNotification *)notification
         withCompletionHandler:(void (^)(UNNotificationPresentationOptions options))completionHandler {
  if (AppDelegate.braze != nil) {
    // Forward notification payload to Braze for processing.
    [AppDelegate.braze.notifications handleForegroundNotificationWithNotification:notification];
  }

  // Configure application's foreground notification display options.
  if (@available(iOS 14.0, *)) {
    completionHandler(UNNotificationPresentationOptionList | UNNotificationPresentationOptionBanner);
  } else {
    completionHandler(UNNotificationPresentationOptionAlert);
  }
}

Benachrichtigungen testen

Wenn Sie In-App- und Push-Benachrichtigungen über die Befehlszeile testen möchten, können Sie über CURL und die Messaging-API eine einzelne Benachrichtigung über das Terminal senden. Sie müssen die folgenden Felder durch die richtigen Werte für Ihren Testfall ersetzen:

  • YOUR_API_KEY – verfügbar unter Einstellungen > API-Schlüssel.
  • YOUR_EXTERNAL_USER_ID – verfügbar auf der Seite Nutzer:innen suchen. Weitere Informationen finden Sie unter Nutzer-IDs zuweisen.
  • YOUR_KEY1 (optional)
  • YOUR_VALUE1 (optional)

Im folgenden Beispiel wird die Instanz US-01 verwendet. Wenn Sie sich nicht auf dieser Instanz befinden, sehen Sie in unserer API-Dokumentation nach, an welchen Endpunkt Sie Anfragen stellen müssen.

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer {YOUR_API_KEY}" -d '{
  "external_user_ids":["YOUR_EXTERNAL_USER_ID"],
  "messages": {
    "apple_push": {
      "alert":"Test push",
      "extra": {
        "YOUR_KEY1":"YOUR_VALUE1"
      }
    }
  }
}' https://rest.iad-01.braze.com/messages/send

Push-Benachrichtigungs-Updates abonnieren

Um auf die von Braze verarbeiteten Push-Benachrichtigungs-Payloads zuzugreifen, verwenden Sie die Methode Braze.Notifications.subscribeToUpdates(payloadTypes:_:).

Sie können den Parameter payloadTypes verwenden, um festzulegen, ob Sie Benachrichtigungen zu Push-Öffnungsereignissen, Push-Empfangsereignissen oder beidem abonnieren möchten.

// This subscription is maintained through a Braze cancellable, which will observe for changes until the subscription is cancelled.
// You must keep a strong reference to the cancellable to keep the subscription active.
// The subscription is canceled either when the cancellable is deinitialized or when you call its `.cancel()` method.
let cancellable = AppDelegate.braze?.notifications.subscribeToUpdates(payloadTypes: [.open, .received]) { payload in
  print("Braze processed notification with title '\(payload.title)' and body '\(payload.body)'")
}
NSInteger filtersValue = BRZNotificationsPayloadTypeFilter.opened.rawValue | BRZNotificationsPayloadTypeFilter.received.rawValue;
BRZNotificationsPayloadTypeFilter *filters = [[BRZNotificationsPayloadTypeFilter alloc] initWithRawValue: filtersValue];
BRZCancellable *cancellable = [notifications subscribeToUpdatesWithPayloadTypes:filters update:^(BRZNotificationsPayload * _Nonnull payload) {
  NSLog(@"Braze processed notification with title '%@' and body '%@'", payload.title, payload.body);
}];

Verarbeitung von Benachrichtigungen im Vordergrund

Standardmäßig zeigt iOS eine Push-Benachrichtigung nicht automatisch an, wenn sie eintrifft, während Ihre App im Vordergrund ist. Um Push-Benachrichtigungen im Vordergrund anzuzeigen und mit Braze-Analytics zu verfolgen, rufen Sie die Methode handleForegroundNotification(notification:) innerhalb Ihrer UNUserNotificationCenterDelegate.userNotificationCenter(_:willPresent:withCompletionHandler:)-Implementierung auf.

So funktioniert es

Wenn Sie handleForegroundNotification(notification:) aufrufen, verarbeitet Braze den Benachrichtigungs-Payload, um Analytics zu protokollieren und Deeplinks oder Button-Aktionen zu verarbeiten. Das tatsächliche Anzeigeverhalten wird durch die UNNotificationPresentationOptions gesteuert, die Sie an den Completion-Handler übergeben.

import BrazeKit
import UserNotifications

extension AppDelegate: UNUserNotificationCenterDelegate {
  func userNotificationCenter(
    _ center: UNUserNotificationCenter,
    willPresent notification: UNNotification,
    withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void
  ) {
    // Let Braze process the notification payload
    if let braze = AppDelegate.braze {
      braze.notifications.handleForegroundNotification(notification: notification)
    }

    // Control how the notification appears in the foreground
    if #available(iOS 14.0, *) {
      completionHandler([.banner, .list, .sound])
    } else {
      completionHandler([.alert, .sound])
    }
  }
}

Ein vollständiges Beispiel finden Sie im Beispiel zur manuellen Integration von Push-Benachrichtigungen im Braze Swift SDK Repository.

Push-Primer

Push-Primer-Campaigns ermutigen Ihre Nutzer:innen, Push-Benachrichtigungen auf ihrem Gerät für Ihre App zu aktivieren. Dies kann ohne SDK-Anpassung mit unserem No-Code-Push-Primer umgesetzt werden.

Dynamische APNs-Gateway-Verwaltung

Die dynamische Verwaltung des Apple Push Notification Service (APNs)-Gateways verbessert die Zuverlässigkeit und Effizienz von iOS-Push-Benachrichtigungen, indem sie die richtige APNs-Umgebung automatisch erkennt. Bisher mussten Sie APNs-Umgebungen (Entwicklung oder Produktion) für Ihre Push-Benachrichtigungen manuell auswählen, was manchmal zu fehlerhaften Gateway-Konfigurationen, Zustellungsfehlern und BadDeviceToken-Fehlern führte.

Mit der dynamischen APNs-Gateway-Verwaltung profitieren Sie von:

  • Verbesserter Zuverlässigkeit: Benachrichtigungen werden immer an die richtige APNs-Umgebung zugestellt, wodurch fehlgeschlagene Zustellungen reduziert werden.
  • Vereinfachter Konfiguration: Sie müssen APNs-Gateway-Einstellungen nicht mehr manuell verwalten.
  • Fehlerresilienz: Ungültige oder fehlende Gateway-Werte werden zuverlässig behandelt und gewährleisten einen unterbrechungsfreien Dienst.

Voraussetzungen

Braze unterstützt die dynamische APNs-Gateway-Verwaltung für Push-Benachrichtigungen auf iOS mit der folgenden SDK-Versionsanforderung:

So funktioniert es

Wenn eine iOS-App mit dem Braze Swift SDK integriert wird, sendet sie gerätebezogene Daten, einschließlich aps-environment, an die Braze SDK API, sofern verfügbar. Der apns_gateway-Wert gibt an, ob die App die Entwicklungs- (dev) oder Produktions- (prod) APNs-Umgebung verwendet.

Braze speichert außerdem den gemeldeten Gateway-Wert für jedes Gerät. Wenn ein neuer, gültiger Gateway-Wert empfangen wird, aktualisiert Braze den gespeicherten Wert automatisch.

Wenn Braze eine Push-Benachrichtigung sendet:

  • Wenn ein gültiger Gateway-Wert (dev oder prod) für das Gerät gespeichert ist, verwendet Braze diesen, um die richtige APNs-Umgebung zu bestimmen.
  • Wenn kein Gateway-Wert gespeichert ist, greift Braze auf die in den App-Einstellungen konfigurierte APNs-Umgebung zurück.

Häufig gestellte Fragen

Warum wurde dieses Feature eingeführt?

Mit der dynamischen APNs-Gateway-Verwaltung wird die richtige Umgebung automatisch ausgewählt. Zuvor mussten Sie das APNs-Gateway manuell konfigurieren, was zu BadDeviceToken-Fehlern, Token-Invalidierung und potenziellen APNs-Rate-Limiting-Problemen führen konnte.

Wie wirkt sich dies auf die Push-Zustellungs-Performance aus?

Dieses Feature verbessert die Zustellungsraten, indem Push-Token immer an die richtige APNs-Umgebung weitergeleitet werden und Fehler durch falsch konfigurierte Gateways vermieden werden.

Kann ich dieses Feature deaktivieren?

Die dynamische APNs-Gateway-Verwaltung ist standardmäßig aktiviert und bietet Verbesserungen der Zuverlässigkeit. Wenn Sie spezielle Anwendungsfälle haben, die eine manuelle Gateway-Auswahl erfordern, wenden Sie sich an den Braze-Support.

Über Push-Benachrichtigungen für Android TV

Illustration eines Android-TV-Geräts für die Anleitung zu Android-TV-Push-Benachrichtigungen.

Obwohl es sich nicht um ein natives Feature handelt, wird die Android-TV-Push-Integration durch die Nutzung des Braze Android SDK und Firebase Cloud Messaging ermöglicht, um ein Push-Token für Android TV zu registrieren. Sie müssen jedoch eine UI erstellen, um den Benachrichtigungs-Payload nach dem Empfang anzuzeigen.

Voraussetzungen

Um dieses Feature zu nutzen, müssen Sie Folgendes abschließen:

Push-Benachrichtigungen einrichten

So richten Sie Push-Benachrichtigungen für Android TV ein:

  1. Erstellen Sie eine angepasste Ansicht in Ihrer App, um Ihre Benachrichtigungen anzuzeigen.
  2. Erstellen Sie eine angepasste Benachrichtigungs-Factory. Dies überschreibt das Standardverhalten des SDK und ermöglicht es Ihnen, die Benachrichtigungen manuell anzuzeigen. Durch die Rückgabe von null wird verhindert, dass das SDK die Benachrichtigung verarbeitet, und es ist angepasster Code erforderlich, um die Benachrichtigung anzuzeigen. Nach Abschluss dieser Schritte können Sie Push-Benachrichtigungen an Android TV senden.

  3. (Optional) Um Klick-Analytics effektiv zu tracken, richten Sie Klick-Analytics-Tracking ein. Dies kann durch die Erstellung eines Push-Callbacks erreicht werden, der auf Braze-Push-Opened- und -Received-Intents lauscht.

Android-TV-Push-Benachrichtigungen testen

Um zu testen, ob Ihre Push-Implementierung erfolgreich ist, senden Sie eine Benachrichtigung über das Braze-Dashboard, wie Sie es normalerweise für ein Android-Gerät tun würden.

  • Wenn die Anwendung geschlossen ist: Die Push-Nachricht wird als Toast-Benachrichtigung auf dem Bildschirm angezeigt.
  • Wenn die Anwendung geöffnet ist: Sie haben die Möglichkeit, die Nachricht in Ihrer eigenen gehosteten UI anzuzeigen. Orientieren Sie sich am UI-Styling der In-App-Nachrichten des Android Mobile SDK.

Best Practices

Für Marketer, die Braze verwenden, ist das Starten einer Campaign für Android TV identisch mit dem Starten eines Push an Android-Mobile-Apps. Um diese Geräte exklusiv anzusprechen, wählen Sie die Android-TV-App in der Segmentierung aus.

Die von FCM zurückgegebene Antwort zu Zustellung und Klicks folgt derselben Konvention wie bei einem mobilen Android-Gerät; daher sind alle Fehler in Messaging Observability sichtbar.

Voraussetzungen

Bevor Sie dieses Feature nutzen können, müssen Sie das Cordova Braze SDK integrieren. Nach der Integration des SDK sind die grundlegenden Funktionen für Push-Benachrichtigungen standardmäßig aktiviert. Um Rich-Push-Benachrichtigungen und Push Stories zu verwenden, müssen Sie sie einzeln einrichten. Um iOS-Push-Nachrichten zu verwenden, müssen Sie außerdem ein gültiges Push-Zertifikat hochladen.

Deeplinking für Push-Benachrichtigungen aktivieren

Standardmäßig verarbeitet das Braze Cordova SDK Deeplinks aus Push-Benachrichtigungen nicht automatisch. Um Deeplinking für Push-Benachrichtigungen zu aktivieren, folgen Sie den Konfigurationsschritten unter Deeplinking. Weitere Details zu diesen und anderen Push-Konfigurationsoptionen finden Sie unter Optionale Konfigurationen.

Einfache Push-Benachrichtigungen deaktivieren (nur iOS)

Nach der Integration des Braze Cordova SDK für iOS ist die grundlegende Funktionalität für Push-Benachrichtigungen standardmäßig aktiviert. Um diese Funktionalität in Ihrer iOS-App zu deaktivieren, fügen Sie Folgendes zu Ihrer config.xml-Datei hinzu. Weitere Informationen finden Sie unter Optionale Konfigurationen.

<platform name="ios">
    <preference name="com.braze.ios_disable_automatic_push_registration" value="NO" />
    <preference name="com.braze.ios_disable_automatic_push_handling" value="NO" />
</platform>

Voraussetzungen

Bevor Sie dieses Feature nutzen können, müssen Sie das Flutter Braze SDK integrieren.

Push-Benachrichtigungen einrichten

Schritt 1: Ersteinrichtung abschließen

Schritt 1.1: Für Push registrieren

Registrieren Sie sich für Push über die Firebase Cloud Messaging (FCM) API von Google. Eine vollständige Anleitung finden Sie in den folgenden Schritten aus dem nativen Android-Push-Integrationsleitfaden:

  1. Firebase zu Ihrem Projekt hinzufügen.
  2. Cloud Messaging zu Ihren Abhängigkeiten hinzufügen.
  3. Ein Dienstkonto erstellen.
  4. JSON-Zugangsdaten generieren.
  5. Ihre JSON-Zugangsdaten in Braze hochladen.

Schritt 1.2: Ihre Google-Sender-ID abrufen

Öffnen Sie zunächst die Firebase Console, öffnen Sie Ihr Projekt und wählen Sie dann  Settings > Project settings.

Das Firebase-Projekt mit geöffnetem Menü „Settings“.

Wählen Sie Cloud Messaging und kopieren Sie unter Firebase Cloud Messaging API (V1) die Sender ID in Ihre Zwischenablage.

Die Seite „Cloud Messaging“ des Firebase-Projekts mit hervorgehobener „Sender ID“.

Schritt 1.3: Ihre braze.xml aktualisieren

Fügen Sie Folgendes zu Ihrer braze.xml-Datei hinzu. Ersetzen Sie FIREBASE_SENDER_ID durch die zuvor kopierte Sender-ID.

<bool translatable="false" name="com_braze_firebase_cloud_messaging_registration_enabled">true</bool>
<string translatable="false" name="com_braze_firebase_cloud_messaging_sender_id">FIREBASE_SENDER_ID</string>

Schritt 1.1: APNs-Zertifikate hochladen

Generieren Sie ein Apple Push Notification Service (APNs)-Zertifikat und laden Sie es in das Braze-Dashboard hoch. Eine vollständige Anleitung finden Sie unter Ihr APNs-Zertifikat hochladen.

Schritt 1.2: Push-Benachrichtigungsunterstützung zu Ihrer App hinzufügen

Folgen Sie dem nativen iOS-Integrationsleitfaden.

Schritt 2: Auf Push-Benachrichtigungsereignisse lauschen (optional)

Um auf Push-Benachrichtigungsereignisse zu lauschen, die Braze erkannt und verarbeitet hat, rufen Sie subscribeToPushNotificationEvents() auf und übergeben Sie ein Argument zur Ausführung.

// Create stream subscription
StreamSubscription pushEventsStreamSubscription;

pushEventsStreamSubscription = braze.subscribeToPushNotificationEvents((BrazePushEvent pushEvent) {
  print("Push Notification event of type ${pushEvent.payloadType} seen. Title ${pushEvent.title}\n and deeplink ${pushEvent.url}");
  // Handle push notification events
});

// Cancel stream subscription
pushEventsStreamSubscription.cancel();

Felder von Push-Benachrichtigungsereignissen

Eine vollständige Liste der Push-Benachrichtigungsfelder finden Sie in der folgenden Tabelle:

Feldname Typ Beschreibung
payloadType String Gibt den Benachrichtigungs-Payload-Typ an. Die beiden Werte, die vom Braze Flutter SDK gesendet werden, sind push_opened und push_received. Unter iOS werden nur push_opened-Ereignisse unterstützt.
url String Gibt die URL an, die durch die Benachrichtigung geöffnet wurde.
useWebview Boolean Wenn true, wird die URL in der App in einem modalen Webview geöffnet. Wenn false, wird die URL im Gerätebrowser geöffnet.
title String Stellt den Titel der Benachrichtigung dar.
body String Stellt den Inhalt oder Textinhalt der Benachrichtigung dar.
summaryText String Stellt den Zusammenfassungstext der Benachrichtigung dar. Wird unter iOS von subtitle zugeordnet.
badgeCount Number Stellt den Badge-Zähler der Benachrichtigung dar.
timestamp Number Stellt den Zeitpunkt dar, zu dem der Payload von der Anwendung empfangen wurde.
isSilent Boolean Wenn true, wird der Payload still empfangen. Details zum Senden stiller Android-Push-Benachrichtigungen finden Sie unter Stille Push-Benachrichtigungen auf Android. Details zum Senden stiller iOS-Push-Benachrichtigungen finden Sie unter Stille Push-Benachrichtigungen auf iOS.
isBrazeInternal Boolean Dies ist true, wenn ein Benachrichtigungs-Payload für ein internes SDK-Feature gesendet wurde, z. B. Feature-Flag-Synchronisierung oder Uninstall-Tracking. Der Payload wird für Nutzer:innen still empfangen.
imageUrl String Gibt die mit der Benachrichtigung verknüpfte Bild-URL an.
brazeProperties Object Stellt die mit der Campaign verknüpften Braze-Eigenschaften dar (Schlüssel-Wert-Paare).
ios Object Stellt iOS-spezifische Felder dar.
android Object Stellt Android-spezifische Felder dar.

Schritt 3: Anzeige von Push-Benachrichtigungen testen

Um Ihre Integration nach der Konfiguration von Push-Benachrichtigungen in der nativen Schicht zu testen:

  1. Legen Sie eine:n aktive:n Nutzer:in in der Flutter-Anwendung fest. Initialisieren Sie dazu Ihr Plugin, indem Sie braze.changeUser('your-user-id') aufrufen.
  2. Navigieren Sie zu Campaigns und erstellen Sie eine neue Push-Benachrichtigungs-Campaign. Wählen Sie die Plattformen aus, die Sie testen möchten.
  3. Verfassen Sie Ihre Testbenachrichtigung und wechseln Sie zum Tab Test. Fügen Sie dieselbe user-id als Testnutzer:in hinzu und klicken Sie auf Send Test.
  4. Sie sollten die Benachrichtigung in Kürze auf Ihrem Gerät erhalten. Möglicherweise müssen Sie im Notification Center nachsehen oder die Einstellungen aktualisieren, wenn sie nicht angezeigt wird.

Um Braze zu ermöglichen, Ihre App und alle Deeplinks automatisch zu öffnen, wenn auf eine Push-Benachrichtigung getippt wird, setzen Sie com_braze_handle_push_deep_links_automatically in Ihrer braze.xml auf true:

<bool name="com_braze_handle_push_deep_links_automatically">true</bool>

Dieses Flag kann auch über die Laufzeitkonfiguration in Ihrem nativen Android-Code gesetzt werden:

val brazeConfig = BrazeConfig.Builder()
        .setHandlePushDeepLinksAutomatically(true)
        .build()
Braze.configure(this, brazeConfig)

Wenn Sie Deeplinks stattdessen benutzerdefiniert verarbeiten möchten, verwenden Sie den in Schritt 2 beschriebenen subscribeToPushNotificationEvents()-Listener, um das url-Feld des push_opened-Ereignisses selbst weiterzuleiten. Weitere Informationen finden Sie unter Deeplinking.

Voraussetzungen

Bevor Sie dieses Feature nutzen können, müssen Sie das Android Braze SDK integrieren.

Push-Benachrichtigungen einrichten

Neuere Telefone von Huawei sind mit Huawei Mobile Services (HMS) ausgestattet – einem Dienst, der anstelle von Googles Firebase Cloud Messaging (FCM) für die Zustellung von Push-Benachrichtigungen verwendet wird.

Schritt 1: Registrieren Sie sich für ein Huawei-Entwicklerkonto

Bevor Sie beginnen, müssen Sie ein Huawei-Entwicklerkonto registrieren und einrichten. Gehen Sie in Ihrem Huawei-Konto zu My Projects > Project Settings > App Information und notieren Sie sich die App ID und das App secret.

Seite mit App-Informationen in der Huawei-Entwicklungskonsole, die App-ID und App-Secret anzeigt.

Schritt 2: Erstellen Sie eine neue Huawei-App im Braze-Dashboard

Gehen Sie im Braze-Dashboard zu App Settings, das in der Settings-Navigation aufgeführt ist.

Klicken Sie auf + Add App, geben Sie einen Namen ein (z. B. „My Huawei App“) und wählen Sie Android als Plattform aus.

Braze-Dialog „Add App“ zum Erstellen einer Android-Huawei-App.

Sobald Ihre neue Braze-App erstellt wurde, suchen Sie die Push-Benachrichtigungseinstellungen und wählen Sie Huawei als Push-Anbieter aus. Geben Sie anschließend Ihr Huawei Client Secret und Ihre Huawei App ID ein.

Braze-Push-Anbietereinstellungen für Huawei mit Feldern für Huawei-App-ID und Client-Secret.

Schritt 3: Integrieren Sie das Huawei-Messaging-SDK in Ihre App

Huawei stellt ein Android-Integrations-Codelab bereit, das die Integration des Huawei-Messaging-Dienstes in Ihre Anwendung beschreibt. Folgen Sie diesen Schritten, um zu beginnen.

Nach Abschluss des Codelabs müssen Sie einen benutzerdefinierten Huawei Message Service erstellen, um Push-Token zu erhalten und Nachrichten an das Braze SDK weiterzuleiten.

public class CustomPushService extends HmsMessageService {
  @Override
  public void onNewToken(String token) {
    super.onNewToken(token);
    Braze.getInstance(this.getApplicationContext()).setRegisteredPushToken(token);
  }

  @Override
  public void onMessageReceived(RemoteMessage remoteMessage) {
    super.onMessageReceived(remoteMessage);
    if (BrazeHuaweiPushHandler.handleHmsRemoteMessageData(this.getApplicationContext(), remoteMessage.getDataOfMap())) {
      // Braze has handled the Huawei push notification
    }
  }
}
class CustomPushService: HmsMessageService() {
  override fun onNewToken(token: String?) {
    super.onNewToken(token)
    Braze.getInstance(applicationContext).setRegisteredPushToken(token!!)
  }

  override fun onMessageReceived(hmsRemoteMessage: RemoteMessage?) {
    super.onMessageReceived(hmsRemoteMessage)
    if (BrazeHuaweiPushHandler.handleHmsRemoteMessageData(applicationContext, hmsRemoteMessage?.dataOfMap)) {
      // Braze has handled the Huawei push notification
    }
  }
}

Nachdem Sie Ihren benutzerdefinierten Push-Dienst hinzugefügt haben, fügen Sie Folgendes zu Ihrer AndroidManifest.xml hinzu:

<service
  android:name="package.of.your.CustomPushService"
  android:exported="false">
  <intent-filter>
    <action android:name="com.huawei.push.action.MESSAGING_EVENT" />
  </intent-filter>
</service>

Schritt 4: Vordergrund-Benachrichtigungen verarbeiten

Standardmäßig zeigt Huawei eine Push-Benachrichtigung automatisch an, wenn sie eintrifft, während Ihre App im Vordergrund ist. Damit Braze den Payload der Push-Benachrichtigung verarbeiten kann (für Analytics-Tracking, Deeplink-Verarbeitung und benutzerdefinierte Verarbeitung), leiten Sie die eingehenden Push-Daten in Ihrer HmsMessageService.onMessageReceived-Methode an Braze weiter.

Wenn Sie BrazeHuaweiPushHandler.handleHmsRemoteMessageData aufrufen, ermittelt Braze, ob der Payload eine Braze-Push-Benachrichtigung ist, und erstellt und zeigt die Benachrichtigung gegebenenfalls an. Weitere Informationen finden Sie unter Vordergrund-Benachrichtigungen verarbeiten in der Android-Push-Benachrichtigungsdokumentation.

Ein vollständiges Beispiel finden Sie in der Huawei-Handler-Referenz in der Braze Android SDK-Dokumentation.

Schritt 5: Push-Benachrichtigungen testen (optional)

An diesem Punkt haben Sie eine neue Huawei-Android-App im Braze-Dashboard erstellt, sie mit Ihren Huawei-Entwickler-Zugangsdaten konfiguriert und die Braze- und Huawei-SDKs in Ihre App integriert.

Als Nächstes können wir die Integration testen, indem wir eine neue Push-Campaign in Braze ausprobieren.

Schritt 5.1: Eine neue Push-Benachrichtigungs-Campaign erstellen

Erstellen Sie auf der Campaigns-Seite eine neue Campaign und wählen Sie Push Notification als Nachrichtentyp.

Nachdem Sie Ihre Campaign benannt haben, wählen Sie Android Push als Push-Plattform aus.

Der Campaign-Erstellungs-Composer mit den verfügbaren Push-Plattformen.

Verfassen Sie anschließend Ihre Push-Campaign mit einem Titel und einer Nachricht.

Schritt 5.2: Einen Test-Push senden

Geben Sie im Tab Test Ihre Nutzer-ID ein, die Sie in Ihrer App mit der changeUser(USER_ID_STRING)-Methode festgelegt haben, und klicken Sie auf Send Test, um einen Test-Push zu senden.

Der Test-Tab im Campaign-Erstellungs-Composer zeigt, dass Sie eine Testnachricht an sich selbst senden können, indem Sie Ihre Nutzer-ID eingeben und sie in das Feld „Add Individual Users“ eintragen.

An diesem Punkt sollten Sie eine Test-Push-Benachrichtigung auf Ihrem Huawei-Gerät (HMS) von Braze erhalten.

Schritt 5.3: Huawei-Segmentierung einrichten (optional)

Da Ihre Huawei-App im Braze-Dashboard auf der Android-Push-Plattform basiert, haben Sie die Flexibilität, Push-Benachrichtigungen an alle Android-Nutzer:innen (Firebase Cloud Messaging und Huawei Mobile Services) zu senden, oder Sie können Ihre Campaign-Zielgruppe auf bestimmte Apps segmentieren.

Um Push-Benachrichtigungen nur an Huawei-Apps zu senden, erstellen Sie ein neues Segment und wählen Sie Ihre Huawei-App im Abschnitt Apps aus.

Braze-Segment-App-Filter mit ausgewählter Huawei-App für das Push-Targeting.

Wenn Sie denselben Push an alle Android-Push-Anbieter senden möchten, können Sie natürlich auch darauf verzichten, die App anzugeben, wodurch der Push an alle Android-Apps gesendet wird, die im aktuellen Workspace konfiguriert sind.

Voraussetzungen

Bevor Sie dieses Feature nutzen können, müssen Sie das React Native Braze SDK integrieren.

Push-Benachrichtigungen einrichten

1. Schritt: Ersteinrichtung abschließen

Voraussetzungen

Bevor Sie Expo für Push-Benachrichtigungen verwenden können, müssen Sie das Braze Expo Plugin einrichten.

Schritt 1.1: Ihre app.json-Datei aktualisieren

Aktualisieren Sie als Nächstes Ihre app.json-Datei für Android und iOS:

  • Android: Fügen Sie die Option enableFirebaseCloudMessaging hinzu.
  • iOS: Fügen Sie die Option enableBrazeIosPush hinzu.

Schritt 1.2: Ihre Google-Absender-ID hinzufügen

Gehen Sie zunächst zur Firebase-Konsole, öffnen Sie Ihr Projekt und wählen Sie dann  Settings > Project settings.

Das Firebase-Projekt mit geöffnetem Menü „Settings“.

Wählen Sie Cloud Messaging und kopieren Sie dann unter Firebase Cloud Messaging API (V1) die Sender ID in Ihre Zwischenablage.

Die Seite „Cloud Messaging“ des Firebase-Projekts mit hervorgehobener „Sender ID“.

Öffnen Sie als Nächstes die Datei app.json Ihres Projekts und setzen Sie die Eigenschaft firebaseCloudMessagingSenderId auf die Sender ID in Ihrer Zwischenablage. Zum Beispiel:

"firebaseCloudMessagingSenderId": "693679403398"

Schritt 1.3: Den Pfad zu Ihrer Google Services JSON hinzufügen

Fügen Sie in der Datei app.json Ihres Projekts den Pfad zu Ihrer google-services.json-Datei hinzu. Diese Datei wird benötigt, wenn Sie enableFirebaseCloudMessaging: true in Ihrer Konfiguration festlegen.

{
  "expo": {
    "android": {
      "googleServicesFile": "PATH_TO_GOOGLE_SERVICES"
    },
    "plugins": [
      [
        "@braze/expo-plugin",
        {
          "androidApiKey": "YOUR-ANDROID-API-KEY",
          "iosApiKey": "YOUR-IOS-API-KEY",
          "enableBrazeIosPush": true,
          "enableFirebaseCloudMessaging": true,
          "firebaseCloudMessagingSenderId": "YOUR-FCM-SENDER-ID",
          "androidHandlePushDeepLinksAutomatically": true
        }
      ],
    ]
  }
}

Beachten Sie, dass Sie diese Einstellungen anstelle der nativen Einrichtungsanweisungen verwenden müssen, wenn Sie auf zusätzliche Push-Benachrichtigungsbibliotheken wie Expo Notifications angewiesen sind.

Wenn Sie das Braze Expo Plugin nicht verwenden oder diese Einstellungen stattdessen nativ konfigurieren möchten, registrieren Sie sich für Push anhand der Anleitung zur nativen Android-Push-Integration.

Wenn Sie das Braze Expo Plugin nicht verwenden oder diese Einstellungen stattdessen nativ konfigurieren möchten, registrieren Sie sich für Push, indem Sie die folgenden Schritte aus der Anleitung zur nativen iOS-Push-Integration befolgen:

Schritt 1.1: Push-Berechtigungen anfordern

Wenn Sie nicht vorhaben, Push-Berechtigungen beim Start der App anzufordern, lassen Sie den Aufruf requestAuthorizationWithOptions:completionHandler: in Ihrem AppDelegate weg. Fahren Sie dann mit Schritt 2 fort. Andernfalls folgen Sie der nativen iOS-Integrationsanleitung.

Schritt 1.2 (optional): Push-Schlüssel migrieren

Wenn Sie zuvor expo-notifications zur Verwaltung Ihres Push-Schlüssels verwendet haben, führen Sie expo fetch:ios:certs aus dem Stammordner Ihrer Anwendung aus. Dadurch wird Ihr Push-Schlüssel (eine .p8-Datei) heruntergeladen, der dann in das Braze-Dashboard hochgeladen werden kann.

2. Schritt: Berechtigung für Push-Benachrichtigungen anfordern

Verwenden Sie die Methode Braze.requestPushPermission() (verfügbar ab v1.38.0), um die Berechtigung für Push-Benachrichtigungen von Nutzer:innen unter iOS und Android 13+ anzufordern. Bei Android 12 und älter hat diese Methode keine Auswirkung.

Diese Methode erwartet einen erforderlichen Parameter, der angibt, welche Berechtigungen das SDK unter iOS von den Nutzer:innen anfordern soll. Diese Optionen haben keine Auswirkungen auf Android.

const permissionOptions = {
  alert: true,
  sound: true,
  badge: true,
  provisional: false
};

Braze.requestPushPermission(permissionOptions);

Schritt 2.1: Auf Push-Benachrichtigungen lauschen (optional)

Sie können zusätzlich Ereignisse abonnieren, bei denen Braze eine eingehende Push-Benachrichtigung erkannt und verarbeitet hat. Verwenden Sie den Listener-Schlüssel Braze.Events.PUSH_NOTIFICATION_EVENT.

Braze.addListener(Braze.Events.PUSH_NOTIFICATION_EVENT, data => {
  console.log(`Push Notification event of type ${data.payload_type} seen. Title ${data.title}\n and deeplink ${data.url}`);
  console.log(JSON.stringify(data, undefined, 2));
});
Ereignisfelder für Push-Benachrichtigungen

Eine vollständige Liste der Felder für Push-Benachrichtigungen finden Sie in der folgenden Tabelle:

Feldname Typ Beschreibung
payload_type String Gibt den Nutzlasttyp der Benachrichtigung an. Die beiden Werte, die vom Braze React Native SDK gesendet werden, sind push_opened und push_received.
url String Gibt die URL an, die durch die Benachrichtigung geöffnet wurde.
use_webview Boolescher Wert Wenn true, wird die URL in der App in einer modalen Webansicht geöffnet. Wenn false, wird die URL im Browser des Geräts geöffnet.
title String Stellt den Titel der Benachrichtigung dar.
body String Stellt den Textkörper oder Inhalt der Benachrichtigung dar.
summary_text String Stellt den zusammenfassenden Text der Benachrichtigung dar. Dieser wird unter iOS aus subtitle zugeordnet.
badge_count Zahl Stellt die Badge-Anzahl der Benachrichtigung dar.
timestamp Zahl Stellt den Zeitpunkt dar, zu dem die Nutzlast von der Anwendung empfangen wurde.
is_silent Boolescher Wert Wenn true, wird die Nutzlast still empfangen. Einzelheiten zum Senden von stillen Push-Benachrichtigungen unter Android finden Sie unter Stille Push-Benachrichtigungen unter Android. Einzelheiten zum Senden von stillen Push-Benachrichtigungen unter iOS finden Sie unter Stille Push-Benachrichtigungen unter iOS.
is_braze_internal Boolescher Wert Dies ist true, wenn eine Benachrichtigungsnutzlast für eine interne SDK-Funktion gesendet wurde, wie z. B. die Synchronisierung von Feature-Flags oder das Uninstall-Tracking. Die Nutzlast wird für die Nutzer:innen unbemerkt empfangen.
image_url String Gibt die URL an, die mit dem Benachrichtigungsbild verknüpft ist.
braze_properties Objekt Stellt die mit der Campaign verbundenen Braze-Eigenschaften dar (Schlüssel-Wert-Paare).
ios Objekt Stellt iOS-spezifische Felder dar.
android Objekt Stellt Android-spezifische Felder dar.

3. Schritt: Deeplinking aktivieren (optional)

Um Braze in die Lage zu versetzen, Deeplinks innerhalb von React-Komponenten zu verarbeiten, wenn auf eine Push-Benachrichtigung geklickt wird, implementieren Sie zunächst die Schritte, die in der Bibliothek React Native Linking beschrieben sind, oder verwenden Sie die Lösung Ihrer Wahl. Folgen Sie dann den weiteren Schritten unten.

Weitere Informationen zu Deeplinks finden Sie in unserem FAQ-Artikel.

Wenn Sie das Braze Expo Plugin verwenden, können Sie Push-Benachrichtigungs-Deeplinks automatisch verarbeiten, indem Sie androidHandlePushDeepLinksAutomatically in Ihrer app.json auf true setzen.

Um Deeplinks stattdessen manuell zu verarbeiten, lesen Sie die native Android-Dokumentation: Deeplinks hinzufügen.

Schritt 3.1: Push-Benachrichtigungs-Nutzlast beim App-Start speichern

Fügen Sie populateInitialPushPayloadFromIntent zur Methode onCreate() Ihrer Hauptaktivität hinzu. Dies muss vor der Initialisierung von React Native aufgerufen werden, um die ursprünglichen Intent-Daten zu erfassen. Zum Beispiel:

override fun onCreate(savedInstanceState: Bundle?) {
  BrazeReactUtils.populateInitialPushPayloadFromIntent(intent)
  super.onCreate(savedInstanceState)
}

Zusätzlich zu den Basisszenarien, die von React Native Linking behandelt werden, implementieren Sie die Methode Braze.getInitialPushPayload und rufen den Wert url ab, um Deeplinks von Push-Benachrichtigungen zu berücksichtigen, die Ihre App öffnen, wenn sie nicht läuft. Zum Beispiel:

// Handles deep links when an app is launched from a hard close via push click.
Braze.getInitialPushPayload(pushPayload => {
  if (pushPayload) {
    console.log('Braze.getInitialPushPayload is ' + pushPayload);
    showToast('Initial URL is ' + pushPayload.url);
    handleOpenUrl({ pushPayload.url });
  }
});

Dazu gehört die Registrierung eines benutzerdefinierten URL-Schemas und die Implementierung eines URL-Handlers in Ihrem AppDelegate. Eine vollständige Einrichtungsanleitung finden Sie unter Deeplinks verarbeiten in der nativen iOS-Dokumentation.

Schritt 3.1: Push-Benachrichtigungs-Nutzlast beim App-Start speichern

Fügen Sie für iOS populateInitialPayloadFromLaunchOptions zur Methode didFinishLaunchingWithOptions des AppDelegate hinzu. Zum Beispiel:

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  // ... Perform regular React Native setup

  BRZConfiguration *configuration = [[BRZConfiguration alloc] initWithApiKey:apiKey endpoint:endpoint];
  configuration.triggerMinimumTimeInterval = 1;
  configuration.logger.level = BRZLoggerLevelInfo;
  Braze *braze = [BrazeReactBridge initBraze:configuration];
  AppDelegate.braze = braze;

  [self registerForPushNotifications];
  [[BrazeReactUtils sharedInstance] populateInitialPayloadFromLaunchOptions:launchOptions];

  return [super application:application didFinishLaunchingWithOptions:launchOptions];
}
func application(
  _ application: UIApplication,
  didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil
) -> Bool {
  // ... Perform regular React Native setup

  let configuration = Braze.Configuration(apiKey: apiKey, endpoint: endpoint)
  configuration.triggerMinimumTimeInterval = 1
  configuration.logger.level = .info
  let braze = BrazeReactBridge.initBraze(configuration)
  AppDelegate.braze = braze
  registerForPushNotifications()
  BrazeReactUtils.shared().populateInitialPayload(fromLaunchOptions: launchOptions)

  return super.application(application, didFinishLaunchingWithOptions: launchOptions)
}

Zusätzlich zu den Basisszenarien, die von React Native Linking behandelt werden, implementieren Sie die Methode Braze.getInitialPushPayload und rufen den Wert url ab, um Deeplinks von Push-Benachrichtigungen zu berücksichtigen, die Ihre App öffnen, wenn sie nicht läuft. Zum Beispiel:

// Handles deep links when an app is launched from a hard close via push click.
Braze.getInitialPushPayload(pushPayload => {
  if (pushPayload) {
    console.log('Braze.getInitialPushPayload is ' + pushPayload);
    showToast('Initial URL is ' + pushPayload.url);
    handleOpenUrl({ pushPayload.url });
  }
});

Um die Unterstützung für Universal Links zu aktivieren, implementieren Sie einen Braze-Delegaten, der festlegt, ob eine bestimmte URL geöffnet werden soll, und registrieren Sie diesen anschließend bei Ihrer Braze-Instanz.

Erstellen Sie eine BrazeReactDelegate.swift-Datei in Ihrem iOS-Verzeichnis und fügen Sie Folgendes hinzu. Ersetzen Sie YOUR_DOMAIN_HOST durch Ihre tatsächliche Domain.

import Foundation
import BrazeKit
import UIKit

class BrazeReactDelegate: NSObject, BrazeDelegate {

  /// This delegate method determines whether to open a given URL.
  /// Reference the context to get additional details about the URL payload.
  func braze(_ braze: Braze, shouldOpenURL context: Braze.URLContext) -> Bool {
    if let host = context.url.host,
       host.caseInsensitiveCompare("YOUR_DOMAIN_HOST") == .orderedSame {
      // Sample custom handling of universal links
      let application = UIApplication.shared
      let userActivity = NSUserActivity(activityType: NSUserActivityTypeBrowsingWeb)
      userActivity.webpageURL = context.url
      // Routes to the `continueUserActivity` method, which should be handled in your AppDelegate.
      application.delegate?.application?(
        application,
        continue: userActivity,
        restorationHandler: { _ in }
      )
      return false
    }
    // Let Braze handle links otherwise
    return true
  }
}

Erstellen und registrieren Sie dann Ihr BrazeReactDelegate in didFinishLaunchingWithOptions der Datei AppDelegate.swift Ihres Projekts.

import BrazeKit

class AppDelegate: UIResponder, UIApplicationDelegate {

  static var braze: Braze?

  // Keep a strong reference to the BrazeDelegate so it is not deallocated.
  private var brazeDelegate: BrazeReactDelegate?

  func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil
  ) -> Bool {
    // Other setup code (e.g., Braze initialization)

    brazeDelegate = BrazeReactDelegate()
    AppDelegate.braze?.delegate = brazeDelegate
    return true
  }
}

Erstellen Sie eine BrazeReactDelegate.h-Datei in Ihrem iOS-Verzeichnis und fügen Sie anschließend das folgende Snippet hinzu.

#import <Foundation/Foundation.h>
#import <BrazeKit/BrazeKit-Swift.h>

@interface BrazeReactDelegate: NSObject<BrazeDelegate>

@end

Erstellen Sie als Nächstes eine Datei BrazeReactDelegate.m und fügen Sie das folgende Code-Snippet ein. Ersetzen Sie YOUR_DOMAIN_HOST durch Ihre tatsächliche Domain.

#import "BrazeReactDelegate.h"
#import <UIKit/UIKit.h>

@implementation BrazeReactDelegate

/// This delegate method determines whether to open a given URL.
///
/// Reference the `BRZURLContext` object to get additional details about the URL payload.
- (BOOL)braze:(Braze *)braze shouldOpenURL:(BRZURLContext *)context {
  if ([[context.url.host lowercaseString] isEqualToString:@"YOUR_DOMAIN_HOST"]) {
    // Sample custom handling of universal links
    UIApplication *application = UIApplication.sharedApplication;
    NSUserActivity* userActivity = [[NSUserActivity alloc] initWithActivityType:NSUserActivityTypeBrowsingWeb];
    userActivity.webpageURL = context.url;
    // Routes to the `continueUserActivity` method, which should be handled in your `AppDelegate`.
    [application.delegate application:application
                 continueUserActivity:userActivity restorationHandler:^(NSArray<id<UIUserActivityRestoring>> * _Nullable restorableObjects) {}];
    return NO;
  }
  // Let Braze handle links otherwise
  return YES;
}

@end

Erstellen und registrieren Sie dann Ihr BrazeReactDelegate in didFinishLaunchingWithOptions der Datei AppDelegate.m Ihres Projekts.

#import "BrazeReactUtils.h"
#import "BrazeReactDelegate.h"

@interface AppDelegate ()

// Keep a strong reference to the BrazeDelegate to ensure it is not deallocated.
@property (nonatomic, strong) BrazeReactDelegate *brazeDelegate;

@end

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  // Other setup code

  self.brazeDelegate = [[BrazeReactDelegate alloc] init];
  braze.delegate = self.brazeDelegate;
}

Eine beispielhafte Integration finden Sie in unserer Beispiel-App in diesem AppDelegate-Beispiel.

4. Schritt: Vordergrundbenachrichtigungen behandeln

Die Behandlung von Benachrichtigungen im Vordergrund funktioniert je nach Plattform und Konfiguration unterschiedlich. Wählen Sie den Ansatz, der zu Ihrer Integration passt:

Für iOS entspricht die Verarbeitung von Vordergrundbenachrichtigungen der nativen Swift-Integration. Rufen Sie handleForegroundNotification(notification:) innerhalb Ihrer UNUserNotificationCenterDelegate.userNotificationCenter(_:willPresent:withCompletionHandler:)-Implementierung auf.

Ausführliche Informationen und Code-Beispiele finden Sie unter Vordergrundbenachrichtigungen behandeln in der Dokumentation zu Swift-Push-Benachrichtigungen.

Bei Android entspricht die Verarbeitung von Vordergrundbenachrichtigungen der nativen Android-Integration. Rufen Sie BrazeFirebaseMessagingService.handleBrazeRemoteMessage innerhalb Ihrer FirebaseMessagingService.onMessageReceived-Methode auf.

Ausführliche Informationen und Code-Beispiele finden Sie unter Vordergrundbenachrichtigungen behandeln in der Dokumentation zu Android-Push-Benachrichtigungen.

Im von Expo verwalteten Workflow rufen Sie native Benachrichtigungs-Handler nicht direkt auf. Verwenden Sie stattdessen die Expo Notifications API, um die Vordergrunddarstellung zu steuern, während das Braze Expo Plugin die native Verarbeitung automatisch übernimmt.

import * as Notifications from 'expo-notifications';
import Braze from '@braze/react-native-sdk';

// Control foreground presentation in Expo
Notifications.setNotificationHandler({
  handleNotification: async () => ({
    shouldShowAlert: true,    // Show alert while in foreground
    shouldPlaySound: false,
    shouldSetBadge: false,
  }),
});

// React to Braze push events
const subscription = Braze.addListener('pushNotificationEvent', (event) => {
  console.log('Braze push event', {
    type: event.payload_type,   // "push_received" | "push_opened"
    title: event.title,
    url: event.url,
    is_silent: event.is_silent,
  });
  // Handle deep links, custom behavior, etc.
});

// Handle initial payload when app launches via push
Braze.getInitialPushPayload((payload) => {
  if (payload) {
    console.log('Initial push payload', payload);
  }
});

Für Bare-Workflow-Integrationen verwenden Sie stattdessen die nativen Ansätze für iOS und Android.

5. Schritt: Test-Push-Benachrichtigung senden

Sie sollten nun in der Lage sein, Benachrichtigungen an die Geräte zu senden. Führen Sie die folgenden Schritte durch, um Ihre Push-Integration zu testen.

  1. Setzen Sie eine:n aktive:n Nutzer:in in der React Native-Anwendung, indem Sie die Methode Braze.changeUserId('your-user-id') aufrufen.
  2. Gehen Sie zu Campaigns und erstellen Sie eine neue Push-Benachrichtigungs-Campaign. Wählen Sie die Plattformen aus, die Sie testen möchten.
  3. Verfassen Sie Ihre Testbenachrichtigung und wechseln Sie zum Tab Test. Fügen Sie dieselbe user-id als Testnutzer:in hinzu und klicken Sie auf Send Test. Sie sollten die Benachrichtigung in Kürze auf Ihrem Gerät erhalten.

Eine Braze-Push-Campaign, die zeigt, wie Sie Ihre eigene Nutzer-ID als Testempfänger:in hinzufügen können, um Ihre Push-Benachrichtigung zu testen.

Das Expo-Plugin verwenden

Nachdem Sie Push-Benachrichtigungen für Expo eingerichtet haben, können Sie damit die folgenden Verhaltensweisen für Push-Benachrichtigungen handhaben—ohne Code in den nativen Android- oder iOS-Schichten schreiben zu müssen.

Android-Push an zusätzliche FMS weiterleiten

Wenn Sie einen zusätzlichen Firebase Messaging Service (FMS) verwenden möchten, können Sie einen Fallback-FMS angeben, der aufgerufen wird, wenn Ihre Anwendung eine Push-Benachrichtigung empfängt, die nicht von Braze stammt. Zum Beispiel:

{
  "expo": {
    "plugins": [
      [
        "@braze/expo-plugin",
        {
          ...
          "androidFirebaseMessagingFallbackServiceEnabled": true,
          "androidFirebaseMessagingFallbackServiceClasspath": "com.company.OurFirebaseMessagingService"
        }
      ]
    ]
  }
}

App-Erweiterungen mit Expo Application Services verwenden

Wenn Sie Expo Application Services (EAS) verwenden und enableBrazeIosRichPush oder enableBrazeIosPushStories aktiviert haben, müssen Sie die entsprechenden Bundle-Bezeichner für jede App-Erweiterung in Ihrem Projekt deklarieren. Es gibt mehrere Möglichkeiten, diesen Schritt durchzuführen, je nachdem, wie Ihr Projekt für die Code-Signierung mit EAS konfiguriert ist.

Ein Ansatz besteht darin, die appExtensions-Konfiguration in Ihrer app.json-Datei zu verwenden, indem Sie der Dokumentation zu App-Erweiterungen von Expo folgen. Alternativ können Sie die multitarget-Einstellung in Ihrer credentials.json-Datei einrichten, indem Sie der Dokumentation zu lokalen Zugangsdaten von Expo folgen.

Fehlerbehebung

Dies sind häufige Schritte zur Fehlerbehebung bei der Integration von Push-Benachrichtigungen mit dem Braze React Native SDK und dem Expo-Plugin.

Push-Benachrichtigungen funktionieren nicht mehr

Wenn Push-Benachrichtigungen über das Expo-Plugin nicht mehr funktionieren:

  1. Überprüfen Sie, ob das Braze SDK weiterhin Sessions erfasst.
  2. Überprüfen Sie, ob das SDK nicht durch einen expliziten oder impliziten Aufruf von wipeData deaktiviert wurde.
  3. Prüfen Sie kürzlich durchgeführte Upgrades von Expo oder den zugehörigen Bibliotheken, da es Konflikte mit Ihrer Braze-Konfiguration geben könnte.
  4. Prüfen Sie kürzlich hinzugefügte Projektabhängigkeiten und stellen Sie fest, ob diese Ihre bestehenden Delegate-Methoden für Push-Benachrichtigungen manuell überschreiben.

Geräte-Token wird nicht bei Braze registriert

Wenn Ihr Geräte-Token nicht bei Braze registriert wird, lesen Sie zunächst Push-Benachrichtigungen funktionieren nicht mehr.

Falls das Problem weiterhin besteht, könnte eine separate Abhängigkeit Ihre Braze-Push-Benachrichtigungskonfiguration beeinträchtigen. Sie können versuchen, diese zu entfernen, oder stattdessen Braze.registerPushToken manuell aufrufen.

Wenn Deeplinks aus Push-Benachrichtigungen nach einer Migration nicht mehr geöffnet werden, überprüfen Sie Folgendes:

  1. Stellen Sie sicher, dass Ihre React Native Linking-Einrichtung in Ihrer aktualisierten App weiterhin gültig ist.
  2. Bestätigen Sie bei nativen iOS-Integrationen, dass Sie populateInitialPayloadFromLaunchOptions und Braze.getInitialPushPayload implementiert haben, damit die App beim Start aus einem beendeten Zustand den initialen Push-Payload abrufen und dessen url an Ihren Deeplink-Handler übergeben kann.
  3. Wenn Sie das Braze Expo-Plugin verwenden, überprüfen Sie, ob androidHandlePushDeepLinksAutomatically für Ihre Implementierung korrekt konfiguriert ist.
  4. Prüfen Sie kürzlich hinzugefügte Abhängigkeiten auf Überschreibungen der Benachrichtigungsverarbeitung oder des App-Delegate-Verhaltens.

Wenn Sie diese Überprüfungen abgeschlossen haben und das Problem weiterhin besteht, eröffnen Sie ein Support-Ticket und fügen Sie SDK-Logs sowie Schritte zur Reproduktion bei.

Voraussetzungen

Bevor Sie dieses Feature nutzen können, müssen Sie das Braze Web SDK integrieren. Außerdem müssen Sie Push-Benachrichtigungen für das Web SDK einrichten. Beachten Sie, dass Sie Push-Benachrichtigungen nur an iOS- und iPadOS-Nutzer:innen senden können, die Safari v16.4 oder höher verwenden.

Safari-Push für Mobilgeräte einrichten

Schritt 1: Eine Manifest-Datei erstellen

Ein Web Application Manifest ist eine JSON-Datei, die steuert, wie Ihre Website dargestellt wird, wenn sie auf dem Startbildschirm von Nutzer:innen installiert wird.

Sie können beispielsweise die Hintergrund-Themenfarbe und das Symbol festlegen, die der App Switcher verwendet, ob die Darstellung im Vollbildmodus erfolgt, um einer nativen App zu ähneln, oder ob die App im Quer- oder Hochformat geöffnet werden soll.

Erstellen Sie eine neue manifest.json-Datei im Stammverzeichnis Ihrer Website mit den folgenden Pflichtfeldern.

{
  "name": "your app name",
  "short_name": "your app name",
  "display": "fullscreen",
  "icons": [{
    "src": "favicon.ico",
    "sizes": "128x128",
  }]
}

Die vollständige Liste der unterstützten Felder finden Sie in der MDN-Dokumentation zum Web App Manifest.

Fügen Sie das folgende <link>-Tag zum <head>-Element Ihrer Website hinzu und verweisen Sie auf den Speicherort Ihrer Manifest-Datei.

<link rel="manifest" href="/manifest.json" />

Schritt 3: Einen Service Worker hinzufügen

Ihre Website muss über eine Service-Worker-Datei verfügen, die die Braze-Service-Worker-Bibliothek importiert, wie in unserem Integrationsleitfaden für Web-Push beschrieben.

Schritt 4: Zum Startbildschirm hinzufügen

Gängige Browser (wie Safari, Chrome, FireFox und Edge) unterstützen Web-Push-Benachrichtigungen in ihren neueren Versionen. Um auf iOS oder iPadOS die Push-Berechtigung anzufordern, muss Ihre Website zum Startbildschirm der Nutzer:innen hinzugefügt werden, indem Sie Teilen > Zum Home-Bildschirm auswählen. Mit Zum Home-Bildschirm hinzufügen können Nutzer:innen Ihre Website als Lesezeichen speichern und Ihr Symbol auf ihrem Startbildschirm platzieren.

Ein iPhone mit Optionen zum Speichern einer Website als Lesezeichen und zum Hinzufügen zum Startbildschirm

Schritt 5: Den nativen Push-Dialog anzeigen

Nachdem die App zu Ihrem Startbildschirm hinzugefügt wurde, können Sie die Push-Berechtigung anfordern, wenn Nutzer:innen eine Aktion ausführen (z. B. auf einen Button klicken). Dies kann über die Methode requestPushPermission oder mit einer Push-Primer-In-App-Nachricht ohne Code erfolgen.

Ein Push-Dialog mit der Frage „Erlauben“ oder „Nicht erlauben“ für Benachrichtigungen

Zum Beispiel:

import { requestPushPermission } from "@braze/web-sdk";

button.onclick = function(){
    requestPushPermission(() => {
        console.log(`User accepted push prompt`);
    }, (temporary) => {
        console.log(`User ${temporary ? "temporarily dismissed" : "permanently denied"} push prompt`);
    });
};

Nächste Schritte

Senden Sie sich als Nächstes eine Testnachricht, um die Integration zu validieren. Nachdem Ihre Integration abgeschlossen ist, können Sie unsere No-Code-Push-Primer-Nachrichten verwenden, um Ihre Push-Opt-in-Raten zu optimieren.

Voraussetzungen

Bevor Sie dieses Feature nutzen können, müssen Sie das Unity Braze SDK integrieren.

Push-Benachrichtigungen einrichten

Schritt 1: Plattform einrichten

Schritt 1.1: Firebase aktivieren

Folgen Sie zunächst der Firebase Unity Setup-Dokumentation.

Schritt 1.2: Firebase-Zugangsdaten festlegen

Sie müssen Ihren Firebase Server Key und Ihre Sender ID im Braze-Dashboard eingeben. Melden Sie sich dazu in der Firebase Developers Console an und wählen Sie Ihr Firebase-Projekt aus. Wählen Sie dann Cloud Messaging unter Settings und kopieren Sie den Server Key und die Sender ID:
Firebase Console Cloud-Messaging-Einstellungen mit Server Key und Sender ID.

Wählen Sie in Braze Ihre Android-App auf der Seite App Settings unter Manage Settings aus. Geben Sie dann Ihren Firebase Server Key im Feld Firebase Cloud Messaging Server Key und Ihre Firebase Sender ID im Feld Firebase Cloud Messaging Sender ID ein.

Braze Android-App-Einstellungsseite mit den Feldern für Firebase Cloud Messaging Server Key und Sender ID.

Schritt 1.1: Integrationsmethode überprüfen

Braze bietet eine native Unity-Lösung zur Automatisierung der iOS-Push-Integration. Wenn Sie Ihre Integration stattdessen manuell einrichten und verwalten möchten, lesen Sie Swift: Push-Benachrichtigungen.

Andernfalls fahren Sie mit dem nächsten Schritt fort.

Schritt 1.1: ADM aktivieren

  1. Erstellen Sie ein Konto beim Amazon Apps & Games Developer Portal, falls noch nicht geschehen.
  2. Beschaffen Sie sich OAuth-Zugangsdaten (Client-ID und Client-Secret) sowie einen ADM-API-Schlüssel.
  3. Aktivieren Sie Automatic ADM Registration Enabled im Unity-Braze-Konfigurationsfenster.
    • Alternativ können Sie die folgende Zeile zu Ihrer res/values/braze.xml-Datei hinzufügen, um die ADM-Registrierung zu aktivieren:
  <bool name="com_braze_push_adm_messaging_registration_enabled">true</bool>

Schritt 2: Push-Benachrichtigungen konfigurieren

Schritt 2.1: Push-Einstellungen konfigurieren

Das Braze SDK kann die Push-Registrierung bei den Firebase Cloud Messaging Servern automatisch durchführen, damit Geräte Push-Benachrichtigungen empfangen können. Aktivieren Sie in Unity Automate Unity Android Integration und konfigurieren Sie dann die folgenden Push Notification-Einstellungen.

Einstellung Beschreibung
Automatic Firebase Cloud Messaging Registration Enabled Weist das Braze SDK an, automatisch ein FCM-Push-Token für ein Gerät abzurufen und zu senden.
Firebase Cloud Messaging Sender ID Die Sender ID aus Ihrer Firebase Console.
Handle Push Deeplinks Automatically Legt fest, ob das SDK beim Klick auf Push-Benachrichtigungen automatisch Deeplinks öffnen oder die App starten soll.
Small Notification Icon Drawable Android-Drawable-Ressourcenreferenz für das kleine Symbol, das bei eingehenden Push-Benachrichtigungen angezeigt wird. Geben Sie die vollständige Referenz einschließlich des Präfixes @drawable/ ein (z. B. @drawable/hourglass_icon). Die automatische Integration schreibt diesen Wert genau so in braze.xml. Wenn Sie dieses Feld leer lassen, wird das Anwendungssymbol als kleines Symbol verwendet.
Large Notification Icon Drawable Optionales großes Symbol für Benachrichtigungen. Verwenden Sie dasselbe @drawable/-Format wie beim kleinen Symbol (z. B. @drawable/my_large_icon).

Schritt 2.1: APNs-Token hochladen

Bevor Sie eine iOS-Push-Benachrichtigung mit Braze senden können, müssen Sie Ihre .p8-Push-Benachrichtigungsdatei hochladen, wie in der Entwicklerdokumentation von Apple beschrieben:

  1. Gehen Sie in Ihrem Apple-Entwickler-Account zu Certificates, Identifiers & Profiles.
  2. Wählen Sie unter Keys die Option All aus und klicken Sie auf die Schaltfläche „Hinzufügen“ (+) oben auf der Seite.
  3. Geben Sie unter Key Description einen eindeutigen Namen für den Signierschlüssel ein.
  4. Aktivieren Sie unter Key Services das Kontrollkästchen Apple Push Notification service (APNs) und klicken Sie dann auf Continue. Klicken Sie auf Confirm.
  5. Notieren Sie sich die Key-ID. Klicken Sie auf Download, um den Schlüssel zu generieren und herunterzuladen. Stellen Sie sicher, dass Sie die heruntergeladene Datei an einem sicheren Ort speichern, da Sie sie nur einmal herunterladen können.
  6. Gehen Sie in Braze zu Einstellungen > App-Einstellungen und laden Sie die .p8-Datei unter Apple Push Certificate hoch. Sie können entweder Ihr Entwicklungs- oder Ihr Produktions-Push-Zertifikat hochladen. Um Push-Benachrichtigungen zu testen, nachdem Ihre App im App Store live ist, empfiehlt es sich, einen separaten Workspace für die Entwicklungsversion Ihrer App einzurichten.
  7. Wenn Sie dazu aufgefordert werden, geben Sie die Bundle-ID, die Key-ID und die Team-ID Ihrer App ein. Sie müssen außerdem angeben, ob Benachrichtigungen an die Entwicklungs- oder die Produktionsumgebung Ihrer App gesendet werden sollen. Dies wird durch das Bereitstellungsprofil Ihrer App festgelegt.
  8. Wenn Sie fertig sind, wählen Sie Speichern aus.

Schritt 2.2: Automatische Push-Funktion aktivieren

Öffnen Sie die Braze-Konfigurationseinstellungen im Unity Editor, indem Sie zu Braze > Braze Configuration navigieren.

Aktivieren Sie Integrate Push With Braze, um Nutzer:innen automatisch für Push-Benachrichtigungen zu registrieren, Push-Token an Braze zu übergeben, Analytics für Push-Öffnungen zu erfassen und unsere standardmäßige Verarbeitung von Push-Benachrichtigungen zu nutzen.

Schritt 2.3: Hintergrund-Push aktivieren (optional)

Aktivieren Sie Enable Background Push, wenn Sie den background mode für Push-Benachrichtigungen nutzen möchten. Dadurch kann das System Ihre Anwendung aus dem Status suspended aufwecken, wenn eine Push-Benachrichtigung eintrifft, sodass Ihre Anwendung als Reaktion auf Push-Benachrichtigungen Inhalte herunterladen kann. Diese Option ist für unsere Uninstall-Tracking-Funktionalität erforderlich.

Der Unity Editor zeigt die Braze-Konfigurationsoptionen. In diesem Editor sind „Automate Unity iOS integration“, „Integrate push with braze“ und „Enable background push“ aktiviert.

Schritt 2.4: Automatische Registrierung deaktivieren (optional)

Nutzer:innen, die Push-Benachrichtigungen noch nicht zugestimmt haben, werden beim Öffnen Ihrer Anwendung automatisch für Push autorisiert. Um dieses Feature zu deaktivieren und Nutzer:innen manuell für Push zu registrieren, aktivieren Sie Disable Automatic Push Registration.

  • Wenn Disable Provisional Authorization unter iOS 12 oder höher nicht aktiviert ist, werden Nutzer:innen vorläufig (lautlos) für den Empfang stiller Push-Benachrichtigungen autorisiert. Bei Aktivierung wird den Nutzer:innen stattdessen der native Push-Prompt angezeigt.
  • Wenn Sie genau festlegen müssen, wann der Prompt zur Laufzeit angezeigt wird, deaktivieren Sie die automatische Registrierung im Braze-Konfigurationseditor und verwenden Sie stattdessen AppboyBinding.PromptUserForPushPermissions().

Der Unity Editor zeigt die Braze-Konfigurationsoptionen. In diesem Editor sind „Automate Unity iOS integration“, „Integrate push with braze“ und „Disable automatic push registration“ aktiviert.

Schritt 2.1: AndroidManifest.xml aktualisieren

Wenn Ihre App keine AndroidManifest.xml hat, können Sie das folgende Template verwenden. Wenn Sie bereits eine AndroidManifest.xml haben, stellen Sie sicher, dass alle folgenden fehlenden Abschnitte zu Ihrer bestehenden AndroidManifest.xml hinzugefügt werden.

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
          package="REPLACE_WITH_YOUR_PACKAGE_NAME">

  <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
  <uses-permission android:name="android.permission.INTERNET" />
  <permission
    android:name="REPLACE_WITH_YOUR_PACKAGE_NAME.permission.RECEIVE_ADM_MESSAGE"
    android:protectionLevel="signature" />
  <uses-permission android:name="REPLACE_WITH_YOUR_PACKAGE_NAME.permission.RECEIVE_ADM_MESSAGE" />
  <uses-permission android:name="com.amazon.device.messaging.permission.RECEIVE" />

  <application android:icon="@drawable/app_icon"
               android:label="@string/app_name">

    <!-- Calls the necessary Braze methods to ensure that analytics are collected and that push notifications are properly forwarded to the Unity application. -->
    <activity android:name="com.braze.unity.BrazeUnityPlayerActivity"
      android:label="@string/app_name"
      android:configChanges="fontScale|keyboard|keyboardHidden|locale|mnc|mcc|navigation|orientation|screenLayout|screenSize|smallestScreenSize|uiMode|touchscreen"
      android:screenOrientation="sensor">
      <meta-data android:name="android.app.lib_name" android:value="unity" />
      <meta-data android:name="unityplayer.ForwardNativeEventsToDalvik" android:value="true" />
      <intent-filter>
        <action android:name="android.intent.action.MAIN" />
        <category android:name="android.intent.category.LAUNCHER" />
      </intent-filter>
    </activity>

    <receiver android:name="com.braze.push.BrazeAmazonDeviceMessagingReceiver" android:permission="com.amazon.device.messaging.permission.SEND">
      <intent-filter>
          <action android:name="com.amazon.device.messaging.intent.RECEIVE" />
          <action android:name="com.amazon.device.messaging.intent.REGISTRATION" />
          <category android:name="REPLACE_WITH_YOUR_PACKAGE_NAME" />
      </intent-filter>
    </receiver>
  </application>
</manifest>

Schritt 2.2: ADM-API-Schlüssel speichern

Generieren Sie zunächst einen ADM-API-Schlüssel für Ihre App und speichern Sie den Schlüssel in einer Datei namens api_key.txt. Fügen Sie diese Datei in das Assets/-Verzeichnis Ihres Projekts ein.

Fügen Sie anschließend in Ihrer mainTemplate.gradle-Datei Folgendes hinzu:

task copyAmazon(type: Copy) {
    def unityProjectPath = $/file:///**DIR_UNITYPROJECT**/$.replace("\\", "/")
    from unityProjectPath + '/Assets/api_key.txt'
    into new File(projectDir, 'src/main/assets')
}

preBuild.dependsOn(copyAmazon)

Schritt 2.3: ADM-JAR hinzufügen

Die erforderliche ADM-JAR-Datei kann gemäß der Unity-JAR-Dokumentation an beliebiger Stelle in Ihrem Projekt abgelegt werden.

Schritt 2.4: Client-Secret und Client-ID zum Braze-Dashboard hinzufügen

Abschließend müssen Sie das Client-Secret und die Client-ID, die Sie in Schritt 1 erhalten haben, auf der Seite Manage Settings im Braze-Dashboard hinzufügen.

Braze Fire OS-App-Einstellungsseite mit den Feldern für ADM-Client-ID und Client-Secret.

Schritt 3: Push-Listener einrichten

Schritt 3.1: Push-Empfangs-Listener aktivieren

Der Push-Empfangs-Listener wird ausgelöst, wenn Nutzer:innen eine Push-Benachrichtigung erhalten. Um den Push-Payload an Unity zu senden, legen Sie den Namen Ihres Spielobjekts und die Callback-Methode des Push-Empfangs-Listeners unter Set Push Received Listener fest.

Schritt 3.2: Push-Öffnungs-Listener aktivieren

Der Push-Öffnungs-Listener wird ausgelöst, wenn Nutzer:innen die App durch Klicken auf eine Push-Benachrichtigung starten. Um den Push-Payload an Unity zu senden, legen Sie den Namen Ihres Spielobjekts und die Callback-Methode des Push-Öffnungs-Listeners unter Set Push Opened Listener fest.

Schritt 3.3: Push-Lösch-Listener aktivieren

Der Push-Lösch-Listener wird ausgelöst, wenn Nutzer:innen eine Push-Benachrichtigung wegwischen oder verwerfen. Um den Push-Payload an Unity zu senden, legen Sie den Namen Ihres Spielobjekts und die Callback-Methode des Push-Lösch-Listeners unter Set Push Deleted Listener fest.

Beispiel für Push-Listener

Das folgende Beispiel implementiert das BrazeCallback-Spielobjekt mit den Callback-Methodennamen PushNotificationReceivedCallback, PushNotificationOpenedCallback und PushNotificationDeletedCallback.

Diese Implementierungsbeispielgrafik zeigt die in den vorangehenden Abschnitten genannten Braze-Konfigurationsoptionen und ein C#-Code-Snippet.

public class MainMenu : MonoBehaviour {
  void PushNotificationReceivedCallback(string message) {
#if UNITY_ANDROID
    Debug.Log("PushNotificationReceivedCallback message: " + message);
    PushNotification pushNotification = new PushNotification(message);
    Debug.Log("Push Notification received: " + pushNotification);
#elif UNITY_IOS
    ApplePushNotification pushNotification = new ApplePushNotification(message);
    Debug.Log("Push received Notification event: " + pushNotification);
#endif
  }

  void PushNotificationOpenedCallback(string message) {
#if UNITY_ANDROID
    Debug.Log("PushNotificationOpenedCallback message: " + message);
    PushNotification pushNotification = new PushNotification(message);
    Debug.Log("Push Notification opened: " + pushNotification);
#elif UNITY_IOS
    ApplePushNotification pushNotification = new ApplePushNotification(message);
    Debug.Log("Push opened Notification event: " + pushNotification);
#endif
  }

  void PushNotificationDeletedCallback(string message) {
#if UNITY_ANDROID
    Debug.Log("PushNotificationDeletedCallback message: " + message);
    PushNotification pushNotification = new PushNotification(message);
    Debug.Log("Push Notification dismissed: " + pushNotification);
#endif
  }
}

Schritt 3.1: Push-Empfangs-Listener aktivieren

Der Push-Empfangs-Listener wird ausgelöst, wenn Nutzer:innen eine Push-Benachrichtigung erhalten, während sie die Anwendung aktiv nutzen (z. B. wenn die App im Vordergrund ist). Legen Sie den Push-Empfangs-Listener im Braze-Konfigurationseditor fest. Wenn Sie Ihren Spielobjekt-Listener zur Laufzeit konfigurieren müssen, verwenden Sie AppboyBinding.ConfigureListener() und geben Sie BrazeUnityMessageType.PUSH_RECEIVED an.

Der Unity Editor zeigt die Braze-Konfigurationsoptionen. In diesem Editor ist die Option „Set Push Received Listener“ aufgeklappt, und der „Game Object Name“ (AppBoyCallback) sowie der „Callback Method Name“ (PushNotificationReceivedCallback) sind angegeben.

Schritt 3.2: Push-Öffnungs-Listener aktivieren

Der Push-Öffnungs-Listener wird ausgelöst, wenn Nutzer:innen die App durch Klicken auf eine Push-Benachrichtigung starten. Um den Push-Payload an Unity zu senden, legen Sie den Namen Ihres Spielobjekts und die Callback-Methode des Push-Öffnungs-Listeners unter der Option Set Push Opened Listener fest:

Der Unity Editor zeigt die Braze-Konfigurationsoptionen. In diesem Editor ist die Option „Set Push Received Listener“ aufgeklappt, und der „Game Object Name“ (AppBoyCallback) sowie der „Callback Method Name“ (PushNotificationOpenedCallback) sind angegeben.

Wenn Sie Ihren Spielobjekt-Listener zur Laufzeit konfigurieren müssen, verwenden Sie AppboyBinding.ConfigureListener() und geben Sie BrazeUnityMessageType.PUSH_OPENED an.

Beispiel für Push-Listener

Das folgende Beispiel implementiert das AppboyCallback-Spielobjekt mit den Callback-Methodennamen PushNotificationReceivedCallback und PushNotificationOpenedCallback.

Diese Implementierungsbeispielgrafik zeigt die in den vorangehenden Abschnitten genannten Braze-Konfigurationsoptionen und ein C#-Code-Snippet.

public class MainMenu : MonoBehaviour {
  void PushNotificationReceivedCallback(string message) {
#if UNITY_ANDROID
    Debug.Log("PushNotificationReceivedCallback message: " + message);
    PushNotification pushNotification = new PushNotification(message);
    Debug.Log("Push Notification received: " + pushNotification);
#elif UNITY_IOS
    ApplePushNotification pushNotification = new ApplePushNotification(message);
    Debug.Log("Push received Notification event: " + pushNotification);
#endif
  }

  void PushNotificationOpenedCallback(string message) {
#if UNITY_ANDROID
    Debug.Log("PushNotificationOpenedCallback message: " + message);
    PushNotification pushNotification = new PushNotification(message);
    Debug.Log("Push Notification opened: " + pushNotification);
#elif UNITY_IOS
    ApplePushNotification pushNotification = new ApplePushNotification(message);
    Debug.Log("Push opened Notification event: " + pushNotification);
#endif
  }
}

Durch die Aktualisierung Ihrer AndroidManifest.xml im vorherigen Schritt wurden Push-Listener automatisch eingerichtet, als Sie die folgenden Zeilen hinzugefügt haben. Es ist daher kein weiteres Setup erforderlich.

<action android:name="com.amazon.device.messaging.intent.RECEIVE" />
<action android:name="com.amazon.device.messaging.intent.REGISTRATION" />

Optionale Konfigurationen

Deeplinking zu In-App-Ressourcen

Braze kann standardmäßig herkömmliche Deeplinks (z. B. Website-URLs, Android-URIs usw.) verarbeiten. Für benutzerdefinierte Deeplinks ist jedoch eine zusätzliche Manifest-Einrichtung erforderlich.

Eine Anleitung zur Einrichtung finden Sie unter Deep Linking to In-App Resources.

Braze-Push-Benachrichtigungssymbole hinzufügen

Um Push-Symbole zu Ihrem Projekt hinzuzufügen, erstellen Sie ein AAR-Plug-in oder eine Android-Bibliothek, die die Symbolbilddateien unter res/drawable* (oder dichtespezifischen Ordnern) enthält, und referenzieren Sie jedes Symbol in Braze > Braze Configuration mit dem vollständigen @drawable/-Ressourcennamen (siehe Schritt 2.1: Push-Einstellungen konfigurieren). Informationen zu den Paketierungs- und Importschritten in Unity finden Sie unter Android Library Projects and Android Archive plug-ins.

Regeln für Small-Icon-Grafiken (nur Alpha-Kanal, keine Farbe) finden Sie unter Android-Push-Benachrichtigungen, Schritt 2: Small Icons an Design-Richtlinien anpassen.

Push-Token-Callback

Um eine Kopie der Braze-Geräte-Token vom Betriebssystem zu erhalten, legen Sie einen Delegaten mit AppboyBinding.SetPushTokenReceivedFromSystemDelegate() fest.

Für ADM gibt es derzeit keine optionalen Konfigurationen.

Voraussetzungen

Bevor Sie dieses Feature nutzen können, müssen Sie das .NET MAUI Braze SDK integrieren.

Push-Benachrichtigungen einrichten

Um Push-Benachrichtigungen für .NET MAUI (ehemals Xamarin) zu integrieren, müssen Sie die Schritte für native Android-Push-Benachrichtigungen durchführen. Die folgenden Schritte sind lediglich eine Zusammenfassung. Eine vollständige Anleitung finden Sie im nativen Push-Benachrichtigungsleitfaden.

Schritt 1: Projekt aktualisieren

  1. Fügen Sie Firebase zu Ihrem Android-Projekt hinzu.
  2. Fügen Sie die Cloud-Messaging-Bibliothek zur build.gradle Ihres Android-Projekts hinzu:
      implementation "google.firebase:firebase-messaging:+"
    

Schritt 2: JSON-Zugangsdaten erstellen

  1. Aktivieren Sie in Google Cloud die Firebase Cloud Messaging API.
  2. Wählen Sie Service Accounts > Ihr Projekt > Create Service Account und geben Sie einen Dienstkontonamen, eine ID und eine Beschreibung ein. Wenn Sie fertig sind, wählen Sie Create and continue.
  3. Suchen Sie im Feld Role den Eintrag Firebase Cloud Messaging API Admin in der Rollenliste und wählen Sie ihn aus.
  4. Wählen Sie unter Service Accounts Ihr Projekt aus und dann  Actions > Manage Keys > Add Key > Create new key. Wählen Sie JSON und dann Create.

Schritt 3: JSON-Zugangsdaten hochladen

  1. Wählen Sie in Braze  Einstellungen > App-Einstellungen. Wählen Sie unter den Push-Benachrichtigungseinstellungen Ihrer Android-App Firebase und dann Upload JSON File aus und laden Sie die zuvor erstellten Zugangsdaten hoch. Wenn Sie fertig sind, wählen Sie Speichern.
  2. Aktivieren Sie die automatische FCM-Token-Registrierung, indem Sie die Firebase Console öffnen. Öffnen Sie Ihr Projekt und wählen Sie  Settings > Project settings. Wählen Sie Cloud Messaging und kopieren Sie unter Firebase Cloud Messaging API (V1) die Nummer im Feld Sender ID.
  3. Fügen Sie in Ihrem Android-Studio-Projekt Folgendes zu Ihrer braze.xml hinzu.
  <bool translatable="false" name="com_braze_firebase_cloud_messaging_registration_enabled">true</bool>
  <string translatable="false" name="com_braze_firebase_cloud_messaging_sender_id">FIREBASE_SENDER_ID</string>

Schritt 1: Ersteinrichtung abschließen

Informationen zum Einrichten Ihrer Anwendung mit Push und zum Speichern Ihrer Zugangsdaten auf unserem Server finden Sie in den Swift-Integrationsanweisungen. Weitere Details finden Sie in der iOS-MAUI-Beispielanwendung.

Schritt 2: Berechtigung für Push-Benachrichtigungen anfordern

Unser .NET-MAUI-SDK unterstützt jetzt die automatische Push-Einrichtung. Richten Sie die Push-Automatisierung und -Berechtigungen ein, indem Sie den folgenden Code zu Ihrer Braze-Instanzkonfiguration hinzufügen:

configuration.Push.Automation = new BRZConfigurationPushAutomation(true);
configuration.Push.Automation.RequestAuthorizationAtLaunch = false;

Weitere Details finden Sie in der iOS-MAUI-Beispielanwendung. Zusätzliche Informationen finden Sie in der Xamarin-Dokumentation für Enhanced User Notifications in Xamarin.iOS.

New Stuff!