Skip to content
Get Help

Banner Settings Reference (New)

Note

Journeys is becoming Banners. Opt-in access starts October 13, 2026. To get access, fill out the Banners opt-in form. Your existing Journeys keep running whether or not you opt in.

Look up what each banner campaign setting does, from placement rules to link data. This reference also covers campaign statuses and how Branch picks which banner a visitor sees. For the steps to build a campaign, including analytics tags, A/B tests, and scheduling, see Create a Banner Campaign.

Placement rules ​

Placement rules decide which pages a banner can appear on. You add them under Placement in the Define step, and each rule compares the page URL with the values you enter. With no rules, the banner can appear on every page. With several rules, the page must match every one.

ConditionThe rule matches when the page URL
exactly matchingIs exactly the value
not matchingIsn't exactly the value
starting withBegins with the value
not starting withDoesn't begin with the value
whose domain matchesIs on the domain you enter
whose domain does not matchIsn't on that domain
whose path containsHas the value anywhere in its path
whose path does not containDoesn't have the value in its path
with query param keyHas the query parameter. Then choose whose value matches, whose value starts with, or whose value matches anything.
without query param keyDoesn't have the query parameter

You can enter several values in one rule. Press Enter after each one.

Devices ​

Mobile campaigns need at least one device type under Device & Operating System in the Audience step. The options are iOS Phone, iOS Tablet, Android Phone, and Android Tablet. Desktop campaigns don't have this setting.

User attributes ​

User attributes, also in the Audience step, narrow who sees the banner. With no attributes, the banner can show to every visitor who matches the device and placement rules. With several, a visitor must match every one.

AttributeWhat you setExample
Has completed eventAn event and a countVisitors who completed PURCHASE two or more times
Browserincludes or excludes, and the browsersVisitors on any browser except one your site doesn't support
Came directly from a urlThe URL that referred the visitor, with the same conditions as placement rulesVisitors from search, using whose domain matches and the value google.com
Has visited webA count of days or visitsVisitors who visited on four or more days in the last 30 days
Has visited the appA countVisitors who opened the app at least twice and are browsing your website
Has clicked on emailA countVisitors who have clicked a Branch Link in an email at least once
Has clicked on adA countVisitors who have clicked a Branch Link in an ad at least once
Has the app installedtrue or falseVisitors who have the app, for an "Open the app" banner
Is viewing a page with metadata keyA metadata key, a condition such as whose value matches, and valuesPages that have shoes as their category value
Has interacted with bannerA banner campaign, a number of days, and the interaction (Dismissal)Visitors who dismissed another campaign in the last seven days
Is locatedincludes or excludes, and countries, regions, or citiesVisitors in Canada and the United States

Has visited web can count days or visits. Counting days looks back over the in last period (30 days by default) and counts each day with at least one visit. Counting visits totals every visit and has no in last period.

For Is viewing a page with metadata key, your developer provides the page metadata through Branch meta tags or the Branch Web SDK. Keys and values must be strings. See Set page metadata for targeting.

Count conditions ​

Attributes that take a count, such as Has visited the app, use these conditions:

ConditionMeaning
more than or equal toAt least the number you enter
less than or equal toAt most the number you enter
exactlyExactly the number you enter
between (inclusive)From the Min to the Max you enter, including both
withinWithin the number of days you enter

Formats and templates ​

Mobile and desktop campaigns offer different formats, and each format has its own Branch templates. You choose them under Format and Options in the Creative step.

DeviceFormatBranch templates
MobileStandardDefault, Minimal, and Enhanced
MobilePartial PageTop and Bottom
MobileFull PageOverlay and Fill
MobileCenterWeb Link, App Only, Image, and App Rating
MobileButtonSplit Pill, Round, and Pill
DesktopCenterDesktop Overlay Modal
DesktopCornerDesktop Corner Card and Desktop Corner Card Offset
DesktopSidebarDesktop Sidebar Half and Desktop Sidebar Full

