TIBCO Scribe® Online Connector For Google Analytics

The TIBCO Scribe® Online Connector for Google Analytics is based on the CData driver for Google Analytics. This Connector provides access to data about your websites. Get statistics on visitors, traffic, goal completions, and more. Merge Google Analytics data with data from other sources in a database or send goal completions to your CRM system to better understand your customers.

Use Google Analytics Connector as a source Connection for Integration Solutions. This Connector is based on the Scribe.Connector.AdoNet library and CData Google Analytics ADO.NET Provider.

Connector Specifications

This Connector supports version 3 of the Google Analytics API.

  Supported

Agent Types

On Premise X
Cloud  

Replication Services

Source  
Target  

Integration Services

Source X
Target  

Migration Services

Source  
Target  

Maps

Integration X
Request-Reply X
Message  

Note: This Connector is available from the TIBCO Scribe® Online Marketplace. See Marketplace TIBCO Scribe® Certified Connectors for more information.

Supported Entities

The Google Analytics Connector supports the following entities. Click a linked entity name for additional information when using that entity in TIBCO Scribe® Online.

Google Analytics entities are separated into two categories, account and profile information, and combinations of metrics and dimensions. Tables in most Google Analytics reports organize dimension values into rows and metrics into columns.

Standard Operations

Entity Query Create Update Delete Upsert

Account And Profile

Accounts

X

 

 

 

 

Profiles

X

 

 

 

 

Segments

X

 

 

 

 

WebProperties

X

 

 

 

 

Metrics And Dimensions

AdSense

X

 

 

 

 

AdWords

X

 

 

 

 

Ecommerce

X

 

 

 

 

GoalCompletions

X

 

 

 

 

SiteContent

X

 

 

 

 

SiteSearch

X

 

 

 

 

SiteSpeed

X

 

 

 

 

Traffic

X

 

 

 

 

Setup Considerations

To use the Google Analytics Connector you must have the following configured in the Google Developer Console:

Advanced considerations, such as customizing the SSL configuration, or connecting through a firewall or a proxy, are described in the Advanced Settings section of the CData documentation.

API Usage Limits

Google Analytics limits the number of API calls per project per day and the number of queries per second per IP address. Refer to Limits and Quotas on API Requests in the Google Analytics Developer Guides for exact limits.

Note: Refreshing metadata for the Connector consumes API calls.

Selecting An Agent Type For Google Analytics

Refer to TIBCO Scribe® Online Agents for information on available Agent types and how to select the best Agent for your Solution.

Connecting To Google Analytics

