The Integrate Module allows Adobe partners to integrate their data collection efforts with your organization. This integration provides the opportunity for a two-way data connection. Typically, use of the Integrate Module is driven by an Adobe partner.
Requesting partner data in your implementation can increase delays between page load and data sent to Adobe data collection servers. If a visitor loads a new page before data is sent, that page is not recorded.
get
request for partner data.get
request and packages the appropriate variables in a JSON object. The JSON object is returned.setVars
to assign the information contained in the JSON object to Adobe Analytics variablesAn organization working with an Adobe partner can use these steps to successfully begin using the Integrate Module.
Obtaining module code requires a user with Product Admin access, or belonging to a product profile with access to the Code Manager. The method to obtain module code is the same for all implementation methods, including tags in Adobe Experience Platform.
AppMeasurement_Module_Integrate.js
.Implementing the Integrate Module on your site requires access to Adobe Experience Platform Data Collection. If you use a legacy JavaScript implementation, access to your organization’s website source code is required.
Once the Integrate Module has been implemented, use these methods to configure it to send and receive data from the desired Adobe partner.
The add
method instantiates a partner object, which serves as an intermediate store of variable data when sharing data between partner systems and your implementation. This method is required for all integrations. A separate partner object must be used for each unique partner if multiple partners are used in a single implementation.
s.Integrate.add("<partner_name>");
Your organization typically works with an Adobe partner to determine the value for partner name.
The beacon
method creates an image request and points it to the specified URL. These image requests are different than standard image requests. The beacon method typically sends data to the Adobe partner instead of Adobe data collection servers.
p.beacon("<partner_url>/track?qs1=value1&qs2=value2");
Your organization typically works with the Adobe partner to determine the value for partner name. Query strings included in the URL are optional, and dependent on partner. The Integrate Module automatically includes a query string containing a random number to prevent browser caching.
Adobe is working with teams internally to get this method documented.
The get
method lets a client import partner variables and store them in the partner object. Once data is in the partner object, it can be assigned to Analytics variables and sent in an image request. This method calls a URL, which points to a JSON object containing desired data.
s.Integrate.<partner_name>.get("<url_to_json_object>?pid=value1&pid2=value2");
The Integrate module automatically adds more query strings to the URL. A var query string specifies the name of the JSON object the module expects back from the partner. A random number is also added to prevent browser caching.
Adobe is working with teams internally to get this method documented.
The useVars
method lets the client share variable values with an Adobe partner.
s.Integrate.<partner_name>.useVars = function (s,p) {
p.<partner_var1> = s.eVar1;
p.<partner_var2> = s.eVar2;
}
Your organization typically works with an Adobe partner to determine the values for partner name and the variables that partner uses.
The setVars
method lets the client populate Analytics variables using partner data retrieved. Partner data can be the result of a get
method, a static assignment, or any other mechanism that populates the partner object with data.
s.Integrate.<partner_name>.setVars = function (s,p) {
s.eVar1 = p.<partner_var1>;
s.eVar2 = p.<partner_var2>;
}
Your organization typically works with an Adobe partner to determine the values for partner name and the variables that partner uses.
The script
method lets an Adobe partner to call additional JavaScript from the partner site if certain conditions are met (for example, if the campaign variable is set).
p.script("<partner_url>/script?qs1=value1&qs2=value2");
Your organization typically works with the Adobe partner to determine the value for partner name. Query strings included in the URL are optional, and dependent on partner. The Integrate Module automatically includes a query string containing a random number to prevent browser caching.