Bannerplatzierungen verwalten

Erfahren Sie, wie Sie Bannerplatzierungen im Braze SDK erstellen und verwalten, einschließlich des Zugriffs auf deren eindeutige Eigenschaften und der Protokollierung von Impressionen. Weitere allgemeine Informationen finden Sie unter Über Banner.

Über Platzierungsanfragen

Wenn Sie Platzierungen in Ihrer App oder Website erstellen, sendet Ihre App eine Anfrage an Braze, um Banner-Nachrichten für jede Platzierung abzurufen.

• Sie können bis zu 10 Platzierungen pro Aktualisierungsanfrage anfordern.
• Für jede Platzierung gibt Braze das Banner mit der höchsten Priorität zurück, für das die Nutzer:in berechtigt ist.
• Wenn bei einer Aktualisierung mehr als 10 Platzierungen angefragt werden, werden nur die ersten 10 zurückgegeben; die übrigen werden verworfen.

Beispielsweise könnte eine App in einer Aktualisierungsanfrage drei Platzierungen anfordern: homepage_promo, cart_abandonment und seasonal_offer. Jede Anfrage gibt das für diese Platzierung relevanteste Banner zurück.

Rate-Limiting für Aktualisierungsanfragen

Wenn Sie ältere SDK-Versionen verwenden (vor Swift 13.1.0, Android 38.0.0, Web 6.1.0, React Native 17.0.0 und Flutter 15.0.0), ist nur eine Aktualisierungsanfrage pro Nutzersitzung zulässig.

Wenn Sie neuere Mindest-SDK-Versionen verwenden (Swift 13.1.0+, Android 38.0.0+, Web 6.1.0+, React Native 17.0.0+ und Flutter 15.0.0+), werden Aktualisierungsanfragen durch einen Token-Bucket-Algorithmus gesteuert, um übermäßiges Polling zu verhindern:

• Jede Nutzersitzung beginnt mit fünf Aktualisierungs-Token.
• Die Token werden mit einer Rate von einem Token alle 180 Sekunden (3 Minuten) aufgefüllt.

Jeder explizite Aufruf von requestBannersRefresh verbraucht ein Token. Die automatische Aktualisierung, die zu Beginn einer neuen Sitzung oder beim Aufruf von changeUser erfolgt, verbraucht kein Token, da bei dieser Aktualisierung das zuletzt zwischengespeicherte Banner für die jeweilige Nutzer:in veröffentlicht wird. Wenn Sie versuchen, eine Aktualisierung durchzuführen, obwohl keine Token verfügbar sind, sendet das SDK die Anfrage nicht und protokolliert einen Fehler, bis ein Token wieder aufgefüllt ist. Dies ist für Updates während der Sitzung und Event-getriggerte Updates von Bedeutung. Um dynamische Updates durchzuführen (beispielsweise nachdem eine Nutzer:in eine Aktion auf derselben Seite abgeschlossen hat), rufen Sie die Aktualisierungsmethode auf, nachdem das angepasste Event protokolliert wurde. Beachten Sie jedoch die erforderliche Verzögerung, die Braze benötigt, um das Event zu erfassen und zu verarbeiten, bevor die Nutzer:in für eine andere Banner-Campaign qualifiziert ist.

Platzierung erstellen

Voraussetzungen

Dies sind die Mindestversionen des SDK, die zum Erstellen von Banner-Platzierungen erforderlich sind:

Schritt 1: Platzierungen in Braze erstellen

Falls Sie dies noch nicht getan haben, müssen Sie in Braze Banner-Platzierungen erstellen, mit denen Sie die Standorte in Ihrer App oder Website definieren, an denen Banner angezeigt werden können. Um eine Platzierung zu erstellen, gehen Sie zu Einstellungen > Banner-Platzierungen und wählen Sie dann Platzierung erstellen.

Geben Sie Ihrer Platzierung einen Namen und weisen Sie eine Platzierungs-ID zu. Stimmen Sie sich unbedingt mit anderen Teams ab, bevor Sie eine ID zuweisen, da diese während des gesamten Lebenszyklus der Karte verwendet wird und später nicht mehr geändert werden sollte. Weitere Informationen finden Sie unter Platzierungs-IDs.

Schritt 2: Platzierungen in Ihrer App aktualisieren

Um Platzierungen zu aktualisieren, rufen Sie requestBannersRefresh() für Ihr SDK auf.

requestBannersRefresh() wird mit dem vorhandenen Banner-Cache zusammengeführt. Nur die von Ihnen übergebenen Platzierungs-IDs werden hinzugefügt, aktualisiert oder entfernt:

• Wenn der Server ein Banner für eine angeforderte Platzierung zurückgibt, wird das zwischengespeicherte Banner für diese Platzierung ersetzt.
• Wenn der Server kein Banner für eine angeforderte Platzierung zurückgibt, wird diese Platzierung aus dem Cache entfernt.
• Zwischengespeicherte Banner für Platzierungen, die Sie nicht angefordert haben, bleiben bis zum Ablauf im Cache.

Informationen darüber, wie viele Platzierungen Sie pro Aktualisierung anfordern können, finden Sie unter Über Platzierungsanfragen. Sie können im Laufe der Zeit verschiedene Gruppen von Platzierungen aktualisieren (z. B. Platzierungen auf dem aktuellen Bildschirm) und Banner für andere Platzierungen im Cache behalten.

Das Aktualisierungsverhalten von Bannern hat zwei Pfade:

1. Explizite Aktualisierung: Sie können die Aktualisierungsmethode jederzeit während einer aktiven Sitzung aufrufen.
2. Automatische Aktualisierung bei neuer Sitzung: Nachdem Sie mindestens eine explizite Aktualisierungsanfrage gestellt haben, kann das SDK die zuletzt angeforderten Platzierungs-IDs erneut anfordern, wenn eine neue Braze-Sitzung beginnt (z. B. nach changeUser() oder nach einem Sitzungs-Timeout).

Die Rolle von subscribeToBannersUpdates() unterscheidet sich je nach Plattform:

• iOS und Android: subscribeToBannersUpdates() (oder subscribeToUpdates() in Swift) registriert einen Update-Callback. Die automatische Aktualisierung beim Sitzungsstart ist nicht davon abhängig, ob das Abo aktiv ist.
• Web: Die automatische Aktualisierung beim Sitzungsstart ist an die Registrierung von subscribeToBannersUpdates() gebunden. Ohne ein aktives Abo wiederholt das SDK die Aktualisierung bei einer neuen Sitzung nicht automatisch.

In allen Fällen müssen Sie pro App-Lebenszyklus mindestens eine explizite Aktualisierungsanfrage stellen, damit das SDK weiß, welche Platzierungs-IDs aktuell gehalten werden sollen. Banner werden beim ersten Start nicht automatisch abgerufen, wenn dieser initiale Aufruf fehlt, und die nachverfolgten Platzierungs-IDs werden nach dem Neustart der App zurückgesetzt.

Automatische Aktualisierungen beim Sitzungsstart verbrauchen kein Rate-Limiting-Token.

Tipp

Aktualisieren Sie Platzierungen so früh wie möglich, um Verzögerungen beim Herunterladen oder Anzeigen von Bannern zu vermeiden.

• web
• swift
• android
• react native
• unity
• cordova
• flutter
• roku

1
2
3

import * as braze from "@braze/web-sdk";

braze.requestBannersRefresh(["global_banner", "navigation_square_banner"]);

1

AppDelegate.braze?.banners.requestBannersRefresh(placementIds: ["global_banner", "navigation_square_banner"])

1
2
3
4

ArrayList<String> placementIds = new ArrayList<>();
placementIds.add("global_banner");
placementIds.add("navigation_square_banner");
Braze.getInstance(context).requestBannersRefresh(placementIds);

1

Braze.getInstance(context).requestBannersRefresh(listOf("global_banner", "navigation_square_banner"))

1

Braze.requestBannersRefresh(["global_banner", "navigation_square_banner"]);

1

This feature is not currently supported on Unity.

1

This feature is not currently supported on Cordova.

1

braze.requestBannersRefresh(["global_banner", "navigation_square_banner"]);

1

This feature is not currently supported on Roku.

Schritt 3: Auf Updates lauschen

Tipp

Wenn Sie Banner mithilfe der SDK-Methoden in diesem Leitfaden einfügen, werden alle Analytics-Ereignisse (wie Impressionen und Klicks) automatisch verarbeitet, und Impressionen werden nur protokolliert, wenn das Banner sichtbar ist.

• web
• swift
• android
• react native
• unity
• cordova
• flutter
• roku

• javascript
• react

Wenn Sie reines JavaScript mit dem Web Braze SDK verwenden, nutzen Sie subscribeToBannersUpdates, um auf Platzierungs-Updates zu lauschen, und rufen Sie dann requestBannersRefresh auf, um sie abzurufen.

1
2
3
4
5
6
7
8

import * as braze from "@braze/web-sdk";

braze.subscribeToBannersUpdates((banners) => {
  console.log("Banners were updated");
});

// always refresh after your subscriber function has been registered
braze.requestBannersRefresh(["global_banner", "navigation_square_banner"]);

Wenn Sie React mit dem Web Braze SDK verwenden, richten Sie subscribeToBannersUpdates innerhalb eines useEffect-Hooks ein und rufen Sie requestBannersRefresh auf, nachdem Sie Ihren Listener registriert haben.

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

import * as braze from "@braze/web-sdk";

useEffect(() => {
  const subscriptionId = braze.subscribeToBannersUpdates((banners) => {
    console.log("Banners were updated");
  });

  // always refresh after your subscriber function has been registered
  braze.requestBannersRefresh(["global_banner", "navigation_square_banner"]);

  // cleanup listeners
  return () => {
    braze.removeSubscription(subscriptionId);
  }
}, []);

Hinweis

Ihr Banner-Update-Listener spiegelt den In-Memory-Banner-Zustand des SDK wider. Ein einzelnes Update kann Platzierungen enthalten, die bereits zwischengespeichert waren (z. B. von einer früheren Aktualisierung, einem anderen Bildschirm oder automatischer SDK-Arbeit), nicht nur die Platzierungs-IDs aus Ihrem letzten requestBannersRefresh-Aufruf. Wenn Sie sich nur für bestimmte Platzierungen interessieren, prüfen Sie die Platzierungs-ID jedes Banners in Ihrem Listener und überspringen Sie den Rest. Nachdem Sie Ihren Listener registriert haben, rufen Sie requestBannersRefresh für die Platzierungen auf, die Sie von Braze synchronisieren möchten.

1
2
3
4
5
6
7
8

