JDBC Driver for Google Ads

Build 20.0.7654

Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for Google Ads consists of three basic steps:

  • Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.
  • Provide the driver class. For example:
    cdata.jdbc.googleads.GoogleAdsDriver
  • Provide the JDBC URL. For example:
    jdbc:googleads:InitiateOAuth=GETANDREFRESH;DeveloperToken=myDeveloperToken;ClientCustomerId=myClientCustomerId;
    
    or
    
    jdbc:cdata:googleads:InitiateOAuth=GETANDREFRESH;DeveloperToken=myDeveloperToken;ClientCustomerId=myClientCustomerId;

    The second format above can be used whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:googleads:" or "jdbc:cdata:googleads:" and can include any of the connection properties in name-value pairs separated with semicolons.

Authenticate via OAuth Authentication

Use the OAuth authentication standard to connect to Google Ads. You can authenticate with a user account or with a service account. A service account is required to grant organization-wide access scopes to the driver. The driver facilitates these authentication flows as described below.

Authenticate with a User Account

See Using OAuth Authentication for an authentication guide.

Authenticate with a Service Account

Service accounts have silent authentication, without user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes to the driver.

You need to create an OAuth application in this flow. See Creating a Custom OAuth App in the Getting Started section to create and authorize an app. You can then connect to Google Ads data that the service account has permission to access.

After setting the following connection properties, you are ready to connect:

  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthJWTCertType: Set this to "PFXFILE".
  • OAuthJWTCert: Set this to the path to the .p12 file you generated.
  • OAuthJWTCertPassword: Set this to the password of the .pem file.
  • OAuthJWTCertSubject: Set this to "*" to pick the first certificate in the certificate store.
  • OAuthJWTIssuer: In the service accounts section, click Manage Service Accounts and set this field to the email address displayed in the service account Id field.
  • OAuthJWTSubject (Optional): Set this to the email address of the user for whom the application is requesting delegate access. Note that delegate access must be granted by an administrator.
  • DeveloperToken: Set this to the developer token of the AdWords account. You can get a developer token by signing up for the AdWords API. To do this, log in to the AdWords site with your MCC account and navigate to Settings -> Account Settings -> AdWords API Center. Apply for API access and wait for Google to contact you via email with more instructions. You should receive a token with a pending status. This token is only for testing and does not allow you to connect to live data. Google should contact you to fill out a questionnaire and once this has been received and approved by Google, you will receive your active developer token.
  • ClientCustomerId: Set this to the client customer Id of the AdWords account. You can find this value in your AdWords account. This value is not the same as the Id of the MCC account. You need to provide the lowest-level Ids to retrieve data.
When you connect the driver completes the OAuth flow for a service account.
  1. Creates and signs the JWT with the claim set required by the driver.
  2. Exchanges the JWT for the access token.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
  4. Submits the JWT for a new access token when the token expires.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7654