This article describes how to configure Floodlight in your Tealium iQ account.
To learn how to configure Floodlight tags in bulk, see Configuring Multiple Floodlight Tags.
In this article:
Table of Contents Placeholder
Tag Tips
- Activate the conversion API before beginning. (Learn more )
- Supports the ecommerce extension for:
- Order ID (_corder
)
- Order Total (_ctotal
)
- List of Product IDs (_cprod
)
- List of Quantities (_cquan
)
- List of Prices (_cprice
)
- Use mappings to:
- Set up event triggers
- Dynamically override standard config values
- Dynamically override ecommerce extension values
- Pass custom event parameters by mapping to "DoubleClick Custom Parameters" and replacing
myvar
with your custom variable name.
- If you do not need a Session ID while using a list, place an empty space/string in its place.
- For additional information, see the Floodlight documentation.
Tag Configuration
First, go to the tag marketplace and add the Floodlight (gtag.js) tag (Learn more about how to add a tag).
After adding the tag, configure the following settings:
- Advertiser ID
- A single or comma separated list of advertiser identifiers that are the source of the Floodlight activity.
- Example: DC-123456789
- Activity Group
- A single or comma-separated list of activity group names.
- Must match the number of Advertiser IDs.
- Activity
- A single or comma-separated list of activity names.
- Must match the number of Advertiser IDs.
- Counting Method
- A single or comma-separated list of counting methods.
- Must match the number of Advertiser IDs.
- Auto Fire Purchase Event
- Fires purchase event when an Order ID is present.
- If counting method is not set it will be set to transactions.
- Allow Custom Scripts
- Global Object
- This is the name of the Global Object used for the event queue.
- If not specified, "gtag" is used.
- Not required for most implementations.
- Data Layer Name
- By default, the data layer initiated and referenced by the global site tag is named dataLayer.
- Rename the data layer only if your project requires a separate name.
- Cross-Tracking Domains
- A comma-separated list of domains to use with Cross-Domain Tracking (
setAllowLinker
).
- This should be the top-level domain.
- Example: tealiumiq.com
Data Mappings
Mapping is the process of sending data from a data layer variable to the corresponding destination variable of the vendor tag. For instructions on how to map a variable to a tag destination, see data mappings.
The available categories are:
Standard
Setting |
Description |
Advertiser ID
advertiser_id
|
- Required
- String/Array
- One or more Advertiser IDs separated by commas.
- Example: DC-12345678
- Data will be sent to all IDs.
- Case-sensitive
|
Activity Group
activity_group
|
- Required
- String/Array
- One or more Activity Group names separated by commas
- Must match the length of Advertiser ID
- Case-sensitive
|
Activity
activity
|
- Required
- String/Array
- One or more Activity names separated by commas
- Must match the length of Advertiser ID
- Case-sensitive
|
Counting Method
counting_method
|
- Required
- String/Array
- One or more counting method names separated by commas
- Must match the length of Advertiser ID
- Converts to lowercase
|
Session ID
session_id
|
- String/Array
- Map none, one, or a set of values matching the length of Advertiser ID
- Place blanks where not needed.
|
Event Name
event_name
|
- The name of the current event.
|
Auto Fire Purchase Event
fire_purchase
|
- Values are True or False
- Fires purchase event when an Order ID is present.
- If counting method is not set, it will be set to transactions.
|
Allow Custom Scripts
custom_scripts
|
- Values are True or False
- The default value is True
- Enables Dynamic tags to integrate third-party tools for tracking website activity.
- Use to override the configuration value
|
Standard
Destination Name |
Description |
Advertiser ID
advertiser_id
|
- Use to override the configuration value
- Accepts either a comma separated string or an array
|
Activity Group
activity_group
|
- Use to override the configuration value
- Must match the length of Advertiser ID
- Accepts either a comma separated string or an array
|
Activity
activity
|
- Use to override the configuration value
- Must match the length of Advertiser ID
- Accepts either a comma separated string or an array
|
Counting Method
counting_method
|
- Use to override the configuration value
- Must match the length of Advertiser ID
- Accepts either a comma separated string or an array
- Converts to lowercase
|
Event Name
event_action
|
- The name of the current event
|
Auto Fire Purchase Event
fire_purchase
|
- Values are True or False
- Fires purchase event when an Order ID is present.
- If counting method is not set, it will be set to transactions.
|
Allow Custom Scripts
custom_scripts
|
- Values are True or False
- Use to override the configuration value
|
Events
Map to these destinations for triggering specific events on a page.
Use the following steps to trigger an event:
- Select Conversion or Purchase from the drop-down list.
- In the Trigger field, enter the value of the variable being mapped.
- To map more events, click + Add and repeat Steps 1 and 2.
- Click Apply.
The event triggers when the supplied value is found in the data layer.
Destination Name |
Description |
conversion
conversion
|
- Map to trigger sending a conversion type event.
- Conversion events are not sent by default.
- Use the
standard , unique or per_session counting method for this event.
|
purchase
purchase
|
- Map to trigger sending a purchase type event.
- Purchase events are sent automatically when an order ID is present.
- Use the
transactions or items_sold counting method with this event.
|
E-Commerce
As the Floodlight (gtag.js) tag is e-commerce enabled, it will 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 to your desired e-commerce variable is not offered in the extension.
Destination Name |
Description |
Order ID
order_id
|
|
Order Total
order_total
|
|
List of IDs
product_id
|
|
List of Quantities
product_quantity
|
- Array
- Overrides
_cquan .
- Accepts a single number override or an array of values
|
List of Prices
product_unit_price
|
|
Custom
Destination Name |
Description |
DoubleClick Custom Parameters
dc_custom_params.myvar
|
- Use to send custom parameters as part of the
dc_custom_params object
- Replace
myvar with the name of your parameter
|
Custom Variable 1
custom.u1
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u1
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 2
custom.u2
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u2
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 3
custom.u3
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u3 .
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 4
custom.u4
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u4
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 5
custom.u5
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u5
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 6
custom.u6
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u6
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 7
custom.u7
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u7
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 8
custom.u8
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u8
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 9
custom.u9
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u9
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 10
custom.u10
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u10
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 11
custom.u11
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u11
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 12
custom.u12
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u12
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 13
custom.u13
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u13
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 14
custom.u14
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u14
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 15
custom.u15
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u15
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 16
custom.u16
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u16
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 17
custom.u17
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u17
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 18
custom.u18
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u18
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 19
custom.u19
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u19
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 20
custom.u20
|
- Use to add custom metrics and dimensions
- Associate with the custom Floodlight variable
u20
- Defaults to dimension or metric name if not provided in mapping
|
Custom Variable 21+
custom.u#
|
- Use to add custom metrics and dimensions beyond 20 (not supported in Floodlight Search)
- Associate with the custom Floodlight variable
u#
- Replace the
# sign in mapping with the desired number
|
AB Transparency and Consent Framework v2
Variable |
Description |
Enable TCF Support
tag_enable_tcf_support
|
- Values are true or false.
|
Additional Documentation