Tracking and Consent Functions

The Tracking and Consent API supports these functions.

create (<integer> piAId, <integer> piCId, <string> tracker domain hostname)

Creates the Account Engagement tracker necessary for analytics. Add 1000 to the Account Engagement instance ID (piAId) and the campaign ID (piCId).

Example

set(<string> propertyName, value)

Return: undefined

Updates the value of a tracked property. Subsequent page views sent to Account Engagement include the updated property value. See Writeable Analytics Parameters for the properties that support updates.

Example

sendPageView()

Return: undefined

Sends a page view to Account Engagement that includes the current values of Tracker object properties. If the value of the pi_opt_in cookie is false, then no request is made.

Example

showConsentBanner()

Shows the Account Engagement consent banner, allowing the visitor to choose to give consent to Account Engagement analytics tracking.

Example

hideConsentBanner(<null|boolean > status)

Hide the Account Engagement consent banner from the page. If true or false is given, the pi_opt_in status is updated. If null is given, the banner is hidden and the status isn't updated.

Example

setOptIn(<boolean> status)

Set the value of the pi_opt_in cookie. Account Engagement analytics only records page views when the value of this cookie is true.

Example

revokeConsent()

Return: undefined

Deletes any existing visitor tracking cookies and sets the pi_opt_in cookie value to false.

If the pi_opt_in cookie is true or unset a page view request is sent to Account Engagement. If your Account Engagement settings require the visitor to give consent based on their geo, then no page view is recorded and the Account Engagement consent banner is displayed.

Example

clearTrackingCookies()

Deletes all Account Engagement tracking cookies.

Example

Adding analytics actions to the queue is the primary way to interact with Account Engagement analytics. To retrieve data from the Account Engagement analytics tracker, pass a callback function into the queue. The callback function is executed when the queue is processed and it is passed a reference to the Account Engagement tracker.

Since analytics is processed asynchronously, interacting with tracked values must be done within a callback function that is processed after the analytics library has loaded. In this example the current consent status is fetched, which then can be used to gate logic on your web page.

get(<string> propertyName)

Return: mixed

Returns the value of a tracked property.

Example

getConsentStatus()

Return: null|boolean

Returns the current consent status for the Account Engagement tracker. If no consent status has been set, null is returned.

Example

The following parameters can be updated using the set function.