Update your data collection library for Audience Manager from the Audience Manager tag extension to the Web SDK tag extension
Intended audience
This page is intended for Audience Manager customers who are using the Audience Manager tag extension to bring web collection data into Audience Manager. For customers using the AppMeasurement JavaScript library, please read the guide on how to update your data collection library for Audience Manager from the AppMeasurement JavaScript library to the Web SDK JavaScript library.
Advantages and disadvantages of this implementation path
Using this migration approach has both advantages and disadvantages. Carefully weigh each option to decide which approach is best for your organization.
- No code changes on your site: Since your implementation already has tags installed, all migration updates can be made in the tags interface.
- Uses your existing implementation: This approach does not require a net-new implementation. While it does require new rule actions, you can reuse your existing data elements and rule conditions with minimal changes.
- Does not require a schema: For this stage of migrating to the Web SDK, you don’t need an XDM schema. Instead, you can populate the
data
object, which sends data straight to Adobe Audience Manager. Once migration to the Web SDK is complete, then you can create a schema for your organization and use datastream mapping to populate applicable XDM fields. If a schema were required at this stage of the migration process, your organization would be forced to use an Adobe Audience Manager XDM schema. Use of this schema makes it more difficult for your organization to use your own schema in the future.
- Implementation technical debt: Since this approach uses a modified form of your existing implementation, it can be harder to track implementation logic and perform changes when needed. Custom code can be particularly difficult to debug.
- Requires mapping to send data to Platform: When your organization is ready to use Real-Time CDP, you must send data to a data set in Adobe Experience Platform. This action requires that every field in the
data
object be an entry in the datastream mapping tool that assigns it to an XDM schema field. Mapping only needs to be done once for this workflow, and it doesn’t involve making implementation changes. However, it is an extra step that is not required when sending data in an XDM object.
Adobe recommends following this implementation path when you have an existing implementation using the Adobe Audience Manager tag extension.
Steps required to migrate to the Web SDK
The following steps contain concrete goals to work towards. Select each step for detailed instructions on how to accomplish it.
Follow the instructions below to create a datastream in Adobe Experience Platform Data Collection. When you send data to this datastream, it forwards data to Audience Manager. In the future, this same datastream forwards data to Real-Time CDP.
-
Navigate to experience.adobe.com and log in using your credentials.
-
Use the home page or product selector in the top right to navigate to Data Collection.
-
In the left navigation, select Datastreams.
-
Select New Datastream.
-
Enter the desired name, then select Save.
-
Once the datastream is created, select Add Service.
-
In the service drop-down menu, select Adobe Audience Manager.
-
Make sure the Enable XDM Flattened Fields option is unchecked.
Your datastream is now ready to receive and pass along data to Audience Manager.
This section prepares your tag for the bulk of the migration effort taking place in the next step.
-
Select the hamburger icon in the top left of the Adobe Experience Platform interface, then select Tags.
-
Select the desired tag property.
-
In the left navigation of the tag property, select Extensions.
-
Select Catalog near the top to see a list of all available extensions.
-
Search for and select the Adobe Experience Platform Web SDK extension, then select Install on the right side.
-
The extension configuration settings appear. Locate the Datastreams section, and select the sandbox that you are using and the datastream that you created in the previous step.
-
Select Save.
Your tag property now has the Web SDK installed.
The data object data element provides an intuitive framework to configure a payload that the Web SDK uses to send to a datastream. Most rules that you update in the following step interact with this data element.
-
In the left navigation of the tags interface, select Data Elements.
-
Select Add Data Element
-
Give the data element the following settings:
- Name: Anything you’d like, such as “Data layer” or “Data object”
- Extension: Adobe Experience Platform Web SDK
- Data Element Type: Variable
- Check boxes can remain as they are.
-
On the right side, select the following settings:
- Property radio button: Data
- Solution: Adobe Audience Manager
-
Select Save.
Your tag property now has everything needed to update each rule.
This step contains the bulk of the effort required to migrate to the Web SDK, and requires knowledge of how your implementation works. An example is provided below of how to edit a typical tag rule. Update all tag rules in your implementation to replace all references to the Audience Manager extension with the Web SDK extension.
-
In the left navigation of the tags interface, select Rules.
-
Select a rule to edit.
-
Select the action Audience Manager - Set Variables
-
Note all Audience Manager variables set within this rule. Include both variables set in the drop-down menus and variables set within custom code.
-
Change the Action Configuration to the following settings:
- Extension: Adobe Experience Platform Web SDK
- Action type: Update variable
-
Ensure that the data object you created at step 3 is selected in the drop-down on the right, in the Data element field.
-
Set the Audience Manager key-value pairs to their same respective values as they were configured in the Audience Manager extension.
-
Once all rule logic is replicated using the Web SDK extension, select Keep Changes.
-
Repeat these steps for every action configuration that uses the Audience Manager tag extension to set values.
The above steps apply only to rules that set values. The following steps replace all actions that use the Action Configuration Send Event.
-
Select a rule that sends a Web SDK event.
-
Select the action type Send Event.
-
Change the Action Configuration to the following settings:
- Extension: Adobe Experience Platform Web SDK
- Action type: Send event
-
On the right, change the action settings to the following:
- Type: Use Web Webpagedetails Page Views.
- Data: Select the data object that you created at step 3.
-
Select Keep Changes.
-
Repeat these steps for every action configuration that uses Audience Manager to send an event.
Publishing updated rules follows the same workflow as any other change to your tags configuration.
-
In the left navigation of the tags interface, select Publishing Flow.
-
Select Add Library.
-
Give this tag commit a name, such as “Upgrade to Web SDK”.
-
Select Add All Changed Resources.
-
Select Save.
-
The publishing workflow displays an orange dot, indicating that it is building. Once the dot turns green, your changes are available in your development environment.
-
Test your changes in your development environment to ensure that all rules are firing properly, and that the data object is populating with expected values.
-
When ready, submit the library for approval, build to staging, then ultimately approve and publish to production.
Once your tag implementation is fully migrated to the Web SDK, you can disable the Audience Manager extension.
- In the left navigation of the tags interface, select Extensions.
- Locate and select the Audience Manager extension. On the right, select Disable.
- Follow the same publishing workflow above to publish the removal of the Audience Manager extension.
- Once the extension is disabled in production, you can uninstall it entirely. Select the extension, select the three-dot menu on the right, then select Uninstall.
- Follow the same publishing workflow above to publish those changes to production.
At this point, your Audience Manager implementation is fully migrated to the Web SDK and is prepared to move to Real-Time CDP in the future.