and Drivers with SQL · 2018-07-06 · Simba ODBC and JDBC Drivers with SQL Connector for Google Analytics ReferenceGuide Simba TechnologiesInc. ODBC driver version 1.0.0, JDBC driver

Simba JDBC Driver with SQLConnector for Google Analytics

Reference Guide

Simba Technologies Inc.

Version 1.7.0August 31, 2020

Copyright © 2020 Magnitude Software, Inc. All rights reserved.

No part of this publication may be reproduced, stored in a retrieval system, ortransmitted, in any form or by any means, electronic, mechanical, photocopying,recording, or otherwise, without prior written permission from Magnitude.

The information in this document is subject to change without notice. Magnitude strivesto keep this information accurate but does not warrant that this document is error-free.

Any Magnitude product described herein is licensed exclusively subject to theconditions set forth in your Magnitude license agreement.

Simba, the Simba logo, SimbaEngine, and Simba Technologies are registeredtrademarks of Simba Technologies Inc. in Canada, the United States and/or othercountries. All other trademarks and/or servicemarks are the property of their respectiveowners.

All other company and product names mentioned herein are used for identificationpurposes only and may be trademarks or registered trademarks of their respectiveowners.

Information about the third-party products is contained in a third-party-licenses.txt filethat is packaged with the software.

www.simba.com 2

Reference Guide

Simba JDBC Driver for Google Analytics ReferenceGuide

PurposeThe Simba JDBC Driver with SQL Connector for Google Analytics Reference Guidedescribes the schema tables and stored procedures available for the Simba JDBCDriver for Google Analytics.

AudienceThe guide is intended for end users of the Simba JDBC Driver for Google Analyticswho have already installed and configured the driver.

Knowledge PrerequisitesFor detailed information about installing, configuring, and using the Simba JDBCDriver for Google Analytics, see the Installation and Configuration Guide for the driver.

Document ConventionsItalics are used when referring to book and document titles.

Bold is used in procedures for graphical user interface elements that a user clicks andtext that a user types.

Monospace font indicates commands, source code, or contents of text files.

Note:

A text box with a pencil icon indicates a short note appended to a paragraph.

Important:

A text box with an exclamation mark indicates an important comment related to thepreceding paragraph.

www.simba.com 3

Reference Guide Simba JDBC Driver for Google AnalyticsReference Guide

Table of Contents

Simba JDBC Driver for Google Analytics ReferenceGuide 3

Google Analytics Stored Procedures 5CreateView() 6RemoveView() 8

Google Analytics Schema Tables 9Accounts 10Accounts_Permissions 11Ad_Exchange 12Ad_Sense 14Ad_Words 16Dimensions 18Ecommerce 19Event_Tracking 21Goal_Conversions 23Internal_Search 25Master_Table 27Metrics 28Page_Tracking 29Profiles 31Profiles_Permissions 33Segments 34Sessions 35Site_Speed 37Users 39Web_Properties 41Web_Properties_Permissions 42

Third-Party Trademarks 43

www.simba.com 4

Reference Guide Simba JDBC Driver for Google AnalyticsReference Guide

Google Analytics Stored Procedures

The Simba JDBC Driver for Google Analytics provides stored procedures that you canuse to create, view, modify, and delete objects from a Google Analytics data source.

The stored procedures are listed alphabetically by name. For each stored procedure,the following information is provided:

l The name of the stored procedure.l A brief description of the stored procedure.l The name, SQL type, and description of each parameter used by the storedprocedure.

l If the stored procedure requires a JSON input as one of the parameters, thestructure of the JSON.

l A description of the data that is returned by the stored procedure, if any.

www.simba.com 5

Reference Guide Google Analytics Stored Procedures

CreateView()

This stored procedure creates a view of your Google Analytics reporting data, with thespecified dimensions and metrics.

The following rules must be observed when you create a view with this procedure:

l Columns cannot be duplicated.l A column list must contain at least one metric.l Google Analytics does not allow certain columns to be used together. For a list ofcompatible column sets, see the Google Analytics Reporting API documentation:https://developers.google.com/analytics/devguides/reporting/core/dimsmets.

