Help Manual - Google Ads Connection Manager

Documentation on SSIS Google Ads Connection Manager component

Using the Google Ads Connection Manager

The Google Ads Connection Manager is an SSIS connection manager that can be used to establish connections with Google Ads.

To add a new connection, right-click the Connection Manager area in your Visual Studio project and choose "New Connection..." from the context menu. You will be prompted with the "Add SSIS Connection Manager" window. Select the "Google Ads (KingswaySoft)" item to add a new Google Ads Connection Manager.

New SSIS Connection

Add SSIS Google Ads Connection

The Google Ads Connection Manager contains the following configuration pages:

  • General
  • Advanced Settings

General Page

The General page allows you to specify connection properties and login credentials for Google Ads.

SSIS Google Ads Connection

Customer Id

The Customer Id option allows you to specify the Customer Id of the target Ads account, typically in the form of 123-456-7890.

Google Ads API

The Google Ads API option allows you to choose an API version to work with. The available options are:

  • Google Ads API (since v21.1)
  • Google AdWords API (Deprecated since v22.1)
Google Ads API Version

The Google Ads API Version option allows you to specify which version of the Google Ads API is used from the available options. By default, it will populate <Default>, which will be the current version.

Authentication Mode

The Authentication Mode option allows you to specify how you want to authenticate to your Google Service. Available options are:

  • Authorization Code
  • Service Account (server-to-server authentication)

The options in this box have been deprecated and are only available in v10.0 or earlier. If you are using v20.1 or newer, these options will not be available.

Token Location (Available only when Authorization Code is selected)

Google Ads retrieves tokens from the Google app once you give authorization. The tokens are stored in the Windows Registry so that once they expire, our component will automatically request new tokens from Google and replace the existing tokens with the new ones in the Registry to minimize user effort and avoid service interruption for scheduled jobs. You have two options to choose where in the Registry you would like to store these tokens:

  • Local Machine registry hive – HKEY_LOCAL_MACHINE
  • Current User hive – HKEY_CURRENT_USER
App Type (Available only when Authorization Code is selected)

The selected App Type that was chosen when creating the Google token.

Account (Available only when Authorization Code is selected)

The selected available Google Account Number and Name.

Authentication (Available only when Authorization Code is selected)
Generate Token File

This button will open a dialog that allows you to log in to the service endpoint and authorize your app to generate a new token.

SSIS Google Ads Connection

Authorization Type

The app that will be used to connect to your Google Service. Available options are:

  • KingswaySoft: The Connection Manager will use the Client ID and Secret that is provided by KingswaySoft for your convenience when setting up the connection. It should NEVER be used for production purposes.
  • My Own App: Selecting this option will allow you to use your own Client ID and Secret to connect to Google Services.
App Info
Client ID

The Client ID option allows you to specify the unique ID that identifies the application making the request.

Client Secret

The Client Secret option allows you to specify the secret belonging to your Google Service App ID.

Redirect URL

The Redirect URL option allows you to specify the Redirect URL which was used during the Google App creation in order to complete the authentication process.

Developer Token

A Developer Token from Google allows your app to connect to the Google AdWords API.

Sign In & Authorize
Use Default Browser to Sign In

When this option is checked the Sign In & Authorize button will open your default web browser in order to complete the OAuth authentication. When this option is unchecked, the Sign In & Authorize button will complete the entire OAuth authentication process inside of the toolkit.

Sign In & Authorize Button

This button allows you to log in to the service endpoint and authorize your app to generate a token.

Warning: By default, you are using the Google AdWords API authorization information (Client ID, Client Secret & Developer Token) provided by KingswaySoft, which is provided for your convenience when setting up the connection, and it should NEVER be used for production purposes. To obtain your own Google AdWords API authorization credentials for product use, please follow the instructions in the link below to create your own application registration with Google: https://developers.google.com/adwords/api/docs/guides/signup

Path To Token File

This option allows you to specify the path to the token file on the file system.

Token File Password

This option allows you to specify the password of the selected token file.

Token File Details

The Token File Details section displays information associated with the selected token file.

Account ID

Displays the ID of the Google account associated with the selected token file.

Account Name

Displays the name of the Google account associated with the selected token file.

App Client ID

Displays the Client ID of the application associated with the selected token file.

