Site JavaScript-API

Sets a possible custom identifier by which the user is uniquely defined. Typically this will be a value by which you will be able to recognize users between different sessions (for instance login id or guid).

It is of great importance that the value provided here is valid and unique per user. If no customIdentifier is known at the time of the call, this property should not be included in the tracking call

A JSON array of tags with their corresponding tag-values. These are the tags that will actually be measured:

[
 { "tag":"CATEGORY", "value":"CYCLING" },
 { "tag":"ZIPCODE", "value":"3800" }
]

Note: If TRAFFICSOURCE is included in the tracking call, the corresponding system tag is overruled.

Possible values for TARFFICSOURCE are :
- Search
- PaidSearch
- Social 6 Site JavaScript API
- Affiliate
- Direct
- Email

It is also possible to provide a weight for a certain tagvalue. This can be done by providing a score. The default score if not provided is 1.

[
 { "tag":"CATEGORY",
   "value":"CYCLING",
   "score":5 }
]

It is possible to supply a function which is executed once the tracking call is successfully finished.

For instance this can be useful when we would like to make sure that the segment evaluation has occurred on the last tracking data and hence the tracking call is finished, a callback can be supplied.

window.bt_trackingFinishedCallback = function (data) {
    var profileInfo = data;
}

Similar to the finishedCallback, it is possible to supply a function which is executed once the tracking call has finished with an error.

The parameter for this function is the trackingCall for which the error has occurred.

window.bt_trackingErrorCallback = function (data) {
    var trackingCall = data;
}

Whether the tracking call is used for targeting. If so, the call will only be executed when the DOM is ready. The call will make sure the found placeholders are properly filled with offer/action - content.