l View creation fails if a table already exists with the same catalog, schema, andname as the view being created.

l Existing views are overwritten if they have the same catalog, schema, and nameas the view being created. A warning message is displayed that includes adescription of the definition of the previous view, so it can be recreated.

l Views are limited to a maximum of 10 metrics and 9 dimensions.

Parameters

ViewCatalog

SQL_VARCHAR (255)

The catalog in which to create the view.

ViewSchema

SQL_VARCHAR (255)

The schema in which to create the view.

ViewName

SQL_VARCHAR (255)

The name of the view.

ColumnList

SQL_VARCHAR (2048)

A comma-seperated list of columns to use for the view. Column names can befound by querying the "Dimensions" and "Metrics" tables and looking at the"Column Name" column.

www.simba.com 6


https://developers.google.com/analytics/devguides/reporting/core/dimsmets

MakePersist

SQL_VARCHAR (8)

(Optional) 1 to make the view persist after the connection closes, 0 to delete theview when the connection closes. If this parameter is not included, the view isdeleted when the connection closes, that is, the default is 0.

Returns - ODBC

The procedure returns a single-row table with the following column:

Success

SQL_BIT

1 for success, 0 for failure.

Returns - JDBC

If successful, the procedure returns -1, indicating success and an unknown row count.

If the procedure fails, an exception is thrown during execution beforegetUpdateCount() can be called.

www.simba.com 7


RemoveView()

This stored procedure removes a view that has been configured to persist usingCreateView(). After this stored procedure is called, the specified view is removed whenthe current connection is closed.

Note:

DELETE operations cannot be performed on views.

Parameters

ViewCatalog

SQL_VARCHAR (255)

The catalog containing the view to be removed.

ViewSchema

SQL_VARCHAR (255)

The schema containing the view to be removed.

ViewName

SQL_VARCHAR (255)

The name of the view to be removed.

Returns

If the procedure fails, the driver displays the message "View not found."

Otherwise, the procedure returns a single-row table with the following column:

Success

SQL_BIT

1 for success, 0 for failure.

www.simba.com 8


Google Analytics Schema Tables

Google Analytics stores data in structures which do not follow the rules of data typingand structure that apply to traditional relational tables and columns. Becausetraditional JDBC toolsets might not support these data structures, the data needs to bemapped to a relational form. To achieve this, the Simba JDBC Driver for GoogleAnalytics uses schema tables to map the Analytics data to a format that is compatiblewith JDBC.

Google Analytics contains the following types of data:

l Metrics, which include aggregatable numeric data. Metrics are stored in theMetrics schema table (see Metrics on page 28).

l Dimensions, which include all other data. Dimensions are stored in theDimensions schema table (see Dimensions on page 18).

Many other schema tables contain pre-created views. These represent some commondatabase views for these metrics and dimensions. If the schema does not contain apre-created view that fits your needs, you can create your own view using theCreateView() stored procedure (see CreateView() on page 6).

The schema tables are listed alphabetically by table name. For each table, thefollowing information is provided:

l The name of the table.l Whether the table is a virtual table, and if so, the table that it is contained in.l Whether the table contains any virtual tables, and if so, which ones.l Any of the columns in the table that are foldable, that is, whether operations onthose columns can be delegated to the server instead of the client.

l A list of all of the columns in the table, with information about the SQL type andwhether the column is nullable or updatable.

Important:

The JDBC driver currently does not support write-back. Columns that aredescribed as updatable cannot be updated when you connect using theJDBC driver.

www.simba.com 9

Reference Guide Google Analytics Schema Tables

Accounts

The table below describes the Accounts table.

This table contains the following virtual table:

l Accounts_Permissions on page 11

None of the columns in this table are updatable.

None of the columns in this table are foldable.

This table does not contain Return Primary Key columns.

Column Name SQL Type Nullable

IdPrimary Key

SQL_VARCHAR(255) False

Created SQL_TIMESTAMP False

Name SQL_VARCHAR(255) True

Updated SQL_TIMESTAMP True

