目录

Extension Template Fields

HUAWEI Analytics

Field

Description

Event ID

Event ID on HUAWEI Analytics, including predefined events and custom events. You can select a value from the drop-down list box or manually enter a value.

NOTE:

If the entered event ID is not registered on HUAWEI Developers, the reported event details will be treated as invalid data. You need to click Register it now, register the event on the event management page displayed, and then configure the event in DTM.

Only one event ID can be set for a HUAWEI Analytics tag. To set multiple event IDs, you can create multiple HUAWEI Analytics tags.

Event parameters

There are recommended event parameters for each event. For details, please refer to HUAWEI Analytics event parameters. In addition, you can also customize event parameters. However, you are advised to use recommended event parameters.

Petal Ads

Field

Description

Tracking ID

ID for tracking a conversion event. The value is an 8-digit number.

Custom parameters

Custom parameters in key-value pair format. The key or value of a custom parameter cannot exceed 1000 characters. Up to 100 key-value pairs are allowed.

Trace Linker

Field

Description

Enable IAB TCF

You can select this field if your website supports TCF. DTM uses the standard TCF API window.__tcfapi to obtain the values of Cookie consent and Support personalized advertising. This field is deselected by default.

Cookie consent

You need to set this field when Enable IAB TCF is deselected.

To use this field, you need to configure a Custom JavaScript variable that returns true or false to check whether a user agrees to use cookies. The value true indicates that the user agrees to use cookies.

After a user agrees to use cookies, the tracking parameters will be saved to first-party cookies preferentially based on the top-level domain name of the first party.

Support personalized advertising

This field is optional. You can set it when Enable IAB TCF is deselected.

This field indicates whether the user agrees to support personalized advertising. The options are true (yes) and false (no).

Pass tracking parameters to URL

Indicates whether to append tracking parameters to the redirection URL.

Link domain

To support cross-domain pass of tracking parameters, you must set Pass tracking parameters to URL to true, and add third-party domains to this parameter.

If tracking parameters only need to be passed to the URL in the local domain, you do not need to set this parameter.

VMALL

Field

Description

Event ID

ID of an event, which is a string of at least 8 digits.

Custom attributes

Custom attributes in key-value pair format. The key or value of a custom parameter cannot exceed 1000 characters. Up to 100 key-value pairs are allowed.

Custom parameters

Custom parameters in key-value pair format. The key or value of a custom parameter cannot exceed 1000 characters. Up to 100 key-value pairs are allowed.

SEAD Intermodal Launch Platform

Field

Description

Tracking ID

ID for tracking a conversion event. The value is an 18-digit number.

Custom parameters

Custom parameters in key-value pair format. The key or value of a custom parameter cannot exceed 1000 characters. Up to 100 key-value pairs are allowed.

Custom HTML

Field

Description

Support document.write

If you select this option, document.write can be called in the <script> tag, preventing the current page from being overwritten.

Select this check box if necessary.

Custom HTML

HTML code snippet, which is used to deploy third-party tags that DTM currently does not support. The code snippet should be provided by a third-party vendor.

The HTML code snippet will be embedded into pages. JavaScript code should be placed in the <script> tag to ensure proper execution.

It is recommended that the function not include keywords like eval, with, and Function.

Custom URL

Field

Description

URL

URL of a custom HTTP request. The value must begin with http:// or https://.

The length cannot exceed 1000 characters.

Reporting method

Event reporting method. The options are as follows:

  1. GET(1px-img): Triggers a GET request based on 1x1 GIF files.
  2. GET(xhr): Triggers a GET request based on XmlHttpRequest.
  3. POST(JSON): Triggers a POST request whose content-type is application/json based on XmlHttpRequest.
  4. POST(form-urlencoded): Triggers a POST request whose content-type is application/x-www-form-urlencoded based on XmlHttpRequest.

Request header

HTTP request header information, which complies with the W3C.

This parameter is unavailable if Reporting method is set to GET(1px-img).

Parameter

Custom parameters to be reported in the HTTP request. The length cannot exceed 1000 characters.

Google Analytics: GA4 Configuration

Field

Description

Measurement ID

ID allocated when a property is created on Google Analytics. The ID begins with G- and contains a maximum of 1000 characters.

Send web browsing event

Indicates whether to automatically send web browsing events. By default, this parameter is selected.

Web browsing events are automatically collected. If you select this parameter, web browsing events will be automatically sent when the web page is browsed. If you deselect this parameter, web browsing events will not be automatically sent.

NOTE:

If you want to add additional parameters to web browsing events, you need to trigger web browsing events through the web browsing condition. In addition, you are advised to deselect this parameter to prevent GA4 from automatically reporting web browsing events that are duplicate with the ones triggered by the condition.

Event parameters

Parameters of an event. Up to 100 key-value pairs are allowed, and the length of each key-value pair cannot exceed 1000 characters.

NOTE:

This field is used to configure common parameters (such as Measurement ID, User-ID, and Cookie domain) for all events. The GA4 Event tag will inherit parameters from the GA4 Configuration tag with the same measurement ID. If a parameter in the GA4 Event tag has the same name as a parameter in the GA4 Configuration tag, the parameter value in the GA4 Event tag will overwrite that in the GA4 Configuration tag.

User attributes

User attributes created in GA4 properties. Up to 100 key-value pairs are allowed, and the length of each key-value pair cannot exceed 1000 characters.

Google Analytics: GA4 Event

Field

Description

Measurement ID

ID allocated when a property is created on Google Analytics. The ID begins with G- and contains a maximum of 1000 characters. If you want to use the GA4 Event tag together with the GA4 Configuration tag, the measurement ID must be the same for the two tags.

Event name

New event name. The value can contain a maximum of 1000 characters, and cannot be empty.

Event parameters

Parameters of an event. Up to 100 key-value pairs are allowed, and the length of each key-value pair cannot exceed 1000 characters.

User attributes

User attributes created in GA4 properties. Up to 100 key-value pairs are allowed, and the length of each key-value pair cannot exceed 1000 characters.

Google Analytics: Universal Analytics

The following template fields are used only for web apps.

Field

Description

Google Analytics setting

You can reference custom variables of Google Analytics, or select Custom to customize the tracker.

Customize tracker to overwrite original variables

Indicates whether to overwrite values of referenced fields in Google Analytics settings. If yes, the field value in the code is preferentially used to overwrite the value of the field with the same name in Google Analytics settings.

Tracking type

Data hit types sent by Google Analytics, including Web page browsing, Event, Social interaction, Exception, Transaction, and Timing. Each data hit type has its own fields. For details, please refer to Hit Type Parameters.

Enable enhanced e-commerce

Indicates whether to enable enhanced e-commerce. This parameter is available only when Tracking type is set to Web page browsing. This field is deselected by default.

For details about enhanced e-commerce settings, please refer to Enhanced e-Commerce.

Hit Type Parameters

Hit Type

Field

Description

Web page browsing

Title

Title of a web page or document. The default value is document.title. The length cannot exceed 1500 characters.

URL

Complete URL of a web page (excluding the anchor point). The length cannot exceed 2048 characters.

Path

Path in the URL, which begins with a slash (/). It specifies a virtual web page path. The length cannot exceed 2048 characters.

Event

Event type

The length of an event type cannot exceed 150 characters.

Event operation

The length of an event operation cannot exceed 500 characters.

Event label

The length of an event label cannot exceed 500 characters.

Event value

Value of an event, which cannot be a negative number.

Social interaction

Social network

The length of the social network, for example, Facebook, cannot exceed 50 characters.

Social action

The length of the social interaction cannot exceed 50 characters.

Social interaction target

Target of social interaction. The value is usually a URL but it can also be any other text. The length cannot exceed 2048 characters.

Exception

Exception description

Description of the exception. The length cannot exceed 150 characters.

Fatal

Indicates whether the exception is fatal. This parameter is of the Boolean type.

Timing

Timing type

Timing type of a user. The length cannot exceed 150 characters.

Timing variable

Timing variable of a user. The length cannot exceed 500 characters.

Timing value

Timing value of a user, which is an integer in milliseconds.

Timing label

Timing label of a user. The length cannot exceed 500 characters.

Transaction

Transaction ID

ID of a transaction. The length cannot exceed 1000 characters.

Associated merchant

Store or associated merchant where the transaction is initiated. The length cannot exceed 1000 characters.

Total revenue

Total revenue or amount of a transaction (for example, 11.99). The revenue or amount includes the freight, tax, and other relevant incomes.

