Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Metering Authorize functions can be used to allow your site visitors to bypass a Meter once they’ve completed a form. With this method an “authorized” flag will be associated to the visitor’s cookie via a Javascript function that must be placed on the last page of the form. Unlike the product based implementation, the visitor’s product membership data will not be used to determine whether they will no longer be Metered. This allows for added flexibility when using an Omeda Form Builder form because forms built around behaviors or other non-product attributes can now be used within Meters. The authorize function can also be used on third party forms where Olytics is implemented.

It is important to note that the Authorize flag will expire for each visitor per the setting configured in the “Configuration” tab of the Meter labelled, “An authorized Visitor must re-authorize after”.

Authorize Function for Iframed or Embedded Form Builder Forms

If the form for the Meter is iframed within a Meter Message, the below function should be used, where meter-identifier represents the Meter Id that displays within the configuration tab.

Code Block
olytics.authorizeWithIframe('meter-identifier')

When this function is fired the following will occur:

  1. The visitor will be authorized to bypass the meter

  2. Returns the visitor’s encrypted customer id to the parent site and closes the Meter Message.

When this function is used a close-confirm function should not be used on the form and the form should be set to Process Immediately.

For ease of use, we’ve provided an example of the full script that can be inserted into the head of the last page of the Form Builder form. Again, please note that the ‘meter-identifier’ must be replaced in the below script with the correct identifier for the meter.

Code Block
// this UID is different for each meter:
var olyEncMeterId = 'meter-identifier';

if( document.readyState !== 'loading' ) {

    if(document.getElementById("olyticsImport")) {
        window.olytics.authorizeWithIframe(olyEncMeterId);
    } else {
        document.querySelector("#olyticsImport").addEventListener('load',function(){
        	window.olytics.authorizeWithIframe(olyEncMeterId);
        });
    }

} else {

    window.onload = function() {

        if(document.getElementById("olyticsImport")) {
        	window.olytics.authorizeWithIframe(olyEncMeterId);
        } else {
            document.getElementById("olyticsImport").onload = function(){
            	window.olytics.authorizeWithIframe(olyEncMeterId);
            };
        }   
 
    };
}

If you’d like the modal to wait three seconds after the form is submitted before closing, please use the script below as a guide.

Code Block
// this UID is different for each meter:
var olyEncMeterId = 'meter-identifier';

if( document.readyState !== 'loading' ) {

    if(document.getElementById("olyticsImport")) {
        setTimeout(function(){
                   window.olytics.authorizeWithIframe(olyEncMeterId);
	}, 3000);
    } else {
        document.querySelector("#olyticsImport").addEventListener('load',function(){
		setTimeout(function(){
                   window.olytics.authorizeWithIframe(olyEncMeterId);
                }, 3000);
        });
    }

} else {

    window.onload = function() {

        if(document.getElementById("olyticsImport")) {

		setTimeout(function(){
                   window.olytics.authorizeWithIframe(olyEncMeterId);
                }, 3000);

        } else {
            document.getElementById("olyticsImport").onload = function(){
            	setTimeout(function(){
                   window.olytics.authorizeWithIframe(olyEncMeterId);
                }, 3000);
            };
        }   
 
    };
}

Authorize Function for Linked Form Builder Forms

If the form for the Meter is linked from a Meter Message, the below function should be used, where meter-identifier represents the Meter Id that displays within the configuration tab and redirectUrl represents the url the visitor should be returned to after the form is submitted. The visitor’s encrypted customer id (oly_enc_id) should be appended to the redirectUrl.

Code Block
olytics.authorizeAndRedirect('meter-identifier', 'redirectUrl');

When this function is fired the following will occur:

  1. The visitor will be authorized to bypass the meter

  2. The visitor is directed to the url stored in the redirectUrl variable

For ease of use, we’ve provided an example of the full script that can be inserted into the head or header of the last page of the Form Builder form. Again, please note that the ‘meter-identifier’ and ‘redirectUrl’ must be replaced in the below script with the correct identifier for the meter and the return url. The form must also be set to Process Immediately.

Code Block
<script>

// this UID is different for each meter:
var olyEncMeterId = 'meter-identifier';