www.simba.com 10


Accounts_Permissions

The table below describes the Accounts_Permissions table.

This is a virtual table, and is linked to the Accounts table (see Accounts on page 10).





Accounts_Permissions_IndexPrimary Key

SQL_INTEGER(unsigned) False

IdPrimary KeyForeign Key linked to columnId in Accounts table


Permission SQL_VARCHAR(255) True

www.simba.com 11


Ad_Exchange

The table below describes the Ad_Exchange table.


This table contains the following foldable columns:

l Adx_CTRl Adx_Clicksl Adx_Coveragel Adx_ECPMl Adx_Impressionsl Adx_Impressions_Per_Sessionl Adx_Monetized_Pageviewsl Adx_Revenuel Adx_Revenue_Per1000_Sessionsl Adx_Viewable_Impressions_Percentl Campaignl Datel Dayl Hourl Monthl Weekl Year



Adx_CTR SQL_FLOAT True

Adx_Clicks SQL_INTEGER(signed) True

Adx_Coverage SQL_FLOAT True

Adx_ECPM SQL_NUMERIC(16,2) True

Adx_Impressions SQL_INTEGER(signed) True

www.simba.com 12



Adx_Impressions_Per_Session SQL_FLOAT True

Adx_Monetized_Pageviews SQL_INTEGER(signed) True

Adx_Revenue SQL_NUMERIC(16,2) True

Adx_Revenue_Per1000_Sessions

SQL_NUMERIC(16,2) True

Adx_Viewable_Impressions_Percent

SQL_FLOAT True

Campaign SQL_VARCHAR(255) True

Date SQL_VARCHAR(255) True

Day SQL_VARCHAR(255) True

Hour SQL_VARCHAR(255) True

Month SQL_VARCHAR(255) True

Segment SQL_VARCHAR(1024) True

Week SQL_VARCHAR(255) True

Year SQL_VARCHAR(255) True

www.simba.com 13


Ad_Sense

The table below describes the Ad_Sense table.



l Adsense_Ad_Units_Viewedl Adsense_Ads_Clicksl Adsense_Ads_Viewedl Adsense_CTRl Adsense_Coveragel Adsense_ECPMl Adsense_Exitsl Adsense_Page_Impressionsl Adsense_Revenuel Adsense_Viewable_Impression_Percentl Campaignl Datel Dayl Hourl Monthl Weekl Year



Adsense_Ad_Units_Viewed SQL_INTEGER(signed) True

Adsense_Ads_Clicks SQL_INTEGER(signed) True

Adsense_Ads_Viewed SQL_INTEGER(signed) True

Adsense_CTR SQL_FLOAT True

Adsense_Coverage SQL_FLOAT True

www.simba.com 14



Adsense_ECPM SQL_NUMERIC(16,2) True

Adsense_Exits SQL_INTEGER(signed) True

Adsense_Page_Impressions SQL_INTEGER(signed) True

Adsense_Revenue SQL_NUMERIC(16,2) True

Adsense_Viewable_Impression_Percent

SQL_FLOAT True









www.simba.com 15


Ad_Words

The table below describes the Ad_Words table.



l Ad_Clicksl Ad_Costl Ad_Groupl CPCl CPMl CTRl Campaignl Cost_Per_Goal_Conversionl Cost_Per_Transactionl Datel Impressionsl Keywordl Monthl ROASl RPCl Weekl Year



Ad_Clicks SQL_INTEGER(signed) True

Ad_Cost SQL_NUMERIC(16,2) True

Ad_Group SQL_VARCHAR(255) True

CPC SQL_NUMERIC(16,2) True

CPM SQL_NUMERIC(16,2) True

www.simba.com 16



CTR SQL_FLOAT True


Cost_Per_Goal_Conversion SQL_NUMERIC(16,2) True

Cost_Per_Transaction SQL_NUMERIC(16,2) True


Impressions SQL_INTEGER(signed) True

Keyword SQL_VARCHAR(255) True


ROAS SQL_FLOAT True

RPC SQL_NUMERIC(16,2) True




www.simba.com 17


