Class: Tag

ATInternet.Tracker. Tag

Main Tag Object.

new ATInternet.Tracker.Tag(config, context, trackerCallback)

Tracker/tag.js, line 1
Name Type Description
config object Configuration of the Tag
context object Context of the Tag
trackerCallback function Executed when tracker is ready

Members

staticATInternet.Tracker.Tag.isFormSubmitboolean

Check if it is a form submission action.

bufferBufferManager

Module for buffer management.
See:

builderBuildManager

Module for hit builder.
See:

callbacksCallbacksManager

Module for callback management.
See:

pluginsPluginsManager

Module for plugins management.
See:

propertiesPropertiesManager

Module for properties management.
See:

triggersTriggersManager

Module for triggers management.
See:

inneraisleobject

[Object added by plugin SalesTracker] Tags to track aisle values.
Properties:
Name Type Description
set function Tag helper, see details here ATInternet.Tracker.Tag#aisle.set

inner~~avInsightsObject

[Object added by plugin AvInsights] Tags to manage media measurement.
Properties:
Name Type Description
set function Tag helper, see details here ATInternet.Tracker.Tag#avInsights.Media

innercartobject

[Object added by plugin SalesTracker] Tags to track cart values.
Properties:
Name Type Description
set function Tag helper, see details here ATInternet.Tracker.Tag#cart.set
add function Tag helper, see details here ATInternet.Tracker.Tag#cart.add

innerclickObject

[Object added by plugin Clicks] Tags for clicks.
Properties:
Name Type Description
send function Tagging method for clicks (helper), see details here ATInternet.Tracker.Tag#click.send
set function Alternative tagging method for clicks (helper), see details here ATInternet.Tracker.Tag#click.set

innerclickListenerobject

[Object added by plugin Clicks] Tags for clicks using a listener.
Properties:
Name Type Description
send function Tagging method for clicks (helper), see details here ATInternet.Tracker.Tag#clickListener.send

innerclientSideUserIdobject

[Object added by plugin ClientSideUserId] Tags to manage a user ID on client side mode.
Properties:
Name Type Description
set function Tag helper, see details here ATInternet.Tracker.Tag#clientSideUserId.set

innercustomTreeStructureobject

[Object added by plugin Page] Tags to obtain a completely customised view of all your traffic.
Properties:
Name Type Description
set function Tag helper, see details here ATInternet.Tracker.Tag#customTreeStructure.set

innercustomVarsobject

[Object added by plugin Page] Tags to associate page and site variables specific to your activity.
Properties:
Name Type Description
set function Tag helper, see details here ATInternet.Tracker.Tag#customVars.set

innerdynamicLabelobject

[Object added by plugin Page] Tags to track the history of a page whose content has been modified.
Properties:
Name Type Description
set function Tag helper, see details here ATInternet.Tracker.Tag#dynamicLabel.set

innerecommerceobject