let placementIds = ["global_banner", "navigation_square_banner"]
let cancellable = brazeClient.braze()?.banners.subscribeToUpdates { banners in
  banners.forEach { placementId, banner in
    print("Received banner: \(banner) with placement ID: \(placementId)")
  }
}
// Always refresh after your subscriber is registered
brazeClient.braze()?.banners.requestBannersRefresh(placementIds: placementIds)

Hinweis

Ihr Banner-Update-Listener spiegelt den In-Memory-Banner-Zustand des SDK wider. Ein einzelnes Update kann Platzierungen enthalten, die bereits zwischengespeichert waren (z. B. von einer früheren Aktualisierung, einem anderen Bildschirm oder automatischer SDK-Arbeit), nicht nur die Platzierungs-IDs aus Ihrem letzten requestBannersRefresh-Aufruf. Wenn Sie sich nur für bestimmte Platzierungen interessieren, prüfen Sie die Platzierungs-ID jedes Banners in Ihrem Listener und überspringen Sie den Rest. Nachdem Sie Ihren Listener registriert haben, rufen Sie requestBannersRefresh für die Platzierungen auf, die Sie von Braze synchronisieren möchten.

• java
• kotlin

1
2
3
4
5
6
7
8
9
10

ArrayList<String> placementIds = new ArrayList<>();
placementIds.add("global_banner");
placementIds.add("navigation_square_banner");
Braze.getInstance(context).subscribeToBannersUpdates(banners -> {
  for (Banner banner : banners.getBanners()) {
    Log.d(TAG, "Received banner: " + banner.getPlacementId());
  }
});
// Always refresh after your subscriber is registered
Braze.getInstance(context).requestBannersRefresh(placementIds);

1
2
3
4
5
6
7
8

val placementIds = listOf("global_banner", "navigation_square_banner")
Braze.getInstance(context).subscribeToBannersUpdates { update ->
  for (banner in update.banners) {
    Log.d(TAG, "Received banner: " + banner.placementId)
  }
}
// Always refresh after your subscriber is registered
Braze.getInstance(context).requestBannersRefresh(placementIds)

1
2
3
4
5
6
7
8
9
10

const bannerCardsSubscription = Braze.addListener(
  Braze.Events.BANNER_CARDS_UPDATED,
  (data) => {
    const banners = data.banners;
    console.log(
      `Received ${banners.length} Banner Cards with placement IDs:`,
      banners.map((banner) => banner.placementId)
    );
  }
);

1

This feature is not currently supported on Unity.

1

This feature is not currently supported on Cordova.

1
2
3
4
5

StreamSubscription bannerStreamSubscription = braze.subscribeToBanners((List<BrazeBanner> banners) {
  for (final banner in banners) {
    print("Received banner: " + banner.toString());
  }
});

1

This feature is not currently supported on Roku.

Schritt 4: Mithilfe der Platzierungs-ID einfügen

Tipp

Eine vollständige Schritt-für-Schritt-Anleitung finden Sie unter Ein Banner anhand der Platzierungs-ID anzeigen.

• web
• swift
• android
• react native
• unity
• cordova
• flutter
• roku

Erstellen Sie ein Container-Element für das Banner. Achten Sie darauf, Breite und Höhe festzulegen.

1

<div id="global-banner-container" style="width: 100%; height: 450px;"></div>

• javascript
• react

Wenn Sie reines JavaScript mit dem Web Braze SDK verwenden, rufen Sie die insertBanner-Methode auf, um den inneren HTML-Inhalt des Container-Elements zu ersetzen.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

import * as braze from "@braze/web-sdk";

braze.initialize("sdk-api-key", {
  baseUrl: "sdk-base-url",
  allowUserSuppliedJavascript: true, // banners require you to opt-in to user-supplied javascript
});

braze.subscribeToBannersUpdates((banners) => {
  // get this placement's banner. If it's `null` the user did not qualify for one.
  const globalBanner = braze.getBanner("global_banner");
  if (!globalBanner) {
    return;
  }

  // choose where in the DOM you want to insert the banner HTML
  const container = document.getElementById("global-banner-container");

  // Insert the banner which replaces the innerHTML of that container
  braze.insertBanner(globalBanner, container);

  // Special handling if the user is part of a Control Variant
  if (globalBanner.isControl) {
    // hide or collapse the container
    container.style.display = "none";
  }
});

braze.requestBannersRefresh(["global_banner", "navigation_square_banner"]);

Wenn Sie React mit dem Web Braze SDK verwenden, rufen Sie die insertBanner-Methode mit einer ref auf, um den inneren HTML-Inhalt des Container-Elements zu ersetzen.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

import { useRef } from 'react';
import * as braze from "@braze/web-sdk";

export default function App() {
    const bannerRef = useRef<HTMLDivElement>(null);

    useEffect(() => {
       const globalBanner = braze.getBanner("global_banner");
       if (!globalBanner || globalBanner.isControl) {
           // hide the container
       } else {
           // insert the banner to the container node
           braze.insertBanner(globalBanner, bannerRef.current);
       }
    }, []);
    return <div ref={bannerRef}></div>
}

Tipp

Um Impressionen zu tracken, stellen Sie sicher, dass Sie insertBanner auch für isControl aufrufen. Sie können den Container anschließend ausblenden oder zusammenklappen.

Nach einer Aktualisierung aktualisiert das SDK eine BannerUIView oder BannerView nur, wenn sich der zwischengespeicherte Inhalt dieser Platzierung ändert (hinzugefügt, entfernt oder aktualisiert). Unverändert angezeigte Banner bleiben wie sie sind. Der Aufruf von changeUser() aktualisiert jede registrierte Banner-Ansicht.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

