This article describes how to set up the Braze Web SDK tag in your Tealium iQ Tag Management account.

In this article:

Table of Contents Placeholder

Supported Versions

  • 2.0
  • 2.2.6

Tag Tips

  • The Purchase Event fires when an Order ID is present.
  • Supports these E-Commerce extension parameters:
    • Customer ID (Overrides _ccustid)
    • City (Overrides _ccity)
    • Country (Overrides _ccountry)
    • Order ID (Overrides _corder)
    • Sub Total (Overrides _csubtotal)
    • Currency (Overrides _ccurrency)
    • Product IDs (Overrides _cprod)
    • Product Quantities (Overrides _cquan)
  • Use mapping to dynamically override the standard config values.

Tag Configuration

First, go to the Tealium Tag Marketplace and add the Braze Web SDK tag to your profile (how to add a tag?).

After adding the tag, configure the following settings:

  • Code Version
    • Select the major version of the API you want to use.
  • API Key
    • Your unique API key, available on your Braze dashboard.
  • Base Url
    • Optional
    • Full URL to your custom endpoint, provided by Blaze.
  • Enable Logging
    • Allows Braze error messages to display in the web console.

Load Rules

Load Rules determine when and where to load an instance of this tag on your site.

Data Mappings

Mapping is the process of sending data from a data layer variable to the corresponding destination variable of the vendor tag. (Learn more)

The destination variables for the Braze Web SDK tag are built into the Data Mapping tab for the tag. The following tables list the available destination categories and describe each destination name.

Standard

Destination Name Description

initOpt.allow_crawler

  • Allow Crawlers
  • All activity from web crawlers to be recorded by Braze.
  • Options are true or false.

initOpt.app_ver

  • App Version
  • The version of your app to associate data with.

initOpt.base_url

  • Base URL
  • Full URL to your Braze-provided custom endpoint.

initOpt.no_cookies

  • No Cookies
  • Prevent Braze from storing user information in cookies.
  • Options are true or false.

initOpt.no_fntawsm

  • No Font Awesome
  • Prevent Braze from loading FontAwesome.
  • Options are true or false.

initOpt.enable_htmlmsgs

  • Enable Html in Messages
  • Allow Braze users to send HTML via in-app messages.
  • Options are true or false.

initOpt.enable_logging

  • Enable Logging
  • Allow Braze error messages in the web console to display.
  • Options are true or false.

initOpt.localization

  • Localization
  • An ISO 639-1 Language Code used to override the browser default language.

initOpt.min_trggrinterval

  • Minimum Interval Between Actions
  • The time, in seconds, before another trigger action can occur.
  • Default value is 30.

initOpt.msg_innewtab

  • Open In App Messages In New Tab
  • Force in-app message links to open in a new tab or window.
  • Options are true or false.

initOpt.card_innewtab

  • Open News Feed Cards In New Tab
  • Force news feed card links to open in a new tab or window.
  • Options are true or false.

initOpt.explicit_dissmisal

  • Require Explicit Dismissal
  • Force user to click a button to dismiss messages.
  • Options are true or false.

initOpt.safari_pushid

  • Safari Website Push ID
  • The ID from your Safari push certificate.

initOpt.srvcewrkr_location

  • Service Worker Location
  • Path to your service-worker.js file if it is not in the root directory.

initOpt.session_timeout

  • Session Timeout
  • Time until the session will time out, in minutes.
  • Default: value is 30.

E-Commerce

The Braze Web SDK tag is e-commerce enabled and will therefore automatically use the default E-Commerce extension mappings. Manually mapping in this category is generally not needed unless you want to override any extension mappings or your desired e-commerce variable is not offered in the extension.

Destination Name Description
order_id
  • Order Id
  • Overrides _corder.
order_subtotal
  • Sub Total
  • Overrides _csubtotal.
order_currency
  • Currency
  • Overrides _ccurrency.
customer_id
  • Customer ID
  • Overrides _ccustid.

customer_city

  • Customer City
  • Overrides _ccity.
customer_country
  • Customer Country
  • Overrides _ccountry.
product_id
  • Array
  • List of Product IDs
  • Overrides _cprod.
product_quantity
  • Array
  • List of Quantities
  • Overrides _cquan.

Event

Map to these destinations for triggering specific events on a page.

Use the following steps to trigger an event:

  1. Select an event from the drop-down list.
    • You can select from the predefined list or create a custom event.
    • For a custom event, enter a name with which to identify it.
  2. In the Trigger field, enter the value of the variable being mapped.
  3. To map more events, click the + button and repeat Steps 1 and 2.
  4. Click Apply.

The following table lists the event triggers when the supplied value is found in the data layer.

Destination Name Description

Purchase

  • Log Purchase
  • An In-App purchase is made by the current user.
  • The Purchase event is automatically set when an Order ID is present.

Alias

  • Add User Alias
  • A new alias is added for the current user.

AddAtt

  • Add Custom Attribute to Array
  • A new attribute is added to the custom attribute array.

IncAtt

  • Increment Custom Attribute
  • Increments an attribute currently in the custom attribute array.

