Using the Google Analytics Connection Manager

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

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 the "Add SSIS Connection Manager" window. Select the "Google Analytics (KingswaySoft)" item to add a new Google Analytics Connection Manager.

New SSIS Connection

Add SSIS Google Analytics Connection

The Google Analytics Connection Manager contains the following 2 pages of configuration.

  • General
  • Advanced Settings

General page

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

SSIS Google Analytics Connection

API Version (since v8.0)

Specify a Google Analytics API version to work with, available options are:

  • V3
  • V4
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)
Token Location (Available only when Authorization Code is selected)

Google Analytics retrieves tokens from the Google app once you give authorization. The tokens are stored in 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 Registry to minimize user effort and avoid service interruption for scheduled jobs. You have two options to choose where in 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 which was chosen when creating the Google token.

Account (Available only when Authorization Code is selected)

The selected available Google Account Number and Name.

Get New (Available only when Authorization Code is selected)

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

SSIS Google Analytics Connection

  • Google Service: The Google Service you are tyring to connect to.
  • Token Location: The windows registry location where the new token will be saved.
  • Authorization Type: The App which 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 purpose.
    • My Own App: Selecting this option will allow you to use your own Client ID and Secret to connect to Google Services.
  • Client Id: The Client Id option allows you to specify the unique ID which 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.
  • Generate Token File in App: This button completes the entire OAuth authentication process inside of the toolkit. All you need to do is login to the service endpoint and authorize our app to generate your token.
  • Generate Token in Browser: This button completes the OAuth authentication using your default browser. After you click this button simply follow the steps in the browser to generate your token.

Warning: By default you are using the Google Analytics API authorization information (Client Id and Secret) provided by KingswaySoft, which is provided for your convenience when setting up the connection, and it should NEVER be used for production purpose. To obtain your own Google Analytics API authorization credentials for product use, please follow the instructions at the link below to create your own application registration with Google: https://developers.google.com/analytics/devguides/config/mgmt/v3/authorization

Service Account (Available only when Service Account is selected)

The Service Account option allows you to specify the account which will be used to connect to your Google's service.

Certficate Location (Available only when Service Account is selected)

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

  • Store
  • File System
Certificate Thumbprint (Available only when Service Account is selected)

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

Test Connection

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

Advanced Settings

The Advanced Settings page of Google Analytics Connection Manager allows you to specify some advanced settings of the connection.

SSIS Google Analytics Connection - Advanced Settings

Proxy Mode

Proxy Mode option allows to specify how you want to configure the proxy server setting. 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 Analytics.

Port

The Port option allows you to specify 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 Analytics 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.

Timeout (secs)

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

API Throttling Rate

The API Throttling Rate option will limit the number of requests that can be sent per second. This rate is set to a 10 requests per second limit, by default, to respect the Google Analytics API limits.

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, in some occasions such retry service calls could result in the creation of duplicate data.