1 of 100

Commanders Act X

Welcome !

Discover capabilities of Commanders Act X

Learn how to use the platform to collect, enrich, validate and integrate your customer data with hundreeds of solutions.

Platform updates

Announcements

16/12/2022 - End of life of Platform version 7

Dear Customer,

As you know, we have created the new Platform X, which was launched in May 2022 to provide you with a range of new and improved features, including a higher-performance architecture, modern, fast and user-friendly interfaces, and enhanced functionalities to make your daily life easier.

In light of this, we will be closing the old platform (version 7) on June 30th 2023.

Here are the closing steps on the v7 in 2023:

End date for adding new containers: April 30
Maintenance end date: June 30
Support end date: June 30
Complete closing of the platform: June 30
Server-side v1 collection/processing end date: December 31

Many of you have already switched to the platform X and are already enjoying its benefits. If you have not yet had the chance to explore the new platform, we invite you to come and discover it for yourself. We would be happy to provide you with a presentation and show you all that it has to offer. We are very proud of our new platform and are delighted with the positive feedbacks we have received so far. This reinforces our choice to provide you this new unified platform, ready for the future !

Thank you for your continued support.

Sincerely, The Commanders Act Team

Documentation updates

The latest updates made to our documentation articles

09/05/2025

Destination documentation (updates):

02/05/2025

Destination documentation (updates):

18/04/2025

Destination documentation (updates):

16/04/2025

Update about GPC implementation

11/04/2025

Update for React Native (Mobile) Source

Update for Plugin Commanders Act Assistant

Source documentation:

Destination documentation:

Destination documentation (updates):

28/03/2025

Destination documentation (updates):

18/03/2025

New documentation for Storage Settings UI

05/03/2025

New documentation for the latest version of our Chrome Extension

31/01/2025

Destination documentation (updates):

21/01/2025

13/12/2024

Destination documentation (updates):

06/12/2024

Destination documentation:

29/11/2024

Destination documentation:

22/11/2024

Destination documentation:

Destination documentation (updates):

27/10/2024

New destination Logs exporter:

24/10/2024

Updated documentation for new features of cookie scanner:

21/10/2024

CDN 1st new documentation:

18/10/2024

Destination documentation:

09/08/2024

Destination documentation (updates):

02/08/2024

Destination documentation:

26/07/2024

Destination documentation (updates):

19/07/2024

Destination documentation:

12/07/2024

Destination documentation:

Destination documentation (updates):

05/07/2024

New commands available to use our Javascript SDK API with our TMS

28/06/2024

Destination documentation (updates):

21/06/2024

Destination documentation:

07/06/2024

Destination documentation:

Destination documentation (updates):

31/05/2024

Destination documentation (updates):

17/05/2024

Destination documentation (updates):

15/05/2024

Cookies page updated

Tracking First

10/05/2024

Destination documentation:

03/05/2024

Destination documentation (updates):

19/04/2024

Destination documentation (updates):

14/04/2024

Cookies page updated

29/03/2024

Destination documentation (updates):

08/03/2024

Destination documentation:

Destination documentation (updates):

27/02/2024

26/02/2024

New documentation homepage with especially a link to Adloop documentation

16/02/2024

Update documentation and screenshot on Data Quality

05/02/2024

Update section Domain Management

30/01/2023

Update for new native feature Google Consent Mode

26/01/2024

Destination documentation:

12/01/2024

Destination documentation:

05/01/2024

Destination documentation:

Destination documentation (updates):

21/12/2023

Information page about Google new requirements

17/11/2023

Destination documentation:

10/11/2023

Data retention duration new page

Update: add the section "Debug mode" in Live Event Inspector

Implementation guide of Consent Banners in GTM

Destination documentation:

03/11/2023

Destination documentation:

20/10/2023

Destination documentation (updates):

06/10/2023

Destination documentation:

04/10/2023

28/09/2023

Explanation and workflow examples on Environments inside the platform

20/09/2023

Update Adobe Analytics for authentication token

08/09/2023

Destination documentation (updates):

01/09/2023

Destination documentation:

04/08/2023

Destination documentation (updates):

28/07/2023

Destination documentation:

07/07/2023

Destination documentation (updates):

First party tracking : CloudFlare tutorial updates:

30/06/2023

Destination documentation (updates)

09/06/2023

01/06/2023

30/05/2023

Improvements for connectors documentation

26/05/2023

Destination documentation:

23/05/2023

19/05/2023

Destination documentation:

12/05/2023

Destination documentation:

05/05/2023

Destination documentation:

Destination documentation (updates):

07/04/2023

Destination documentation (updates):

31/03/2023

Destination documentation:

Destination documentation (updates):

24/03/2023

Destination documentation (updates):

25/02/2023

24/02/2023

Destination documentation:

21/02/2023

New feature documentation: Destination Builder

09/02/2023

Event enrichment documentation (updates):

Destination and source live event inspector documentation (updates):

03/02/2023

Destination documentation:

13/01/2023

Destination documentation (updates):

30/12/2022

Destination documentation:

20/12/2022

16/12/2022

Enhance the home page

09/12/2022

Destination documentation:

06/12/2022

Re-arrangement of menus to find sources/destinations more easily
Event reference better arranged to simplify reading:

02/12/2022

Destination documentation (updates):

30/11/2022

Destination builder documentation update:

04/11/2022

Destination documentation (updates):

21/10/2022

Revamp Identity resolution documentation

Enrich Data cleansing transformation functions documentation

Destination documentation (updates):

30/09/2022

Added a data quality indicators description in Source Overview

22/09/2022

Documentation on how to migrate from serverside v1

16/09/2022

Destination documentation:

Destination documentation (updates):

13/09/2022

Destination documentation (updates)

+ 2 others

01/09/2022

Destination settings -> Advanced mapping updated to Properties transformation:

Destination documentation (updates):

+ 10 others

26/08/2022

Destination documentation:

Destination documentation (updates):

22/08/2022

Data quality documentation:

19/08/2022

Destination documentation (updates):

12/08/2022

Destination documentation (updates):

05/08/2022

Destination documentation:

01/08/2022

Events collection documentation:

29/07/2022

Destination documentation:

Destination documentation (updates):

22/07/2022

Destination documentation:

Destination documentation (updates):

15/07/2022

Destination documentation (updates):

08/07/2022

Destination documentation:

05/07/2022

Mobile sources updates:

Mobile APP global setup guide:

30/06/2022

Webhook documentation:

29/06/2022

Segment stats article:

Data quality feature:

23/06/2022

Add a description of automatic added properties for Web events (JS SDK and Web container):

Update automatic added properties for Mobile SDK:

21/04/2022

Events enrichment article:

Product catalog files importer details:

19/04/2022

Bulk articles update :

Getting started

How the platform works

Commanders Act is a cookieless platform that allows you to collect, normalize/fix, enrich, check and send in real time your first-party customer data.

Event

Source

Destination

Data store

Data layer

A data layer is a specification of your data for tracking customer interactions. This can include data from websites, mobile apps, connected devices, and offline sources. The data layer enables your third-party vendor solutions and serves as the basis for your data-focused initiatives.

Glossary

Our market and solution use many technical concepts, but our goal is also to democratize and explicate these notions to all.

A first-party cookie is a cookie managed by the website owner to track users' activities and remember preferences. It is opposed to third-party cookies which are not owned by the website but partners (advertising partners, for example). Ad blockers and browsers are blocking more and more third-party cookies, that's why first-party cookie is a great workaround to keep a continuity on tracking users.

A-record

It indicates the IP address of a given domain. 'A' for address, it is the most fundamental DNS record type (Domain Name System = website domain). By adding Commanders Act on your A-record, it allows Commanders Act to launch tags as first-party cookies, avoiding ad blockers and limitations regarding third-party cookies.

A client-side cookie (HTTP cookie, browser cookie) is a small piece of data that a server sends to a user's web browser. These cookies are stored on the browser.

A server-side cookie (session) is a unique Session Identifier stored on the browser and cookie information are stored on the server. The Session Identifier is used to match the request with the data stored on the server.

ITP

Intelligent Tracking Prevention is a feature on browser Safari (Apple) to restrict the use of cookies to track consumers.

Public cloud

With public cloud, companies don't have to purchase, manage and maintain heavy and expensive infrastructures. All of this is managed by third-party providers, and companies only pay for what they consume.

ETL capabilities

An ETL (Extract - Transform - Load) is a system that can extract the data from a source, transform the data (normalization, cleaning...) and load, insert the data to a destination.

Normalized data layer

A normalized data layer refers to ready-to-use data: after collection and normalization, the data quality is ensured, data is clean and ready to be sent to destinations.

Augmented data layer

From collected data, it is possible to enrich the data layer with computed data: create new properties from existing properties to create a sum, count, average, ratio... This allows to create high value properties to send to destinations for a better segmentation or personalization. For example, it is possible to count the total value of purchases per user or the average basket value per user.

Enrichment

When an event is collected, it is possible to enrich it from stored data to add more information on the event before to send it to destinations. For example, a purchase event can be enriched with data coming from CRM, like hashed email address or any other relevant information. It can also be enriched with information coming from the product catalog, from the product ID we can add product details, color, weight, materials...

Identity resolution

The goal of Identity resolution is to create a unified customer profile, whatever devices (desktop, mobile) or channels used (online and offline). To achieve this goal, we built a real-time proprietary reconciliation algorithm to create the complete view of customers.

Condensed platform concepts

CAX Platform : Features and Functions

Commanders Act: Cookieless platform for first-party customer data collection, normalization, enrichment, and real-time transmission.

Components:

Source: Libraries/APIs collect user actions (events) from various platforms (websites, apps, POS).
Event: User actions tracked from sources and sent to CAX.
Destination: Tools/partners receiving the collected data in suitable format. Examples include GA4, Facebook CAPI, Google Enhanced Conversion.
Data store: Commanders Act's BigData database for storing events and imported data. Enables event or user enrichment, user segmentation, and data analysis.
Identity resolution
Data Insights : Campaign analysis, Automatic Ads budget optimisation (Adloop), Customer analytics, Control group

Data Integration:

Real-time tracking: Via OneTag, Javascript SDK, Google Tag Manager, Mobile SDKs, Rest API.
Third-party tools: Connectors catalog, destination builder, webhook.
Imports: Regular automated file imports (csv) for CRM users, offline conversions, product catalog, custom storage universe.
Data API: Specific data transmission via Data JSON APIs.

Data Quality:

Confidence: In-app reporting and daily email digests for invalid event action.
Normalized Datalayer UI: Interface for data schema definition and validation rule creation (event specs).
QA automation: Event specification writing for QA process automation and real-time alert definition.
Data Cleansing UI : Live data transformation feature for quick data error response.
Event Delivery UI: Quality check for data transmission and event delivery history view.
Event Inspector UI: Source and destination inspectors for specific event analysis/QA/debug

OneTag

Add OneTag from tag library in web container. Options: Builder (no code) and Custom (manual code).
Setup tag. Use cact('trigger') to record user actions. Format: cact('trigger', '<event_name>', {<event_data>}, [config], [callback]);. Events have names, properties. Example:
Event types: standard (recommended, predefined names, parameters) and custom (user-defined). Use standard properties in custom events.
User consent automatically included in all events with Commanders Act CMP. With other CMP, manually add consent_categories inside user.
Override default parameters (collectionDomain, sourceKey, siteId) if needed. Set globally for all events with cact('config').
Check functionality with Event Inspector.
Setup first destination. Add in Commanders Act platform, configure, choose source, manage user consent, save, check.
Server-side consent management: event sent to destination only if match between user consent categories and destination consent category.

Platform interface

Prod and Testing environments

The Commanders Act platform allows you to manage data sources, destinations, transformations across different environments. These environments—namely Production, Staging, and Development—help you organize and control your data flow more efficiently.

What Are Environments?

Environments are labels can be applied to sources, destinations, and transformations. These labels help you categorize and manage how data flows and is processed within the system. By selecting an environment, you can specify the context in which a particular source, destination, or transformation should operate. The default three primary environments are:

Production: This is the live environment (on which to be very carreful)
Staging: Often used for testing and quality assurance.
Development: Used to build and test things

Workflow Examples

Use Case 1: Team-wide Testing of a New Destination

Scenario: Your team needs to validate a new destination configuration.
Steps:
1. Create a destination in the Development environment and label it "Team_Test_Destination."
2. Connect only Development sources that are sending known, controlled events.
Outcome: The team can collectively test and validate the new destination using controlled, lower-volume data.

Use Case 2: Testing Data Transformations on a Smaller Scale

Scenario: You've developed a new data transformation logic and want to test its impact before applying it to your live data.
Steps:
1. Create a source in the Development environment and label it "Transformation_Test."
2. Direct only a subset of your events, preferably test events, to this source.
3. Create a transformation in the Development environment and connect it to the "Transformation_Test" source.
Outcome: You can validate the new data transformation logic using controlled, lower-volume data without affecting the Production environment.

Use Case 3: Verifying a Mobile App Update

Scenario: You're releasing a new version of your mobile app and want to ensure it works as expected.
Steps:
1. Create a source in the Development environment specifically for the new mobile app version.
2. Initially, connect this source to destinations in the Development environment.
3. Once verified, connect it to Production destinations.
Outcome: You can test the new app version in a controlled, lower-volume setting before rolling it out to your user base.

Use Case 4: Role-based Access Control (soon)

Scenario: You want to control who can make changes in different environments.
Steps:
1. Assign roles to team members, specifying permissions for Production, Staging, and Development.
2. Implement these roles to restrict or grant access to specific sources, destinations, or transformations.
Outcome: Only authorized team members can make changes in sensitive environments, enhancing security and accountability.

In the near future, the platform will introduce user permission management that will allow you to define who can modify or create elements in each environment. This adds an extra layer of control and security, ensuring that only authorized personnel can make changes to critical environments like Production.

Advantages of Using Environments

Data Isolation

Isolating data between environments minimizes the risk of errors and data corruption. For example, testing a new feature in the Development or Staging environment will not affect your live data in Production.

Enhanced Security

Production data is isolated from Development and Staging, reducing the risk of unauthorized access or data leakage.

Improved Testability

New features or data transformations can be thoroughly tested in the Staging or Development environment before being rolled out to Production.

Streamlined Deployment

Moving new features from Development to Staging and finally to Production becomes more straightforward, reducing the chances of errors during deployment.

Team Collaboration

Environments facilitate better collaboration between development, testing, and operations teams by providing dedicated spaces for each phase.

Future Feature: User Permission Management

It allows you to define who can modify or create elements on production, staging, etc. This adds an extra layer of control and security, ensuring that only authorized personnel can make changes to critical environments like Production.

How to Use Environments

Creating a Source or Destination: You have the option to label it with an environment tag—either Production, Staging, or Development. This helps you categorize and manage how data flows and is processed within the system.
Data Cleansing Transformations: While creating a transformation, you can choose to apply it to a specific environment, giving you more control over your data flow.

Create Your Own Environments: In addition to the default Production, Staging, and Development environments, a future update will allow you to create your own custom environments. This will provide even more flexibility in managing data flows and transformations, allowing you to tailor the platform to your specific needs.

Productivity tools

Commander's AI

Technical documentation on the use of artificial intelligence in the platform

1. Introduction

1.1. Overview of Commander's AI

Commander's AI is a set of artificial intelligence features integrated into the Commanders Act platform. These features leverage advanced language models (LLM) to optimize and automate various tasks. Its goal is to simplify and optimize tag management, data handling, insights and destination configurations through natural language processing models.

The functionalities of Commander's AI are designed to:

Improve user efficiency by automating repetitive tasks.
Simplify data management and transformation.
Ensure tag and destination compliance with privacy regulations.
Assist users in optimizing configurations through intelligent suggestions.
Accelerate and simplify complex tasks for users.
Improve the quality and standardization of configurations/data.

All Commanders AI suggestions are non-binding and subject to human validation. Users remain responsible for verifying any AI-generated content before applying it in production.

1.2. Key AI Features

Commanders AI includes several advanced functionalities (some are limited to beta testers) :

2. AI Features Description

2.1. Automatic Change Summary in Web containers

Feature Overview

When a user generates a web container in the Tag Management System (TMS), Commander's AI analyzes the modifications and provides an automatic summary of the changes made since the last container generation.

How It Works

The AI identifies changes made: additions, deletions, or modifications of tags, variables, triggers, etc.
An AI-based summarization algorithm generates a concise and readable description of the modifications.
The summary is displayed before the container is generated for user validation.

Customization and Validation

Users can manually edit the proposed summary before validation. This ensures the content meets expectations and facilitates team collaboration.

Personalization Options

Users have access to additional customization options via the gear icon ⚙️:

Summary Length: Choose between short, medium, or detailed summaries.
Custom Prompting: Define specific formatting rules or content guidelines for the AI to follow when generating summaries. Users can specify formatting or content preferences, such as writing in uppercase, adding emojis, structuring summaries with bullet points, (e.g., "Write in uppercase with emoticons with max 5 bullet points"). This allows for greater adaptability to specific workflows or reporting standards.

2.2. AI Copilot for Data Cleansing (closed beta)

Feature Overview

Commanders AI includes a conversational assistant (aka AI copilot) that enables users to formulate queries for generating data transformation formulas tailored to specific data cleansing needs.

How It Works

The user interacts with the AI Copilot using natural language to describe a data transformation.
The AI copilot interprets the request and suggests a transformation formula.
The user can test, modify, and apply the formula before final integration.

Use Cases

Conditional values
Converting date formats.
Cleaning invalid values...

Verification and Adjustment

Users can edit and test the generated formulas to ensure they meet their requirements before applying them. Each generation includes a reminder that the result should be validated by the user.

2.3. Smart Suggestions for Names and Descriptions (closed alpha)

Feature Overview

When configuring destinations, segments in Commanders Act, Commanders AI suggests names and descriptions based on usage context.

How It Works

When a relevant field is detected (destination name, segment description, etc.), the AI analyzes existing data and suggests suitable content.
The user can accept, modify, or ignore the suggestion.
Suggestions adapt based on usage trends and best naming practices.

Use Cases

Generating a destination name based on destination's settings and filters.
Proposing a detailed description for a segment

2.4. Automatic Privacy Category Selection (closed alpha)

Feature Overview

When a user adds a client-side tag in the TMS or configures a destination, Commanders AI automatically suggests an appropriate privacy classification.

How It Works

The AI analyzes the tag or destination metadata.
A privacy category is suggested based on best practices and applicable regulations.
The user can validate, adjust, or modify the suggestion before final approval.

Customization and Validation

Users retain full control over the classification and can adjust the suggestion as needed.

3. Transparency and Accountability

3.1. Clear Identification of AI-Generated Content

All Commanders AI features include explicit labels indicating AI usage:

Visible UI labels/icon such as "AI-Generated", "AI Suggestion", "AI Copilot" or ✨icon
User Control: Users can modify/verify AI-generated content to prevent unwanted automation.

3.2. Human Oversight

Users always retain final control over actions suggested or performed by Commander's AI. The AI does not make irreversible autonomous decisions.

3.3. Data Privacy and Security

Commanders AI complies with GDPR and the AI Act:

✔ Transparency: Explicit labeling of AI-powered functionalities. ✔ Human Oversight: No AI action is irreversible. ✔ Data Privacy: Generated suggestions and content are not stored/used for training purposes. User data remains within the scope of its intended use and is not shared externally. ✔ Technical Documentation: Full traceability and governance of AI models are maintained.

3.4. Scope of AI Usage and Data Boundaries

As of today, Commander's AI does not process or analyze any personal data or event payloads collected via the Tag Management System (TMS) or the Customer Data Platform (CDP).

Its usage is strictly limited to configuration assistance and user interface enhancements, such as:

Generating summaries of tag management changes.
Assisting in writing regex, expressions, or formulas based on metadata or structural fields.
Suggesting field names or descriptions based on metadata (not user-level data).
Classifying tags or destinations based on structural criteria.

No user event data or identifiers are currently exposed to AI models.

4. AI Model Governance and Updates

4.1. Models Used

Commanders AI is based on a combination of advanced language models (LLMs) carefully selected for their efficiency in data management and tag management tasks.

4.2. Updates and Monitoring

Models are regularly updated to ensure accuracy and relevance.
Validation tests are performed before each deployment to reduce biases and improve reliability.

4.3. Security and Privacy

AI-generated content is not stored for reuse or retraining.
Suggestions are based solely on technical and contextual criteria without exploiting personal data.

5. Support and Assistance

For any technical questions or issues related to Commanders AI, contact our support team at support@commandersact.com

Integrating your data

There are several ways how to get your data into Commanders Act platform.

Real-time Commanders Act tracking

Third party tools

Imports

It is possible to import data to Commanders Act through regular automated file imports (csv), such as:

Custom storage universe

Data API

Features

User guides for browser-side platform

Advertising

Release notes

All details about the updates or new features of each new release updated by our Product team!

Release 10.0.28 - April - 2025

✨ New Features

🔎 Tag Assistant Chrome Extension Perform faster, more secure QA with our browser plugin:

See all tags triggered in one place
Quickly access containers
Security enhancements with login widget
Test your Branches directly

📱 New Source: Mobile Server-Side Events via React Native Easily send server-side events from mobile apps using the React Native framework. A perfect fit for many of our customers.

🧠 AI-Powered Support (Early Access) The AI journey begins with new tools to assist your daily work:

JarvX auto-generates comments
Formula generator pop-in for advanced setups
Side panel guidance for Commanders

🛠️ Improvements

📤 Destination Builder – Direct Publishing

Users can now publish Custom Destinations instantly
Built-in safety checks to prevent errors → Greater autonomy & faster go-live

🗑️ TMS – Branch Deletion Confirmation

Added confirmation pop-up before branch deletion → No more accidental deletions

🗃️ Custom Data Store & Storage Settings

Retain and reuse event data (up to 730 days)
Store specific object properties
Fully configurable UI with safety warnings → Enrich future events with past context

📌 Beta / Closed Tests

📁 CSV Conversion Importer Still in closed alpha – enabling 1st-party library hosting for Google Ads + GA4 integrations.

🧪 AI Features Currently limited to selected users (Commanders) in closed beta. Public availability coming soon.

🎉 New Destinations: (alpha versions)

Button
Floodlight Mobile App Conversion

🛠️ Destinations updates:

FB CAPI destinations: updated EMQ score via “Integration Quality” API (Performance tab)
FB CAPI Advanced: fallback support for standard fields user.email and user.email_sha256
Effinity: support for custom properties and input fields for landing parameters
Awin: encoded product names
Piano Analytics: Enrichment API: value in the “Enrichment Configuration” instead of property name
Snapchat CAPI: support for “invite” and “reserve” events.

That’s all for this update! Stay tuned for more improvements, and as always, let us know your feedback! 🚀🌟

Release 10.0.27 - February - 2025

🍾 1st Party Hosting Now Available for All Customers!

What is it? Customers can now use their own URL (via CNAME) to host privacy files & web containers.

Why is it important? Ensures better data control while maintaining compliance.

🚨 TMS Modernization & Performance Boost

Web container generation is now faster and supports larger containers (though smaller is still best practice!).

New TMS UI with contextual side nav

🔒 Cookie Scanner Update: Teaser Alert Module Added

Prepares for future alerting features – get notified immediately when new cookies are found.

Competitive Advantage – Unlike competitors, our scanner provides real-time alerts (no waiting 24h for a crawler!).

🛠️ UX Enhancement: Filter Categories for Sources & Destinations

Find specific sources/destinations faster.

Easier workspace overview – Quick visibility on available integrations.

🌟 IAB Banners: Total Vendors Now Displayed

Market alignment with Google CMP Partner requirements.

Easier vendor visibility – Just regenerate & deploy the banner to update.

TMS API Update:

Added mapping variables for tags in API calls

🎉 CMP Template Update in GTM

Use IAB TCF consent to manage part of the Google Consent Mode signal.

For customers using our CMP in GTM – Just enable it in Advanced Features.

🌟 TMS API Update – Retrieve Destination Mappings

New API capability – Customers can now retrieve destination mapping properties for data governance audits.

Technical Documentation:

🤖 AI-Based Commenting on Container Generation (Beta)

Faster comment generation (still optimizing for larger changesets).

Smarter summaries – Improved clarity.

Now translated UI – Not just in English anymore!

🔥 Event Specification (aka Normalized Datalayer) is Live for All Customers!

New Feature Name – Renamed based on Sales & Consulting feedback.

Customers can now set up their own validation rules.

🌟 Source Data Quality Enhancements

New Features:

Pagination added for event lists.

Event details now open in a side panel.

Search bar for easier filtering.

Benefits:

No more freezing or bugs with large event lists.

Faster page load times (side panel optimizations coming soon).

🎉 New Destination: RTB House Audience

Leverage RTB House Audience API to share audiences efficiently.

That’s all for this update! Stay tuned for more improvements, and as always, let us know your feedback! 🚀🌟

Release 10.0.26 - December 16 - 2024

Modernization of TMS client-side interfaces!

-Simplified Navigation, with contextual side nav -Improved TMS steps

Pages Revamped: -Containers Overview -Tags Overview -Tags Library -Container settings

Release 10.0.25 - October 2024

🍪🔍Enhanced Cookie Scanner: Automatic Filtering & Unmatched Usability

Our Cookie Scanner now delivers an unmatched user experience, combining the most exhaustive cookie capture on the market with powerful enhancements for usability and insight. Already leveraging data from tens of thousands of real users to capture a truly comprehensive view of cookies—something no virtual crawler can match—this update automatically filters out rare and irrelevant cookies, while adding advanced investigation and filtering capabilities for a more streamlined analysis.

Smart Filtering: By default, cookies detected in fewer than 5% of sessions are now filtered out, allowing clients to focus on frequently relevant cookies while eliminating noise.
Flexible “Rare Cookies” Toggle: A new toggle enables users to view all cookies, including rare ones, by adjusting an interactive frequency setting for tailored insights.
Automatic Pattern-Based Grouping: Cookies with similar names are grouped when three or more share a pattern (e.g., cookie_name...), simplifying cookie lists and making analysis easier.
Enhanced Filters by Type and Domain: New filters for cookie storage type and 3rd-party domain allow for more precise targeting in analyses.
Frequency Display for Insight: Each cookie now includes an occurence frequency percentage, giving immediate insight into detection rates and relevance.
Detailed Tracking for 1st Party Cookies: Full URLs of recent detections are displayed for first-party cookies, helping identify exact points of origin.
Improved Cookie Descriptions: Enhanced descriptions clarify cookie types, offering clients a better understanding of cookie purposes.
Updated Documentation: Detailed guidance on using these new features is available in our for a seamless user experience.

🔍📊 Introducing the Destination Logs Exporter: Full Transparency for Outgoing Requests

Our new Destination Logs Exporter feature, now in closed beta, complements our Live Event Inspector by providing a more comprehensive monitoring solution. While the Event Inspector samples data during high-traffic periods, the Destination Logs Exporter allows users to export all outgoing requests from selected destinations. Each log includes detailed information, including the originating events, status, errors, etc. setting a new standard in data transparency and control.

Full Log Export to SFTP: This feature captures every outgoing request, exporting raw logs to an SFTP server for secure access and long-term storage.
Detailed Event Tracing: Logs provide comprehensive insights into outgoing requests, including the originating events, enabling precise data flow tracking and easier troubleshooting.
Seamless Integration: Configurable directly within the destination catalog, ensuring quick setup and intuitive management.

Explore the full feature details in our as we refine this tool during the closed beta phase.

👁️ Enhanced Login Accessibility

You can now view your password while logging in! This small addition aims to enhance accessibility for all users.

🔗 Improved Navigation for Sources

The navigation menu now includes a shortcut to our Sources Catalog, saving you a click and making it even easier to locate the resources you need.

🔄 General UX Enhancements

Loader Spinner: Added to additional TMS client-side interfaces for smoother interactions.
Destination Overview: Destinations in “dry mode” now display a clear label, reducing uncertainty about destination status.
Event Delivery: Similar “dry mode” labels are added here too, so you’ll always know if a destination is live.
Augmented User Attribute: Removed redundant “visitor” tags in sub-universes for clarity.
Source Data Quality: Action buttons are now available to help quickly address errors in data sources.

1st party hosting

What’s New: WebContainers and Privacy Banners can now use your customer domain to host files via CNAME, keeping data on our servers without external hosting. This will help bypass ad blockers and increase data collection while staying RGPD-compliant. The feature can be opened on customers account, on request. Explore the full feature details in

🔐 New User Access Rights

We’ve added 3 new access rights for destination UIs, providing more secure access for all Custom Profiles users.

Release 10.0.24 - September 2024

🎯 Facebook CAPI Advanced Destination

Key Updates:

Smart mapping: Visualise all the data sent to Meta with default mapping you can customize
Enable App Tracking: A new option to manage automatically to send all mobile data needed by Meta with dedicated app properties smart mapping.
More advanced options: send automatically search event with page_view if needed, and test mode Benefit: You get the most configurable and user-friendly Facebook CAPI solution available on the market, tailored to fit advanced needs.

New Destinations and Integrations

Facebook Lead Ads: Unlock lead optimization by .
X (Twitter) Conversion API Global opening : without the website code.
Microsoft Advertising UET: Available for all clients, offering features like .

🔧 Javascript SDK new setProperty command Now, you can set permanent property values, just like in our mobile SDK. Why it’s useful: This update allows you to save values more efficiently, simplifying processes for all customers. 👉 For more details, check out our documentation .

🌟 Enhanced cact API A new cact('emit') API has been introduced to send browser-side events, replacing the older tC.event.XXX functions. Why it’s better: This new method ensures smoother integration with our tools and reduces errors when sending custom events. For more details, read

We’ve added a set of you can use to trigger custom actions in your tags. New triggers include:

consent_ready
consent_updated
consent_revoke
banner_show/hide
privacy_center_show/hide

Benefit: Greater control over privacy actions within your tagging structure.

📦 Server-Side Tracking as a Custom Trigger The cact('trigger', 'page_view') method now launches , streamlining your server-side and client-side event handling. Benefit: Enhance your event tracking setups with more precision and flexibility, especially useful for consultants handling complex multi-site environments.

🔧 Tag Context Variables We’ve introduced like cact_container.id_site and cact_event.type that can be used directly in your tags. Why it’s helpful: These additions make it easier to manage and track events across different sites and containers.

💾 Event enrichment from Custom Data Store (Beta) For our Beta customers, Storage Settings for now allows a longer duration (30 days), improving data retention capabilities. Global opening : end of september

🖇️ TMS UX Enhancements (Closed Beta)

Our TMS interface has been modernized to provide a smoother, more intuitive user experience. Now available for beta testing with some customers!

New Features Include:

Breadcrumb Navigation: Stay on top of your position within the TMS with easy access to your containers (and soon your branches)
Contextual Side Navigation: shortcuts to reach all webcontainer's related page's in a single click
Expanded Editing Space: More room to modify tags, with a clearer "Tags Overview" UI for faster workflows.
A new interface and 3 revamped ones:
- Tags Overview,
- Tag Catalog,
- WebContainers Overview,
- Container Settings

🛡️ Google CMP Partnership: Gold Tier

We are officially a Gold Tier partner for Google’s CMP partner Program. This recognition underscores our commitment to the highest Google's standards in consent management.

Thank you for your attention and continuous engagement! We look forward to your feedback on these improvements.

Release 10.0.23 - May 2024

May Release Notes 🌟

📱 New Mobile Release

Android

Consent 5.3.2: Automatic JSON update when receiving a new one from the CDN. Benefit: Ensures continuous compliance and accuracy.

iOS

Consent 5.3.0 / Core 5.4.0 / IAB 5.1.0:
- Unified TCConsent Module: Now there's only one module instead of separate ones for IAB and non-IAB. Benefit: Simplifies consent management.
- Remove Refused Vendors from TCUser: When no consent is available. Benefit: Cleaner consent handling.

💳 Credit Usage UI Improvements

What's New:

Time Split: View by day for periods < 30 days, by week for periods < 90 days. Benefit: More precise credit usage tracking.
New Metric Names: Closer to those on customer invoices. Benefit: Better data understanding.
UI Enhancements: Improved sorting order, labels, and colors. Benefit: More intuitive and navigable interface.

👥 Target Audience: Sales team & customers with "account administrator" rights.

🧼 Data Cleansing UX Improvement

Show More Than 10 Cleansings on a Single Page. Benefit: Improved organization and management of cleansings.

🍪 Technical Session Cookies Update

Renaming Cookies for 1st Party Tracking: Previously named "phoenix". Benefit: More accurate and understandable nomenclature.

Better detection of first-party session cookies

🔍 Anti-Adblocking Enhancement

Key Changes:

Adblocker Detection: Now included in web containers. Benefit: More comprehensive data collection despite adblockers.

👥 Target Audience: Customers using oneTag. You need to generate/redeploy all containers containing a oneTag tag.

📈 Google Analytics 4 Enhanced Conversions

New Feature: Send user-provided data along with the user identifier to improve behavior and conversion measurement.

🛠 Amazon Ads CAPI Update

Key Changes:

No longer in closed beta, open to all customers.
More user-friendly setup: Add a new conversion definition directly within the destination settings.

✨ Benefits:

Officially the easiest and most user-friendly Amazon CAPI setup

📊 Facebook - Conversion API Advanced (closed beta)

Key Changes:

Dynamic Fields: Allows dynamic values for Pixel ID and token.
Smart Mapping:
- Easier to review/master all data shared with Facebook
- Option to send all properties as custom data or define them manually.
- Option to send App events and review/edit app specific properties sent to Facebook
Advanced Settings: Options for content type, custom data, test code and additional PageView events. Benefit: Greater control over data shared with Facebook, more options, and flexibility.

🎯 Why These Changes:

Integration of requested features and customer feedback

🚀 New Destination: Outbrain

Server-Side Event Tracking: Enabled for more accurate performance measurement. Benefit: Enhanced tracking capabilities.

Thank you for your attention and continuous engagement! We look forward to your feedback on these improvements.

Release 10.0.22 - March 2024

Mobile SDK Consent 5.2.1 🔧 Resolved a potential crash with Vendors details drop-down. ➕ Added the Privacy Manifest file for enhanced security. 🔨 Fixed Layout Constraints warnings on the purposes screen. 🖼️ Ensured the Illustrations button always displays correctly.

Benefits:

Smoother navigation without crashes.
Enhanced privacy with manifest file integration.
Improved layout stability for a seamless user experience.

Mobile SDK Core 5.3.4, ServerSide 5.4.3, IAB 5.0.2 ➕ All modules now feature the Privacy Manifest file.

Benefits:

Heightened privacy measures across all platforms.

New Destination: LinkedIn Conversions API 🎉 Introducing the for direct marketing data connection. Benefits:

Track campaign performance anywhere for optimized results.
Better attribution and cost efficiency with complete data sets.

New Destination: Firebase Analytics for Mobile Applications 📱 Introducing a new informative configuration page for Firebase Analytics integration. Benefits:

Seamless bridge between CMP & Firebase Analytics.
Easy implementation of Google Consent Mode with Firebase Analytics (GA4).

Security Enhancement! 🔒 Native platform login has been exclusively streamlined with SSO.

Benefits:

Enhanced security with SSO-only access.
Improved user experience without confusion.

Speed Boost! 🚀 TMS client-side now limits displayed container versions at the generation step for efficiency.

Benefits:

Eliminates timeouts and crashes during version generation.
Clients can still access the latest 100 versions effortlessly.

Real-time Destination's settings updates 🚀 Modifications now propagate instantly across all servers for faster updates (settings, filters, activation, dry mode, etc.).

Benefits:

No more waiting times, changes take effect instantly.
Easy testing iterations for seamless destination adjustments.

Introducing new "Reset Password" Page! 🔑 Enjoy a user-friendly password reset experience.

Benefits:

Simplicity: Visual widget for accurate input and ability to use passphrase
Smartness: Progress bar for security evaluation.
Solidity: Compliance with new standards for passphrase usage.

New Destination: Taboola Events 🎉 New destination now available for server-side event tracking with .

Benefits:

Track conversions without client-side pixel installation.

Your feedback matters! Let us know how these updates enhance your Commanders Act experience.

Release 10.0.21 - February 2024

🔧 GA4 Source Update (Adloop) 🔧

All GA4 conversion events now selectable as main conversions in Adloop
Events conditionable by custom variables (customEvent, customUser)

💡 Benefits:

Comprehensive GA4 data-source connector
Clients easily locate diverse GA4 conversions & events in Adloop
Precise attribution calculation for better performance insights

🔍 Dry mode enhancement 🔍 We had a smart credential cache management on our (closed beta) feature on destinations. 💡Benefits: Allow to not have Event Delivery polluted by false errors when you switch to OFF the dry mode

🚀 Source Data Quality Boost 🚀 🔍 Here's what's new:

🛠️ Faster interface loading for seamless user experience 🛠️ Simplified menu for quicker access 🛠️ Sneak peek into the Alerting system (closed beta) 🛠️ Shortcut buttons for validation rules & Data Cleansing

✅ Why it rocks:

Increased productivity with lightning-fast loading
Simplified workflows for easier navigation
Immediate issue detection for data quality perfection

🛡️ New Privacy Template "popin accessibility" 🛡️ 🔒 New offerings for enhanced privacy & UX:

🔹 Ready-to-use privacy template for WCAG compliance 🔹 Streamlined UX with improved information display

💡 Why it's great:

WCAG compliance made simple
Enhanced opt-in rates with new popin template
Improved clarity for better user engagement

🚀 Customer Spotlight: Amazon CAPI Integration 🚀 🌟 Big shoutout to the team for wowing users with our CAPI integration! 🌟

Release 10.0.20 - January 2024

🌟 Vue.js Wrapper Version Update (TMS)🌟 🔗

Compatibility Enhanced: Now fully compatible with Vue3, ensuring a smoother integration for your web applications.
Why This Matters: Seamless updates mean less downtime and more productivity for developers leveraging Vue.js in their projects.

🔍 Live Event Inspector Enhancements 🔍

Test Code Events Bypass: Events with the test_code property can now bypass the standard sampling limit (2 millions stored logs max), guaranteeing visibility in high-traffic scenarios.
Increased Visibility for Test Code Events: For events marked with test_code, there is now a generous sampling allowance of 100 events per minute per event type. This guarantees the visibility of these events for testing and validation purposes.
Filterable Test Codes: The test_code property has been made searchable and filterable, simplifying the QA process.
Targeted Benefit: Ideal for server-side feature users needing comprehensive event tracking, like mobile app production tests.

📦 Amazon CAPI Destination Beta 📦 🔗

Exclusive Early Access: Initially available to some customers, with potential openings for eager customers.
Why Join the Beta: Influence the development of our Amazon CAPI destination and get a head start on leveraging this powerful integration.

🔧 Smart Mapping for Google Enhanced Conversions 🔧

Intuitive Automation: Automatic mapping with the option for manual adjustments enhances data accuracy and utility.
Why It's Great: Spend less time on setup and more on Data Governance with this smart, flexible feature.

🛠 UX Enhancements Across Destinations 🛠

Error Prevention: Fields now have helpful prompts in red for incorrect inputs, reducing errors and improving data quality.
Why It Matters: A more user-friendly interface leads to fewer mistakes and a smoother operation for our clients.

📈 Significant User Enrichment Feature Upgrade 📈

Advanced Data Enrichment: Create complex formulas for dynamic and attributes, all with a no-code approach.
Business Impact: Drive targeted marketing actions and advanced customer segmentation, leading to improved ROI and analytics capabilities.

📣 CMP Feature Release: Google Consent Mode V2 📣

Effortless Implementation: Activate Google Consent Mode v2 easily, enhancing data collection quality while ensuring compliance.
Who Benefits: Any client using Commanders Act Consent banners with Google tags, aiming for hassle-free RGPD compliance.

🌱 Server-Side Architecture Eco-Efficiency 🌱

Increased Efficiency: We've optimized our architecture to process events more efficiently, significantly improving performance while minimizing our environmental footprint.

🔧 Segmentation Engine v1 Update 🔧

Refined Performance: We've made incremental but meaningful updates to the Segmentation Engine v1, improving the efficiency of segment calculation times. This enhancement ensures smoother site personalization experiences.
Site Personalization Impact: These improvements will subtly enhance the speed for websites to customize pages for each visitor, ensuring a more seamless user experience.
Looking Ahead: Our development focus is on the Segmentation Engine v2 (currently in QA phase), which is set to bring groundbreaking performance and modernization that will take segmentation to the next level.

📲 Facebook CAPI Now Supports Offline Conversions 📲

Send your offline conversion through your purchase event (type: offline)

📱 Google Consent Mode Update for Android & iOS 📱

Firebase Users: Ensure seamless integration with the latest versions tailored for Android and iOS platforms.

🎹 Piano Analytics Enrichment API Destination Released 🎹

Data Enrichment Made Easy: Seamlessly update transaction statuses or values, enriching your data landscape.

Release 10.0.19 - December 2023

🔧 Advanced Flexibility in Destination’s Consent Filters: Get more flexibility for complex privacy setups You managing consent through our CMP while also utilizing a competitor's solution for different websites on the same account? You can now employ native privacy filters from either our CMP or an external solution within the same account !
📊 Enhanced Event Collection Charts: Now More Insightful. It's such easier to see the type of events collected!

🔒 Data Governance: Introducing 'Tag & Data Sharing' Page. In a quick view, control the shared Datas through the Client-Side TMS tags. *Please note: This is the preview v0 of this page. A nicer version is coming soon!

🔑 Streamlined Platform Administration Access: Instant Workspace Access. No more need to log out and re login when you get access to a new site As an administrator, you granted access to a workspace to one of your colleague? He just need to refresh the page to see the site into the search bar's list. No need to log out and re-login anymore!

🌟 Consistent and Upgraded Chart Styles Across the Platform is now applied to all graphs!
All our customers can enjoy a better visualization with this enhancement of standardization on our platform.

Release 10.0.18 - November 2023

Ability to search by source-key in the Source Overview & Destination Overview UIs:

New version of the Source Data Quality UI: It's even easier to see the quality of your data at a glance ! "What proportion of events have errors to need to be fixed?" The new Overview chart give you the answer in realtime. You will also be able to filter by environment (by default Production environment is shown) and by source.
Platform
- User Management UI: speed increase x3
Destinations
- GEC destination enhancement: Avoid random "failed_get_conversion_id" errors in Event Delivery.
Mobile
- React-Native:
  - add useLegacyUniqueIDForConsentID & useLegacyUniqueIDForAnonymousID
  - startScreen for privacy center choose your launch on the Vendors or Purposes UI
Documentation

Release 10.0.17 - 24/10/23

Platform
- Security enhancement : passwords now required a minimum of 12 characters
- Proxy configuration (Cloud Flare, etc.) in domain management UI

TMS/CMP interfaces:
- Slightly increase UI loading time on TMS pages
- UI random errors fixed
Server Side
- Event Inspector UX improvement: user properties (standard and custom) are now searchable by default
- Destination Event delivery UX improvement: Longer duration for conservation of error details
- Destination Properties Transformations option UX improvement: allows the same transformations as the Data Cleansing UI
Debug Mode for Source/Destination Live Event Inspector Adding a special parameter to you events allows you to have them visible in Event Inspector, even on production environment with billions of events. This debug parameter will allows you to bypass the "Intelligent Sampling".
Mobile
- Consent
  Android & iOS:
  - iAB new function to get the number of IAB vendors
    iAB remove consentOutdated callback migrating to iabv2.2
  Android: do_not_track parameter as a boolean inside the payload
  IOS: illustrations fix on privacy center
- Core
  - Android & iOS: translations fix on migrating to iab v2.2
- Server Side
  - Android & iOS:
    language and country code from the device
    2 function to use legacy ID TC_UNIQUEID
New destinations
- The Trade Desk: CAPI
- Piwik PRO
- Alphalyr Marketing Studio
- TradeTracker
Destinations updates
- Awin: support for “Smart Mapping” and “Custom Event Properties”.
- Mapp: support for "Independent parameters“.

Release 10.0.16 - 24/09/23

TMS/CMP interfaces: Add a loading indicator to TMS/CMP interfaces
Copy Manager: When you duplicate a site (aka workspace), you can now copy Server Side configurations (PlatformX activation, Sources, Destinations, Data Management, Enrichments, etc...)

Interface speed improvements on the following pages:
- TMS: Container overview => +22%
- TMS: External variable => +41%
- Mix: Attribution option => + 46%
- CMP: Privacy banners overview => +38%
- Admin: Profile management => +21%
- Segment overview => +40%
Files imports: The fields mapping now support conditionnal value transformation with
Data Activation: Variables UI can now be reached from Segment overview
Mobile Android & iOS: add language & region Android & iOS: Firebase Destination (for Analytics) IOS: Fix for non-IAB Privacy
Destinations updates
- Adobe Analytics authentication token. You can see our
- Pinterest: support for "click_id“ and "view_item" mapped to "page_visit“.
- Piano Analytics Collection API: removed useless “ref” parameter.

Release 10.0.15 - 24/08/23

New API "Users Activities logs" This new API allows administrators to get all users activities history (who has changed what, when, etc...). Read the technical to start using it.
Live Report Builder: enhancement on UI The filters are now directly visible as before, and the data set limitation (if any) is visible on mouse over only on the flag "limited dataset"
Data Cleansing: new function "GET(property_name)" Allows to work on a property name that contains special characters incompatible with formula. For example if your property name contains a - like page-count you will not be able to write this formula because it is interpreted as a minus sign :
```
page-count-5
```
Now you can, just write :
```
GET("page-count")-5
```
You can read our dedicated
Consent dashboards: new metric for "Global Privacy Control" This new metric will help you to identify the amount of "Optout All" registered through a GPC parameter turned ON
Consent banners: IAB TCF v2.2 compliance Our customers can now be compliant with the latest framework of IAB TCF (v2.2) It is available for Web & Mobile apps ! If you need more information about migration please check
New destination : (closed beta)
Normalized Datalayer (closed beta): Add an option to not consider missing properties as an issue (not impacting quality score). Accept unspecified properties without warning
UX enhancements and speed up of Destination's interfaces (destination list, etc.)

Release 10.0.14 - 24/07/23

Performance tab of Facebook CAPI destinations For more information, you can have look to our new documentation's

Live Report Builder: 2 new charts We added two new type of charts in LRB : bar chart and pie chart. You can retrieve them in the edition part of a LRB report !

Live Report Builder: UX enhancement The filters are now directly visible as before, and the data set limitation (if any) is visible on mouse over only on the flag "limited dataset"

Mobile: New SDK version released for IAB TCFv2.2 For more details, please read our For technical instructions, you can refer to our Github : &

Release 10.0.13 - 24/06/23

New Source: Pixel Tracking API Pixel Tracking API, also known as 1x1 gifs, or clear gifs, allows you to send data to Commanders Act with a HTTP GET request from your server, your local console or any development framework. You can have a look to page for more details.
Data Cleansing: New functions available 9 new functions related to dates: DATEPARSE ; DATEFORMAT ; DATEADD ; DATESUB ; DATEDIFF ; AGE ; [YEAR, MONTH, DAY, HOUR, MINUTES, SECONDS] ; TIMEZONE ; TODAY
Consent: New setting "Global Privacy Control" Setting to be configured at the banner level. Required for CCPA banners For further information, you can read
Destinations: New section 'events filtered' on Event Delivery tab For all destinations, on Event Delivery tab, there is a new section with number of filtered events (consents, conditions defined)
Destinations: Dry Mode (lab) - Closed Beta The Dry mode allows you to simulate sending events, but events are not sent to the destination.
Destinations: update on Facebook Conversion API We released a Performance tab with Event Match Quality score The Performance tab can now display Event Match Quality insights, coming from Facebook. It represents the matching quality, referring to the quality of events sent (completeness of data, like events with email, phone, fbp, fbc...). More identifiers are present on events sent, better is the score. You can have a look to our
UI Improvements: Statistics on weather icons On hover of weather icons, you can see the percentage of accepted/refused events

Release 10.0.12 - 24/05/23

Event delivery improvement for Audience based destinations Event Delivery errors messages for Audience connectors (API connectors such as Facebook Custom Audience, Google Customer Match...) now provide more detailed information about errors encountered.
Sources: update on GTM Bridge A Commanders Act source key is now required in the bridge configuration. As, in the future, events without a source key will be discarded, it is important that you apply the update. If it is not already done, please update it as soon as you can, following the instructions available in our .
Destinations settings enhancement: New dynamic text input component on settings fields (except Smart Mapping for the moment)
Mobile:
- Video Events are now natively supported For more informations about video events, you can have a look to
- the property 'do not track' has been added Required by CNIL for Consent Statistics exempted. For more information check
- Flutter SDK minor updates
New destinations releases: :
Destinations updates: Equativ: improvements and user/cookie sync fix
GA4: send all properties option, automatic session id. Proxy mode is open to more beta customers. Global opening on 25/05
Piano Analytics: send all properties
TikTok: “Smart Mapping” support
Partnerize: field encoding fixes
Awin: dynamic fields support
Commission Junction: dynamic fields support

Release 10.0.11 - 24/04/23

A new item has been added to the navigation menu of our platform: 'Data Governance'. For the moment, you will find the pages related to your privacy banners configuration's in the tab 'Consent Management'. More pages are coming soon!
Data Cleansing: 2 new function for your formulas:
New destinations releases Data Activation Legacy: Only for Data Activation customers. Gives you the possibility to map the format of the events to the format of the data activation (Data Commander variables). To go deeper, you can consult our
GA4 Proxy Mode: The proxy mode option allows you to anonymize data before to send it to Google. *We also added analyses, suggestions and report's impact in our
Destinations updates GA4: Send all properties in one click to Google
TikTok: Offers a smart mapping option

Bridge updates GTM bridge: a Commanders Act source key is now required in the bridge configuration. As, in the future, events without a source key will be discarded, it is important that you apply the update. For further information, read the bridge’s .

Release 10.0.10 - 24/03/23

Formula component enhancement (Data Cleansing, Event Enrichment, ...) The field now resizes automatically according to the size of the formula, to facilitate the reading and writing of complex formulas. Users can also resize the field themselves if needed

New User Rights 3 new user rights have been added in Rights management interface to manage the Destination Builder feature

New SDKs: SDK for Flutter is launched For further informations, please check our github SDK Angular 15 is available Note : it's also compatible with Angular 14. Check our GitHub for more informations :
Filters enhanced on destinations
- quick/easy filter with autocomplete
- more operators (contains, match regex, etc.)
- advanced mode with formula (ability to create very complexe filter, applying our formula function to any condition)
Data Quality indicators and trend graph are now displayed on all sources
New option on LRB report you can now choose to do not display the "non attributed" line in a report
New destinations releases Partenerize Note : this destination allows a dynamic field SmartAd Server Rakuten Events
Destinations updates Mapp: usability improvements Partnerize: Advanced operations added Snapchat: SmartMapping support

Release 10.0.9.1 - 22/02/23

Destination builder - Javascript sandbox Create your own custom destination using basic javascript code ! You can create event-based or audience-based destination.

More information here:

UI enhancement Data Cleansing and Event Enrichment features benefit for a even more userfriendly autocomplete property selector component. Find quicly your property or create a new one in a click.
Data Cleansing – new functions added
Events reference update
has been added
New destinations:
- (audience)
- Updates: Matomo, Kwanko, Google Universal Analytics
Consent management - Exempted statistics
- New tag in the library to facilitate the setup
Event Replay - Closed alpha
New source:
- Flutter - for mobile App – Closed beta
Campaign analysis 
- Campaign Overlap enhanced => possibility to go back up to 30 days
- Make it possible to send a timestamp with the incoming hit of your campaigns collection

Release 10.0.9 - 14/02/23

27% increase in the speed of the interfaces listed below:
- Client-side TMS UIs
- Segments UIs
- Admin UIs
- Campaign options UIs
- Banner builder and consent Dashboard UIs

Release 10.0.8 - 24/01/23

Product enrichment & External API - Public opening Enrich your events in real time with data transmission from your product catalog or from an external API. It does not requires any data storage
OnSite API:
are available, to help you on consent behaviour management:
- cact('consent.onReady', (consent) => console.log(consent))
- cact('consentBanner.show')
- cact('consentBanner.hide')
- cact('consentCenter.show')
- cact('consentCenter.hide')
Destinations:
- Adobe Analytics: beta
- Pinterest: beta
- Piano Analytics: improvement you can now set the Piano Site Id parameter with a dynamic value

Release 10.0.7 - 24/12/22

Destinations:
- Google Universal Analytics (GA3): beta
- Adobe Analytics: closed beta
Explore: Enhancement of LRB integrations in the platform\

Release 10.0.6 - 24/11/22

Data Management – New feature:
- Campaign analytics interfaces: public opening
Destinations:
- Google Enhanced Conversion connector now supports more events
- Commission Junction : smart mapping adjustments and public opening
- Google Univers Analytics: closed beta
- Partnerize: closed alpha
- TikTok: Add Smart Mapping : closed alpha
- Adobe Analytics : closed alpha
Global Platform X:
- Even faster interfaces on : CMP UI, client-side TMS UI, Administrations UI, Campaigns Analytics UI => closed alpha. Public opening on 13 Jan.
- Data Activation features: public opening

Release 10.0.5 - 24/10/22

Data management - new feature:
Enrichment - new feature:
- Event enrichment from your Product catalog: Copy in realtime time any properties of your imported product catalog to your choosen event. Use case example: send a purchase event with only product ids and enrich your events on the server with all the product properties you have in your product catalog for these ids. (closed beta) Public opening on 08 Dec.\
Destinations improvements:
- New feature : smart mapping (closed alpha) : visualize/edit the data mapping done automatically by the system between your event properties and the destination's API. This feature will be progressively open on each destination during next months.\
- Enhancement on existing destinations: Tradedoubler, Criteo conversion, Snapchat, GEC, TikTok, Kwanko
- Event delivery: error's labels enhancement, easier to understand what is wrong
Sources enhancements:
- Web container : Add a summary/setup guide step.
Campaign analytics - new feature:
- New whitelist feature for landing page redirections (closed beta)

Release 10.0.4 - 24/09/22

Global Platform enhancement:
Source improvements:
- iOS SDK: Core 5.1.1 ServerSide 5.1.2
  - Supporting TVOS Consent 5.1.2
  - Disclosure for IAB's vendors
Destinations improvements:
- Event inspector now show initial event too in each log
- Enhancement on existing destinations : Piano Analytics
Explore improvements:

Release 10.0.3 - 24/08/22

Sources improvements:
- Live Events Inspector for sources, available both in Sources menu (for all sources) and on each source (tab Event Inspector). It allows to inspect/debug your incoming events
Destinations improvements:
- - Ability to create new property and map them to existing one for a specific destination
- Enhancement on existing destinations : Piano Analytics, Snapchat and Google Enhanced conversions
- New destinations :
Campaign analysis -> Live Report builder look and feel enhancements
Minor UI enhancements:
- tooltip on all destinations or sources logo in overview UI
- Increase clarity of labels on some UI
- Add technical base for future onboarding features

Release 10.0.2 - 24/07/22

Sources improvements:
- Duplicate a source (except web containers)
- Link/unlink destinations to a source (create and edit)
Destinations improvements:
- Duplicate a destination to edit it in another environment
- Activate/ deactivate switch, to pause a destination
- Userfriendly way to select a specific sources to a destination (create and edit)
- Advanced mapping on each destination
- TikTok connector (Web mode only, App mode in September)
- Piano Analytics, Snapchat, Criteo, GA4 enhancements/fix

Release 10.0.1 - 24/06/22

Sources improvements:
- Source data quality in health menu (global) and in a tab for each source
- Adding new sources, currently in closed alpha (Shopify, pixel tracking, cost imports…)
- Source event inspector : inspect each event individually (intelligent sampling)
- Adding new environment: ‘development’
Destinations improvements:
- Consent categories dropdown on destination’s filters
- Destination description: what you will need & supported sources sections
- Adding new environment: ‘development’
Improvements on 2FA
Integration of segment stats interface
New connectors: Criteo Events, Tradedoubler, Xandr*, Appnexus*, Tableau*
Destination enhancements:
- Webhook v2 (more methods, and more formatting data possibilities)
- Google Enhanced Conversion v2 (new Google API)
- Google Analytics 4 (more options)
- AT Internet (cookie server)
- Awin (more advanced affiliation property option)

(*) audience based destination

Release 10.0.0 - 21/01/2022

Serverside v2 interfaces - closed beta 1

Release 0.0.12 - 01/02/1970

Removed humans, they weren't doing fine with animals.
Animals are now super cute, all of them.

Release 0.0.1 - 01/01/1970

Introduced animals into the world, we believe they're going to be a neat addition.

GTM Tutorial

Quick Setup: From GTM Client-Side to Commanders Act Server-Side

This guide shows you how to quickly set up server-side event forwarding for GA4 in Google Tag Manager (GTM) using Commanders Act. With this setup, your GA4 events can be routed to multiple destinations like Facebook CAPI, Google Enhanced Conversions, and others.

Create a GTM Source in Commanders Act.
Update the GA4 URL in GTM.
Set Up Domain Delegation for first-party data collection (strongly recommended).

Alternative Approach for Event Tracking

Instead of using GA4 to transfer events, you can add Commanders Act tags directly in GTM for each event you want to track. While this method takes more time to set up, it gives you full control over which events are sent, independent of GA4, and works even if GA4 is not used.

Step 1: Create a GTM Source in Commanders Act

Log in to Commanders Act.
Copy the Source Token displayed.

Step 2: Update GA4 in Google Tag Manager

Open your GTM workspace.
Find your GA4 Configuration Tag.
In the Tag Configuration window, under Fields to Set, add a new field with the following values:
- Field Name: server_container_url
- Value:
  https://collect.commander1.com/events?tc_s={siteId}&token={sourceKey}&&ga_url_param=
Replace:
- {siteId}: Your Commanders Act site ID.
- {sourceKey}: The Source Token from Commanders Act.

Note: This URL uses Commanders Act’s default domain (commander1.com) to get you up and running quickly. For better data quality, it’s strongly recommended to use your own custom domain (see Step 3).

Save and Publish your changes in GTM.

Step 3: Set Up Domain Delegation for First-Party Data Collection

For enhanced data accuracy and first-party tracking, we recommend setting up a custom domain through domain delegation. This ensures the data is collected and processed as first-party, improving tracking reliability and compliance with privacy regulations.

How to Set Up Domain Delegation:

In GTM, update server_container_urlwith your subdomain url such as:
```
https://collect.yourdomain.com/events?tc_s={siteId}&token={sourceKey}&&ga_url_param=
```
Replace collect.yourdomain.com with your own subdomain.

Using a custom domain not only improves tracking precision but also helps ensure better compliance with browser and privacy policies.

Step 4: Event Forwarding to Multiple Destinations

Once GA4 events are sent to Commanders Act, they can be forwarded to various destinations, such as: Facebook CAPI, Google Enhanced Conversion, Bing Ads, TikTok, Awin, ... And many more through the Commanders Act plug&play destinations catalog.

Going Further: Bypassing Ad-Blockers with GTM Script Proxification

For users looking to optimize server-side tracking, Commanders Act provides also an option to proxify the GTM JavaScript file to bypass ad-blockers. This solution ensures that consented data can still flow to your analytics tools or partners without being unfairly blocked by ad-blockers that might indiscriminately block GTM scripts, even when used responsibly.

How It Works:

Instead of using the default GTM URL (e.g., https://www.googletagmanager.com/gtm.js?id=XXX), the script is served from your own domain (e.g., https://track.yourdomain.com/custompath.js) with a unique path modifier to avoid detection by ad-blockers.
This process helps ensure that only user-consented data is collected and forwarded, in strict compliance with privacy regulations such as GDPR.

A Privacy-Respectful Approach:

Our server-side infrastructure is designed with privacy, consent, and user control at its core. By proxifying the GTM script, you're simply ensuring that consented data can be processed and sent to trusted tools and partners, in line with the user’s preferences. This aligns with best practices in privacy and GDPR compliance, ensuring that ad-blockers do not unfairly interrupt responsible data flows.

If you're interested in setting this up, please contact your account manager for more information.

Purchase event example (ssv1 to ssv2)

Here are an example of a serverside v1 hit : Booking Confirmation :

{
    "method": "GET",
    "event_page_name_detailed": "page.Checkout.Confirmation",
    "booking_order_number": 9179124954957,
    "product_list_pricing_price_base_amount": 295.82,
    "product_list_pricing_currency_displayed": "USD",
    "event_page_funnel_location": 70,
    "point_of_sale_eg_brand_name": "magicOne",
    "event_page_p_line": "F",
    "privacy_ccpa_consent": true,
    "privacy_gdpr_consent": true,
    "product_list_product_id_1": 4521812,
    "product_list_product_name_1": "Luggage compartment",
    "product_list_product_id_2": 5721913,
    "product_list_product_name_1": "Lifeline",
    "request_request_url": "https://www.domain.com/Checkout/V1/MultiItemBookingConfirmation",
    "user_sha256_email_address": "4a0a303e33c11f496a9312a77309133325af1527a26d9d95cf74b81feba9c955",
    "facebook_fbp":"fb.1.1596403881668.1116446470",
    "device_information_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.110 Safari/537.36 Edg/96.0.1054.62",
    "timestamp": "11/01/2022 14:32",
 
}

It should be sent to the serverside v2 in this format (adding maximum of recommanded properties) :

{
    "event_name": "purchase",
    "properties": {
        "id": 9179124954957,
        "revenue":295.82,
        "value": 300.00,
        "currency": "USD",
        "point_of_sale_eg_brand_name": "magicOne",
        "p_line": "F",
        "items": [
            { 
             "discount":1.99,
             "quantity": 2,
             "product":{ "id":"4521812", "name":"Luggage compartment"}
            },
            {
             "discount":1.99,
             "quantity": 1, 
             "product":{ "id":"5721913", "name":"Lifeline"}
             }
        ],
        "user": {
            "id": "61be2261-8701-4b4d-af97-60ea4329c7aa",
            "email_sha256": "4a0a303e33c11f496a9312a77309133325af1527a26d9d95cf74b81feba9c955",
            "consent_categories": [
                1,
                2,
                3
            ]
        }
    },
    "page": {
        "location": "https://www.domain.com/Checkout/V1/MultiItemBookingConfirmation",
        "title" : "page.Hotels.Checkout.Confirmation",
    },
    "device": {
        "user_agent": "Mozilla/5.0 (X11; CrOS x86_64 14268.67.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.111 Safari/537.36",
        "cookie": "_fbp=fb.1.1596403881668.1116446470;_fbc=fb.1.233356.5656565;"
    },
    "event_timestamp": 1641907920000
}

Standard parameters :

Cookies should be sent through thedevice.cookieparameter. For example, if you use Facebook CAPI, you'll have to send _fbp and _fbc cookies

RGPD: User consents have to be sent in each events, inside the user.consent_categories parameter

Migrate from old mobile sdk

How to migrate to the old platform sdk (Platform 7) to the new platform (Platform X)

Steps to follow for migration from SDK v4 to SDK v5

Create your Mobile Source(s)

In the Sources Catalog, create your new Sources. Sources > Overview > Add Source

At the last step of the Source setup, you will obtain a Source Key, required for the initialization methods of our SDK

Replace SDK Modules

Our SDK files have changed. You must replace the old ones. Get our latest versions :

Some names of our modules have also evolved, here are their correspondences :

TCSDK -> TCServerSide

TCPrivacy -> TCConsent

Modify initialization methods

The way you initialize our SDK is now different, your old methods will not be recognized anymore.

You don't need container ID anymore, all is on the same site ID. Instead of a container ID you'll need a specific key to define the source.
You don't need to put any TCServerSide instance in your Consent implementation anymore.
You might need to use the TCUser class to forward relevant information about your users.

There’s a code example you can check here:

If your mobile app use our SDK modules only for Privacy your migration is done at this point.

If you want to benefit of all the advantages of tracking with server-side destinations, or if you were using server-side v1 containers to send data to your partners, please follow the next steps!

Replace container calls by events

With the old platform, you were used to send a container call, with all the variables. It's not compatible anymore. Instead, you have to send events with properties.

Here’s a code example of how to execute an event:

let event = TCPageViewEvent(type: "product list")
	event?.pageName = "Best sellers"
	serverside?.execute(event)

Upgrade your data layer

The new platform is using standard properties, so we recommend to upgrade your mobile application’s data layer by using our standard properties as much as possible

Create your destinations

Test & validation

A Quality Assurance Test & validation is strongly recommended before launch in production ! Here’s a few references to help you on this point:

Testing => tips how to test
Common errors list

Your migration is done !

Maybe you have some specific needs ? Don’t forget to check the following FAQ

FAQ

Should my data layer be identical for my website & my app ?

It’s a good practice ! We strongly recommend to have the same data layer for web & mobile application Main benefit: setup only 1 destination for both sources! Your destination’s setup will be recognized by web and mobile

How can I obtain the IDFA/AAID ?

Our SDK doesn’t collect automatically the IDFA/AAID anymore, but we offer a simple method to track this information:

Can I create custom events ?

Yes it’s possible !

Can I use additional parameters ?

Yes it’s possible ! If you need to send more data then just the required properties, simply use the "additional property" method, as follow:

TCPageViewEvent pageViewEvent = new TCPageViewEvent("Consent");
pageViewEvent.pageName = "Configuration";
pageViewEvent.addAdditionalProperty("currentConsent", "refused");

TCPageViewEvent *pageViewEvent = [[TCPageViewEvent alloc] initWithType: @"Consent"];
pageViewEvent.pageName = @"Configuration";
[pageViewEvent addAdditionalProperty: @"currentConsent" withStringValue: @"refused"];

Can I add Persisting variables ?

Yes it’s possible !

Persisting variable’s definition: it’s a key/value which will remains the same as long as the app is opened (example : Google account ID)

Do I need to change/update my Json file ?

It’s not required ! Your current json is still valid for our new SDK

It’s not required ! Your current setup is still valid for our new SDK

Testing

The “TEST” step seeks to prevent problems in production by testing the version of a container and diagnosing its compatibility and reliability.

At first, it will block deployment of the faulty container, but you can ignore some of the errors found, such as those resulting from incompatible JavaScript elements with old versions of browsers (IE8 for example).

A total of 8 browsers/OS are tested:

The latest version of Edge
The latest version of Chrome
The latest version of Firefox
The latest version of Opera
The latest version of Safari (for the Mac OS)
The latest version of Safari (for tablets)
The latest version of Android (for tablets)

Tests are performed on five levels:

Container: The container’s code (the JavaScript file) is tested globally
Data layer: The data layer (internal and external variables, etc.) is tested in isolation
Custom JS blocks: The static and dynamic JavaScript files are tested in isolation
Tags: All tags are tested, and errors are displayed by tag
Events: All events are tested, and errors are displayed by event

If no errors are detected, your version is “DEPLOYABLE”:

If an error is detected in your container, it will be indicated by a red “X” under the browser returning the error and on the line of the element the error was found in (Data layer, Custom JS blocks, Tags, Events); it will also appear on the Container line .

In this case, your container version is “NOT DEPLOYABLE” until you correct or ignore the error.

We recommend that you correct the errors detected in the Data layer, Custom JS Blocks, Tags, and Event before correcting the Container errors since the latter will most often disappear after the other four levels are corrected.

To display and correct errors, click on a red “X”.

A window will appear displaying the test error details. Below is an example of a possible tag error:

Error message details returned by the tested browser

Tag name and line number where the error is found. Clicking the button redirects you to the “Edit” step where you can correct your tag’s code directly.

Note: Do not hesitate to contact your personal consultant or the Commanders Act support team (support@commandersact.com) if you need help correcting an error.

Finally, the “TEST” step allows you to consult the error history for the different container versions generated. This history is displayed at the bottom of the “Test” page, where you can click the red “X“s again to display the error details:

Deployment and roll back

A container can be deployed at the “DEPLOY” step:

Before deploying a container version, you can:

Display all the modifications made to your container since its last deployment (technical logs) (1) in the “MODIFICATIONS SINCE LAST DEPLOYMENT” section
View the history of generated versions in the “DEPLOY BY VERSION” section.

For each version generated, you will find his version number, creation date, status (“deployed” when it is the version currently deployed and/or “live” when it is the version currently called for the site) , the name of the person who generated the version, a comment, and the container’s size. You will also be able to load your selected container version directly from the interface or via a permanent link:

Additional information:

The “Weight Detail” section shows the container’s size (in GZIP format), its change in size since the last deployment as well as the percentage of space occupied by each of the following container elements:

Core: The weight of the content necessary to execute the container
Tags: Tags’ weight
Events: Events’ weight
Rules: Rules’ weight
Privacy: Privacy module’s weight (if activated)
Internal variables: Internal variables’ weight
Deduplication channel: Deduplication channel’s weight (if activated)

Deploying a new container version or rolling back a container is done in two steps:

Choose the version to deploy.

Note: to roll back the container, just select a previous container version.

Choose the deployment method.

Note: the deployment method depends on your container’s hosting and synchronization, which are defined at the project’s start with your personal consultant.

Once the version and deployment method are selected, a window summarizing the deployment will appear. Click “Deploy” to validate:

Additional information

Depending on the hosting and synchronization methods defined at the project’s start and configured in the interface, different deployment options are available in the drop-down menu under “Choose the deployment method”:

Creation and modification

To create/add a container, go to the “Web Containers” tab on the platform and click “ADD CONTAINER”:

A configuration window will appear with 3 main tabs:

After configuring the various container options, click “Add”

General

Simply fill the “Name“ field with Container’s wanted name

Synchronization

Mode: Synchronization modes for the container:

FTP/CDN: This mode hosts the container on an FTP or CDN server (the server must be previously configured in Administration => Connector Credentials). By clicking this option, the “Set as deployed and send to FTP” synchronization mode will be proposed in the “DEPLOY” step.
Amazon S3: This mode hosts the container on an FTP or CDN server (the server must be previously configured in Administration => Connector Credentials). By clicking this option, the “Set as deployed and send to AWS” synchronization mode will be proposed in the “DEPLOY” step.
Update by batch from permanent link: this mode activates a permanent link to the last container version deployed. This mode can be useful when manually updating the container on your site or if you use a batch that regularly restores the last container version on the site. By clicking this option, the “Set as deployed and use external URL” synchronization mode will be proposed in the “DEPLOY” step.
Custom URL: this mode calls a URL when deploying the container (the URL must be previously configured in Administration => Connector Credentials). This URL refers to a script placed on your servers (created by you) that must perform the operations necessary to launch the container. By clicking this option, the “Set as deployed and call the URL” synchronization mode will be proposed in the “DEPLOY” step.
Manual: this mode allows you to load the container directly from the interface so that you can then deploy it manually on your site. You can check the “Add unminified version” function in order to load the container in either compressed (minified) or uncompressed (unminified) mode. By clicking this option, the “Set as deployed and get JavaScript file” synchronization mode will be proposed in the “DEPLOY” step.
Send an email: this deployment mode complements the other 4 modes. It is used to send a notification email to specified users when a deployment is carried out.

Recurring synchronization:

Recurring synchronization is used to automatically deploy a container on a regular basis via the deployment mode desired (FTP, batch or send by email).

Two programming modes are available: Simplified mode and expert mode:

“Simplified mode”: Simplified mode is used to program recurring synchronization by the day and hour (e.g. recurring synchronization every day at 2 p.m.).
“Expert mode”: Expert mode is used to program recurring synchronization with more precision, by minute, hour, day, week and month (e.g. recurring synchronization every two weeks of the month on Tuesdays at 11:35 a.m.).

Advanced

NoScript support: This option is used to create a noscript version of the container that allows both the container and its tags to execute for users without JavaScript activated on their browser.

You can also define a JavaScript version and noscript version for each tag.

Verification by MD5 file: This option is linked to the “Manual” deployment mode and associates an MD5 code with a container version in either compressed (minified) or uncompressed (unminified) mode in order to verify the integrity of the container before putting it into production. It does this by comparing TagCommander’s MD5 code with the MD5 code calculated by your technical team upon receiving the container.

Include jQuery (at the test step): This option allows you to include the JavaScript jQuery library in the test step so that you won’t have any errors linked to its absence if it is indeed present on your site.

Display block for old tc_event function: This option allows to show/ hide the old TagCommander event section. It is hidden per default.

Default expiration date: This option allows you to set a default expiration date for all the tags to be added to the container (in this case, the tags will be deactivated). If necessary, it also allows you to send an expiration report to selected users when a tag expires (the report is sent 2 weeks and 1 week before the tags expire).

Container default trigger: Container Load is the value by default, you can modify it if needed

Linked sub-domain(s) for Phoenix: Enter your sub-domains for Phoenix, which enables you to persist 1st party cookies for longer durations to reduce the impact of ITP on your website and business.

Force Cookie SameSite setting: all cookies created through the container will get the SameSite parameter

Force Cookie Secure setting: all cookies created through the container will get the Secure parameter

*Note: this setup can be modified at any time. Simply click the 'parameter' icon:

Hosting

Hosting types

We offer two ways for your container's hosting:

Via your site’s web servers, managed by your IT department or outside technical provider. With this hosting option, you can choose a synchronization method (automatic or manual) for transmitting the modifications made for your site in the Commanders Act interface. In all cases : for a new workspace, you will be must to configure the connector on the platform. Use the menu Administration => Connector Credentials to add a new connector

FTP connector configuration

Simply fill in all fields of the form: Name: Give an explicit name to your connector Containers: Select any client-side containers you want to associate with the connector Protocol: Select the type of File Transfer Protocol you need. We recommend to using SFTP, for security reasons Host: Enter the main domain or IP address of your FTP repository Port: Enter your standard port ID (SFTP is 22, FTP is 21, FTPS is 21...) Path: Enter the path of your repository. Should end with a "/" (see below example) User: Login to access of your FTP Password/Key: if there's a password or a key associated to your FTP, enter this information here

CDN connector configuration

It's almost identical to the FTP connector, there is only 2 more steps: Select a CDN vendor (EdgeCast or Akamai) Setup the "Purge" part (use the Account ID, Token and Purge URL provided by your CDN vendor)

URL connector configuration

Just give an explicit name, enter the correct URL and select any client-side container(s) you want to associate with the connector

Amazon S3 connector configuration

It's almost identical to the FTP connector. However, it requires a bucket as the host:

Google Cloud Storage connector configuration

fill in all fields of the form: Name: Give an explicit name to your connector Bucket: Enter the main domain or IP address of your FTP repository Path: Enter the path of your repository. Should end with a "/" (see below example) Project ID: Enter the id of the project in Google Cloud Storage. Can be found in Google Cloud JSON Key file Private key ID: Enter your private RSA Key Id for Google Cloud Services. Can be found in Google Cloud JSON Key file Private key: Enter the password associated to your Private Key ID. Still can be found in Google Cloud JSON Key file Google Account Email: Enter the client Google Cloud Services email used for authentication. You can find it in Google Cloud JSON Key file Client Id: Enter the client Google Cloud Services Id. Still can be found in Google Cloud JSON Key file Client X509 Cert URL: Enter the client custom X509 URL for Google Cloud Services. Can be found in Google Cloud JSON Key file

The Private Key field must include the comments 'BEGIN PRIVATE KEY' and 'END PRIVATE KEY' All the characters "\n" present in the Private Key must be replaced by "enter" (jump line)

Bing Ads connector configuration

Simply follow the step by step guide provided by Bing:

Facebook Ads connector configuration

Simply follow the step by step guide provided by Facebook:

Criteo connector configuration

Simply follow the step by step guide provided by Criteo:

Google Ads connector configuration

Simply follow the step by step guide provided by Google Ads:

Please note! Deletion of this connector credential is final. By removing access to a login, you will no longer be able to use it for this or any other site. This means you'll have to create a new one if you need it in the future.

If destinations from other sites use this identifier, they too will no longer work.

In case this login is currently used by at least one destination, our interface will display a list of the concerned destination(s) (only for the current site, it may affect some destinations on other sites)

Snapchat connector configuration

Simply follow the step by step guide provided by Snapchat:

Adobe Analytics connector configuration

Equativ connector configuration

Simply follow the step by step guide provided by Equativ:

Test & Debug

Once your connector configuration is done, you can click on the Test button to check that it's working properly. If it is correct, then you will see the following message:

Common errors:

your directory is not writable
mistake on host/port/path
Insufficient space
Network outage = server/ or network problem

OneTag Tutorial

1. Add the OneTag from the tag library

From your web container, add a tag from the tag library, searching Commanders Act OneTag

You will find 2 tags to choose from :

The OneTag - Builder: it will guide you without having to write code
The OneTag - Custom: for those who prefer to manually write complex event data using javascript

2. Setup the tag

Here’s the format of a typical trigger call:

Each event has a name, like page_view, and properties. For example, a page_view event might have properties like page_name or page_type.

Here is an example

config and callback parameters are optional

Standard events and custom events

You can implement two types of events:

We strongly recommend the use of standard events, as it allows you to benefit from plug&play features, automatic-mapping, automatic-QA-alerting, etc. but also future features/reporting.

Inside a standard events, you can add custom properties beside standard properties

Inside custom events, it is recommanded to put standard properties. Of course, custom properties can also be added

If you use Commanders Act CMP, the user consent is automatically retrieved and put inside all events in the user property.

If you use another CMP, you will have to add manually a property consent_categories inside a user property, following this example :

Advanced options: Overriding default parameters

There are 3 default parameters that you can override if needed:

collectionDomain: if not set, the default value correspond to your first party domain (if you setup one) or collect.commander1.com
siteId : if not set, the default value is the site id of the last web container loaded (tC.id_site)

To override a parameter, you can add a config object to your cact('trigger') function (4th parameter) like this:

3. Check that everything is working

The Source Event Inspector serves as a live tool that aids in validating the arrival of events originating from your website, mobile application, or servers to your Commanders Act Source. This enables you to promptly examine the reception of calls by your source and troubleshoot without the need to await data processing.

4. Setup your first destination

Once you have verified the inflow of data from your fresh source, it's the perfect moment to create your first destination:

Navigate to your Commanders Act platform, click on Destinations-> Overview, and select 'Add Destination' to list all the available destinations in the catalog.
Look for the destination of your preference. For example Facebook Conversion API.
Click on the card representing the destination to obtain more information about it.
Initiate the configuration by clicking on 'Configure'
Choose the source that you had previously setup, or select all sources.
In the settings screen, name your destination, choose an environment and enter required information.
Then in the filter tab, manage the user consent by selecting the appropriate consent categories for that destination (for example "Advertising" category for Facebook CAPI)
Save and go checking that everything is going well in the Event Delivery and/or Event Inspector tab, or directly in your tool.

FAQ

When you add a destination (aka serverside tag), you manage the user consent by selecting the appropriate consent categories for that destination (for example "Advertising" category for Facebook CAPI). As a result, since each event entering the platform contains information about the user's consent, the event will only be sent to the destination if there is a match between the categories consented by the user and the consent's category associated to the destination.

//example for the private key:

-----BEGIN PRIVATE KEY-----
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxp
yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy0
zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzA
aaaaaaaaaaaaaaaaaaaaaaa=
-----END PRIVATE KEY-----

Configure tags

Once a tag is added, you can configure it in the “EDIT” step.

A list of your tags is displayed in the left menu of the “EDIT” interface. Tags that need to be configured or validated have a warning (/!\) sign before their name.

For each tag selected, a configuration window will appear in the center of the interface containing the following elements:

Expiration: An expiration date can be applied to the tag

Tag variable(s): Tag variables that need data layer data or static information linked to them

Tag code: The selected tag’s code

Use Tag Cleaner: JavaScript correction tool and preview button to see the tag’s code once its variables have been mapped with variables from the datalayer

Previous version(s): The tag’s version history;

“delete” and “save” buttons

Rules: Shortcut to the tag’s rules configuration

Expiration date

Setting expiration on a tag

You can apply a custom expiration date to each tag. Check the box to activate this function and then select a date on the calendar or type it in the blank field.

When you activate the expiration function, it automatically deactivates the tag into the container on the expiration date selected.

This function is useful if you have added a tag for a specific campaign and you want it to be deactivated once it ends, so that your container is not needlessly overloaded with tags.

Mapping tags' variables

Important reminder: You must create a link between the information requested by the different tags in the container and the data available in the data layer. Adding data layer variables to tag variables is called “mapping“.

The tag variables to map are called “dynamic variables“, and they are designated in the following manner: #variable#.

They appear in the tag’s code, in blue boldface, as well as above the tag’s code .

Additional information

If the tag’s code does not meet your needs, you can customize it directly in the “JAVASCRIPT CODE” section as well as the “NOSCRIPT CODE” section for browsers without JavaScript activated (this function will only work if you call the NOSCRIPT version of the container in your site’s source code):

You can modify your tag directly by transforming the dynamic variables within the code into data of your choice.

Example:

You can also customize your tag’s code by changing the static elements into dynamic variables.

Example:

Note: you can modify your tag anytime you want. However, please pay attention to its JavaScript structure: Dynamic elements must be placed between the ## and followed or preceded by a “+” if they are joined with static elements. The colored syntax in the tag code allows you to verify that there are no errors:

Configuring custom tags

A “Free input (custom)” tag can be used to add a tag to your container even if it is not listed in the tag library.

To configure your custom tag, just replace the default code in the “JAVASCRIPT CODE” with the code supplied by your partner solution and click “SAVE”.

In the vast majority of cases, you will see that your tag is rewritten so that its structure is compatible with that of the container and is called asynchronously. This is also done to prevent errors linked to certain JavaScript data structures such as “document.write”.

Tags are corrected by using the “Use Tag Cleaner” feature:

Uncheck the “Use Tag Cleaner” box if you do not want your tag to be rewritten.

Returning to a previous tag version

Each time a container is generated, Commanders Act saves the tags present in the container, thus allowing you to return to an old tag configuration if necessary.

Tag version: number of the last tag version saved, name of the user who generated the version, and the date and time it was generated

“Rollback“: button allowing you to return to the tag version displayed

Tag code: selected tag code (JavaScript or NoScript code depending on the option selected in (3))

Tag versions: previous versions of the tag

To return to a previous tag version, select the version you want and click “ROLLBACK“.

Applying a rule on the fly

You can add a tag activation rule directly in the “EDIT” step.

You have two options:

The rule creation window will appear so that you can create your rules in the same way as in the “RULES” step.

Displaying the summary of tags and associated rules

To display a summary of all the tags present on your site along with their rules, go to the “REPORTS” tab > “Tags’ Summary“ *this page is currently accessible only from Platform v7.

You can display the code, rules and expiration date for each tag.

You can also filter the containers or tags that you want to analyze.

This report can be useful for displaying which tags are present on your site at a given time and for sharing this information with others internally. It can also help you find a tag from the list of tags present on your site.

Saving and removing a tag

Once you have finished configuring your tag, click “SAVE” to save your modifications.

You can also delete a tag you do not need any more by clicking “DELETE”.

Caution: a deleted tag cannot be recovered.

Tags' activation and execution order

All checked tags are active and all unchecked tags are inactive. The advantage of deactivating a tag rather than permanently deleting it is that you can keep all the tag parameters (mapping, rules) and reactivate them at a later date without having to reconfigure everything.

Note: Since a deactivated tag will be visible in the interface but not in the container called for your site, your container will not become needlessly cluttered.

To modify the order in which tags are executed in a container in the “GENERATE” step, just drag and drop each tag in the “RANK” column and place them in the order in which you want them to execute on your site’s pages, and then generate a new container version (blue button in the upper-right hand side of the screen):

We recommend that you place the most important tags at the top of the container so that they have the best chance of executing if your visitors change pages quickly without waiting for them to fully load.

Setting a timeout on a tag

To improve your site’s performance, Commanders Act suggests that you deactivate a tag if it takes too long to load. You can enter a maximum duration, in milliseconds, for a tag to execute. If the tag takes longer than this time to execute, it will be deactivated.

Customizing the tag library (whitelisting)

You can customize the tag library by restricting the number of tag templates available in the tag addition popin from the “Select” and “Edit” steps.

This “tags whitelist” feature is useful if you wish to limit access to the solutions in the library and only make some of them available to your staff. This aims at preventing users from placing tags you did not authorize into your containers.

The “Library management” interface is accessible to administrators and to custom users this interface was granted access to. The tags whitelist is managed from the “Admin” > “Library management” interface. This page is currently only available on platform v7.

All tags will be selected by default.

You can click the “Unselect all” option and then choose the tags you wish to make available in your library.

Select the site you wish to set up the tags white list for from the drop down menu.

You can Check/Uncheck relevant tags.

The “Select all” and “Unselect all” buttons allow you to check or uncheck many tags simultaneously.

You have the possibility to filter tags by name or alphabetical order.

Click the “SAVE” button to save your settings.

Must know:

When a new tag is added to the tag library by Commanders Act’s staff, it is automatically unchecked if you have already created at least one tag whitelist for your site.
You can copy a tags whitelist from one site to another from the “Administration” > “Copy management” menu.

Javascript block

Adding static JavaScript code

Commanders Act allows you to include “free” JavaScript in the tag container, with no character limit, in two places named “Static JavaScript Code”.

The “Static JS codes” allow you to perform different types of actions, notably:

– Fixing data layer issues.

E.g. If your external variable “page_name” contains values with special characters, you can delete or replace them in the Static JavaScript code (e.g. change “&” into “and” as follows:

Thus, you can continue to use your external variable “page_name” in tags by removing its special characters via the Static JS code.

– Recovering data absent in the data layer from the site pages’ source code.

E.g. You can recover JQuery form fields in your Static JS block in the following manner:

The “Static JS codes” appear in two places in the left menu of the “EDIT” step interface:

– The first Static JS code is placed before the declaration of internal variables in the order that elements in your site’s container are executed.

– The second Static JS code is placed after the declaration of the internal variables (you can thus reuse previously declared internal variables in this position):

The same user interface is used for the Static JavaScript code regardless of whether it executes before or after the internal variables. Just enter the JavaScript code you desire and click “SAVE”.

Adding dynamic JavaScript files

Commanders Act allows dynamic JavaScript file(s) to be included in a tag container, in two places named “Dynamic JavaScript File(s)“.

Unlike “Static JavaScript codes“, “Dynamic JavaScript Files” are JavaScript files outside Commanders Act that are downloaded and then added or updated in the container each time it is generated.

The “Dynamic JavaScript File(s)” allow you to perform different types of actions.

For example, you can use them to import a JavaScript file containing a JQuery library (if it is not already called on your site) or a JavaScript currency converter file into your container. By importing these files into Commanders Act, you can add them to your solutions or use them to create new variables (for example, you can automatically update currencies in your solutions’ tags).

“Dynamic JavaScript File(s)” appear in two places in the left menu of the “EDIT” step:

The first Dynamic JavaScript File(s) is placed before the declaration of the internal variables, in the order that the elements of the container on your site are executed.
The second Dynamic JavaScript File(s) is placed after the declaration of the internal variables (you can thus reuse previously declared internal variables in this position):

The same user interface is used for the Dynamic JavaScript File(s) regardless of whether they execute before or after the internal variables. Just enter the URL of your JavaScript file and click “SAVE”.

You can perform this operation again for all the JavaScript files to be included in your tag container.

Caution: adding JavaScript files to the container will increase its size and thus increase the time for the pages to load.

You can update your dynamic file manually (by clicking “Refresh”), display its contents (“View”) or delete it (“Remove”):

Plugin Commanders Act Assistant

Introduction

We are excited to introduce the latest version of our browser plugin, Commanders Act Assistant (CAA)! Designed to streamline your testing and debugging processes, CAA is fully compatible with Google Chrome and Microsoft Edge, offering seamless integration into your workflow.

*Availability in the Microsoft Edge Store is coming soon!

Key Features

Replace Web Containers easily

How to replace your(s) Web Container(s)

You can test directly using the dedicated buttons visible on the steps "Generate," "Test," and "Deploy" within the Commanders Act platform, making it easier to validate your configurations.

Plugin must be active on your browser to see these buttons

On click, you will be invited to enter the expected landing page for your test session, then click 'OK' to be redirected to your site.

Stop Web Container(s) replacement

To turn off the override, simply click the button "stop override" on the plugin.

Monitor Tags in Action

Easily view the list of triggered tags as they fire on your website, giving you a clear overview of your tracking implementation in real time. Simply unfold the "web containers" section to see the list

Reach your Web Container in 1 click

Use the icon aside the Site Name - Container Name to reach in just one click your Web Container on our Platform

Keep a History Across Pages

CAA records events across multiple pages, ensuring you have a complete history of tag activations for a comprehensive debugging experience.

Need to clear your history ? You can clear by stopping the "record across pages" option, reloading the page, and turning it on again. This process will be improved in an upcoming update!

To preserve confidentiality, our plugin requires to be logged on our platform.

Once you are logged, only the Sites and the Web Containers that you have access are visible through the extension

Limitations

While CAA is a powerful tool, here are some current limitations to keep in mind:

🌍 Consistent Web Container URLs: The WebContainer URLs must remain the same across all pages for the plugin to function correctly.
⚡ SPA Compatibility: On Single Page Applications (SPA), the list of triggered tags is only filled on the first hit collected by the plugin. On each page change, the tags are added to the list. *This will behavior will be improved in an upcoming update, so stay tuned!

Future Enhancements

CAA is continuously evolving, with new features and improvements planned to further enhance your testing experience. Keep an eye out for future updates that will make debugging and optimization even easier!

Coming soon

Events tracking
Web DataLayer visibility

Data layer and data types

The data layer represents all your available data. It consists of information about your site (e.g. page name, product ID) and your visitors (e.g. user ID, customer status) in the form of JavaScript variables.

These variables have two uses:

– To populate the tags present in your container;

– To create activation rules for your tags.

Additional information:

The data layer can consist of two types of data:

– Data implemented by your IT department or your technical provider for all your web pages, based on the CSS, Backoffice and CRM. These data are called “external variables” and are displayed in your site’s source code as a JavaScript object containing all the variables used by your tags.

This is what the external variables look like in the source code:

<script type="text/javascript">
var tc_vars = new Array();
tc_vars["env_work"] = 'Prod';
tc_vars["env_channel"] = 'Web';
tc_vars["env_language"] = 'fr';
tc_vars["env_country"] = 'FR';
tc_vars['page_type'] = 'Homepage';
tc_vars["page_name"] = 'Tag Commander Market';
tc_vars["page_category_1"] = '';
tc_vars["page_category_2"] = '';
tc_vars["page_category_3"] = '';
</script>

/* Data layer is setup - call the Web Container Script underneath */

<script type="text/javascript" src="//cdn.tagcommander.com/674/my_web_container.js"></script>

– Data created in the interface by Commanders Act staff or Commanders Act users based on information available on the site’s pages (URL, cookies, HTML tags, external variables in the data layer, etc). They are called “internal variables” and are displayed in the Commanders Act web container’s code.

Basic actions

Summary of rules for tags and events

You can use the “Summary” interface to assign previously created rules directly to the new tags you want to add to the container:

By default, a newly added tag is called on the container loaded trigger, on all pages, with no constraints.

You can use this interface to add perimeters and constraints alerady created to tags or events added afterwards or modify them from the “Summary” interface:

To add a perimeter to a tag, you must check the box where the tag line and the perimeter column intersect. You can also delete a tag’s perimeter(s) by checking the green “All pages” column. The tag will now activate on all pages.
To add a constraint to a tag, click edit button (pencil icon) close to the triggers and use the existing constraints list to select those you wish to add to your tag.

Additional information:

You can add multiple triggers, perimeters and constraints to the same tag:

The “OR” logic operates when multiple triggers are added to a tag. For example, if you check the “Container loaded” and “add to cart button” triggers, your tag will activate in one case OR the other, i.e. on the container loaded and at the click on the button.
The “OR” logic operates when multiple perimeters are added to a tag. For example, if you check the “homepage” and “account creation page” perimeters, your tag will activate in one case OR the other, i.e. for the homepage and the account creation page.
The “AND” logic operates when multiple constraints are added to a tag. For example, if you check the “logged user” and “mobile exclusion” constraints, your tag will activate only if the two conditions are met, i.e. only for logged users AND everything except a mobile device.
The “AND” logic operates when a trigger, a perimeter and a constraint are added to the same tag. For example, if you check the “container loaded” trigger, the “homepage” perimeter and the “logged user” constraint, your tag will activate only if the three rules are valid, i.e. only at the container loaded AND on the homepage AND logged visitors.

Adding rules

You can add 3 types of rules: constraint, perimeters and triggers.

Perimeters are the page types you want to activate your tags for (example: the homepage, “my account” page, product page, etc.).
Constraints are rules based on criteria other than the page type (example: rules based on visitor status, the type of browser or device, etc.).
Triggers are rules allowing to execute tags on different conditions: container loaded, DOM Ready, clicks, form submissions, scroll and custom events.

To create a new trigger, click “Trigger” > “ADD TRIGGER”:

To create a new perimeter, click “Perimeters” > “ADD PERIMETER”:

To create a new constraint, click “Constraints”> “ADD TAG CONSTRAINT”:

By clicking “Add trigger” a rule creation interface will appear. This interface allows you to create a trigger of your choice: container loaded, DOM ready, click, form submission, scroll and custom.

By clicking “Add perimeter” or “Add tag constraint“, a rule creation interface will appear. This interface can be seen as a “tool box” that allows you to create rules based on various elements: cookies, data layer variables, URLs, etc.

The “tools” available to you can be selected at the top of the rules creation interface, and various options allow you to create the most appropriate rule for your tag. For each new rule created, make sure to complete the “Name” field (rule name), check the boxes of the tags to which the rule applies and configure the rule.

Note: The perimeter and constraint creation interfaces offer the same options, but in the constraint creation interface you need to link the constraint to a specific trigger:

Modifying a rule

To modify a rule, click the “edit” icon (pencil icon).

Note: you can modify the rule’s name and value. However, you must create a new rule if you wish to change its type: if you want to replace the “If Variable Equals” rule with “If Variable Is not Equal”.

Deleting a rule

To delete a rule, click the “trash” icon (garbage bin icon):

Note: your rule will be saved in the trash, where you can recover or permanently delete it at any time:

Event variables

Event variables are the variables present in Commanders Act browser-side events. They are used primarily for tracking user actions (button clicks, links, etc.).

Event variables are useful if you want to send data specific to an event without having these data on your site pages as external variables.

Example: you wish to assign an event for the “Send” button on your form. The event variables could be the user’s last name, first name, email address and telephone number. These are data that are not available when the page is loaded; it only becomes available after the user has completed the fields on the form and clicked “Send”.

Event variables must be added in the Commanders Act interface before they can be used, and only for events, not tags.

Event variables must be created in the Commanders Act interface before they can be used in an event. See the “Adding event variables” article to find out how to create an event variable in the interface.

All event variables created can be used:

To add information to the solutions embedded in Commanders Act (linking event variables and solutions is called mapping). See the “Mapping Tags’ Variables” article to find out how to map your variables in an event.
To create activation rules for your events. See the “Adding Rules” section to find out how to create rules based on your event variables.

Additional information

Event variables must be implemented in the Commanders Act event function (tC.events).

Note: External variables that are already available on the page do not need to be implemented in your event. For example, you do not need to assign a “country” variable to an event if this information is already present in an external variable.

Here is an example of an event variable:

When to add an event variable

There are two situations in which you may need to declare your variables in the event variable management interface:

You want to implement Commanders Act events on a new site. The variables that your technical staff or technical provider implement in the site’s source code (in the tC.events function) must be declared in the interface first in order to be available to be added to your tags and rules.
Variables are for your current event functions are missing or you want to add a new event to your site. Again, this variable must be declared in the interface first before it can be used in your tags and rules.

Adding event variables

The “add” window consists of the following elements:

“Name“: the variable’s name (mandatory field)

“Type“: the variable’s type

“Description“: A description of the variable, to clarify its name (e.g. “Page template” can be the description of the variable named “env_template”)

“Detailed description“: A detailed description of the variable, to further clarify tits name (e.g. “possible values: homepage/category/product/funnel_confirmation” can be the detailed description of the “env_template” variable)

Editing or deleting variables

You can edit an internal variable by clicking the “Edit” icon and delete it by clicking the “X”:

External variables

These variables are called external variables because they are outside the Commanders Act web container: They are embedded directly in the source code of your site’s pages, in contrast with internal variables, which are created inside the container and therefore not visible in the page’s source code. External variables are added by your technical teams or the technical provider in charge of implementing Commanders Act web containers on your site.

External variables are indispensable since they contain most of the data sent to the solutions present in the container. Their function and number vary depending on the site’s economic model (for example, media sites will not have the same external variables as e-commerce sites).

The list of external variables must be considered and established before Commanders Act web container is implemented in order to meet the embedded solutions’ medium- to long-term needs. A summary of the external variables to implement on your site will be provided by your Commanders Act consultant during the setup phase of the TMS, in an Excel file named “deliverables” or “tagging plan“.

External variables must be declared in the Commanders Act interface before you begin configuring tags in your containers. See the “Adding external variables” article in this section to find out how to declare an external variable in the interface.

All declared external variables can be used:

– To pass information to the solutions embedded in the container (linking external variables and solutions is called mapping). See the “Mapping Tags’ Variables” article to find out how to map your external variables in a tag.

– To create activation rules for your tags. See the “Adding Rules” section to find out how to create rules based on your external variables.

Additional information

As with your container, external variables must be present on all of your site’s pages and assigned values suited to the context. For example:

– The value of the “page template” variable will be different for the most important page templates on your site: homepage, product page, confirmation page, etc.

– The value of the “user id” variable will change for each visitor that connects to your site.

External variables must be declared in your site’s source code before the call to your containers (=JavaScript files). If you have a header container, the external variables will thus be present in the <head>; if you have a container in the body, they must be declared in the <body> html tag.

Here is a sample list of external variables:

Adding external variables

There are two situations in which you may need to declare your variables in the external variable management interface:

1) You wish to install Commanders Act on a new site: prior to having your technical teams or technical provider implement the data layer/variables in your site’s source code, you need to declare the variables in the Commanders Act interface so they are available for mapping.

2) Information is missing from your current tagging plan (e.g. customer status): Again, this variable must be declared in the interface first, before it can be used in your tags and rules.

Clicking “Download” will open a window containing the JavaScript code to insert in the site’s source code:

To add an external variable, you must go to the “Data Management” > "Web Data layer" > “External Variables” and click “ADD VARIABLE”

“Name“: the variable’s name (mandatory field).

“Category“: used to categorize the variable according to its application (e.g. variable relative to users, product pages, confirmation pages, etc.) See the “Categorizing External Variables” article in this section.

“Type“: The type of variable. See the “Managing Variable Types” article in this section.

“Use in noscript“: Check the box so that the variable is present in the tag’s noscript code.

“Description“: A description of the variable, to clarify the variable’s name (e.g. “Page template” can be the description of the variable named “env_template”).

“Detailed description“: A detailed description of the variable, to further clarify the variable’s name (e.g. “possible values: homepage/category/product/funnel_confirmation” can be the detailed description of the “env_template” variable).

Once the variable is added, it will appear on the variables list:

Categorizing external variables

Variables can be categorized for easier management.

Categories allow you to classify variables according to their application (e.g. variables relative to site users in the “Users” category, variables for product pages in the “Product page” category, generic cross-functional variables for the site in the “Environment” category, etc.)

Categories are managed by clicking the “manage categories” button to the left of the “ADD VARIABLE” button:

Managing variable types

The variable “type” (also called “processing function“) allows you to modify the variable format on the fly when mapping your tags.

They are useful when one of your solutions requires a variable format that is different from the format used in the external variables by the technical teams in charge of implementing the data layer.

For example, if your “page_name” variable contains special characters in the source code, the processing functions allow you to correct them so that your solutions can receive the value without special characters.

The most commonly used types are:

Order amount: this allows you to modify the number format (amount) on the fly.

You can change separating commas into periods (e.g. “12,50” becomes “12.50”), choose the number of decimal places to retain (e.g. “12.50 becomes “12.5”), or convert the amount into pennies (“12.50 becomes “1250”).

Alphanumeric & Special chars: this allows you to modify the character string format on the fly.

You can replace special characters with “_” (e.g. “the company&its values” changes to “the company_its values”) or truncate a character string (e.g. limiting the variable’s value to 10 characters).

Once you have mapped your variable, click the link symbol:

Advanced : 2-dimensional array

This type can be assigned to variables having a two-dimensional array as a value. On an ecommerce site, this will deal very often with “list_product” and “order_product” variables that return, respectively, information on products displayed on a category page or added to the cart.

We speak of “two-dimensional arrays” since these variables return an array of values for each product (e.g. for all the products on the site’s page, their ID, name, price, quantity, etc.).

Certain partner solutions may request that you send product data in their tag that are separated by a character called a “separator” (e.g. all product IDs separated by “|“, or all product prices separated by a comma in their confirmation tag).

The operation will be much easier if you select the “Two-dimensional array” processing function for your “order_product” variable.

You will then be able to send your partners the information they expect without requiring any knowledge of JavaScript.

The first step in the configuration process is to select the “Two-dimensional array” type (1) for your variable:

Once this type is added, click on the “List” icon that appears next to your variable to see a summary of the external variables:

Enter all your array keys in the window that appears (e.g. if your main variable is “list_products”, the keys will be characteristics of your products, i.e. the ID, name, price, etc.):

After selecting the “Two-dimensional array” type for your variable go to the “EDIT” step. Click the symbol appearing to the left of the variable that you just mapped:

Enter the array key in the configuration window (e.g. the product ID) and the separator:

Editing and deleting external variables

You can edit an external variable by clicking the “Edit” icon and delete it by clicking the trash can. The flag next to the variable’s name will tell you if it is mapped and the tag(s) it is mapped with:

Note: The variables used in a container (to be added to a tag, for example) cannot be deleted, and their names cannot be modified.

By clicking on the flag, you will see which container(s), tag(s) or rule(s) use this variable:

<script type="text/javascript">
var tc_vars = new Array();
tc_vars["env_work"] = 'Prod';
tc_vars["env_channel"] = 'Web';
tc_vars["env_language"] = 'fr';
tc_vars["env_country"] = 'FR';
tc_vars['page_type'] = 'Homepage';
tc_vars["page_name"] = 'Tag Commander Market';
tc_vars["page_category_1"] = '';
tc_vars["page_category_2"] = '';
tc_vars["page_category_3"] = '';
</script>

/* Data layer is setup - call the Web Container Script underneath */

<script type="text/javascript" src="//cdn.tagcommander.com/674/my_web_container.js"></script>

Deduplication

Deduplication is the conditional activation on the confirmation page of a website, of the tag(s) responsible for the conversion.

This activation is possible by capturing and reading the parameters of your tracking URLs through TagCommander.

Within our interface, tags can be deduplicated with configurable rules depending on their position throughout the customer journey: at the beginning, at the end, or anywhere.

For example, if before converting on your site a user saw and clicked a banner served by your retargeting partner, you can set up a rule to call only that partner’s confirmation tag on the confirmation page.

The deduplication module in Commanders Act is included in your Commanders Act offer.

It allows you to create rules to fire confirmation tags (mostly but not only) based on:

A digital marketing channel (SEM, Display, Retargeting, Affiliation, etc).
A traffic source linked to that channel (digital marketing solutions such as Criteo, Netaffiliation, Marin, Tradedoubler, etc).
The position of the touchpoint throughout the customer journey.
Whether a click or impression – or both – are involved.

Note: Channel and source information is read and captured from the parameters in your tracking URLs if you use our “Commanders Act TMS” product only. However, if you have subscribed to other options of our platform (like “Enrichment”), you can use Commanders Act redirects, in which case there would be no URL parameter capture.

There are many benefits from activating the deduplication module:

Preserving information confidentiality: by activating solely the tag of the partner responsible for a conversion, you limit information leakage about your sales, leads, order amounts, among others, to all your providers, and communicate only what pertains to a specific conversion generated by a specific solution to that very partner.
Saving time: Commanders Act’s deduplication module allocates conversions to partners in real time, helping you save time and not having to allocate conversions manually afterwards from information obtained through reports generated by your analytics tools and your partners.

Report analysis

To access the reports,

Dashboard

The “Dashboard” report provides an overview of tags’ performance on your site:

You will find below a detailed explanation of the report’s analysis windows.

1)-The three main indicators (Start Render, DOM Ready, DOM Loaded):

Average Start Render (First Paint): average loading time on site of the Start Render event.
Average DOM Ready: average loading time on site of the DOM Ready event.
Average Page loading time (on load): average loading time on site of the DOM Loaded event.

Note: These three metrics consider the following filters “page type”, “container”, “device”, “OS” or “browser”.

Example: These three pages are loaded on your site:

The three metrics would take the following values:

“Average Start Render (First Paint)”: 5 sec (700ms, 500ms and 300ms on average)
“Average DOM Ready”: 8 sec (2000ms, 2200ms and 1100ms on average)
“Average Page loading time (on load)”: 6 sec (2800ms, 2800ms and 2100ms on average)

2)-The Pie Chart:

The pie chart highlights tags that take longer to load in terms of the selected level of analysis in the available filters: Start Render, DOM Ready, DOM Loaded or Cumulated loading time.

Example: the pie chart above appears once the “Tags impacting start render (First Paint)” level of analysis is selected. It shows that the “Lengow lead validation” tag is the tag that delays the most the Start Render event, because it takes about 17% of total time preceding the Start Render event.

By clicking the “Others” part, you will be able to obtain more details about the remaining tags affecting your site’s loading time.

Note: the pie chart that appears next provides the proportion of each tag in relation with the “Other”’s total.

Example: Here below, the “Effiliation” tag takes about 14% of the “Other”’s total loading time (14% of the 21% of global loading time, which “Others” account for).

3)-Main Tag Variations:

The “Main Tag Variations” graphs allow you to identify tags whose loading time has varied (+/-10%) over a selected period of time in terms of the selected level of analysis in the available filters: Start Render, DOM Ready, DOM Loaded or Cummulated loading time.

The tag’s variation measures gaps in tags’ loading times in relation with the median (and not the average, in order for it to be less sensitive to extreme values). Calculation is based on the six previous identical periods.

Example:

We wish to analyze the variation of tags affecting the Start Render event on May 22nd.

In the screenshot below, we can see a 65% increase in AB Tasty’s loading time for that day. The tag does indeed take 61.96ms to load, whereas the median for the six previous days was of 37.65ms. (May 16th: 48.05ms /May 17th: 30.30ms / May 18th: 35.77ms / May 19th: 27.44ms / May 20th: 64.11 ms / May 21st: 39.53ms).

4)-Main Page Type Variations:

The “Main Page Type Variations” graphs allow you to identify the page types whose loading time has varied (+/-10%) over a selected period of time in terms of the DOM Loaded event only (the page’s loading time is defined with the arrival of the DOM Loaded event).

Note: The page type corresponds to the default “page type” filter available on the interface.

The page type variation measures gaps in pages’ loading times depending on their type and in relation with the median (and not the average). Calculation is based on the six previous identical periods.

Example:

We wish to analyze variations in types on May 2nd.

In the screenshot below, we see a 31% reduction in loading times for the “newsletter” page type on that day. It takes 5.23ms to load whereas the median in the six preceding days was of 7.6ms (April 26th: 7.58 ms / April 27th: 5.31 ms / April 28th: 8.16 ms /April 29th: 7.62 ms / April 30th: 7.84 ms / May 1st: 6.02 ms).

Report by tag

1)-The four main metrics

Average page loading time: average loading time of your website’s pages (= DOM Loaded). This loading time is compared to that of the previous period (ex: the previous day or week according to the selected period).
Average tag loading time: average loading time of the tags on your website according to the level of analysis that you selected in the filtering options (Start Render, DOM Ready, DOM Loaded, Cumulated loading time). This loading time is compared to that of the previous period (ex: the previous day or week according to the selected period).
Lowest impact tag: tag that takes the least time to load according to the level of analysis that you selected in the filtering options (Start Render, DOM Ready, DOM Loaded, Cumulated loading time).
Highest impact tag: tag that takes the most time to load according to the level of analysis that you selected in the filtering options (Start Render, DOM Ready, DOM Loaded, Cumulated loading time).

Note: These four metrics consider the selected filters among “page type”, “container”, “device”, “OS” or “browser”.

2)-TagPerformance by tags

The graph shows information about tags’ loading time on your website.

To select tags to analyze with the graph (1), check the corresponding tag in the “Tags” report (2) and reload (3).

You can compare this data to generic information about the page’s context. To do so, select the indicators you are interested in from the dropdown menu above the graph.

Metrics related to the analyzed tags:

Tag Loading time: tags’ loading time according to the level of analysis that you selected in the filtering options (Start Render, DOM Ready, DOM Loaded, Cumulated loading time).
Tag firing: number of times tags are loaded on the site (this metric is independent from the filters).

Metrics related to the page’s context:

Tag number: number of tags present in the last generated version(s) of a container.
Average start render (First paint): average loading time of the tart Render on the site.
Average page structure building (DOM Ready): average loading time of the DOM Ready on the site.
Average page loading time (OnLoad): average loading time of the DOM Loaded on the site.

Note: These six metrics consider the selected filters among “page type”, “container”, “device”, “OS” or “browser”.

Example:

You wish to know if a tag loading during the Start Render event has an impact on the site’s global Start Render.

Use the “Tags impacting Start Render (First Paint)” filter on your report:

Select the tag to analyze:
Select the following metrics from your graph: “Tag Loading Time” (the tag’s loading time) and “Average Start Render (First Paint)” (average loading time of the Start Render):

The result below shows that the selected tag has little impact on the site’s Start Render, as the increase in the tag’s loading time at 13h (1) did not cause the Start Render’s average loading time to increase as well at that very moment.

3)-Tags

The “Tags” section of the report provides deeper insight about the tags that are loaded on your site, according to the level of analysis you selected from the filters on the top left-hand side (Start Render, DOM Ready, DOM Loaded, Cumulated loading time) and top right-hand side of the page (“page type”, “container”, “device”, “OS” and “browser”).

You can analyze the following elements for each tag:

“Tag loading time” (ms): Loading time in milliseconds
“Tag firing”: Number of times a tag is loaded

If you click a tag’s name, a graph appears showing these items:

The tag’s loading time compared to the previous period (ex: previous day if the analysis is done by day).
The tags’ average loading time compared to the previous period.
The number of times a tag is loaded compared to the previous period (ex: previous day if the analysis is done by day).
The number of times tags are loaded on the site compared to the previous period.

Note: The current period is always displayed in green and the period of comparison in blue.

Piggybacking

“Piggybacking”, consisting in triggering a tag with another, has widespread exponentially with the appearance of programmatic. The subsequent data leakage has generated legal issues and financial losses for companies.

Amid this context, the “Tag Hierarchy” report provides a global insight of requests happening while your website and its content load. You can thus better control calls issued from your website and exchanged data.

Report Structure:

1/Page type filter:

This report is filtered by page type (“page_type” option on the segmentation menu). The default selected page type is the first one appearing on the list (1) and is displayed on the top, left-hand side of the report (2):

You can at all times apply filters on different page types or deselect enabled filters to have an overview of your site (please note that in this case, the report might take a little longer to load, as it will combine all domains called on your website).

2/Request type (script/iframe/pixel)

Script (URL called with <script> tag)
Iframe (URL called with an <iframe> tag)
Pixel (URL called with an <img> tag)
“Other” (in case the request type is not identified)

3/Request Detail

The “Tag Hierarchy” report allows you to visualize all domains called from your main domain and all other domains they call on different levels:

On the diagram above, sub-domain 2 (“sub-domain 2”) is called from your site’s main domain. It is a JavaScript file (blue circle) that in turn calls two pixels (green circles) and a JavaScript file. Waterfall calls stop here for this request, but this is not the case for sub- domain 1 (“Sub-domain 1”), which calls JavaScript files which in turn issue new requests.

In order to provide you with better readability, same-type “childless” requests (script/iframe/pixel) coming from the same domain are gathered under the same domain name, and a number between brackets next to the domain’s name indicates how many calls were issued from it:

You will also be able to see the URL structure and its parameters for certain requests, hence all the information sent to solutions called on your website:

4/Report dates

Displayed data is collected over the past 24 rolling hours.

This export is currently unavailable.

Filters

1)-Select your level of analysis:

“Tags impacting start render (First Paint)”: This corresponds to the aggregated loading time of hits that are sent prior to the Start Render event.
“Tags impacting page structure building (DomReady)”: This corresponds to the aggregated loading time of hits that are sent prior to the DOM Ready event.
“Tags impacting page loading time (Onload)”: This corresponds to the aggregated loading time of hits that are sent before the DOM Loaded event.
“Cumulated tag loading time”: corresponds to the aggregated loading time of all hits (including those sent after the DOM Loaded event).

Example: The following diagram shows an extract of tags present on the site:

These are the results you will obtain when you select the following levels of analysis:

“Tags impacting start render (First Paint)”: TAG1 (HIT1) + TAG2 (HIT1)
“Tags impacting page structure building (DomReady)”: TAG1 (HIT1) + TAG2 (HIT1) + TAG1 (HIT2) + TAG1 (HIT3)
“Tags impacting page loading time (Onload)”: TAG1 (HIT1) + TAG2 (HIT1) + TAG1 (HIT2) + TAG1 (HIT3) + TAG2 (HIT2)
“Cumulated tag loading time”: TAG1 (HIT1) + TAG2 (HIT1) + TAG1 (HIT2) + TAG1 (HIT3) + TAG2 (HIT2) + TAG1 (HIT4)

If you wish to know more about the “Start Render”, “DOM Ready” and “DOM Loaded” concepts please refer to the Definition of TagPerformance Metrics article.

If you wish to know more about the technical elements that are captured by TagPerformance, please refer to the Advanced: Technical functioning of TagPerformance article.

2)-Select, if need be, one of the default filters from the interface should you require a more detailed analysis of your site’s performance.

The page type: This filter allows you to display your tags’ performance in terms of the page template. It is based on the “env_template” variable’s values, which are automatically captured by TagPerformance.

Note: If you do not have an env_template variable on your site, you still can capture the values of other variables. Please refer to the Adding the TagPerformance Tag article.

The container name: This filter allows you to display how tags within one or more specific containers are performing.
The device: This filter allows you to display your tags’ performance in terms of the devices your visitors are using. The “device” metric is calculated automatically by our servers, based on the user agent.
OS: This filter allows you to display your tags’ performance in terms of the devices your visitors are using. The “OS” metric is calculated automatically by our servers based on the user agent.
The Bowser: This filter allows you to display your tags’ performance in terms of the browsers your visitors are using. The “browser” metric is calculated automatically by our servers based on the user agent.

Note: if you wish to add an additional filter, please refer to the Adding the TagPerformance Tag article.

3)-Click “Apply” to obtain filtered results and a different level of analysis.

Setup example

Defining channels and sources

You work with Retargeting solutions and your tracking URLs look like:

mysite.com?utm_medium=RETARGETING&utm_source=Criteo
mysite.com?utm_medium=RETARGETING&utm_source=MyThings

Where the utm_medium parameter stores the channel and utm_source stores the source (namely your partners).

In order to fire only the tag of the partner to whom the sale is attributed, you would need to follow these steps:

Defining Channels and Sources

Adding a Channel: click “Add Channel”

Name the channel and add the parameter that will store the value defining Retargeting (Add Condition)

Define the condition (Parameter Match or Not and the comparison value) and specify whether or not the value of the parameter containing the source will be captured (pencil icon).

Select the capture mode of the parameter containing the source (the whole value, or parts of it), then confirm the channel identification condition by clicking ADD.

Save the source-capturing settings and save the Channel configuration (Click “SAVE”).

Setting up deduplication rules

Now that you have defined the retargeting channel, you can define firing rules for your retargeting tags Criteo and MyThings.

Click the edition tab and go to the Rules step. Once there, click “Deduplication” on the menu to the left.

In the new window, click “ADD DEDUPLICATION RULE” to open the rule configuration window.

When the window opens, select the Criteo OneTag Conversion tag from the dropdown menu (3).

Select “Last” among the options relating to the touch point’s position in the customer journey. This will fire the tag if it is the last paid solution in the customer journey, now you need to define if it is the last paid click, impression or both (4).

Let’s say you want to launch the Criteo OneTag Conversion tag only if it is the last paid click. Select “click” from the options (5).

Select whether it corresponds or not to your channel (6).

Select “RETARGETING” from the dropdown menu. All channels that you have defined will become available in this menu (7).

Select “EQUALS” for the source. When you configured the channel you indicated that the source of traffic (partner) would be captured by “taking all” the value of the “utm_source” URL parameter. Since your tracking URL for Criteo looks like this:

www.mysite.com?utm_medium=RETARGETING&utm_source=Criteo

You will need to select “EQUALS”.

Enter the value of the parameter that will be compared to what was set in the interface (“Criteo”) (9)

Click “ADD” to add the rule (10).

Repeat these steps for your MyThings Conversion tag.

When both your rules are created, they will appear in the rule summary.

If your wish to edit any of them, click the pencil icon to the right on the line of each rule. If you wish to delete it, click the trash can.

The rules summary interface has a Deduplication column. A check mark will indicate that your two tags are deduplicated.

Deduplication reports

Report by conversion

The “Report by Conversion” report provides information pertaining to the tags that were called for every conversion on your site, according to the rules you defined in the rules section, more specifically deduplication rules. Data is collected by the “Commanders Act – Reporting Deduplication v1.2” tag.

Access

To access the report, please click the “Deduplication by conversions” entry from the Health > Website Monitoring menu.

Interface Description

Calendar

The calendar allows you to select a period of time to display deduplicated tag calls. There are eight predefined periods (Yesterday, Last Week, Last 30 days, Last Month, Last Quarter, Month-to-Date, Quarter-to-Date, Year-To-Date) and you can customize the period you wish to see tag calls for. You also have the possibility to compare periods to have a clearer vision of the way tags’ performance has evolved from one period to another.

“Report by Conversion” Table

This table displays the number of tag calls for every conversion:

“Conversion ID”column: displays your conversions’ IDs.
“Date”column: displays a conversions’ time and date.
“Revenue”column: displays the conversions’ amounts (including or excluding taxes, depending on the amount you chose to collect with the “Commanders Act – Reporting Deduplication v1.2” tag).
“Tags” column: lists all tags that were called per conversion. Rules affecting tags are all considered, especially deduplication rules.
“Detail”column: it displays a popin with the detailed customer journey per conversion. The popin is made of four columns.

Position: displays, in descending order, the position of every touch point within the customer journey associated to the conversion.
Type: displays the touchpoint’s type (click or impression).
Channel/Source: displays the channel (lever) and source (solution) corresponding to every touch point.
Date: displays every touch point’s time and date.

The search engine above the table allows you to easily and quickly find a conversion simply by typing its ID.

The “Advanced Filtering” button lets you filter results by tag to find a conversion faster.

Exporting the “Report by Conversion” table

The “export” icon on top of the table allows you to export the “Report by Conversion” report:

If you click “CSV” you will receive the CSV report directly in your mailbox.
If you click “Email”, you will be able to enter the email addresses of people you wish to send the CSV report to.

Report by tag

The “Report by Tag” report allows you to see, over a specific period of time, the number and evolution of calls to the tags that were placed on your confirmation page(s), more specifically those of deduplicated tags. Data is collected by the “Commanders Act – Reporting Deduplication v1.2” tag.

Access

To access the report, please click the “Deduplication by tags” entry from the Health > Website Monitoring menu.

Interface Description

Calendar

“Tag calls’ evolution” graph

The “Tag calls’ evolution” graph displays calls to the tags checked in the “Tag Calls Detailed” table. If you wish to display data for other tags, simply check the corresponding box and click the table’s refresh icon. A curve with a specific color is associated to every tag. When you click the tag’s name in the graph’s legend, the curve corresponding to the tag whose name you clicked will disappear or reappear.

The arrow in the graph’s upper right-hand corner allows you to unfold or collapse the latter.

The button in the graph’s bottom right-hand corner lets you see calls to deduplicated tags on a daily or weekly basis.

“Tag Calls Detailed” table

Tags listed in the “Tag Calls Detailed” table are tags placed on pages where the “Commanders Act – Reporting Deduplication v1.2” tag was included too.

The table displays the number of calls that were issued:

The “Conversions” column indicates the number of times a tag was called over a given period of time. This number considers deduplication and other rules placed on your tags.
The “Conversion Share” column displays the percentage of conversions a given tag participated in, according to the exact same rules as those considered in the “Conversions”
The “Detail” column allows you to see the IDs of conversions a tag was called for, as well as the corresponding time, date and amount (including or excluding taxes, depending on the amount you chose to collect with the “Commanders Act –Reporting Deduplication v1.2” tag.

TagPerformance

A Website’s performance is key to SEO and user experience; however, the increasing amount of tags used on websites nowadays has an impact on loading times.

In this context, tags’ performance has become a strategic matter.

Commanders Act's “TagPerformance” module offers the possibility to measure your site’s performance based on the tags that are placed on it. It acts as a complementary tool to those used by IT departments to measure loading times of websites’ key elements (images, CSS …)

TagPerformance’s main features include:

A measuring tag executed on the end client’s browser and not by a robot.
Analysis of the START RENDER, DOM READY and DOM LOADED events to measure performance.
The possibility to visualize significant variations in tags and page types, free from the noise resulting from the analysis of micro-variations.
Information on loading times of partner solutions in relation with the average loading times of other solutions to ensure loading times are correct.
Data segmentation to identify sources of problems, if any, or to focus on a particular segment: container, page type (product, home page), device (mobile, tablet, PC), OS and browser.

TagPerformance is one of the additional modules for the Commanders Act product: if you wish to use it on your website(s), please contact your account manager or reach out to our Support Department (support@commandersact.com)

Metrics

TagPerformance allows you to analyze three events:

START RENDER or FIRST PAINT: This is when the first element is displayed on the page.

This metric is key to bounce rates (if initial visual elements take too long to load, users will most often leave a site) and SEO (“dwell time” metric).

DOM READY: this is when a page’s structure is loaded and analyzed by the browser.
PAGE LOADING TIME or ONLOAD or DOM LOADED: this is when the page’s content has finished loading. This metric is useful for SEO.

Loading order of a web page’s elements:

Example:

Page A and page B take both 12ms to load; DOM loaded is the same for both of them. However, Start Render and DOM Ready events are optimized for page A but not for page B.

How it works ?

The page loads with the Commanders Act container.
The Commanders Act container calls the tags placed on the page and loads the “Commanders Act – TagPerformance” tag two seconds after the DOM Loaded event.
The “Commanders Act – TagPerformance” tag captures information provided by the browser thanks to the Navigation Timing API, which is compatible with 88% of existing browsers. The information that is captured includes:
Generic information about the page: Start Render, DOM Ready and DOM Loaded
Information about every tag that is executed on the page: hits’ aggregated loading time before Start Render, DOM Ready and DOM Loaded happen (separately).

Example:

This is the structure of a page from a website:

“Tag 1” sends 4 hits:

One that loads before the Start Render event (300ms)
One that loads before the DOM Ready event at (400ms)
One that starts loading before DOM Ready and finishes loading during the DOM Loaded event (600ms)
One that loads after the DOM Loaded event (100ms)

“Tag” 2 sends 2 hits:

One that loads during the Start Render event (700ms)
One that loads before the DOM Loaded event (200ms)

With the “TagPerformance” tag, Commanders Act will count the following loading times for tag 1:

Hits’ aggregated loading time before the Start Render event (300ms).
Hits’ aggregated loading time before the DOM Ready event: 1300ms (the first and second hit’s respective loading times of 300ms and 400ms are stored and added to the 600ms loading time of hit three, which is sent during the DOM Ready event).
Hits’ aggregated time before the DOM Loaded event: 1300ms (all hits’ loading times are stored: 300ms, 600ms and 600ms for hits one, two and three, respectively).
Total loading time of tag1 (1400ms)

The “TagPerformance” tag will count the following loading times for tag 2:

Hits’ aggregated loading time before the Start Render event (700ms)
Hits’ aggregated loading time before the DOM Ready event (700ms)
Hit’s aggregated loading time before the DOM Loaded event (900ms)
Total loading time of tag1 (900ms)

It will also count generic loading times on the page:

Start Render (700 ms)
DOM Ready (2000 ms)
DOM Loaded (2800 ms)

All this data will populate TagPerformance’s reports.

Setup guide

Prerequisites

Before you begin creating deduplication rules in the interface, you should define the following things and inform your Commanders Act consultant:

The digital marketing channels you wish to include in the configuration of the deduplication interface. Commanders Act allows you to configure natural and paid channels to take into account for the deduplication rules.
The “cookie window” (lookback window) settings you wish to configure for every channel: information on the channels that drove a user to your site are stored in a cookie whose lifetime usually is of 30 days. You can, for example, set it to 15 days for channel A and 30 days for channel B.

Setting deduplication rules is a two-step procedure:

Defining and configuring channel and sources recognition in the interface.
Applying deduplication and other rules to activate tags according to your needs.

/!\ If you wish to track impressions, you need to make sure a Commanders Act subdomain has been created for you and have your account manager confirm that the feature is enabled. Please note that setting up the subdomain and tracking impressions with our pixel is a paid service.

Defining channels and sources

Go in the menu "Data Management" > "Web Datalayer" > "Deduplication Channels"

The Channel Identification menu will open, then

Click the ADD CHANNEL button.
Your channel will be displayed afterwards in the channels list.

When you click “ADD CHANNEL”, a new window will be displayed to allow you to configure a new paid channel (natural channels are set-up by default).

You can configure channels with one or more “channel” parameters and one or more “source” parameters (or no “source” parameters at all).

Configuring a channel with a single "channel" parameter

In the window that opens after you click “ADD CHANNEL”, enter your new channel’s name (Display, Affiliation, Retargeting, etc) – this is only a label to identify it in the Channel’s list in the interface – and click “ADD CONDITION”.

In the menu that appears (see below)(2), select the parameter that will store the information defining the channel (there are default parameters such as those used by Google Analytics, AT Internet as well as the possibility to add custom parameters)(2).

Select the condition (whether the value of the parameter matches or doesn’t match the value you are about to enter)(3).

Enter the value that will identify the channel (4). /!\ If a parameter’s value is made of more elements than the one you require, you need to use a star (*) to indicate what chunk is to be considered. For example, let’s say you only need “Retargeting” in this parameter: utm_medium=Retargeting-A1B3C3-crt. You need to write “Retargeting*” (values are case sensitive):

Click SAVE (6) at the bottom, right-hand corner of the window.

Configuring a channel with a single "channel" parameter and a "source" parameter

In the window that opens after you click “ADD CHANNEL”, enter your new channel’s name (Display, Affiliation, Retargeting, etc) – this is only a label to identify it in the Channel’s list in the interface – and click “ADD CONDITION”.
In the menu that appears, select the parameter that will store the information defining the channel (there are default parameters such as those used by Google Analytics, AT Internet as well as the possibility to add custom parameters).
Select the condition (whether the value of the parameter matches or doesn’t match the value you are about to enter).
Enter the value that will identify the channel.

/!\ If a parameter’s value is made of more elements than the one you require, you need to use a star (*) to indicate what chunk is to be considered. For example, let’s say you only need “Retargeting” in this parameter:

utm_medium=Retargeting-A1B3C3-crt

You need to write “Retargeting*” (values are case sensitive):

Click ADD on the line of the channel declaration to confirm the creation of the condition.
Click the pencil icon next to “Source: Will not be captured” to modify settings for the source to be captured.
Select the capture method:

Taking all: the entire value of the URL parameter containing the source will be captured. For example, if the parameter in the URL is: “?utm_source=criteo” and you use “Taking all”, all the parameter’s value will be taken. In this case, “criteo”.
Splitting: splits the parameter’s value and takes the block you want. For example, if the parameter in the URL is: “?utm_source=retargeting|criteo|123456&(…)” and you use the setting depicted in the image below, you will obtain “criteo”.
Cutting: cuts a part of the parameter’s value and returns it. For example, if the parameter in the URL is: “?utm_source=criteo&”, you will obtain “cri” with the setting below.

Select the parameter containing the source that will be captured.
Save
Add the channel

This will allow you to have the tag fire depending on the value of the channel AND the value of the source.

Configuring a channel with two or more "channel" parameters and a single "source" parameter

In the window that opens after you click “ADD CHANNEL”, enter your new channel’s name (Display, Affiliation, Retargeting, etc) – this is only a label to identify it in the Channel’s list in the interface – and click “ADD CONDITION”.
In the menu that appears, select the parameter that will store the information defining the channel (there are default parameters such as those used by Google Analytics, AT Internet as well as the possibility to add custom parameters).
Select the condition (whether the value of the parameter matches or doesn’t match the value you are about to enter).
Enter the value that will identify the channel. Repeat these steps for as many possible combinations of parameters/values that could identify a channel. In the example below, if the utm_medium parameter in the URL takes the values “Retargeting”, “rtg”, “RTG”, or “retargeting”, the channel called/labeled “Retargeting” (1) will be recognized.

/!\ If a parameter’s value is made of more elements than the one you require, you need to use a star (*) to indicate what chunk is to be considered. For example, let’s say you only need “Retargeting” in this parameter:

utm_medium=Retargeting-A1B3C3-crt

You need to write “Retargeting*” (values are case sensitive):

You can also create conditions based on the “AND” operator. For example: if the UTM_MEDIUM parameter’s values are “Retargeting” or “rtg” AND the UTM_CONTENT’s parameter’s value is “email”, then, the Retargeting channel will be recognized (see second screenshot below).

If you wish to base your conditions on sources too (B), for every condition defining a channel, you will need to select a source.

When everything is setup, click ADD in the bottom, right-hand corner of the window.

Configuring condition groups with multiple "channel[s]/source[s]" combinations

In order to create groups of conditions combining “blocks” made of multiple channel+source parameters, follow the steps in C) (above), according to your needs. When you have created your first “block”, click the “ADD CONDITION GROUP” button to create a new set of parameters to be configured (1).

In the example below, the Retargeting channel will be recognized by the interface when either of the two conditions* is met.

Note:

You can select the default parameters (below) but also enter custom parameters or use the “Advanced” option to add custom JavaScript.

Example of custom parameter: “gclid” (SEM)

When you connect Google Adwords and Google Analytics, Google allows you to automatically link your two accounts by adding the “gclid” tracking parameter in your URL. This parameter replaces “utm_source = SEM” and indicates that traffic is SEM-originated. You can use a custom parameter to set this up.

When your channels and source-capturing methods are defined, you will return to the channel list and options.

Configuring a channel based on MixCommander Tracking

You just need to write the iD values available on Mixcommander side. For each value you have to declare a channel. For example for the channel AFFILIATION, you have to create as many channels as IDs available on the mapping table ("Affiliation", "aff", "affiliate"). That's why it's very important when you create a campaign to use always the same id. Example : chn=affiliation.

Channel prioritization

You can change the order of paid channels and move them up and down according to the priority you want to give to each one of them. Channels are detected in the exact same order they are listed in the interface and do not exclude each other. So, in the event in which two or more conditions are true, the last condition will be taken into account.

For example, if you have two channels (Email Retargeting and Retargeting) configured as below.

Email Retargeting

Retargeting

The interface will only pay attention to the last condition (if utm_medium = retargeting) and will ignore the rest.

So if you have channels sharing one or more conditions, it is necessary that you place the channels with the least conditions first and those with the most conditions at the bottom of the queue so that all conditions are taken into consideration.

To reorder the channels, please use the handles to the left of the channel’s label.

Cookie Window Configuration

You can change the order of paid channels and move them up and down according to the priority you want to give to each one of them.
Check this box if the channel considers clicks.
Define the lifetime to the cookie storing click information (in number of days).
Check this box if the channel considers views.
Define the lifetime to the cookie storing views information (in number of days).
Define the number of touch points you want to store in the deduplication cookie. You can store no less than ten and no more than 50. The larger the amount of touchpoints, the heavier the cookie’s weight.
Enter the keywords for SEO brand identification, the full word or part of if (you can choose between “contains” or Regex). Declaring keywords is useful to differentiate branded and unbranded SEO in case one of both should be taken into consideration in the deduplication rules. Since some browsers, such as Google, have ceased to provide keywords – this is referred to as “not provided”-, the branded and unbranded SEO distinction is less complete than it used to be.
Add more keywords if necessary.
See the list of your keywords and how they are captured.
Configure your impression tracking pixel’s URL by replacing Channel with one of the channels you created and source with the desired parameter value.

For more information on these fees please contact your account manager. For more information about Commanders Act’s view pixel, please refer to the “Tracking impressions” and “Structure of Commanders Act's impression pixel” articles.

Setting up deduplication rules

When your channels are defined in the interface and you have specified whether the parameter storing the source of traffic will be considered or not to launch a tag, you will need to go to the “RULES” step in the Commanders Act TMS interface.

Set-up your deduplication rules by following these steps:

1.When on the RULES step, click the “Deduplication” button on the menu to the left.

4.Select the touchpoint’s position in the customer journey (beginning, end, anywhere).

First refers to the first touchpoint at the beginning of the customer journey (SEM/Google in the illustration below). A rule based on this position would call Google’s tag on the confirmation page and allocate the conversion to it.
Last refers to the last touchpoint before the conversion, at the end of the customer journey (if we consider paid traffic, it would be RETARGETING/Criteo in the image below, and Direct Access overall). A rule based on this position, would call Criteo’s tag on the confirmation page and allocate the conversion to it.
Any refers to any place throughout the customer journey (in the example below, all paid traffic solutions contributing to the conversion would be called on the confirmation page. That is Google, Tradedoubler and Criteo).

5. Select the nature of the touch point (click, view or both) you wish to include in your conversion attribution rules. For example, if you wish to consider only clicks, check that box and leave the view box unchecked. If you wish to consider them both, you should check both boxes.

6. Select your channel(s) (you must declare them first in the Channel Identification section; you can select more than one channel).

7. Select whether it corresponds or not to your channel.

8.State whether the source is ignored or (if you configured it to be captured in the channel identification interface) not. If not, define if all or only a part of it will be captured and if it has to match or not a certain value.

9.Enter the value of the parameter that will be compared to what was set in the interface, during the channel identification step, when you chose to capture the source.

10. Click “ADD” to add the rule.

After you create your rules, they will appear in the rules summary.

If your wish to edit a rule, click the pencil icon to the right on the line of each rule. If you wish to delete it, click the trash can.

The rules summary interface has a Deduplication column. A check mark will indicate what tags are deduplicated.

Adding tags necessary to the proper operation of the deduplication module

In order to enable the deduplication module, you will need to place the “Commanders Act – Get dedup cookie” and “Commanders Act– Reporting Deduplication v1.2” tags inside your container.

The “Commanders Act – Reporting Deduplication v1.2” tag

You will then need to go to the tag library and add the tag to the container you placed in the confirmation page(s).

In the “Edit” section, map the “Commanders Act – Reporting Deduplication v1.2” tag with the corresponding variables from your data layer:

#TCIDORDER# (mandatory field) must be mapped with the data layer variable that collects the conversion ID (ex: tc_vars[“order_id”]).
#TCAMOUNTORDER# (optional field) must be mapped with the data layer variable that collects the conversion amount (ex: tc_vars[“order_amount”]). Whether you collect the order amounts excluding taxes or all taxes included is your choice.

In the “Rules” section, add a condition to your “Commanders Act – Reporting Deduplication v1.2” tag to call it only on your website’s confirmation page(s) (“confirmation page” perimeter).

The “Commanders Act – Get dedup cookie” tag

Important note: Before adding this tag, you need to make sure that a “commander1.com” subdomain has been added to your account from the “Admin”>”Domain management” interface (only administrators have access to this area). If the subdomain has not yet been created, please contact our support department (support@commandersact.com).

The “Commanders Act – Get dedup cookie” tag lets you retrieve all the touch points from a user’s customer journey. These touch points are collected on the “commander1.com” subdomain that is associated to your account. This tag is indispensable if you track impressions for your deduplication rules.

Go to the tag library and add the tag to the container you placed in the confirmation page(s).

In the “Rules” section, add a condition to your “Commanders Act– Get dedup cookie” tag to call it on all but the conversion page among the conversion funnel pages. This will allow you to retrieve all information stored in the “commander1.com” subdomain (especially impressions) when a user engages in the purchase process. Your tags will thus be called depending on the user touch points that are identified.

Setup guide

The TagPerformance tag must be included in each and every one of your containers.

If you have many containers on a given page and as many TagPerformance tags, only one hit containing information about your tags will be sent.

It is not necessary to place it in a particular order within your containers, as it will automatically execute two seconds after the DOM Loaded event, that is to say, after all the other tags have loaded.

In the tag library, select the “Commanders Act – TagPerformance” tag.
There is nothing to configure in the “EDIT” step: Generate a new container version and deploy it.

Advanced – Customizing the “TagPerformance” tag:

It is possible to force-measure a tag’s performance (for example, that of a tag outside the container, that of a custom tag whose URL paths are not recognized by Commanders Act or that of a tag that is not present in the Commanders Act TMS tag library). If you wish to measure a new tag’s performance, place the following code block in the commented line 4 (1) tC.tagPerf.customPatterns.push({label:’Solution A’,p:’domain\.com.*js\.js’})

Example:

tC.tagPerf.customPatterns.push({label:’exelate’,p:’loadm.exelator.com’});

You can also add additional filters (in addition to default filters page type, container, device, OS and browser). If you wish to add a custom filter, place the following code block in the commented line: tc_vars[“custom_segment”] = #custom_segment#;

Note: You can only add one additional filter.

Example: to add a “page category” filter (tc_vars[“page_cat1”]) :

tc_vars[“custom_segment”] = tc_vars[“page_cat1”];

Finally, you can change the capturing method of the “Page Type” filter, which is available in the reports. This filter is based on the tc_vars[“env_template”] variable by default. If this variable is not available on your site, you can rely on a different variable by adding the following code block in the commented line (4) tc_vars[“env_template”] = #page_type#;

Example: if you wish to replace tc_vars[“env_template”] with tc_vars[“page_type”] :

tc_vars[“env_template”] = tc_vars[“page_type”] ;

SPA implementation guide

1. What is an SPA environment?