// To get access to the Banner model object:
let globalBanner: Braze.Banner?
AppDelegate.braze?.banners.getBanner(for: "global_banner", { banner in
  self.globalBanner = banner
})

// UIKit implementation:
// If you simply want the Banner view, initialize a `UIView` with the placement ID:
if let braze = AppDelegate.braze {
  let bannerUIView = BrazeBannerUI.BannerUIView(
    placementId: "global_banner",
    braze: braze,
    // iOS does not perform automatic resizing or visibility changes.
    // Use the `processContentUpdates` parameter to adjust the size and visibility of your Banner according to your use case.
    processContentUpdates: { result in
      switch result {
      case .success(let updates):
        if let height = updates.height {
          // Adjust the visibility and/or height.
        }
      case .failure(let error):
        // Handle the error.
      }
    }
  )
}

// SwiftUI implementation:
// Similarly, if you want a Banner view in SwiftUI, use the corresponding `BannerView` initializer:
if let braze = AppDelegate.braze {
  let bannerView = BrazeBannerUI.BannerView(
    placementId: "global_banner",
    braze: braze,
    // iOS does not perform automatic resizing or visibility changes.
    // Use the `processContentUpdates` parameter to adjust the size and visibility of your Banner according to your use case.
    processContentUpdates: { result in
      switch result {
      case .success(let updates):
        if let height = updates.height {
          // Adjust the visibility and/or height according to your parent controller.
        }
      case .failure(let error):
        // Handle the error.
      }
    }
  )
}

Nach einer Aktualisierung aktualisiert das SDK eine BannerView nur, wenn sich der zwischengespeicherte Inhalt dieser Platzierung ändert (hinzugefügt, entfernt oder aktualisiert). Unverändert angezeigte Banner bleiben wie sie sind. Der Aufruf von changeUser() aktualisiert weiterhin jede registrierte BannerView.

• java
• kotlin

Um das Banner im Java-Code zu erhalten, verwenden Sie:

1

Banner globalBanner = Braze.getInstance(context).getBanner("global_banner");

Sie können Banner in Ihrem Android-Views-Layout erstellen, indem Sie dieses XML einfügen:

1
2
3
4
5

<com.braze.ui.banners.BannerView
    android:id="@+id/global_banner_id"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    app:placementId="global_banner" />

Wenn Sie Android Views verwenden, nutzen Sie dieses XML:

1
2
3
4
5

<com.braze.ui.banners.BannerView
    android:id="@+id/global_banner_id"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    app:placementId="global_banner" />

Um Jetpack Compose zu verwenden, fügen Sie das Artefakt com.braze:android-sdk-jetpack-compose zu Ihrem App-Modul hinzu. Verwenden Sie die gleiche Version wie Ihre anderen Braze Android SDK-Abhängigkeiten. Dieses Modul ist von android-sdk-ui getrennt und enthält das Banner-Composable unter com.braze.jetpackcompose.banners.

Hinweis

Einige Compose-UI-Bibliotheken definieren ihr eigenes Banner-Composable. Importieren Sie com.braze.jetpackcompose.banners.Banner explizit, damit Sie die API von Braze aufrufen.

1
2
3
4
5
6

import com.braze.jetpackcompose.banners.Banner

@Composable
fun myBannerSlot() {
    Banner(placementId = "global_banner")
}

Optional können Sie heightCallback übergeben, um die gerenderte Höhe in dp zu erhalten, wenn sich die Banner-Größe ändert. Als Referenz siehe die KDoc für Banner.

Wenn Sie das Jetpack Compose-Modul nicht hinzufügen, umschließen Sie BannerView in AndroidView:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

import android.view.ViewGroup
import androidx.compose.runtime.Composable
import androidx.compose.ui.viewinterop.AndroidView
import com.braze.ui.banners.BannerView

@Composable
fun myBannerSlot() {
    AndroidView(
        factory = { context ->
            BannerView(context, "global_banner").apply {
                layoutParams = ViewGroup.LayoutParams(
                    ViewGroup.LayoutParams.MATCH_PARENT,
                    ViewGroup.LayoutParams.WRAP_CONTENT
                )
            }
        },
        update = { it.placementId = "global_banner" }
    )
}

Um das Banner in Kotlin zu erhalten, verwenden Sie:

1

val banner = Braze.getInstance(context).getBanner("global_banner")

Wenn Sie die neue Architektur von React Native verwenden, müssen Sie BrazeBannerView als Fabric-Komponente in Ihrer AppDelegate.mm registrieren.

1
2
3
4
5
6
7
8

#ifdef RCT_NEW_ARCH_ENABLED
/// Register the `BrazeBannerView` for use as a Fabric component.
- (NSDictionary<NSString *,Class<RCTComponentViewProtocol>> *)thirdPartyFabricComponents {
  NSMutableDictionary * dictionary = [super thirdPartyFabricComponents].mutableCopy;
  dictionary[@"BrazeBannerView"] = [BrazeBannerView class];
  return dictionary;
}
#endif

Für die einfachste Integration fügen Sie das folgende JavaScript-XML-(JSX)-Snippet in Ihre Ansichtshierarchie ein und geben Sie lediglich die Platzierungs-ID an.

1
2
3

<Braze.BrazeBannerView
  placementId='global_banner'
/>

