Update Target audiences and profile scripts for Platform Web SDK compatibility

After you complete the technical updates to migrate Target to the Platform Web SDK, you may need to update some of your audiences, profile scripts, and activities to ensure a smooth transition.

All Target mbox parameters must be passed in XDM format with a Platform Web SDK implementation. Before publishing your changes to production, you should:

  • Update audiences that use mbox parameters
  • Update profile scripts that use mbox parameters
  • Update any offers and activities use mbox parameter token replacement (for example, ${mbox.parameter_name})

Adjust audiences

Any audiences that use custom mbox parameters should be updated to use the new XDM parameter names. For example, a custom parameter for page_name would likely be mapped to web.webpagedetails.pageName.

One approach to ensure compatibility with both at.js and Platform Web SDK is to update any relevant audiences so that OR conditions are used, as shown below:

modal-image
How to view update a Target audience for Platform Web SDK compatibility

Edit profile scripts

Profile scripts should be updated to reference new XDM parameter names, similar to audiences. Aside from the change of mbox parameter names, there is no difference in the way profile scripts work between an at.js and a Platform Web SDK implementation.

One approach to ensure that compatibility is to use OR conditions in your profile script code.

Example profile script:

if(mbox.param('pageName') == 'Product Details'){
  return true
}

Updated profile script for Platform Web SDK compatibility:

if((mbox.param('pageName') == 'Product Details') || (mbox.param('web.webPageDetails.pageName') =='Product Details')){
  return true
}

For more information and best practices, refer to the dedicated documentation about profile scripts.

Update parameter tokens for dynamic content

If you have any offers, recommendations designs, or activities that use dynamic content replacement, they may need to be updated accordingly to account for the new XDM parameter names.

Depending on how you are using token replacement for mbox parameters, you may be able to enhance your existing setup to account for both old and new parameter names. However, in situations where custom JavaScript code is not possible, such as in JSON offers, you should create copies and make updates after the migration is complete and live on your production site.

Example JSON offer:

{
  "pageName" : "${mbox.page_name}",
  "layoutVariation" : "grid"
}

Example JSON offer using Platform Web SDK parameter names:

{
  "pageName" : "${mbox.web.webPagedDetails.pageName}",
  "layoutVariation" : "grid"
}

If you choose to make adjustments after the migration to account for the new XDM mbox parameter names, be sure to pause any impacted activities during the migration event to prevent activity display errors to visitors.

Next, learn how to validate the Target implementation.

NOTE
We are committed to helping you be successful with your Target migration from at.js to Web SDK. If you run into obstacles with your migration or feel like there is critical information missing in this guide, please let us know by posting in this Community discussion.
recommendation-more-help
a69e1b51-9545-4d8a-822d-319242c29110