Promises

Many of the customerApi methods make asynchronous calls to MXO. Therefore the value returned by these methods is not the actual response from MXO, but a promise object, that can be used to register callbacks when the response is returned from MXO.

The promise object used by the available MXO methods is compatible with the jQuery promise API implementing the usual then(), done, fail(), and always() methods.

sendInteraction

customerApi.sendInteraction(interactionPath, properties);

The sendInteraction() method sets the context for the customer, by making a call to an Interaction Point in MXO and returning content for any Optimization Points associated with that Interaction.

Any properties passed on this call are made available in MXO. You can configure Attribute Capture Points to capture those properties, if you want to persist that data for the current customer.

Any subsequent calls to sendProperties() or sendResponseCode() are within the Interaction Point context established with the original call to the sendInteraction() method.

Use Case

You need to trigger a specific event for a dynamic web page. For example, if a single page is presented to both authenticated and unauthenticated customers, and you want to trigger an Interaction to capture the login event only for authenticated customers.

Required Input

 customerApi.sendInteraction('physical://my.hotel/wifi')

 { name : 'TSmith', customerID : '123456' }

Returns

A promise into which a data object is passed, when the REST call completes, that contains the following:

{ optimizations: [{ data: '', dataMimeType: '', directives: '', path: '', responseId: '' }], tid: '' }

processResponse

customerApi.processResponse(response[,retryFlag=true, timeoutMS=1050]);

The processResponse() method returns the required response after you call the sendInteraction() method. This returns a promise containing details about on-click Capture Points and Optimization Points in an object.

Use cases

You need to delay the triggering of an optimization for a period of time. For example:

• If you need to trigger an optimization a few seconds after a page loads rather then immediately, you would send an interaction with a zero second timeout.

• If you need to trigger an optimization on a page that is in another region, you would increase the timeout for that optimization.

Required Input

 ccustomerApi.sendInteraction('physical://my.hotel/wifi').then(function(response){ customerApi.processResponse(response); }

 retryFlag=true

 retryFlag=false

 timeoutMS=1050

Returns

A promise into which a data object is passed, when the REST call completes. This is similar to the object returned by the sendInteraction() method.

sendProperties

customerApi.sendProperties(interactionPath, properties); 

The sendProperties() method sends additional data about the current customer or context to MXO. Typically, this would include additional, dynamic, data not directly visible on the page. It does not trigger any Activity Capture or Optimization Points for the matched Interaction but will update the data sent matching any Attribute Capture Points.

Use cases

1. You want to send additional data to MXO about the customer who is currently logged in, but that information is not actually "presented" on the screen. For example, information about their customer identifier or other available insights.
2. You want to send information about the actual content presented to a customer where multiple content variations are available for a single context.

Required Input

 { name : 'TSmith', customerID : '123456' } 

Returns

A promise into which a data object is passed, when the REST call completes. This is similar to the object returned by the sendInteraction() method.

sendResponseCode

customerApi.sendResponseCode(responseCode); 

The sendResponseCode() method registers a response code for one of the Actions returned by the previous sendInteraction() call.

Use case

You want to register the customer response to an Action returned on a web Touchpoint.

By default, only positive responses, on click, are registered for web Touchpoints.

Required Input

Returns

A promise into which a data object is passed, when the REST call completes. This is similar to the object returned by the sendInteraction() method.

getTID

customerApi.getTid(); 

The getTid() method returns the TID for the customer identified in the current browser, making it available within JavaScript, to, for example, share with other solutions.

Use case

You want to send the TID for the current customer to a third party advertising solution.

generatePixelURL

customerApi.generatePixelUrl(interactionPath, properties); 

The generatePixelUrl() method returns the MXO Pixel URL for the current customer and Space. This method does not make any calls to MXO, but assembles a string URL containing all the information necessary to trigger the specified Interaction.

Use case

You want to synchronize MXO TID with the identifier used by a third-party advertising platform. This involves sending the TID to that advertising platform, and the advertising platform sending their customer identifier back to MXO, enabling MXO to associate that customer identifier with the TID. This is known as cookie-syncing.

In normal cookie-syncing integrations, the URL generated by the generatePixelUrl() method is encoded and passed as a parameter to the cookie-sync API of the advertising platform. A specially named property value is provided to the generatePixelUrl() method to indicate the substitution token that the advertising platform will replace with its' own tracking id.

Worked Example

// Get tid and pixel URL from MXO Var tid = customerApi.getTid(); // tid now e4fb914c-1f4c-405d-82c4-d358915a958e var pixelUrl = customerApi.generatePixelUrl('/store-ad-id', {"ad-id" : "ADIDTOKEN" }); // pixelUrl now https://eu2.thunderhead.com/one/rt/web/onetag/pixel/ // ONE-NWPAYPVCJA-1444?tid=e4fb914c-1f4c-405d-82c4-d358915a958e& // uri=https://www.site.com/store-ad-id?ad-id=ADIDTOKEN // Add the MXO tid and the pixel URL to the Ad Platform's cookie syncing API var syncURL = 'https://track.adplatform.com/sync?id=' + tid + '&url=' + pixelUrl // Call Ad Platform's Cookie Syncing URL // After triggering the cookie syncing API, the ADIDTOKEN will be replaced // by the Ad Platform, and subsequently the pixel URL // will be triggered at the following URL: https://eu2.thunderhead.com/ // one/rt/web/onetag/pixel/ONE-NWPAYPVCJA-1444?tid=e4fb914c-1f4c-405d-82c4- // d358915a958e&uri=https://www.site.com/store-ad-id?ad-id=id-from-ad-platform 

Required Input

 { "ad-id" : "ADIDTOKEN" }