Um das Datenmodell des Banners in React Native zu erhalten oder zu prüfen, ob diese Platzierung im Cache des Nutzers/der Nutzerin vorhanden ist, verwenden Sie:

1

const banner = await Braze.getBanner("global_banner");

1

This feature is not currently supported on Unity.

1

This feature is not currently supported on Cordova.

Für die einfachste Integration fügen Sie das folgende Widget in Ihre Ansichtshierarchie ein und geben Sie lediglich die Platzierungs-ID an.

1
2
3
4

BrazeBannerView(
  placementId: "global_banner",
),
To get the Banner's data model in Flutter, use:

Sie können die Methode getBanner verwenden, um zu prüfen, ob diese Platzierung im Cache des Nutzers/der Nutzerin vorhanden ist.

1
2
3
4
5
6
7

braze.getBanner("global_banner").then((banner) {
  if (banner == null) {
    // Handle null cases.
  } else {
    print(banner.toString());
  }
});

1

This feature is not currently supported on Roku.

Schritt 5: Ein Test-Banner senden (optional)

Bevor Sie eine Banner-Campaign starten, können Sie ein Test-Banner senden, um Ihre Integration zu überprüfen. Test-Banner werden in einem separaten In-Memory-Cache gespeichert und bleiben nicht über App-Neustarts hinweg erhalten. Es ist keine zusätzliche Einrichtung erforderlich, aber Ihr Testgerät muss in der Lage sein, Vordergrund-Push-Benachrichtigungen zu empfangen, damit der Test angezeigt werden kann.

Hinweis

Test-Banner verhalten sich wie alle anderen Banner, werden aber bei der nächsten App-Sitzung entfernt.

Impressionen protokollieren

Braze protokolliert Impressionen für Banner, die sichtbar sind, automatisch, wenn Sie SDK-Methoden verwenden, um ein Banner einzufügen—es ist also nicht nötig, Impressionen manuell zu tracken.

Klicks protokollieren

Die Methode zum Protokollieren von Banner-Klicks hängt davon ab, wie Ihr Banner gerendert wird und wo sich Ihr Klick-Handler befindet.

Standard-Banner-Inhalt (automatisch)

Wenn Sie die standardmäßigen, mitgelieferten SDK-Methoden zum Einfügen von Bannern verwenden und Ihr Banner Standard-Editor-Komponenten (Bilder, Buttons, Text) nutzt, werden Klicks automatisch getrackt. Das SDK fügt diesen Elementen Klick-Listener hinzu, und es ist kein zusätzlicher Code erforderlich.

Custom-Code-Blöcke

Wenn Ihr Banner den Custom Code-Editor-Block im Braze-Dashboard verwendet, müssen Sie brazeBridge.logClick() nutzen, um Klicks aus diesem benutzerdefinierten HTML heraus zu protokollieren. Dies gilt auch bei Verwendung von SDK-Methoden zum Rendern des Banners, da das SDK Listenern nicht automatisch an Elemente innerhalb Ihres benutzerdefinierten Codes anhängen kann.

1
2
3

<button onclick="brazeBridge.logClick()">
  Click me
</button>

Die vollständige Referenz finden Sie unter Benutzerdefinierter Code und JavaScript-Brücke für Banner. Die brazeBridge stellt eine Kommunikationsschicht zwischen dem internen HTML des Banners und dem übergeordneten Braze SDK bereit.

Benutzerdefinierte UI-Implementierungen (headless)

Wenn Sie eine vollständig benutzerdefinierte UI mithilfe der benutzerdefinierten Eigenschaften des Banners erstellen, anstatt das Banner-HTML zu rendern, müssen Sie Klicks und Impressionen manuell aus Ihrem Anwendungscode heraus protokollieren. Da das SDK das Banner nicht rendert, kann es Interaktionen mit Ihren benutzerdefinierten UI-Elementen nicht automatisch tracken.

Methodensignaturen und vollständige Details finden Sie in der Braze SDK-Referenzdokumentation.

Impressionen protokollieren

Rufen Sie die Banner-Impressionsmethode der jeweiligen Plattform auf, wenn Ihre benutzerdefinierte UI das Banner als „angesehen“ betrachtet. Implementieren Sie eine robuste Logik dafür, was als Impression zählt, um doppelte Ereignisse zu vermeiden – protokollieren Sie z. B. nur dann, wenn das Banner in den Viewport eintritt (oder gleichwertig), und nicht erneut, wenn dasselbe Banner zurück in den sichtbaren Bereich gescrollt wird oder wenn Ihre Komponente ohne ein neues View-Ereignis neu gerendert wird.

• web
• android
• swift
• react native
• flutter

1
2
3
4
5
6
7

import * as braze from "@braze/web-sdk";

// Log impression when your custom UI considers the banner viewed (for example, once when it enters viewport)
const banner = braze.getBanner("placement_id_homepage_top");
if (banner) {
  braze.logBannerImpressions([banner]);
}

1
2

// Log impression when your custom UI considers the banner viewed (for example, once when it enters viewport)
Braze.getInstance(context).logBannerImpression("placement_id_homepage_top")

1
2

// Log impression when your custom UI considers the banner viewed (for example, once when it enters viewport)
Braze.getInstance(context).logBannerImpression("placement_id_homepage_top");

1
2
3
4

// Retrieve a banner and log an impression on it (for example, once when it enters viewport)
braze.banners.getBanner(for: "placement_id_homepage_top") { banner in
  banner?.context.logImpression()
}

1
2

