Back

This article describes how to configure the Monetate tag in your iQ Tag Management (TiQ) account.

In this article:

Table of Contents Placeholder

How it Works

The Monetate tag enables online businesses to implement superior marketing strategies and quickly and easily test and target website content and features, resulting in more relevant and compelling website experiences.

Tag Configuration

First, go to the Tag Marketplace and add the Monetate tag to your profile (see How to Add a Tag).

After adding the tag, configure the below settings:

  • Title
    • Enter a title.
    • Assign a unique name when using multiple tags by the same vendor.
  • Library loaded on page
    • Select True if you are loading the Monetate tag on your page instead of through TiQ.
    • Value Options: True or False
  • Monetate HTTPS URL
    • The URL provided to you by Monetate in your tracking code snippet.
    • When entering your Monetate URL /d/ is development and /p/ is production.
      Example: //se.monetate.net/js/2/a-[ACCOUNT ID]/p/[Domain URL]/custom.js
  • Use AddCartRows on all pages
    • Allows the cart data to be sent with all page types.
    • Value Options: True or False
  • Poll for Element
    • Used to add a delay to the trackData call until a page element exists.
    • You will also need to map Poll Element in the Standard Mapping Toolbox.
    • Value Options: True or False
  • Poll Element
    • Name of the element to wait for when using Poll for Element

Load Rules

Load Rules determine when and where to load an instance of this tag on your site.

Recommended Load Rule: All Pages

Data Mappings

Mapping is the process of sending data from a data layer variable to the corresponding destination variable of the vendor tag. For instructions on how to map a variable to a tag destination, see data mappings.

The destination variables for the Monetate tag are built into the Data Mapping tab. With the Monetate tag, you can use mapping to:

  • Override the standard configuration values
  • Override the E-Commerce extension values
  • Configure event triggers
  • Send required and optional event parameters

The following tables list the available Standard and E-Commerce categories:

Standard

Destination Name Description

Page Type

page_type

  • Used to identify the page the user is viewing.
  • Used in setPageType method when populated.
  • Can also be used to override the default name of a page type.
  • Triggers special actions on index/search/category, product, cart, purchase/order, and conversion pages.

Poll For Element

poll_for_element

  • Used to enable the addPollForElement method to add a delay to the trackData call until a page element exists.
  • You will also need to map Poll Element.
  • Value Options: True or False

Poll Element

poll_element

  • Used in the addPollForElement method as the CSS selector to identify the element on the page to poll for.
  • Upon successful completion, it is not re-evaluated on subsequent retracks.

Breadcrumbs

breadcrumbs

  • An ordered list representing the breadcrumb trail for a user's navigation.
  • Used in the addBreadcrumbs method whenever populated.

Custom Variable

variable.custom

  • Used with setCustomVariables to set a custom variable.
  • Map to the variable containing the desired value and replace "custom" in the mapping name with the name of your variable.
  • Example:
    • In your data layer: utag_data.member_status = "Platinum"
    • Data mapping: member_status:variable.rewardStatus
  • Result:

monetateQ.push(['setCustomVariables', [
{name: 'rewardStatus', value: 'Platinum'}
]]);

List of Conversion IDs

conversion_id

  • Used with addConversionRows to set the itemId property associated with a non-monetary conversion.
  • Example:

window.monetateQ.push([
"addConversionRows",
[{
"itemId" : "conversionNameString",
"quantity" : "quantityString",
"unitPrice" : "valueString",
}]
]);

List of Conversion Quantities

conversion_quantity

  • Used with addConversionRows to set the quantity property associated with a non-monetary conversion.

List of Conversion Prices

conversion_unit_price

  • Used with addConversionRows to set the unitPrice property associated with a non-monetary conversion.

Track Custom Event

track_event

  • A Boolean value used to indicate if custom events should be tracked.

Event Name

event_name

  • Used with the trackEvent method to send a custom eventt.
  • Example:
    window.monetateQ.push(["trackEvent", ["customEventHere"]]);

E-Commerce

Since the Monetate tag is e-commerce enabled, it will automatically use the default E-Commerce Extension mappings. Manually mapping in this category is generally not needed unless:

  • You want to override any extension mappings
  • Your desired e-commerce variable is not offered in the extension
Destination Name Description

Order ID

order_id

  • The unique order Id for the current transaction.
  • Used on purchase/order pages. Defaults to the E-Commerce value _corder.

Order Total

order_total

  • The order total for the current page or transaction. Used on cart and purchase/order pages in the addCartRows or addPurchaseRows methods.
  • Defaults to the E-Commerce value _ctotal.

Sub Total

order_subtotal

  • The order subtotal for the current page or transaction.Used on cart and purchase/order pages in the addCartRows or addPurchaseRows methods.
  • Defaults to the E-Commerce value _csubtotal.

Shipping Amount

order_shipping

  • The order shipping for the current page or transaction.Used on cart and purchase/order pages in the addCartRows or addPurchaseRows methods.
  • Defaults to the E-Commerce value _cship.

Tax Amount

order_tax

  • The order tax for the current page or transaction.Used on cart and purchase/order pages in the addCartRows or addPurchaseRows methods.
  • Defaults to the E-Commerce value _ctax.

Currency

order_currency

  • The order currency for the current page or transaction.Used on cart and purchase/order pages in the addCartRows or addPurchaseRows methods.
  • Defaults to the E-Commerce value _ccurrency.

Order Discount

order_discount

  • The order discount for the current page or transaction.
  • Used on cart and purchase/order pages in the addCartRows or addPurchaseRows methods.

List of Product IDs

product_id

  • A list of product IDs for the current page or transaction.
  • Used on index/search/category ( addProducts), product ( addProductDetails), cart ( addCartRows), and purchase/order pages ( addPurchaseRows).
  • Defaults to the E-Commerce value _cprod.
  • Map to List of Product IDs to override the list sent on Index and Product pages.

List of SKUs

product_sku

  • A list of product SKUs for the current page or transaction.
  • Used on cart and purchase/order pages. Defaults to the E-Commerce value _csku.

    If your Monetate library version is prior to Version 1.6.0 in July 4, 2018, do no send Product SKUs on Product Detail pages or simply update your library version.

List of Categories

product_category

  • A list of product categories.
  • Used in the addCategories method whenever populated.
  • Defaults to the E-Commerce value _ccat.

List of Quantities

product_quantity

  • A list of product quantities for the current page or transaction.
  • Used on cart and purchase/order pages.
  • Defaults to the E-Commerce value
_cquan.

List of Prices

product_unit_price

  • A list of product prices for the current page or transaction.
  • Used on cart and purchase/order pages.
  • Defaults to the E-Commerce value _cprice.

Custom Order Data

orderData.custom

  • A custom item of order data for the current page or transaction.
  • Map to the variable containing the desired value and replace "custom" in the mapping name with the name of your variable in format _CUSTOM.
  • Used on cart and purchase/order pages. Used in the addCartRows or addPurchaseRows methods whenever populated.

Vendor Documentation