if( document.readyState !== 'loading' ) {

    if(document.getElementById("olyticsImport")) {
        window.olytics.authorizeAndRedirect(olyEncMeterId, 'redirectUrl');
    } else {
        document.querySelector("#olyticsImport").addEventListener('load',function(){
        	window.olytics.authorizeAndRedirect(olyEncMeterId , 'redirectUrl');
        });
    }

} else {

    window.onload = function() {

        if(document.getElementById("olyticsImport")) {
        	window.olytics.authorizeAndRedirect(olyEncMeterId, 'redirectUrl');
        } else {
            document.getElementById("olyticsImport").onload = function(){
            	window.olytics.authorizeAndRedirect(olyEncMeterId, 'redirectUrl');
            };
        }   
 
    };
}
</script>

When using this function, you may want to populate the redirectUrl using merge variables. To do so the following script should be placed within an Export URL element with the type ‘Other’.

Code Block
<script>

// this UID is different for each meter:
var olyEncMeterId = 'meter-identifier';

if( document.readyState !== 'loading' ) {

    if(document.getElementById("olyticsImport")) {
        window.olytics.authorizeAndRedirect(olyEncMeterId, 'redirectUrlMergeVariable?oly_enc_id=%%0.2.110%%');
    } else {
        document.querySelector("#olyticsImport").addEventListener('load',function(){
        	window.olytics.authorizeAndRedirect(olyEncMeterId , 'redirectUrlMergeVariable?oly_enc_id=%%0.2.110%%');
        });
    }

} else {

    window.onload = function() {

        if(document.getElementById("olyticsImport")) {
        	window.olytics.authorizeAndRedirect(olyEncMeterId, 'redirectUrlMergeVariable?oly_enc_id=%%0.2.110%%');
        } else {
            document.getElementById("olyticsImport").onload = function(){
            	window.olytics.authorizeAndRedirect(olyEncMeterId, 'redirectUrlMergeVariable?oly_enc_id=%%0.2.110%%');
            };
        }   
 
    };
}
</script>

Authorize Function for Third-Party Forms

If the form for the Meter is hosted by a third party, the below function should be used, where meter-identifier represents the Meter Id that displays within the configuration tab.

Code Block
olytics.authorize('meter-identifier')

The third party form site must have Olytics implemented and the visitor’s anonymous or encrypted id must be passed to the metered siteReporting on Personalization jobs can be done a few different ways: Overall stats and charts within the tool itself, individual job queries in Audience Builder and through Reports & Analytics under Web Behavior.

The stats and charts within the Personalization tool will show the total # of clicks and impressions while Audience Builder shows the # of customers who have seen/clicked at least once. The Report will provide a summary view across all Personalization jobs.

Reporting within Personalization

Within the tool itself, there are two ways to access reports for a personalization job. The first is by selecting ‘View Report’ from the Actions drop down to the right of the personalization job in question:

image-20240425-122629.pngImage Added

You will be able to click on the ‘View Report’ option when a personalization is in one of the following statuses:

  • Active

  • Passed End Date

  • Paused

The second way you can access the reporting is within the Edit Personalization screen by selecting the ‘Click / Impression Report’ button:

image-20240425-122636.pngImage Added

Available Reports within Personalization

The reports are in both graph and chart format. Each report and associated chart can be exported to a PDF by selecting the ‘Output to PDF’ option in the upper left-hand corner.

image-20240425-122644.pngImage Added

Depending on who your personalization job is targeting and if you have click-tracking turned on, the following reports will be available as the job begins to fire.

Reports:

  • Impressions by Day (Known Customers)

  • Impressions by Day (Anonymous Traffic)

image-20240425-122651.pngImage Added
  • Impressions Per Url (Top 20 Shown – Known Customers)

  • Impressions Per Url (Top 20 Shown – Anonymous Traffic)

image-20240425-122700.pngImage Added
  • Impressions Per Entry Point (Top 20 Shown – Known Customers)

  • Impressions Per Entry Point (Top 20 Shown – Anonymous Traffic)

image-20240425-122708.pngImage Added
  • Link Clicks by Day (Known Customers)

  • Link Clicks by Day (Anonymous Traffic)

image-20240425-122715.pngImage Added

