Environment
Issues / Symptoms
This article describe a simple method to enable and implement Optin Service using Adobe Launch.
Experience Cloud ID Service extension in Adobe Launch allows customers to manage Optin permissions. By default, Optins are granted for all Adobe Experience Cloud solutions. Customers can configure the settings in the extension to track opt in/out choices of users.
Here is a simple guide to enable and configure optin service.
Note: This guide assumes Experience Cloud ID Service extension is already implemented in Launch.
Step 1
The first step is to enable optin in the Experience Cloud ID Service extension UI. The extension gives you the initial three options as below:
No: By default, No is selected. This will let the allow the tracking as if all permissions have been granted by the user.
Yes: Turning on this option causes the libraries to wait for user consent before triggering server calls.
Determined at runtime using function: Enabling this option will cause the libraries to wait for user consent. You would need to supply a reference to a call back function which will return a Boolean (True or False) to determine the if Optin is enabled or not.
In order to enable optin, select Yes.
Step 2
The next step is to build a mechanism to get the consent from the customer. This is done using Javascript or any server-side script. You would need to present a cookie consent dialogue box to the user and record the choice.
Step 3
Once the necessary permission is taken using consent form, you would need to send the choices to Opt-in Service.
The document below describes Optin-in Service APIs in detail. I have described a simple workflow here.
Lets assume, your web site only has Adobe Analytics implementation and you have fetched the user consent (as in Step 2). Based on the user preference, you may run the below script to approve/deny the optin.
Approve
adobe.optIn.approve(adobe.OptInCategories.ANALYTICS, true);
adobe.optIn.complete();
Deny
adobe.optIn.deny(adobe.OptInCategories.ANALYTICS, true);
adobe.optIn.complete();
You may also fetch the permissions using the code below and accordingly show/hide the cookie consent window.
if (adobe.optIn.isApproved(adobe.OptInCategories.ANALYTICS)){
$("#consent").hide();
}
As soon as the above code fires, the Analytics server call/s will be fired.
You may also check the additional configurations in the extension. However, that is out of scope of this document. You may refer to Optin Extension article for more information.