Dimensions

The table below describes the Dimensions table.





IdPrimary Key


Added_In_Api_Version SQL_VARCHAR(255) True

Allowed_In_Segments SQL_BIT True

Column_Name SQL_VARCHAR(255) False

Data_Type SQL_VARCHAR(255) True

Description SQL_VARCHAR(1024) True

Group SQL_VARCHAR(255) True

Kind SQL_VARCHAR(255) True

Status SQL_VARCHAR(255) True

UI_Name SQL_VARCHAR(255) True

www.simba.com 18


Ecommerce

The table below describes the Ecommerce table.



l Datel Dayl Hourl Item_Quantityl Item_Revenuel Monthl Revenue_Per_Transactionl Total_Valuel Transaction_Idl Transaction_Revenuel Transaction_Shippingl Transaction_Taxl Transactionsl Transactions_Per_Userl Unique_Purchasesl Weekl Year






Item_Quantity SQL_INTEGER(signed) True

Item_Revenue SQL_NUMERIC(16,2) True

www.simba.com 19




Revenue_Per_Transaction SQL_NUMERIC(16,2) True


Total_Value SQL_NUMERIC(16,2) True

Transaction_Id SQL_VARCHAR(255) True

Transaction_Revenue SQL_NUMERIC(16,2) True

Transaction_Shipping SQL_NUMERIC(16,2) True

Transaction_Tax SQL_NUMERIC(16,2) True

Transactions SQL_INTEGER(signed) True

Transactions_Per_User SQL_FLOAT True

Unique_Purchases SQL_INTEGER(signed) True



www.simba.com 20


Event_Tracking

The table below describes the Event_Tracking table.



l Avg_Event_Valuel Datel Event_Actionl Event_Categoryl Event_Labell Event_Valuel Events_Per_Session_With_Eventl Monthl Sessions_With_Eventl Total_Eventsl Unique_Eventsl Weekl Year



Avg_Event_Value SQL_FLOAT True


Event_Action SQL_VARCHAR(255) True

Event_Category SQL_VARCHAR(255) True

Event_Label SQL_VARCHAR(1024) True

Event_Value SQL_INTEGER(signed) True

Events_Per_Session_With_Event

SQL_FLOAT True

www.simba.com 21





Sessions_With_Event SQL_INTEGER(signed) True

Total_Events SQL_INTEGER(signed) True

Unique_Events SQL_INTEGER(signed) True



www.simba.com 22


Goal_Conversions

The table below describes the Goal_Conversions table.



l Datel Dayl Goal_Abandon_Rate_Alll Goal_Abandons_Alll Goal_Completion_Locationl Goal_Completions_Alll Goal_Conversion_Rate_Alll Goal_Starts_Alll Goal_Value_Alll Goal_Value_Per_Sessionl Hourl Monthl Weekl Year





Goal_Abandon_Rate_All SQL_FLOAT True

Goal_Abandons_All SQL_INTEGER(signed) True

Goal_Completion_Location SQL_VARCHAR(255) True

Goal_Completions_All SQL_INTEGER(signed) True

Goal_Conversion_Rate_All SQL_FLOAT True

www.simba.com 23



Goal_Starts_All SQL_INTEGER(signed) True

Goal_Value_All SQL_NUMERIC(16,2) True

Goal_Value_Per_Session SQL_NUMERIC(16,2) True






www.simba.com 24


Internal_Search

The table below describes the Internal_Search table.



l Avg_Search_Depthl Avg_Search_Result_Viewsl Datel Monthl Percent_Sessions_With_Searchl Search_Categoryl Search_Depthl Search_Durationl Search_Exitsl Search_Keywordl Search_Refinementsl Search_Result_Viewsl Search_Sessionsl Search_Start_Pagel Search_Uniquesl Weekl Year



Avg_Search_Depth SQL_FLOAT True

Avg_Search_Result_Views SQL_FLOAT True



Percent_Sessions_With_Search SQL_FLOAT True

www.simba.com 25



Search_Category SQL_VARCHAR(255) True

Search_Depth SQL_FLOAT True