RmvAtt

  • Remove Custom Attribute from Array
  • Removes an attribute from the custom attribute array.

SetAtt

  • Set User Attribute
  • Sets a new custom attribute for the current user.

SetAvatar

  • Set Avatar
  • Sets the avatar URL for the current user.

SetLoc

  • Set Last Location
  • Sets the last known location of the current user.

SetDOB

  • Set Date of Birth
  • Sets the day, month and year of birth for the current user.

SetEmail

  • Set Email
  • Sets the email for the current user.

SetEmailSub

  • Set Email Subscription Type
  • Sets the notification type for email subscription for the current user.

SetPushSub

  • Set Push Subscription Type
  • Sets the notification type for push notifications for the current user.

SetFirst

  • Set First Name
  • Sets the first name for the current user.

SetLast

  • Set Last Name
  • Sets the last name for the current user.

SetCity

  • Set Home City
  • Sets the city for the current user.

SetCountry

  • Set Country
  • Sets the country for the current user.

SetLang

  • Set Language
  • Sets the language for the current user.

SetPhone

  • Set Phone Number
  • Sets the phone number for the current user.

SetGender

  • Set Gender
  • Sets the gender for the current user.

Custom

  • Custom
  • Sends a custom event made by the current user.

Parameter

Map to these destinations to pass data to the events mapped earlier. Parameters are only used with pre-defined Events. See the Custom Event Data section below to learn how to pass a parameter with a custom event.

Use the following steps to pass a parameter to a pre-defined event:

  1. In the Event field, select an event from the drop-down list.
  2. In the Parameter field, select a parameter from the drop-down list.
  3. For a custom parameter, enter a name to identify the custom event.
  4. Click + Add.
Destination Name Description

product_id

  • Product ID
  • The unique ID for the in-app product purchased.
  • Overrides _cprod.

product_quantity

  • Product Quantity
  • The quantity of the in-app product purchased.
  • This overrides the e-commerce value _cquan.

order_id

  • Order ID
  • The unique ID for the in-app purchase.
  • Overrides _corder.

order_subtotal

  • Order Subtotal
  • The subtotal for the in-app purchase.
  • Overrides _csubtotal.

order_currency

  • Order Currency
  • The ISO 4217 currency code for the in-app purchase.
  • Overrides_ccurrency.

purchase_properties

  • Purchase Properties
  • An object of additional properties for the in-app purchase.

alias

  • User Alias
  • An identifier for the current user.

label

  • Alias Label
  • A label for the alias, such as the source of the alias.

key

  • Custom Attribute Key
  • The identifier for the custom attribute.
  • Enter the name of the parameter to send.

value

  • Custom Attribute Value
  • The value for the custom attribute.
  • Enter the name of the parameter to send.

inc_value

  • Custom Attribute Incrementation Value
  • The value by which to increment a custom user attribute.
  • Enter the name of the parameter to send.
  • Use negative numbers to decrement.
  • Default value is one (1).

avatar_url

  • Avatar Image URL
  • URL for the current user's selected avatar.

longitude

  • User's Longitude
  • The validated longitude of the user's location, in degrees.
  • Values are from -180 to 180

latitude

  • User's Latitude
  • The validated latitude of the user's location, in degrees.
  • Values are from -90 to 90

accuracy

  • Location Accuracy
  • The accuracy of the user's longitude and latitude, in meters.

altitude

  • User's Altitude
  • The altitude of the user's location, in meters.

altitude_accuracy

  • Altitude Accuracy
  • The accuracy of the user's altitude, in meters.

year

  • User's Birth Year
  • The year associated with the current user's birthday.

month

  • User's Birth Month
  • The month associated with the current user's birthday.

day

  • User's Birth Day
  • The day associated with the current user's birthday.

email

  • User's Email
  • The validated email address of the current user.

notification_type

  • Notification Subscription Type
  • Selected notification type for the current user.
  • Options: opted_in, subscribed, unsubscribed

first_name

  • User's First Name
  • The first name of the current user.

last_name

  • User's Last Name
  • The last name of the current user.

gender

  • User's Gender
  • Gender code for the current user.
  • Options are male (m), female (f), or other o.

customer_city

  • User's Home City
  • The home city of the current user.
  • Overrides _ccity.

customer_country

  • User's Country
  • The country of the current user.
  • Overrides _ccountry.

language

  • User's Language
  • The ISO 639-1 Language Code for the current user's display language.

phone_number

  • User's Phone Number
  • The phone number for the current user.
  • Allows only numbers, spaces, and the +, ., -, ( , and ) characters

Custom Event Data

Map to custom event data destinations if you want to pass a custom parameter with a custom event that you previously mapped in the Events tab.

Use the following steps to map a custom event data variable:

  1. For Event Name, enter the name of the custom event, exactly as specified in the Events tab.
  2. For Parameter, enter the name of the parameter you want to send.
  3. Click + Add.

Vendor Documentation

Version history
Revision #:
13 of 13
Last update:
3 weeks ago
Updated by: