Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hotfix: Cleaning up feature flags + banner cards #8604

Merged
merged 6 commits into from
Dec 10, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
nav_title: Banner Cards
article_title: Banner Cards
page_order: 4
layout: dev_guide
hidden: true
guide_top_header: "Banner Cards"
Expand All @@ -12,15 +11,17 @@ channel:

guide_featured_title: "Section articles"
guide_featured_list:
- name: Creating placements
link: /docs/developer_guide/banner_cards/creating_placements/
image: /assets/img/braze_icons/compass-01.svg
- name: Creating Banner Cards
link: /docs/create_banner_card/
image: /assets/img/braze_icons/channel-content-cards.svg
- name: Integrating Banner Cards
link: /docs/developer_guide/platform_wide/banner_cards/integration/
link: /docs/developer_guide/banner_cards/integration/
image: /assets/img/braze_icons/code-01.svg
---

{% alert important %}
Banner Cards are currently in early access. Contact your Braze account manager if you’re interested in participating in this early access.
{% endalert %}

54 changes: 54 additions & 0 deletions _docs/_developer_guide/banner_cards/creating_placements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
nav_title: Creating placements
article_title: Creating Banner Card placements for the Braze SDK
hidden: true
description: "This reference article covers Banner Cards and how to integrate this feature in the Braze SDK."
platform:
- iOS
- Android
- Web

---

# Creating Banner Card placements

> Before launching a Banner Card campaign in your app, you'll need to create a placement in the Braze dashboard. Placements are locations that you define in your app that can display Banner Cards.

{% alert important %}
Banner Cards are currently in early access. Contact your Braze account manager if you’re interested in participating in this early access.
{% endalert %}

## Prerequisites

These are the minimum SDK versions to start using Banner Cards:

{% sdk_min_versions swift:11.3.0 android:33.1.0 web:5.6.0 %}

## Creating a placement

### Step 1: Create a new placement

Go to **Settings** > **Banner Cards Placements**, then select **Create Placement**.

![Banner Card Placements section to create placement IDs.]({% image_buster /assets/img/banner_cards/create_placement.png %})

### Step 2: Fill in the details

Name your placement and give it a **Placement ID**. Optionally, you can add a description for your placement.

Work with your marketing team to create this ID. This is the ID you'll reference in your app's code, and your marketing team will use the ID to assign a campaign to the location in your app.

{% alert important %}
Avoid editing your placement ID after launch, as this can break the integration with your app or website.
{% endalert %}

![Placement details that designate a Banner Card will display in the left sidebar for spring sale promotion campaigns.]({% image_buster /assets/img/banner_cards/placement_details_example.png %})

For steps on how to launch a Banner Card campaign, refer to [Creating a Banner Card]({{site.baseurl}}/create_banner_card/).

## Next steps

Now that you've created your Banner Card placements, you can:

- [Integrate Banner Cards]({{site.baseurl}}/developer_guide/banner_cards/integration/)
- [Create Banner Cards]({{site.baseurl}}/create_banner_card/)
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
nav_title: Integrating Banner Cards
article_title: Integrating Banner Cards
nav_title: Banner Cards
article_title: Banner Cards for the Braze SDK
hidden: true
description: "This reference article covers Banner Cards and how to integrate this feature in the Braze SDK."
platform:
Expand All @@ -12,43 +12,23 @@ platform:

# Integrating Banner Cards

Similar to [Content Cards]({{site.baseurl}}/user_guide/message_building_by_channel/content_cards/about), Banner Cards are embedded directly in your app or website so that you can engage users with an experience that feels natural. They’re a quick and seamless solution to create personalized messaging for your users all while extending the reach of other channels (such as email or push notifications).
> Similar to [Content Cards]({{site.baseurl}}/user_guide/message_building_by_channel/content_cards/about), Banner Cards are embedded directly in your app or website so that you can engage users with an experience that feels natural. They’re a quick and seamless solution to create personalized messaging for your users all while extending the reach of other channels (such as email or push notifications).

{% alert important %}
Banner Cards are currently in early access. Contact your Braze account manager if you’re interested in participating in this early access.
{% endalert %}

This feature is available as of the following [SDK versions]({{site.baseurl}}/user_guide/engagement_tools/campaigns/ideas_and_strategies/new_features/#filtering-by-most-recent-app-versions):
## Prerequisites

{% sdk_min_versions swift:11.3.0 android:33.1.0 web:5.6.0 %}

## Dashboard prerequisites

### Define placements {#define-placements}

Before launching a Banner Card campaign in your app, you must set up a placement in the Braze dashboard. Placements are locations that you define in your app that can display Banner Cards.

#### Step 1: Create a new placement

Go to **Settings** > **Banner Cards Placements**, then select **Create Placement**.

![Banner Card Placements section to create placement IDs.]({% image_buster /assets/img/banner_cards/create_placement.png %})

#### Step 2: Fill in the details
Before you can integrate Banner Cards, you'll need to [create Banner Card placements]({{site.baseurl}}/developer_guide/banner_cards/creating_placements) in your app.

Name your placement and give it a **Placement ID**. Optionally, you can add a description for your placement.
In addition, these are the minimum SDK versions needed to start using Banner Cards:

Work with your marketing team to create this ID. This is the ID you'll reference in your app's code, and your marketing team will use the ID to assign a campaign to the location in your app.

{% alert important %}
Avoid editing your placement ID after launch, as this can break the integration with your app or website.
{% endalert %}

![Placement details that designate a Banner Card will display in the left sidebar for spring sale promotion campaigns.]({% image_buster /assets/img/banner_cards/placement_details_example.png %})
{% sdk_min_versions swift:11.3.0 android:33.1.0 web:5.6.0 %}

For steps on how to launch a Banner Card campaign, refer to [Creating a Banner Card]({{site.baseurl}}/create_banner_card/).
## Integrating Banner Cards

## Refresh placements in your app {#requestBannersRefresh}
### Step 2: Refresh placements in your app {#requestBannersRefresh}

Placements can be requested each session and will be cached automatically when a user's session expires or when you change identified users using the `changeUser` method.

Expand Down Expand Up @@ -119,7 +99,7 @@ This feature is not currently supported on Roku.
{% endtab %}
{% endtabs %}

## Listen for updates {#subscribeToBannersUpdates}
### Step 3: Listen for updates {#subscribeToBannersUpdates}

{% alert tip %}
If you insert banners using the SDK methods in this guide, all analytics events will be handled automatically. If you want to manually render the HTML, [let us know](mailto:banners-feedback@braze.com).
Expand Down Expand Up @@ -202,7 +182,7 @@ This feature is not currently supported on Roku.
{% endtab %}
{% endtabs %}

## Get and insert a Banner Card by placement ID {#insertBanner}
### Step 4: Insert cards by placement ID {#insertBanner}

{% tabs %}
{% tab JavaScript %}
Expand Down Expand Up @@ -411,15 +391,10 @@ This feature is not currently supported on Roku.

{% enddetails %}

## Best practices

### Banner Card dimensions and sizing
## Dimensions and sizing

- No dimension information is sent from Braze.

{% alert note %}
The composer allows a user to preview banners in different dimensions. That information is not saved or sent to the SDK.
{% endalert %}
Here's some things to know about Banner Card dimensions and sizing:

- While the composer let's you preview banners in different dimensions, that information is not saved or sent to the SDK.
- The HTML will take up the full width of the container it's rendered in.
- As a best practice, we recommend making a fixed dimension element and testing those dimensions in composer.
- We recommend making a fixed dimension element and testing those dimensions in composer.
Loading