Search_Duration SQL_FLOAT True

Search_Exits SQL_INTEGER(signed) True

Search_Keyword SQL_VARCHAR(255) True

Search_Refinements SQL_INTEGER(signed) True

Search_Result_Views SQL_INTEGER(signed) True

Search_Sessions SQL_FLOAT True

Search_Start_Page SQL_VARCHAR(255) True

Search_Uniques SQL_FLOAT True




www.simba.com 26


Master_Table

The table below describes the Master_Table table.


None of the columns in this table are nullable.



Column Name SQL Type

www.simba.com 27


Metrics

The table below describes the Metrics table.





IdPrimary Key


Added_In_Api_Version SQL_VARCHAR(255) True

Allowed_In_Segments SQL_BIT True

Column_Name SQL_VARCHAR(255) False

Data_Type SQL_VARCHAR(255) True

Description SQL_VARCHAR(1024) True

Group SQL_VARCHAR(255) True

Kind SQL_VARCHAR(255) True

Status SQL_VARCHAR(255) True

Ui_Name SQL_VARCHAR(255) True

www.simba.com 28


Page_Tracking

The table below describes the Page_Tracking table.



l Avg_Time_On_Pagel Datel Entrance_Ratel Entrancesl Exit_Ratel Exitsl Hostnamel Monthl Page_Pathl Page_Titlel Page_Valuel Pageviewsl Pageviews_Per_Sessionl Time_On_Pagel Unique_Pageviewsl Weekl Year



Avg_Time_On_Page SQL_FLOAT True


Entrance_Rate SQL_FLOAT True

Entrances SQL_INTEGER(signed) True

Exit_Rate SQL_FLOAT True

www.simba.com 29



Exits SQL_INTEGER(signed) True

Hostname SQL_VARCHAR(255) True


Page_Path SQL_VARCHAR(255) True

Page_Title SQL_VARCHAR(255) True

Page_Value SQL_NUMERIC(16,2) True

Pageviews SQL_INTEGER(signed) True

Pageviews_Per_Session SQL_FLOAT True


Time_On_Page SQL_FLOAT True

Unique_Pageviews SQL_INTEGER(signed) True



www.simba.com 30


Profiles

The table below describes the Profiles table.


l Profiles_Permissions on page 33





IdPrimary Key


Account_Id SQL_VARCHAR(255) True

Bot_Filtering_Enabled SQL_BIT True

Created SQL_TIMESTAMP True

Currency SQL_VARCHAR(255) True

Default_Page SQL_VARCHAR(255) True

Ecommerce_Tracking SQL_BIT True

Enhanced_Ecommerce_Tracking SQL_BIT True

Exclude_Query_Parameters SQL_VARCHAR(255) True

Internal_Web_Property_Id SQL_VARCHAR(255) True


Site_Search_Category_Parameters

SQL_VARCHAR(255) True

Site_Search_Query_Parameters SQL_VARCHAR(255) True

www.simba.com 31



Starred SQL_BIT True

Strip_Site_Search_Category_Parameters

SQL_BIT True

Strip_Site_Search_Query_Parameters

SQL_BIT True

Timezone SQL_VARCHAR(255) True

Type SQL_VARCHAR(255) True


Web_Property_Id SQL_VARCHAR(255) True

Website_Url SQL_VARCHAR(255) True

www.simba.com 32


Profiles_Permissions

The table below describes the Profiles_Permissions table.

This is a virtual table, and is linked to the Profiles table (see Profiles on page 31).





IdPrimary KeyForeign Key linked to columnId in Profiles table


Profiles_Permissions_IndexPrimary Key

SQL_INTEGER(unsigned) True

Permissions SQL_VARCHAR(255) True

www.simba.com 33


Segments

The table below describes the Segments table.





IdPrimary Key



Definition SQL_VARCHAR(255) True


Segment_Id SQL_VARCHAR(255) True

Type SQL_VARCHAR(255) True


www.simba.com 34


Sessions

The table below describes the Sessions table.



