TRACKING DOCUMENTATION

In addition to the above listed parameters the following parameters are always attached to an event when possible:

​

• doorId: The id of the currently selected door

• externalDoorId: The external id of the currently selected door

• scenarioId: The id of the currently selected scenario (example image)

• scenarioType: The type of scenario which is currently shown. Can be “USER” for a user uploaded scenario or “EXAMPLE” for an example scenario

• userId: The id of the frontend user

• customerKey: The key to your environment

​

Google tag manager setup

To successfully forward the custom events to a Tag the following resources need to be setup correctly:

• 1. Variables

• 2. Tag which represents the target of the custom events (e.g. Google Analytics)​

• 3. Trigger to define which event should be forwarded to the Tag​

​​

​

1. Variables

For each of the above-mentioned events (which you want to forward), create an individual custom variable with the following steps:

1. Navigate to Variables in GTM.

2. Click "New" and Select "Data Layer Variable":

   • Set the data layer variable name to `body.<label>` where the label references the label from the above table.​​

   • For example: The custom variable for the scenario id should be defined as `body.scenarioId`.

   • Select Version 2 as the Data Layer version.

​

Additionally to the custom variable, you need to create a Data Layer Variable for the event field in the data layer to capture the event name. Follow those steps:​​​​​

1. Click New to create a new variable.

2. Select Data Layer Variable as the variable type.

3. Define the Data Layer Variable Name as "event" to capture the event name.

4. Select Version 2 as the Data Layer version.

​​

2. Trigger

To ensure that the custom events you defined are correctly forwarded to a tag, a trigger needs to be set up. Follow these steps to create a trigger that listens to all custom events:

1. Navigate to Triggers in GTM.

2. Create a New Trigger:

   • Click New and select Custom Event as the trigger type.

• In the Event Name field, use a wildcard (.*) to match all events. This will allow the trigger to fire for any custom event pushed to the dataLayer. Make sure to select the checkbox to match for regular expressions.

  • Example:

    • Trigger Type: Custom Event

    • Event Name: .* (Regular expression)

    • This trigger fires on: All Custom Events

​

3. Tag

Once the trigger is set, you’ll need to configure a tag to send data to your target destination (e.g., Google Analytics GA4). Follow these steps to create the tag for Google Analytics GA:

1. Navigate to Tags in GTM.

2. Create a New Tag:

   • Click New and select Google Analytics: GA4 Event Tag as the tag type.

3. Configure our GA4 Event Tag:

   • In the tag configuration, select the GA4 Configuration Tag (which contains your Measurement ID).

   • Set Event Name to {{event}} to dynamically capture the name of the event being fired.

4. Map Custom Variables to GA4 Parameters:

   • If you want to send additional data (like scenarioId, userId, or doorId) as custom parameters, add those mappings in the Event Parameters section.

   • Example:

     • Parameter Name: scenario_id, Value: The name of the variable, for example: {{scenario_id}}

5. Attach the Trigger:

   • In the Triggering section, select the "All Custom Events Trigger" that you created in the previous step.

​

Once this setup is complete, the tag will fire for every custom event sent to the dataLayer, and the corresponding data will be forwarded to Google Analytics GA4

​

4. Debugging Events Using Preview Mode

Once you have set up the custom variables, triggers, and tags, it is essential to test and ensure that everything is working correctly before publishing. Google Tag Manager provides a built-in Preview Mode to debug your events.

Follow these steps to debug your events:

​

Steps to Use Preview Mode:

1. Enter Preview Mode:

   • In the GTM workspace, click the Preview button located at the top right of the screen.

   • This will open a new tab in Tag Assistant, where you can enter your website's URL. Use the url for your door vision environment, for example: demo.door-vision.com for our demo environment.

2. Interact with Your Site:

   • After entering Preview Mode, interact with the application by performing one of the actions defined in the list above. For example, if you’re testing a selectDoor event, select a visual door in the door range panel.

3. Review Events in the Tag Assistant:

   • As you interact with the application, the Tag Assistant will display a list of triggered events in the left-hand pane.

   • Locate the custom event (e.g., selectDoor) in the event list and click on it to inspect the details.

4. Check the Tag Firing Status:

   • Under each event, check if your GA4 Event Tag fired correctly by looking at the Tags Fired and Tags Not Fired sections.

   • If the tag did not fire, review your trigger conditions and make sure the event matches your trigger setup (e.g., if you’re using a custom event trigger, ensure the event name is correct).

5. Inspect the Data Layer:

   • In the Data Layer section of the Tag Assistant, inspect the data that was pushed for each event. You should be able to see all variables and their values which you setup, such as scenarioId, userId, and the event field which describes the action which was taken.

   • Ensure that all the required data is present and that your variables are correctly mapped.

6. Use Google Analytics DebugView:

   • If you're using Google Analytics GA4, you can also verify the event data in GA4 DebugView.

     • Open Google Analytics, navigate to the DebugView (found in the Events section), and check that your events are being received by GA4.

     • Look for the custom parameters (e.g., scenario_id, user_id) to ensure they are being passed correctly.

​

Troubleshooting:

• If the tag does not fire, recheck the trigger and event name configurations in GTM.

• If variables are not passing the correct values, verify the Data Layer Variable names.

• Check if you browser has any add blockers or simliar enabled which could block the tracking (for example uBlock, ghostery,...)