// Log impression when your custom UI considers the banner viewed (for example, once when it enters viewport)
Braze.logBannerImpression("placement_id_homepage_top");

1
2

// Log impression when your custom UI considers the banner viewed (for example, once when it enters viewport)
braze.logBannerImpression("placement_id_homepage_top");

Klicks protokollieren

Rufen Sie die Banner-Klick-Methode der jeweiligen Plattform auf, wenn Nutzer:innen auf Ihr benutzerdefiniertes Banner (oder einen bestimmten Button) tippen. Übergeben Sie die optionale buttonId, wenn der Klick auf einen bestimmten Button erfolgt, damit die Analytics den Klick korrekt zuordnen können.

• web
• android
• swift
• react native
• flutter

1
2
3
4

import * as braze from "@braze/web-sdk";

// Log click
braze.logBannerClick("placement_id_homepage_top", buttonId);  // buttonID is optional

1
2

// Log click
Braze.getInstance(context).logBannerClick("placement_id_homepage_top", buttonId)  // buttonID parameter can be null

1
2

// Log click
Braze.getInstance(context).logBannerClick("placement_id_homepage_top", buttonId);  // buttonID parameter can be null

1
2
3
4

// Retrieve a banner and log a click on it
braze.banners.getBanner(for: "placement_id_homepage_top") { banner in
  banner?.context.logClick(buttonId: buttonId)  // buttonID is optional
}

1
2

// Log click
Braze.logBannerClick("placement_id_homepage_top", buttonId);  // buttonID is optional

1
2

// Log click
braze.logBannerClicked("placement_id_homepage_top", buttonId);  // buttonID parameter can be null

Dismissals protokollieren

Banner-Dismissals entfernen ein Banner programmatisch aus einer Platzierung, wenn Nutzer:innen es aktiv schließen. Nach dem Schließen wird das Banner für diese:n Nutzer:in unterdrückt. Beim nächsten Aktualisieren der Platzierungsliste wird ein neues Banner zurückgegeben, sofern die:der Nutzer:in für eines qualifiziert ist.

Voraussetzungen

Dies sind die mindestens erforderlichen SDK-Versionen, um Banner-Dismissals zu protokollieren:

Integrationen

Standard-Banner-Integrationen (Drag-and-Drop-Editor)

Wenn Ihr Banner den Drag-and-Drop-Editor verwendet und eine Schließen-Button-Komponente enthält, ist kein zusätzlicher Code erforderlich. Wenn Nutzer:innen auf den Schließen-Button klicken, wird die Nachricht ausgeblendet, ein Dismissal ausgelöst und anschließend ein Dismissal-Ereignis für Analytics aufgezeichnet.

Custom-Code-Blöcke

Wenn Ihr Banner den Custom Code-Editor-Block verwendet, können Sie ein Dismissal direkt aus dem HTML des Banners heraus mit brazeBridge.closeMessage() auslösen.

1
2
3

<button onclick="brazeBridge.closeMessage()">
  Dismiss
</button>

Ein Banner programmatisch schließen

Wenn Sie die Standard-BrazeBannerView mit dem im Drag-and-Drop-Editor erstellten Schließen-Button verwenden, ist kein zusätzlicher Code erforderlich – das Dismissal wird automatisch verarbeitet.

Für benutzerdefinierte UI-Integrationen können Sie die Dismiss-Methode direkt auf Ihrer Braze-Instanz aufrufen, um ein Banner programmatisch zu schließen und ein Dismissal-Ereignis zu protokollieren. Die Dismiss-Methode kann mehrfach sicher aufgerufen werden – das SDK ignoriert doppelte Aufrufe für dasselbe Banner.

Dies sind die mindestens erforderlichen SDK-Versionen, um ein Banner programmatisch zu schließen:

• web
• android
• swift
• react native
• flutter

1
2
3
4
5
6
7
8

import * as braze from "@braze/web-sdk";

const banners = braze.getAllBanners();
const banner = banners["global_banner"];

if (banner) {
  braze.dismissBanner(banner);
}

1
2
3
4
5
6
7
8

import * as braze from "@braze/web-sdk";

const banners = braze.getAllBanners();
const banner = banners["global_banner"];

if (banner) {
  braze.dismissBanner(banner);
}

1

Braze.getInstance(context).dismissBanner("your-placement-id");

1

Braze.getInstance(context).dismissBanner("your-placement-id")

1
2
3
4
5

// Preferred: dismiss via context.
banner.context?.dismiss()

// Fallback: if context is unavailable.
banner.dismiss(using: braze)

1

Braze.dismissBanner("your-placement-id");

1

braze.dismissBanner("your-placement-id");

Benutzerdefinierte Analytics bei Banner-Dismissal protokollieren

Um benutzerdefinierte Logik auszuführen, wenn ein Banner geschlossen wird – etwa um Analytics zu protokollieren – verwenden Sie den Dismiss-Callback für Ihr SDK. Der Callback erhält ein Event-Objekt mit der placementId, dem stableKey und der trackingId des Banners.

• web
• android
• swift
• react native
• flutter

Verwenden Sie Banner.subscribeToDismissedEvent(), um benutzerdefinierte Logik auszuführen, wenn ein bestimmtes Banner geschlossen wird. Abonnieren Sie das Ereignis, bevor Sie das Banner anzeigen.

Hinweis

