MagnitudeGatewayGoogle AnalyticsAdapterReferenceGuide … · 2020-07-31 · TableofContents...

Magnitude Gateway GoogleAnalytics Adapter Reference Guide

Reference Guide

Magnitude Software, Inc.

Version 1.6.13April 6, 2020

Copyright © 2020 Magnitude Software, Inc. All Rights Reserved.

Information in this document is subject to change without notice. Companies, namesand data used in examples herein are fictitious unless otherwise noted. No part of thispublication, or the software it describes, may be reproduced, transmitted, transcribed,stored in a retrieval system, decompiled, disassembled, reverse-engineered, ortranslated into any language in any form by any means for any purpose without theexpress written permission of Magnitude Software, Inc.

Trademarks

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

Contact Us

www.magnitude.com

www.simba.com 2

Reference Guide

http://www.magnitude.com/

Magnitude Gateway Google Analytics AdapterReference Guide

PurposeThe Magnitude Gateway Google Analytics Adapter Reference Guide Reference Guidedescribes the schema tables and stored procedures available for the MagnitudeGateway Google Analytics Adapter.

AudienceThe guide is intended for end users of the Magnitude Gateway Google AnalyticsAdapter who have already set up the adapter and configured a connection.

Knowledge PrerequisitesFor detailed information about installing, configuring, and using the MagnitudeGateway Google Analytics Adapter, see the following documentation:

l The installation documentation for the appropriate edition ofMagnitude Gatewayl Magnitude Gateway User Guidel Magnitude Gateway Google Analytics Adapter User Guide

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 Magnitude Gateway Google AnalyticsAdapter Reference Guide

Table of Contents

MagnitudeGatewayGoogle Analytics Adapter ReferenceGuide 3

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

Google Google Analytics Schema Tables 9Accounts 10Accounts_Permissions 11Ad_Exchange 12Ad_Sense 14Ad_Words 16Dimensions 18Ecommerce 19Event_Tracking 21Goal_Conversions 22Internal_Search 23Metrics 25Page_Tracking 26Profiles 28Profiles_Permissions 30Segments 31Sessions 32Site_Speed 33Users 34Web_Properties 35Web_Properties_Permissions 36

Third-Party Trademarks 37

www.simba.com 4

Reference Guide Magnitude Gateway Google AnalyticsAdapter Reference Guide

Google Analytics Stored Procedures

The Magnitude Gateway Google Analytics Adapter provides stored procedures thatyou can use to create, view, modify, and delete objects from a Google Analytics datasource.

Important:

The adapter currently does not support stored procedures for JDBC connections.These stored procedures cannot be used when you connect to Google Analyticsthrough a JDBC application.

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 Google Analytics reporting data,with the specified 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 Google Analytics Schema Tables

Google Google Analytics stores data in structures which do not follow the rules of datatyping and structure that apply to traditional relational tables and columns. Becausetraditional ODBC and JDBC toolsets might not support these data structures, the dataneeds to be mapped to a relational form. To achieve this, the Magnitude GatewayGoogle Analytics Adapter uses schema tables to map the Google Analytics data toformats that are compatible with ODBC and JDBC.

Google 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 25).

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, updatable, or returnable by ODBC-escapedDML statements.

Important:

The adapter currently does not support write-back for JDBC connections.Columns that are described as updatable cannot be updated when youconnect to Google Analytics through a JDBC application.

www.simba.com 9

Reference Guide Google 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.

The primary key columns in this table are returnable.

Column Name SQL Type

IdPrimary Key

SQL_VARCHAR(255)

Created SQL_TIMESTAMP

Name SQL_VARCHAR(255)

Updated SQL_TIMESTAMP

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)

IdPrimary KeyForeign Key linked to column Id inAccounts table

SQL_VARCHAR(255)

Permission SQL_VARCHAR(255)

www.simba.com 11


Ad_Exchange

The table below describes the Ad_Exchange table.


All columns are foldable.



Adx_CTR SQL_FLOAT

Adx_Clicks SQL_INTEGER(signed)

Adx_Coverage SQL_FLOAT

Adx_ECPM SQL_NUMERIC(16,2)

Adx_Impressions SQL_INTEGER(signed)

Adx_Impressions_Per_Session SQL_FLOAT

Adx_Monetized_Pageviews SQL_INTEGER(signed)

Adx_Revenue SQL_NUMERIC(16,2)

Adx_Revenue_Per1000_Sessions SQL_NUMERIC(16,2)

Adx_Viewable_Impressions_Percent SQL_FLOAT

Campaign SQL_VARCHAR(255)

Date SQL_VARCHAR(255)

Day SQL_VARCHAR(255)

Hour SQL_VARCHAR(255)

Month SQL_VARCHAR(255)

www.simba.com 12



Week SQL_VARCHAR(255)

Year SQL_VARCHAR(255)

www.simba.com 13


Ad_Sense

The table below describes the Ad_Sense table.





Adsense_Ad_Units_Viewed SQL_INTEGER(signed)

Adsense_Ads_Clicks SQL_INTEGER(signed)