[Object added by plugin Ecommerce] Tags to manage ecommerce sending.
Properties:
Name Type Description
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.cartAwaitingPayment.cart.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.cartAwaitingPayment.products.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.cartAwaitingPayment.shipping.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.cartAwaitingPayment.payment.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.cartAwaitingPayment.transaction.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.displayProduct.products.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.displayPageProduct.products.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.addProduct.cart.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.addProduct.products.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.removeProduct.cart.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.removeProduct.products.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.displayCart.cart.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.updateCart.cart.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.deliveryCheckout.cart.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.deliveryCheckout.shipping.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.paymentCheckout.cart.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.paymentCheckout.shipping.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.transactionConfirmation.cart.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.transactionConfirmation.discount.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.transactionConfirmation.transaction.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.transactionConfirmation.shipping.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.transactionConfirmation.payment.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.transactionConfirmation.customer.set
set function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.transactionConfirmation.products.set
reset function Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.reset
Deprecated
  • {function} set Tag helper, see details here ATInternet.Tracker.Tag#ecommerce.displayCart.products.set

    innereventobject

    [Object added by plugin EventRoot] Tags to manage event sending.
    Properties:
    Name Type Description
    reset function Tag helper, see details here ATInternet.Tracker.Tag#event.reset
    send function Tag helper, see details here ATInternet.Tracker.Tag#event.send
    set function Tag helper, see details here ATInternet.Tracker.Tag#event.set
    set function Tag helper, see details here ATInternet.Tracker.Tag#event.add

    inneridentifiedVisitorobject

    [Object added by plugin IdentifiedVisitor] Tags to identify a visitor.
    Properties:
    Name Type Description
    set function Tag helper, see details here ATInternet.Tracker.Tag#identifiedVisitor.set
    unset function Tag helper, see details here ATInternet.Tracker.Tag#identifiedVisitor.unset

    innerinternalSearchobject

    [Object added by plugin InternalSearch] Tags to manage internal searches data.
    Properties:
    Name Type Description
    set function Tag helper, see details here ATInternet.Tracker.Tag#internalSearch.set
    send function Tag helper, see details here ATInternet.Tracker.Tag#internalSearch.send

    innermvTestingobject

    [Object added by plugin MvTesting] Tags to manage multivariate testing data.
    Properties:
    Name Type Description
    set function Tag helper, see details here ATInternet.Tracker.Tag#mvTesting.set
    add function Tag helper, see details here ATInternet.Tracker.Tag#mvTesting.add

    innerofflineobject

    [Object added by plugin Offline] Tags to manage local storage.
    Properties:
    Name Type Description
    getLength function Tag helper, see details here ATInternet.Tracker.Tag#offline.getLength
    remove function Tag helper, see details here ATInternet.Tracker.Tag#offline.remove
    get function Tag helper, see details here ATInternet.Tracker.Tag#offline.get
    send function Tag helper, see details here ATInternet.Tracker.Tag#offline.send

    innerorderobject

    [Object added by plugin SalesTracker] Tags to track order values.
    Properties:
    Name Type Description
    set function Tag helper, see details here ATInternet.Tracker.Tag#order.set

    innerpageobject

    [Object added by plugin Page] Tags to manage a page.
    Properties:
    Name Type Description
    set function Tag helper, see details here ATInternet.Tracker.Tag#page.set
    send function Tag helper, see details here ATInternet.Tracker.Tag#page.send
    reset function Tag helper, see details here ATInternet.Tracker.Tag#page.reset

    inner~~privacyObject

    [Object added by plugin Privacy] Tags to manage visitor mode context
    Properties:
    Name Type Description
    set function Tag helper, see details here ATInternet.Tracker.Tag#privacy.setVisitorOptout
    set function Tag helper, see details here ATInternet.Tracker.Tag#privacy.setVisitorOptin
    set function Tag helper, see details here ATInternet.Tracker.Tag#privacy.setVisitorRandomID
    set function Tag helper, see details here ATInternet.Tracker.Tag#privacy.setVisitorMode
    set function Tag helper, see details here ATInternet.Tracker.Tag#privacy.getAuthority
    set function Tag helper, see details here ATInternet.Tracker.Tag#privacy.getVisitorMode
    set function Tag helper, see details here ATInternet.Tracker.Tag#privacy.addAuthority
    set function Tag helper, see details here ATInternet.Tracker.Tag#privacy.extendIncludeStorage
    set function Tag helper, see details here ATInternet.Tracker.Tag#privacy.extendIncludeBuffer
    set function Tag helper, see details here ATInternet.Tracker.Tag#privacy.updateStorageDuration

    innerproductobject

    [Object added by plugin SalesTracker] Tags to track viewed products.
    Properties:
    Name Type Description
    add function Tag helper, see details here ATInternet.Tracker.Tag#product.add

    innerpublisherobject

    [Object added by plugin OnSiteAds] Tags for publisher campaigns
    Properties:
    Name Type Description
    set function Tag helper, see details here ATInternet.Tracker.Tag#publisher.set
    add function Tag helper, see details here ATInternet.Tracker.Tag#publisher.add
    send function Tag helper, see details here ATInternet.Tracker.Tag#publisher.send

    innerrichMediaobject

    [Object added by plugin RichMedia] Tags to manage media measurement.
    Properties:
    Name Type Description
    add function Tag helper, see details here ATInternet.Tracker.Tag#richMedia.add
    remove function Tag helper, see details here ATInternet.Tracker.Tag#richMedia.remove
    removeAll function Tag helper, see details here ATInternet.Tracker.Tag#richMedia.removeAll
    send function Tag helper, see details here ATInternet.Tracker.Tag#richMedia.send

    innerselfPromotionobject

    [Object added by plugin OnSiteAds] Tags for self-promotion campaigns
    Properties:
    Name Type Description
    set function Tag helper, see details here ATInternet.Tracker.Tag#selfPromotion.set
    add function Tag helper, see details here ATInternet.Tracker.Tag#selfPromotion.add
    send function Tag helper, see details here ATInternet.Tracker.Tag#selfPromotion.send

    innerstorageobject

    [Object added by plugin Storage] Methods to manage data to store.
    Properties:
    Name Type Description
    get function Tag helper, see details here ATInternet.Tracker.Tag#storage.get
    getPrivate function Tag helper, see details here ATInternet.Tracker.Tag#storage.getPrivate
    set function Tag helper, see details here ATInternet.Tracker.Tag#storage.set
    setPrivate function Tag helper, see details here ATInternet.Tracker.Tag#storage.setPrivate
    del function Tag helper, see details here ATInternet.Tracker.Tag#storage.del
    delPrivate function Tag helper, see details here ATInternet.Tracker.Tag#storage.delPrivate
    cacheInvalidation function Tag helper, see details here ATInternet.Tracker.Tag#storage.cacheInvalidation

    innertagsobject

    [Object added by plugin Page] Tags to define the theme(s) of the content your users visit.
    Properties:
    Name Type Description
    set function Tag helper, see details here ATInternet.Tracker.Tag#tags.set

    innertechClicksobject

    [Object added by plugin Clicks] Tags for clicks.
    Properties:
    Name Type Description
    manageClick function Method for managing redirection after a click, see details here ATInternet.Tracker.Tag#techClicks.manageClick
    deactivateAutoManagement function Method for managing redirection after a click, see details here ATInternet.Tracker.Tag#techClicks.deactivateAutoManagement

    innerutilsobject

    [Object added by plugin Utils]
    Properties:
    Name Type Description
    get function Tag helper, see details here ATInternet.Tracker.Tag#utils.getQueryStringValue
    getPrivate function Tag helper, see details here ATInternet.Tracker.Tag#utils.getLocation

    innerversionstring

    Version of the tracker.

    innerweboramaobject

    [Object added by plugin Weborama] Tags to collect marketing data from Weborama Partner.
    Properties:
    Name Type Description
    set function Tag helper, see details here ATInternet.Tracker.Tag#weborama.set
    callback function Tag helper, see details here ATInternet.Tracker.Tag#weborama.callback

    Methods

    configPlugin(plg, cfg, cbk){object}

    Tracker/tag.js, line 154
    Set the specific configuration of a plugin. If the configuration already exists, set only the undefined properties.
    Name Type Description
    plg string Name of the plugin concerned
    cfg object Value of the plugin configuration
    cbk function Function which be executed if the plugin configuration change

    debug(trigger, level, message, details)

    Tracker/tag.js, line 68
    Use to emit debug triggers.
    Name Type Description
    trigger string Trigger that you want to emit
    level string DEBUG, ERROR, WARNING
    message string
    details * Data you want to transmit to listeners
    Example
    tag.debug('RichMedia:richMedia:remove', 'DEBUG', 'method ended', {playerId: plyr, media: mediaObject});

    delContext(key1, key2)

    Tracker/tag.js, line 223
    Delete context value or parameter value in context(s).
    Name Type Description
    key1 string Context name
    key2 string Context parameter name (first level)
    Example
    tag.delContext('myContext'); //=> Delete 'myContext' content