l Avg_Session_Durationl Bounce_Ratel Bouncesl Datel Dayl Hitsl Hourl Monthl Session_Durationl Session_Duration_Bucketl Sessionsl Unique_Dimension_Combinationsl Weekl Year



Avg_Session_Duration SQL_FLOAT True

Bounce_Rate SQL_FLOAT True

Bounces SQL_INTEGER(signed) True



Hits SQL_INTEGER(signed) True


www.simba.com 35





Session_Duration SQL_FLOAT True

Session_Duration_Bucket SQL_VARCHAR(255) True

Sessions SQL_INTEGER(signed) True

Unique_Dimension_Combinations

SQL_INTEGER(signed) True



www.simba.com 36


Site_Speed

The table below describes the Site_Speed table.



l Avg_Dom_Content_Loaded_Timel Avg_Dom_Interactive_Timel Avg_Domain_Lookup_Timel Avg_Page_Download_Timel Avg_Page_Load_Timel Avg_Redirection_Timel Avg_Server_Connection_Timel Avg_Server_Response_Timel Browserl Datel Dayl Hourl Monthl Page_Load_Timel Weekl Year



Avg_Dom_Content_Loaded_Time

SQL_FLOAT True

Avg_Dom_Interactive_Time SQL_FLOAT True

Avg_Domain_Lookup_Time SQL_FLOAT True

Avg_Page_Download_Time SQL_FLOAT True

Avg_Page_Load_Time SQL_FLOAT True

www.simba.com 37



Avg_Redirection_Time SQL_FLOAT True

Avg_Server_Connection_Time SQL_FLOAT True

Avg_Server_Response_Time SQL_FLOAT True

Browser SQL_VARCHAR(255) True





Page_Load_Time SQL_INTEGER(signed) True




www.simba.com 38


Users

The table below describes the Users table.



l Datel Days_Since_Last_Sessionl Monthl New_Usersl Percent_New_Sessionl Session_Countl Sessions_Per_Userl User_Typel Usersl Weekl Year




Days_Since_Last_Session SQL_VARCHAR(255) True


New_Users SQL_INTEGER(signed) True

Percent_New_Session SQL_FLOAT True


Session_Count SQL_VARCHAR(255) True

Sessions_Per_User SQL_FLOAT True

User_Type SQL_VARCHAR(255) True

www.simba.com 39



Users SQL_INTEGER(signed) True



www.simba.com 40


Web_Properties

The table below describes the Web_Properties table.


l Web_Properties_Permissions on page 42





IdPrimary Key


Account_Id SQL_VARCHAR(255) True


Default_Profile_Id SQL_BIGINT(signed) True

Industry_Vertical SQL_VARCHAR(255) True

Internal_Web_Property_Id SQL_VARCHAR(255) True

Level SQL_VARCHAR(255) True


Profile_Count SQL_INTEGER(signed) True

Starred SQL_BIT True


Website_Url SQL_VARCHAR(255) True

www.simba.com 41


Web_Properties_Permissions

The table below describes the Web_Properties_Permissions table.

This is a virtual table, and is linked to the Web_Properties table (see Web_Propertieson page 41).





IdPrimary KeyForeign Key linked to columnId in Web_Properties table


Web_Properties_Permissions_Index

Primary Key

SQL_INTEGER(unsigned) True

Permissions SQL_VARCHAR(255) True

www.simba.com 42


Third-Party Trademarks

Microsoft, MSDN, Windows, Windows Server, Windows Vista, and the Windows startbutton are trademarks or registered trademarks of Microsoft Corporation or itssubsidiaries in Canada, United States and/or other countries.

Google Analytics and Google are trademarks or registered trademarks of Google, Inc.or its subsidiaries in Canada, the United States and/or other countries.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other namesmay be trademarks of their respective owners.

All other trademarks are trademarks of their respective owners.

www.simba.com 43

Reference Guide Third-Party Trademarks

Documents

and Drivers with SQL · 2018-07-06 · Simba ODBC and JDBC Drivers with SQL Connector for Google Analytics ReferenceGuide Simba TechnologiesInc. ODBC driver version 1.0.0, JDBC driver