Adsense_Ads_Viewed SQL_INTEGER(signed)

Adsense_CTR SQL_FLOAT

Adsense_Coverage SQL_FLOAT

Adsense_ECPM SQL_NUMERIC(16,2)

Adsense_Exits SQL_INTEGER(signed)

Adsense_Page_Impressions SQL_INTEGER(signed)

Adsense_Revenue SQL_NUMERIC(16,2)

Adsense_Viewable_Impression_Percent SQL_FLOAT






www.simba.com 14





www.simba.com 15


Ad_Words

The table below describes the Ad_Words table.





Ad_Clicks SQL_INTEGER(signed)

Ad_Cost SQL_NUMERIC(16,2)

Ad_Group SQL_VARCHAR(255)

CPC SQL_NUMERIC(16,2)

CPM SQL_NUMERIC(16,2)

CTR SQL_FLOAT


Cost_Per_Goal_Conversion SQL_NUMERIC(16,2)

Cost_Per_Transaction SQL_NUMERIC(16,2)


Impressions SQL_INTEGER(signed)

Keyword SQL_VARCHAR(255)


ROAS SQL_FLOAT

RPC SQL_NUMERIC(16,2)

www.simba.com 16





www.simba.com 17


Dimensions

The table below describes the Dimensions table.





IdPrimary Key

SQL_VARCHAR(255)

Added_In_Api_Version SQL_VARCHAR(255)

Allowed_In_Segments SQL_BIT

Column_Name SQL_VARCHAR(255)

Data_Type SQL_VARCHAR(255)

Description SQL_VARCHAR(1024)

Group SQL_VARCHAR(255)

Kind SQL_VARCHAR(255)

Status SQL_VARCHAR(255)

UI_Name SQL_VARCHAR(255)

www.simba.com 18


Ecommerce

The table below describes the Ecommerce table.








Item_Quantity SQL_INTEGER(signed)

Item_Revenue SQL_NUMERIC(16,2)


Revenue_Per_Transaction SQL_NUMERIC(16,2)

Total_Value SQL_NUMERIC(16,2)

Transaction_Id SQL_VARCHAR(255)

Transaction_Revenue SQL_NUMERIC(16,2)

Transaction_Shipping SQL_NUMERIC(16,2)

Transaction_Tax SQL_NUMERIC(16,2)

Transactions SQL_INTEGER(signed)

Transactions_Per_User SQL_FLOAT

Unique_Purchases SQL_INTEGER(signed)

www.simba.com 19





www.simba.com 20


Event_Tracking

The table below describes the Event_Tracking table.





Avg_Event_Value SQL_FLOAT


Event_Action SQL_VARCHAR(255)

Event_Category SQL_VARCHAR(255)

Event_Label SQL_VARCHAR(1024)

Event_Value SQL_INTEGER(signed)

Events_Per_Session_With_Event SQL_FLOAT


Sessions_With_Event SQL_INTEGER(signed)

Total_Events SQL_INTEGER(signed)

Unique_Events SQL_INTEGER(signed)



www.simba.com 21


Goal_Conversions

The table below describes the Goal_Conversions table.







Goal_Abandon_Rate_All SQL_FLOAT

Goal_Abandons_All SQL_INTEGER(signed)

Goal_Completion_Location SQL_VARCHAR(255)

Goal_Completions_All SQL_INTEGER(signed)

Goal_Conversion_Rate_All SQL_FLOAT

Goal_Starts_All SQL_INTEGER(signed)

Goal_Value_All SQL_NUMERIC(16,2)

Goal_Value_Per_Session SQL_NUMERIC(16,2)





www.simba.com 22


Internal_Search

The table below describes the Internal_Search table.





Avg_Search_Depth SQL_FLOAT

Avg_Search_Result_Views SQL_FLOAT



Percent_Sessions_With_Search SQL_FLOAT

Search_Category SQL_VARCHAR(255)

Search_Depth SQL_INTEGER(signed)

Search_Duration SQL_FLOAT

Search_Exits SQL_INTEGER(signed)

Search_Keyword SQL_VARCHAR(255)

Search_Refinements SQL_INTEGER(signed)

Search_Result_Views SQL_INTEGER(signed)

Search_Sessions SQL_INTEGER(signed)

Search_Start_Page SQL_VARCHAR(255)

Search_Uniques SQL_INTEGER(signed)

www.simba.com 23





www.simba.com 24


Metrics

The table below describes the Metrics table.





IdPrimary Key

SQL_VARCHAR(255)

Added_In_Api_Version SQL_VARCHAR(255)

Allowed_In_Segments SQL_BIT

Column_Name SQL_VARCHAR(255)

Data_Type SQL_VARCHAR(255)

Description SQL_VARCHAR(1024)

Group SQL_VARCHAR(255)

Kind SQL_VARCHAR(255)

Status SQL_VARCHAR(255)

Ui_Name SQL_VARCHAR(255)

www.simba.com 25


Page_Tracking

The table below describes the Page_Tracking table.





Avg_Time_On_Page SQL_FLOAT


Entrance_Rate SQL_FLOAT