Dismissal ​

The dismissal settings in the Creative step control what happens when a visitor dismisses a banner. Dismissal Period sets how long the banner stays hidden afterward:

  • One Hour
  • One Day (24 Hours)
  • One Week (7 Days)
  • Forever, so the banner never shows to that visitor again
  • Custom, a number of hours or days that you set

Dismissal Behavior sets what dismissing does and which banners it hides:

  • Close banner closes the banner. Redirect to a new webpage closes it and sends the visitor to the Web URL you enter.
  • Dismiss this banner hides only this campaign. Dismiss all banners hides every banner campaign for the dismissal period.

Link data sets where a banner's call to action (CTA) sends visitors and what data your app receives when it opens. Add it under Link Data Configuration in the Creative step. Without link data, Branch uses your app-level link settings.

LabelKeyWhat it does
Default Deep Link Path$deeplink_pathThe default in-app path for every platform
iOS Deep Link Path$ios_deeplink_pathThe in-app path on iOS
Android Deep Link Path$android_deeplink_pathThe in-app path on Android
iOS Fallback URL$ios_urlWhere to send iOS visitors who don't have the app
Android Fallback URL$android_urlWhere to send Android visitors who don't have the app
Default Fallback URL$fallback_urlWhere to send any visitor who doesn't have the app
CTA Destination Override$journeys_ctaSends every visitor to this URL, with or without the app
Canonical URL$canonical_urlThe web URL of the content

You can also add your own keys, such as a coupon code for your app to read.

Caution

The $journeys_cta key overrides deep link paths, fallback URLs, and every other routing setting. Clicks go straight to your URL instead of through a Branch Link, so Branch can't count them or attribute installs, opens, or other events to the banner.

Open the app automatically ​

Auto-Open the app, in the Creative step, opens your app without the visitor selecting anything. It applies only to visitors Branch believes have the app installed, and it doesn't work in every browser.

Campaign statuses ​

A campaign's status decides whether it can show to visitors and which actions its menu offers in the Campaign Manager:

StatusMeaningActions
DraftSaved but not publishedAnalysis, Duplicate, Edit, and Archive
ScheduledPublished with a future start timeReschedule, Analysis, Pause, Duplicate, Edit, and Archive
ActiveLive for visitors who match itReschedule, Analysis, Pause, Duplicate, Edit, and Archive
PausedStopped until you resume itAnalysis, Resume, Duplicate, Edit, and Archive
ArchivedNo longer liveAnalysis, Duplicate, and Edit

Active campaigns with an A/B test also have the A/B Analysis action. To learn what each action does, see Manage and Measure Banners.

How Branch picks a banner ​

Each time a page loads, Branch finds the active campaigns whose placement and audience rules match the page and the visitor. It skips campaigns that are outside their scheduled days or hours. Priority, dismissals, and app detection then decide which banner the visitor sees and what it says.

  • When a visitor matches more than one campaign, Branch shows the one with the highest priority. Priority #1 is the highest. See Set priority.
  • A dismissed banner stays hidden for its dismissal period. If the campaign uses Dismiss all banners, the visitor sees no banners until that period ends.
  • Branch can't know for certain whether a visitor has your app, because iOS and Android don't share that information. Some visitors can see the wrong CTA text or fall into the wrong Has the app installed group. Right after an install, a visitor can keep seeing Text (no app) until Branch registers the install.

Plan for Safari and search traffic ​

Two things outside Branch can affect how your banner looks and performs:

  • If your main domain uses Universal Links, Safari can show Apple's Smart App Banner along with yours, and visitors might not know which one to select. To avoid this, we recommend a Button banner, such as the Pill template.
  • Google can rank a page lower when a full-screen takeover, such as a Full Page banner, covers it for visitors who arrive from search. Keep search visitors out of full-screen campaigns, or show them a smaller banner in a higher-priority campaign. Use Came directly from a url to target them.