App Type

Displays the App Type associated with the selected token file.

Key File Type (Available only when Service Account is selected) (since v21.1)

Specify the private key file format that was downloaded from Google. Available options are:

  • JSON
  • P12

In order to work with the Service Account option, a service account would need to be created in Google Console to generate a certificate key. The following steps can be used for that:

  • Log in to the Google Cloud Platform Console

  • Navigate to IAM & Admin Console.

  • Choose "Service Accounts" from the list, and then click on "Create Service Account".

  • Provide the "Service Account Name", and the "Service Account ID" would be auto-populated based on the Name.

  • Give permissions if required by switching to the "Permissions" tab.

  • Choose the "Keys" tab, and then click on "Add Key" and select "Create New Key".

  • From the window that pops up, download the private key file.

Developer Token (Available only when Service Account is selected)

The Developer Token option allows you to specify the Developer Token used to access the Google Ads API.

JSON Key File Path (Available when JSON is selected as the Key File Type)

Specify the path to the JSON private key file used for authentication.

Service Account

When JSON is selected as the Key File Type, this read-only field displays the Service Account from the specified JSON key file. When P12 is selected, specify the Service Account associated with the P12 certificate.

Client Id (Available when JSON is selected as the Key File Type)

This read-only field displays the Client Id from the specified JSON key file.

Certificate Location (Available when P12 is selected as the Key File Type)

Allows you to specify the location of the certificate that will be used for authentication. There are two options available:

  • Store (Recommended)
  • File System
Certificate Thumbprint (Available when Store is selected as Certificate Location)

This option allows you to specify the thumbprint of the selected certificate in order to authenticate using your Google Service Account.

Path To Certificate (Available when File System is selected as Certificate Location)

Provide the path to the certificate file to use for authentication. Click the ellipsis button to browse the file system for the certificate.

Note: The component supports Azure Blob Shared Access Signature (SAS) URL in the certificate path.

Certificate Password (Available when File System is selected as Certificate Location)

Provide the password to the certificate file.

Test Connection

After all the connection information has been provided, click the Test Connection button to test if the connection settings entered are valid.

Advanced Settings Page

The Advanced Settings page on the Google Ads Connection Manager allows you to specify advanced and optional settings for the connection.

SSIS Google Ads Connection

Proxy Server Settings

The Proxy Server Settings allow you to specify how you want to configure the proxy server.

Proxy Mode

The Proxy Mode option allows you to specify how you want to configure the proxy server settings. There are three options available:

  • No Proxy
  • Auto-detect (Using system-configured proxy)
  • Manual
Proxy Server

Using the Proxy Server option, you can provide a proxy server to connect to Google Ads.

Port

The Port option allows you to specify the port number of the proxy server for the connection.

Username

The Username option allows you to specify the proxy user account.

Password

The Password option allows you to specify the proxy user’s password.

Note: Proxy Password is not included in the Google Ads connection manager's ConnectionString property by default. This is done by design for security reasons. However, you can include it in your ConnectionString if you want to parameterize your connection manager. The format would be ProxyPassword=myProxyPassword; (make sure you have a semicolon as the last character). It can be anywhere in the ConnectionString.

Misc
Timeout (secs)

The Timeout (secs) option allows you to specify a timeout value in seconds for the connection. The default value is 120 seconds. Specify 0 for an infinite timeout.

API Throttling Rate

The API Throttling Rate option allows you to restrict how many requests you want to send to Ads per unit of time. While Google Ads doesn't limit the number of requests a client application can send during a specific time window, continually sending requests can exceed the rate limit and cause RateExceededError. This rate is set to 10 and you can adjust upward from there to optimize your throughput without exceeding the rate limit. The requests drop-down will allow you to specify whether the API Throttling Rate should be per second, minute, or hour.

Retry on Intermittent Errors

This is an option designed to help recover from possible intermittent outages or disruption of service. It prevents the integration process from stopping due to temporary issues. Enabling this option will allow service calls to be retried upon certain types of failure. A service call may be retried up to 3 times before an exception is fired. Retries occur after 0 seconds, 15 seconds, and 60 seconds.

Warning: We have designed our retry feature carefully such that the retry should only occur when it is deemed safe to do so; however, on some occasions, such retry service calls could result in the creation of duplicate data.