tag.delContext('myContext', 'param'); //=> Delete 'param' content in 'myContext'
tag.delContext(undefined, 'param');  //=> Delete 'param' content in all contexts

    delParam()

    Tracker/tag.js, line 347
    Use to delete a stored parameter.
    See:

    delProp(key)

    Tracker/tag.js, line 423
    Delete/remove a property
    Name Type Description
    key string Key name of the property

    delProps()

    Tracker/tag.js, line 433
    Delete/remove all properties

    emit(trigger, data)

    Tracker/tag.js, line 49
    Use to trigger event.
    Name Type Description
    trigger string Trigger to emit
    data object Data to transmit to listeners
    See:
    Example
    tag.emit('RichMedia:richMedia:remove', {
      lvl: 'DEBUG',
      msg: 'method ended',
      details: {playerId: plyr, media: mediaObject}
  });

    getAllContext(){*}

    Tracker/tag.js, line 184
    Get all context.

    getConfig(key){*}

    Tracker/tag.js, line 123
    Get configuration.
    Name Type Description
    key string Configuration property name
    Returns:
    property value if exist, undefined if not

    getContext(key){*}

    Tracker/tag.js, line 196
    Get a context variable.
    Name Type Description
    key string Context variable name

    getParam(filterList, withOptions){string|object}

    Tracker/tag.js, line 311
    Get variables from the buffer using the filter given, with possibility of returning options or not.
    Name Type Description
    filterList Array List of key/value(s) in an array. (ex : [[key1,value1],[key2,[value2A,value2B]]]) Filter on variable's options
    withOptions boolean If true only returns value else returns object with value and options
    See:
    Example
    // This filter will get variables with hitType 'page' OR 'all', AND with permanent true
