Overview
The Integrate Module is a javascript tool that can be used to capture data from a partner (3rd party) context and bring it into Adobe Analytics. This tool is applicable in real-time on the brand's website -- as a user is engaging with the site. The Integrate Module can be installed on a website if the Adobe AppMeasurement javascript library has been implemented. Think of the Integrate Module as an "add-on" or "extension" for the AppMeasurement javascript library.
Example use cases
- The user ID generated by a partner solution is made available on the brand's website, either in a cookie or a javascript object on the page. This user ID needs to be sent to Adobe Analytics (in an eVar, for example).
- A partner solution has a real-time (highly performant) web service that can surface valuable insights about the user. These insights need to be sent to Adobe Analytics (in one or more eVars, for example).
Timing value
Probably the most significant value of the Integrate Module (IM) is its ability to manage timing issues as the webpage loads.
In the first example above, the Adobe Analytics (AA) tracking code may execute and send data off to the AA collection server before the partner solution makes the user ID available. In this case, the IM "delay" method can be used to cause the AA collection to wait for the user ID to become available. Then the IM "ready" method can be used to proceed with the AA tracking.
In the second example, the IM "get" method can be used to call out to the partner web service. This will automatically pause the AA tracking execution (up to the "maxDelay" timeout) giving time for the web service to return the data to the page. The IM "setVars" method is used to define how the data from web service response is mapped back to the AA tracking variables (eVars, contextData, etc.)
WARNING: It is risky to set a "maxDelay" too high as this can lead to data loss. The user might move on to the next page before the previous page was tracked.
Implementation
See the official documentation for more details on implementing a solution with the Integrate Module.