Total freight

Total freight of a transaction (for example, 5).

Total tax

Total tax amount of a transaction (for example, 1.29).

Currency unit

By default, Google Analytics uses the global currency for all products and transactions.

You can specify local currencies for transactions and products on web apps that support multiple currencies for transactions. The specified local currencies must comply with the ISO 4217 standard.

Items

Products in the shopping cart. You can pass a JSON array object using the recordTier variable. For details, please refer to Product Data Sample Code.

[h2]Product Data Sample Code

Fields in the sample code are as follows:

  • name: product name. The length cannot exceed 1000 characters.
  • sku: SKU or product code, for example, SKU47. The length cannot exceed 1000 characters.
  • category: product category, for example, clothes or toy. The length cannot exceed 1000 characters.
  • price: product unit price, for example, 11.99. The value must be a number.
  • currency: product currency. By default, Google Analytics uses the global currency for all products and transactions. You can specify local currencies for transactions and products on web apps that support multiple currencies for transactions. The specified local currencies must comply with the ISO 4217 standard.
  • quantity: number of products in a transaction. The value must be 0 or a positive integer. If a non-integer value (for example, 1.5) is passed, the value will be rounded off to an integer.
<script>
   window.recordTier.push({
     myprod: [{ // myprod is the name of the recordTier variable, which needs to be created on the Variable page in DTM.
       'sku': 'A',
       'name': 'Cloth',
       'category': 'Apparel',
       'price': 11.99,
       'quantity': 1
     }, {
       'sku': 'B',
       'name': 'Fruit',
       'category': 'Apparel',
       'price': 10,
       'quantity': 2
     }]
   });
</script>

Google Analytics Setting

Field

Description

Tracking ID

Measurement ID or network media resource ID, which is in UA-XXXX-Y format.

This field is mandatory. You need to register a tracking ID. For details, please refer to Set up the Analytics global site tag.

Custom dimensions

Custom data attributes. The key is the numeric index, which must be a positive integer. Up to 200 dimensions are allowed for a Google Analytics 360 account and 20 for a non-Google Analytics 360 account.

Custom indicators

Custom data to be measured. The key is the numeric index, which must be a positive integer. The value must be a number. Up to 200 indicators are allowed for a Google Analytics 360 account and 20 for a non-Google Analytics 360 account.

Content group

Web page content group. The key must be a positive integer. Up to 5 content groups are allowed. The value is words separated by slashes (/), for example, a/b/c and HUAWEI/phone. Up to 100 words are allowed.

Enable Google Advertising ID

Select this parameter if you want to integrate the following functions from Google: app installation conversion, audience feature report, audience interest report, and Google Analytics remarketing.

Name

Tracker name. The default value is dtmX. (In the value, X is an auto-increment integer used to distinguish different trackers.)

Client ID

ID identifying a browser instance in anonymous mode. It is generated randomly and stored in the cookie of Google Analytics, with a validity period of two years.

Sample rate

Proportion of users to track. The default value 100 indicates to track all users. You may need to reduce the sample rate for large websites to prevent sampled data from exceeding the processing limit of Google Analytics.

Website speed sample rate

Frequency for sending website speed beacons. By default, the system will automatically measure 1% of users.

Treat other pages on the host as referrals

The HTTP referral URL for attribution analysis is sent only when the host name of the referral page differs from that of the current page. If you select this field, other pages on the host will be treated as referrals.

Search for custom campaign parameters in the anchor

By default, analytics.js searches for custom campaign parameters such as utm_source and utm_medium in both the query string and anchor of the current URL. If you deselect this field, custom campaign parameters in the anchor will be ignored.

Cookie name

Name of the cookie for storing analytics data. The default value is _ga.

Cookie domain

Domain for storing analytics cookies. The default value is document.location.hostname. You are advised to set this field to auto. If this parameter is set to none, no domain will be specified during cookie setting.

Cookie validity period

Validity period of a cookie, in seconds. The default value is 63072000 (two years).

Write campaign information to a cookie

By default, analytics.js writes campaign information to a cookie for storage. You can deselect this parameter to not write campaign information to a cookie.

Legacy cookie domain

Indicates how analytics.js searches for cookies generated by earlier Google Analytics scripts such as ga.js and urchin.js. This field has no default value.

Enable analytics.js to import historical data from ga.js cookies

Indicates whether analytics.js should attempt to import historical data from the ga.js cookies.

Enable parsing of domain linker parameters

Indicates whether parsing of cross-domain linker parameters (for passing status across domains) is enabled.

Enhanced e-Commerce

Field

Description

Currency code

Currency of the user value, which must comply with the ISO 4217 standard. You can select a currency code from the drop-down list box.

Impression data

A data array providing information about the product through custom recordTier variables. Up to 200 impression data records are allowed. For details about the example, please refer to Impression Data Sample Code.

Measurement mode

Mode of measurement. The options are as follows:

[h2]Impression Data Sample Code

Fields in the sample code are as follows:

  • id: product ID. The length cannot exceed 1000 characters.
  • name: product name. The length cannot exceed 1000 characters.
  • category: product category. The length cannot exceed 1000 characters.
  • brand: product brand. The length cannot exceed 1000 characters.
  • variant: product variant. The length cannot exceed 1000 characters.
  • list: product list. The length cannot exceed 1000 characters.
  • position: product display position. The length cannot exceed 1000 characters.
  • price: product price, for example, 11.99. The value must be a number.
  • dimension: custom product impression dimensions. The index of a dimension is a positive integer ranging from 1 to 200. The value length cannot exceed 1000 characters.
  • metric: custom product impression metrics. The index of a metric is a positive integer ranging from 1 to 200. The value must be an integer.
<script>
  Window.recordTier.push({
    'gImpressions': [{ // gImpressions is the name of the recordTier variable, which needs to be created on the Variable page in DTM.
       'id': 'P12345',
       'name': 'Android Warhol T-Shirt',
       'category': 'Apparel/T-Shirts',
       'brand': 'Google',
       'variant': 'Black',
       'list': 'listResults',
       'position': "1",
       'price': "3.9",
       'dimension1': 'Member',
       'metric1': 'metric',
    }, {
       'id': 'P890',
       'name': 'MagicWatch',
       'category': 'Electronic consumer',
       'brand': 'Huawei',
       'variant': 'Black',
       'list': 'listResults',
       'price': "4.9",
       'position': 2, 
       'dimension1': 'Member2',
       'metric1': 'metric2'
    }]
  });
</script>

Product Action

Field

Description

Action type

Type of an action. You can select a value from the drop-down list box.

Product data

A data array providing information about the product that is viewed (or added to shopping cart) through custom recordTier variables. Up to 200 product data records are allowed. For details about the example, please refer to Product Data Sample Code.

Transaction ID

ID of a transaction. This parameter must be set if the operation type is purchase or refund.

Associated merchant

Store or merchant where the transaction occurs. This parameter can be set if the operation type is purchase or refund.

Revenue

Total revenue or amount associated with the transaction, including the freight, tax, and other relevant fees. This parameter can be set if the operation type is purchase or refund.

Tax

Tax of the transaction. This parameter can be set if the operation type is purchase or refund.

Freight

Freight of the transaction. This parameter can be set if the operation type is purchase or refund.

Coupon

Coupon redeemed in the transaction. This parameter can be set if the operation type is purchase or refund.

Product operations

List or collection of product operations. This parameter can be set if the operation type is detail or click.

Checkout step

Step number in the checkout funnel. This parameter can be set if the operation type is checkout.

Checkout step option

Additional information about the checkout step. This parameter can be set if the operation type is checkout.

[h2]Product Data Sample Code

Fields in the sample code are as follows:

  • id: product ID. The length cannot exceed 500 characters.
  • name: product name. The length cannot exceed 500 characters.
  • price: product unit price, for example, 11.99. The value must be a number.
  • brand: product brand. The length cannot exceed 500 characters.
  • category: product category, for example, clothes or toy. The length cannot exceed 500 characters.
  • variant: product variant. The length cannot exceed 500 characters.
  • metric: custom product metrics. The index of a metric is a positive integer ranging from 1 to 200. The value must be an integer.
  • dimension: custom product dimensions. The index of a dimension is a positive integer ranging from 1 to 200. The value length cannot exceed 1000 characters.
  • quantity: number of products in a transaction. The value must be 0 or a positive integer. If a non-integer value (for example, 1.5) is passed, the value will be rounded off to an integer.