Note: Best practice is to create Connections with credentials that limit permissions in the target system, following the principle of least privilege. Using Administrator level credentials in a Connection provides Administrator level access to the target system for TIBCO Scribe® Online users. Depending on the entities supported, a TIBCO Scribe® Online user could alter user accounts in the target system.

  1. Select More > Connections from the menu.
  2. From the Connections page select Add to open the Add a New Connection dialog.
  3. Select the Connector from the drop-down list in the Connection Type field, and then enter the following information for this Connection:
    • Name — This can be any meaningful name, up to 25 characters.
    • Alias — An alias for this Connection name. The alias is generated from the Connection name, and can be up to 25 characters. The Connection alias can include letters, numbers, and underscores. Spaces and special characters are not accepted. You can change the alias. For more information, see Connection Alias.
    • OAuthJWTCert — Path to the P12 certificate file stored in the Agent folder. Note that double backslashes are required.

      Example: C:\\Program Files (x86)\\Scribe Software\\TIBCO Scribe® Online Agent\\ScribeDocumentation-a4741c20f334.p12

    • OAuthJWTCertPassword — Password provided by the Google Developers Console when you downloaded the certificate.
    • OAuthJWTIssuer — Service account ID of the account that has access to your Google Analytics account.

      Example: scribe-docs@scribedocumentation-197314.iam.gserviceaccount.com

    • OAuthJWTSubject — Email address of the service account.

      Example: scribe-docs@scribedocumentation-197314.iam.gserviceaccount.com

    • Profile — Optional. Set this to the Google Analytics profile or view to which you want to connect.
    • Additional Parameters — Optional field where you can specify one or more connection string parameters. See the Connection String Options section of the CData documentation for a list of parameters that can be used and their default values. Note that in some cases the CData Google Analytics ADO.NET Provider does not fully support all of the possible parameters.

      Syntax for the Additional Parameters field is as follows:

      • All blank characters, except those within a value or within quotation marks, are ignored
      • Preceding and trailing spaces are ignored unless enclosed in single or double quotes, such as Keyword=" value"
      • Semicolons (;) within a value must be delimited by quotation marks
      • Use a single quote (') if the value begins with a double quote (")
      • Use a double quote (") if the value begins with a single quote (')
      • Parameters are case-insensitive
      • If a KEYWORD=VALUE pair occurs more than once in the connection string, the value associated with the last occurrence is used
      • If a keyword contains an equal sign (=), it must be preceded by an additional equal sign to indicate that the equal sign is part of the keyword
      • Parameters that are handled by other fields or default settings in the Connection dialog are ignored if used in the Additional Parameters field, including: 
        • OAuthJWTCert
        • OAuthJWTCertPassword
        • OAuthJWTIssuer
        • OAuthJWTSubject
        • Profile
        • Logfile — This parameter is not visible in the Connection dialog, but is set by the Connector. The default size is a maximum of 10MB. Any CData log files generated by this setting are stored in the default TIBCO Scribe® Online Agent Logs directory, C:\Program Files (x86)\Scribe Software\TIBCO Scribe® Online Agent\logs\. The format for log file names for CData logs are as follows: <ConnectorName><GUID of the Connection><DateTimeStamp>.log

          Note: For information on setting log file verbosity, see Verbosity in the CData Help.

        • MaxLogFileSize — This parameter is set by the Connector to a maximum of 10MB.
        • Other
        • RTK
        • UseConnectionPooling
  4. Select Test to ensure that the Agent can connect to your database. Be sure to test the Connection against all Agents that use this Connection. See Testing Connections.
  5. Select OK to save the Connection.

Metadata Notes

Consider the following for Google Analytics data fields and entity types.

Naming

Connection metadata must have unique entity, relationship, and field names. If your Connection metadata has duplicate names, review the source system to determine if the duplicates can be renamed.

Google Analytics Connector As IS Source

Consider the following when using the Google Analytics Connector as an IS source.

Query

Google Analytics only allows up to ten Metrics and seven Dimensions in a single query. Therefore, when issuing a query that selects all columns, only the default Metric columns are selected for tables with more than ten Metrics. The default Dimensions are used unless you explicitly select other dimension columns.

Native Query

The Google Analytics Connector supports SQL queries in Native Query Blocks to create customized queries for Google Analytics. The query can be as simple or complex as you need it to be; however, it should return a single result set. The native query text is sent to Google Analytics exactly as it is entered without any modifications.

Note: It is possible to perform a SQL query with unintended negative consequences, such as dropping a table. TIBCO recommends that you use only SELECT clauses in the Native Query Block.

GroupBy and Aggregated functions are not supported for Native Query.

After entering the SQL query, you must select Test to validate the query. Invalid queries are not accepted by the Connector. See Native Query Block for additional information.

When testing a Native Query in a Map, if the source datastore does not return any data, TIBCO Scribe® Online cannot build the schema for the underlying metadata and the Map cannot be saved. To allow TIBCO Scribe® Online to build the schema, do the following:

  1. Create a single temporary record in the source datastore that matches the Native Query.
  2. Test the Native Query and ensure that it is successful.
  3. Save the Map.
  4. Remove the temporary record from the source datastore.

Filtering

Filtering support varies by entity. For additional details, see the Data Model section of the CData documentation .

Notes On Standard Entities

AdSense

TIBCO Scribe® Online API Considerations

To create connections with the Google Analytics API, the Google Analytics Connector requires the following information:

Connector Name

Google Analytics

Connector ID

F3576DD7-5873-43CA-AD7D-82FA66BEC24F

TIBCO Scribe® Online Connection Properties

In addition, this Connector uses the Connection properties shown in the following table.

Note: Connection property names are case-sensitive.

Name Data Type Required Secured Usage

OAuthJWTCert

string

Yes

No

 

OAuthJWTCertPassword

string

Yes

Yes

 

OAuthJWTIssuer

string

No

No

 

OAuthJWTSubject

string

Yes

No

 

Profile

string

No

No

 

ConnectionString

string

No

No

 

License Agreement

The TIBCO Scribe® Online End User License Agreement for the Google Analytics Connector describes TIBCO and your legal obligations and requirements. TIBCO suggests that you read the End User License Agreement.

More Information

For additional information on this Connector, refer to the Knowledge Base and Discussions in the TIBCO Community.