var filter = [
 ['hitType',['page','all']],
 ['permanent',true]
]

var dataObj = tag.getParam(filter, true); // true to get options
dataObj = {
 'variableExample' : {
     _value:'value',
     _options: {
         hitType:['page'],
         permanent:true
     }
  }
}

var dataObj = tag.getParam(filter); // no option in results
dataObj = {
 'variableExample':'value'
}

    getParams(param){string|object}

    Tracker/tag.js, line 297
    Use to get the collection of hit parameters stored (or a value if a parameter name is given).
    Name Type Description
    param string Parameter name (optional)
    See:

    getProp(key)

    Tracker/tag.js, line 442
    Get a property
    Name Type Description
    key string Key name of the property

    getProp(){object}

    Tracker/tag.js, line 452
    Get all properties

    onTrigger(trigger, callback){number}

    Tracker/tag.js, line 92
    Use to add a trigger listener.
    Name Type Description
    trigger string Trigger you want to subscribe
    callback function Method that you want to be triggered
    See:
    Returns:
    ID
    Example
    // It returns the ID of the callback so you can delete it if needed.
var idCallback = tag.onTrigger('myTrigger', callback(trig, data, idCallbackBis){});

    sendHit(customParams, filters, callback, requestMethod, elementType)

    Tracker/tag.js, line 462
    Send the hit and call the callback if present The hit will integrate parameters stored
    Name Type Description
    customParams object Object which contains some hit parameters that you would like to send specifically (they are given priority over the current buffer)
    filters Array List of buffer filters
    callback function Callback to execute
    requestMethod string Overloading the global method of sending hits (GET|POST)
    elementType string Element type (mailto, form, redirection)
    See:

    sendUrl(hit)

    Tracker/tag.js, line 367
    Send single hit from complete url. An event will be sent thanks to TriggersManager :
    - "Tracker:Hit:Sent:Ok" with the hit as data if succeed,
    - "Tracker:Hit:Sent:Error" with error as data otherwise.
    Name Type Description
    hit string Url to send
    See:

    setConfig(key, value, ifNotExist){*}

    Tracker/tag.js, line 136
    Set configuration.
    Name Type Description
    key string Configuration property name
    value * Configuration property value
    ifNotExist boolean If true, the property will only be set if the configuration property doesn't exist

    setContext(key, value)

    Tracker/tag.js, line 209
    Set a context variable.
    Name Type Description
    key string context variable name
    value *

    setParam(name, value, options)

    Tracker/tag.js, line 281
    Set value for a hit variable (overrides if present).
    Name Type Description
    name string Name of the hit variable
    value string | number | function | Array value of the hit variable
    options object Configuration of the variable, if no hitType defined, it will be "page" by default
    See:
    Example
    tag.setParam('test1', 'val1', {hitType: ['test', 'click'], permanent: true, encode: true});

    setProp(key, value, permanent)

    Tracker/tag.js, line 400
    Set a property (overrides if present)
    Name Type Description
    key string Key name of the property
    value string | number | Array value of the property
    permanent boolean Permanence of property

    setProps(props, permanent)

    Tracker/tag.js, line 412
    Set multiple properties
    Name Type Description
    props object Object to be added
    permanent boolean Permanence of object properties

    innerdispatch(callback, elementType)

    Utils/utils.js, line 243
    [Helper added by plugin Utils] Dispatch all tags.
    Name Type Description
    callback function Callback to execute
    elementType string Element type (mailto, form, redirection)

    innerdispatchRedirect(tagObject){boolean}

    Utils/utils.js, line 289
    [Helper added by plugin Utils] Dispatch all tags (with automatic redirect management).
    Name Type Description
    tagObject object Tag object, used here to tell how we have to do the redirection (url/target)