<script>
  Window.recordTier.push({
    "gProduct": [{ // gProduct is the name of the recordTier variable, which needs to be created on the Variable page in DTM.
      "id": "57b9d",
      "name": "runner",
      "price": "55.00",
      "brand": "Kiosk",
      "category": "shoe",
      "variant": "blue",
      "dimension1": "Member",
      "metric1": "M",
      "quantity": 1
    }, {
      "id": "57b9f",
      "name": "runner",
      "price": "65.00",
      "brand": "Nike",
      "category": "shoe",
      "variant": "blue",
       "dimension1": "Member2",
      "metric1": "L",
      "quantity": 2
    }]
  });
</script>

Promotion Action

Field

Description

Action type

Type of an action. You can select a value from the drop-down list box.

Promotion data

A data array providing promotion information about the product that is viewed (or added to shopping cart) through custom recordTier variables. Up to 200 product promotion data records are allowed. For details about the example, please refer to Promotion Data Sample Code.

Transaction ID

ID of a transaction. This parameter must be set if the operation type is purchase or refund.

Associated merchant

Store or merchant where the transaction occurs. This parameter can be set if the operation type is purchase or refund.

Revenue

Total revenue or amount associated with the transaction, including the freight, tax, and other relevant fees. This parameter can be set if the operation type is purchase or refund.

Tax

Tax of the transaction. This parameter can be set if the operation type is purchase or refund.

Freight

Freight of the transaction. This parameter can be set if the operation type is purchase or refund.

Coupon

Coupon redeemed in the transaction. This parameter can be set if the operation type is purchase or refund.

Product operations

List or collection of product operations. This parameter can be set if the operation type is detail or click.

Checkout step

Step number in the checkout funnel. This parameter can be set if the operation type is checkout.

Checkout step option

Additional information about the checkout step. This parameter can be set if the operation type is checkout.

[h2]Promotion Data Sample Code

Fields in the sample code are as follows:

  • id: ID of the promoted product. The length cannot exceed 1000 characters.
  • name: name of the promoted product. The length cannot exceed 1000 characters.
  • creative: promotion ad asset. The length cannot exceed 1000 characters.
  • position: product promotion position. The length cannot exceed 1000 characters.
<script>
  Window.recordTier.push({
    'gPromo': [{ // gPromo is the name of the recordTier variable, which needs to be created on the Variable page in DTM.
      'id': 'PROMO_1',
      'name': 'Summer Sale',         
      'creative': 'summer_banner1', 
      'position': 'banner_slot1'  
    }, {
      'id': 'PROMO_2',           
      'name': 'winter Sale',       
      'creative': 'summer_banner2',   
      'position': 'banner_slot2'
    }]
  });
</script>

Google Ads Remarketing

Field

Description

Conversion ID

Conversion ID obtained from your Google Ads account.

Conversion tag

Conversion tag obtained from your Google Ads account.

App event type

Name of the dynamic remarketing event of the currently measured event. To ensure optimal performance, set this parameter to one of the values recommended for your services.

Event name

Name of an event. This parameter is available only when App event type is set to custom. The length cannot exceed 1000 characters.

Event value

Value of a remarketing event, indicating the total value of the product or service with which the user is interacting.

Event items

All products that the user is interacting with. The value must be an object array complying with the dynamic remarketing product architecture. Each product must have one or more of the following attributes: id, location_id, origin, destination, start_date, end_date, and google_business_vertical. For details, please refer to Event Item Sample Code.

Enable restricted data processing

Restricted data processing aims to help advertisers, publishers, and partners comply with the California Consumer Privacy Act (CCPA). After you enable restricted data processing, Google will restrict usage of some unique identifiers, and process data more strictly when serving you, to ensure that the data is only used for specified business purposes.

Event data

Indicates whether to enable event parameters. By default, Enable next to this field is deselected.

Parameter

Up to 100 parameters are allowed, and the key or value of each parameter cannot exceed 1000 characters.

User ID

Unique ID for cross-device association or remarketing.

[h2]Event Item Sample Code

Floodlight Sales

Type

Field

Description

Basic

Advertiser ID

ID of an advertiser. The value cannot be empty and must be a positive integer consisting of 0 to 63 digits.

Activity group label

Label of an activity group. The length cannot exceed eight characters.

Activity label

Label of an activity. The length cannot exceed eight characters.

Statistical method

Statistical method

The value is of the enumerated type. Only one option can be selected.

Unique parameters

Revenue

Revenue generated from a transaction (the price of the item sold).

This parameter is mandatory. Its value can be any number, including decimal numbers and negative numbers. The length cannot exceed 1000 characters.

Order ID

Unique ID of an order.

This parameter is mandatory. Its value consists of letters, hyphens (-), and digits.

The length cannot exceed 1000 characters.

Quantity

Number of sold products. This parameter is available when Statistical method is set to Sold products.

The parameter value must be a positive integer with up to 1000 characters.

Custom variable

Custom variable

Custom attributes of Floodlight, which can be used to pass any value.

The key of a custom attribute is a drop-down list box, and the value ranges from u1 to u100. The key must be unique. Otherwise, the custom attribute set later will overwrite the existing custom attribute with the same key.

The length of the custom attribute value cannot exceed 1000 characters.

Product report

Provide product-level sales data

Indicates whether to provide information about the product sold in a transaction. By default, this field is deselected.

Country/Region

Country or region of a product. The value is a two-letter country/region code complying with ISO 3166.

Language

Language of a product. The value is a two-letter language code complying with ISO 639.

Product data

Product data in JSON array format. Each item in the array contains the id, price, and quantity fields. For details, please refer to Product Data Sample Code.

Personalized setting

Prohibit personalized ad data

Indicates whether to prohibit personalized ad data. Personalized ad marketing data will not be collected from users with this setting enabled.

Custom parameters

Custom parameters

Custom parameters. Do not pass on any data that could be used to identify an individual.

Conversion association

Enable linker

Indicates whether to enable the linker. To enable this function, you need to set a linker and execute it in advance.

This function will read ad click information from the first-party cookies generated by the linker.

Cookie prefix

Prefix of a cookie. The default cookie prefix is _gcl. To change the prefix, ensure that it is the same as the one in the linker code.

[h2]Product Data Sample Code

<script>
  Window.recordTier.push({
    'productItem': [{ // productItem is the name of the recordTier variable, which needs to be created on the Variable page in DTM.
             'id': 'A',
             'price': 1,
             'quantity': 1
          }, {
            'id': 'B',
            'price': 2,
            'quantity': 2
       }]
  });
</script>

Floodlight Counter

Type

Field

Description

Basic

Advertiser ID

ID of an advertiser. The value cannot be empty and must be a positive integer consisting of 0 to 63 digits.

Activity group label

Label of an activity group. The length cannot exceed 1000 characters.

Activity label

Label of an activity. The length cannot exceed 1000 characters.

Counting mode

Counting mode

Mode of counting. The options include Standard, Once only, and Each session.

Session ID

This field is available when Counting mode is set to Each session. The length cannot exceed 1000 characters.

Custom variable

Custom variable

Custom attributes of Floodlight, which can be used to pass any value.

The key of a custom attribute is a drop-down list box, and the value ranges from u1 to u100. The key must be unique. Otherwise, the custom attribute set later will overwrite the existing custom attribute with the same key.

The length of the custom attribute value cannot exceed 1000 characters.

Personalized setting

Prohibit personalized ad data

Indicates whether to prohibit personalized ad data. Personalized ad marketing data will not be collected from users with this setting enabled.

Custom parameters

Custom parameters

Custom parameters. Do not pass on any data that could be used to identify an individual.

Conversion association

Enable linker

Indicates whether to enable the linker. To enable this function, you need to set a linker and execute it in advance.

This function will read ad click information from the first-party cookies generated by the linker.

Cookie prefix

Prefix of a cookie. The default cookie prefix is _gcl. To change the prefix, ensure that it is the same as the one in the linker code.

Google Conversion Linker

Type

Field

Description

Cross-domain connection

Conversion ID

Conversion ID obtained from your Google Ads account. The length cannot exceed 1000 characters.

Auto link domains

List of auto link domains associated with the tag. Linker parameters will be appended to the end of any link redirected to a domain in the list.

Link form

Indicates whether the link form is required. If yes, select the check box.

Accept linker parameters

If the target domain is not an auto link domain, you can select this check box to specify that the web pages in the target domain analyze linker parameters.

URL position