Important remark:
Site only adds content to the website, it doesn’t remove it. So if isTargeting is set to true and a profile is currently in an audience for which specific content must displayed on the website, this content will be shown. If at a certain moment in time the profile is no longer in this audience the content will still be displayed on the website (eg. An offer exists where some content is shown when the profile has at least one item in his cart. When a profile adds an item in the cart and the property isTargeting is set to true, the offer is evaluated and the content is shown. However, if the profile removes the item from the cart and the property isTargeting is set to true, the offer is re -evaluated but the content will NOT be removed although the profile is no longer in the audience.

[DEPRECATED] Use exposedFields

The property is still available for compatibility reasons, but should no longer be used, it may be removed in the future.

[DEPRECATED] Use exposedFields

The property is still available for compatibility reasons, but should no longer be used, it may be removed in the future.

[Will be DEPRECATED in the future, please use BT.GetProfileInfoAsync() ] Returns an object with profile-information. This is the same object that is returned to the callback-function when performing the tracking-call.
Note that the names returned for offers, tags and profile-fields are the internal public names.

{
 "profileId": "aaa-aaa-aaa-aaa-aaa",
 "profileInfo":
     { "offers": [
          {
            "name": "OfferName",
            "inOffer": false,
             "date": "2014-04-15T17:15:08.375+02:00"
          }
         ],
      
       "exposedFields": [
         {    
           "field": "tagName",
           "value": [ "value1", "value2" ]
         },
         { 
           "field": "aaa",
           "value": [ "xxx" ]
         },
          {
           "field": "fieldName",
           "value": ["xxx"]
         }
         ],
         
         "tags": [
          {
            "name": "tagName",
            "values": [ "value1", "value2" ]
          }
         ],
          
        "CRMFields": [
          {
            "name": "aaa",
            "value": "xxx"
          }
        ],
          
        "profileFields": [
          {
            "field": "fieldname",
            "values": "xxx"
          }          
         ]
    }
}

Note: The boolean indicates if the profile is in the offer or not. It is still possible that even if the boolean is 1 (so the profile is in the offer) that the offer is not shown. (ex. The offer domain does not correspond with the current domain; or the planning of the offer prevents it from being shown; or there is another offer with higher priority;…)

Returns an object with profile-information. This is the same object that is returned to the callback-function when performing the tracking-call.
Note that the names returned for offers, tags and profile-fields are the internal public names.

{
    "profileId": "aaa-aaa-aaa-aaa-aaa",
    "profileInfo": {
        "offers": [{
            "name": "OfferName",
            "inOffer": false,
            "date": "2014-04-15T17:15:08.375+02:00"
        }],

        "exposedFields": [{
                "field": "tagName",
                "value": ["value1", "value2"]
            },
            {
                "field": "aaa",
                "value": ["xxx"]
            },
            {
                "field": "fieldName",
                "value": ["xxx"]
            },
        ],

        "tags": [{
            "name": "tagName",
            "values": ["value1", "value2"]
        }],

        "CRMFields": [{
            "name": "aaa",
            "value": "xxx"
        }],

        "profileFields": [{
            "field": "fieldname",
            "values": "xxx"
        }]
    }
}

Note: The boolean indicates if the profile is in the offer or not. It is still possible that even if the boolean is 1 (so the profile is in the offer) that the offer is not shown. (ex. The offer domain does not correspond with the current domain; or the planning of the offer prevents it from being shown; or there is another offer with higher priority;…)

Returns a Boolean (true or false) indicating if the website visitor is inside the offer-target-audience or not.

Note: The boolean indicates if the profile is in the offer or not. It is still possible that even if the boolean is 1 (so the profile is in the offer) that the offer is not shown. (ex. The offer domain does not correspond with the current domain; or the planning of the offer prevents it from being shown; or there is another offer with higher priority;…)

offer = The public offer name for which inclusion should be checked.

Returns an array of objects for all the offers the user has been or is in the Site-audience.

Each returned offer-object contains:

• name: the public name of the offer.
• isInOffer: Boolean indicating if the user is still in the Site audience.
• date:
  • if isInOffer is true, this is the date and time the user joined the offer.
    
    Note: The boolean indicates if the profile is in the offer or not. It is still possible that even if the boolean is 1 (so the profile is in the offer) that the offer is not shown. (ex. The offer domain does not correspond with the current domain; or the planning of the offer prevents it from being shown; or there is another offer with higher priority;…) Site JavaScript API 11
    
    
  • If isInOffer is false, this is the date and time the user dropped out of the offer.
    
    

Returns an array of objects for all the exposedFields that were returned in the tracking call.

See section Exposed Fields for more information

Returns, if found, a single exposed field object for the requested field name.

See section Exposed Fields for more information.

[DEPRECATED] Use getExposedFields

The function is still available for compatibility reasons, but should no longer be used, it may be removed in the future.

[DEPRECATED] Use getExposedField(fieldname)

The function is still available for compatibility reasons, but should no longer be used, it may be removed in the future.

[DEPRECATED] Use getExposedField

The function is still available for compatibility reasons, but should no longer be used, it may be removed in the future.

[DEPRECATED] Use getExposedFields

The function is still available for compatibility reasons, but should no longer be used, it may be removed in the future.

[DEPRECATED] Use getExposedFields

The function is still available for compatibility reasons, but should no longer be used, it may be removed in the future.

When no arguments are specified for the optout function, a cookie with name "behavioral-disable-track" is stored to disable all behavioral tracking. To undo the opt-out, the user should manually remove this cookie or the method BT.optin() should be called.

To optout of all offers for a specified time, specify a period in minutes, in this case the cookie will not be created and Site will handle the optout.

To optout of a specific offer for a specific time also specify the public name of the offer.

[DEPRECATED] Use BT.optin()

The function is still available for compatibility reasons, but should no longer be used, it may be removed in the future.

Clears the behavioral-optout-cookie if set.

If an offer is specified and the user has an active optout for that offer, it will be cleared and the user will start receiving that offer again.

Tracks an activity defined on an Offer as "via API". As parameters, the public name for the offer and the unique name for the activity should be passed.

offer = The public offer name to track activity for.
activity = The activity name to track activity for.

The object contains the content id and one or more callback functions.

The function measures a click-event for a popup or popin opened for an offer, since these can’t be tracked automatically in a consistent way. This allows the user to only sense the click when (a) specific element(s) in the popup/popin is/are clicked. (e.g. an OK button).

When the script is running in Engage, it should be :
BT.trackClick (
{ "id": "[%requestValue('CONTENTID')%]",
"finishedCallback": function(data) { console.log(data); },
"errorCallback": function(trackingCall) { console.log(trackingCall); }
});

When the script is running in Campaign, it should be :
BT.trackClick (
{ "id": "~@CONTENTID~",
"finishedCallback": function(data) { console.log(data); },
"errorCallback": function(trackingCall) { console.log(trackingCall); }
});

Adds the specified items to the cart with the specified name. As parameters, the public name for the cart, the list of items and the isTargeting flag should be passed.

cartName = The public name of the cart to which the items should be added
items = A json array containing the items that should be added to the cart. Each item should contain an identifier, a value and a quantity.
isTargeting = This flag indicates whether or not this call should be used for targeting.

E.g.
BT.addCartItems( "CARTNAME", [ { "id": 7, "value": 649, "count": 1 } ], true);

Note : BT.addCartItems() is incremental, so updates the QTY value of that item if the item already exists in the cart.

Removes the specified items from the cart with the specified name. As parameters, the public name for the cart, the list of items and the isTargeting flag should be passed.

cartName = The public name of the cart of which the items should be removed.
items = A json array containing the items that should be removed from the cart. Each item should contain an identifier and a quantity
isTargeting = This flag indicates whether or not this call should be used for targeting.

BT.removeCartItems(
"CARTNAME",
[
{
"id": 7,
"count": 1
}
],
true);

Clears all items from the cart with the specified name. As parameters, the public name for the cart and the isTargeting flag should be passed.

cartName = The public name of the cart that should be cleared.
isTargeting = This flag indicates whether or not this call should be used for targeting.

BT.clearCart( "CARTNAME", true);

Performs a checkout operation on the cart with the specified name. As parameters, the public name for the cart and the isTargeting flag should be passed.

cartName = The public name of the cart that should be checked out.
isTargeting = This flag indicates whether or not this call should be used for targeting.

BT.checkoutCart( "CARTNAME", true);

Note that a cart checkout will automatically clear the cart when done (see BT.clearCart above)

Use this method initialize a tracking call object. This object can be populated by using the other API methods, avoiding the actual tracking call to be executed. The method is compatible with the following API calls:

• BT.trackActivity
• BT.trackClick
• BT.addTag
• BT.addCartItems
• BT.removeCartItems
• BT.clearCart