How to Install & Setup the Adobe Ads Integration (OAuth Method)

Updated 

3 months ago

​

Adobe Analytics setup is a straight forward process and it can be done by anyone who has admin access to the Adobe Analytics account

Please follow the below steps and prepare all the metrics,dimensions and identify the unique identifiers to have a seamless experience during the configuration.

Before you Begin

  • Ensure user adding the Adobe Analytics in Sprinklr Marketplace have Admin permissions in Adobe Analytics.

  • Understand the Metrics which you want to track in Sprinklr.

  • Identify the Unique Identifier in your URLs which will help you to map the data to the best possible granular level.

  • JWT Authentication Method has been depricated and replaced by OAuth Server to Server Method.

​

Integration Steps

You are required to raise a support ticket with Sprinklr Support Team requesting DP Enablement which is required for the configuration in Sprinklr Marketplace. Meanwhile it is recommended for users to gather the "Client ID" and "Client Secret" from the Adobe Developers Website.

Tip

  • The Support Team is required to verify the accessibility of the Integration user.

  • Since Integration User is the sole Administrator, the customer is required to verify the accessibility for the Report Suites, Metrics, and Dimensions.

  1. The customer is required to navigate to the following URL: https://adminconsole.adobe.com. Note that you can only access the site as an Administrator.

  2. Find Adobe Analytics under the Product tab.

    Note

    The name - Adobe Analytics - will vary depending on how the customer has named Adobe Analytics in their environment.

  3. Next, navigate to Product Profiles inside the Adobe Analytics product.AdminConsole_Products_AdobeAnalytics_ProductProfiles.png​

  4. Edit and verify if you have access to the desired Report Suites, Metrics, and Dimensions.AdobeAnalytics_ReportSuites.png​

    1. Additionally, click Edit alongside the desired entity and add, update, or remove the permissions. AdobeAnalytics_Permissions.png​

  5. After the verification, confirm that the Integration User has access to Report Suites, Metrics, and Dimensions.

You are required to create an API Integration within the Adobe IO Console. For more information, see Creating an API Integration.

​​

  • Click the Create New Project button on the top right. 

​

  • Click on the + Add to Project and select API from the dropdown

​

  • On the Add an API pop-up window, select Adobe Analytics and click Next in the bottom right corner of the Add an API pop-up window.

​

​

​

  • On the Configure API pop-up window, select OAuth Server-to-Server. Add a credential name and click on Next.

​

​

  • Select the Product Profiles in the Configure API pop-up window.

​

​

​

  • Click Save configured API in the bottom right corner of the Configure API pop-up window. Once you save the configured API, an API was configured successfully  message will appear on the bottom of the window.

​
​​

  • Your client is now created. Notice your client has a Client ID and Client Secret value.

  • You can get all the relevant API keys Under APIS. Note that the following information is available, you can copy/save the info to install Adobe APIs in the Sprinklr Marketplace as mentioned in Step 4.

    • Client ID

    • Client Secre​t

  • Click on the Generate Access Token on the credential. On clicking the Retrieve Client Secret, the user can view the Client Secret.

  1. Click the New Tab icon. Under the Governance Console, click Manage Marketplace within Integrations.

    ​

  2. In the Market Place window, select Adobe Analytics from the Available Apps

    ​

    ​

    ​

  3. In the Install Adobe Analytics pop-up window, enter a Name and Description and click on Save.

    ​

    ​

    ​

  4. Click + Add User button.

    ​

    ​

5. Enter Client Details and click on Add button.

​

  • ​

​

  1. On the Market Place window, click Installed from the top dashboard bar.

  2. Under the Analytics section, identify the Site Catalyst you want to configure and click Edit.Edit Site Catalyst

  3. On the Configuration window, you can view and configure the application further. For more information, see Configure Site Catalyst — Descriptions.

Note

  • If you do not have the appropriate permissions to add an Adobe Analytics account and proceed to give Sprinklr permission for fetching the data, you will be prompted with an error message to get the desired permissions and then add the account.

  • If you have selected incompatible metrics and dimensions in your Adobe Analytics configuration, you will receive an error message that the dimensions and metrics which you have added are not compatible with each other, on saving the configuration.

By default, the validation will be enabled. To learn more about getting this capability disabled in your environment, please work with your Success Manager.

Internal Note:

Use these DPs:

  • OMNITURE_DATAWAREHOUSE_REQUEST_NEW_VERSION_ENABLED("omniture.datawarehouse.request.new.verion.enabled", BOOLEAN, PARTNER),

  • OMNITURE_VALIDATION_DISABLED("omniture.validation.disabled", BOOLEAN, PARTNER)

Enablement of this capability requires additional setup.

Configure Site Catalyst4. Click Save in the top-right corner.

Configure Site Catalyst — Descriptions

Term
Description
Site Catalyst Overview

View the Site Catalyst details such as the Name, Client, etc.

Site Catalyst Overview

Site Catalyst User

View the users that are added to configure the Site Catalyst. You can click the Addition box to add multiple users.

Site Catalyst User

Report Suites

A report suite defines the complete, independent reporting on a chosen website, set of websites, or a subset of web pages.

Select a report suite from the Select a report suite drop-down menu. You can also click the Addition icon alongside to add multiple report suites.

For each report suite, you can further configure the details given below.

Dimensions

Configure the following:

  • Parameter

  • Name

  • Data Type

  • Description

  • Hidden Parameters

  • Profile Parameters

  • Post Parameters

  • Account Parameters

  • Ad Parameters

Note

  • Sprinklr will fetch data in any scenario and will try to map it to the ad entity level at which we are able to find the unique ad identifier that you have defined in the configuration. If you haven't defined any unique identifier, data will reflect in Sprinklr but won’t be associated with any Ad.

  • For Adobe Analytics data to populate correctly in Ads Reporting, ensure that you select 'URL Parameter' instead of 'Containing' as the Condition Type while configuring Ad Parameters.

Measurements

Configure the following:

  • Parameter

  • Name

  • Data Type

  • Description

  • Hidden Parameters

Single Dimension Measurements

Configure the following:

  • Measurement

  • Selected Dimension

  • Name

  • Data Type

  • Description

Measurement Interval Configuration

Configure the following:

  • Measurement Parameter

  • Interval Type

The default interval is hourly for all measurements.

Data Configuration

Configure the following:

  • Warehouse

    • Client ID

    • Client Secret

    • Mandatory Parameters

  • Streaming

    • Streaming URL

    • Mandatory Parameters

Site Catalyst Report Suite

Visibility

Define the Client/Groups and Users/Groups you want to share this application across.

Site Catalyst Visibility

Was this article helpful?

Related Articles

Loading...