Install the Tealium app in Shopify
This article provides information about installing the Tealium Shopify app.
Before you install and configure the Tealium Shopify app, configure the following in Tealium:
- Tealium HTTP API data source
- Event specifications
- A data layer
restock
variable
For information about these configuration tasks, see Tealium configuration.
Install the Tealium app
The following sections provide instructions for installing the Tealium App in Shopify, enabling the Shopify theme, and configuring the Checkout Pixel.
Install the Tealium app
- In Shopify, under Apps, search and select the Tealium app.
- On the Config tab, enter your Account, Profile, and Environment information.
Environment would typically beprod
,dev
, orqa
. - Select a Checkout Tracking option:
- Client Side Only: Select this option if you only have Tealium iQ Tag Management.
- Client and Server Side: Select this option if you will be using Shopify Webhooks to send data to EventStream.
- If you selected Client and Server Side, do the following:
- In Tealium, go to Server-Side > Data Sources, and select the data source you created for Shopify.
- Copy the Data Source Key for the selected data source.
- In Shopify, paste the data source key into the Server Side Data Source ID field.
- If you are using First-Party Domains, enter your domain name.
- Click Submit when you have finished the configuration. Webhooks are immediately created.
Enable the Shopify theme
Use the following steps to enable the Shopify theme:
- In Shopify, on the Theme Extension tab, click Enable.
This loads the Tealium library,utag.js
, as well as the standard data layer for Shopify events, and opens the Theme Manager. - In the Theme Manager, toggle Tealium Settings on.
- To enable debugging, click the down arrow next for Tealium Settings, then do the following:
- Click Enabled.
- Enter the Environment (
prod
,dev
, orqa
).
Configure the checkout pixel
The Tealium app uses a custom checkout pixel to send checkout event data to EventStream. If you do not have EventStream enabled, you do not need to configure the checkout pixel.
Use the following steps to configure the Checkout Pixel:
- On the Checkout Install tab, copy the example code shown.
- In Shopify Admin, go to Settings > Customer Events.
You will see the Tealium pixel that the Tealium app has installed. The checkout pixel must be added manually - Click Add Custom Pixel and enter
Tealium Checkout
for the Pixel Name. - Click Add pixel.
- Under Customer Privacy, the recommended options are as follows:
- Permission: select Analytics.
- Data sale: select Data collected does not qualify as data sale.
This may change depending on the data your store is collecting in Tealium.
- Delete the example code shown in the Code box.
- Paste the code copied from the Checkout Install tab into the Code box.
- Click Save.
- Click Connect.
Privacy and consent
The Tealium app uses a custom template for consent integrations that makes use of the Shopify Customer Privacy API. This section shows how to configure the recommended approach to consent management and privacy with Shopify.
For more information, see Tealium: Consent Integrations.
The Tealium Shopify app can use the built-in Shopify cookie banner and the Shopify Privacy platform. Use Tealium iQ Consent Integrations to configure third-party banners or other consent management platforms.
Configure Tealium consent integrations
Configuration of Tealium consent integrations consists of the following:
- Create a purpose group and purposes
- Map tags to purposes
- Add a consent integration for Shopify
Create a purpose group and purposes
To add a consent integration for Shopify, create a purpose group and one or more purposes. Each purpose you create requires a name and a key. The name must correspond to one of the Shopify consent categories. The following table shows the keys and names for Shopify consent purposes:
Key | Name |
---|---|
analytics |
analytics |
marketing |
marketing |
preferences |
personalization/preferences |
sale_of_data |
sale_of_data |
Assign the appropriate Tealium iQ purpose before mapping tags to the different purposes. For each Tag, select the Map drop-down menu and assign the most appropriate purpose for the tag.
For more information about creating a purpose group and purposes, see Add a purpose group.
Add a custom consent integration
Use the following settings when configuring a custom integration for Shopify:
Option | Value |
---|---|
Name | Shopify |
Vendor | Custom |
Vendor ID | _tracking_consent |
Enforcement Rule | Use the default |
Publish Locations | Dev for testingProd when testing is complete |
Purpose Group | The purpose group created for Shopify |
For more information about adding a custom consent integration, see Add an integration.
Validate your installation
Shopify Custom Pixels run in an iFrame sandbox that makes most tag monitoring plugins incompatible, including the Tealium Universal Tag Debugger. This section provides information on manually implementing debug mode.
To enable this debug mode, follow these steps:
- Add a cookie named
tealium_debug
to the page that you are testing. - Set the cookie value to
dev
.
This automatically setsutagdb=true
, which enables verbose output and loads the Tealiumdev
environment version. - To see the additional output, open the browser console.
This debug mode applies only to the client-side. It cannot be used to validate server-side data collection.
Debugging of webhooks and events sent to EventStream can be done using the Live Events page in EventStream. The page being tested will need to be reloaded to see the events. This works on the whole site, including checkout. For more information, see About Live Events.
Uninstall the Tealium Shopify app App
To remove the Tealium app from Shopify, use the following steps:
- In Shopify, go to Visit Settings > Custom data,
- In the list, click Tealium, which will be near the bottom of the list.
The Tealium meta fields will be listed. - Scroll down in the list of fields and click Delete.
This page was last updated: October 25, 2024