Banner.subscribeToDismissedEvent() erfordert Web SDK 6.9.0 oder höher. In früheren Versionen verwenden Sie braze.subscribeToBannersUpdates() und erkennen ein Dismissal, indem Sie prüfen, ob das Banner in der aktualisierten Banner-Map nicht mehr vorhanden ist.

• javascript
• react

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

import * as braze from "@braze/web-sdk";

braze.subscribeToBannersUpdates((banners) => {
  const banner = banners["global_banner"];

  if (banner) {
    banner.subscribeToDismissedEvent(() => {
      // Run any custom logic here, such as logging custom analytics
      console.log("Banner was dismissed");
    });
  }
});

braze.requestBannersRefresh(["global_banner"]);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

import { useEffect } from "react";
import * as braze from "@braze/web-sdk";

useEffect(() => {
  const subscriptionId = braze.subscribeToBannersUpdates((banners) => {
    const banner = banners["global_banner"];

    if (banner) {
      banner.subscribeToDismissedEvent(() => {
        // Run any custom logic here, such as logging custom analytics
        console.log("Banner was dismissed");
      });
    }
  });

  braze.requestBannersRefresh(["global_banner"]);

  return () => {
    braze.removeSubscription(subscriptionId);
  };
}, []);

Setzen Sie die optionale onDismissCallback-Eigenschaft auf BannerView.

• java
• kotlin

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

import android.util.Log;
import com.braze.ui.banners.BannerView;
import kotlin.Unit;

// After obtaining your BannerView instance (for example from XML via findViewById, or `new BannerView(context, "global_banner")`)

bannerView.setOnDismissCallback((snapshot) -> {
  Log.d(TAG, "placementId: " + snapshot.getPlacementId()
    + ", stableKey: " + snapshot.getStableKey()
    + ", trackingId: " + snapshot.getTrackingId());

  // Run any custom logic here, such as logging custom analytics
  return Unit.INSTANCE;
});

1
2
3
4
5
6
7
8
9
10

import android.util.Log
import com.braze.ui.banners.BannerView

// After obtaining your BannerView instance (for example via findViewById or `BannerView(context, "global_banner")`)

bannerView.onDismissCallback = { snapshot ->
  Log.d(TAG, "placementId: ${snapshot.placementId}, stableKey: ${snapshot.stableKey}, trackingId: ${snapshot.trackingId}")

  // Run any custom logic here, such as logging custom analytics
}

1
2
3
4
5
6
7
8
9

// After initializing your banner view instance using UIKit or SwiftUI

bannerView.onDismiss = { event in
  print("Banner dismissed — placementId: \(event.placementId ?? "unknown")")
  print("  stableKey: \(event.stableKey ?? "unknown")")
  print("  trackingId: \(event.trackingId ?? "unknown")")

  // Run any custom logic here, such as logging custom analytics
}

Setzen Sie die onDismiss-Eigenschaft auf Braze.BrazeBannerView, um benutzerdefinierte Logik auszuführen, wenn ein Banner geschlossen wird.

1
2
3
4
5
6
7
8
9

import Braze from "@braze/react-native-sdk";

<Braze.BrazeBannerView
  placementId="global_banner"
  onDismiss={(event) => {
    console.log("placementId:", event.placementId, "stableKey:", event.stableKey, "trackingId:", event.trackingId);
    // Run any custom logic here, such as logging custom analytics
  }}
/>

Setzen Sie den onDismiss-Parameter auf BrazeBannerView, um benutzerdefinierte Logik auszuführen, wenn ein Banner geschlossen wird.

1
2
3
4
5
6
7

BrazeBannerView(
  placementId: 'global_banner',
  onDismiss: (BrazeBannerDismissEvent event) {
    print('placementId: ${event.placementId}, stableKey: ${event.stableKey}, trackingId: ${event.trackingId}');
    // Run any custom logic here, such as logging custom analytics
  },
)

Speicherlimit für ausstehende Dismissals

Dismissal-Ereignisse werden lokal als ausstehende Einträge gespeichert, bis sie beim nächsten requestBannersRefresh-Aufruf mit dem Braze-Server synchronisiert werden können.

Warnung

In seltenen Fällen, in denen sich eine große Anzahl von Dismissals ohne erfolgreiche Synchronisierung ansammelt, können ältere ausstehende Dismissals verworfen werden. In diesem Fall können zuvor geschlossene Banner wieder erscheinen, bis die nächste erfolgreiche Synchronisierung abgeschlossen ist. Um dieses Risiko zu minimieren, rufen Sie requestBannersRefresh auf, wann immer Ihre App wieder über Netzwerkverbindung verfügt.

Abmessungen und Größe

Hier erfahren Sie, was Sie über die Abmessungen und Größe von Bannern wissen müssen:

• Der Composer ermöglicht zwar die Vorschau von Bannern in verschiedenen Abmessungen, diese Informationen werden jedoch nicht gespeichert oder an das SDK gesendet.
• Das HTML nimmt die gesamte Breite des Containers ein, in dem es gerendert wird.
• Wir empfehlen, ein Element mit festen Abmessungen zu erstellen und diese Abmessungen im Composer zu testen.

Benutzerdefinierte Eigenschaften

Sie können benutzerdefinierte Eigenschaften aus Ihrer Banner-Campaign verwenden, um Schlüssel-Wert-Daten über das SDK abzurufen und das Verhalten oder das Erscheinungsbild Ihrer App anzupassen. Beispielsweise könnten Sie:

