Configure a Connection Profile

From the CData ribbon, click Get Data and select From Adobe Analytics connection/s to launch the CData Query window. To setup a new connection, you will have to click the New Adobe Analytics Connection button. Here you can set the connection settings, test the connection, and save the connection profile.

Connecting to Adobe Analytics

To connect to Adobe Analytics, both the GlobalCompanyId and RSID must be identified. By default, the add-in attempts to identify your company and report suite automatically. However, you can also specify these values explicitly:

Global Company Id

The GlobalCompanyId is an optional connection property. If left empty, the add-in attempts to automatically detect the Global Company ID. To find the Global Company ID:

1. Locate it in the request URL for the users/me endpoint on the Swagger UI.
2. Expand the users endpoint, then click GET users/me.
3. Click Try it out > Execute.
4. Set the GlobalCompanyId connection property to the Global Company ID shown in the request URL immediately preceding the users/me endpoint.

Report Suite Id

RSID is also an optional connection property. If not set, the driver tries to detect it automatically. To view all of your report suites and their identifiers, go to Admin > Report Suites.

Authenticating to Adobe Analytics

Adobe Analytics uses the OAuth authentication standard. You can authenticate with OAuth integration or Service Account integration.

User Accounts (OAuth)

You must set AuthScheme to OAuth for all user account flows.

NOTE: Adobe authentication via OAuth requires updating your refresh token every two weeks. As an alternative, you can use the OAuthJWT method, but be aware that this method will be deprecated by January 2025. Adobe recommends migrating to the Server-to-Server OAuth method for continued access.

Desktop Applications

CData provides an embedded OAuth application that simplifies OAuth desktop authentication. Alternatively, you can create a custom OAuth application. Review Creating a Custom OAuth App for more information.

Get and Refresh the OAuth Access Token

Set the following properties to connect:

• OAuthClientId (custom applications only): Set to the client Id assigned when you registered your app.
• OAuthClientSecret (custom applications only): Set to the client secret assigned when you registered your app.
• CallbackURL (custom application only): Set to the redirect URI defined when you registered your app. For example: https://localhost:3333

When you connect, the add-in opens Adobe Analytics's OAuth endpoint in your default browser. Log in and grant permissions to the application. The add-in refreshes the access token automatically when it expires.

Service Account

Service accounts have silent authentication, which does not require user authentication in the browser.
You need to create an application for this flow. Review Creating a Custom OAuth App to create and authorize an application. You can then connect to Adobe Analytics data that the service account has permission to access.

Server-to-Server OAuth

Set the AuthScheme to OAuthClient to authenticate with this method.

Set the following properties to connect:

• OAuthClientId: Set to the client Id in your app settings.
• OAuthClientSecret: Set to the client secret in your app settings.

When you connect, the add-in completes the OAuth flow for a service account.

JWT OAuth

Set the AuthScheme to OAuthJWT to authenticate with this method.

Note: OAutJWT is currently supported as an AuthScheme, but support ends in January 2025. Adobe recommends migrating to the Server-to-Server OAuth method for continued access.

Set the following properties to connect:

• OAuthClientId: Set to the client Id in your app settings.
• OAuthClientSecret: Set to the client secret in your app settings.
• OAuthJWTCertType: Set to "PUBLIC_KEY_FILE".
• OAuthJWTCert: Set to the path to the .key file you generated.
• OAuthJWTCertPassword: Set to the password of the .key file.
• OAuthJWTIssuer: Set to your Organization ID from the Adobe I/O Console integration in the format org_ident@AdobeOrg. This identifies the organization that was configured for access to the Adobe I/O API.

When you connect, the add-in completes the OAuth flow for a service account.

Connection Properties

The Connection properties describe the various options that can be used to establish a connection.

Managing Connections

After successfully authenticating to Adobe Analytics you will be able to customize the data you are importing. To learn more about this, see Managing Connections.

See Also

• Querying Data: Use the data selection wizard to pull data into a spreadsheet. You can also configure scheduled data refresh here.
• Using the Excel Add-In: Find other ways to interact with Adobe Analytics data, such as using the available CData Excel Functions.