An SPA (Single Page Application) is a website or a web application that loads elements dynamically according to user actions rather than loading new pages after every interaction. Commanders Act web container offers functions allowing you to load all or a part of the container within an SPA environment, allowing you to call desired tags on every action performed by a user. These functions need to be implemented in your site’s source code by either your technical partner or by your own technical staff.

2.How to implement Commanders Act web container in an SPA environment?

2.1 Loading containers

Commanders Act web containers are loaded once upon page load within a Single Page Application Environment. In order to reload containers on user actions, you can use the following features:

tC.container.reload() : this function allows you to reload all the containers on a page. Elements shared by containers (deduplication calculation, external variables initialization, internal variables calculation, calculation of cookies dropped with data storage and the initialization of the Privacy cookie) are only loaded once to optimize performance.

tC.container.reload({ exclusions: ["datastorage","deduplication","internalvars","privacy"], events: {label1: [{targeted_element},{event_variables}], label2: [{},{}]}})

This function allows to reload all of a page’s containers while excluding some of their elements. Elements to exclude need to be mentioned in the “exclusions” table. Ex: if you wish to reload the container without recalculating internal variables, you need to call this function: tC.container.reload({exclusions:["internalvars"]}) This function also allows to call the tC.event function that loads selected tags upon user action. The tC.event function is executed after the container elements reloading. label: specify the name you wish to call your function (ex : "click", "add_to_cart"…). targeted_element: DOM elements on which the event applies. {} if not necessary. event_variables: variables specific to the event. {} if not necessary.Ex:

tC.container.reload({events: {label1: [{target: document.getElementById('targeted_element'}, {"page_name":"", "product_id":""}]}})

tC.container_IDS_IDC.reload() : this function allows loading a single container (to do so, you will have to specify the site’s and the container’s ID) on a page that contains more than one.

IDS : Commanders Act site ID IDC : Commanders Act container ID

tC.container_IDS_IDC.reload({ exclusions: ["datastorage","deduplication","internalvars","privacy"], events: {label1: [{targeted_element},{event_variables}], label2: [{},{}]} })

This function allows loading a single container (to do so, you will have to specify the site’s and the container’s ID) on a page that contains more than one while excluding some of their elements. Elements to exclude need to be mentioned in the “exclusions” table, and event functions need to be mentioned in the “events” object, as for the tC.container.reload({exclusions:["datastorage","deduplication","internalvars","privacy"]}) function.

2.2 Loading tags

To load selected tags upon user action, you will need to implement this function:

tC.event.label() : this function allows loading selected tags upon user action.

label: specify the name you wish to call your function. Ex: implement the tC.event.step2_basket function if your wish to call specific tags on the 2nd step in the purchase cart. You can also set-up a “generic” function like tC.event.all on all of your virtual pages to call tags on all of your SPA sites (Analytics tags, for instance). You will then use perimeters and constraints from the Commanders Act interface to control other tags’ execution.

tC.event.label(this, {"page_name":"", "product_id":""}) : this function allows loading selected tags based on user action and to define variables specific to said action (ex : the name of a virtual page, a specific product id …).

2.3 Going further: Structure of a Commanders Act web Ccontainer

You will find below a list of all the elements that load inside the Commanders Act web container upon first load, as well as the tC.container.reload,(tC.container_IDS_IDC.reload()) and tC.event.XXX() functions that are called.

Container element

Definition

1st container load

tC.container.rel oad() function

tC.container_IDS_IDC.reload() function

tC.event.XXX() function

Deduplication functions

They identify thevisitor’s traffic source

yes

Yes (once loaded)

yes

External variables initialization

They define all external variables that do not already exist

yes

Dynamic JS 1

Calls an external JavaScript file prior to the internal variables’ declaration

yes

Static JS 1

Calls custom JavaScript code prior to the internal variables’ declaration

yes

Internal variables

Calculates internal variables

yes

Dynamic JS 2

Calls an external JavaScript file after the external variables’ declaration

yes

Static JS 2

Calls an external JavaScript file after the internal variables’ declaration

yes

Data storage

Calculates the value of cookies created with the "data storage" module

yes

"Container loaded" & "DOM ready" & "Clicks"& "Form submission " & "Scroll" tags + rules

Executes tags called on the "Container loaded", "DOMready", "Clicks","Form submission" and"Scroll" triggers, as well as on the rules associated to the

yes

container’s first load.

"Custom" tags + rules

Executes tags called on the "Custom"triggers, as well as on the rules associated to the container’s loading or reloading.

yes

Events + rules

Executes events triggered on the previous tc_events function

yes

Privacy

Re-initializes the Privacy cookie to take into account users’ choices.

yes

Tag Hierarchy

Identifies piggybacked tags (tags sideloaded by other tags in the"TagPerformanc e" module)

yes

Event listener

Reloads event listeners (which allow to track actions performed by any userbrowsing the site (clicks, scrolls …))

yes

Datalayer setup

A Commanders Act Data Layer is a JavaScript object that holds metadata of a website as properties to make it available to Tags. In the platform this Data Layer is named "External Variables" to distinguish it from scripted "Internal Variables" that are generated within the Container JavaScript.

Installation

Re-using an Existing Data Layer

In case a website already has a Data Layer installed it is possible to transform it into a Commanders Act Data Layer. Please contact a Commanders Act consultant to implement the transformation.

The approach to fill the Data Layer with properties depends on the technology framework that is used on the website and can reach from JavaScript web scraping to templating to hardcoding.

<script>
    window.tc_vars = {
        env_template: "homepage",
        env_work: "prod",
        page_name: "Homepage",
        page_keywords: ["homepage", "home", "entrypage", "index"],
        product_name: "",
        (…)
    };

    window.tc_vars.user_name = "myuser";
</script>
<script src="{{ container_URL }}"></script>

The Data Layer needs to be filled with information before the Web Container file is loaded—otherwise information might not be available at the time the Container JavaScript executes.

Race Conditions

Race conditions between the Data Layer properties and the Container JavaScript can be difficult to identify and debug by Commanders Act users. It is therefore important to avoid them during installation!

In case multiple Containers are used on the same page it is possible to fill the Data Layer in multiple steps. Global information like the page type should be made available before the first Container is loaded. Information that is only relevant for a certain Container (e.g. product information) can be appended prior to the respective Container.

Following example outlines how a Data Layer can be installed in case both a <head> and a <body> Container are used on a website.

<!DOCTYPE html>
<html>
    <head>
        <meta charset="UTF-8">
        <script>
            window.tc_vars = Object.assign({}, window.tc_vars, {
                env_template: "homepage",
                env_work: "prod"
            });
        </script>
        <script src="{{ head_container_URL }}"></script>
        (…)
    <head>
    <body>
        (…)
        <script>
            window.tc_vars = Object.assign({}, window.tc_vars, {
                page_name: "Homepage",
                page_keywords: ["homepage", "home", "entrypage", "index"]
            });
        </script>
        <script src="{{ body_container_URL }}"></script>
    </body>
</html>

Data Layer Naming Convention

As outlined in the example above the properties of the Data Layer are usually grouped with a prefix notation. E.g. env_ is used to group environment information and user_ is used to group user information.

In case a property is not relevant for a certain page (e.g. product_name on the privacy policy page) it is recommended to fill it with an empty value (e.g. "", 0, [] or {}).

Testing

Via JavaScript Console

It is possible to investigate the Data Layer in the JavaScript console by logging tc_vars.

Following you will find an example output of a tc_vars Data Layer in the JavaScript Console.

{
    env_template: "homepage",
    env_work: "prod",
    page_name: "Homepage",
    page_keywords: ["homepage", "home", "entrypage", "index"],
    product_name: "",
    (…)
}

Via Quality Assurance Tag

The Tag template Commanders Act - Data Layer QA in the Commanders Act Tag library automatically outputs Data Layer information to the JavaScript console on each page. This approach has the advantage that it logs a snapshot of the Data Layer at the exact time the Container JavaScript was executed. This allows to identify race conditions between the Data Layer properties and the Container JavaScript to make sure all necessary properties are available in time.

Browser-side events setup

Commanders Act Events Triggers are onsite events that are used by Commanders Act users to dynamically execute Tags.

Definitions

Metric

Description

Trigger Label

Label for an event that is used by Commanders Act users to execute Tags. e.g. add_to_basket

Trigger Data Layer

A JavaScript object that can be accessed by Tags that are executed on the related Trigger. e.g. product_id

Installation

To install a custom Trigger on the website it is necessary to call a JavaScript function with the following pattern:

tC.event.{{ Trigger Label }}(this, {{ Trigger Data Layer }});

A typical example is an Add to basket event where the product id of the selected product is sent with the event:

tC.event.add_to_basket(this, { product_id: "12345" });

Trigger Data Layer Properties

A common approach for the Trigger Data Layer is to always use the same properties like event_label, event_type and event_value—so in case of an add_to_basket Trigger the event_value would hold the product id of the selected product and in case of a video_play event the event_value would hold the current position within the video timeline. This allows to avoid to create multiple custom variable names for each individual event and therefore makes Trigger more generic.

Trigger Error Handling

In some situations it might happen, that a user interacts with a custom Trigger before the Commanders Act Web Container file was loaded. In this case using the Trigger function would cause a JavaScript ReferenceError. Therefore it is recommended to check the availability of the Trigger function before using it.

if (tC && tC.event && typeof tC.event.add_to_basket === "function") {
    tC.event.add_to_basket(this, { product_id: "12345" });
}

Testing

Via Quality Assurance Tag

The Tag template Commanders Act - Event QA in the Commanders Act Tag library automatically outputs event Data Layer information to the JavaScript console when executed. Assigning this Tag with the Trigger allows to log a snapshot of the Data Layer when the respective Trigger is executed. Another way, more technical: you can type in your console tc_arrray_events when the event is executed. The Data Layer of the event variables will be displayed.

APIs

GET Tags List

Returns the tags list

Call URL

GET api.commander1.com/api/1.0/manage/container/tags/list?id_site=X&access_token=Y&id_container=Z

Call parameters

URL PARAMETER

TYPE

MANDATORY

DESCRIPTION

id_site

Integer

Yes

Client site identifier

access_token

Alphanum

Yes

Caller’s security identifier

id_container

Integer

Container identifier

Return code:

HTTP CODE

MESSAGE

DESCRIPTION

200

The request went through, the result is in the answer’s body

400

Bad Request

The parameters are not ok or mandatory parameters are missing

401

Unauthorized

The security token does not match the site_id or the container_id

404

Not Found

A container identifier for the site_id parameter was not found

500

Internal Server Error

Internal server error

Response format :

The response is in JSON format.

FIELD

TYPE

ALWAYS PRESENT ?

DESCRIPTION

idSite

Integer

Yes

Site identifier

containers

Array

Yes

Array containing the container list and their label

containers/id

Integer

Yes

Container identifier

containers/label

String

Yes

Container label

containers/is_active

Boolean

Yes

Container status (active=true, deleted=false)

Response example

{  
    "idSite":26,
    "containers":[  
        {  
            "id":1,
            "label":"Container1",
            "is_active": true,
            "tags":[  
                {  
                    "id":1,
                    "label":"Click&Site Tracking"
                },
                {  
                    "id":3,
                    "label":"commanders act"
                }
            ]
        }
    ]

Get Users

Get platform users.

Users

GET https://api.commander1.com/v2/{siteId}/users

Two usages : GET /users/ : Returns a list of user properties (depending on the parameters requested) linked to the users of a site. GET /users/123 : Return properties of one user (id 123) on one site. Click below to download complete API documentation

Query Parameters

Name

Type

Description

integer

The user id

include

string

permissions or roles or both separated by a comma

tC.* attributes and methods

“tC.” methods are namespaced* . They come in handy when needing to perform technically advanced actions such as printing the array of launched tags within a container into the browser’s console. Please note that these functions’ availability and behavior depend on several elements like your container configuration, among others. Simply type “tC.” into your browser’s console and the list of available functions on a given site and for a given container will appear.

* “namespacing is a technique employed to avoid collisions with other objects or variables in the global namespace. They’re also extremely useful for helping organize blocks of functionality in your application into easily manageable groups that can be uniquely identified.”

tC._R

Internal object used for statistics

tC.ams

Internal object used for the Measure product

tC.array_launched_tags

Displays a list of tags within the container version that is published. If you use one of our testing tools (Bookmarklet or TagAssistant Chrome extension) and simulate the presence of a different container version, the function will display the tags within the container version that is being tested

tC.array_launched_tags_keys

Displays a list of tag identifiers corresponding to the tags within the container version that is published or being tested

tC.call

Internal function used for callbacks

tC.containerVersion

Displays the version number of the container that is published or being tested

tC.containersLaunched

Displays a JavaScript object containing other objects. The latter correspond to the containers launched on a given page and provide information about them and the tags within (id, name)

tC.dedup

DEDUPLICATION HAS TO BE ENABLED FOR THIS FUNCTION TO WORK

Displays a JavaScript object containing all defined channels and sources and showing whether they are active or not

tC.dedup_done

DEDUPLICATION HAS TO BE ENABLED FOR THIS FUNCTION TO WORK

Displays whether the deduplication module is on or off on a given site

tC.dedup.cj

DEDUPLICATION HAS TO BE ENABLED FOR THIS FUNCTION TO WORK

Displays the last 10 touchpoints in a user’s customer journey. They are collected with customer journey (CJ) cookies. You can adjust the number of touchpoints in the interface. To do so, please go to the Options > Channel and sources definition tab

tC.dedup.LeA

DEDUPLICATION HAS TO BE ENABLED FOR THIS FUNCTION TO WORK

Displays the last recognized channel in the customer journey

tC.dedup.LeAD

DEDUPLICATION HAS TO BE ENABLED FOR THIS FUNCTION TO WORK

Displays the source associated to the last recognized channel in the customer journey cookie

tC.dedup.LeC

DEDUPLICATION HAS TO BE ENABLED FOR THIS FUNCTION TO WORK

Displays the last recognized channel – related to clicks – in the customer journey cookie

tC.dedup.LeCD

DEDUPLICATION HAS TO BE ENABLED FOR THIS FUNCTION TO WORK

Displays the source associated to the last recognized channel – associated to clicks – in the customer journey cookie

tC.dedup.LeV

DEDUPLICATION HAS TO BE ENABLED FOR THIS FUNCTION TO WORK

Displays the last recognized channel – related to views – in the customer journey cookie

tC.dedup.LeVD

DEDUPLICATION HAS TO BE ENABLED FOR THIS FUNCTION TO WORK

Displays the source associated to the last recognized channel – related to views – in the customer journey cookie

tC.dedup.FeC

DEDUPLICATION HAS TO BE ENABLED FOR THIS FUNCTION TO WORK

Displays the first recognized channel – related to clicks – in the customer journey

tC.dedup.FeCD

DEDUPLICATION HAS TO BE ACTIVE FOR THIS FUNCTION TO WORK

Displays the source associated to the first recognized channel – related to clicks – in the customer journey cookie

tC.dedup.FeV

DEDUPLICATION HAS TO BE ENABLED FOR THIS FUNCTION TO WORK

Displays the source associated to the first recognized channel – related to views – in the customer journey cookie

tC.dedup.FeVD

DEDUPLICATION HAS TO BE ENABLED FOR THIS FUNCTION TO WORK

Displays the source associated to the first recognized channel –related to views – in the customer journey cookie

tC.dedup.AeA

DEDUPLICATION HAS TO BE ENABLED FOR THIS FUNCTION TO WORK

Displays channels recognized halfway through the customer journey

tC.dedup.AeC

DEDUPLICATION HAS TO BE ENABLED FOR THIS FUNCTION TO WORK

Displays channels recognized halfway through the customer journey (for clicks)

tC.dedup.AeV

DEDUPLICATION HAS TO BE ENABLED FOR THIS FUNCTION TO WORK

Displays channels recognized halfway through the customer journey (for views)

tC.domReady

Displays whether all the content from the Document Object Model (DOM) has finished loading or not (i.e. the containers)

tC.domain

Returns the page’s domain (.tagcommander.com for instance)

tC.each

Internal iterator

tC.generatorVersion

Displays the container generation engine’s version

tC.getCookie

Displays the value of a given cookie. You need to write the function and the cookie’s name next to it between parentheses and quotes: tC.getCookie(“cookie’s name”).

tC.getParamURL

Displays a given parameter from the page’s URL

tC.hitCounter

Internal function used to obtain statistics related to invoicing hits

tC.id_container

Displays the container ID

tC.id_site

Displays the TagCommander site ID

tC.inArray

Internal function to check if an element is placed inside an array

tC.inclusion_oct_1

Specific to each container (JS inclusion)

tC.internalFunctions

Namespace for TagCommander’s internal functions

tC.internalvars

Namespace for TagCommander’s internal variables

tC.isArray

Method to verify whether a variable is placed inside an array

tC.isCurrentVersion

Confirms whether the currently deployed version in the interface is the current version on the site

tC.isDOMReady

Confirms if the Document Object Model (DOM) is ready

tC.isFunction

Method to verify whether the type of a variable is a function

tC.isNumeric

Method to verify whether a variable’s value is a number

tC.isPrototypeOf

Method to verify whether a variable is prototype

tC.isWindow

Method to verify whether a variable is window

tC.launchTag

Internal method used for TagCommander’s Google Chrome extension

tC.length

Internal variable

tC.log

Method replacing the console.log() command

tC.maindomain

Displays the main domain containers are deployed on

tC.name

Displays a “c” for container

tC.nodeNames

Displays the list of the Document Object Model’s (DOM) elements

tC.onDomReady

Method to execute code on the Dom Ready event

tC.pixelTrack

Internal Method injecting pixels

tC.privacy

Namespace for variables related to the Privacy module

tC.privacyVersion

Displays the version number of the Privacy banner and settings that are published

tC.rchecked

Internal Variable storing a regexp

tC.removeCookie

This function lets you remove a cookie. You need to write the function and the cookie’s name next to it between parentheses and quotes: tC.removeCookie(“cookie’s name”)

tC.script

Returns a JavaScript object that you can “unfold” to find the location of the container (link to the script)

tC.setCookie

This function lets you create a cookie. Here is the function interface: tC.setCookie(name, value, lifetime, path, domain, secure, sameSite). Ex: tC.setCookie(“My_cookie”, “1”, 365,”/”,”.mysite.com”, true, "Lax")

tC.ssl

Displays the SSL certificate: indicates whether the page’s protocol is https or http

tC.tagPatterns

Internal variable containing the regex (patterns) to detect tags’ hits for the TagPerformance module

tC.tagPerf

Internal variable for the TagPerformance module

tC.tagPerfAnalyzer

Internal function that analyzes a page to calculate tags’ response time (for the TagPerformance module)

tC.tagPerfE

Yet unused variable that controls sampling rates of TagPerformance’s calls

tC.script.add(location.protocol + “//manager.tagcommander.com/utils/IP/”);

This function allows you to recover the IP address

Common Trigger Strategies

Data Layer strategies for common setups.

Following you will find common Commanders Act Trigger setups.

Page View Trigger

In most cases page view events are covered by the inbuilt Container loaded and DOM ready Trigger within Commanders Act. Therefore it is only necessary to setup the Data Layer and the Container to execute Tags on page views. In case of JavaScript driven webpages it is sometimes necessary to further track "virtual page views", e.g. in case the process steps of a sales funnel (log-in, enter shipping details, enter payment details, confirm order, order success) are implemented via JavaScript functionally and not via individual pages with distinct URLs.

In this case it is common to track the initial page view with the Container loaded or DOM ready Trigger and subsequent virtual page views via a custom Trigger. For this scenario it would be necessary to follow these steps on each subsequent virtual page view.

1. Update `tc_vars` Data Layer

The Data Layer should be updated with the new metadata of the subsequent virtual page view.

2. Reload the Container

Some internal functionality of the Container (e.g. Internal Variables) are only calculated when the Container was initially loaded. To reload these with the updated Data Layer it is necessary to reload the Container via a JavaScript function.

3. Execute Triggers

After these steps it is then necessary to signal a custom Trigger to execute the related Tags.

To use event attributes, you can specify the event or the element as first argument.

Old Method

To use event attributes, you need to specify the event or the element as argument. event is a special variable that is always available inside of onclick and on* attributes.

Steps 2. and 3. are often used in conjunction therefore it is possible to combine them in one call. e.g. tC.container.reload({ events: { pageview: [{}, {}] } });

Click Trigger

Click Trigger implementation depends on the scenario. e.g. Is the user navigated to another site when he clicks an element? and Does the following page open in a new tab?.

Following you will find a list of common scenarios for click Trigger.

Scenarios

Click Navigates to an Internal Page

Links or interactions that navigate the user to another internal page are difficult to track. The reason for this is that Tags usually need more time to execute than the browser needs to navigate to the next page. This might accidentally cancel Tags execution and therefore its related tracking capabilities.

To successfully track these kind of scenarios it is important to align with the Tag vendor for a solutions. Typical solutions are:

The Tag delays page navigation until the Tag finishes execution
The Tag uses the Beacon Browser API, which sends tracking calls in the background

These options typically require configuration of the event Tag code.

Click Navigates to an External Page

External links are best opened in another browser tab by using the target="_blank" option on anchor links. This allows Tags to finish their work on the old tab, while users can already navigate the new external page in a new tab.

In case external links can not be opened in a new tab this scenario should follow the same advice than the prior scenario.

Click Does Not Navigate to Another Page

Some click events do not redirect to a new page. Typical examples are video transport controls or interactions with image carousels.

These click events can usually be tracked with less rissk due to Tags having enough time to execute on the same page.

Setup

With Commanders Act Interface

Commanders Act users can setup common click Triggers with minimal effort via the Web Containers interface by selecting them with a CSS selector path.

This Trigger works in many scenarios but has two downsides:

Using a generic CSS selector path to setup a Trigger is unstable and can break on future releases of the website code when the CSS is updated.
Commanders Act can only identify elements that are loaded synchronously on the website. Elements that are loaded asynchronously cannot be watched by the predefined Commanders Act Trigger.

Good scenarios for setting up Commanders ActTriggers with the Interface are:

Onsite campaign that has to be measured for a short time period (couple of weeks)
General click tracking until the web development team can implement a custom Trigger.

With Custom Trigger

Technical personnel can implement custom Triggers to track clicks on a website. This approach is more stable compared to setting up a click Trigger with the interface, but usually requires some time until the web development team can implement them. Therefore it is recommended to implement intermediary Triggers with the interface until they are implemented in the site.

Custom Triggers should not be implemented for short term campaigns, but should be favoured for business critical functionalities like Add to basket or Successful Registration.

A common way to setup click Trigger is done by setting up data-attributes on all elements where clicks should be tracked. These attributes could then be filled by the website CMS with values, so e.g. the marketing team can setup a "Click Trigger" for a new Teaser on their own. In HTML this might look like this:

Inside of Commanders Act Platform it is then possible to catch clicks on these elements to execute a custom Trigger. With jQuery this might look like this:

This approach results in a nice separation of concerns between website code and Commanders Act. The website is responsible to provide tracking data and mark which elements should be trackable. Commanders Act is responsible in bootstrapping the click tracking code and executing the related Tags.

Pixel Tracking API

Pixel Tracking, also known as 1x1 gifs, or clear gifs, lets you record data from any website (or application) where JavaScript or POST requests are not allowed, but where you can insert an image (aka GET hit)

Basic Event Call

To send a basic event call using pixel tracking, construct a GET request to the tracking endpoint URL with the necessary query parameters. The following example demonstrates a basic event call for tracking a page view:

In the above example, replace {siteId} with the ID of your site (aka workspace), {yourSourceKey} with your specific source key, and value1 with the desired value for prop1. Remember to URL encode the string values, especially if they contain special characters or spaces.

Event Call with Objects and Arrays

Pixel tracking allows for more complex data structures like objects and arrays. To include them in your event calls, you can nest parameters by indicating objects and their properties with square brackets for both objects and arrays. The property names are enclosed within the brackets and nested properties are further enclosed in their own set of brackets. The following example demonstrates an event call with objects and arrays:

To transform the above JSON event call to URL parameter form, follow these steps:

Start with an empty string for the URL parameter form.
Copy the key-value pairs at the top level of the JSON object (event_name, tc_s, token, page_type, page_name) as they are, separating them with ampersands (&).
For nested objects like user, represent them in the URL parameter form by appending the nested key using square brackets ([]).
For array values like user[consent_categories], append [] to the key to indicate an array parameter.
Include each element of the array as a separate key-value pair, appending the square brackets notation to the key as well.
URL encode the string values, such as replacing the space in Best sellers with %20 and the @ symbol in the email address with %40.

The transformed URL parameter form for the JSON event call would be:

Manage array of objects (ex: items)

Arrays of objects can also be handled in pixel tracking event calls. This allows you to include multiple items within a single event, such as a purchase event. Let's consider an example of managing an array of objects for items in a purchase event:

To include the array of objects within the event call, follow these steps:

Include the key-value pairs at the top level of the JSON object as usual (id, revenue, value, shipping_amount, tax_amount, currency, user).
For the array of objects, specify the key (e.g., items) and use square brackets ([]) to indicate an array parameter.
Include each object within the array as a separate set of key-value pairs, preserving the structure of the objects.
If necessary, nest additional objects or arrays within the objects of the array.

Example of transforming the JSON event call to URL parameter form:

In the transformed URL parameter form, each item within the array is represented by its index, followed by the keys and values of the nested object.

Google Tag Manager (GTM)

Bridge your events in a seamless way.

Commanders Act provides a GTM template to connect your existing GTM implementation to our serverside endpoint, in a secured environment.

Setup

Summarizing all recommended steps:

Create a GTM source in Commanders Act
Add our template to your GTM implementation
Configure your tag

Create a source in Commanders Act

In your Commanders Act dashboard:

In the left pane menu, click on Sources > Overview.
Click on the Add source button.
In the catalog, search for the Google Tag Manager source and click on it.
Click on Configure and set its name, environment and bound destinations.
Once you're done, click on the Create button at the bottom.
The source key will then be displayed:

Copy its value and keep it for later!

Hint: If you have already created a GTM source, you can retrieve its key by browsing to its Settings tab.

Add our template to GTM

Click on (2) the "New" button.

Click on (3) the "Tag Configuration" area.

Click (4) the magnifying glass in the upper right corner.

Search for (5) the "Commanders Act | Serverside events bridge" custom template and click on it to start the configuration.

Configure your tag

Start by filling (6) a name for your tag in the upper left corner.

Hint: you may want to name your tag adding the event name you're going to implement in the end. (E.g. "Commanders Act | Serverside events bridge - Purchase")

Input your (7) "Commanders Act Site ID" and (8) "Commanders Act Source Key" (refer to the first section on how to create a source and retrieve its key).

Select (9) the "Commanders Act Event" from the drop-down menu, which is the event you want to forward.

Depending on which event you select more (or less) fields will be presented. In case you don't input a mandatory field the template will highlight the missing entry so you can provide a proper mapping.

The "Event Fields" section contains fields that define the event itself and are mostly mandatory or highly recommended.

In the "User Fields" section you can set (12) the "User Id" and (13) "User Email" - Either one of them is required if you select the "Purchase" event. The (14) "User Consent Categories" is a mandatory field holding an array with the user's consent category identifiers.

It's important to define and map all category identifiers with their respective names. For example, you may have the following array: [1,2,4] and you defined the following relationship:

1 ➜ Advertising category
2 ➜ Analytics category
4 ➜ Functionality category

You also share with Commanders Act that the "Advertising category" must be enabled to activate the "Facebook CAPI." In this example, since the category identifier [1] is included in the array we can activate the bridge and forward the event to Facebook.

Ensure your category relationships are shared with Commanders Act.

Only with the agreed consent settings, we're allowed to bridge both the "Purchase" and "Refund" events to the "Facebook CAPI".

Complete your configuration by selecting the proper activation in the "Triggering" area / "Firing Triggers".

(function(){

    if (!$) {
        console.log("Commanders Act | Error | jQuery not available in Commanders Act Click Trigger!");
        return;
    }

    var eventActionSelector = '[data-tracking-action="click"]';
    var eventLabelAttribute = 'data-tracking-label';
    var eventValueAttribute = 'data-tracking-value';

    var eventHandler = function(event) {

        var eventData = {};
        eventData.event_action = "click";
        eventData.event_label = $(this).attr("data-tracking-label");
        eventData.event_value = $(this).attr("data-tracking-value");

      	if (tC.event && typeof tC.event[triggerName] === "function"){
            // old method
            // tC.event["my_click_trigger"](event, eventData);

            eventData.from = event; // necessary to use event attributes inside the tag
            cact('emit', 'my_click_trigger', eventData);
      	}

    }

    // Setup event handler on body via event delegation to include asynchronous elements
    $("body").on("click", eventElementSelector, eventHandler);

}());

{
  "event_name": "page_view",
  "tc_s": "1234",
  "token": "abcdef",
  "page_type": "product_list",
  "page_name": "Best sellers",
  "user": {
    "id": "12356",
    "email": "toto@domain.fr",
    "consent_categories": [
      "1",
      "3"
    ]
  }
}

GET  https://collect.commander1.com/events?tc_s=1234&token=abcdef&event_name=page_view&page_type=product_list&page_name=Best%20sellers&user[id]=12356&user[email]=toto%40domain.fr&user[consent_categories][]=1&user[consent_categories][]=3

{
  "id": "O_12345",
  "revenue": 16.00,
  "value": 22.53,
  "shipping_amount": 3.33,
  "tax_amount": 3.20,
  "currency": "EUR",
  "user": {
    "id": "12356",
    "email": "toto@domain.fr"
  },
  "items": [
    {
      "id": "SKU_12345",
      "quantity": 1,
      "product": {
        "id": "12345",
        "name": "Trex tshirt",
        "category_1": "clothes",
        "colors": ["red"],
        "price": 9.99
      }
    },
    {
      "id": "SKU_12346",
      "quantity": 1,
      "price": 9.99,
      "product": {
        "id": "12346",
        "name": "Heart tshirt",
        "colors": ["blue", "white"],
        "price": 9.99
      }
    }
  ]
}

id=O_12345&revenue=16.00&value=22.53&shipping_amount=3.33&tax_amount=3.20&currency=EUR&user[id]=12356&user[email]=toto%40domain.fr&items[0][id]=SKU_12345&items[0][quantity]=1&items[0][product][id]=12345&items[0][product][name]=Trex%20tshirt&items[0][product][category_1]=clothes&items[0][product][colors][]=red&items[0][product][price]=9.99&items[1][id]=SKU_12346&items[1][quantity]=1&items[1][price]=9.99&items[1][product][id]=12346&items[1][product][name]=Heart%20tshirt&items[1][product][colors][]=blue&items[1][product][colors][]=white&items[1][product][price]=9.99

Performance Optimization

Strategies to improve the onsite performance of TagCommander.

Onsite performance of a website is one of the most important KPIs for SEO. Therefore more and more businesses are interested in optimizing onsite performance via TagCommander. This post collects topics to make TagCommander itself more performant.

Reduce File Size of TagCommander

Remove unused Data Layer Properties

Each Data Layer property that is configured in the options in the interface creates a bit of JavaScript code in the Container to initialise the variable in case it was not present in the onsite Data Layer tc_vars. Removing unused/old variables will therefore make the Container file a bit smaller (and as a side effect also improve transparency of the Container setup).

Remove Unused Internal Variables

Each internal variable that is configured in the options in the interface is a JavaScript snippet, so removing internal variables allows to make a Container file smaller. This can be done by removing unused internal variables and also by specifying which variables are used in which Container. This is especially important for clients with a <head> and <body> Container and clients that have multiple Containers for different websites.

Do Not Repeat Yourself

Sometimes the same functionality of a Tag is duplicated in multiple Tags. In these cases it is possible to save a good amount of JavaScript code and Container file size by refactoring the common functionality into an internal variable or into a common Tag. For example many Tags exist of two parts. One part loads an external JavaScript library of the vendor and one part sends the actual event to the vendor. Per default the code that loads the JavaScript library is often duplicated in every event. So extracting the first part into a base Tag allows to remove the duplicated JavaScript.

Split Large Container Files

Many Tags are deployed on every page of a website even so they are not triggered. For example many vendors have separate Tags for collecting information and only one Tag that is played out on the confirmation page. Therefore it might make sense to split the Container in two parts—one for catalogue pages and one for funnel pages. Therefore both Containers have a smaller size as they only include Tags that are relevant for their part of the website.

Also make sure to only implement Tags in <head> Container if necessary as those Tags usually have a greater impact on onpage performance than Tags in `<body>` Container.

Implement Hybrid TagCommander Setup

A hybrid setup allows to move onsite performance impact into the Server-Side TagCommander infrastructure.

Make TagCommander asynchronous

Load Container Asynchronous

Many onsite page speed crawlers measure the time until the browser event onload. So in case the IT team loads the TagCommander Container asynchronous on the onload event it is possible to make the TagCommander file invisible for some page speed metrics. This is usually only possible for <body> Containers as <head> Containers need to be executed synchronously for A/B testing and personalisation Tags that have an impact on the visual content of the website.

Tags in asynchronous <body> Container that use synchronous document.write (e.g. some advertising solutions) will break the website in case the Container is loaded asynchronously. These Tags need to be avoided in case a Container is installed asynchronously.

Load Tags Asynchronous

JavaScript is for the most part a single thread language, this means that long running JavaScript (like a long process in a loop) can block other parts of the JavaScript that should be executed right away. It is possible to put long running JavaScript on an execute later with a lower priority stack by wrapping it inside of a setTimeout with a delay of 0 ms.

setTimeout(function() {
    // My Tag Code
}, 0);

This needs to be tested with each individual Tag as some might not be compatible with this approach.

Shopify

Our Shopify application and the related source are currently under final review and will be available soon. This page will walk you through the steps to add and configure your Shopify source and connect it to our Shopify Store application so you can get the most out of their sinergy.

The Commanders Act application, which is available in the Shopify App Store, helps merchants streamline their workflows by connecting Shopify events with partners. Whether you’re tracking customer interactions, or optimizing ad performance, our app simplifies the process. By intercepting Shopify Standard and Custom events, the Commanders Act application seamlessly integrates with your existing stack while leveraging Shopify Customer Privacy API. This means less manual setup and more secure data collection.

Key features

Preserve original Shopify event data.
User-friendly configuration.
Include debugging functionality for troubleshooting.

Source setup

Scroll down to the bottom and click Save.

App setup

In the search box, on the top, type: "Commanders Act" and click on it.

Validate your setup

Check for reported log/entries.

Quick reference

The following table shows the mapping between Commanders Act and Shopify events. Custom Shopify events are also forwarded to Commanders Act with the same original Shopify event name.

Shopify Events

Commanders Act Events

cart_viewed

view_cart

checkout_completed

purchase

checkout_shipping_info_submitted

add_shipping_info

checkout_started

begin_checkout

collection_viewed

view_item_list

page_viewed

page_view

payment_info_submitted

add_payment_info

product_added_to_cart

add_to_cart

product_removed_from_cart

remove_from_cart

product_viewed

view_item

search_submitted

search

[Custom Shopify event name]

Field mappings

All Shopify properties are retrieved from the event property. The original Shopify event data, with all its properties, is stored in the Commanders Act property partners.shopify.event .

Shopify Properties

Commanders Act Properties

analytics.subscribe(...)

event_name [1]

data.checkout.order.id

data.element.id

id

data.checkout.subtotalPrice.amount

data.cartLine.cost.totalAmount.amount

data.cart.cost.totalAmount.amount

value

data.checkout.totalPrice.amount

revenue

data.checkout.shippingLine.price.amount

shipping_amount

data.checkout.totalTax.amount

tax_amount

data.checkout.currencyCode

data.cartLine.cost.totalAmount.currencyCode

data.cart.cost.totalAmount.currencyCode

currency

context.document.location.href

url

context.document.title

page_title

context.document.location.href

context.page.url

context.navigator.language

context.page.lang

context.navigator.userAgent

context.device.user_agent

data.searchResult.query

search_term

data.checkout.transactions.0.paymentMethod.type

payment_method [2]

data.checkout.discountApplications.X.title

coupon

data.checkout.order.customer.id

user.id

data.checkout.order.customer.isFirstOrder

user.status [3]

data.checkout.shippingAddress.firstName

data.checkout.billingAddress.firstName

user.firstname

data.checkout.shippingAddress.lastName

data.checkout.billingAddress.lastName

user.lastname

data.checkout.email

user.email

data.checkout.phone

data.checkout.shippingAddress.phone

user.phone

data.checkout.shippingAddress.address1 + data.checkout.shippingAddress.address2

data.checkout.billingAddress.address1 + data.checkout.billingAddress.address2

user.street

data.checkout.shippingAddress.city

data.checkout.billingAddress.city

user.city

data.checkout.shippingAddress.countryCode

data.checkout.billingAddress.countryCode

user.country

data.checkout.shippingAddress.province

data.checkout.billingAddress.province

user.state

data.checkout.shippingAddress.zip

data.checkout.billingAddress.zip

user.zipcode

data.collection.title

item_list_name

data.checkout.lineItems.X.variant.id

data.checkout.lineItems.X.merchandise.id

data.checkout.lineItems.X.id

data.cart.lines.X.variant.id

data.cart.lines.X.merchandise.id

data.cart.lines.X.id

data.collection.productVariants.X.variant.id

data.collection.productVariants.X.merchandise.id

data.collection.productVariants.X.id

data.searchResult.productVariants.X.variant.id

data.searchResult.productVariants.X.merchandise.id

data.searchResult.productVariants.X.id

data.productVariant.product.id

data.cartLine.merchandise.product.id

items.X.id [4]

data.checkout.lineItems.X.variant.product.title

data.checkout.lineItems.X.merchandise.product.title

data.checkout.lineItems.X.product.title

data.cart.lines.X.variant.product.title

data.cart.lines.X.merchandise.product.title

data.cart.lines.X.product.title

data.collection.productVariants.X.variant.product.title

data.collection.productVariants.X.merchandise.product.title

data.collection.productVariants.X.product.title

data.searchResult.productVariants.X.variant.product.title

data.searchResult.productVariants.X.merchandise.product.title

data.searchResult.productVariants.X.product.title data.productVariant.product.title

data.cartLine.merchandise.product.title

items.X.product.name [4]

data.checkout.lineItems.X.variant.price.amount

data.checkout.lineItems.X.merchandise.price.amount

data.checkout.lineItems.X.price.amount

data.cart.lines.X.variant.price.amount

data.cart.lines.X.merchandise.price.amount

data.cart.lines.X.price.amount

data.collection.productVariants.X.variant.price.amount

data.collection.productVariants.X.merchandise.price.amount

data.collection.productVariants.X.price.amount

data.searchResult.productVariants.X.variant.price.amount

data.searchResult.productVariants.X.merchandise.price.amount

data.searchResult.productVariants.X.price.amount data.productVariant.price.amount

data.cartLine.merchandise.price.amount

items.X.product.price [4]

data.checkout.lineItems.X.quantity

data.cart.lines.X.quantity

data.collection.productVariants.X.quantity

data.searchResult.productVariants.X.quantity data.cartLine.quantity

items.X.quantity [4]

data.checkout.lineItems.X.variant.product.vendor

data.checkout.lineItems.X.merchandise.product.vendor

data.checkout.lineItems.X.product.vendor

data.cart.lines.X.variant.product.vendor

data.cart.lines.X.merchandise.product.vendor

data.cart.lines.X.product.vendor

data.collection.productVariants.X.variant.product.vendor

data.collection.productVariants.X.merchandise.product.vendor

data.collection.productVariants.X.product.vendor

data.searchResult.productVariants.X.variant.product.vendor

data.searchResult.productVariants.X.merchandise.product.vendor

data.searchResult.productVariants.X.product.vendor

data.productVariant.product.vendor

data.cartLine.merchandise.product.vendor

items.X.product.brand [4]

data.checkout.lineItems.X.discountAllocations.Y.amount.amount

data.cart.lines.X.discountAllocations.Y.amount.amount

data.collection.productVariants.X.discountAllocations.Y.amount.amount

data.searchResult.productVariants.X.discountAllocations.Y.amount.amount

items.X.discount [4]

data.checkout.lineItems.X.discountAllocations.Y.discountApplication.title

data.cart.lines.X.discountAllocations.Y.discountApplication.title

data.collection.productVariants.X.discountAllocations.Y.discountApplication.title

data.searchResult.productVariants.X.discountAllocations.Y.discountApplication.title

items.X.coupon [4]

analyticsProcessingAllowed

analyticsProcessingAllowed [5]

marketingAllowed

marketingAllowed [5]

preferencesProcessingAllowed

preferencesProcessingAllowed [5]

saleOfDataAllowed

saleOfDataAllowed [5]

[Original Shopify event data]

partners.shopify.event

TMS & Consent banners IDs

This is how you can retrieve IDs of sites, containers, privacy.

Site & Containers IDs / Versions

To be able to retrieve your site ID & containers IDs you need to open your DevTool on your navigator and enter

tC.containersLaunched

Here above :

Site ID : 4505
Containers IDs :
- 20 (version 155.04)
- 21 (version 32.01)

Privacy ID & Privacy Version

To be able to retrieve your Privacy ID & Privacy Version you need to open your DevTool on your navigator and enter

tC.PrivacyID

tC.PrivacyVersion

Here above :

Privacy ID : 12
Privacy Version : 005

API users

Visitor

GET https://api.commander1.com/v1.0/engage/visitors/

This endpoint allows you to

get properties for one specific visitor

. When you create the token, you can define which properties to return.

This API is more designed to be called from a tag in each user's browser.

Query Parameters

Name

Type

Description

callback

string

(optional) Callback for jsonp request

token

string

Security token

site

integer

ID of the site

tcid

string

Cookie id. If empty (recommanded) it will read the tcid in the user's cookie.

{
    "user_age": 39,
    "user_privacy_categories": [
      "11",
      "12",
      "13"
    ]
}

User

GET https://api.commander1.com/engage/user/

This endpoint allows you to

get properties for one specific user

based on a

user_id

. When you create the token, you can define which properties to return.

Query Parameters

Name

Type

Description

token

string

Security token

user_id

string

ID of the user

site

integer

ID of the site

{
    "message": "Person not found"
}

User

PUT https://api.commander1.com/engage/user/

Insert or update a user

Query Parameters

Name

Type

Description

site

string

Id of the site (account)

user_id

string

Id of the user. Required if tc_id parameter is not set

token

string

Security token

{"success":true}

Example Request

PUT

https://api.commander1.com/engage/user/?site=1234&user_id=1234&token=WvNIX8955cnZ7WF0f632s0Wb99Ql3rtA

{
"preferences.channel":"email",
"preference.frequency":"30d",
...
}

DELETE user

Delete a user

Resource URL

https://api.commander1.com/engage/user/

Resource Information

Response formats

JSON

Requires authentication?

Yes (token)

Parameters

NAME

REQUIREMENT

EXAMPLE VALUES

DESCRIPTION

site

1234

Id of the site

user_id

1234

Id of the user

tc_id (optional)

1234

Id of the visitor

token

[a-zA-Z0-9]*

WvNIX8955cnZ7WF0f632s0Wb99Ql3rtA

Security token

Example Request

DELETE

https://api.commander1.com/engage/user/?site=1234&user_id=1234&tc_id=1234&token=WvNIX8955cnZ7WF0f632s0Wb99Ql3rtA

Response

{"success":true}

Triggers

Default triggers

You can select a default trigger in the container options.

This means that each time you will add a tag to your container, the default trigger(s) will apply on this tag.

To select your default trigger(s), go in the container options, “advanced” part:

Container loaded

This trigger allows calling tags when the container is loaded on a page. It is the default trigger for all the tags you add to your container. This means that the tag will only be called when your JavaScript container loads on your site, but it will not be the case for other event types (such as a click, a page change within an “single page applications” environment, etc.). In order to trigger tags when a container loads on your page, all you need to do is selecting them from the list.

DOM Ready

This trigger allows calling tags when the page’s structure is built (on the “DOM Ready” event). To launch tags on this event, all you need to do is selecting them. They will be called on the DOM Ready event when the page loads.

Click

This trigger allows calling tags whenever elements of the page are clicked. Example: if you would like to call a tag when a user clicks a button (ex: “add to cart” button), select the desired tag(s) and enter the code allowing to target the button or the link on your page in the “CSS Selector” field.

Must know:

To retrieve the CSS selector, open your browser’s console and use its targeting tool to target one of your page’s elements. Then right-click, the code appearing in your console, click “Copy” and “Copy selector”. All you have to do next is pasting this code in the interface.

You can enter many selectors in the interface; you will have to separate them with commas.

Form submission

This trigger allows calling tags when a user submits a form properly filled. Example: when they click the “submit” button or press the Enter key. To call a tag when a form is submitted, follow the same steps you followed to call a tag upon a click. Indicate your trigger’s name (ex: “account creation confirmation”), select the desired tag(s) and enter the code allowing targeting the form submission button on your page in the “CSS Selector” field.

Scroll

This trigger allows calling tags when a user scrolls the page vertically or horizontally. In order to execute a tag on scrolling, you will need to enter your trigger’s name (ex: “30% vertical scrolling”), select the desired tag(s), choose the scrolling type (horizontal/vertical) from the dropdown menu, the expected scrolling and measuring unit (page percentage or pixels).

Custom

This trigger allows calling tags whenever a Commanders Act event function (tC.event.xxx) is identified on the page. If you wish to execute a tag on a custom eventm, please indicate your trigger’s name (ex: “add to cart click”), select the desired tag(s) and enter the implemented event function’s name (ex : “tC.event.add_to_cart”).

Data storage

Commanders Act Data Storage is a cookie stored on the user’s browser.

When you create data storage in the Commanders Act interface, a cookie with the same name is stored on the visitor’s browser. Data storage allows you to make use of the data it contains. Its use is described in the next articles in this section.

Data storage is useful for continually storing data about a visitor from one page to the next, from one visit to the next or for a defined period of time up to one year.

It is a cookie that stores data and allows to use it afterwards in many ways. Its uses are detailed in other articles in this section.

Additional information

Data storage that you create in the interface are first-party cookies, which are cookies set for your site’s domain name.

Data storage usage

You can use the function below to see the content of data storage created for one of your site’s pages:

tC.getCookie('cookie_name')

You can use the following function to create custom data storage: tC.setCookie('cookie_name', 'value', 'expiration')

Adding data storage

To add data storage, you must go to the “Options” tab > “Data layer” > “Data Storage” and click “ADD DATA STORAGE”:

The “add” window consists of the following fields:

Name: Name of the Data Storage Container(s) to link:A menu that unfolds and shows all available containers Lifetime: A menu to select the cookie’s lifetime Type: the type of cookie/what it is used for Value: the values the cookie will take (a and b for ab testing, many more for n testing …)

Types of data storage

Unique ID

Generates a unique ID for each visitor.

Example: Commanders Act can become your visitors’ unique reference ID to replace or enrich the ID generated by your partner solutions.

The “Do you want lifetime to be refreshed at each page view?” option changes the data storage’s lifetime based on the frequency of visits to the site. This option refreshes the data storage lifetime with each page view.

Example: you have set the data storage lifetime to 30 days and checked this option. If a user visits the page at 12 p.m. on 05/01/2015, the cookie will remain on the visitor’s computer until 12 p.m. on 05/31/2015, i.e. 30 days later. The cookie’s lifetime will refresh with each page view.

URL parameter saver

Saves the value of a URL parameter.

Scoring on page views

Assigns a score based on the number of page views.

Page views counter

Saves the number of page views for a given visitor.

A/B testing

Creating two visitor populations split 50/50.

Example: if you want to activate solution A for 50% of your visitors and solution B for the remaining 50%, all you need to do is indicate the data storage values for population A, “vendor_A” for example, and population B, “vendor_B”.

You will then be able to create a rule during the deployment process in the “Rules” section that activates solution A’s tags when the data storage value is “vendor_A”, and solution B’s tags when the value is “vendor_B”.

Note: this method is used regularly for A/B tests of two competing retargeting solutions.

N testing

Creating N visitor populations of equal size.

Example: if you want to launch an N test for 3 competing solutions, each solution will be assigned 33.3% of the traffic (100%/3); for 4 solutions, each solution will be assigned 25% of the traffic (100%/4), and so forth.

If you decide to activate solution A for 33.3% of your visitors, solution B for another 33.3% and solution C for the remaining 33.3%, you must enter the data storage value in each case. For example, “vendor_A” for solution A, “vendor_B” for solution B and “vendor_C” for solution C (1). Each value must be separated by a comma in order to be processed.

Variable Saver

Saves a variable’s value.

Example: if at some point you want to save a Commanders Act data layer variable or any other JavaScript variable present on the page, you must enter the name of the variable to save.

For example, data storage allows you to save visitors’ user_id variables in order to recognize them if they return several days after leaving your site. To save the user_id variable value, you must enter “tc_vars[“user_id”]” or “tc_vars.user_id” (both formats are accepted) in the “Variable to save” field (1). If you want to save the value of an internal variable, you must enter the value using the following format: tC.internalvars.variable_name.

Branches

Introducing the new "Branches" feature

Are you ready to take your TMS experience to the next level? We are thrilled to introduce our latest feature: Branches. This powerful tool is designed to elevate your team’s efficiency, allowing multiple users to work simultaneously on the same project without stepping on each other's toes. Imagine a workspace where you can confidently make changes, test them in isolation, and merge them seamlessly—all while keeping your Main project intact. Let’s dive into what makes this feature a game-changer.

What is "Branches"?

Branches allow you to create a separate, partitioned work environment—a safe space where your work is your own. You can make changes without worrying about interrupting your colleagues’ progress. When you're ready, simply merge your work back into the Main project with confidence, knowing that everything aligns perfectly.

Key Benefits

Work independently: No more waiting for colleagues to finish their tasks. With Branches, everyone can contribute simultaneously without conflicts.
Reduce errors: By isolating changes, you can avoid the dreaded “unfinished work” being deployed to production. Test and validate your changes in a secure environment before merging.
Streamlined merging: Our intuitive interface makes merging a breeze. View changes side-by-side with our diff checker, ensuring nothing slips through the cracks.

Say goodbye to workflow interruptions!

Previously, if two users worked on the same account, their changes would overlap, leading to potential conflicts during container generation. This often resulted in errors that stalled the deployment process, or worse—unfinished work going live. With Branches, you’ll experience a smoother, more controlled workflow. Your team can now focus on what they do best, without the hassle of managing conflicting changes.

A seamless User Experience

Visual indicators: It’s easy to know where you are. When you’re working on the Main (your actual web container), all menu elements are cherry red. Switch to a Branch, and everything turns blue, signaling that you’re in a safe zone to make changes.
Effortless Branch creation: Whether you’re starting a new project, creating a new Branch is just a click away. Our intuitive panel guides you through the process, from naming your Branch to diving straight into editing.
Real-time notifications: Stay updated with any changes made into the Main while you’re working on a Branch. You’ll receive a prompt with options to update your Branch or continue working—keeping you in control at all times.

Glossary

Main: your usual container, considered as "parent" in a Branch context
Branch: a duplication of your Main to work without impacting your Main configuration
Merge: action to bring the modifications from your Branch live in your Main container

How it works ?

Branch Creation

To open the Branch creation UI use the button in the breadcrumb menu (identified as "Main" when you are on your regular container, or by the Branch name if your are in Branch context). The list of your branches will appears. Click on "Create new branch". Just define a Branch name, you can also add a description if needed, You can create up to 5 Branches for each container!

On save, you will redirected in your new Branch environment

Once your Branch is created, all changes you make are isolated to this environment. The blue color of the navigation elements shows you are in a Branch.

You can edit or modify any of the elements as if you were in a normal container.

Limitations

-Rules cannot be permanently deleted in a Branch, only "Archive" action is possible. -Old events formats (deprecated tc_events) cannot be deleted in a Branch

Be careful on your WebDatalayer modification(s), it may impact all your site

If you create an internalvar in your Branch, you must link it with the Main as well, because internalvars aren't merged

Branch Comparison with the Main

At any time you can have clear view of the work done on each Branch. Simply click on the link "See changes"

The "Comparison" pop in will appears:

You can unfold elements to get details

Existing Branch Edition

To access an existing Branch, click on "pen" icon. This pop in is also useful to go back to your Main container.

Edit/modify any elements as if you where in a regular container.

Branch Update

If your Branch is not up to date with the newest Main changes, you will see this warning message, inviting you to update your Branch

On click, the pop in "Update" will be displayed, a diff checker. You are allowed to keep or discard the changes. The checked items will be bring into your Branch. If you don't wish to update your Branch now, then click on cancel.

Be careful on items with the items with label "conflict" It means there is modification(s) on the Main and on the Branch too

By default they are unchecked. Take time to compare and choose if you wish to keep the modification from the Branch or from the Main

We recommend to bring all the changes from the Main into your Branch. If you refuse to update some elements, you may impact the Main container on merging.

Branch QA & Test

You can generate your Branch as a regular container.

Once your Branch has been merged, you can do your Quality Assurance by 2 different ways: Deploy your Branch in your UAT environment, or use our Chrome Plugin "Commanders Act Tag Assistant"

Test on your UAT environment

When you’re ready, deploy your changes in your UAT environment, ensuring everything works flawlessly before merging.

There's a main difference for Branches containers at the deloy step: deployment on Production environment isn't allowed. That's why the deploy step has been renamed as "QA - Merge" in Branch context!

The UAT deployment option will push your Branch version on the UAT URL of the Main container.

It means that you can test your Branch directly on your UAT site without IT intervention.

Test with our plugin

Our Commanders Act Assistant is compatible with Branches!

Download it from Chrome Extension Store, once it is installed on your browser, you can use the button "preview" to test your Branch on your website.

For a detailed documentation about our plugin, pease read the following page

Merge Branch

Ready to bring your changes from Branch into the Main? Use our “Merge” feature, where you can review the differences, see a detailed comparison, and complete the merge effortlessly.

Merge doesn't consider the generation versions. The UI for merging will ever display the latest updates of your Branch

If your Branch is not up to date, Merge will be blocked.

Take the time to update your Branch now with the latest Main changes!

After merge

Once you merged your Branch, the Branch will be deleted and you will be redirected to your Main

All modifications from Branches are now logged in your Main with [Branch*] prefix

At any time after merge, you can view all modifications logs from the merged Branch on your Main Modification History.

Don't forget to re-generate your Main container to bring your changes in Production!

Custom User Rights

The native roles 'Administrator', 'Technical' and 'Marketing' are allowed to create, edit and merge branches.

If you want to manage these access rights more closely, you can use the dedicated rights in Profile Management, Custom Profile.

Looking ahead

Future-Proof Your Workflow

Although direct production deployment from a Branch is not available, our new QA plugin (currently under development), will offer you another way of testing your Branches, even in a production environment.

Perimeters & constraints

Perimeters and Constraints are two methods to conditionally fire your tags.

Under the Perimeter panel, tags fire if at least one rule is true.
Under the Constraints panel, tags fire if all rules are true.

Variable

The “Variables” tab allows you to create rules based on your data layer variables (external variables, internal variables, events attributes, events variables):

Condition and behavior

“If Variable Equals“: Tag activated if the variable equals the specified value.

“If Variable is Not Equal“: Tag activated if the variable differs from the specified value.

“OR Condition (One Variable)“: Tag activated if the variable equals at least one of the specified values.

“NAND Condition (One Variable)“: Tag activated if the variable equals two or more specified values.

“OR Condition (Up To Six Possible Variables)“: Tag activated if at least one of the variables equals the specified value.

“AND Condition (Up To Six Possible Variables)“: Tag activated if all the variables equal all the specified values.

“Greater than condition“: Tag activated if the variable is greater than the specified value.

“Less than condition“: Tag activated if the variable is less than the specified value.

“If Variable Contains“: Tag activated if the variable contains the specified value.

“If Variable Does Not Contain“: Tag activated if the variable does not contain the specified value.

“If Variable Matches“: Tag activated if the variable matches the specified value (regular expressions allowed: * to match any character and ^ for “variable begins with”).

“If Variable Doesn’t Match“: Tag activated if the variable does not match the specified value (regular expressions allowed: * to match any character and ^ for “variable begins with”).

In case of multiple values: enter all the values in the field separated by a comma ",". Don't use space between.

In which case using “external variables” for the mapping?

When you want to create a rule based on a tc_vars from the data layer implemented on your website.

Example: your technical team has implemented an env_country variable, and you want to create a rule based on it:

In which case using “internal variables” for the mapping?

When you want to create a rule based on a variable that you have created by yourself, from the internal variable interface.

In which case using “event variables” for the mapping?

When you want to create a rule based on a variable specific to an event.

Example: The following event is implemented in your site’s source code:

To call a tag only if the product name is “iphone”, you have to select the event variable named “product_name” and configure it in the following manner:

The “Cookie” tab allows you to create rules based on cookies you have previously created in the Commanders Act interface or which are available for your site’s domain name (first-party cookies).

Condition and behavior

“If Cookie Equals“: Tag activated if the cookie’s value equals the specified value.

“If Cookie Is Not Equal“: Tag activated if the cookie’s value differs from the specified value.

“If Cookie Contains“: Tag activated if the cookie’s value contains the specified value. In case of multiple values : enter all the values in the field separated by a comma ",". Don't use space between.

“If Cookie Doesn’t Contain“: Tag activated if the cookie’s value does not contain the specified value. In case of multiple values : enter all the values in the field separated by a comma ",". don't use space between.

Example with multiple values: In order to call a tag when your “consent_status” cookie equals “exempt” or "optin", you must select the “If Cookie Equals” rule and configure it in the following manner:

URL

This tab allows you to create rules based on your site’s URLs (note: we recommend that you use rules based on variables instead of URLs since the rule will become obsolete if your URL changes in the future):

Condition and behavior

“If URL Equals“: Tag activated if the URL equals the specified value.

“If URL Contains“: Tag activated if the URL contains the specified value. In case of multiple values : enter all the values in the field separated by a comma ",". Don't use space between.

“If URL Doesn’t Contain“: Tag activated if the URL does not contain the specified value.

“If URL Matches“: Tag activated if the URL matches the specified value (regular expressions allowed: * to match any character and ^ for “variable begins with”).

“If URL Doesn’t Match“: Tag activated if the URL does not match the specified value (regular expressions allowed: * to match any character and ^ for “variable begins with”).

Example: to call a tag when your URL indicates that the user is on the product page (providing your product page URLs are all structured the same: https://www.site.com/$category$/$subcategory$/product_$product_ID$), you have to select the “If URL Matches” rule and configure it in the following manner:

Browser

This tab allows you to create rules based on browsers.

Condition and behavior

“If Browser Is“: Tag activated if the browser is (choose from the list).

“If Browser Is Not“: Tag activated if the browser is not (choose from the list).

Mobile

This tab allows you to create rules based on the type of device.

Condition and behavior

“If Device / OS Is“: Tag activated if the device is (choose from the list).

“If Device / OS Is Not“: Tag activated if the device is not (choose from the list).

“If Device / OS Is Android Tablet“: Tag activated if the device is an Android tablet.

“If Device / OS Is Android Mobile“: Tag activated if the device is an Android mobile device.

“If Device / OS Is Not Android Tablet“: Tag activated if the device is not an Android tablet.

“If Device / OS Is Not Android Mobile“: Tag activated if the device is not an Android mobile device.

Example: to prevent a tag from being called on an Android mobile device, you must select the “If Device Is Not Android Mobile” rule and configure it:

DataCommander

This tab allows you to create rules based on the type of audience segments created in DataCommander.

Condition and behavior

“DataCommander OR condition (up to six variables)“: Tag activated if at least one of the audiences equals the specified value.

“DataCommander AND condition (up to six variables)“: Tag activated if all the audiences equal all the specified values.

“DataCommander Event activation“: Tag activated on an event

Advanced rules

This tab allows you to create all types of advanced rules. For example, you can create sampling rules or even “Custom” rules:

Condition and behaviour

“Sampling (1/X) (Page Based)“: Tag activated in X% of page views.

“Sampling (1/X) (Session Based)” : Tag activated in X% of visits.

“Sampling (1/X) (Visitor Based)“: Tag activated for X% of visitors.

“(A or B or C or D or E) AND (F or G or H or I or J)“: Tag activated if at least one of the variables in the first group AND at least one of the variables in the second group equal the specified values.

“(A and B and C and D and E) AND (F or G or H or I or J)“: Tag activated if all the variables in the first group AND at least one of the variables in the second group equal the specified values.

“(A and B and C and D and E) OR (F and G and H and I and J)“: Tag activated if all the variables in the first group OR all the variables in the second group equal the specified values.

“(A and B and C and D and E) OR (F or G or H or I or J)“: Tag activated if all the variables in the first group OR at least one of the variables in the second group equal the specified values.

“(A different than VALUE1) OR (B different than VALUE2)“: Tag activated if the first variable is not equal to a value OR the second variable is not equal to a value.

“(A different than VALUE1) OR (B equals VALUE2)“: Tag activated if the first variable is not equal to a value OR the second variable is equal to a value.

“(A different than VALUE1) AND (B different than VALUE2)“: Tag activated if the first variable is not equal to a value AND the second variable is not equal to a value.

“(A different than VALUE1) AND (B equals VALUE2)“: Tag activated if the first variable is not equal to a value AND the second variable equals a value.

“In Array“: Tag activated if the variable is present in the variable array.

“In Sub Array“: Tag activated if the variable is present in a variable array key.

“Array Intersection”: Tag activated if two variables from two variable arrays are equal.

“Custom“: Custom rule (to define in JavaScript).

Example: In order to call a tag for 25% of site visitors, you must select the “Sampling (1/X) (Visitor Based)” and configure it in the following manner:

API Conversions and Product catalog

Commanders Act Data API v2.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Rate-limits

You may send up to 30 requests per second
You may have up to 30 concurrent connections
If you send many conversions/products/etc. in bulk, the upload speed will be limited to 30 conversions/products/etc. per second

Rate limiting examples

If you send 1 conversion per request you will be limited to 30 requests per second
If you send 90 conversions in one request your upload will be completed in about 3 seconds
If you send 40 requests, each with one conversion in the same second, 30 of them will be processed and 10 of them will be rejected
If you send 3 requests, each with 100 conversions they will be completed in 10 seconds

Limitations

You can send up to 150 conversion items

Date formats

Use the long format with timezone for passing ISO-8601 dates. The following formats are accepted:

"2019-04-29T13:47:47.315Z"
"2019-04-29T13:47:47Z"
"2019-04-29T13:47:47.315+02:00"
"2019-04-29T13:47:47+02:00"

Errors

Errors are always returned as an array of objects in the top-level "errors" property.

Errors in bulk operations

For bulk operations you may have "errors" and "data" properties at the same time since some objects may have errors while others may not. Bulk errors are aggregated which means there won't be an error for each instance of an error but one error for each type of error with the number of occurrences and some examples of line numbers or ids.

{
  "errors": [
    {
      "code": "YOU_CAN_CHECK_THIS_IN_CODE",
      "detail": "This explains the error",
      "meta": {
        "context_property_example": "value_example",
        "error_count": 3,
        "line_numbers": [34, 45],
        "ids": [
          "c9017b85-8016-4f13-88b4-18d57c67b866",
          "12e0c3cb-7e8d-462f-9232-f7c61a900738"
        ]
      }
    }
  ]
  "data": {
    "accepted_object_count": 4,
    "rejected_object_count": 3
  }
}

Error object

Error objects have the following properties

Property

Type

Required

Description

code

string

true

Always present and contains error code that can be checked programmatically

detail

string

true

Human readable message that explains the problem. You should not check the value of this property programmatically because it may change

Authentication

HTTP Authentication, scheme: bearer Token will be provided by our support/consulting team

Default

Upsert conversions

Code samples

POST https://api.commander1.com/v2/{siteId}/conversions/bulk HTTP/1.1
Host: api.commander1.com
Content-Type: application/x-ndjson
Accept: application/json
Authorization: Bearer NJtcKaoCYu...mGZDxRgMBMUw==

POST /conversions/bulk

This endpoint creates and updates conversions. Your request will be processed asynchronously. It can take up to 1 hour until the request is processed and updates are made in the database.

Body parameter

{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","user":{"user_email":"user@example.com"},"type":"offline","status":"in_progress","created":"2018-01-01T20:00:00.000+01:00","updated":"2018-01-01T20:00:00.000+01:00","acknowledged":true,"currency":"EUR","comment":"Package needs to be smaller than 30cm by 30cm","billing_address":{"country":"France","iso_country_code":"FR","country_code":"FRA","region":"Ile-de-France","locality":"Paris","postal_code":"75009","recipient":"Commanders Act","street_address":"3-5 Rue Saint-Georges","full_address":null,"label":"home","coordinates":{"latitude":48.857764,"longitude":2.33935}},"contact_address":{"country":"France","iso_country_code":"FR","country_code":"FRA","region":"Ile-de-France","locality":"Paris","postal_code":"75009","recipient":"Commanders Act","street_address":"3-5 Rue Saint-Georges","full_address":null,"label":"home","coordinates":{"latitude":48.857764,"longitude":2.33935}},"shipping_address":{"country":"France","iso_country_code":"FR","country_code":"FRA","region":"Ile-de-France","locality":"Paris","postal_code":"75009","recipient":"Commanders Act","street_address":"3-5 Rue Saint-Georges","full_address":null,"label":"home","coordinates":{"latitude":48.857764,"longitude":2.33935}},"shipping_provider":"UPS","shipping_tracking_code":"702c7a16-2c3d-4946-bb35-69ba540773f6","payment_method":"card","original_quantity":3,"cancelled_quantity":1,"returned_quantity":1,"exchanged_quantity":0,"final_quantity":1,"original_amount":30,"cancelled_amount":10,"returned_amount":10,"exchanged_amount":0,"shipping_amount":0,"discount_amount":0,"tax_amount":5,"final_amount":10,"custom":{"internal_reference":"fa34dc2","referer":"user@example.com","website_version":"2.4"},"conversion_items":[{"id":"68cd1310-4b7a-454c-99fb-2510f0e156ec","original_quantity":3,"cancelled_quantity":1,"returned_quantity":1,"exchanged_quantity":0,"final_quantity":1,"original_amount":30,"cancelled_amount":10,"returned_amount":10,"exchanged_amount":0,"final_amount":10,"price":10,"original_item":true,"custom":{"remarketing_campaign":"christmas_2018","time_to_checkout":"25 minutes","ab_testing_group":"3245fcda"},"product":{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","name":"Mug Commanders Act","description":"White stoneware mug with C-Handle is the perfect cup for any beverage","category_1":"Home","category_2":"Kitchen","category_3":"Accessories","category_4":"Containers","category_5":"Mugs","tags":["mugs","handle","white","brand"],"condition":"new","availability":"in_stock","availability_date":"2019-02-06T17:41:31.427+01:00","expiration_date":"2019-02-06T17:41:31.427+01:00","price":10,"sale_price":8,"currency":"EUR","image_link":"https://commandersact.com/images/shopping/mug_hi_res.jpg","link":"https://commandersact.com/shopping/mug","brand":"Commanders Act","width":6.4,"length":7.3,"height":9.5,"weight":80.7,"size":"medium","colors":["white","red"],"gtin":"134588842456789000","mpn":"134588842","custom":{"internal_category_id":721,"warehouse":"building B","box_barcode":1830135586179}}},{"id":"68cd1310-4b7a-454c-99fb-2510f0e156ec","original_quantity":3,"cancelled_quantity":1,"returned_quantity":1,"exchanged_quantity":0,"final_quantity":1,"original_amount":30,"cancelled_amount":10,"returned_amount":10,"exchanged_amount":0,"final_amount":10,"price":10,"original_item":true,"custom":{"remarketing_campaign":"christmas_2018","time_to_checkout":"25 minutes","ab_testing_group":"3245fcda"},"product":{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","name":"Mug Commanders Act","description":"White stoneware mug with C-Handle is the perfect cup for any beverage","category_1":"Home","category_2":"Kitchen","category_3":"Accessories","category_4":"Containers","category_5":"Mugs","tags":["mugs","handle","white","brand"],"condition":"new","availability":"in_stock","availability_date":"2019-02-06T17:41:31.427+01:00","expiration_date":"2019-02-06T17:41:31.427+01:00","price":10,"sale_price":8,"currency":"EUR","image_link":"https://commandersact.com/images/shopping/mug_hi_res.jpg","link":"https://commandersact.com/shopping/mug","brand":"Commanders Act","width":6.4,"length":7.3,"height":9.5,"weight":80.7,"size":"medium","colors":["white","red"],"gtin":"134588842456789000","mpn":"134588842","custom":{"internal_category_id":721,"warehouse":"building B","box_barcode":1830135586179}}}]}
{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","user":{"user_email":"user@example.com"},"type":"offline","status":"in_progress","created":"2018-01-01T20:00:00.000+01:00","updated":"2018-01-01T20:00:00.000+01:00","acknowledged":true,"currency":"EUR","comment":"Package needs to be smaller than 30cm by 30cm","billing_address":{"country":"France","iso_country_code":"FR","country_code":"FRA","region":"Ile-de-France","locality":"Paris","postal_code":"75009","recipient":"Commanders Act","street_address":"3-5 Rue Saint-Georges","full_address":null,"label":"home","coordinates":{"latitude":48.857764,"longitude":2.33935}},"contact_address":{"country":"France","iso_country_code":"FR","country_code":"FRA","region":"Ile-de-France","locality":"Paris","postal_code":"75009","recipient":"Commanders Act","street_address":"3-5 Rue Saint-Georges","full_address":null,"label":"home","coordinates":{"latitude":48.857764,"longitude":2.33935}},"shipping_address":{"country":"France","iso_country_code":"FR","country_code":"FRA","region":"Ile-de-France","locality":"Paris","postal_code":"75009","recipient":"Commanders Act","street_address":"3-5 Rue Saint-Georges","full_address":null,"label":"home","coordinates":{"latitude":48.857764,"longitude":2.33935}},"shipping_provider":"UPS","shipping_tracking_code":"702c7a16-2c3d-4946-bb35-69ba540773f6","payment_method":"card","original_quantity":3,"cancelled_quantity":1,"returned_quantity":1,"exchanged_quantity":0,"final_quantity":1,"original_amount":30,"cancelled_amount":10,"returned_amount":10,"exchanged_amount":0,"shipping_amount":0,"discount_amount":0,"tax_amount":5,"final_amount":10,"custom":{"internal_reference":"fa34dc2","referer":"user@example.com","website_version":"2.4"},"conversion_items":[{"id":"68cd1310-4b7a-454c-99fb-2510f0e156ec","original_quantity":3,"cancelled_quantity":1,"returned_quantity":1,"exchanged_quantity":0,"final_quantity":1,"original_amount":30,"cancelled_amount":10,"returned_amount":10,"exchanged_amount":0,"final_amount":10,"price":10,"original_item":true,"custom":{"remarketing_campaign":"christmas_2018","time_to_checkout":"25 minutes","ab_testing_group":"3245fcda"},"product":{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","name":"Mug Commanders Act","description":"White stoneware mug with C-Handle is the perfect cup for any beverage","category_1":"Home","category_2":"Kitchen","category_3":"Accessories","category_4":"Containers","category_5":"Mugs","tags":["mugs","handle","white","brand"],"condition":"new","availability":"in_stock","availability_date":"2019-02-06T17:41:31.427+01:00","expiration_date":"2019-02-06T17:41:31.427+01:00","price":10,"sale_price":8,"currency":"EUR","image_link":"https://commandersact.com/images/shopping/mug_hi_res.jpg","link":"https://commandersact.com/shopping/mug","brand":"Commanders Act","width":6.4,"length":7.3,"height":9.5,"weight":80.7,"size":"medium","colors":["white","red"],"gtin":"134588842456789000","mpn":"134588842","custom":{"internal_category_id":721,"warehouse":"building B","box_barcode":1830135586179}}},{"id":"68cd1310-4b7a-454c-99fb-2510f0e156ec","original_quantity":3,"cancelled_quantity":1,"returned_quantity":1,"exchanged_quantity":0,"final_quantity":1,"original_amount":30,"cancelled_amount":10,"returned_amount":10,"exchanged_amount":0,"final_amount":10,"price":10,"original_item":true,"custom":{"remarketing_campaign":"christmas_2018","time_to_checkout":"25 minutes","ab_testing_group":"3245fcda"},"product":{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","name":"Mug Commanders Act","description":"White stoneware mug with C-Handle is the perfect cup for any beverage","category_1":"Home","category_2":"Kitchen","category_3":"Accessories","category_4":"Containers","category_5":"Mugs","tags":["mugs","handle","white","brand"],"condition":"new","availability":"in_stock","availability_date":"2019-02-06T17:41:31.427+01:00","expiration_date":"2019-02-06T17:41:31.427+01:00","price":10,"sale_price":8,"currency":"EUR","image_link":"https://commandersact.com/images/shopping/mug_hi_res.jpg","link":"https://commandersact.com/shopping/mug","brand":"Commanders Act","width":6.4,"length":7.3,"height":9.5,"weight":80.7,"size":"medium","colors":["white","red"],"gtin":"134588842456789000","mpn":"134588842","custom":{"internal_category_id":721,"warehouse":"building B","box_barcode":1830135586179}}}]}
{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","user":{"user_email":"user@example.com"},"type":"offline","status":"in_progress","created":"2018-01-01T20:00:00.000+01:00","updated":"2018-01-01T20:00:00.000+01:00","acknowledged":true,"currency":"EUR","comment":"Package needs to be smaller than 30cm by 30cm","billing_address":{"country":"France","iso_country_code":"FR","country_code":"FRA","region":"Ile-de-France","locality":"Paris","postal_code":"75009","recipient":"Commanders Act","street_address":"3-5 Rue Saint-Georges","full_address":null,"label":"home","coordinates":{"latitude":48.857764,"longitude":2.33935}},"contact_address":{"country":"France","iso_country_code":"FR","country_code":"FRA","region":"Ile-de-France","locality":"Paris","postal_code":"75009","recipient":"Commanders Act","street_address":"3-5 Rue Saint-Georges","full_address":null,"label":"home","coordinates":{"latitude":48.857764,"longitude":2.33935}},"shipping_address":{"country":"France","iso_country_code":"FR","country_code":"FRA","region":"Ile-de-France","locality":"Paris","postal_code":"75009","recipient":"Commanders Act","street_address":"3-5 Rue Saint-Georges","full_address":null,"label":"home","coordinates":{"latitude":48.857764,"longitude":2.33935}},"shipping_provider":"UPS","shipping_tracking_code":"702c7a16-2c3d-4946-bb35-69ba540773f6","payment_method":"card","original_quantity":3,"cancelled_quantity":1,"returned_quantity":1,"exchanged_quantity":0,"final_quantity":1,"original_amount":30,"cancelled_amount":10,"returned_amount":10,"exchanged_amount":0,"shipping_amount":0,"discount_amount":0,"tax_amount":5,"final_amount":10,"custom":{"internal_reference":"fa34dc2","referer":"user@example.com","website_version":"2.4"},"conversion_items":[{"id":"68cd1310-4b7a-454c-99fb-2510f0e156ec","original_quantity":3,"cancelled_quantity":1,"returned_quantity":1,"exchanged_quantity":0,"final_quantity":1,"original_amount":30,"cancelled_amount":10,"returned_amount":10,"exchanged_amount":0,"final_amount":10,"price":10,"original_item":true,"custom":{"remarketing_campaign":"christmas_2018","time_to_checkout":"25 minutes","ab_testing_group":"3245fcda"},"product":{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","name":"Mug Commanders Act","description":"White stoneware mug with C-Handle is the perfect cup for any beverage","category_1":"Home","category_2":"Kitchen","category_3":"Accessories","category_4":"Containers","category_5":"Mugs","tags":["mugs","handle","white","brand"],"condition":"new","availability":"in_stock","availability_date":"2019-02-06T17:41:31.427+01:00","expiration_date":"2019-02-06T17:41:31.427+01:00","price":10,"sale_price":8,"currency":"EUR","image_link":"https://commandersact.com/images/shopping/mug_hi_res.jpg","link":"https://commandersact.com/shopping/mug","brand":"Commanders Act","width":6.4,"length":7.3,"height":9.5,"weight":80.7,"size":"medium","colors":["white","red"],"gtin":"134588842456789000","mpn":"134588842","custom":{"internal_category_id":721,"warehouse":"building B","box_barcode":1830135586179}}},{"id":"68cd1310-4b7a-454c-99fb-2510f0e156ec","original_quantity":3,"cancelled_quantity":1,"returned_quantity":1,"exchanged_quantity":0,"final_quantity":1,"original_amount":30,"cancelled_amount":10,"returned_amount":10,"exchanged_amount":0,"final_amount":10,"price":10,"original_item":true,"custom":{"remarketing_campaign":"christmas_2018","time_to_checkout":"25 minutes","ab_testing_group":"3245fcda"},"product":{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","name":"Mug Commanders Act","description":"White stoneware mug with C-Handle is the perfect cup for any beverage","category_1":"Home","category_2":"Kitchen","category_3":"Accessories","category_4":"Containers","category_5":"Mugs","tags":["mugs","handle","white","brand"],"condition":"new","availability":"in_stock","availability_date":"2019-02-06T17:41:31.427+01:00","expiration_date":"2019-02-06T17:41:31.427+01:00","price":10,"sale_price":8,"currency":"EUR","image_link":"https://commandersact.com/images/shopping/mug_hi_res.jpg","link":"https://commandersact.com/shopping/mug","brand":"Commanders Act","width":6.4,"length":7.3,"height":9.5,"weight":80.7,"size":"medium","colors":["white","red"],"gtin":"134588842456789000","mpn":"134588842","custom":{"internal_category_id":721,"warehouse":"building B","box_barcode":1830135586179}}}]}

Parameters

Name

Type

Required

Description

Authorization

header

string

true

Authorization token

overwrite

query

boolean

false

Determines if conversions should be fully replaced (true) or partially updated (false - default).

body

true

Conversions as newline delimited JSON strings

Overwrite Parameter Behavior

The overwrite url parameter determines how conversions are processed when an existing id is found:

false (default):
- Only the specified fields will be updated.
- Unspecified fields will retain their existing values.
true:
- The existing conversion will be fully replaced with the new data provided.

If you need to replace a conversion entirely, set overwrite=true.

Example responses

202 Response

{
  "data": {
    "accepted_object_count": 4,
    "rejected_object_count": 0
  }
}

400 Cannot parse nd-json line

{
  "errors": [
    {
      "code": "PARSE_ERROR",
      "detail": "Cannot parse nd-json"
    }
  ],
  "data": {}
}

400 Missing required property

{
  "errors": [
    {
      "code": "MISSING_REQUIRED_PROPERTY",
      "detail": "should have required property 'id'\n",
      "meta": {
        "line_numbers": [
          34,
          45
        ],
        "error_count": 2,
        "ids": [
          "c9017b85-8016-4f13-88b4-18d57c67b866",
          "12e0c3cb-7e8d-462f-9232-f7c61a900738"
        ]
      }
    }
  ],
  "data": {
    "accepted_object_count": 4,
    "rejected_object_count": 2
  }
}

400 Invalid property type

{
  "errors": [
    {
      "code": "INVALID_PROPERTY_TYPE",
      "detail": "\"original_amount\" property is not a number",
      "meta": {
        "property": "original_amount",
        "line_numbers": [
          34,
          45
        ],
        "error_count": 2,
        "ids": [
          "c9017b85-8016-4f13-88b4-18d57c67b866",
          "12e0c3cb-7e8d-462f-9232-f7c61a900738"
        ]
      }
    }
  ],
  "data": {
    "accepted_object_count": 4,
    "rejected_object_count": 2
  }
}

400 Invalid property format

{
  "errors": [
    {
      "code": "INVALID_PROPERTY_FORMAT",
      "detail": "\"original_amount\" property is not a number",
      "meta": {
        "property": "original_amount",
        "line_numbers": [
          34,
          45
        ],
        "error_count": 2,
        "ids": [
          "c9017b85-8016-4f13-88b4-18d57c67b866",
          "12e0c3cb-7e8d-462f-9232-f7c61a900738"
        ]
      }
    }
  ],
  "data": {
    "accepted_object_count": 4,
    "rejected_object_count": 2
  }
}

401 Authorization header is missing

{
  "errors": [
    {
      "code": "MISSING_AUTHORIZATION_HEADER",
      "detail": "The \"Authorization\" header is required"
    }
  ]
}

401 Token type is missing

{
  "errors": [
    {
      "code": "UNKNOWN_TOKEN_TYPE",
      "detail": "The token type is missing"
    }
  ]
}

401 The token type is invalid

{
  "errors": [
    {
      "code": "INVALID_TOKEN_TYPE",
      "detail": "The token type \"Bear\" is invalid. Expecting \"Bearer\" instead"
    }
  ]
}

401 The provided token is unknown

{
  "errors": [
    {
      "code": "UNKNOWN_TOKEN",
      "detail": "The provided token is unknown. Please contact our support team support@commandersact.com"
    }
  ]
}

403 Response

{
  "errors": [
    {
      "code": "SITE_ACCESS_FORBIDDEN",
      "detail": "You cannot access this site"
    }
  ]
}

Too Many Requests

{
  "description": "You have too many open connections",
  "errors": [
    {
      "code": "CONNECTION_LIMIT_REACHED",
      "detail": "Your account is limited to 30 simultaneous connections"
    }
  ]
}

{
  "description": "You have reached the request limit",
  "errors": [
    {
      "code": "REQUEST_LIMIT_REACHED",
      "detail": "Your account is limited to 30 requests per second"
    }
  ]
}

500 Response

{
  "errors": [
    {
      "code": "SERVER_ERROR",
      "detail": "An internal error occurred. Please contact our support team support@commandersact.com"
    }
  ]
}

Responses

Status

Meaning

Description

Schema

202

All objects are accepted for processing

None

400

Cannot process request or part of the request due to client error

None

401

Cannot identify the API caller

None

403

API caller does not have access to this resource

None

429

Too Many Requests

None

500

Internal server error

None

Response Schema

Upsert products

Code samples

POST https://api.commander1.com/v2/{siteId}/products/bulk HTTP/1.1
Host: api.commander1.com
Content-Type: application/x-ndjson

Authorization: Bearer NJtcKaoCYu...mGZDxRgMBMUw==

POST /products/bulk

This endpoint creates and updates products. Your request will be processed asynchronously. It can take up to 24 hours until the request is processed and updates are made in the database.

Body parameter

{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","name":"Mug Commanders Act","description":"White stoneware mug with C-Handle is the perfect cup for any beverage","category_1":"Home","category_2":"Kitchen","category_3":"Accessories","category_4":"Containers","category_5":"Mugs","tags":["mugs","handle","white","brand"],"condition":"new","availability":"in_stock","availability_date":"2019-02-06T17:41:31.427+01:00","expiration_date":"2019-02-06T17:41:31.427+01:00","price":10,"sale_price":8,"currency":"EUR","image_link":"https://commandersact.com/images/shopping/mug_hi_res.jpg","link":"https://commandersact.com/shopping/mug","brand":"Commanders Act","width":6.4,"length":7.3,"height":9.5,"weight":80.7,"size":"medium","colors":["white","red"],"gtin":"134588842456789000","mpn":"134588842","custom":{"internal_category_id":721,"warehouse":"building B","box_barcode":1830135586179}}
{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","name":"Mug Commanders Act","description":"White stoneware mug with C-Handle is the perfect cup for any beverage","category_1":"Home","category_2":"Kitchen","category_3":"Accessories","category_4":"Containers","category_5":"Mugs","tags":["mugs","handle","white","brand"],"condition":"new","availability":"in_stock","availability_date":"2019-02-06T17:41:31.427+01:00","expiration_date":"2019-02-06T17:41:31.427+01:00","price":10,"sale_price":8,"currency":"EUR","image_link":"https://commandersact.com/images/shopping/mug_hi_res.jpg","link":"https://commandersact.com/shopping/mug","brand":"Commanders Act","width":6.4,"length":7.3,"height":9.5,"weight":80.7,"size":"medium","colors":["white","red"],"gtin":"134588842456789000","mpn":"134588842","custom":{"internal_category_id":721,"warehouse":"building B","box_barcode":1830135586179}}
{"id":"db050bb1-810d-4420-a6fb-c1ce472a4ca9","name":"Mug Commanders Act","description":"White stoneware mug with C-Handle is the perfect cup for any beverage","category_1":"Home","category_2":"Kitchen","category_3":"Accessories","category_4":"Containers","category_5":"Mugs","tags":["mugs","handle","white","brand"],"condition":"new","availability":"in_stock","availability_date":"2019-02-06T17:41:31.427+01:00","expiration_date":"2019-02-06T17:41:31.427+01:00","price":10,"sale_price":8,"currency":"EUR","image_link":"https://commandersact.com/images/shopping/mug_hi_res.jpg","link":"https://commandersact.com/shopping/mug","brand":"Commanders Act","width":6.4,"length":7.3,"height":9.5,"weight":80.7,"size":"medium","colors":["white","red"],"gtin":"134588842456789000","mpn":"134588842","custom":{"internal_category_id":721,"warehouse":"building B","box_barcode":1830135586179}}

Parameters

Name

Type

Required

Description

Authorization

header

string

true

Authorization token

body

true

Products as newline delimited JSON strings

Responses

Status

Meaning

Description

Schema

202

Accepted

None

207

Multi-Status

None

401

Unauthorized

None

405

Invalid input

None

Schemas

Conversion

{
  "id": "db050bb1-810d-4420-a6fb-c1ce472a4ca9",
  "user": {
    "email": "user@example.com", 
    "consent_categories": [1,3]
  },
  "type": "offline",
  "status": "in_progress",
  "created": "2018-01-01T20:00:00.000+01:00",
  "updated": "2018-01-01T20:00:00.000+01:00",
  "acknowledged": true,
  "currency": "EUR",
  "comment": "Package needs to be smaller than 30cm by 30cm",
  "billing_address": {
    "country": "France",
    "iso_country_code": "FR",
    "country_code": "FRA",
    "region": "Ile-de-France",
    "locality": "Paris",
    "postal_code": "75009",
    "recipient": "Commanders Act",
    "street_address": "3-5 Rue Saint-Georges",
    "full_address": null,
    "label": "home",
    "coordinates": {
      "latitude": 48.857764,
      "longitude": 2.33935
    }
  },
  "contact_address": {
    "country": "France",
    "iso_country_code": "FR",
    "country_code": "FRA",
    "region": "Ile-de-France",
    "locality": "Paris",
    "postal_code": "75009",
    "recipient": "Commanders Act",
    "street_address": "3-5 Rue Saint-Georges",
    "full_address": null,
    "label": "home",
    "coordinates": {
      "latitude": 48.857764,
      "longitude": 2.33935
    }
  },
  "shipping_address": {
    "country": "France",
    "iso_country_code": "FR",
    "country_code": "FRA",
    "region": "Ile-de-France",
    "locality": "Paris",
    "postal_code": "75009",
    "recipient": "Commanders Act",
    "street_address": "3-5 Rue Saint-Georges",
    "full_address": null,
    "label": "home",
    "coordinates": {
      "latitude": 48.857764,
      "longitude": 2.33935
    }
  },
  "shipping_provider": "UPS",
  "shipping_tracking_code": "702c7a16-2c3d-4946-bb35-69ba540773f6",
  "payment_method": "card",
  "original_quantity": 3,
  "cancelled_quantity": 1,
  "returned_quantity": 1,
  "exchanged_quantity": 0,
  "final_quantity": 1,
  "original_amount": 30,
  "cancelled_amount": 10,
  "returned_amount": 10,
  "exchanged_amount": 0,
  "shipping_amount": 0,
  "discount_amount": 0,
  "tax_amount": 5,
  "final_amount": 10,
  "custom": {
    "internal_reference": "fa34dc2",
    "referer": "user@example.com",
    "website_version": "2.4"
  },
  "conversion_items": [
    {
      "id": "68cd1310-4b7a-454c-99fb-2510f0e156ec",
      "original_quantity": 3,
      "cancelled_quantity": 1,
      "returned_quantity": 1,
      "exchanged_quantity": 0,
      "final_quantity": 1,
      "original_amount": 30,
      "cancelled_amount": 10,
      "returned_amount": 10,
      "exchanged_amount": 0,
      "final_amount": 10,
      "price": 10,
      "original_item": true,
      "custom": {
        "remarketing_campaign": "christmas_2018",
        "time_to_checkout": "25 minutes",
        "ab_testing_group": "3245fcda"
      },
      "product": {
        "id": "db050bb1-810d-4420-a6fb-c1ce472a4ca9",
        "name": "Mug Commanders Act",
        "description": "White stoneware mug with C-Handle is the perfect cup for any beverage",
        "category_1": "Home",
        "category_2": "Kitchen",
        "category_3": "Accessories",
        "category_4": "Containers",
        "category_5": "Mugs",
        "tags": [
          "mugs",
          "handle",
          "white",
          "brand"
        ],
        "condition": "new",
        "availability": "in_stock",
        "availability_date": "2019-02-06T17:41:31.427+01:00",
        "expiration_date": "2019-02-06T17:41:31.427+01:00",
        "price": 10,
        "sale_price": 8,
        "currency": "EUR",
        "image_link": "https://commandersact.com/images/shopping/mug_hi_res.jpg",
        "link": "https://commandersact.com/shopping/mug",
        "brand": "Commanders Act",
        "width": 6.4,
        "length": 7.3,
        "height": 9.5,
        "weight": 80.7,
        "size": "medium",
        "colors": [
          "white",
          "red"
        ],
        "gtin": "134588842456789000",
        "mpn": "134588842",
        "custom": {
          "internal_category_id": 721,
          "warehouse": "building B",
          "box_barcode": 1830135586179
        }
      }
    },
    {
      "id": "68cd1310-4b7a-454c-99fb-2510f0e156ec",
      "original_quantity": 3,
      "cancelled_quantity": 1,
      "returned_quantity": 1,
      "exchanged_quantity": 0,
      "final_quantity": 1,
      "original_amount": 30,
      "cancelled_amount": 10,
      "returned_amount": 10,
      "exchanged_amount": 0,
      "final_amount": 10,
      "price": 10,
      "original_item": true,
      "custom": {
        "remarketing_campaign": "christmas_2018",
        "time_to_checkout": "25 minutes",
        "ab_testing_group": "3245fcda"
      },
      "product": {
        "id": "db050bb1-810d-4420-a6fb-c1ce472a4ca9",
        "name": "Mug Commanders Act",
        "description": "White stoneware mug with C-Handle is the perfect cup for any beverage",
        "category_1": "Home",
        "category_2": "Kitchen",
        "category_3": "Accessories",
        "category_4": "Containers",
        "category_5": "Mugs",
        "tags": [
          "mugs",
          "handle",
          "white",
          "brand"
        ],
        "condition": "new",
        "availability": "in_stock",
        "availability_date": "2019-02-06T17:41:31.427+01:00",
        "expiration_date": "2019-02-06T17:41:31.427+01:00",
        "price": 10,
        "sale_price": 8,
        "currency": "EUR",
        "image_link": "https://commandersact.com/images/shopping/mug_hi_res.jpg",
        "link": "https://commandersact.com/shopping/mug",
        "brand": "Commanders Act",
        "width": 6.4,
        "length": 7.3,
        "height": 9.5,
        "weight": 80.7,
        "size": "medium",
        "colors": [
          "white",
          "red"
        ],
        "gtin": "134588842456789000",
        "mpn": "134588842",
        "custom": {
          "internal_category_id": 721,
          "warehouse": "building B",
          "box_barcode": 1830135586179
        }
      }
    }
  ]
}

It is recommended to use as many fields as you can in order to be able to build good segments with advanced conditions

Properties

Name

Type

Required

Restrictions

Description

string(1-50)

true

none

Conversion id. Used as key for updates

user

object

true

none

All properties that you add here will be used as conditions for matching users in our database. You must ensure that values used inside these properties are unique. Use same property names as those defined in variables interface for the user.

» user.email

string(1-250)

false

none

Email of the user

»user.consent_categories

string

false

none

Consent categories of the user, to be allowed to share conversions with partners

type

string(1-250)

true

none

Type of conversion (online, offline, call etc.)

status

string

true

none

Status of your conversion (see list of possible values below). Conversions with status "pending" are not included in default sum and counts aggregated on a user.

created

string(ISO-8601)

true

none

Time when conversion occurred. See "Date formats" section above for a list of allowed formats.

updated

string(ISO-8601)

false

none

Time when conversion was updated. See "Date formats" section above for a list of allowed formats.

acknowledged

boolean

false

none

Set to true if conversion was acknowledged

currency

string(ISO-4217)

true

none

Currency

comment

string(1-250)

false

none

Comment of the buyer

billing_address

false

none

It is recommended to use as many fields as you can in order to be able to build good segments with advanced conditions

contact_address

false

none

It is recommended to use as many fields as you can in order to be able to build good segments with advanced conditions

shipping_address

false

none

It is recommended to use as many fields as you can in order to be able to build good segments with advanced conditions

shipping_provider

string(1-250)

false

none

Shipping provider

shipping_tracking_code

string(1-250)

false

none

Shipping tracking code

payment_method

string

false

none

Payment method type (see list of possible values below)

payment_provider

string

false

none

Payment provider used for this transaction

original_quantity

float

false

read-only

Sum of all articles in the original conversion (CALCULATED)

cancelled_quantity

float

false

read-only

Quantity of cancelled articles in the conversion (CALCULATED)

returned_quantity

float

false

read-only

Quantity of returned articles in the conversion (CALCULATED)

exchanged_quantity

float

false

read-only

Quantity of exchanged articles in the conversion (CALCULATED)

final_quantity

float

false

read-only

Quantity of articles in final transaction for this conversion (original_quantity - cancelled_quantity - returned_quantity - exchanged_quantity) (CALCULATED)

original_amount

float

false

write-once

Original amount for this conversion (shipping price and taxes included)

cancelled_amount

float

false

none

Cancelled amount for this conversion

returned_amount

float

false

none

Returned amount for this conversion

exchanged_amount

float

false

none

Exchanged amount for this conversion

shipping_amount

float

false

none

Shipping amount for this conversion

discount_amount

float

false

none

Discount amount for this conversion

tax_amount

float

false

none

Tax amount for this conversion

final_amount

float

false

none

Final amount for this conversion after returns, exchanges, cancellations etc. (shipping price and taxes included). This represents the overall transaction amount between the buyer and the seller

custom

object

false

none

Object containing custom properties

conversion_items

true

none

List of products in the conversion + their own attributes. You cannot have the same product twice inside a conversion unless you provide a conversion item id

Enumerated Values

Property

Value

status

canceled

status

delivered

status

in_progress

status

partially_delivered

status

partially_returned

status

partially_shipped

status

pending_shipment

status

returned

status

shipped

status

pending

payment_method

by_bank_transfer_in_advance

payment_method

by_invoice

payment_method

card

payment_method

check_in_advance

payment_method

cod

payment_method

coupon

payment_method

direct_debit

payment_method

online_payment_system

payment_method

other

ConversionItem

{
  "id": "68cd1310-4b7a-454c-99fb-2510f0e156ec",
  "original_quantity": 3,
  "cancelled_quantity": 1,
  "returned_quantity": 1,
  "exchanged_quantity": 0,
  "final_quantity": 1,
  "original_amount": 30,
  "cancelled_amount": 10,
  "returned_amount": 10,
  "exchanged_amount": 0,
  "final_amount": 10,
  "price": 10,
  "original_item": true,
  "custom": {
    "remarketing_campaign": "christmas_2018",
    "time_to_checkout": "25 minutes",
    "ab_testing_group": "3245fcda"
  },
  "product": {
    "id": "db050bb1-810d-4420-a6fb-c1ce472a4ca9",
    "name": "Mug Commanders Act",
    "description": "White stoneware mug with C-Handle is the perfect cup for any beverage",
    "category_1": "Home",
    "category_2": "Kitchen",
    "category_3": "Accessories",
    "category_4": "Containers",
    "category_5": "Mugs",
    "tags": [
      "mugs",
      "handle",
      "white",
      "brand"
    ],
    "condition": "new",
    "availability": "in_stock",
    "availability_date": "2019-02-06T17:41:31.427+01:00",
    "expiration_date": "2019-02-06T17:41:31.427+01:00",
    "price": 10,
    "sale_price": 8,
    "currency": "EUR",
    "image_link": "https://commandersact.com/images/shopping/mug_hi_res.jpg",
    "link": "https://commandersact.com/shopping/mug",
    "brand": "Commanders Act",
    "width": 6.4,
    "length": 7.3,
    "height": 9.5,
    "weight": 80.7,
    "size": "medium",
    "colors": [
      "white",
      "red"
    ],
    "gtin": "134588842456789000",
    "mpn": "134588842",
    "custom": {
      "internal_category_id": 721,
      "warehouse": "building B",
      "box_barcode": 1830135586179
    }
  }
}

It is recommended to use as many fields as you can in order to be able to build good segments with advanced conditions

Properties

Name

Type

Required

Restrictions

Description

string

true

none

Id of this item in the conversion. This id is required. If you don't have an item id in your database and the same product id cannot repeat within a conversion you can use the product id as value. This field is used for identifying the item in updates.

original_quantity

float

true

none

Quantity of items in the original conversion

cancelled_quantity

float

false

none

Quantity of cancelled items

returned_quantity

float

false

none

Quantity of returned items

exchanged_quantity

float

false

none

Quantity of exchanged items

final_quantity

float

false

none

Quantity of items in final transaction (original_quantity - cancelled_quantity - returned_quantity - exchanged_quantity)

original_amount

float

false

none

Original amount for this item

cancelled_amount

float

false

none

Cancelled amount for this item

returned_amount

float

false

none

Returned amount for this item

exchanged_amount

float

false

none

Exchanged amount for this item

final_amount

float

false

none

Final amount for this item (original_amount - cancelled_amount - returned_amount - exchanged_amount)

price

float

false

none

Price of item (using same currency as for conversion)

original_item

boolean

false

none

Wether this item was present in the original conversion. This is automatically set to false to all items added in conversion updates

custom

object

false

none

Object containing custom properties

product

true

none

There are three ways to have product information in your conversion items. First method is to put product properties inline for each conversion item. Second method is to synchronize your product catalog with our database using "POST /products/bulk" endpoint and only send product ids in conversion items (our server will copy product properties from catalog). Third method is a combination of previous ones and implies having a product catalog and send the product information inline. In case a property is present in both catalog product and inline product, properties from inline product will overwrite properties from catalog. This method is useful when product information is incomplete or complementary in inline products. It is recommended to send products inline, except when you do not have all product information. In most cases you don't need to use the catalog. It is recommended to use as many fields as you can in order to be able to build good segments with advanced conditions. When you only send the id of the product in a conversion item, you need to make sure that your catalog already contains the product, otherwise product properties will not be added to your conversion item.

Address

{
  "country": "France",
  "iso_country_code": "FR",
  "country_code": "FRA",
  "region": "Ile-de-France",
  "locality": "Paris",
  "postal_code": "75009",
  "recipient": "Commanders Act",
  "street_address": "3-5 Rue Saint-Georges",
  "full_address": null,
  "label": "home",
  "coordinates": {
    "latitude": 48.857764,
    "longitude": 2.33935
  }
}

It is recommended to use as many fields as you can in order to be able to build good segments with advanced conditions

Properties

Name

Type

Required

Restrictions

Description

country

string(1-250)

false

none

Readable country name

iso_country_code

string(ISO-3166)

false

none

ISO-3166 country code

country_code

string

false

none

Use this field in case you use country codes other than ISO-3166

region

string(1-250)

false

none

Administrative region

locality

string(1-250)

false

none

Name of city/town/village etc.

postal_code

string(1-250)

false

none

Postal code

recipient

string(1-250)

false

none

Recipient name

street_address

string(1-250)

false

none

Street name, street number, building number etc.

full_address

string(1-250)

false

none

Full address as a string that can contain newlines. Not usable in segmentation but available for exports

label

string(1-250)

false

none

Label for this address (home, work etc.)

coordinates

object

false

none

Coordinates for this address

» latitude

float

false

none

Latitude

» longitude

float

false

none

Longitude

Product

{
  "id": "db050bb1-810d-4420-a6fb-c1ce472a4ca9",
  "name": "Mug Commanders Act",
  "description": "White stoneware mug with C-Handle is the perfect cup for any beverage",
  "category_1": "Home",
  "category_2": "Kitchen",
  "category_3": "Accessories",
  "category_4": "Containers",
  "category_5": "Mugs",
  "tags": [
    "mugs",
    "handle",
    "white",
    "brand"
  ],
  "condition": "new",
  "availability": "in_stock",
  "availability_date": "2019-02-06T17:41:31.427+01:00",
  "expiration_date": "2019-02-06T17:41:31.427+01:00",
  "price": 10,
  "sale_price": 8,
  "currency": "EUR",
  "image_link": "https://commandersact.com/images/shopping/mug_hi_res.jpg",
  "link": "https://commandersact.com/shopping/mug",
  "brand": "Commanders Act",
  "width": 6.4,
  "length": 7.3,
  "height": 9.5,
  "weight": 80.7,
  "size": "medium",
  "colors": [
    "white",
    "red"
  ],
  "gtin": "134588842456789000",
  "mpn": "134588842",
  "custom": {
    "internal_category_id": 721,
    "warehouse": "building B",
    "box_barcode": 1830135586179
  }
}

Properties

Name

Type

Required

Restrictions

Description

string(1-50)

true

none

Unique identifier for the article (try using the most specific identifier or SKU), such as a reference. If there are several occurrences for the same identifier, only the last one will be recorded

name

string(1-500)

false

none

Name of the article

description

string(max 5000 chars)

false

none

Description of the article

category_1

string(1-250)

false

none

Main category of the article

category_2

string(1-250)

false

none

Second sub-category of the article

category_3

string(1-250)

false

none

Third sub-category of the article

category_4

string(1-250)

false

none

Fourth sub-category of the article

category_5

string(1-250)

false

none

Fifth sub-category of the article. If you have more than five levels of category you may choose to concatenate the remaining ones like 'Bikes/Parts/Wheels/Front' or simply ignore the remaining ones like 'Bikes', depending on your segmentation needs.

Web container setup

A web container is a JavaScript file which has two purposes:

· To be able to use native functions & methods of the TMS

· To execute the partners solutions (tags) contained inside

It is possible, as it is often the case, to have several containers for the same site or even the same page.

The URL of each JavaScript Web Container file will be provided alongside the Container IDs and Container Names by a Commanders Act Consultant during the setup process.

Implementation of the containers on the page

Web container are usually installed by implementing a <script> html node on every page of your website that holds a src attribute that points to the Container URL.

The containers can be placed in different locations in the page source’s code depending on their use and your type of business.

Here’s a common example with 3 containers:

<head> container's location is usually used for AB test and should be load synchronously, to prevent flickering effect.

We recommended to implement all <body> containers asynchronously. Simply use the async attribute in the <script> element.

Important : the datalayer must be declared before your containers calls. Otherwise, the tags in the container will not be able to use the variables

Installation of `<head>` Container

<head> Container are used to implement A/B-testing and personalisation Tags that usually impact the visual content of a website before it is presented to the user. Therefore it is important to place them as high as possible in the <head> section of your website.

Please ensure that the <head> Container file is loaded synchronously to avoid potential content flickering effects.

Installation of `<body>` Container

<body> Container are used to implement Tags that measure information. These Containers are therefore placed at the end of the <body> section to make sure they have minimal impact on the loading time of the content of the website.

In contrast to the <head> Container it is possible to implement <body> Container asynchronously. For example it is possible to load them via JavaScript on the onload event of the page or it is possible to use the async attribute in the <script> element.

Installation via JavaScript Loaders

It is possible to implement JavaScript Container files with JavaScript loaders like RequireJS or HeadJS. On the opposite it is not possible to bundle the JavaScript Container files with bundlers like Webpack or ParcelJS to make sure that the Container files are dynamically loaded from the CDN or server on each page request. Otherwise users will not be able to manage Commanders Act Web Container on their own.

Testing

Via Browser Console

It is possible to log all loaded Container files on a site via the JavaScript console of the browser. The JavaScript object tC.containersLaunched provides information of each loaded Web Container.

Following you will find an example object including its most relevant information:

Definitions

Mobile APP

Introduction to mobile app tagging

CommandersAct’s SDK allows you to trigger destinations from a mobile application.

Commanders Act offers a so-called “super light” SDK you can include in your mobile app’s code; its purpose is to reduce calls to partner solutions as much as possible in order to improve your app’s performance and user experience. A unique call is issued to CommandersAct’s servers per action recorded in the app. Information related to the page browsed or the element that is clicked is then sent separately to partner solutions by CommandersAct’s servers; this allows to prevent applications’ loading speed from slowing down.

Note: Not all solutions are compatible with this method. Since the light SDK sends app information to partner solutions’ servers, they cannot “go back” to the app. Adserving solutions (those displaying ads) and push notification providers are thus not compatible with this method.

The basic operational principle of Commanders light SDK is:

– Step 1: the mobile data layer and CommandersAct’s SDK are called in the app’s source code every time the screen loads or that an element is clicked. (your IT staff should have implemented this at the start of the project).

– Step 2: CommandersAct’s SDK issues calls to CommandersAct’s servers and automatically sends the mobile data layer’s contents. This is the server-side hits’ structure: https://collect.commander1.com/events?tc_s=${siteID}&token=${YOUR_SOURCE_KEY}

${siteID} and ${YOUR_SOURCE_KEY} are to be provided to the SDK and will be replaced automatically.

The rest of the parameters are send in the body in POST like presented here:

– Step 3: CommandersAct’s servers send the received information to the different destinations. There are as many outgoing hits as there are partner solutions you wish to send information to.

Ex: if you wish to issue a call to both Criteo and Google, a hit will be sent to either solution’s servers.

Implementing our SDKs on a mobile application is a project that consists of the steps listed hereunder:

Definition of the mobile application’s tagging plan: selection and definition of the events.
Creation of a mobile source and destinations
CommandersAct SDK implementation in the app’s source code.
Acceptance testing of the implementation in a test environment.
Publishing

Step #1: defining the application's tagging plan

The tagging plan corresponds to the list of events that will be sent.

Step #2: creating a mobile source and configuring destinations in the CommandersAct interface

Creating a source for iOS, Android or both.
Implement or select destinations.

Implementing mobile destination is the same as implementing cloud-base destinations

Step #3: implementing the SDK in the applications' source code

The SDK implementation is performed by technical staff or IT departments.

These elements must be provided:

The app’s CommandersAct tagging plan, which lets IT staff know which events to declare and on which screens or elements.
Technical documentation referring to each and every app. It must contain elements that are key to setting up the SDK and screenshots of setup examples.

The site’s ID (Commanders Act account number) and that of the source key are necessary to set-up the SDK. These two elements can be retrieved in the interface.

Step #4: Testing the setup in a test environment

Commanders Act SDK can be tested with many different tools:

Tests for iOS with XCode

Commanders Act SDK for iOS can be tested with Apple’s developing software “XCode”:

You will need to connect your iPhone to your Mac.

Open XCode, go to “Window” ), > “Devices” (2), then select your device in thecolumn to the left (3):

These elements will be displayed when you analyze mobile logs:

Commanders Act SDK’s version number example for consent module: “Commanders Act Privacy module init with version: 5.2.0”
Commanders Act site ID

***

Running tests for Android or iOS with Charles Debugger

The first thing to do is to configure your phone so it can communicate with Charles.

In your phone’s settings, go to the Wi-fi configuration tab.

Select your network and proceed to the advanced options to edit Wi-fi settings.

Add a proxy manually:

Proxy’s name (server)(1): Computer’s IP (you can find it in the “Local IP address” tab from Charles’ options)
Port (2): 8888

Save.

Go to the Charles app and authorize it to connect to the phone.

When you go to the “Request” area, you will be able to see all variables and the corresponding values that are sent through the Commanders Act SDK.

HTTPS Protocol:

Most of the time, server-side calls are issued through an https protocol.

Download the certificate and install it; you will need to enter its name for two applications “VPN and applications” and “Wi-fi”.

Go back to Charles > “SSL proxy settings” > “SSL Proxying” > check “Enable SSL Proxying” > Click “Add” and type “*” in the “Host” field (to authorize any given host).

Then proceed to running tests the same way you do for http hits.

Step #5: publishing

When the implementation is ok on your testing environment, you need to submit your app to app stores (Apple Store or Android Market) and wait for them to approve changes and include the new version in their catalogues.

Internal variables

These variables are called internal variables because they are created inside the Commanders Act web container: They are integrated directly into your site’s container, in contrast with external variables, which are added into the page’s source code by the technical staff.

Internal variables are used to collect data to enrich data through the external variables. A library of predefined internal variables is available, but you can also create your own.

Internal variables must be created in the Commanders Act interface before they can be used in containers. See the rest of the articles in the “internal variables” section to know more about the different options available to create such variables.

All internal variables created can be used:

To be added to the solutions embedded in the container (linking internal variables and solutions is called mapping). See the “Mapping tags’ variables” article to find out how to map your internal variables in a tag.
To create activation rules for your tags. See the “Adding Rules” article to find out how to create rules based on your internal variables.

Additional information

Internal variables are all coded in JavaScript, but you do not need any technical knowledge of JavaScript in order to use the “Predefined” variables or the “Builder” modes, since the code is generated automatically by the Commanders Act. However, you will need to know JavaScript or seek help from the Commanders Act support team in order to create your own custom internal variables.

Here are some examples of predefined internal variables:

Internal variable for retrieving the URL of the page:
Internal variable for retrieving the URL of the previous page/site:
Internal variable for retrieving what comes between the first “/” and second “/” of the URL:

When to add an internal variable

There are several situations in which you may need to create an internal variable using the internal variable management interface:

You want to retrieve elements available on your web pages, but they do not have external variables implemented by technical staff (for example: the value of a cookie, HTML tag, URL, etc.).
You want to create a new variable based on the values of external variables already implemented by technical staff (for example: calculating the cart’s total before tax using the external variable that returns the cart’s total including tax).
You want to create a lookup table based on an external variable (for example: when the external “country” variable is “FR”, you send an account number to your analytics tool that is different from when the variable is “IT”).
Etc.

The link created between the internal variables and the solutions is called “mapping“. This is performed in the “EDIT” tab during the container deployment process.

Types of internal variables

There are two types of internal variables: predefined and custom.

Predefined internal variables, have already been created and are ready to use (e.g. variables that retrieve URL fragments).
You can also configure your own internal variables, using pre-existing variables (e.g. external variables) or retrieving elements available on your sites’ pages (e.g. cookies).

You will then be prompted to select a predefined variable universe.

The “add variable” window contains various fields:

“Predefined universe“: Selection of predefined internal variable categories

“Name“: Variable’s name

“Description“: Variable’s description

“Code“: Variable’s code

Checkbox: The selection of predefined internal variables to add to the container (it is futile to include variables you do not wish to use).

Four predefined variable universes (“Predefined universe”) are available:

Common variables: The most used variables by both Commanders Act consultants and customers.
Customer journey variables: Variables that exploit the visitor’s customer journey (prerequisite: the "deduplication" module must be activated).
AT Internet plugin: Variables that exploit data collected by the AT Internet digital analytics solution (prerequisite: the AT Internet solution must be present on your site).
Partner tags: Code snippets adapted and adaptable to partner tags to increase their potential and perform additional actions.

Add build-in internal common variable

You will find below a list of the variables available in the “Common variables” category and their description

Example:

The value of this variable (on the http://www.tagcommander.com/fr/) page will be “Commanders Act – Tag Universel – Tag Management – Commanders Act”. It takes the value of the html <title> tab.

***

Example:

The value of this variable for the “http://www.tagcommander.com/fr/” page will be “http://www.tagcommander.com/fr/”

***

Previously Visited URL: it stores the URL of the previous page

Example:

If the visitor arrives at the Commanders Act site via the Google search engine, the value of this variable will contain “google.fr”

***

Page URL without query string: it stores the URL of the current page without the tracking parameters (Commanders Act will remove the “?” from the URL and everything after it.

Example:

If the visitor is on the page “https://www.google.fr/webhp?tab=ww&ei=-ATjVPTyFaWqywOpqoHYDw&ved=0CAcQ1S4#q=inurl&start=10″, the value of this variable will be “https://www.google.fr/webhp”

***

Page query string only: it stores the the current page’s URL parameters (Commanders Act a will save everything that follows the “?” without including it).

Example:

If the visitor is on the page “https://www.google.fr/webhp?tab=ww&ei=-ATjVPTyFaWqywOpqoHYDw&ved=0CAcQ1S4#q=inurl&start=10″, the value of this variable will be “tab=ww&ei=-ATjVPTyFaWqywOpqoHYDw&ved=0CAcQ1S4#q=inurl&start=10”

***

URL parameters: it stores the current page’s array of URL parameters.

Example:

If the visitor is on the page “https://www.google.fr/webhp?tab=ww&ei=-ATjVPTyFaWqywOpqoHYDw&ved=0CAcQ1S4#q=inurl&start=10″, this variable will contain the value of these three parameters: “tab”, “ei” and “ved”, and their values will be accessible in the following manner: “tc_array_url_vars[‘tab’]”, “tc_array_url_vars[‘ei’]” and “tc_array_url_vars[‘ved’]”

***

Folder #1 in URL: it stores the First “folder” in the current page’s URL

Example:

If the visitor is on the page “http://www.tagcommander.com/fr/fonctionnalites/tag-management”, the value of this variable will be “fr”.

***

Folder #2 in URL: it stores the second “folder” in the current page’s URL

Example:

If the visitor is on the page “http://www.tagcommander.com/fr/fonctionnalites/tag-management”, the value of this page will be “fonctionnalites”

***

Folder #3 in URL: it stores Third “folder” in the current page’s URL

Example:

If the visitor is on the page “http://www.tagcommander.com/fr/fonctionnalites/tag-management“, the value of this variable will be “tag-management”

***

Random value(integer 9 digits): it creates and stores a random number composed of 9 digits

Example:

With each pageview/loading of this variable, the variable will return a random 9-digit number; for example, “255103492”

***

URL pathname without query string /…/…/….html: it stores the current page’s URL without the parameters (including the “/”)

Example:

If the visitor is on the page “https://www.google.fr/webhp?tab=ww&ei=-ATjVPTyFaWqywOpqoHYDw&ved=0CAcQ1S4#q=inurl&start=10″, the value of this variable will be “/webhp”

***

Https protocol? “yes”/”no”: Sends “yes” if the page uses the “https” protocol and “no” if it does not

Example:

If the visitor is on the page “https://www.google.fr/webhp?tab=ww&ei=-ATjVPTyFaWqywOpqoHYDw&ved=0CAcQ1S4#q=inurl&start=10″, the value of this variable will be “yes”

***

Current domain name (www.domain.com): it stores the current page’s domain name

Example:

If the visitor is on the page “http://www.tagcommander.com/fr/fonctionnalites/tag-management”, the value of this variable will be “www.tagcommander.com”

***

Main domain name without subdomains: it stores the current page’s domain name without the subdomains

Example:

If the visitor is on the page “http://www.tagcommander.com/fr/fonctionnalites/tag-management”, the value of this variable will be “tagcommander.com”

***

Unix timestamp: Current UNIX time (the number of seconds since January 1, 1970 00:00:00)

Example:

The current UNIX time when this document was written was “142166467”

***

Device: This variable provides information regarding a user’s device based on their screen resolution.

Adding built-in customer journey internal variables

You will find below a list of the variables available in the “Customer journey variables” category and their corresponding description:

Last touch name (channel): Channel of the last touchpoint saved (prerequisite: deduplication must be active on your site).

Example:

For customer journey “SEO/Google -> SEM/Bing -> Display/Criteo” the value of this variable will be “Display”.

***

Last touch name (source): Source of the last touchpoint saved (prerequisite: deduplication must be active on your site).

Example :

For customer journey “SEO/Google -> SEM/Bing -> Display/Criteo” the value of this variable will be “Criteo”.

Adding customer internal variables

You can create your own internal variable in two ways:

Via the “Builder” tab: The “Builder” mode assists you in creating customized internal variables without any technical knowledge or expertise;
Via the “Custom” tab: “Custom” is a completely customized mode used to write your own JavaScript code. This method requires technical knowledge and expertise (but your Commanders Act consultant or support team can create custom variables for you if necessary).

“tC.internalvars.“: The variable’s name (caution: it must not contain any accents or special characters, especially “-“).

Note: The variable’s name is always prefixed by “tC.internalvars.” in order to avoid conflict with other variables on your site. For example, to see the content of an internal variable directly on your site or use a variable on another site, do not forget to specify the full name of the variable, which includes the prefix “tC.internalvars.” along with the variable’s name.

“Builder“/”Custom“: Select “Builder” or “Custom” creation mode

Area to create the variable (see details below for the Builder and Custom modes)

“Type“: The type of variable. Please refer to the article “Managing Variable Types“.

“Description“: A description of the variable, to clarify the variable’s name (e.g. “Product IDs separated by a /” can be the description of the variable named “tC.internalvars.concatid”)

“Detailed description“: A detailed description of the variable, to further clarify its name (e.g. “ID1/ID1/ID2…” can be the description of the variable named “tC.internalvars.concatid”)

Builder mode

The “Builder” mode offers you three types of operations (1) that we describe below:

“Join internal and/or external variable(s)”;
“Join two-dimensional array variable(s)”;
“Variable mapping”.

Join internal and/or external variable(s)

This operation allows you to join internal or external variables with the separator of your choice.

Example:

If you wish to join an external variable returning the order ID with another external variable returning the order amount, with everything separated by a “-“, select the “order_id” variable in the “External variables” tab to the left and then enter and add your separator in the “add separator” field in order to finish the “order_amount” variable in the “External variables” tab.

Join two-dimensional array variable(s)

This operation allows you to join the array keys of a “Two dimensional array” variable.

Example:

Your retargeting provider wants you to send all the prices of the products added to the cart separated by “|”. Begin by selecting the variable that contains the product information on the cart page (here the “user_id” variable) (1), then the “order id” variable (here the “order_confirmation_id” key) and the separator “|”. For example, the value obtained might be: “user@mail.com|123456789AB”.

Variable mapping

This operation allows you to create a lookup table for an input value (via an already existing internal or external variable) and an expected output value.

Example:

You want to send a different account ID to your Digital Analytics solution depending on the work environment (pre-prod or prod). Select your reference variable (here the external variable “env_work”), add its different input values in the “INPUT” field (e.g. “pre-prod” et “prod”) and then add the output account IDs of your analytics solution in the “OUTPUT” field. You can also add a default value if none of the values entered in the “INPUT” field have been foundj,yècr èuc.

This operation allows you to automatically send the correct account ID to your analytics solution depending on the work environment.

Full custom mode

Note: make sure that the variable’s JavaScript code always has the following syntax: tC.internalvars.nameVariable = "yourCode";

Also, make sure that nameVariable has the same name as the variable entered in the “tC.internalvars” field (see first screenshot with the variable tC.internalvars.my_custom_var):

Note: To avoid potential errors when the internal variable’s code is included, the “TEST” step of the container deployment process will test your internal variable on multiple browsers/operating systems.

Managing variable types

The variable “type” (also called “processing function“) allows you to modify the variable format on the fly when mapping your tags.

They are useful when one of your solutions requests a variable format different from the format that you return in your internal variable. For example, if your “order_discount” variable contains three decimal places, the processing functions will allow you to correct this so that your solutions receive the value with only 2 decimal places.

The most commonly used types are:

Order amount: this allows you to modify the number format (amount) on the fly.

Alphanumeric & Special chars: this allows you to modify the character string format on the fly.

Once you have mapped your variable, click the link symbol:

Categorizing internal variables

Since you can create a variable using other variables, it is important for you to be able to manage the order in which they are executed so as to avoid any problems.

Therefore, you must declare an internal variable A, on which an internal variable B is based, before variable B. Variable B needs variable A declared first in order to be executed without creating errors.

To categorize an internal variable you must :

Click the edit button (pencil icon to the right in the same row where the internal variable is located) and select the type from the drop down menu as depicted below. This applies only when you add a predefined variable.
Select the type when you add a custom variable, whether with the “Builder” or ‘Full Custom” mode. (Similar window as the one above).

Declare an internal variable in a container

You can link an internal variable to a container if you have multiple containers on your site.

By doing this action, you declare just once the internal variable code in the linked container(s).

Consequences:

You reduce the weight of the other containers by avoiding to declare many times the code of one single internal variable.
If you call 2 containers on the same page, you avoid to overwrite the variable value defined in the first container by the value defined in the second container (if the value can change during the page load)

Example: two containers are on the same page, one in the header and one in the body. If you link an internal variable to the header container you will reduce the code of the page as the variable won’t be declared twice, and keep the value of the variable defined in the header.

To link an internal variable to a container, select the container of your choice when you create or modify your variable in the “Declared in container” field:

To realize a bulk action on multiple variables, check the variables of your choice, then choose the container(s) in the list:

{
    1234: { // Commanders Act Account ID
        1: { // ID of the 1st loaded Container
            g: 15,
            v: "5.15" // Version of the 1st loaded Container
        },
        5: { // ID of the 2nd loaded Container
            g: 20,
            v: "55.16" // Version of the 2nd loaded Container
        }
}

<!doctype html>
<html amp lang=”en”>
<head>
<meta charset=”utf-8″>
<title>Commanders Act – AMP Analytics</title>
<link rel=”canonical” href=”http://example.ampproject.org/article-metadata.html” />
<meta name=”viewport” content=”width=device-width,minimum-scale=1,initial-scale=1″>
<!– Mandatory execution of the AMP Analytics Script “https://cdn.ampproject.org/v0/amp-analytics-0.1.js” –> 
<script async custom-element=”amp-analytics”
src=”https://cdn.ampproject.org/v0/amp-analytics-0.1.js“></script>
<style>body {opacity: 0}</style><noscript><style>body {opacity: 1}</style></noscript>
<script async src=”https://cdn.ampproject.org/v0.js”></script>
</head>
<body
<amp-analytics id=”commandersact”>
<!– JSON data structure containing the TagCommander data layer –> 
<script type=”application/json”>
{
“vars”: {
“tC_SiteID”: “3503”,
“tC_ContainerID”: “1”,
“env_template” : “homepage”,
“env_work” : “prod”,
“env_device” : “m”,
“env_country” : “IT”,
“page_name” : “amp_homepage”,
“user_id” : “”,
“user_newcustomer” : “”,
“order_id” : “”
},
<!– Call to Commanders Act’s API (server-side) –> 
“requests”: {
“tC_BaseURL“: “//serverside${tC_SiteID}.tagcommander.com/${tC_ContainerID}/”,
<!– Page variables mentioned in the “tC_PageTrack” element –> 
“tC_PageTrack“: “${tC_BaseURL}?&env_template=${template}&env_work=${work_environment}&env_device=${device}&env_country=${country}&page_name=${page_name}&user_id=${user_id}&user_newcustomer=${newcustomer}&order_id=${order_id}”,
<!– Event variables mentioned in the “tC_EventTrack” element. Note: “scroll” and other such variables are natively proposed in AMP pages–> 
“tC_EventTrack“: “${tC_PageTrack}&scrollY=${scrollTop}&scrollX=${scrollLeft}&height=${availableScreenHeight}&width=${availableScreenWidth}&scrollBoundV=${verticalScrollBoundary}&scrollBoundH=${horizontalScrollBoundary}${eventLabel}”
},
<!– Additional parameters mentioned in the “extraUrlParams” element. Note: the clientId function creates a unique ID per visitor (different from the regular TCIDs)–> 
“extraUrlParams”: {
“TCID_AMP”: “${clientId(TCID_AMP)}”,
“path”: “${ampdocUrl}”,
“type”: “${type|default:page}”,
“platform”: “AMP”,
“r”: “${random}”
},
<!– Execution of Commanders Act hits on the “triggers” element. “Pageview” sends the hit to the page viewed, the “clickPings” trigger sends the hit to an event defined in the “selector” –>
“triggers”: {
“pageview”: {
“on”: “visible”,
“request”: “tC_PageTrack”,
“vars”: {
“type”: “page”
}
},
“clickPings”: {
“on”: “click”,
“selector”: “.tC_events”,
“request”: “tC_EventTrack”,
“vars”: {
“type”: “event”
}
}
}
}
</script>
</amp-analytics>
<h1 id=”header”>AMP Page</h1>
<!– data-vars-event-label2 allows to collect additional variables, such as event variables –>
<span id=”event-test” class=”tC_events” data-vars-event-label2=”22″>
Click here to generate an event
</span>
</body>

<!doctype html>
<html amp lang=”en”>
<head>
<meta charset=”utf-8″>
<title>Commanders ACT – Serverside – AMP Analytics</title>
<link rel=”canonical” href=”http://example.ampproject.org/article-metadata.html” />
<meta name=”viewport” content=”width=device-width,minimum-scale=1,initial-scale=1″>
<!– Mandatory execution of the AMP iframe script “https://cdn.ampproject.org/v0/amp-iframe-0.1.js ” –>
<script async custom-element=”amp-iframe” src=”https://cdn.ampproject.org/v0/amp-iframe-0.1.js”></script>
<style>body {opacity: 0}</style><noscript><style>body {opacity: 1}</style></noscript>
<script async src=”https://cdn.ampproject.org/v0.js”></script>
</head>
<body>
<!– Call to the TagCommander iframe “https://academy.commandersact.com/AMP/iframe.php” containing the data layer variables. Note: the iframe must belong to a different domain from that of the website (except if the allow-same-origin parameter is added) and be https –>
<amp-iframe width=1 height=1 src=”https://academy.commandersact.com/AMP/iframe.php? env_template=homepage&env_work=prod&env_device=m&env_country=IT&page_name=amp_homepage&user_id=&user_newcustomer=&order_id=” sandbox=”allow-scripts allow-same-origin” layout=”fixed” frameborder=”0″>
<!– Adding content to the iframe is mandatory (a pixel in this case)–>
<amp-img src=”https://academy.commandersact.com/AMP/pixel.gif” height=1 width=1 layout=”fill” placeholder></amp-img>25
</amp-iframe>
<h1 id=”header”>AMP Page</h1>
<span id=”event-test” class=”tC_events” data-vars-event-label2=”22″>
Click here to generate an event
</span>
</body>
</html>

tC.internalvars.tc_url_1 =(function(){
tC.internalvars.tc_url_1_tmp = document.location.href.split('?');
tC.internalvars.tc_url_1_tmp2 = tC.internalvars.tc_url_1_tmp[0].split('/');
return tC.internalvars.tc_url_1_tmp2[3];
})();

Next.js serverside rendering

Trigger an browser event when you use serverside rendering with Next.js framework

Example of event triggered from a browser-side user interraction

Example use case : trigger a view_content event when the user scroll to 80% of the page.

import React, { useEffect } from 'react';

const MyPage = () => {
  useEffect(() => {
    let eventTriggered = false; // Flag to track if the event has been triggered

    function handleScroll() {
      if (eventTriggered) return; // If the event has already been triggered, do nothing

      const { scrollTop, scrollHeight, clientHeight } = document.documentElement;
      if (scrollTop + clientHeight >= scrollHeight * 0.8) {
        if (window.cact) {
          window.cact('trigger', 'my_event_name', {
            myprop1: '1234',
            myprop2: 'abcd',
          }, {
            collectionDomain: "my.firstdomain.com",
            siteId: "1234", 
            sourceKey: "abcd1234",
          });
          eventTriggered = true; // Update the flag to avoid triggering the event again
        }
      }
    }

    window.addEventListener('scroll', handleScroll);

    return () => {
      window.removeEventListener('scroll', handleScroll);
    };
  }, []);

  return (
    <div>
      {/* Your server-side rendered content here */}
      <script
        dangerouslySetInnerHTML={{
          __html: `
            (function() {
              var tc = document.createElement('script');
              tc.type = 'text/javascript';
              tc.async = true;
              tc.src = 'https://cdn.tagcommander.com/events/sdk.js';
              var s = document.getElementsByTagName('script')[0];
              s.parentNode.insertBefore(tc, s);
            })();
          `
        }}
      />
    </div>
  );
};

export default MyPage;

Onsite API

Getting Started

The onsite API is used to interact with Commanders Act features with JavaScript.

How to use

The onsite API consists of a single function, cact(), with the following strict signature:

cact(command, [options,] [callback])

Argument

Descriptions

Required

command

A string identifier used to select the desired method.

Required

options

A JavaScript object that includes data passed to the method.

Optional

callback

A JavaScript callback function that is used to receive information or events from the onsite API.

Optional

Onsite API is included in each containers and privacy banners.

Send event

To send event data to the serverside Commanders Act platform, use this command:

cact('<event_name>', {<event_params>});

Example : to send a purchase event :

cact('purchase', { 
  id:'1234',
  currency: 'EUR',
  //...
});

Get information

To get various values from Commanders Act, use this command:

cact(get command, [callback])

Example : to get consent from TrustCommander, you can call the consent.get API like this:

cact('consent.get', function(result) {
    if (result.consent.status === "all-on") {
        
        // Consent available for all categories.
        
    }
});

The onsite API methods are called asynchronously. In case e.g. you need information synchronous in the <head> of the document it is recommended to cache and retrieve the result of the API in localStorage.

Error handling

You can handle errors through error property in the callback object. Example:

cact('consent.get', function(result) {

    if (result.error) {
    
        // Manage the error
    
    }
    else if (result.consent.status === "all-on") {
        
        // Consent available for all categories.
        
    }
});

API Stub (optional)

For advance usage, we provide also an API stub that can be added when you need to interact with the API before containers or banners have loaded. This stub is already included in containers and privacy banners, so you do not have to add in most use cases. The stub is used to buffer all methods in a JavaScript array until Commanders Act JavaScript is loaded and ready to process the methods. This allows for example to use the onsite API before TrustCommander JavaScript was loaded.

window.caReady = window.caReady || []; 
window.cact = function() { window.caReady.push(arguments); };

window.caReady is a JavaScript array that buffers the interactions with the API. window.cact is a JavaScript function used to interact with the onsite API.

In case you work in a big team and are unsure the stub was already installed it is ok to install the JavaScript stub multiple times.

Javascript SDK

Getting Started

The onsite API is used to interact with Commanders Act features with JavaScript.

There are different commands available within cact(): config is used to set general options, trigger event is used to send data, and other specific get/update/revoke commands are used to interract with platform features (ex : get user consent)

How to use

The onsite API consists of a single function, cact(), with the following strict signature:

cact(command, [options,], [config,], [callback])

Argument

Descriptions

Required

command

A string identifier used to select the desired method.

Required

options

A JavaScript object that includes data passed to the method.

Optional

config

A javascript object that is used to override the default settings like siteId , collectionDomain , eventId, or sourceKey

Optional

callback

A JavaScript callback function that is used to receive information or events from the onsite API.

Optional

Onsite API is included in each containers and privacy banners.

Initialize global settings with config

Use the config command to initialize and configure settings for a particular workspace.

The config command takes the following format:

cact('config', {<config_object>});

Config object accept 4 parameters, they are optional if you use a web container on your page :

siteId : if not set, the default value is the site id of the last web container loaded (tC.id_site)
sourceKey: if not set, the default value is derivative from you web container id. If you don't have a web container, the sourceKey is mandatory and correspond to your JS SDK source.
eventId: if not set, an random id is set for this event and will be put in context.event_id

Example :

cact('config', { siteId: 1234, sourceKey: 'abcd' });

Send event

To send event data to the serverside Commanders Act platform, use this command:

cact('trigger', '<event_name>', {<event_params>});

Example : to send a purchase event :

cact('trigger', 'purchase', {   id:'1234',  currency: 'EUR',  //...});

Example : to send a purchase event, overriding the default tracking domain / workspace / sourcekey :

cact('trigger', 'purchase', {   id:'1234',  currency: 'EUR',  //...},{
    collectionDomain: "my.firstdomain.com",
    siteId: "1234", 
    sourceKey: "abcd"
});

Get information

To get various values from Commanders Act, use this command:

cact(get command, [callback])

Example : to get consent from TrustCommander, you can call the consent.get API like this:

cact('consent.get', function(result) {    if (result.consent.status === "all-on") {                // Consent available for all categories.            }});

Error handling

You can handle errors through error property in the callback object. Example:

cact('consent.get', function(result) {    if (result.error) {            // Manage the error        }    else if (result.consent.status === "all-on") {                // Consent available for all categories.            }});

Meta Properties

API Stub (optional)

window.caReady = window.caReady || []; window.cact = function() { window.caReady.push(arguments); };

window.caReady is a JavaScript array that buffers the interactions with the API. window.cact is a JavaScript function used to interact with the onsite API.

In case you work in a big team and are unsure the stub was already installed it is ok to install the JavaScript stub multiple times.

Use Javascript SDK in TMS

Our system now includes several new and improved features to help you efficiently manage and implement tags on your website. This guide provides comprehensive information on using our TMS webcontainers and JavaScript SDK, including browser-side events, command references, and tag context variables.

Browser-Side Events

Introduction

Our new cact('emit') API is a new approach of tC.event.XXX functions, ensuring safer and more reliable event handling.

Here’s how you can use these events:

<!-- Old method (may cause issues if event does not exist) -->
<a href="mysite.com" onclick="tC.event.my_custom_event(this, { my_event_variable: 'some_value' });">

<!-- New method (safe) -->
<a href="mysite.com" onclick="cact('emit', 'my_custom_event', { from: this, my_event_variable: 'some_value' });">

Note that hyphens (-) in event names will be converted to underscores (_). For example, cact('emit', 'my-custom-event') will actually call tC.event.my_custom_event.

Available Events

container_ready: Fires for every loaded container.
container_<siteId>_<containerId>_ready: Fires a specific event for each containercontainer_ready event (ex: container_1234_1_ready)
consent-ready: Fires when the consent cookie is set or the banner is accepted/refused.
consent-updated: Fires when consent is updated.
consent-revoke: Fires when consent is revoked.
consent-signal-ready: Used for Google Consent Mode setups.
banner-show: Fires when the privacy banner is shown.
banner-hide: Fires when the privacy banner is hidden.
privacy-center-show: Fires when the privacy center is shown.
privacy-center-hide: Fires when the privacy center is closed.
tag_trigger_form_submission: Standard form trigger.
tag_trigger_clicks: Standard clicks trigger.
tag_trigger_scroll: Standard scroll trigger.
track_all_events: Server-side event sent with cact('trigger') API.
track_*: Similar to track_all_events but with specific event names (e.g., track_page_view, track_add_to_cart).
privacy-module-loaded: Internal event fired when tC.privacy is initialized.
Custom events: Sent using cact('emit').

Listening to all Events

You can listen to all events using the cact('on', '*') API.

function listen_all_events(event) {
  console.log(event.type); // '*'
  console.log(event.originalEvent.type); // 'page_view'
}

cact('on', '*', listen_all_events);
cact('emit', 'page_view');

Custom Tag Triggers

To fire a custom trigger, use the cact('emit', 'my_custom_event') command. Note that hyphens will be converted to underscores when launching the trigger.

cact('emit', 'my_custom_event');

You will be able to use this event as a TMS custom trigger:

Commands Reference

The container provides a set of commands, some of which trigger browser-side events. To see all commands, type tC.cact in your console.

config

Set various website configurations.

cact('config', { siteId: 4242, collectionDomain: 'example.com', sourceKey: 'ABCD-1234-EFGH' });

setProperty

Set properties to be merged with server-side events sent via the trigger API.

cact('setProperty', 'page_type', 'homepage');
cact('setProperty', 'user.email', 'user@example.com');

emit (Alias: dispatchEvent)

Dispatch a browser-side event for use as a custom tag trigger.

cact('emit', 'page_view', { page_type: 'homepage' });

on (Alias: addEventListener)

Subscribe to a browser-side event.

cact('on', 'page_view', function(event) {
  console.log('event received of type', event.type); // 'page_view'
  console.log('event data is:', event.eventData); // { page_type: 'homepage' }
});

cact('emit', 'page_view', { page_type: 'homepage' });

once

Similar to on, but the callback fires only once.

cact('once', 'page_view', listener_callback);

off (Alias: removeEventListener)

Remove an event listener.

cact('off', 'page_view', listener_callback);

trigger

Send a server-side event. Any call to cact('trigger', ...) will also dispatch a generic track_all_events event.

cact('trigger', 'add_to_cart', { value: 42, currency: 'EUR' });

Tag Context Variables

The Tag Context provides variables used within a tag. If you need a Tag Context similar to "Container Loaded," consider using the container_ready custom trigger.

cact_container

Contains information about the container.

{
  id_container: <containerId>,
  id_site: <siteId>,
  sourceKey: <sourceKey>
}

cact_event

The event that triggered the tag, with a property cact_event.type.

cact('emit', 'page_view', {});
// cact_event.type will be 'page_view'

cact_event_vars

Contains all event variables from the trigger.

cact('emit', 'page_view', { hello: 'world' });
// cact_event_vars will be { hello: 'world' }

cact_event_attrs

Contains event attributes, set using the from property in emit or trigger API.

<a href="/home" onclick="cact('emit', 'page_view', { from: this, hello: 'world' })">Home</a>

For more examples and a live demo, refer to the documentation links provided.

Best Practices and Tips

Resolving Site-ID/Source-Key Conflicts

In multi-container websites, events were sometimes sent with incorrect site-id or source-key. This issue is fixed for tags using triggers other than native "Container Loaded." Use the new container_ready custom trigger for accurate site-id/source-key resolution.

Privacy-Related Events

You can use various privacy-related events as custom triggers:

consent_ready
consent_updated
consent_revoke
banner_show
banner_hide
privacy_center_show
privacy_center_hide

Server-Side Tracking as Custom Triggers

Need to track an event sent in Server Side ?

Our cact('trigger', ...) will dispatch a corresponding track_* event, that you can use as a custom trigger.

cact('trigger', 'page_view', { value: 42, currency: 'EUR' });

To use this feature as a TMS custom tag trigger, you'll need to prefix the event name with "track_*" Example:

Using cact('on') for Event Subscription

You can subscribe to any event sent using cact('emit').

cact('on', 'my_custom_event', function(event) {
  console.log('received an event', event.type); // "my_custom_event"
  console.log('event data:', event.eventData); // { var: "value" }
});