---
title: Google Tag Manager - Android
description: Use our integration to send Google Tag Manager events to Contentsquare
lastUpdated: 23 October 2025
source_url:
  html: https://docs.contentsquare.com/en/csq-sdk-android/experience-analytics/google-tag-manager/
  md: https://docs.contentsquare.com/en/csq-sdk-android/experience-analytics/google-tag-manager/index.md
---

If you are using Firebase to track events such as screenviews or transactions, you can trigger these events for Contentsquare with minimal effort, thanks to Google Tag Manager.

## Prerequisites

If you are following this Google Tag Manager integration process, you should already have followed the Google Tag Manager + Firebase setup as described in [Google's Tag Manager + Firebase: Getting Started ↗](https://developers.google.com/tag-manager/android/)

You also need to [integrate the CSQ SDK](../#install-the-sdk).

## Screenview events

This section covers how to trigger a Contentsquare screenview event for every Firebase screenview event. Firebase allows you to [log screenviews automatically or manually ↗](https://firebase.google.com/docs/analytics/screenviews) for an exhaustive coverage of your app screens.

### Variables

Contentsquare screenview events require a `name` parameter.

Firebase has 2 ways to track screens:

#### 1. Variable for automatically tracked screens

Firebase’s `screen_view` events have an `_sc` parameter (for screen class) which we can use as parameter for screens that are **automatically tracked**.

We will create a variable called **Auto Screenview** with:

* The **Variable Type** set to **Event Parameter**
* The **Event Type** set to **Custom Parameter**
* The **Event Parameter Key** set manually to `_sc`

![](https://docs.contentsquare.com/_astro/gtm-screenview-variable-auto.DBb_tfSp_Z1jB9ik.webp)

#### 2. Variable for manually tracked screens

Firebase’s `screen_view` events have a `_sn` parameter (for screen name) which we can use as parameter for screens that are **manually tracked**.

We will create a variable called **Manual Screenview** with:

* The **Variable Type** set to **Event Parameter**
* The **Event Type** set to **Custom Parameter**
* The **Event Parameter Key** set manually to `_sn`

![](https://docs.contentsquare.com/_astro/gtm-screenview-variable-manual.3rST-eEh_FlfI9.webp)

We can also create variables for our own custom parameters, for example, we can send a `screen_view` event like this:

```kotlin
firebaseAnalytics.logEvent(FirebaseAnalytics.Event.SCREEN_VIEW) {
    param(FirebaseAnalytics.Param.SCREEN_NAME, "MyScreenName")
    param("is_user_logged_in", "true")
}
```

and create a variable called **Is User Logged In** with:

* The **Variable Type** set to **Event Parameter**
* The **Event Type** set to **Custom Parameter**
* The **Event Parameter Key** set manually to `is_user_logged_in`

Check out [Configure variables in Tag Manager ↗](https://developers.google.com/tag-platform/tag-manager/android/v5#configure_variables_in_tag_manager) for more information.

### Screenview trigger

We will need to tell Google Tag Manager when to send a Contentsquare screenview, and for that we need to create a **Trigger**. Firebase sends screenviews as events of name `screen_view`, so we need to create a trigger for that event.

* Name your trigger `Screenview Trigger`
* **Trigger Type** should be set to **Custom**
* Trigger should fire on **Some Events**
* For the Event, the **Event Name** should be **equal** to `screen_view`

![](https://docs.contentsquare.com/_astro/gtm-screenview-trigger.CCYQtsTt_Z121dEM.webp)

### Create the custom function Tag

In Google Tag Manager, a **Tag** is what configures what happens when some trigger is activated. It will be automatically linked to a custom class which we will create in a later step.

The **Tag Type** should be a **Function Call**. You will also need to fill in the **Class Path** field with a class name of your liking, typically related to what the tag is about (here we chose `com.myapp.ContentsquareScreenviewTag`), which you will re-use later.

![](https://docs.contentsquare.com/_astro/gtm-screenview-tag.B-OiT2Pu_2fX8B1.webp)

### Adding the trigger and the variables to the Tag

Edit the `ContentsquareScreenviewTag` Tag:

* Add an argument with the key `auto_screen_name` and the variable `{{Automatic Screenview Name}}` as the value
* Add an argument with the key `manual_screen_name` and the variables `{{Manual Screenview Name | Is User Logged In}}` or `{{Manual Screenview Name}}` as the value
* Add **Contentsquare Screenview Trigger** as the Tag's trigger

It should look like this now:

![](https://docs.contentsquare.com/_astro/gtm-screenview-tag-final.C2nlT51c_Z2dmBEN.webp)

### Create the custom function Tag class

In your app code, create a class of the same name as the `Class Path` you configured in the GTM interface, for example `ContentsquareScreenviewTag`. This is how GTM connects the configuration and the actual class to trigger. This class is used to call the Contentsquare screenview tracking function as follows:

```kotlin
@Keep
class ContentsquareScreenviewTag : com.google.android.gms.tagmanager.CustomTagProvider {
  override fun execute(map: MutableMap<String, Any>?) {
      val autoScreenName = map?.get("auto_screen_name") as String?
      val manualScreenName = map?.get("manual_screen_name") as String?
      if (autoScreenName != null) {
          CSQ.trackScreenview(autoScreenName)
          Log.w("GTM", "-------> $autoScreenName")
      }
      if (manualScreenName != null) {
          CSQ.trackScreenview(manualScreenName)
          Log.w("GTM", "-------> $manualScreenName")
      }
  }
}
```

Now, every time Firebase sends a screenview event, Contentsquare will send one as well.

## Screenview events with Custom Variables

Custom Variables

Custom variables are additional information on the page, the user or the session, sent within screenviews. For more information about custom variables, see [Track Custom Variables](../track-custom-variables/).

It is possible to send custom variables along with the screenview events. To do so:

1. Follow **Use Google Tag Manager** > [Screenview events](#screenview-events)

2. Add extra arguments to the `ContentsquareScreenviewTag` Tag as follows:

   * *Key:* the index of the custom variable
   * *Value:* a string that will contain the custom variable name and value such as `CVAR_NAME : {{Event Name}}`

Note

The value of the custom variable is composed of a name and a value: `NAME : VALUE` concatenated into a single string and separated by `:`.

It should look like this: ![](https://docs.contentsquare.com/_astro/gtm-custom-variables-function-call.C1foQykJ_Z11qEKj.webp)

For Custom Variables

You are free to implement your own logic for filling key and value in GTM, but the application side must be able to receive and extract for each custom variable:

1. An index
2. A name
3. A value

In the code of your application, edit the code of your class to handle the added custom variables:

```kotlin
@Keep
class ContentsquareScreenviewTag : com.google.android.gms.tagmanager.CustomTagProvider {
    override fun execute(map: Map<String, Any>) {
        val autoScreenName = map["auto_screen_name"] as String?
        val manualScreenName = map["manual_screen_name"] as String?
        val screenName = manualScreenName ?: autoScreenName ?: "No screen name!"


        val cvars = mutableListOf<CustomVar>()
        for ((tagKey, tagValue) in map) {
            val varIndex = tagKey.toIntOrNull() ?: continue
            val tagValueString = tagValue as? String ?: continue
            val splitTagValues = tagValueString.split(':')
            if (splitTagValues.size == 2) {
                val varName = splitTagValues[0].trim()
                val varValue = splitTagValues[1].trim()
                cvars.add(CustomVar(varIndex, varName, varValue))
            }
        }


        CSQ.trackScreenview(screenName, cvars.toTypedArray())
        Log.d("GTM", "-------> $screenName")
    }
}
```

With this code, the custom variables will be sent by Contentsquare automatically along with the screenview.

## Transaction events

A Contentsquare transaction event can also be triggered for every Firebase `purchase` event ([See Firebase documentation ↗](https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Event#public-static-final-string-purchase)). To do so, you will need to follow the setup described below.

### Variables

We have to create at least two variables in order to be able to build a transaction event: Value and Currency. Optionally, it is also possible to pass a transaction identifier, meaning you would need to create an additional variable in order to be able to use it.

#### Value (mandatory)

![](https://docs.contentsquare.com/_astro/gtm-transaction-variable-value.hFaSreMy_2kG0Vp.webp)

#### Currency (mandatory)

![](https://docs.contentsquare.com/_astro/gtm-transaction-variable-currency.B-sVY9MZ_2eM5hG.webp)

#### Transaction ID (optional)

![](https://docs.contentsquare.com/_astro/gtm-transaction-variable-transactionid.DJyRmNTH_Z1tJluh.webp)

### Trigger

Create the following custom trigger.

![](https://docs.contentsquare.com/_astro/gtm-transaction-trigger.CLRsqo_K_ZbqLL0.webp)

### Tag

Create a **Function call** Tag called `ContentsquareTransactionTag`.\
You will also need to fill in the **Class Path** field with a class path of your liking, typically related to what the tag is about (here we chose `com.myapp.ContentsquareTransactionTag`), which you will re-use later.\
Pass the two to three variables created earlier as arguments (skip the `id` line if you do not want to use it) and set its trigger to the one you just created.

![](https://docs.contentsquare.com/_astro/gtm-transaction-tag.CWZpqax6_Z2geRCK.webp)

### Implementing the function call

We need to create a `ContentsquareTransactionTag` class, and have it adhere to the `CustomTagProvider` interface to link it to the Google Tag Manager custom Tag of the same name.

Take good note that in order to be able to create and send a Contentsquare Transaction successfully, when you create a Firebase purchase event you will **have to** at least pass values for `VALUE` and `CURRENCY`, and can optionally pass a value for `TRANSACTION_ID` [see Firebase reference docs ↗](https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Event#PURCHASE)

```kotlin
@Keep
class ContentsquareTransactionTag : com.google.android.gms.tagmanager.CustomTagProvider {
  override fun execute(map: MutableMap<String, Any>?) {
      val value = map?.get("value") as String?
      val currency = map?.get("currency") as String?
      if (value != null && currency != null) {
          val transactionBuilder = Transaction.builder(value.toFloat(), currency)
          val id = map?.get("id") as String?
          if (id != null) {
              transactionBuilder.id(id)
          }
          CSQ.send(transactionBuilder.build())
      }
  }
}
```

Now, every time Firebase sends an `ecommerce_purchase` event, Contentsquare will send one as well.

## Dynamic variable events

We can send values from any Firebase event as a Contentsquare dynamic variable:

```kotlin
firebaseAnalytics.logEvent("addToCart") {
    param("product_count", 12)
    param("product_name", "ProductA")
}
```

### Variables

The `addToCart` event has parameters `product_count`, `product_name`, we will create variables called **Product Count** and **Product Name** with:

* The **Variable Type** set to **Event Parameter**
* The **Event Type** set to **Custom Parameter**
* The **Event Parameter Key** set manually to `product_count`/`product_name`

Check out [Configure variables in Tag Manager ↗](https://developers.google.com/tag-platform/tag-manager/android/v5#configure_variables_in_tag_manager) for more information.

### Triggers

We need to create a **Trigger** to tell Google Tag Manager when to send a Contentsquare dynamic variable, so we will create one for the event `addToCart`.

* Name your trigger `AddToCartTrigger`
* **Trigger Type** should be set to **Custom**
* Trigger should fire on **Some Events**
* For the Event, the **Event Name** should be **equal** to `addToCart`

### Create the custom function Tag

We need to create a function tag **AddToCartDynamicVar**

* The **Tag Type** set to **Function Call**

* The **Class Name** set to **DynamicVarTag** (we'll create this class later)

* Add two arguments

  * Key: `cs_dynamic_var_key`, Value: `Product`
  * Key: `cs_dynamic_var_value`, Value: `{{Product Name}}: {{Product Count}}`

* The **Triggering** set to **AddToCartTrigger**

It should look like this now:

![](https://docs.contentsquare.com/_astro/gtm-dynamic-var-tag.DXsQG7Me_inJPf.webp)

### Create the custom function Tag class

In your app code, create a class of the same name as the `Class Name` you configured in the GTM interface, for example `DynamicVarTag`. This is how GTM connects the configuration and the actual class to trigger. This class is used to call the Contentsquare dynamic variable function as follows:

```kotlin
@Keep
class DynamicVarTag : com.google.android.gms.tagmanager.CustomTagProvider {
    override fun execute(parameters: MutableMap<String, Any>) {
        val dynamicVarKey = parameters["cs_dynamic_var_key"] as? String ?: return
        when (val dynamicVarValue = parameters["cs_dynamic_var_value"]) {
            is String -> CSQ.addDynamicVar(dynamicVarKey, dynamicVarValue)
            is Long -> CSQ.addDynamicVar(dynamicVarKey, dynamicVarValue)
        }
    }
}
```

Now, every time Firebase sends an `addToCart` event, Contentsquare will send a dynamic variable `key: "Product", value: "ProductA: 12"`.

Note

To create another tag for a dynamic variable, you can use the `DynamicVarTag` class again.