...
Right-click and save the template files on your computer.
All files are named
temlatetemplate.tpl(as required by GTM).
...
Fields | Description | Default |
|---|---|---|
Tracking Domain | The tracking domain can be a Third-Party Ingenious Tracking Domain, a First-Party Ingenious Tracking Domain or a GTM Serverside Domain. You can find it on the platform under "Partnerships -> Advertiser -> Settings". | proxy.ingenious.cloud |
Advertiser Id | You can find the advertiser ID on the platform under "Partnerships -> Advertiser -> Settings". Do not use the internal ID (mid). | |
Conversion Id | Unique conversion identifier from your system | gtmss_{currentTimestampMillis} |
Conversion Target | Defines an event and its type, for example Sale, Appinstall, Newslettersignup. | sale |
Tracking Currency | Determines the currency for all amounts. | |
Unique Id | The unique ID is used to identify conversions during the validation process. | |
Discount Value | This is the total net discount value. '0.00' is allowed. | |
Discount Code | This is the applied discount code. | |
Basket | The contents of the shopping cart consist of items containing the following values in JSON format | |
Session Id | A session Id. The data type is string. | |
Click Ids | A comma-separated list of click IDs. | uses _iclid Cookie |
Gdpr | Activates the general data protection regulation according to TCFv2.0 | |
Gdpr Consent | The actual tcfv2.0 string | |
Site Id | A short description of the conversion page. | |
Timestamp | Usage for cache invalidation. | Current Timestamp in Millis |
HTTP Location | The complete Browser-URL on which the tag was fired. | |
Customer Id | This specifies the internal customer ID from your system. | |
Customer New | This specifies a new or existing customer. Use value 'true' for new customer or 'false' for existing customer. | |
Pay Method | Customer payment method, for example 'credit card' or 'paypal'. | |
User Value 1 | These fields are for free additional information. All formats are accepted. | |
User Value 2 | These fields are for free additional information. All formats are accepted. |
Generating the 'basket' Variable Using a GTM Variable Template
The ECommerce Conversion Tracking Tag is crucial for capturing details about a purchase. One of the essential components of this tag is the basket variable, which holds the product details of a purchase.
| Info |
|---|
The 'basket' in Ingenious Conversion TrackingThe 'basket' in Ingenious Conversion Tracking represents a collection of product details for items a user intends to purchase. Here's a basic breakdown:
Translating Shop Data to Ingenious FormatMost online shops have their own GTM variables for shopping details. To integrate with Ingenious, this data needs to be mapped to the Ingenious basket format. Essentially, it's about matching your shop's GTM variable fields to the corresponding fields in the Ingenious format for seamless integration and accurate tracking. |
...
Working in GTM we recommend the strategy to work with a dedicated basket variable. There also is a template for this, to easily configure the basket:
1. Download the Variable Template:
Download the appropriate basket variable template here. Save it as file with the ending .tpl
2. Import the Variable Template into GTM:
Navigate to "Templates" from the left sidebar.
Click on the "New" button in the variable template section, go to the three dots and then select "Import."
Browse and select the downloaded variable template file.
Follow the on-screen instructions to successfully import the template.
3. Create the 'basket' Variable Using the Imported Template:
Once the template is imported, go to "Variables" from the left sidebar.
Click on the "New" button to create a new variable.
Name this variable "basket" or something descriptive.
For the variable type, select the imported template from the list of available templates.
4. Mapping Data in the Variable:
To start, fill in the variable that contains your basket information in the fields your basket:
...
Fields | Description | Requirement |
|---|---|---|
basket | Represents your basket variable in GTM with your own basket format and product information | Mandatory |
position_order_number | optional: In case you want to have your own order number (1, 2, 3…) | Optional |
position_uuid | Every position has a UUID in the Ingenious basket format. It usually is created by the Ingenious system. Only provide it, in case needed (e.g. for automated validation process) or if available anyways | Optional |
product_id | Id of the product in your system | Recommended |
name | Name of the product | Recommended |
stock_keeping_unit | SKU | Optional |
brand_name | brand | Optional |
product_price | Price of the product. This price can be used for commissioning later. It should be without taxes, (unless tax must be included due to legal reasons). Price of one product (per piece), will be multiplied by quantity in the system later on. | Mandatory |
quantity | quantity: How many products were purchased?! | Mandatory |
tracking_category | alias of the tracking category (defined in the Ingenious system). You may leave this field empty. If left empty, | Optional |
discount_value | discount applied to this product. Will be multiplied by quantity in the system later on.(of the whole position) | Optional |
shipping_costs | Shipping costs of one product(of the whole position) | Optional |
tax | amount of tax per product. Will be multiplied by quantity in the system later on.(of the whole position) | Optional |
product_category | Name of your product category or hierarchy in the shop. | Optional |
...
Ensure that each field is correctly mapped to capture the desired product information.
5. Use the 'basket' Variable in the ECommerce Conversion Tracking Tag:
Navigate to "Tags" from the left sidebar.
Either create a new tag or edit an existing ECommerce Conversion Tracking Tag.
In the tag configuration, look in the section
eCommerce settingsfor the field to select thebasketvariable. This will ensure that the tag captures the product details from thebasketvariable during a purchase event.Save and test the tag to ensure it's capturing the product details correctly.
...
6. Publish Changes:
Don't forget to submit your changes to make them live.
...
By following this method, you can efficiently generate the basket variable in GTM using the new variable template and ensure accurate capture of product details during purchase events.
Implementing sGTM Templates
Server-side Google Tag Manager (sGTM) templates enable the deployment of tags directly on the server container, enhancing data security, improving site speed, and providing more control over data collection. This chapter focuses on implementing the sGTM client, sGTM onpage Tag, and sGTM conversion Tag.
Client side setup first
The setup of the client side templates (in the client side container) should be done first. See description above for onpage tag and conversion tag.
Important: For the client side templates, that are supposed to send data to the server side container, the tracking domain needs to be the tracking domain of your google tag manager.
sGTM Client Setup
Create a Server Container: In your GTM account, create a new server container if you haven't already.
Download sGTM client template: Download the sGTM client here.
Install the sGTM client template: Navigate to the “Templates” within your server container and click "New". Then import the template you just downloaded.
Deploy the sGTM Client: Navigate to the "Clients" section within your server container and click "New". Select the Ingenious Technologies sGTM client from the list of available templates.
Publish Changes: After configuring the sGTM client, publish the changes to make the client active. This step is crucial for ensuring that the server-side environment is ready to process incoming requests.
Implementing the sGTM Onpage Tag
Create a New Template: In your server container, create a new template and import the Ingenious Technologies sGTM Onpage Tag template.
Create a New Tag: In your server container, create a new tag and select the Ingenious Technologies sGTM onpage Tag template.
Configure the Tag: Fill in the required fields, such as specific settings related to your tracking needs. This tag is designed to capture and store click-in data, including generating and managing cookies for tracking purposes. Note: tracking domain is not needed and the advertiser Id is provided by the client side tag and the client.
Trigger Setup: Assign a trigger for the onpage tag, typically set to fire on all pages or based on specific conditions that match your tracking requirements.
Test and Publish: Before publishing, use the GTM preview mode to test the tag's functionality, ensuring it fires correctly and captures the desired data. Once verified, publish the changes.
Implementing the sGTM Conversion Tag
Create a New Template: In your server container, create a new template and import the Ingenious Technologies sGTM Conversion Tag template.
Create a Conversion Tag: Similar to the onpage tag setup, create a new tag in your server container for the sGTM conversion Tag. Choose the Ingenious Technologies template specifically designed for conversion tracking.
Tag Configuration: Input the necessary information, such as conversion ID, and any other relevant details that define the conversion event, such as conversion target, tracking currency, and basket details. Note: tracking domain is not needed and the advertiser Id is provided by the client side tag and the client.
Conversion Trigger: Define the trigger that will cause the conversion tag to fire. This is usually set to trigger on specific events
...
, such as form submissions, purchases, or any other user actions that qualify as conversions.
Validation and Deployment: Use the GTM preview and debug mode to test the conversion tag's accuracy in capturing conversion events. Ensure all data is correctly recorded and matches your expectations. Once satisfied, publish the changes to deploy the conversion tracking.
Schema for server side implementation (sGTM)
...
In the provided illustration, we demonstrate a typical setup using Ingenious Tags:
...