How to Deploy Opti-X Banners
Deployment Options
Opti-X Banners, are a method for designing personalized messages, and widgets on to your website and into marketing campaigns such as email, push or pop-ups.
There are two primary ways for a channel to render the content of an Opti-X Banner.
- By placing and referencing Opti-X banner images
- By implementing a piece of code that Opti-X uses to build the banner in your site.
As we are building out solutions for making easier and more efficient to implement banners into sites and channels these options are subject to change and be updated.
Making Banners Personalized for Recipients
The power of Opti-X Banners comes from its ability to generate personalized content that can be deployed to your website or in a marketing campaign. To achieve this uniquely personalized content, the banner URLs will need to be provided with a way to understand who the customer is that is trying to view the content.
This is done by providing the banner with specific parameters to identifier the user (userId) and the context, time and place or contextId that the banners is being called from.
If the user identifier is not supplied, a generic or default recommendation is displayed since the unique user’s recommendation cannot be displayed.
Parameter | Description | Example Value |
---|---|---|
bannerKey | The unique identifier for the banner to be rendered. This key underpins the banner's configuration and appearance. | f34a724d-c41e-4716-b6b4-77d3c8... (Opti-X Banner Key) |
auth | The encrypted authentication string composed of the API key and brand. This ensures secure access to the endpoint. | 7f1e2c1d3fceb7dbf7cf50b9d6f2b5... |
userId | Used to identifier the end user who is being shown the banner to inform the AI model and return unique customer specific recommended content. This could be for example a [%CUSTOMER_ID%] tag or other CID or UID type identifier. | CUSTOMER_123456 |
contextId | This parameter ensures the uniqueness of products displayed when a banner contains multiple recommendations and provides caching and alignment of click through links with the products that are displayed. | AA:BB:CC |
The ContextId parameter of the banner is constructed of three parts to ensure it is unique and specific to the end user who is viewing the banner. Without this parameter, the banner images are not guaranteed to be unique among themselves and using this parameter the same banner may be used in multiple locations on the same page and generate unique recommendations in each location.
Parameter | Description |
---|---|
AA | This segment of the contextId provides page or template level context. For example in an email or other channel it could be the CUSTOMER_ID which is unique to the specific email recipient of this email template. |
BB | This segment of the contextId layers on uniqueness on top of the customer identifier to help anchor the recommendation to the pairing of customer and rendering. In Optimail this could be the timestamp of the message to ensure that recommendations displayed in this email context are unique. |
CC | This segment is meant to be a short identifier to denote the specific implementation of the banner. For example if a single bannerKey is implemented two times within a single webpage or email, providing a unique location identifier in this segment would ensure that across the two banner implementations unique recommendations would be displayed since the first two segments are used to identify the user and time/deployment of the banner would be exactly the same. |
Embedding Banners into an Email Campaign
Optimail
For customers who have both Opti-X Smart Content and Optimail in their contracts. While using the Optimail Visual Editor you will have a “Opti-X Banner” content block which allows you to seamlessly select a banner from Opti-X and place it into an email campaign.
In this implementation, all the parameters listed above are managed and controlled by Optimove to ensure that the recommendations are personalized to the recipient of the email.
For full details on implementing Opti-X Banners into Optimail templates please see dedicated guide for implementing Opti-X Banners in Optimail.
Other ESPs
To use Opti-X Banners in an ESP (Email Service Provider) that is not managed by Optimove you have the option to collect the assets that make up the banner, this includes the images and click through URLs, to be placed within your template in any orientation or layout you would like.
From the Opti-X widget manager gallery you can click the “get implementation codes” button and on the “Image Link” tab you will be provided with the URLs of the Opti-X banners to place into your template.
Note that in order to make the banners unique and personalized, you will need to fill in the userId and contextId tags as outlined above in this page.
Embedding Banners on a Website
Opti-X banners may also be used for on-site personalization. To use Opti-X Banners on your website you have the option to collect the assets that make up the banner, this includes the images and click through URLs, to be placed within your template in any orientation or layout you would like.
Using the HTML code tab, you will receive the Opti-X banners ready to use within a full HTML. Note that for the banners to be uniquely personalized for each customer you will need to fill in the userId and contextId tags as outlined above in this page.
Updated 19 days ago