Entrances SQL_INTEGER(signed)

Exit_Rate SQL_FLOAT

Exits SQL_INTEGER(signed)

Hostname SQL_VARCHAR(255)


Page_Path SQL_VARCHAR(255)

Page_Title SQL_VARCHAR(255)

Page_Value SQL_NUMERIC(16,2)

Pageviews SQL_INTEGER(signed)

Pageviews_Per_Session SQL_FLOAT

Time_On_Page SQL_FLOAT

Unique_Pageviews SQL_INTEGER(signed)

www.simba.com 26





www.simba.com 27


Profiles

The table below describes the Profiles table.


l Profiles_Permissions on page 30





IdPrimary Key

SQL_VARCHAR(255)

Account_Id SQL_VARCHAR(255)

Bot_Filtering_Enabled SQL_BIT


Currency SQL_VARCHAR(255)

Default_Page SQL_VARCHAR(255)

Ecommerce_Tracking SQL_BIT

Enhanced_Ecommerce_Tracking SQL_BIT

Exclude_Query_Parameters SQL_VARCHAR(255)

Internal_Web_Property_Id SQL_VARCHAR(255)


Site_Search_Category_Parameters SQL_VARCHAR(255)

Site_Search_Query_Parameters SQL_VARCHAR(255)

www.simba.com 28



Starred SQL_BIT

Strip_Site_Search_Category_Parameters SQL_BIT

Strip_Site_Search_Query_Parameters SQL_BIT

Timezone SQL_VARCHAR(255)

Type SQL_VARCHAR(255)


Web_Property_Id SQL_VARCHAR(255)

Website_Url SQL_VARCHAR(255)

www.simba.com 29


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 28).





IdPrimary KeyForeign Key linked to column Id inProfiles table

SQL_VARCHAR(255)

Profiles_Permissions_IndexPrimary Key


Permissions SQL_VARCHAR(255)

www.simba.com 30


Segments

The table below describes the Segments table.





IdPrimary Key

SQL_VARCHAR(255)


Definition SQL_VARCHAR(255)


Segment_Id SQL_VARCHAR(255)

Type SQL_VARCHAR(255)


www.simba.com 31


Sessions

The table below describes the Sessions table.





Avg_Session_Duration SQL_FLOAT

Bounce_Rate SQL_FLOAT

Bounces SQL_INTEGER(signed)



Hits SQL_INTEGER(signed)



Session_Duration SQL_FLOAT

Session_Duration_Bucket SQL_VARCHAR(255)

Sessions SQL_INTEGER(signed)

Unique_Dimension_Combinations SQL_INTEGER(signed)



www.simba.com 32


Site_Speed

The table below describes the Site_Speed table.





Avg_Dom_Content_Loaded_Time SQL_FLOAT

Avg_Dom_Interactive_Time SQL_FLOAT

Avg_Domain_Lookup_Time SQL_FLOAT

Avg_Page_Download_Time SQL_FLOAT

Avg_Page_Load_Time SQL_FLOAT

Avg_Redirection_Time SQL_FLOAT

Avg_Server_Connection_Time SQL_FLOAT

Avg_Server_Response_Time SQL_FLOAT

Browser SQL_VARCHAR(255)





Page_Load_Time SQL_INTEGER(signed)



www.simba.com 33


Users

The table below describes the Users table.






Days_Since_Last_Session SQL_VARCHAR(255)


New_Users SQL_INTEGER(signed)

Percent_New_Session SQL_FLOAT

Session_Count SQL_VARCHAR(255)

Sessions_Per_User SQL_FLOAT

User_Type SQL_VARCHAR(255)

Users SQL_INTEGER(signed)



www.simba.com 34


Web_Properties

The table below describes the Web_Properties table.


l Web_Properties_Permissions on page 36





IdPrimary Key

SQL_VARCHAR(255)

Account_Id SQL_VARCHAR(255)


Default_Profile_Id SQL_BIGINT(signed)

Industry_Vertical SQL_VARCHAR(255)

Internal_Web_Property_Id SQL_VARCHAR(255)

Level SQL_VARCHAR(255)


Profile_Count SQL_INTEGER(signed)

Starred SQL_BIT


Website_Url SQL_VARCHAR(255)

www.simba.com 35


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 35).





IdPrimary KeyForeign Key linked to column Id inWeb_Properties table

SQL_VARCHAR(255)

Web_Properties_Permissions_IndexPrimary Key


Permissions SQL_VARCHAR(255)

www.simba.com 36


Third-Party Trademarks

Linux is the registered trademark of Linus Torvalds in Canada, United States and/orother countries.

Mac, macOS, Mac OS, and OS X are trademarks or registered trademarks of Apple,Inc. or its subsidiaries in Canada, United States and/or other countries.

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 37

Reference Guide Third-Party Trademarks

Date post:	04-Aug-2020
Category:	Documents
Upload:	others
View:	0 times
Download:	0 times

MagnitudeGatewayGoogle AnalyticsAdapterReferenceGuide … · 2020-07-31 · TableofContents...

Documents