The default value is query (?). To read link parameters from fragment (#) instead of query (?), set this parameter to fragment.

Cookie settings

Cookie prefix

Cookie prefix used by the linker. The default cookie prefix is _gcl. You can change the value manually.

Google Ads Conversion Tracking

Type

Field

Description

Basic parameters

Conversion ID

Conversion ID obtained from your Google Ads account. The length cannot exceed 1000 characters.

Conversion tag

Conversion tag obtained from your Google Ads account. The length cannot exceed 1000 characters.

Conversion value

Value of a conversion. The value must be a number.

Transaction ID

Dynamic transaction ID, which can prevent counting of duplicate conversions. The length cannot exceed 1000 characters.

Currency unit

Currency unit, which complies with ISO 4217. You can select a currency unit from the drop-down list box.

Enable restricted data processing

Indicates whether Google restricts data processing. This field is deselected by default. If this field is selected, Google will restrict the ways through which the product can use certain data.

By default, this field is deselected.

Linker

Enable linker

Indicates whether to enable the linker. This function will read ad click information from the first-party cookies generated by the linker.

To enable this function, you need to set a linker and execute it in advance.

The default value is true.

Cookie prefix

Prefix of a cookie. To change the prefix, ensure that it is the same as the one in the linker code. The length cannot exceed 1000 characters.

The default value is _gcl.

Product sales data

Include product sales data

Indicates whether to include the product sales data. If you select this check box, relevant product sales data will be displayed.

Country/Region

Country/Region code of a product, which complies with the ISO 3166 standard.

Discount

Sum of transaction-level discounts.

Language

Language of a product, which complies with the ISO 639-1 standard.

Product details

Product information recorded through a recordTier variable. For details, please refer to Product Details Sample Code.

Merchant ID

ID of the merchant to which a product belongs.

The value must be 0 or a positive integer.

[h2]Product Details Sample Code

<script>
  Window.recordTier.push({
     gItems: [{ // gItems is the name of the recordTier variable, which needs to be created on the Variable page in DTM.
            'price': 12,
            'quantity': 3,
            'id': 'id-3432'
          },{
            'price': 44,
            'quantity': 100,
            'id': 'id-890'
          }]
  });
</script>

Google Importing Call Conversions

Field

Description

Conversion ID

Conversion ID obtained from your Google Ads account. The length cannot exceed 1000 characters.

Conversion tag

Conversion tag obtained from your Google Ads account. The length cannot exceed 1000 characters.

Website phone number

Phone number on the website. The length cannot exceed 1000 characters.

Number element style

Style of a number element. You can enter a CSS class name to replace the content of all elements in this class with phone numbers in a fixed format. The length cannot exceed 1000 characters.

Search duration

Time limit for number searches, in milliseconds. If no number is found within the duration, no number will be sent to the target. By default, the duration is 5000 ms.

Cache number

Indicates whether to cache searched numbers in cookies. If yes, select Enable next to this parameter. If no, deselect Enable.

Google Questionnaire

Field

Description

Website ID

Unique website ID that is automatically generated when a website is created in Google questionnaire.

Google Optimize

Type

Field

Description

Tracker

Tracking ID

Measurement ID or network media resource ID, which is in UA-XXXX-Y format.

This field is mandatory. You need to register a tracking ID. For details, please refer to Set up the Analytics global site tag.

First name

Tracker name.

Client ID

ID identifying a browser instance in anonymous mode. It is generated randomly and stored in the cookie of Google Analytics, with a validity period of two years.

Sample rate

Proportion of users to track. The default value 100 indicates to track all users. You may need to reduce the sample rate for large websites to prevent sampled data from exceeding the processing limit of Google Analytics.

Website speed sample rate

Frequency for sending website speed beacons. By default, the system will automatically measure 1% of users.

Treat other pages on the host as referrals

The HTTP referral URL for attribution analysis is sent only when the host name of the referral page differs from that of the current page. If you select this field, other pages on the host will be treated as referrals. This field is deselected by default.

Search for custom campaign parameters in the anchor

By default, analytics.js searches for custom campaign parameters such as utm_source and utm_medium in both the query string and anchor of the current URL. If you deselect this field, custom campaign parameters in the anchor will be ignored. This field is selected by default.

Cookie name

Name of the cookie for storing analytics data. The default value is _ga.

Cookie domain

Domain for storing analytics cookies. The default value is document.location.hostname. You are advised to set this field to auto. If this parameter is set to none, no domain will be specified during cookie setting.

Cookie validity period

Validity period of a cookie, in seconds. The default value is 63072000 (two years).

Write campaign information to a cookie

By default, analytics.js writes campaign information to a cookie for storage. You can deselect this parameter to not write campaign information to a cookie. This field is selected by default.

Legacy cookie domain

Indicates how analytics.js searches for cookies generated by earlier Google Analytics scripts such as ga.js and urchin.js. This field has no default value.

Enable analytics.js to import historical data from ga.js cookies

Indicates whether analytics.js should attempt to import historical data from the ga.js cookies. This field is selected by default.

Enable parsing of domain linker parameters (for passing status across domains)

Indicates whether parsing of cross-domain linker parameters (for passing status across domains) is enabled. This field is deselected by default.

Optimize ID

Optimize ID

Unique ID of an Optimize container, which is a string beginning with OPT-.

Facebook Pixel

Type

Field

Description

Basic parameters

Pixel ID

ID of a pixel. The length cannot exceed 1000 characters.

User ID

ID of a user. The length cannot exceed 99 characters.

User attributes

Attributes of a user. The length of each key or value cannot exceed 1000 characters.

Do not push status

By default, this field is deselected, and the pixel script automatically tracks the page switching operation, for example, pushState.

If this field is enabled, page switching operations will not be tracked.

Auto configuration

By default, this field is selected, and the pixel script automatically collects original page data and user interaction data for analysis, measurement, and auto configuration.

If this field is disabled, the pixel script will not collect these data.

Advanced matching

Country

Country of a user. The length cannot exceed 1000 characters.

City

City of a user. The length cannot exceed 1000 characters.

Birthday

Birthday of a user. The length cannot exceed 1000 characters.

Email

Email address of a user, for example, name@xyz.com. The length cannot exceed 1000 characters.

Last name

Last name of a user. The length cannot exceed 1000 characters.

Gender

Gender of a user. The length cannot exceed 1000 characters.

First name

First name of a user. The length cannot exceed 1000 characters.

Phone number

Phone number of a user. The length cannot exceed 1000 characters.

State/Province

State or province of a user. The length cannot exceed 1000 characters.

Postal code

Postal code in the country/region of a user. The length cannot exceed 1000 characters.

Tracking event

Tracking event

Name of a tracking event. You can select only one value from the drop-down list box.

Custom event

Name of a custom event. This field is mandatory when Tracking event is set to Custom. The length cannot exceed 1000 characters.

Cookie consent

Indicates whether to send pixel events to Facebook. You can select only one value from the drop-down list box. The options include false (no) and true (yes).

Preset attributes

Value

Value of a user. The value must be a number.

Currency

Currency of the user value, which must comply with the ISO 4217 standard.

Details

Product details, which is a JSON array object imported using the recordTier variable. The value contains the product quantity, International Article Number (EAN) (if applicable), and other product or content identifiers.

The product ID and quantity are mandatory, for example, [{'id': 'ABC123', 'quantity': 2}, {'id': 'XYZ789', 'quantity': 2}].

The product quantity must be a positive integer. For details, please refer to Details Sample Code.

Identifier

Product ID associated with the event. The value can be a string or a string array, for example, ['ABC123', 'XYZ789'].

You can use the recordTier variable to import a string array. For details, please refer to Identifier Sample Code.

Classification

Classification of a page or product. The length cannot exceed 1000 characters.

Name

Name of a page or product. The length cannot exceed 1000 characters.

Quantity

Number of products for checkout. This field is used together with the InitiateCheckout event. The value must be a positive integer.

Predicted lifetime value of subscriber

Predicted lifetime value of a subscriber. The value is defined by the advertiser and must be a number.

Search string

String for searching for a product. This field is used together with the Search event. The length cannot exceed 1000 characters.

Registration status

Registration status of a user. This field is used together with the CompleteRegistration event. The value is of the Boolean type.

Type

Product type. The value can be product or product_group depending on content_ids or contents. Specifically, the value is product if the value of content_ids or contents is the product ID, and product_group if the value of content_ids or contents is the product group ID.

Custom attributes

Key, Value, Operation

If preset attributes cannot meet the requirements, you can add custom attributes, and specify Key and Value for them.

[h2]Details Sample Code

<script>
  Window.recordTier.push({
     fbpContents: [{ // fbpContents is the name of the recordTier variable, which needs to be created on the Variable page in DTM.
            'id': 'ABC123',
            'quantity': 2
         }, {
            'id': 'XYZ789',
            'quantity': 2
         }]
  });
</script>

[h2]Identifier Sample Code

<script>
  Window.recordTier.push({
    fbpContentids: ["123", "1243"] // fbpContentids is the name of the recordTier variable, which needs to be created on the Variable page in DTM.
  });
</script>

Pinterest

Type

Field

Description

Basic

Tag ID

Tag ID obtained from Pinterest Conversions.

  • The value cannot be empty.
  • The value must be a 13-digit string beginning with 26 (regular expression: 26\d{11}).

Event

Event type

Type of the event to track.

Order amount

Amount of an order, which does not exceed 150,000.

Order quantity

The length cannot exceed 1000 characters.

Currency

The length cannot exceed 1000 characters.

Order ID

The length cannot exceed 1000 characters.

Product

The length cannot exceed 1000 characters.

ID

The length cannot exceed 1000 characters.

Category

The length cannot exceed 1000 characters.

Variant ID

The length cannot exceed 1000 characters.

Variant

The length cannot exceed 1000 characters.

Price

The length cannot exceed 1000 characters.

Quantity

The length cannot exceed 1000 characters.

Brand

The length cannot exceed 1000 characters.

Coupon code

The length cannot exceed 1000 characters.

Attribute

The length cannot exceed 1000 characters.

Search keyword

The length cannot exceed 1000 characters.

Video title

The length cannot exceed 1000 characters.

Lead type

Type of the product or service that the user is interested in.

The length cannot exceed 1000 characters.

Enhanced matching

Encrypted email

Email address or hash value used to enhance matching.

The length cannot exceed 1000 characters.

Custom parameter

Custom parameter

The length of the key or value cannot exceed 1000 characters.

LinkedIn Insight

Field

Description

LinkedIn partner ID

Partner ID obtained from LinkedIn Campaign Manager.

  • The value cannot be empty.
  • The length cannot exceed 1000 characters.

Twitter

Type

Field

Description

Event

Event type

The value is of the enumerated type. Only one option can be selected.

Twitter Pixel ID

The value cannot be empty and can contain a maximum of 5 characters.

Parameter

Value

The value cannot be empty.

Currency

The value cannot be empty and must be a currency complying with the ISO 4217 standard.

Quantity

The value cannot be empty.

Bing

Type

Field

Description

Basic UET tag

Bing Ads tag ID

The value cannot exceed 20 characters.

UETQ variable ID

The value must be a non-empty string. The default value is uetq.

Event tracking UET tag

Event type

This field is optional, and the options include Page loaded, Changeable revenue, and Custom.

Action

The value cannot exceed 1000 characters.

Category

The value cannot exceed 1000 characters.

Label

The value cannot exceed 1000 characters.

Value

The value is a number ranging from 0 to 9,999,999, with up to 3 decimal places.

Revenue

The value is a number ranging from 0 to 9,999,999, with up to 3 decimal places.

Currency

The value cannot be empty and must be a currency complying with the ISO 4217 standard.

Mixpanel

Type

Field

Description

Flag

Flag

Mixpanel API flag under project settings in Mixpanel. The length cannot exceed 1000 characters.

User

Mapping

Mapping between one ID and another ID. Mixpanel uses a created alias to implement the mapping. Multiple aliases can map to the same identifier. However, an alias cannot map to multiple identifiers. An alias is called once when a user creates a unique ID (for example, when the user registers an account for the first time). Do not use Mapping and Identification at the same time.

The length cannot exceed 1000 characters.

Identification

Character string that uniquely identifies a user. If this parameter is not set, distinct_id in the persistent storage (cookies or local storage) will be used. The length cannot exceed 1000 characters.

Feature

User attributes. The length cannot exceed 1000 characters.

Track transaction value

Value of a transaction.

The value can be any number, including positive numbers, 0, and negative numbers. The length cannot exceed 1000 characters.

Incremental (decremental) value attribute

Incremental (decremental) attribute that can be calculated repeatedly. The length cannot exceed 1000 characters.

Appended list attribute

Attributes that can be repeatedly added to the attribute set.

Tracking event

Tracking event

Type of the event to track. The options include Event, Link, and Form.

Event name

Name of the event to track. The length cannot exceed 1000 characters.

Attribute

Attribute value of the tracked event. The length cannot exceed 1000 characters.

Link element

Link element, which must be a DOM element of a CSS selector that exists on the web page. Otherwise, the event cannot be triggered. The length cannot exceed 1000 characters.

Form element

Form element, which must be a DOM element of a CSS selector that exists on the web page. Otherwise, the event cannot be triggered. The length cannot exceed 1000 characters.

Super attribute

Super attributes that are included in all events.

Others

Enable EU endpoint

Indicates whether to enable the EU endpoint. Mixpanel users in the EU can choose to send their data to Mixpanel's EU data center, and have it stored in the EU.

Persistence type

Data storage type. The options include cookie and localStorage.

Cross-subdomain cookies

Indicates whether to enable cross-subdomain cookies.

Security cookies

Indicates whether to enable security cookies.

Cookie

Cookie name. The length cannot exceed 1000 characters.

Clicky

Field

Description

Website ID

Unique numeric ID of a website. A request must contain the website ID. You can obtain the website ID from the website preferences page. The length cannot exceed 50 characters.

Hyperlink URL

URL of the tracked website. The length cannot exceed 1000 characters.

Title

Title name. The length cannot exceed 1000 characters.

Visitor

User who triggers the event. The length of the key or value cannot exceed 1000 characters.

Goal

Tracking goal. The ID will be reported if ID or Name is set to a number, and the name will be reported if ID or Name is set to a string. The length cannot exceed 1000 characters.

Split testing

A website or domain name can be split into different versions for tracking. The length cannot exceed 1000 characters.

Survicate Widget

Type

Field

Description

Workspace key

Workspace key

Unique workspace key of a Survicate account.

-

Personal information

Indicates whether to enable personal information.

Personal information

Respondent identity

Identity of the respondent. The length cannot exceed 1000 characters.

First name

First name of a respondent. The length cannot exceed 1000 characters.

Last name

Last name of a respondent. The length cannot exceed 1000 characters.

Email address

Email address of a respondent. The length cannot exceed 1000 characters.

Organization

Organization to which a respondent belongs. The length cannot exceed 1000 characters.

Department

Department to which a respondent belongs. The length cannot exceed 1000 characters.

Position

Job title of a respondent. The length cannot exceed 1000 characters.

Phone number

Phone number of a respondent. The length cannot exceed 1000 characters.

Website

Website URL of a respondent. The length cannot exceed 1000 characters.

Country/Region

Country/Region of a respondent. The length cannot exceed 1000 characters.

Address 1

Address 1 information of a respondent. The length cannot exceed 1000 characters.

Address 2

Address 2 information of a respondent. The length cannot exceed 1000 characters.

City

City of a respondent. The length cannot exceed 1000 characters.

Province/State

Province or state of a respondent. The length cannot exceed 1000 characters.

Postal code

Postal code of a respondent. The length cannot exceed 1000 characters.

Fax

Fax number of a respondent. The length cannot exceed 1000 characters.

Annual income

Annual income of a respondent. The length cannot exceed 1000 characters.

Employee

Employee information of a respondent. The length cannot exceed 1000 characters.

Custom attributes

Custom attributes in key-value pair format. Up to 100 attributes are allowed.

AdGlare

Field

Description

Domain name

Domain name on AdGlare, which can be obtained through the ad tag generator.

Region ID

Zone ID on AdGlare. You can click Properties on AdGlare to view the zone ID.

HTML tag ID

This parameter is valid only for Display Ad. If the span node with the zone ID is not embedded on the web page, AdGlare will automatically create a span node in the specified HTML container. The length cannot exceed 1000 characters.

Redirect

Indicates whether Ad Type is HTTP 302 Redirect. Select the check box if Ad Type corresponding to the zone ID is HTTP 302 Redirect.

By default, this field is deselected.

Keyword

Keywords are separated by commas (,).

The keyword can contain only letters, digits, and underscores (_).

The keyword is case insensitive and must contain at least three characters.

Key-value pair

AdGlare will read the key value from this parameter if it fails to read the specified key value from cookies or JavaScript global domain.

The key or value can contain only letters, digits, and underscores (_).

The key must contain 3 to 1000 characters.

The value cannot exceed 40 characters.

Quora Pixel

Type

Field

Description

Pixel

Pixel ID

Unique ID of a Quora pixel, which can be obtained from your Quora Pixel account. The value must be a string of 32 characters.

The value consists of letters and digits only.

Tracking

Event type

Type of the event to track. The value is of the enumerated type. Only one option can be selected.

Email address

Email address, for example, name@xyz.com.

Getsitecontrol

Field

Description

Website ID

Site ID that can be obtained on the Getsitecontrol website.

To obtain the site ID, sign in to the website, go to Sites, and click Install code. Then, you can view a code snippet which looks like this:

script type="text/javascript"
async scr="//1.getsitecontrol.com/xxxxxxxx.js"

In the code snippet, xxxxxxxx indicates the site ID.

Hotjar

Field

Description

Hotjar website ID

Website ID that can be obtained from the site page of a signed-in Hotjar account. The length cannot exceed 1000 characters.

Quantcast Advertise

Field

Description

P-code

Unique Quantcast account ID.

The length cannot exceed 1000 characters.

Revenue

Total purchase amount, which can be used to optimize higher-value converters to improve the return on advertising spending.

Order ID

Unique order ID used to verify the conversion of an ad campaign.

User ID

ID of a user. You can add a variable, such as the email address of the signed-in user, to the user ID.

The length cannot exceed 1000 characters.

AdRoll

Type

Field

Description

Pixel

Advertising ID

Unique advertising ID on the AdRoll Smart Pixel website. The length cannot exceed 1000 characters.

Pixel ID

Unique pixel ID on the AdRoll Smart Pixel website. The length cannot exceed 1000 characters.

Tracking

Event name

Name of an event. The value is of the enumerated type. Only one option can be selected.

The default value is PageView.

Conversion value

Conversion value assigned based on the actions a user completes while on the website. The value must be a number with up to 1000 characters.

Currency

Currency of the conversion value, which must comply with the ISO 4217 standard.

Email

Email address of the visitor. The length cannot exceed 1000 characters.

Audience

Audience name on the AdRoll Smart Pixel website. The length cannot exceed 1000 characters.

Product attribute

Product attribute

Attribute of a product. You can select a variable created on the Variable tab page, including product_id, product_group, quantity, price, and category.

The product_id parameter is mandatory. For details, please refer to Product Attribute Sample Code.

[h2]Product Attribute Sample Code

<script>
        recordTier.push({
          aspProductItem: [{ // aspProductItem is the name of the recordTier variable, which needs to be created on the Variable page in DTM.
           'product_id': 'A',
           'product_group': '1',
           'quantity': '1',
           'price': '1500',
           'category': 'abc'
          }, {
           'product_id': 'B',
           'product_group': '2',
           'quantity': '20',
           'price': '2.99',
           'category': 'xyz'
          }]
        });
    </script>

Lucky Orange

Field

Description

User ID

User ID on the Lucky Orange website. The length cannot exceed 1000 characters.

Localize TMS Integration

Field

Description

Project key

Unique project key that is generated when a project is created in Localize TMS Integration. You can view the project key on the project overview page at https://help.localizejs.com.

Message Mate

Field

Description

Token

Message mate token provided by OwnerListens Message Mate. The length cannot exceed 1000 characters.

Shareaholic

Field

Description

Website ID

Unique website ID automatically generated by Shareaholic when a website is created. You can view the website ID in website settings on the official Shareaholic website. The length cannot exceed 1000 characters.

K50 Tracking Tag

Field

Description

Counter ID

Counter ID in the counter list of K50 Tracker.

Crazy Egg

Field

Description

Account

User account provided by Crazy Egg.

Track by name

If this parameter is selected, the tag will track events by the configured snapshot name.

By default, this field is deselected.

Snapshot name

Snapshot page name. The length cannot exceed 1000 characters.

Pushnews

Field

Description

Website ID

Unique website ID automatically generated by Pushnews when a website is created. You can view the website ID in My Sites on the official Pushnews website. The length cannot exceed 1000 characters.

Nudge Content Analytics

Field

Description

Account ID

Unique account ID automatically generated by Nudge. You can view the ID in the personal information on the official Nudge website.

Visitor Analytics

Field

Description

Website ID

ID of a website, which is generated on Visitor Analytics during registration.

Browsee

Field

Description

Project key

Key generated when a project is created on Browsee. You can sign in to Browsee, go to Settings > Install, and view the code snippet to obtain the key.

Smartlook

Field

Description

Project key

Key generated when a project is created on Smartlook.

Quantcast Measure

Field

Description

P-code

Quantcast account ID.

User ID

Unique ID of a user. You can add a variable, such as the email address of the signed-in user, to the user ID.

UserLeap

Field

Description

App ID

Environment ID in the settings on the dashboard of UserLeap.

Personal information

Other user information except for the app ID. Select a value from the drop-down list box. The options include Install, User ID, User Attribute, User Email, and Event.

User ID

ID of a user. This field is displayed only when Personal information is set to User ID. The length cannot exceed 1000 characters.

Custom parameter

Custom information to report. This field is displayed only when Personal information is set to User Attribute. Up to 100 key-value pairs are allowed, and the length of each key-value pair cannot exceed 1000 characters.

Email address

Email address of a user. This field is displayed only when Personal information is set to User Email. The length cannot exceed 1000 characters.

Event name

Name of a triggered event in UserLeap. This field is displayed only when Personal information is set to Event. The length cannot exceed 1000 characters.

Unregistered events can be reported only when UserLeap is configured to accept custom events.

Mouseflow

Field

Description

Website ID

Website ID in the settings of the Mouseflow website.

HTML delay

Time delayed for the Mouseflow website to track the target website. The value must be 0 or a positive integer, and cannot exceed 1000 characters.

It is recommended that the delay be less than 10,000 milliseconds.

Custom variable

Custom information to report. Up to 100 key-value pairs are allowed, and the length of each key-value pair cannot exceed 1000 characters.

Amplitude

Field

Description

API key

API key obtained on the Amplitude website.

User ID

ID of a user. The length cannot exceed 1000 characters.

Device ID

ID of a device. The length cannot exceed 1000 characters.

User attributes

Attributes of a user. Up to 100 key-value pairs are allowed, and the length of each key-value pair cannot exceed 1000 characters.

Reset session ID

Indicates whether to reset the current session ID when the event is reported.

If this check box is deselected, the current session ID will not be reset when the event is reported.

Exit tracking

Indicates whether to quit tracking a user. If this check box is selected, no event will be reported to the Amplitude website.

Report type

Type of report. You can select a value from the drop-down list box. The options include logEvent, logEventWithGroups, and logRevenueV2.

Event name

Name of the reported product. The length cannot exceed 1000 characters.

Event parameters

Parameters of an event. Up to 100 key-value pairs are allowed, and the length of each key-value pair cannot exceed 1000 characters.

Group

Group of a user. This field is displayed only when Report type is set to logEventWithGroups. You can add a user to one or more groups. Up to 100 key-value pairs are allowed, and the length of each key-value pair cannot exceed 1000 characters.

ID

ID of a product. This field is displayed only when Report type is set to logRevenueV2. The length cannot exceed 1000 characters.

Price

Price of a product. This field is displayed only when Report type is set to logRevenueV2. The value must be a number and cannot exceed 1000 characters.

Quantity

Number of products. This field is displayed only when Report type is set to logRevenueV2. The default value is 1. The value must be a number and cannot exceed 1000 characters.

Revenue type

Type of revenue. This field is displayed only when Report type is set to logRevenueV2. The length cannot exceed 1000 characters.

Algolia Search Instant

Field

Description

App ID

Unique ID of an app, which is used for identity verification for using APIs of Algolia. You can obtain the app ID in API Keys on the Algolia website.

API key

Public API key used in the frontend code. The key is only used for search and sending events to Insights.

Index name

Index name defined during index creation on the Algolia website. The length cannot exceed 1000 characters.

Search box label ID

Label ID of a search box. If a DIV node with this field is embedded into a page and the field value is the same as the ID configured on the page, Algolia will automatically create a search box in the specified HTML container. The length cannot exceed 1000 characters.

Content label ID

Label ID of content. If a DIV node with this field is embedded into a page and the field value is the same as the ID configured on the page, the searched data content will be displayed. The length cannot exceed 1000 characters.

Conversify Tag Template

Field

Description

API Key

API key obtained from the Conversify website. The value is a string of 32 characters.

Enable Page Type

Indicates whether to enable the page type function.

Page Type

Type of the page that a visitor browses. This parameter is available when Enable Page Type is selected. The options are index, list, product, shoppingcart, checkout_process, checkout_complete, and misc.

Product Variables

Additional product information, which is specified by Key and Value in key-value pair format. The product object has two standard variables: id and stock.

Custom Variables

Custom variables that are passed to the Conversify service for use in Notification settings on the Conversify website.

Enable Tracking Conversions

Indicates whether to track the performance of Conversify. If yes, select this parameter.

Tracking Conversions

If you select this parameter, enter an actual conversion value, in cents. The value must be a positive integer.

Crisp Chat

Type

Field

Description

-

Website ID

Website ID provided by Crisp Chat. To view the website ID, go to Settings > Website Settings > Setup Instructions on Crisp Chat.

-

Add Operation

Indicates whether to add an operation. By default, this field is deselected.

-

Operation Type

Operation type that Crisp Chat supports. The options are as follows:

  • Perform an action
  • Set a Value
  • Runtime Configuration

Perform an action

Action Type

Operation type. The options are as follows:

  • Open Chatbox
  • Close Chatbox
  • Toggle Chatbox
  • Show Chatbox
  • Hide Chatbox
  • Send Message
  • Show Message
  • Read Message
  • Start Thread
  • End Thread
  • Reset Session

Set a Value

Value Type

Value type. The options are as follows:

  • Message Text
  • User Email
  • User phone number
  • User Nickname

Text Message

Message text, which can contain a maximum of 1000 characters.

Runtime Configuration

Configuration type

Type of the chat box during chatting. The options are as follows:

  • Availability Tooltip
  • Hide when on vacation
  • Hide when away
  • Hide when mobile
  • Show Operator Count
  • Reverse Chat Position
  • Mute Sound
  • Chatbox Color Theme

Value

The default value is Enable.

-

Enable Event Listening

Indicates whether to enable event listening. If event listening is enabled, DTM will listen for triggered events and save the event information to the recordTier. By default, this field is deselected.

-

Event Type

Type of the listened event. The options are as follows:

  • session:loaded
  • chat:initiated
  • chat:opened
  • chat:closed
  • message:sent
  • message:received
  • message:compose:sent
  • message:compose:received
  • user:email:changed
  • user:phone:changed
  • user:nickname:changed
  • user:avatar:changed
  • website:availability:changed
  • helpdesk:queried

Drift Pixel

Field

Description

Embed ID

Embed ID provided by Drift Pixel. To obtain the ID, go to Settings > Drift Widget > Install > JavaScript on Drift Pixel.

Enable widget controlling

Indicates whether to enable the widget management function. By default, this field is deselected.

Action Name

Name of the action to be executed. This parameter is available when Enable widget controlling is selected. The options are as follows:

  • hide
  • show
  • openChat
  • toggleChat

Enable Event Listening

Indicates whether to enable event listening. If event listening is enabled, DTM will listen for triggered events and save the event information to the recordTier. By default, this field is deselected.

Event Name

Name of the listened event. The options are as follows:

  • chatOpen
  • chatClose
  • welcomeMessage:open
  • awayMessage:close
  • welcomeMessage:close
  • awayMessage:open
  • campaign:dismiss
  • sliderMessage:close
  • startConversation
  • message:sent
  • message
  • emailCapture
  • phoneCapture
  • scheduling:requestMeeting
  • scheduling:meetingBooked
  • conversation:playbookFired
  • Conversation:playbookClicked
  • conversation:playbookDismissed
  • conversation:buttonClicked
  • conversation:firstInteraction
  • gdprClicked
  • driftEventName
  • driftEventData

Easyfeedback Tracking Code

Field

Description

Tracking ID

Tracking ID provided by Easyfeedback. To obtain the ID, go to ACCOUNT > Account data > Integration > Tracking code website on Easyfeedback.

CookieConsent.io

Field

Description

CookieConsent.io ID

CookieConsent.io ID provided by CookieConsent.io.

You can obtain the ID from the registration email sent by CookieConsent.io.

Hidden Cookie Consent

Indicates whether to hide cookie consent. By default, this field is deselected.

Enable Backdrop

Indicates whether to display the backdrop. By default, this field is deselected.

Enable Functional

Indicates whether to enable the Functional Cookies function. By default, this field is deselected.

Enable Analytics

Indicates whether to enable the Analytics Cookies function. By default, this field is deselected.

Enable Marketing

Indicates whether to enable the Marketing Cookies function. By default, this field is deselected.

Activate the Functional Cookies option by default

Indicates whether to enable the Functional Cookies option. By default, this field is deselected.

Before enabling this parameter, ensure that you have selected Enable Functional.

Activate the Analytics Cookies option by default

Indicates whether to enable the Analytics Cookies option. By default, this field is deselected.

Before enabling this parameter, ensure that you have selected Enable Analytics.

Activate the Marketing Cookies option by default

Indicates whether to enable the Marketing Cookies option. By default, this field is deselected.

Before enabling this parameter, ensure that you have selected Enable Marketing.

Hide Horizontal Rule

Indicates whether to hide the horizontal rule. By default, this field is deselected.

Position

Position of cookie consent. The options are as follows:

  • center
  • bottom
  • top

Transform Title

Transforms the text format of the title. The options are as follows:

  • none
  • capitalize
  • lowercase
  • uppercase
  • default

Font Family

Consent font family. The font family (for example, Verdana) must be supported by the browser.

Button 1 Color

Color of the Allow all button. The value must be a hexadecimal color code, for example, #1ab530.

Button 2 Color

Color of the Cookie settings button. The value must be a hexadecimal color code, for example, #b1b3b1.

Button 3 Color

Color of the Save settings button. The value must be a hexadecimal color code, for example, #000000.

Pill Color

Color of the Pill button. The value must be a hexadecimal color code, for example, #000000.

Header Font Size

Font size of the header, in pixels. The value must be a positive integer.

Subheader Font Size

Font size of the subheader, in pixels. The value must be a positive integer.

Body Font Size

Font size of the body, in pixels. The value must be a positive integer.

Always Active Font Size

Font size of the Always active label, in pixels. The value must be a positive integer.

Backdrop Color

Color of the backdrop. The value must be a hexadecimal color code, for example, #000000.

Before enabling this parameter, ensure that you have selected Enable Backdrop.

Consent Window Height

Height of the consent window, in pixels. The value must be a positive integer.

Enable Event Listening

Indicates whether to enable event listening. If event listening is enabled, DTM will listen for triggered events and save the event information to the recordTier. By default, this field is deselected.

Event Name

Name of the event to be listened. The options are as follows:

  • CookieConsentInitialize
  • CookieConsentSaved
  • CookieConsentAllowAllButtonClicked
  • CookieConsentCookieSettingsButtonClicked
  • CookieConsentWhatAreCookiesButtonClicked
  • CookieConsentSaveSettingsButtonClicked
  • cookieconsent_necessary
  • cookieconsent_statistics
  • cookieconsent_functional
  • cookieconsent_marketing

Channel.io

Field

Description

Plugin Key

Plugin key provided by the Channel Plugin website. You can go to Settings > Install and configuration on the Channel Plugin website to view the key.

Enable optional settings

Indicates whether to enable optional settings. If this parameter is selected, seven optional parameters will be displayed:

  • Member ID
  • Member Hash
  • Custom Launcher Selector
  • Z-index
  • Unsubscribed
  • Hide Popup
  • Profile

By default, this field is deselected.

Member ID

ID of a member, which is available only after you select the Enable optional settings check box.

Member Hash

Hashed value of the member ID using SHA-256, which is available only after you select the Enable optional settings check box.

Custom Launcher Selector

CSS selector for custom button, which is available only after you select the Enable optional settings check box.

Z-index

Z-index of the custom plugin button, which is available only after you select the Enable optional settings check box.

Unsubscribed

Indicates whether to unsubscribe from marketing messages, which is available only after you select the Enable optional settings check box. By default, this field is deselected.

Hide Popup

Indicates whether to hide the marketing and notification message popup, which is available only after you select the Enable optional settings check box. By default, this field is deselected.

Profile

Indicates whether to enable the profileOptional.help file, which is available only after you select the Enable optional settings check box. By default, this field is deselected.

The profileOptional.help file contains user information such as the email address, mobile number, tag name, avatar URL, and custom value.

Email

Email address, which is available only after you select the Enable optional settings and Profile check boxes.

Mobile Number

Mobile number, which is available only after you select the Enable optional settings and Profile check boxes.

Name

Tag name, which is available only after you select the Enable optional settings and Profile check boxes.

Avatar URL

Avatar URL, which is available only after you select the Enable optional settings and Profile check boxes.

Custom Value

Custom value, which is available only after you select the Enable optional settings and Profile check boxes.

Action

If you want more control beyond what is offered through the Channel IO, you can use actions to control aspects of the widget programmatically. The available actions are as follows:

  • Track (Send event)
  • Boot
  • Shut Down
  • Show Messenger
  • Hide Messenger
  • Open Chat
  • Clear Callback
  • Update User
  • Add Tag
  • Remove Tags
  • Reset Page
  • Show Channel Button
  • Hide Channel Button

Event Name

Event name, which is available only after you select the Enable optional settings check box and set Action to Track (Send event). The name length cannot exceed 30 characters.

Event Property

Event property, which is available only after you select the Enable optional settings check box and set Action to Track (Send event).

Up to 100 key-value pairs are allowed, and the length of each key or value cannot exceed 1000 characters.

Chat ID

Chat ID, which is available only after you select the Enable optional settings check box and set Action to Open Chat.

Message

Message content, which is available only after you select the Enable optional settings check box and set Action to Open Chat.

Language

Language, which is available only after you select the Enable optional settings check box and set Action to Update User.

If you set this field to a valid value such as ko or ja, the UI language will be changed to the set one. If you set this field to an invalid value or leave this field empty, the UI language will be set to English.

Tags

Relevant tag to be overwritten, which is available only after you select the Enable optional settings check box and set Action to Update User.

You can set up to 10 tags. If the tag content is empty, the tag will be reset.

Unsubscribed

Indicates whether to unsubscribe from marketing messages, which is available only after you select the Enable optional settings check box and set Action to Update User. The default value is Enable.

Profile

Indicates whether to overwrite the property configuration file, which is available only after you select the Enable optional settings check box and set Action to Update User. The default value is Enable.

If the profile map is empty, it will be reset.

Email

Email address, which is available only after you select the Enable optional settings check box and set Action to Update User and Profile to Enable.

Mobile Number

Mobile number, which is available only after you select the Enable optional settings check box and set Action to Update User and Profile to Enable.

Name

User name, which is available only after you select the Enable optional settings check box and set Action to Update User and Profile to Enable.

Profile Once

Indicates whether to overwrite the property configuration file once only, which is available only after you select the Enable optional settings check box and set Action to Update User. The default value is Enable.

Email

Email address, which is available only after you select the Enable optional settings check box and set Action to Update User and Profile Once to Enable.

Mobile Number

Mobile number, which is available only after you select the Enable optional settings check box and set Action to Update User and Profile Once to Enable.

Name

User name, which is available only after you select the Enable optional settings check box and set Action to Update User and Profile Once to Enable.

Enable Receiving Event

Indicates whether to enable the event listening function. If yes, the selected events will be detected after being triggered. By default, this field is deselected.

ChannelIO Event

Name of the listened event. The options are as follows:

  • OnShowMessenger
  • OnHideMessenger
  • OnBagdeChanged
  • OnChatCreated
  • OnProfileChanged
  • OnUrlClicked

Cookiebot CMP

Field

Description

Cookiebot ID

Cookiebot ID provided by the Cookiebot website. You can view the value of Domain Group ID on the Your Scripts page on the Cookiebot website. This value is the Cookiebot ID.

Enable Operation

Indicates whether to enable an operation. By default, this field is deselected.

Operations

Operation to be enabled. After you select the Enable Operation check box, the following operation options are available for selection:

  • show
  • hide
  • renew
  • set Default Consent
  • withdraw Default Consent State

Preferences

Default consent state for preference cookies, which is available only after you select the Enable Operation check box and set Operations to set Default Consent. The default value is denied.

Statistics

Default consent state for statistics cookies, which is available only after you select the Enable Operation check box and set Operations to set Default Consent. The default value is denied.

Marketing

Default consent state for marketing cookies, which is available only after you select the Enable Operation check box and set Operations to set Default Consent. The default value is denied.

Wait For Update

Delay for triggering the tag, in milliseconds.

Enable Event Listening

Indicates whether to enable the event listening function. If yes, the selected events will be detected after being triggered. By default, this field is deselected.

Events

Name of the listened events. The options are as follows:

  • CookiebotOnConsentReady
  • CookiebotOnLoad
  • CookiebotOnAccept
  • CookiebotOnDecline
  • CookiebotOnDialogInit
  • CookiebotOnDialogDisplay
  • CookiebotOnTagsExecuted

Gorgias Chat

Field

Description

Gorgias Chat App ID

You can go to Settings > Integrations > Chat > Installation on the Gorgias website to view the Gorgias Chat App ID.

Dreamdata - B2B Revenue Attribution

Field

Description

Dreamdata API Key

API key on the Dreamdata website. You can go to Installation > Sources on the Dreamdata website to obtain the API key.

The value contains 36 characters, in {xxxxxxxx}-{xxxx}-{xxxx}-{xxxx}-{xxxxxxxxxxxx} format.

Example: 99a999ff-000f-00f0-9909-099f0999f909

Turn on an additional auto-identify script

If this parameter is selected, you can add an additional script to specify which track monitors form submissions. If the script detects an input email address, it will use the email address as the user's email address, that is, associate the email address with the user's cookie ID.

By default, this field is deselected.

Track

Conversion name, which must be meaningful. Do not enter any HTML element ID. Otherwise, it will make the page incompatible with our codes.

Page

Page parameter, which is a conversion type.

Dashly

Field

Description

Website ID

Website ID on the Dashly website. You can find the website ID on the installation page in the Dashly Starter guide. Click the Copy website ID button to copy it.

The value is a string of 32 characters.

Fixel Tracking Code

Field

Description

Fixel ID

Fixel ID on the Fixel website. You can find the ID on the Segments page in Fixel.

Livesession

Field

Description

Track ID

Trace IDon the LiveSession website. You can go to the webSite page from the LiveSession settings page and copy the track ID from the TrackID parameter.

Record keystrokes

Indicates whether to enable global keystroke tracking.

Root hostname

Root hostname. To record sessions across different subdomains on your site, you need to set this parameter to the highest-level hostname.

Carrotquest

Field

Description

Website ID

You can find the website ID on the installation page in the Carrotquest Starter guide. Click the Copy website ID button to copy it.

Cookiefirst

Field

Description

CookieFirst API key

API key of your CookieFirst. You can find it on the CookieFirst portal when managing your website.

Stealth mode

Indicates whether to enable the stealth mode. In this mode, CookieFirst Banner does not render any consent-management interface. The only rendered content is the cookie declaration on a page supporting it.

Silent mode

Indicates whether to enable the silent mode. In this mode, CookieFirst Banner does not log any information to the browser console.

Language

If you select this option, when no language attribute is passed to your banner, the user's browser will be checked to determine if their preferred language is one of the languages configured for your banner.

Mailmunch

Field

Description

Site ID

Site ID provided by the Mailmunch website to uniquely identify your site. You can go to Manage Site in the Mailmunch app and view your site ID at the top of the General Settings page.

Poptin

Field

Description

User ID

Unique ID of a user, which is obtained from Poptin after successful registration. The value cannot exceed 1000 characters.

Personyze

Field

Description

Account number

Account number provided by the Personyze website. The value cannot exceed 1000 characters.

Applicable domains

List of domains you want to track, for example, example.com.site.com. Multiple domains are separated by spaces.

Salesfire

Field

Description

Site ID

Site ID provided by the Salesfire website to uniquely identify your site. You can view the site ID under Preferences on Salesfire DashBoard.

Kompassify

Field

Description

Account ID

Account ID provided by the Kompassify website.

Cookiebox

Field

Description

Cookiebox ID

You can find the Cookiebox ID on the domain setting page of the Cookiebox website.

PageSense

Field

Description

Space name

You can obtain the space name in the Project Info area on the Settings page of the PageSense website.

Project key

You can obtain the project key in the Project Info area on the Settings page of the PageSense website.

Data center

You can obtain the data center in the Project Info area on the Settings page of the PageSense website.

AddThis

Field

Description

Site ID

You can find the site ID under Profile Settings of the AddThis website.