If you are running personalization jobs across multiple URLs, the following reports are also available:

  • Clicks per host URL (Known Customers)

  • Clicks per host URL Tracking (Anonymous Traffic)

  • Clicks per Trigger URL (Known Customers)

  • Clicks per Trigger URL (Anonymous Traffic)

image-20240425-122727.pngImage Added

Charts:

To access the charts, you can click “View Values” under each graph on the left-hand side. The impressions-by-day will appear. These are automatically exported whenever you select ‘Output to PDF’.

image-20240425-122735.pngImage Added

Reporting within Audience Builder

There are 2 skittles in Audience Builder you can use to pull your personalization data:

  • Personalization Impressions

  • Personalization Clicks

image-20240425-122745.pngImage Added

Note: If you do not see these currently in your Field Library, please contact your Audience Services team to have them configured in.

How to Query Personalization Impressions:

image-20240425-122800.pngImage Added

To query impressions, you have 3 options that can be used independently, or combined to pull the desired data.

  • Filter by Site Domain: This is most relevant when you are running a personalization job across multiple domains. You are able to narrow down the domain in question using this box.

  • Filter by Date: Enter a date range or static date in order to return the total customer impressions.

  • Filter by Personalization Name: Enter the exact name (or part of a name with a wildcard *) to return a list of personalization jobs

How to Query Personalization Clicks:

image-20240425-122810.pngImage Added

In order to query clicks, you will need to make sure that click tracking has been added to the job. To query clicks, you have 4 options that can be used independently, or combined to pull the desired data.

  • Filter by Site Domain: This is most relevant when you are running a personalization job across multiple domains. You are able to narrow down the domain in question using this box.

  • Filter by Link URL: If your job has multiple links or if a single link is used across multiple jobs, you can query by the link itself using this box.

  • Filter by Date: Enter a date range or static date in order to return the total customer clicks.

  • Filter by Personalization Name: Enter the exact name (or part of a name with a wildcard *) to return a list of links used in the job(s)

Reporting within Reports & Analytics

Personalization Summary Report

  • This will provide a Summary View of Personalizations across the database. This report can be dialed into a specific or broad date range depending on the desired information and will display the following metrics:

    • Total Impressions: Gross count of impressions for the Personalization.

    • Known Impressions: Unique count of known people who saw the Personalization

    • Anonymous Impressions: Unique count of anonymous people who saw the Personalization

    • Total Clicks: Gross number of clicks on the Personalization

    • Known Clicks: Unique count of known people who clicked on the Personalization

    • Anonymous Clicks: Unique count of anonymous people who clicked on the Personalization

    • Activation Date: Date the job was first made active

    • Type: Personalization type

    • Frequency: How often the Personalization is displayed

    • Current Status: Job status at the time the report is generated

    • Current Priority: Job priority rank at the time the report is generated

    • Position: Where the personalization is displayed on the page

    • Target URLs: Specific sites used to target the Personalization  

  • The report is located under the Web Behavior Reports on the Reporting and Analytics page of Omeda’s platform. You may need to contact your Client Success Manager to gain access. 

image-20240425-122829.pngImage Addedimage-20240425-122839.pngImage Added

Additional Personalization Query Tips

  • Querying on iFramed Forms: If you have iFramed a form you are not able to utilize the click tracking feature. However, for Omeda-based forms, you can use the ‘Dragon Sites’* skittle to lookup form submissions. This is best used in conjunction with the Impressions skittle for the best measure of personalization driven submissions.

image-20240425-122849.pngImage Added

*’Dragon Sites’ may be named something else depending on your Field Library setup. If you are unable to find this field, please contact your Audience Services team.

  • Querying on Conversions: If your personalization job is tied to a product within your database, you may be able to query on conversions. In order to successfully do so, you’ll need to use a unique promo code in your Personalization job. Looking up this unique promo code in Audience Builder will return the # of customers who converted via the personalization job.

image-20240425-122859.pngImage Added
  • Exporting Query Data: For personalization jobs that are ongoing, you can query the desired data (e.g. impressions, clicks, etc) and set it up to export regularly using the Omeda Lead Gen tool.

Table of Contents

Table of Contents
stylenone