• Senden Sie Metadaten für Ihre Drittanbieter-Analytics oder Integrationen.
• Verwenden Sie Metadaten wie einen timestamp oder ein JSON-Objekt, um bedingte Logik zu triggern.
• Steuern Sie das Verhalten eines Banners basierend auf enthaltenen Metadaten wie ratio oder format.

Voraussetzungen

Sie müssen Ihrer Banner-Campaign benutzerdefinierte Eigenschaften hinzufügen. Darüber hinaus sind dies die erforderlichen Mindestversionen des SDK, um auf benutzerdefinierte Eigenschaften zugreifen zu können:

Auf benutzerdefinierte Eigenschaften zugreifen

Um auf die benutzerdefinierten Eigenschaften eines Banners zuzugreifen, verwenden Sie eine der folgenden Methoden basierend auf dem im Dashboard definierten Typ der Eigenschaft. Wenn der Schlüssel nicht mit einer Eigenschaft dieses Typs übereinstimmt oder nicht existiert, gibt die Methode null zurück.

• web
• swift
• android
• react native
• flutter

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

// Returns the Banner instance
const banner = braze.getBanner("placement_id_homepage_top");

// banner may be undefined or null
if (banner) {

  // Returns the string property
  const stringProperty = banner.getStringProperty("color");

  // Returns the boolean property
  const booleanProperty = banner.getBooleanProperty("expanded");

  // Returns the number property
  const numberProperty = banner.getNumberProperty("height");

  // Returns the timestamp property (as a number)
  const timestampProperty = banner.getTimestampProperty("account_start");

  // Returns the image URL property as a string of the URL
  const imageProperty = banner.getImageProperty("homepage_icon");

  // Returns the JSON object property
  const jsonObjectProperty = banner.getJsonProperty("footer_settings");
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

// Passes the specified banner to the completion handler
AppDelegate.braze?.banners.getBanner(for: "placement_id_homepage_top") { banner in
  // Returns the string property
  let stringProperty: String? = banner.stringProperty(key: "color")

  // Returns the boolean property
  let booleanProperty: Bool? = banner.boolProperty(key: "expanded")

  // Returns the number property as a double
  let numberProperty: Double? = banner.numberProperty(key: "height")

  // Returns the Unix UTC millisecond timestamp property as an integer
  let timestampProperty: Int? = banner.timestampProperty(key: "account_start")

  // Returns the image property as a String of the image URL
  let imageProperty: String? = banner.imageProperty(key: "homepage_icon")

  // Returns the JSON object property as a [String: Any] dictionary
  let jsonObjectProperty: [String: Any]? = banner.jsonObjectProperty(key: "footer_settings")
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

// Returns the Banner instance
Banner banner = Braze.getInstance(context).getBanner("placement_id_homepage_top");

// banner may be undefined or null
if (banner != null) {
  // Returns the string property
  String stringProperty = banner.getStringProperty("color");

  // Returns the boolean property
  Boolean booleanProperty = banner.getBooleanProperty("expanded");

  // Returns the number property
  Number numberProperty = banner.getNumberProperty("height");

  // Returns the timestamp property (as a Long)
  Long timestampProperty = banner.getTimestampProperty("account_start");

  // Returns the image URL property as a String of the URL
  String imageProperty = banner.getImageProperty("homepage_icon");

  // Returns the JSON object property as a JSONObject
  JSONObject jsonObjectProperty = banner.getJSONProperty("footer_settings");
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

// Returns the Banner instance
val banner: Banner = Braze.getInstance(context).getBanner("placement_id_homepage_top") ?: return

// Returns the string property
val stringProperty: String? = banner.getStringProperty("color")

// Returns the boolean property
val booleanProperty: Boolean? = banner.getBooleanProperty("expanded")

// Returns the number property
val numberProperty: Number? = banner.getNumberProperty("height")

// Returns the timestamp property (as a Long)
val timestampProperty: Long? = banner.getTimestampProperty("account_start")

// Returns the image URL property as a String of the URL
val imageProperty: String? = banner.getImageProperty("homepage_icon")

// Returns the JSON object property as a JSONObject
val jsonObjectProperty: JSONObject? = banner.getJSONProperty("footer_settings")

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

// Get the Banner instance
const banner = await Braze.getBanner('placement_id_homepage_top');
if (!banner) return;

// Get the string property
const stringProperty = banner.getStringProperty('color');

// Get the boolean property
const booleanProperty = banner.getBooleanProperty('expanded');

// Get the number property
const numberProperty = banner.getNumberProperty('height');

// Get the timestamp property (as a number)
const timestampProperty = banner.getTimestampProperty('account_start');

// Get the image URL property as a string
const imageProperty = banner.getImageProperty('homepage_icon');

// Get the JSON object property
const jsonObjectProperty = banner.getJSONProperty('footer_settings');

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

// Fetch the banner asynchronously
_braze.getBanner(placementId).then(('placement_id_homepage_top') {
  // Get the string property
  final String? stringProperty = banner?.getStringProperty('color');

  // Get the boolean property
  final bool? booleanProperty = banner?.getBooleanProperty('expanded');

  // Get the number property
  final num? numberProperty = banner?.getNumberProperty('height');

  // Get the timestamp property
  final int? timestampProperty = banner?.getTimestampProperty('account_start');

  // Get the image URL property
  final String? imageProperty = banner?.getImageProperty('homepage_icon');

  // Get the JSON object property
  final Map<String, dynamic>? jsonObjectProperty = banner?.getJSONProperty('footer_settings');

  // Use these properties as needed in your UI or logic
});