Connecting to Google Ads

For information on the available WHL files for supported environments, and how to install the appropriate file for your Python distribution, see Package Installation.

For information on the module to import, and how to configure the necessary connection properties in a connection string, see Establishing a Connection.

Other available connection properties can be used to configure other aspects of the connector capabilities.

Python Version Support

The CData Python Connector for Google Ads can be installed and used in Python 3.10 or newer.

Google Ads Version Support

The connector provides a relational view of Google Ads data for your Google account or Google Apps domain. The connector includes tables containing often-used dimensions and metrics; you can customize the table schemas or write your own to combine any valid set of dimensions and metrics.

See Also

• Using the Connector: Establish connections and query Google Ads through Python code.
• From SQLAlchemy: Use SQLAlchemy to establish a connection with dialect URL, and interact with Google Ads data using mapped classes and Sessions.

Dependencies

The Python connectors require that Python 3.10 or newer be installed.

Installation

The CData Python Connector for Google Ads is available as a WHL file for Windows, Linux, and Mac. Each connector is built using the Python 3.10 Stable ABI (indicated by the abi3 tag in the filename), so a single wheel supports any Python 3.10 or newer installation — there is no need to match your exact Python minor version. Use the "pip install" command with the appropriate WHL file for your platform.

Windows:

pip install cdata_googleads_connector-26.0.9655-cp310-abi3-win_amd64.whl

Linux:

pip install cdata_googleads_connector-26.0.9655-cp310-abi3-linux_x86_64.whl

macOS:

pip install cdata_googleads_connector-26.0.9655-cp310-abi3-macosx_12_0_arm64.whl

The macOS wheel supports arm64 (Apple Silicon) architectures only on macOS 12 and newer.

Regardless of the environment, certain distributions might require that the "pip3 install" command be used instead, to differentiate from a Python 2 distribution that might exist already. After installation, confirm whether the connector is successfully installed by running the "pip list" command. If "cdata_googleads_connector" is present in the list output by the command, then the installation was successful.

Upgrading

When upgrading, "pip install" does not automatically clean up old JRE files. To avoid leftover files that could cause JVM errors, uninstall the previous version before installing the new one.

Licensing

After the installation is complete, a separate step is needed to activate a license for the connector. Among the CData assets in the distribution's site packages, there is an install-license tool that activates this license. From within the distribution's site-packages folder, after navigating to the "cdata/installlic_googleads" folder, simply use a command like the below to activate the license. Omitting the <key> argument activates a trial license:

• Windows:
  

  ./install-license.exe <key>

• Linux / Mac:
  

  ./install-license.sh <key>

Sometimes, file access issues may cause pip to install the connector in a fallback file path that is not the python distribution's main or primary site-packages location. This can make it difficult to find where the connector was installed, and from there, the license activator. In that event, this python script below will print out the full file path of the connector's native file. This file will be stored in the mentioned cdata folder, from which the installlic_googleads folder is trivial to find:

import os
import cdata.googleads
path = os.path.abspath(cdata.googleads.__file__)
print(path)

Uninstallation

If the connector needs to be uninstalled for any reason, do so by running the pip uninstall command, as in the example below:

pip uninstall cdata-googleads-connector

The objects available within our connector are accessible from the "cdata.googleads" module. To use the module's objects directly:

1. Import the module as follows:
   

   import cdata.googleads as mod

2. To establish a connection string, call the connect() method from the connector object using an appropriate connection string, such as:
   

   mod.connect("InitiateOAuth=GETANDREFRESH;DeveloperToken=myDeveloperToken;ClientCustomerId=myClientCustomerId;")

Connecting to Google Ads

Before you can add the properties needed to authenticate, you must provide the following connection properties:

• DeveloperToken: The account developer token.
• ClientCustomerId: Your Google Ads customer ID. To find your ClientCustomerId, click the Help icon at the upper right corner of the Google Ads UI, then look at the bottom of the help menu.

Retrieving Data from Multiple Accounts

A common use for the driver is retrieving data from multiple customer Ids. This is useful when you have a Google Ads MCC account that includes numerous accounts/ClientCustomerIds. You can query and get data from the accounts you want by specifying CustomerId in the WHERE clause. For example:

SELECT * FROM AdGroupAd WHERE CustomerId='3333333333'
SELECT * FROM AdGroupAd WHERE CustomerId IN ('1111111111', '2222222222')

When you specify the CustomerId in WHERE clauses, the driver ignores the ClientCustomerId connection property.

Authenticating to Google Ads

All connections to Google Ads are authenticated using OAuth. The connector supports using user accounts, service accounts and GCP instance accounts for authentication.

User Accounts (OAuth/OauthPKCE)

Google Ads provides embedded OAuth credentials that simplify connection from a Desktop application or a Headless machine. To connect from a Web application, you must create a custom OAuth application, as described in Creating a Custom OAuth Application.

To connect via OAuth from all authentication flows, you must set AuthScheme to OAuth.

The following subsections describe how to authenticate to Google Ads from the available oauth flows. For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that already have embedded OAuth credentials, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in Google Ads, see Connection.

Desktop Applications

CData provides an embedded OAuth application that simplifies authentication at the desktop. You can also authenticate from the desktop via a custom OAuth application, which you configure and register at the Google Ads console. For further information, see Creating a Custom OAuth Application.

Before you connect, set these properties:

• InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
• Custom OAuth applications only:
  • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
  • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
  • CallbackURL: The redirect URI defined when you registered your custom OAuth application.

When you connect, the connector opens Google Ads's OAuth endpoint in your default browser. Log in and grant permissions to the application.

After you grant permissions to the application, the connector completes the OAuth process:

1. Obtains an access token from Google Ads and uses it to request data.
2. Saves the OAuth values in the path specified in OAuthSettingsLocation. These values persist across connections.

When the access token expires, the connector refreshes it automatically.

Web Applications

Authenticating via the Web requires you to create and register a custom OAuth application with Google Ads, as described in Creating a Custom OAuth Application. You can then use the connector to get and manage the OAuth token values.

This section describes how to get the OAuth access token, how to have the driver refresh the OAuth access token automatically, and how to refresh the OAuth access token manually.

Get the OAuth access token:

1. To obtain the OAuthAccessToken, set these connection properties:
   • OAuthClientId: The client Id in your custom OAuth application settings.
   • OAuthClientSecret: The client secret in your custom OAuth application settings.

2. Call stored procedures to complete the OAuth exchange:
   • Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and the CallbackURL to the Redirect URI you specified in your custom OAuth application settings. The stored procedure returns the URL to the OAuth endpoint.
   • Navigate to the URL that the stored procedure returned in Step 1. Log in and authorize the web application. You are redirected back to the callback URL.
   • Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the code parameter in the query string of the redirect URI.

After you obtain the access and refresh tokens, you can connect to data and refresh the OAuth access token automatically.

Automatic refresh of the OAuth access token:

To have the connector automatically refresh the OAuth access token, do the following:

1. The first time you connect to data, set these connection parameters:
   • InitiateOAuth: REFRESH.
   • OAuthClientId: The client Id in your custom OAuth application settings.
   • OAuthClientSecret: The client secret in your custom OAuth application settings.
   • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
   • OAuthSettingsLocation: The path where you want the connector to save the OAuth values, which persist across connections.
2. On subsequent data connections, set:
   • InitiateOAuth
   • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAUth access token is the OAuth refresh token.

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set these connection properties:
   • OAuthClientId: The Client Id in your custom OAuth application settings.
   • OAuthClientSecret: The Client Secret in your custom OAuth application settings.

3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

If you need to log in to a resource that resides on a headless machine, you must authenticate on another device that has an internet browser. You can do this in either of the following ways:

• Option 1: Obtain the OAuthVerifier value.
• Option 2: Install the connector on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.

After you execute either Option 1 or Option 2, configure the driver to automatically refresh the access token on the headless machine.

Option 1: Obtaining and Exchanging a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL as follows:

1. Authenticate from the machine with an internet browser, and obtain the OAuthVerifier connection property.

   If you are using the embedded OAuth application, call the GetOAuthAuthorizationURL stored procedure. Open the URL returned by the stored procedure in a browser.

   If you are using a custom OAuth application, set these properties:

   • InitiateOAuth: OFF.
   • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
   • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

2. Call the GetOAuthAuthorizationURL stored procedure. The stored procedure returns the CallbackURL established when the custom OAuth application was registered. (See Creating a Custom OAuth Application.)

   Copy this URL and paste it into a new browser tab.

3. Log in and grant permissions to the connector. The OAuth application redirects you the redirect URI, with a parameter called code appended. Note the value of this parameter; you will need it later, to configure the OAuthVerifier connection property.

4. Exchange the OAuth verifier code for OAuth refresh and access tokens. On the headless machine, to obtain the OAuthAccessToken, set these connection properties:

   • InitiateOAuth: REFRESH.
   • OAuthVerifier: The noted verifier code (the value of the code parameter in the redirect URI).
   • OAuthSettingsLocation: persist the encrypted OAuth authentication values to the specified file.
   • Custom OAuth applications only:
     • OAuthClientId: The client Id in your custom OAuth application settings.
     • OAuthClientSecret: The client secret in the custom OAuth application settings.

5. Test the connection to generate the OAuth settings file.

6. You are ready to connect after you re-set these properties:

   • InitiateOAuth: REFRESH.
   • OAuthSettingsLocation: The file containing the encrypted OAuth authentication values. To enable the automatic refreshing of the access token, be sure that this file gives read and write permissions to the connector.
   • Custom OAuth applications only:
     • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
     • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

Option 2: Transferring OAuth Settings

Prior to connecting on a headless machine, you must install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described above in "Desktop Applications".

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the path specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

To connect to data via the headless machine, set these connection properties:

• InitiateOAuth: REFRESH
• OAuthSettingsLocation: The path to the OAuth settings file you copied from the machine with the browser. To enable automatic refreshing of the access token, ensure that this file gives read and write permissions to the connector.
• Custom OAuth applications only:
  • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
  • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

Service Accounts (OAuthJWT)

To authenticate using a service account, you must create a new service account and have a copy of the account's certificate.

For a JSON file, set these properties:

• AuthScheme: Set this to OAuthJWT.
• InitiateOAuth: Set this to GETANDREFRESH.
• OAuthJWTCertType: Set this to GOOGLEJSON.
• OAuthJWTCert: Set this to the path to the .json file provided by Google.
• OAuthJWTSubject:The service account should be part of a GSuite domain, with delegation enabled. The value of this property should be the email address of the user whose data you want to access.

For a PFX file, set these properties:

• AuthScheme: Set this to the email address of the service account. This address usually includes the domain iam.gserviceaccount.com.
• OAuthJWTSubject: The service account must part of a GSuite domain, with delegation enabled. The value of this property is the email address of the user whose data you want to access.

If you do not already have a service account, you can create one by following the procedure in Creating a Custom OAuth Application.

GCP Instance Accounts

When running on a GCP virtual machine, the connector can authenticate using a service account tied to the virtual machine. To use this mode, set AuthScheme to GCPInstanceAccount.

Java Native Interface (JNI) is a standard programming interface for writing Java native methods and embedding the Java virtual machine into native applications.

The connector leverages the JNI for improved performance on Mac and Linux.

Configure the Config INI File

The Linux and Mac editions of the Google Ads python connector are configured with an ini file. This file is used to set several parameters, including JNI behavior. This file is to be located in:

{path_to_distribution_site-packages}/cdata/config.ini

Ensure that any configuration properties you set in the ini file fall under the following section name (adjust the 311 number if you are using an different python version from 3.11):

• For Linux:
  

  [googleads.cpython-311-x86_64-linux-gnu.so]

• For Mac:
  

  [googleads.cpython-311-darwin.so]

Configure the JNI connector's behavior by editing the properties in the connector's config.ini file. The connector can be configured as follows:

• LOGFILE: Set this the same way as the CDATA_LOGFILE envrionment variable below.
• JAVA_HOME: Configure the path to the JVM library location used to launch the JVM.
• CLASS_PATH: Use a colon-separated list to configure the paths to the third-party jar libraries.

Configure Environment Variables

Additionally, set the following environment variables:

• CDATA_JAVA_HOME: Configure the path to the JVM library location used to launch the JVM.
• CDATA_JVM_OPTIONS: Place JVM options here.
• CDATA_LOGFILE: Set this in the following scheme: <SCHEME>://<TAG>[|<LEVEL>]
  • SCHEME: The options are STDOUT, FILE.
    • STDOUT: Both the native wrapper and odbc core log into stdout. The Logfile and Verbosity properties can override the behavior of ODBC core.
    • FILE: The native wrapper logs into <FILENAME> while the odbc core logs into <FILENAME>.driver.log. The Logfile and Verbosity properties can override the behavior of ODBC core.
  • TAG
    • For STDOUT, set this to 1. For FILE, set this to the filename.
  • LEVEL
    • Set to one of: FATAL | ERROR | WARNING | INFO | DEBUG

The following are some examples of this syntax:

• STDOUT://1|DEBUG
• FILE:///tmp/my_py.log|DEBUG

Custom Logger

The Python connector supports a custom logging mechanism for redirecting log output to any destination, such as a cloud storage service or logging framework. Use setCustomLoggerFactory() to register a factory function that creates a logger instance for each connection.

The factory function receives the context string from the Logfile connection property (the portion after CUSTOM://) and must return an object with a writeLog(verbosity, message) method.

To enable custom logging:

1. Call setCustomLoggerFactory() with your factory function before opening connections.
2. Set Logfile to CUSTOM:// followed by a context string to identify the connection.
3. Set Verbosity to the desired log level.

The following example demonstrates a custom logger factory that creates a separate logger instance per connection:

import cdata.googleads as mod
import time

class MyLogger:
    def __init__(self, loggerId):
        self.loggerId = loggerId
    def writeLog(self, verbosity, message):
        print("[MyLogger " + self.loggerId + "] " + message)

def createLogger(context):
    return MyLogger(context[len("MyLoggerId="):])

mod.setCustomLoggerFactory(createLogger)

conn1 = mod.connect("...;Logfile=CUSTOM://MyLoggerId=1;Verbosity=2;")
# do something with conn1
time.sleep(1)  # Wait for logs to flush from conn1

conn2 = mod.connect("...;Logfile=CUSTOM://MyLoggerId=2;Verbosity=2;")
# do something with conn2
time.sleep(1)  # Wait for logs to flush from conn2

Creating a Custom OAuth Application

CData embeds OAuth Application Credentials with CData branding that can be used when connecting to Google Ads via a desktop application or a headless machine. (For information on getting and setting the OAuthAccessToken and other configuration parameters, see the Desktop Authentication section of "Connecting to Google Ads".)

However, you must create a custom OAuth application to connect to Google Ads via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway. Custom OAuth applications are useful if you want to:

• control branding of the authentication dialog;
• control the redirect URI that the application redirects the user to after the user authenticates; or
• customize the permissions that you are requesting from the user.

Custom applications work with both OAuth and OAuthPKCE authschemes.

The following sections describe how to enable the Directory API and create custom OAuth applications for user accounts (OAuth/OAuthPKCE) and Service Accounts (OAuth/JWT).

User Accounts (OAuth/OAuthPKCE)

For users whose AuthScheme is OAuth or OAuthPKCE, and who need to authenticate over a web application, you must always create a custom OAuth application. (For desktop and headless flows, creating a custom OAuth application is optional.)

Do the following:

1. Navigate to the Google Cloud Console.
2. Create a new project or select an existing project.
3. At the left-hand navigation menu, select Credentials.
4. If this project does not already have a consent screen configured, click CONFIGURE CONSENT SCREEN to create one. If you are not using a Google Workspace account, you are restricted to creating an External-type Consent Screen, which requires specifying a support email and developer contact email. Additional info is optional.
5. On the Credentials page, select Create Credentials > OAuth Client ID.
6. In the Application Type menu, select Web application.
7. Specify a name for your custom OAuth application.
8. Under Authorized redirect URIs, click ADD URI and enter a redirect URI.
9. Click Enter, then CREATE. The Cloud Console returns you to the Credentials page.
10. The Google Cloud Console opens a window that displays your client Id and client secret. Record the client Id and Client Secret for later use.

Note: The client secret remains accessible from from the Google Cloud Console.

Service Accounts (OAuthJWT)

Service accounts (AuthScheme OAuthJWT) are used in an OAuth flow to access Google APIs on behalf of users in a domain. A domain administrator can delegate domain-wide access to the service account.

To create a new service account:

1. Navigate to the Google Cloud Console.
2. Create a new project or select an existing project.
3. At the left-hand navigation menu, select Credentials.
4. Select Create Credentials > Service account.
5. On the Create service account page, enter the Service account name, and the Service account ID. If desired, enter a description.
6. Click DONE. The Cloud Console redisplays the Credentials page.
7. In the Service Accounts section, select the service account you just created.
8. Click the KEYS tab.
9. Click ADD KEY > Create new key.
10. Select any supported Key type (see OAuthJWTCert and OAuthJWTCertType).
11. Click CREATE. The key is automatically downloaded to your device, and any additional information specific to the key is displayed.
    Record the additional information for future use.
12. To complete the service account flow, generate a private key in the Google Cloud Console. In the service account flow, the driver exchanges a JSON Web token (JWT) for the OAuthAccessToken. The private key is required to sign the JWT; using it gives the driver the same permissions as those that were granted to the service account.

Customizing Google Ads Behavior

Using QueryPassthrough

Google Ads has its own query language (GAQL) that allow you to execute queries not supported by SQL-92 standard dialect which the driver uses by default. To execute these queries, set QueryPassthrough to True in order to bypass the SQL engine of the connector and execute GAQL queries to Google Ads. By default, queries are sent as-is to Google Ads.

Using QueryPassthrough with GAQL allows fine-tuned control while querying. When QueryPassthrough is True, the use must validate that queries are being built using the native dialect of the data source. It is recommended to have QueryPassthrough set to False in the connection manager when creating tables using this method.

Using APIVersion

This connection property controls the Google Ads APIVersion, defaulting currently to v8. The lastest Google Ads API version can be found in the Google Ads API documentation.

Required Scopes and Endpoint Domains for Google Ads

When integrating with Google Ads, your application needs specific permissions to interact with the API.

These permissions are defined by access scopes, which determine what data your application can access and what actions it can perform.

This topic provides information about the required access scopes and endpoint domains for the Google Ads connector.

Understanding Scopes

Scopes are a way to limit an application's access to a user's data. They define the specific actions that an application can perform on behalf of the user.

For example, a read-only scope might allow an application to view data, while a full access scope might allow it to modify data.

Required Scopes for Google Ads

Scope	Description
googleapis.com/auth/adwords	This driver is read-only, however a read-only scope is not provided by Google Ads. This is the default scope and the only scope available.

Understanding Endpoint Domains

Endpoint domains are the specific URLs that the application needs to communicate with in order to authenticate, retrieve records, and perform other essential operations.

Allowlisting these domains ensures that the network traffic between your application and the API is not blocked by firewalls or security settings.

Note: Most users do not need to make any special configurations. Allowlisting is typically only necessary for environments with strict security measures, such as restricted outbound network traffic.

Required Endpoint Domains for Google Ads

Domain	Always Required	Description
googleads.googleapis.com	TRUE	The endpoint used to make API calls and retrieve data. For example, https://googleads.googleapis.com/v17/customers/1234567890/adGroups.
accounts.google.com	TRUE	The domain used for OAuth.

General Changes

Date	Version	Source	Category	Type	Description
2026-06-03	26.0.9650	Google Ads	Data Model	Removed	Removed the following columns from the Ad view: AdCallAdBusinessName, AdCallAdCallTracked, AdCallAdConversionAction, AdCallAdConversionReportingState, AdCallAdCountryCode, AdCallAdDescription1, AdCallAdDescription2, AdCallAdDisableCallConversion, AdCallAdHeadline1, AdCallAdHeadline2, AdCallAdPath1, AdCallAdPath2, AdCallAdPhoneNumber, AdCallAdPhoneNumberVerificationUrl, and AdDemandGenMultiAssetAdLeadFormOnly. Removed the following columns from the AdGroupAd view: AdGroupAdAdCallAdBusinessName, AdGroupAdAdCallAdCallTracked, AdGroupAdAdCallAdConversionAction, AdGroupAdAdCallAdConversionReportingState, AdGroupAdAdCallAdCountryCode, AdGroupAdAdCallAdDescription1, AdGroupAdAdCallAdDescription2, AdGroupAdAdCallAdDisableCallConversion, AdGroupAdAdCallAdHeadline1, AdGroupAdAdCallAdHeadline2, AdGroupAdAdCallAdPath1, AdGroupAdAdCallAdPath2, AdGroupAdAdCallAdPhoneNumber, AdGroupAdAdCallAdPhoneNumberVerificationUrl, and AdGroupAdAdDemandGenMultiAssetAdLeadFormOnly. Removed CampaignStartDate and CampaignEndDate from the Campaign view. Removed the following columns from the CampaignAggregateAssetView and ChannelAggregateAssetView views: AssetBestPerformanceCostPercentage, AssetBestPerformanceImpressionPercentage, AssetGoodPerformanceCostPercentage, AssetGoodPerformanceImpressionPercentage, AssetLearningPerformanceCostPercentage, AssetLearningPerformanceImpressionPercentage, AssetLowPerformanceCostPercentage, AssetLowPerformanceImpressionPercentage, AssetUnratedPerformanceCostPercentage, AssetUnratedPerformanceImpressionPercentage, SampleBestPerformanceEntities, SampleGoodPerformanceEntities, SampleLearningPerformanceEntities, SampleLowPerformanceEntities, and SampleUnratedPerformanceEntities.
2026-06-03	26.0.9650	Google Ads	Data Model	Added	Added 5 new views: AppliedIncentive, AppTopCombinationView, MatchedLocationInterestView, VideoEnhancement, and YouTubeVideoUpload. Added the following columns to the Ad view: AdDemandGenVideoResponsiveAdCompanionBanners, AdVideoResponsiveAdBusinessName, and AdVideoResponsiveAdLogoImages. Added the following columns to the AdGroup view: ActiveViewAudibilityInvalidGivtMeasurableImpressionsRate, ActiveViewAudibilityInvalidMeasurableImpressionsRate, ActiveViewAudibilityMeasurableImpressions, ActiveViewAudibilityMeasurableImpressionsRate, ActiveViewAudibleImpressions, ActiveViewAudibleImpressionsRate, ActiveViewAudibleQuartileP100Rate, ActiveViewAudibleQuartileP25Rate, ActiveViewAudibleQuartileP50Rate, ActiveViewAudibleQuartileP75Rate, ActiveViewAudibleThirtySecondsImpressions, ActiveViewAudibleThirtySecondsImpressionsRate, ActiveViewAudibleTwoSecondsImpressions, ActiveViewAudibleTwoSecondsImpressionsRate, AdGroupVerticalAdsFormatSettingDisableTextAds, AdGroupVerticalAdsFormatSettingEnableBookingLinks, AdGroupVerticalAdsFormatSettingEnableVerticalPromotionAds, AdSubNetworkType, BiddableIndirectInstallFirstInAppConversionMicros, CostConvertedCurrencyPerPlatformComparableConversion, CostPerPlatformComparableConversion, CrossDeviceConversionsByConversionDate, CrossDeviceConversionsValueByConversionDate, PlatformComparableConversions, PlatformComparableConversionsByConversionDate, PlatformComparableConversionsFromInteractionsRate, PlatformComparableConversionsFromInteractionsValuePerInteraction, PlatformComparableConversionsValue, PlatformComparableConversionsValueByConversionDate, PlatformComparableConversionsValuePerCost, ValuePerPlatformComparableConversion, ValuePerPlatformComparableConversionsByConversionDate, VerticalAdsEventParticipantDisplayNames, VerticalAdsHotelClass, VerticalAdsListing, VerticalAdsListingBrand, VerticalAdsListingCity, VerticalAdsListingCountry, VerticalAdsListingRegion, VerticalAdsPartnerAccount, VerticalAdsVertical, VideoTrueviewViewRateInFeed, VideoTrueviewViewRateInStream, and VideoTrueviewViewRateShorts. Added the following columns to the AdGroupAd view: ActiveViewAudibilityInvalidGivtMeasurableImpressionsRate, ActiveViewAudibilityInvalidMeasurableImpressionsRate, ActiveViewAudibilityMeasurableImpressions, ActiveViewAudibilityMeasurableImpressionsRate, ActiveViewAudibleImpressions, ActiveViewAudibleImpressionsRate, ActiveViewAudibleQuartileP100Rate, ActiveViewAudibleQuartileP25Rate, ActiveViewAudibleQuartileP50Rate, ActiveViewAudibleQuartileP75Rate, ActiveViewAudibleThirtySecondsImpressions, ActiveViewAudibleThirtySecondsImpressionsRate, ActiveViewAudibleTwoSecondsImpressions, ActiveViewAudibleTwoSecondsImpressionsRate, AdGroupAdAdDemandGenVideoResponsiveAdCompanionBanners, AdGroupAdAdVideoResponsiveAdBusinessName, AdGroupAdAdVideoResponsiveAdLogoImages, AdGroupAdEndDateTime, AdGroupAdStartDateTime, AdSubNetworkType, CostConvertedCurrencyPerPlatformComparableConversion, CostPerPlatformComparableConversion, PlatformComparableConversions, PlatformComparableConversionsByConversionDate, PlatformComparableConversionsFromInteractionsRate, PlatformComparableConversionsFromInteractionsValuePerInteraction, PlatformComparableConversionsValue, PlatformComparableConversionsValueByConversionDate, PlatformComparableConversionsValuePerCost, ValuePerPlatformComparableConversion, ValuePerPlatformComparableConversionsByConversionDate, VideoTrueviewViewRateInFeed, VideoTrueviewViewRateInStream, and VideoTrueviewViewRateShorts. Added the following columns to the AdGroupAdAssetView view: AdSubNetworkType and ConversionActionName. Added AdSubNetworkType to the following views: AdGroupAdAssetCombinationView, AdGroupAudienceView, AgeRangeView, AssetFieldTypeView, AssetGroupProductGroupView, AssetSetAsset, AssetSetTypeView, BiddingStrategy, CampaignAsset, CampaignAudienceView, CampaignBudget, CampaignSearchTermView, ClickView, ContentCriterionView, CustomerAsset, DetailPlacementView, DisplayKeywordView, DistanceView, ExpandedLandingPageView, GenderView, GroupPlacementView, HotelPerformanceView, IncomeRangeView, KeywordView, LandingPageView, LocationInterestView, ManagedPlacementView, ParentalStatusView, ProductGroupView, SearchTermView, TopicView, and TravelActivityPerformanceView. Added the following columns to the AssetGroup view: AdSubNetworkType, AverageCpe, EngagementRate, and Engagements. Added the following columns to the AssetGroupAsset view: AdSubNetworkType, AverageCpe, AverageCpm, InteractionEventTypes, TrueviewAverageCpv, VideoTrueviewViewRate, and VideoTrueviewViews. Added the following columns to the Asset view: AssetBusinessMessageAssetFacebookMessengerInfoPageName, AssetBusinessMessageAssetZaloInfoCustomName, AssetBusinessMessageAssetZaloInfoOaId, and AssetOrientation. Added the following columns to the Campaign view: ActiveViewAudibilityInvalidGivtMeasurableImpressionsRate, ActiveViewAudibilityInvalidMeasurableImpressionsRate, ActiveViewAudibilityMeasurableImpressions, ActiveViewAudibilityMeasurableImpressionsRate, ActiveViewAudibleImpressions, ActiveViewAudibleImpressionsRate, ActiveViewAudibleQuartileP100Rate, ActiveViewAudibleQuartileP25Rate, ActiveViewAudibleQuartileP50Rate, ActiveViewAudibleQuartileP75Rate, ActiveViewAudibleThirtySecondsImpressions, ActiveViewAudibleThirtySecondsImpressionsRate, ActiveViewAudibleTwoSecondsImpressions, ActiveViewAudibleTwoSecondsImpressionsRate, AdSubNetworkType, BiddableIndirectInstallFirstInAppConversionMicros, CampaignEndDateTime, CampaignHotelSettingDisableHotelSetting, CampaignStartDateTime, CampaignTargetRoasTargetRoasTolerancePercentMillis, CampaignTextGuidelinesMessagingRestrictions, CampaignTextGuidelinesTermExclusions, CampaignVideoCampaignSettingsBookingDetailsCancellationDateTime, CampaignVideoCampaignSettingsBookingDetailsHoldExpirationDateTime, CampaignVideoCampaignSettingsBookingDetailsStatus, CampaignVideoCampaignSettingsReservationAdCategorySelfDisclosureAlcohol, CampaignVideoCampaignSettingsReservationAdCategorySelfDisclosureGambling, CampaignVideoCampaignSettingsReservationAdCategorySelfDisclosurePolitics, CrossDeviceConversionsByConversionDate, CrossDeviceConversionsValueByConversionDate, Svr, UniqueUsersFivePlus, UniqueUsersFourPlus, UniqueUsersTenPlus, UniqueUsersThreePlus, UniqueUsersTwoPlus, VerticalAdsEventParticipantDisplayNames, VerticalAdsHotelClass, VerticalAdsListing, VerticalAdsListingBrand, VerticalAdsListingCity, VerticalAdsListingCountry, VerticalAdsListingRegion, VerticalAdsPartnerAccount, and VerticalAdsVertical. Added the following columns to the Customer view: ActiveViewAudibilityInvalidGivtMeasurableImpressionsRate, ActiveViewAudibilityInvalidMeasurableImpressionsRate, ActiveViewAudibilityMeasurableImpressions, ActiveViewAudibilityMeasurableImpressionsRate, ActiveViewAudibleImpressions, ActiveViewAudibleImpressionsRate, ActiveViewAudibleQuartileP100Rate, ActiveViewAudibleQuartileP25Rate, ActiveViewAudibleQuartileP50Rate, ActiveViewAudibleQuartileP75Rate, ActiveViewAudibleThirtySecondsImpressions, ActiveViewAudibleThirtySecondsImpressionsRate, ActiveViewAudibleTwoSecondsImpressions, ActiveViewAudibleTwoSecondsImpressionsRate, AdSubNetworkType, BiddableIndirectInstallFirstInAppConversionMicros, CrossDeviceConversionsByConversionDate, CrossDeviceConversionsValueByConversionDate, VerticalAdsEventParticipantDisplayNames, VerticalAdsHotelClass, VerticalAdsListing, VerticalAdsListingBrand, VerticalAdsListingCity, VerticalAdsListingCountry, VerticalAdsListingRegion, VerticalAdsPartnerAccount, VerticalAdsVertical, VideoTrueviewViewRateInFeed, VideoTrueviewViewRateInStream, and VideoTrueviewViewRateShorts. Added the following columns to the GeographicView view: AdSubNetworkType, AllConversionsByConversionDate, AllConversionsValueByConversionDate, ConversionsByConversionDate, ConversionsValueByConversionDate, CrossDeviceConversionsByConversionDate, CrossDeviceConversionsValueByConversionDate, ValuePerAllConversionsByConversionDate, and ValuePerConversionsByConversionDate. Added the following columns to the PerStoreView view: AdSubNetworkType, PerStoreViewAddress1, PerStoreViewAddress2, PerStoreViewBusinessName, PerStoreViewCity, PerStoreViewCountryCode, PerStoreViewPhoneNumber, PerStoreViewPostalCode, and PerStoreViewProvince. Added ProductLinkAdvertisingPartnerPropertiesAllowedDomain to the ProductLink view. Added ProductLinkInvitationAdvertisingPartnerPropertiesAllowedDomain to the ProductLinkInvitation view. Added the following columns to the SharedCriterion view: SharedCriterionNegative, SharedCriterionVerticalAdsItemGroupRuleCityCriterionId, SharedCriterionVerticalAdsItemGroupRuleCountryCriterionId, SharedCriterionVerticalAdsItemGroupRuleHotelClass, SharedCriterionVerticalAdsItemGroupRuleItemCode, and SharedCriterionVerticalAdsItemGroupRuleRegionCriterionId. Added SharedSetVerticalAdsItemVerticalType to the SharedSet view. Added the following columns to the ShoppingPerformanceView view: AdSubNetworkType, AllConversionsByConversionDate, AllConversionsValueByConversionDate, ConversionsByConversionDate, ConversionsValueByConversionDate, SearchBudgetLostAbsoluteTopImpressionShare, SearchBudgetLostImpressionShare, SearchRankLostAbsoluteTopImpressionShare, SearchRankLostImpressionShare, ValuePerAllConversionsByConversionDate, and ValuePerConversionsByConversionDate. Added ShoppingProductProductImageUri to the ShoppingProduct view. Added TrueviewAverageCpv to the TargetingExpansionView view. Added the following columns to the UserLocationView view: AdSubNetworkType, AllConversionsByConversionDate, AllConversionsValueByConversionDate, ConversionsByConversionDate, ConversionsValueByConversionDate, CrossDeviceConversionsByConversionDate, CrossDeviceConversionsValueByConversionDate, ValuePerAllConversionsByConversionDate, and ValuePerConversionsByConversionDate. Added the following columns to the Video view: ActiveViewAudibilityInvalidGivtMeasurableImpressionsRate, ActiveViewAudibilityInvalidMeasurableImpressionsRate, ActiveViewAudibilityMeasurableImpressions, ActiveViewAudibilityMeasurableImpressionsRate, ActiveViewAudibleImpressions, ActiveViewAudibleImpressionsRate, ActiveViewAudibleQuartileP100Rate, ActiveViewAudibleQuartileP25Rate, ActiveViewAudibleQuartileP50Rate, ActiveViewAudibleQuartileP75Rate, ActiveViewAudibleThirtySecondsImpressions, ActiveViewAudibleThirtySecondsImpressionsRate, ActiveViewAudibleTwoSecondsImpressions, ActiveViewAudibleTwoSecondsImpressionsRate, AdSubNetworkType, CostConvertedCurrencyPerPlatformComparableConversion, CostPerPlatformComparableConversion, PlatformComparableConversions, PlatformComparableConversionsByConversionDate, PlatformComparableConversionsFromInteractionsRate, PlatformComparableConversionsFromInteractionsValuePerInteraction, PlatformComparableConversionsValue, PlatformComparableConversionsValueByConversionDate, PlatformComparableConversionsValuePerCost, ValuePerPlatformComparableConversion, ValuePerPlatformComparableConversionsByConversionDate, VideoTrueviewViewRateInFeed, VideoTrueviewViewRateInStream, and VideoTrueviewViewRateShorts. Added AdSubNetworkType and TrueviewAverageCpv to the WebpageView view. Added AdGroupCriterionVerticalAdsItemGroupRuleListSharedSet to the AdGroupCriterion view. Added the following enum values to AdFormatType in the AdGroup, AdGroupAd, Campaign, Customer, and Video views and the AdGroupAdAssetView view: TEXT, VERTICAL_ADS_BOOKING_LINK, and VERTICAL_ADS_PROMOTION. Added the following enum values to field type enums across the following views: CALL_TO_ACTION and LONG_DESCRIPTION to AdGroupExcludedParentAssetFieldTypes (AdGroup view), AdGroupAdAssetViewFieldType (AdGroupAdAssetView view), AdGroupAssetFieldType (AdGroupAsset view), AssetFieldTypeViewFieldType (AssetFieldTypeView view), AssetGroupAssetFieldType (AssetGroupAsset view), CampaignAggregateAssetViewFieldType (CampaignAggregateAssetView view), CampaignAssetFieldType (CampaignAsset view), ChannelAggregateAssetViewFieldType (ChannelAggregateAssetView view), CustomerAssetFieldType (CustomerAsset view), CampaignExcludedParentAssetFieldTypes (Campaign view), and FinalUrlExpansionAssetViewFieldType (FinalUrlExpansionAssetView view). Added the following enum values to criterion type enums across the following views: VERTICAL_ADS_ITEM_GROUP_RULE and VERTICAL_ADS_ITEM_GROUP_RULE_LIST to AdGroupCriterionType (AdGroupCriterion view), CampaignCriterionType (CampaignCriterion view), CustomerNegativeCriterionType (CustomerNegativeCriterion view), and SharedCriterionType (SharedCriterion view). Added the following enum value to SharedSetType in the SharedSet view: VERTICAL_ADS_ITEM_GROUP_RULE_LIST. Added the following enum value to SearchTermMatchSource in the CampaignSearchTermView and SearchTermView views: VERTICAL_ADS_DATA_FEED. Added the following enum value to AdGroupAdAssetViewPerformanceLabel in the AdGroupAdAssetView view: NOT_APPLICABLE. Added the following enum values to AdGroupAdAssetViewPinnedField in the AdGroupAdAssetView view: DESCRIPTION_LINE_HEADLINE_AS_SITELINK_POSITION_ONE, DESCRIPTION_LINE_HEADLINE_AS_SITELINK_POSITION_TWO, HEADLINE_AS_SITELINK_POSITION_ONE, and HEADLINE_AS_SITELINK_POSITION_TWO. Added the following enum values to AssetBusinessMessageAssetMessageProvider in the Asset view: FACEBOOK_MESSENGER and ZALO. Added the following enum value to ConversionActionCategory across all applicable views: YOUTUBE_FOLLOW_ON_VIEWS.
2026-05-27	26.0.9643	General	Connection	Removed	Removed the deprecated ReplaceInvalidTypesWithNull connection property. Use the ReplaceInvalidValuesWithNull property instead.
2026-05-22	26.0.9638	Python		Removed	Remove support for Intel x64 architecture on macOS
2026-05-07	26.0.9623	General	Data Model	Added	Added the ColumnCapabilities column to the sys_tablecolumns system table. This column is a bit mask denoting the column's write capabilities.
2026-05-07	26.0.9623	Python		Changed	Updated embedded JRE to jre-17.0.19+10 (Linux x64 / MacOs x64).
2026-04-15	26.0.9601	General	Query Exec	Changed	String comparisons using GREATER, LESS, and CONTAINS operators are now case-insensitive by default.
2026-04-08	26.0.9594	Google Ads	Security	Changed	TLS 1.3 is now supported by default for HTTP connections.
2026-04-01	26.0.9587	Google Ads		Removed	Removed the BatchSize connection property.
2026-03-12	25.0.9567	Google Ads	Data Model	Added	Added the CampaignGoalConfig view. Added the Goal view. Added the TargetingExpansion view. Added the following columns to the AdGroup view: AdGroupEffectiveTargetCpc, AdGroupEffectiveTargetCpcSource, AdGroupTargetCpcMicros, AverageVideoWatchTimeDurationMillis, TrueviewAverageCpv, and VideoWatchTimeDurationMillis. Added the following columns to the AdGroupAd view: AverageVideoWatchTimeDurationMillis, VideoWatchTimeDurationMillis. Added the following columns to the AdGroupAdAssetView view: AllConversionsFromInteractionsRate, AverageCost, AverageCpe, AverageCpm, ConversionsFromInteractionsRate, CrossDeviceConversions, EngagementRate, Engagements, InteractionEventTypes, InteractionRate, Interactions, TrueviewAverageCpv, VideoTrueviewViewRate, and VideoTrueviewViews. Added the following columns to the AssetGroupAsset view: ConversionAction, ConversionActionCategory, ConversionActionName, and Device. Added the following columns to the Campaign view: CampaignFeedTypes, CampaignTargetCpcTargetCpcMicros, AverageVideoWatchTimeDurationMillis, VideoWatchTimeDurationMillis, and AdUsingVideo. Added the following columns to the Customer view: AverageVideoWatchTimeDurationMillis, VideoWatchTimeDurationMillis, AdUsingProductData, and AdUsingVideo. Added the following columns to the Video view: AverageVideoWatchTimeDurationMillis, VideoWatchTimeDurationMillis. Added the following enums for the ClickType column in all views it appears in: CLICK_TO_MESSAGE_LANDING_PAGE_CLICK, CLICK_TO_MESSAGE_THIRD_PARTY_CLICK. Added the following enums to the AccessibleBiddingStrategyType column in the AccessibleBiddingStrategy view: FIXED_SHARE_OF_VOICE, TARGET_CPC. Added the LANDING_PAGE_PREVIEW enum to fields in views pertaining to AssetFieldType, For example the AdGroupExcludedParentAssetFieldTypes column in the AdGroup view and the CustomerAssetFieldType column in the CustomerAsset view. Added the following enums to the AccessibleBiddingStrategyType column in the AccessibleBiddingStrategy view: FIXED_SHARE_OF_VOICE, TARGET_CPC. Added the following enums to the BiddingStrategyType column in the BiddingStrategy view: TARGET_CPC, FIXED_SHARE_OF_VOICE. Added the following enums to the CampaignAppCampaignSettingBiddingStrategyGoalType column in the Campaign view: OPTIMIZE_TOTAL_VALUE_WITHOUT_TARGET_ROAS, OPTIMIZE_IN_APP_CONVERSIONS_WITHOUT_TARGET_CPA. Added the following enums to the CampaignBiddingStrategyType column in the Campaign view: FIXED_SHARE_OF_VOICE, TARGET_CPC. Added the following enum to the CampaignExcludedPArentAssetFieldTypes column in the Campaign view: LANDING_PAGE_PREVIEW. Added the following enum to the UserListCrmBasedUserListDataSourceType column in the USerList view: THIRD_PARTY_PARTNER_DATA.
2026-03-12	25.0.9567	Google Ads	Connection	Changed	Changed the default API version from v21 to v22.
2026-03-12	25.0.9567	Google Ads	Data Model	Changed	The VideoViewRate column is renamed to VideoTrueviewViewRate in all views it appears in. The VideoViews column is renamed to VideoTrueviewViews in all views it appears in. The AverageCpv column is renamed to TrueviewAverageCpv in all views it appears in. The VideoViewRateInFeed column is renamed to VideoTrueviewViewRateInFeed in the Campaign view. The VideoViewRateInStream column is renamed to VideoTrueviewViewRateInStream in the Campaign view. The VideoViewRateShorts column is renamed to VideoTrueviewViewRateShorts in the Campaign view. The AverageCpv column is renamed to TrueviewAverageCpv in the CampaignGroup view.
2026-03-12	25.0.9567	Google Ads	Data Model	Removed	Removed the AssetGroupAssetPerformanceLabel column from the AssetGroupAsset view. Removed the CampaignUrlExpansionOptOut column from the Campaign view. Removed the AverageCpv column from the Webpage view.
2026-01-13	25.0.9509	General		Added	Added support for the REGEXP_REPLACE() string function.
2025-12-21	25.0.9486	Python		Added	Added support for custom loggers in Python connectors on Linux and macOS.
2025-12-05	25.0.9470	General		Added	Added support for the INSERT INTO SELECT statement, with driver-side execution for providers that do not support the operation natively.
2025-11-05	25.0.9440	Google Ads		Added	Added a CustomerId column to the following views: CarrierConstant, CurrencyConstant, CustomerSearchTermInsight, GeoTargetConstant, HotelPerformanceView, KeywordThemeConstant, LanguageConstant, LifeEvent, MobileAppCategoryConstant, MobileDeviceConstant, OperatingSystemVersionConstant, ProductCategoryConstant, QualifyingQuestion, TopicConstant, TravelActivityPerformanceView, and UserInterest. Added the following views: AiMaxSearchTermAdCombinationView, CampaignSearchTermView, DetailContentSuitabilityPlacementView, FinalUrlExpansionAssetView, GroupContentSuitabilityPlacementView, and LocationInterestView. Added the AdGroupAiMaxAdGroupSettingDisableSearchTermMatching and AdGroupVideoAdGroupSettingsVideoAdSequenceStepId columns to the AdGroup view. Added the Device column to the AdGroupAdAssetView view. Added the AdGroupCriterionBrandListSharedSet, AdGroupCriterionExtendedDemographicExtendedDemographicId, AdGroupCriterionLifeEventLifeEventId, and AdGroupCriterionVideoLineupVideoLineupId columns to the AdGroupCriterion view. Added the AssetPromotionAssetPromotionBarcodeInfoBarcodeContent, AssetPromotionAssetPromotionBarcodeInfoType, AssetPromotionAssetPromotionQrCodeInfoQrCodeContent, AssetPromotionAssetTermsAndConditionsText, AssetPromotionAssetTermsAndConditionsUri, and AssetYoutubeVideoListAssetYoutubeVideos columns to the Asset view. Added the AllConversionsByConversionDate, AllConversionsValueByConversionDate, AllNewCustomerLifetimeValue, AllValueAdjustment, ConversionsByConversionDate, ConversionsValueByConversionDate, NewCustomerLifetimeValue, ValueAdjustment, ValuePerAllConversionsByConversionDate, ValuePerConversionsByConversionDate, AdNetworkType, ClickType, ConversionAction, ConversionActionCategory, ConversionActionName, ConversionAdjustment, ConversionAttributionEventType, ConversionLagBucket, ConversionOrAdjustmentLagBucket, Device, ExternalConversionSource, NewVersusReturningCustomers, and Slot columns to the AssetGroup view. Added the AllConversions, AllConversionsFromInteractionsRate, AllConversionsFromInteractionsValuePerInteraction, AllConversionsValue, AllConversionsValuePerCost, AverageCost, AverageCpc, Clicks, ConversionsFromInteractionsRate, ConversionsFromInteractionsValuePerInteraction, ConversionsValuePerCost, CostMicros, CostPerAllConversions, CostPerConversion, CrossDeviceConversions, CrossDeviceConversionsValue, Ctr, EngagementRate, Engagements, Impressions, InteractionRate, Interactions, ValuePerAllConversions, ViewThroughConversions, and AdNetworkType columns to the AssetGroupAsset view. Added the BiddingStrategyMaximizeConversionValueTargetRoasTolerancePercentMillis, BiddingStrategyTargetRoasTargetRoasTolerancePercentMillis, ClicksUniqueQueryClusters, ConversionsUniqueQueryClusters, and ImpressionsUniqueQueryClusters columns to the BiddingStrategy view. Added the CampaignAiMaxSettingBundlingRequired, CampaignAiMaxSettingEnableAiMax, CampaignContainsEuPoliticalAdvertising, CampaignMaximizeConversionValueTargetRoasTolerancePercentMillis, CampaignThirdPartyIntegrationPartnersBrandLiftIntegrationPartners, CampaignThirdPartyIntegrationPartnersBrandSafetyIntegrationPartners, CampaignThirdPartyIntegrationPartnersReachIntegrationPartners, CampaignThirdPartyIntegrationPartnersViewabilityIntegrationPartners, CampaignVideoCampaignSettingsVideoAdFormatControlFormatRestriction, CampaignVideoCampaignSettingsVideoAdFormatControlNonSkippableInStreamRestrictionsMaxDuration, CampaignVideoCampaignSettingsVideoAdFormatControlNonSkippableInStreamRestrictionsMinDuration,CampaignVideoCampaignSettingsVideoAdInventoryControlAllowNonSkippableInStream, CampaignVideoCampaignSettingsVideoAdSequenceMinimumDuration, CampaignVideoCampaignSettingsVideoAdSequenceSteps, ClicksUniqueQueryClusters, ConversionsUniqueQueryClusters, CostConvertedCurrencyPerPlatformComparableConversion, CostPerPlatformComparableConversion, ImpressionsUniqueQueryClusters, PlatformComparableConversions, PlatformComparableConversionsByConversionDate, PlatformComparableConversionsFromInteractionsRate, PlatformComparableConversionsFromInteractionsValuePerInteraction, PlatformComparableConversionsValue, PlatformComparableConversionsValueByConversionDate, PlatformComparableConversionsValuePerCost, ValuePerPlatformComparableConversion, and ValuePerPlatformComparableConversionsByConversionDate columns to the Campaign view. Added the AllConversions, AllConversionsFromInteractionsRate, AllConversionsFromInteractionsValuePerInteraction, AllConversionsValue, AllConversionsValuePerCost, AverageCost, AverageCpc, Clicks, ConversionsFromInteractionsRate, ConversionsFromInteractionsValuePerInteraction, ConversionsValuePerCost, CostMicros, CostPerAllConversions, CostPerConversion, CrossDeviceConversions, CrossDeviceConversionsValue, Ctr, EngagementRate, Engagements, InteractionRate, Interactions, ValuePerAllConversions, and ViewThroughConversions columns to the ChannelAggregateAssetView view. Added the AllConversions, AllConversionsFromInteractionsRate, AllConversionsFromInteractionsValuePerInteraction, AllConversionsValue, AllConversionsValuePerCost, AverageCost, AverageCpc, Clicks, ConversionsFromInteractionsRate, ConversionsFromInteractionsValuePerInteraction, ConversionsValuePerCost, CostMicros, CostPerAllConversions, CostPerConversion, CrossDeviceConversions, CrossDeviceConversionsValue, Ctr, EngagementRate, Engagements, InteractionRate, Interactions, ValuePerAllConversions, and ViewThroughConversions to the CampaignAggregateAssetView view. Added the CustomerVideoCustomerThirdPartyIntegrationPartnersBrandLiftIntegrationPartners, CustomerVideoCustomerThirdPartyIntegrationPartnersBrandSafetyIntegrationPartners, CustomerVideoCustomerThirdPartyIntegrationPartnersReachIntegrationPartners, CustomerVideoCustomerThirdPartyIntegrationPartnersViewabilityIntegrationPartners, ClicksUniqueQueryClusters, ConversionsUniqueQueryClusters, CostConvertedCurrencyPerPlatformComparableConversion, CostPerPlatformComparableConversion, ImpressionsUniqueQueryClusters, PlatformComparableConversions, PlatformComparableConversionsByConversionDate, PlatformComparableConversionsFromInteractionsRate, PlatformComparableConversionsFromInteractionsValuePerInteraction, PlatformComparableConversionsValue, PlatformComparableConversionsValueByConversionDate, PlatformComparableConversionsValuePerCost, ValuePerPlatformComparableConversion, and ValuePerPlatformComparableConversionsByConversionDate columns to the Customer view. Added the CustomerNegativeCriterionPlacementListSharedSet column to the CustomerNegativeCriterion view. Added the LandingPageSource column to the ExpandedLandingPageView view. Added the MatchType column to the KeywordView view. Added the LandingPageSource column to the LandingPageView view. Added the SearchTermMatchSource column to the SearchTermView view. Added the SharedCriterionWebpageConditions, SharedCriterionWebpageCoveragePercentage, SharedCriterionWebpageCriterionName, and SharedCriterionWebpageSampleSampleUrls columns to the SharedCriterion view. Added the CampaignCriterionExtendedDemographicExtendedDemographicId, CampaignCriterionLifeEventLifeEventId, CampaignCriterionVideoLineupVideoLineupId, and CampaignCriterionWebpageListSharedSet columns to the CampaignCriterion view. Added the ChangeStatusAssetSet and ChangeStatusCampaignAssetSet columns to the ChangeStatus view. In the AdGroup view, added the RELATED_YOUTUBE_VIDEOS enum to the AdGroupExcludedParentAssetFieldTypes column and the PAUSE enum to the AdGroupPrimaryStatus view. In the AdGroupAd view, added the PAUSE enum to the AdFormatType column. In the AdGroupAdAssetView view, added the RELATED_YOUTUBE_VIDEOS enum to the AdGroupAdAssetViewFieldType column, the DESCRIPTION_PREFIX enum to the AdGroupAdAssetViewPinnedField column, and the PAUSE enum to the AdFormatType. In the AdGroupAssset view, added the RELATED_YOUTUBE_VIDEOS enum to the AdGroupAssetFieldType column. In the AdGroupCriterion view, added the PLACEMENT_LIST, VIDEO_LINEUP, and WEBPAGE_LIST enums to the AdGroupCriterionType column. In the Asset view, added the YOUTUBE_VIDEO_LIST enum to the AssetType column. In the AssetFieldTypeView view, added the RELATED_YOUTUBE_VIDEOS enum to the AssetFieldTypeViewFieldType column. In the AssetGroupAsset view, added the RELATED_YOUTUBE_VIDEOS to the AssetGroupAssetFieldType column. In the Campaign view, added the RELATED_YOUTUBE_VIDEOS enum to the CampaignExcludedParentAssetFieldTypes column, the MISSING_LOCATION_TARGETING enum to the CampaignPrimaryStatusReasons column, the PAUSE enum to the AdFormatType column, and the ENGAGED_VIEW enum to the ConversionAttributionEventType column. In the CampaignAggregateAssetView view, added the RELATED_YOUTUBE_VIDEOS enum to the CampaignAggregateAssetViewFieldType column. In the CampaignAsset view, added the RELATED_YOUTUBE_VIDEOS enums to the CampaignAssetFieldType column. In the CampaignCriterion view, added the PLACEMENT_LIST, VIDEO_LINEUP, and the WEBPAGE_LIST enums to the CampaignCriterionType column. In the ChannelAggregateAssetView view, added the RELATED_YOUTUBE_VIDEOS enum to the ChannelAggregateAssetViewFieldType column. In the Customer view, added the PAUSE enum to the AdFormatType column. In the CustomerNegativeCriterion view, added the PLACEMENT_LIST, VIDEO_LINEUP, and WEBPAGE_LIST enums to the CustomerNegativeCriterionType column. In the SearchTermView view, added the AI_MAX and PERFORMANCE_MAX enums to the SearchTermMatchType column. In the SharedCriterion view, added the PLACEMENT_LIST, VIDEO_LINEUP, and WEBPAGE_LIST enums to the SharedCriterionType column. In the SharedSet view, added the WEBPAGES enum to the SharedSetType column. In the UserLocationView, TravelActivityPerformanceView, and Video views, added the PAUSE enum to the AdNetworkType column. The DISCOVER, GMAIL, and MAPS enums have been added to the AdNetworkType column in all views where this column is available. The PRODUCT_ASSETS, VEHICLE_ASSETS, VIDEO_RELATED_VIDEOS_CLICK, and VIDEO_CHANNEL_CLICK enums have been added to the ClickType column in all views where this column is available.
2025-11-05	25.0.9440	Google Ads		Changed	Updated the default API version from v19 to v21.
2025-10-30	25.0.9434	Python		Changed	Updated embedded JRE to jre-17.0.17+10 (Linux x64 / MacOs x64).
2025-10-06	25.0.9410	General		Added	Support for parsing datetime formats using ".S" and ",S" for milliseconds and nanoseconds.
2025-09-16	25.0.9390	Google Ads		Changed	When you run SELECT * queries, NULL segment columns are no longer included in the result set.
2025-09-12	25.0.9386	General		Added	Added the IsInsertable, IsUpdateable, and IsDeleteable columns to the sys_tables table.
2025-09-10	25.0.9384	General		Changed	All columns in statically defined Views are now reported as read-only.
2025-09-03	25.0.9377	General		Changed	Corrected the behavior when IN criteria with NULL values are used in the projection part. It now returns NULL instead of 0. For example, "NULL IN (1,2)" returns "NULL".
2025-09-01	25.0.9375	General		Added	Added support for using the CAST function with infinity values. This function can cast "inf" and "-inf" to DOUBLE, FLOAT, or REAL.
2025-08-21	25.0.9364	General		Changed	Report behavior change: Fixed inconsistent string value comparisons in non-table queries. For example, "SELECT 'A' = 'a'" previously returned false, but it now returns true.
2025-08-13	25.0.9356	General		Changed	Changed the maximum number of pages held in memory from 15 to 5 for the page providers to decrease heap usage.
2025-07-08	25.0.9320	Google Ads		Changed	The following fields are now filtered using Date values (yyyy-mm-dd) instead of DateTime values (yyyy-mm-ddthh:mm:ssz): AccountBudgetProposal view: AccountBudgetProposalApprovalDateTime and AccountBudgetProposalCreationDateTime CallView view: CallViewEndCallDateTime and CallViewStartCallDateTime ChangeEvent view: ChangeEventChangeDateTime ChangeStatus view: ChangeStatusLastChangeDateTime ConversionAction view: ConversionLastReceivedRequestDateTime
2025-07-07	25.0.9319	Python		Removed	Removed the 32-bit version of Windows Python.
2025-07-02	25.0.9314	Python		Removed	Removed support for Python 3.9.
2025-06-25	25.0.9307	General		Removed	Removed the "ADLS Gen 1" value from the ConnectionType property.
2025-06-25	25.0.9307	Python		Added	Added support for Python 3.13 in Windows, Linux, and Mac editions.
2025-06-25	25.0.9307	Python		Removed	Removed support for Python 3.8 as it is no longer supported.
2025-06-20	25.0.9302	General		Added	Created the following functions: TEXT_ENCODE: encodes a string into a different charset (UTF8 → UTF7 and returns a binary array as the result). TEXT_DECODE: takes a binary array and decodes it back into a string when provided the charset. BASE64_ENCODE: takes a binary array and encodes it as a base64 string (varchar). BASE64_DECODE: takes a base 64-encoded string and decodes it into a binary array.
2025-06-18	25.0.9300	General		Changed	The internal code for exception handling has been refactored. Exception messages returned during certain error conditions may now have different wording or formatting.
2025-06-10	25.0.9292	Google Ads		Added	Added 3 columns to the Ad view. Added 9 columns to the AdGroup view. Added 3 columns to the AdGroupAd view. Added 7 columns to the Asset view. Added 1 column to the AssetGroup view. Added 10 columns to the AssetGroupAsset view. Added 11 columns to the Campaign view. Added 3 columns to the CampaignAggregateAssetView view. Added 1 column to the ChangeStatus view. Added 3 columns to the ChannelAggregateAssetView view. Added 1 column to the CustomerLifecycleGoal view. Added 1 column to the LocalServicesLead view. Added value YOUTUBE_AUDIO_AD: In the Ad view's AdType column. In the AdGroupAd view's AdGroupAdType column. Added value YOUTUBE_AUDIO: In the AdGroup view's AdGroupType column. Added values BUSINESS_MESSAGE and TALL_PORTRAIT_MARKETING_IMAGE: In the AdGroup view's AdGroupCpcBidMicros column. In the AdGroupAdAssetView view's AdGroupAdAssetViewFieldType column. In the AdGroupAsset view's AdGroupAssetFieldType column. In the AssetFieldTypeView's AssetFieldTypeViewFieldType column. In the AssetGroupAsset view's AssetGroupAssetFieldType column. In the CampaignAsset view's CampaignAssetFieldType column. In the CustomerAsset view's CustomerAssetFieldType column. In the CampaignAggregateAssetView view's CampaignAggregateAssetViewFieldType column. In the ChannelAggregateAssetView view's ChannelAggregateAssetViewFieldType column. Added values APP_DEEP_LINK and BUSINESS_MESSAGE: In the Asset view's AssetType column. Added value MONTHLY: In the Campaign view's CampaignFixedCpmTargetFrequencyInfoTimeUnit column. Added values ASSET_SET, CAMPAIGN_ASSET_SET, and CAMPAIGN_BUDGET: In the ChangeStatus view's ChangeStatusResourceType column.
2025-06-10	25.0.9292	Google Ads		Changed	Updated the default API version from v18 to v19.
2025-06-10	25.0.9292	Google Ads		Removed	Removed the following views: AdGroupExtensionSetting, AdGroupFeed, CampaignExtensionSetting, CampaignFeed, CustomerExtensionSetting, CustomerFeed, ExtensionFeedItem, Feed, FeedItem, FeedItemSet, FeedItemSetLink, FeedItemTarget, FeedMapping, and FeedPlaceholderView. Removed 1 column in Campaign view: CampaignDynamicSearchAdsSettingFeeds. Removed 1 column in CampaignCriterion view: CampaignCriterionLocationGroupFeed. Removed 2 columns in ChangeEvent view: ChangeEventFeed and ChangeEventFeedItem. Removed 4 columns in ChangeStatus view: ChangeStatusAdGroupFeed, ChangeStatusCampaignFeed, ChangeStatusFeed, and ChangeStatusFeedItem. Removed the following enum values: In the Ad view's AdType column, removed value: VIDEO_OUTSTREAM_AD. In the AdGroup view's AdGroupType column, removed value: VIDEO_OUTSTREAM.
2025-05-29	25.0.9280	Google Ads		Removed	Removed the PageSize connection property, which has been deprecated in GoogleAds.
2025-05-27	25.0.9278	General		Removed	Removed the "Proprietary" enum option from ProxyAuthscheme.
2025-05-12	25.0.9263	Python		Changed	Updated embedded JRE to jre-17.0.15+6 (Linux x64 / MacOS x64) and jre-17.0.15+6 (MacOS aarch64).
2025-02-17	24.0.9179	Google Ads		Added	Three new views: ContentCriterionView, Datalink, and PerformanceMaxPlacementView. New columns in AdGroup: AdGroupExcludeDemographicExpansion, TravelDestinationCity, TravelDestinationRegion, TravelDestinationCountry. New columns in AdGroupAd: AdGroupAdAdGroupAdAssetAutomationSettings New columns in Campaign: StoreVisitsLastClickModelAttributedConversions, VideoViewRateInFeed, VideoViewRateInStream, VideoViewRateShorts, ResultsConversionsPurchase, GeneralInvalidClickRate, GeneralInvalidClicks New columns in ConversionValueRule: ConversionValueRuleItineraryConditionAdvanceBookingWindowMaxDays, ConversionValueRuleItineraryConditionAdvanceBookingWindowMinDays, ConversionValueRuleItineraryConditionTravelLengthMaxNights, ConversionValueRuleItineraryConditionTravelLengthMinNights, ConversionValueRuleItineraryConditionTravelStartDayFriday, ConversionValueRuleItineraryConditionTravelStartDayMonday, ConversionValueRuleItineraryConditionTravelStartDaySaturday, ConversionValueRuleItineraryConditionTravelStartDaySunday, ConversionValueRuleItineraryConditionTravelStartDayThursday, ConversionValueRuleItineraryConditionTravelStartDayTuesday, ConversionValueRuleItineraryConditionTravelStartDayWednesday.
2025-02-15	24.0.9177	General		Added	Added support for converting unsigned integer types to the nearest signed data type that has enough precision to hold the unsigned value.This is done for JDBC only because it does not have support for unsigned data types.
2024-11-27	24.0.9097	General		Added	Added ThreadId to LogModule output. Logfile lines now include the Thread ID associated with the action being performed.
2024-10-17	24.0.9056	Google Ads		Added	Added support for Workload Identity Federation using AWS accounts.
2024-10-14	24.0.9053	Google Ads		Added	Added a new view, ShoppingProduct.
2024-10-14	24.0.9053	Google Ads		Removed	In the AdGroup, Campaign, Custom, and KeywordView views, removed 6 columns: AuctionInsightSearchAbsoluteTopImpressionPercentage AuctionInsightSearchImpressionShare AuctionInsightSearchOutrankingShare AuctionInsightSearchOverlapRate AuctionInsightSearchPositionAboveRate AuctionInsightSearchTopImpressionPercentage
2024-08-20	24.0.8998	Google Ads		Added	Added support for V17 of the Google Ads API. This is now the default value for the APIVersion connection property. Added the Ad, CampaignAggregateAssetView, ChannelAggregateAssetView, OfflineConversionUploadConversionActionSummary, and UserListCustomerType views. For all views with a ClickType column, the value AD_IMAGE has been added to them. In the AdGroup view, added the AdGroupFixedCpmMicros, AdGroupTargetCpvMicros, and AdFormatType columns. In the AdGroupAd view, added the column AdFormatType. In the AdGroupAdAssetView view, added the AdFormatType column. In the AdGroupCriterion view, added the AdGroupCriterionPrimaryStatus and AdGroupCriterionPrimaryStatusReasons columns. In the BiddingDataExclusion view's BiddingDataExclusionAdvertisingChannelTypes column, added the value DEMAND_GEN. In the BiddingSeasonalityAdjustment view's BiddingSeasonalityAdjustmentAdvertisingChannelTypes column, added the value DEMAND_GEN. In the Campaign view, added the CampaignFixedCpmGoal, CampaignFixedCpmTargetFrequencyInfoTargetCount, CampaignFixedCpmTargetFrequencyInfoTimeUnit, CampaignKeywordMatchType, CampaignTargetCpv, CampaignVideoCampaignSettingsVideoAdInventoryControlAllowInFeed, CampaignVideoCampaignSettingsVideoAdInventoryControlAllowInStream, CampaignVideoCampaignSettingsVideoAdInventoryControlAllowShorts, AdFormatType, SkAdNetworkRedistributedFineConversionValue and SkAdNetworkVersion columns. In the Campaign view's CampaignAdvertisingChannelType column, added the value DEMAND_GEN. In the ChangeStatus view, added the ChangeStatusAssetGroup column. In the Customer view, added the AdFormatType, SkAdNetworkRedistributedFineConversionValue, and SkAdNetworkVersion columns. In the CustomerClientLink view, added the CustomerId column. In the CustomerNegativeCriterion's CustomerNegativeCriterionContentLabelType column, added the BRAND_SUITABILITY_CONTENT_FOR_FAMILIES,BRAND_SUITABILITY_GAMES_FIGHTING,BRAND_SUITABILITY_GAMES_MATURE,BRAND_SUITABILITY_HEALTH_SENSITIVE,BRAND_SUITABILITY_HEALTH_SOURCE_UNDETERMINED,BRAND_SUITABILITY_NEWS_RECENT,BRAND_SUITABILITY_NEWS_SENSITIVE,BRAND_SUITABILITY_NEWS_SOURCE_NOT_FEATURED,BRAND_SUITABILITY_POLITICS, and BRAND_SUITABILITY_RELIGION values. In the GenderView view, added the SearchImpressionShare column. In the KeywordView view, added the PhoneCalls column. In the LocalServicesLeadConversation view's LocalServicesLeadConversationConversationChannel column, added the WHATSAPP value. In the LocalServicesVerificationArtifact view, added the LocalServicesVerificationArtifactLicenseVerificationArtifactExpirationDateTime and LocalServicesVerificationArtifactInsuranceVerificationArtifactExpirationDateTime columns. In the OfflineConversionUploadClientSummary view, added the OfflineConversionUploadClientSummaryPendingEventCount and OfflineConversionUploadClientSummaryPendingRate columns. In the PerStoreView view, added the Date and Period columns. In the Video view, added the AdFormatType column.
2024-08-20	24.0.8998	Google Ads		Removed	In the AdGroupAd view's AdGroupAdAdType column, removed the DISCOVERY_CAROUSEL_AD value. In the BiddingDataExclusion view's BiddingDataExclusionAdvertisingChannelTypes column, removed the value DISCOVERY. In the BiddingSeasonalityAdjustment view's BiddingSeasonalityAdjustmentAdvertisingChannelTypes column, removed the value DISCOVERY. In the Campaign view's CampaignAdvertisingChannelType column, removed the value DISCOVERY. Removed the CustomerClientLink view's LinkedManagerId column and CustomerId pseudocolumn. Removed the CustomerLifecycleGoal's CustomerLifecycleGoalLifecycleGoalCustomerDefinitionSettingsExistingUserLists and CustomerLifecycleGoalLifecycleGoalCustomerDefinitionSettingsHighLifetimeValueUserLists columns.
2024-08-20	24.0.8998	Google Ads		Changed	In the AdGroup view's AdGroupExcludedParentAssetFieldTypes column, renamed the value DISCOVERY_CAROUSEL_CARD to DEMAND_GEN_CAROUSEL_CARD. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryCarouselAdBusinessName column to AdGroupAdAdDemandGenCarouselAdBusinessName. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryCarouselAdCallToActionText column to AdGroupAdAdDemandGenCarouselAdCallToActionText. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryCarouselAdCarouselCards column to AdGroupAdAdDemandGenCarouselAdCarouselCards. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryCarouselAdDescription column to AdGroupAdAdDemandGenCarouselAdDescription. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryCarouselAdHeadline column to AdGroupAdAdDemandGenCarouselAdHeadline. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryCarouselAdLogoImage column to AdGroupAdAdDemandGenCarouselAdLogoImage. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryMultiAssetAdBusinessName column to AdGroupAdAdDemandGenMultiAssetAdBusinessName. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryMultiAssetAdCallToActionText column to AdGroupAdAdDemandGenMultiAssetAdCallToActionText. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryMultiAssetAdDescriptions column to AdGroupAdAdDemandGenMultiAssetAdDescriptions. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryMultiAssetAdHeadlines column to AdGroupAdAdDemandGenMultiAssetAdHeadlines. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryMultiAssetAdLeadFormOnly column to AdGroupAdAdDemandGenMultiAssetAdLeadFormOnly. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryMultiAssetAdLogoImages column to AdGroupAdAdDemandGenMultiAssetAdLogoImages. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryMultiAssetAdMarketingImages column to AdGroupAdAdDemandGenMultiAssetAdMarketingImages. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryMultiAssetAdPortraitMarketingImages column to AdGroupAdAdDemandGenMultiAssetAdPortraitMarketingImages. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryMultiAssetAdSquareMarketingImages column to AdGroupAdAdDemandGenMultiAssetAdSquareMarketingImages. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryVideoResponsiveAdBreadcrumb1 column to AdGroupAdAdDemandGenVideoResponsiveAdBreadcrumb1. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryVideoResponsiveAdBreadcrumb2 column to AdGroupAdAdDemandGenVideoResponsiveAdBreadcrumb2. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryVideoResponsiveAdBusinessName column to AdGroupAdAdDemandGenVideoResponsiveAdBusinessName. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryVideoResponsiveAdCallToActions column to AdGroupAdAdDemandGenVideoResponsiveAdCallToActions. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryVideoResponsiveAdDescriptions column to AdGroupAdAdDemandGenVideoResponsiveAdDescriptions. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryVideoResponsiveAdHeadlines column to AdGroupAdAdDemandGenVideoResponsiveAdHeadlines. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryVideoResponsiveAdLogoImages column to AdGroupAdAdDemandGenVideoResponsiveAdLogoImages. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryVideoResponsiveAdLongHeadlines column to AdGroupAdAdDemandGenVideoResponsiveAdLongHeadlines. Renamed the AdGroupAd view's AdGroupAdAdDiscoveryVideoResponsiveAdVideos column to AdGroupAdAdDemandGenVideoResponsiveAdVideos. In the AdGroupAd view's AdGroupAdAdType column, renamed the value DISCOVERY_MULTI_ASSET_AD to DEMAND_GEN_MULTI_ASSET_AD. In the AdGroupAd view's AdGroupAdAdType column, renamed the value DISCOVERY_VIDEO_RESPONSIVE_AD to DEMAND_GEN_VIDEO_RESPONSIVE_AD. Renamed the Asset view's AssetDiscoveryCarouselCardAssetCallToActionText column to AssetDemandGenCarouselCardAssetCallToActionText. Renamed the Asset view's AssetDiscoveryCarouselCardAssetHeadline column to AssetDemandGenCarouselCardAssetHeadline. Renamed the Asset view's AssetDiscoveryCarouselCardAssetMarketingImageAsset column to AssetDemandGenCarouselCardAssetMarketingImageAsset. Renamed the Asset view's AssetDiscoveryCarouselCardAssetPortraitMarketingImageAsset column to AssetDemandGenCarouselCardAssetPortraitMarketingImageAsset. Renamed the Asset view's AssetDiscoveryCarouselCardAssetSquareMarketingImageAsset column to AssetDemandGenCarouselCardAssetSquareMarketingImageAsset. In the AssetGroupAsset view's AssetGroupAssetFieldType column, renamed the value DISCOVERY_CAROUSEL_CARD to DEMAND_GEN_CAROUSEL_CARD. Renamed the Campaign view's CampaignDiscoveryCampaignSettingsUpgradedTargeting column to CampaignDemandGenCampaignSettingsUpgradedTargeting. Renamed the Campaign view's SkAdNetworkConversionValue column to SkAdNetworkFineConversionValue. In the Campaign view's CampaignExcludedParentAssetFieldTypes column, renamed the value DISCOVERY_CAROUSEL_CARD to DEMAND_GEN_CAROUSEL_CARD. Renamed the Customer view's SkAdNetworkConversionValue column to SkAdNetworkFineConversionValue. Renamed the CustomerClientLink view's ClientCustomerId column to CustomerClientLinkClientCustomer. Renamed the CustomerClientLink view's Hidden column to CustomerClientLinkHidden. Renamed the CustomerClientLink view's ManagerLinkId column to CustomerClientLinkManagerLinkId. Renamed the CustomerClientLink view's ResourceName column to CustomerClientLinkResourceName. Renamed the CustomerClientLink view's Status column to CustomerClientLinkStatus.
2024-07-12	24.0.8959	Google Ads		Added	Added a new "ServerTimeZone" connection property. When you set a timezone in this property, the driver assumes that datetime values from the server are in the specified timezone.
2024-07-04	24.0.8951	Google Ads		Removed	Removed the ProductBiddingCategoryConstant view since it has been deprecated from the API.
2024-06-14	24.0.8931	Google Ads		Added	Added support for V16 of the Google Ads API. This is now the default value for the APIVersion connection property. Added LocalServicesEmployee view. Added columns to various views.
2024-06-14	24.0.8931	Google Ads		Removed	Removed columns from various views.
2024-06-05	24.0.8922	Python		Added	Added support for Python 3.12.
2024-05-09	24.0.8895	General		Changed	The ROUND function previously did not accept negative precision values. That feature has now been restored.
2024-03-15	23.0.8840	General		Added	Created a new SQL function called STRING_COMPARE that provides java's String.compare() ability to SQL queries. Returns a number representative of the compared value of two strings
2023-12-11	23.0.8745	Google Ads		Changed	Updated the GoogleAds schema to be compatible with Google Ads API v15.
2023-11-29	23.0.8733	General		Changed	The ROUND function doesn't accept the negative precision values anymore.
2023-11-29	23.0.8733	General		Changed	The returning types of the FDMonth, FDQuarter, FDWeek, LDMonth, LDQuarter, LDWeek functions are changed from Timestamp to Date. The return type of the ABS function will be consistent with the parameter value type.
2023-11-28	23.0.8732	General		Added	Added the HMACSHA256 formatter to allow for secrets to be decoded if it is in base64 format
2023-10-20	23.0.8693	Google Ads		Added	Added all missing metrics and the following column for Customer view: CustomerCustomerAgreementSettingAcceptedLeadFormTerms. Added columns AllNewCustomerLifetimeValue, NewCustomerLifetimeValue, NewVersusReturningCustomers to AdGroup, AdGroupAd, Campaign views. Added column NewVersusReturningCustomers to KeywordView, LocationView views. Added columns RecommendationImprovePerformanceMaxAdStrengthRecommendation, RecommendationMigrateDynamicSearchAdsCampaignToPerformanceMaxRecommendation, RecommendationPerformanceMaxOptInRecommendation to Recommendation view. Added columns AdGroupAdAdDiscoveryVideoResponsiveAdBreadcrumb1, AdGroupAdAdDiscoveryVideoResponsiveAdBreadcrumb2, AdGroupAdAdDiscoveryVideoResponsiveAdBusinessName, AdGroupAdAdDiscoveryVideoResponsiveAdCallToActions, AdGroupAdAdDiscoveryVideoResponsiveAdDescriptions, AdGroupAdAdDiscoveryVideoResponsiveAdHeadlines, AdGroupAdAdDiscoveryVideoResponsiveAdLogoImages, AdGroupAdAdDiscoveryVideoResponsiveAdLongHeadlines, AdGroupAdAdDiscoveryVideoResponsiveAdVideos to AdGroupAd view. Added columns AdGroupCriterionLanguageLanguageConstant, AdGroupCriterionListingGroupPath, AdGroupCriterionLocationGeoTargetConstant to AdGroupCriterion view. Added columns AssetGroupPrimaryStatus, AssetGroupPrimaryStatusReasons to AssetGroup view. Added columns AssetGroupAssetPrimaryStatus, AssetGroupAssetPrimaryStatusDetails, AssetGroupAssetPrimaryStatusReasons to AssetGroupAsset view. Added column AssetGroupListingGroupFilterPath to AssetGroupListingGroupFilter view. Added columns CampaignDiscoveryCampaignSettingsUpgradedTargeting, CampaignShoppingSettingAdvertisingPartnerIds to Campaign view. Added the following value to AdGroupAd.AdGroupAdAdType: DISCOVERY_VIDEO_RESPONSIVE_AD Added the following values to Asset.AssetCallToActionAssetCallToAction: BUY_NOW, DONATE_NOW, ORDER_NOW, PLAY_NOW, SEE_MORE, START_NOW, VISIT_SITE, WATCH_NOW. Added the following values to Campaign.CampaignPrimaryStatusReasons: HAS_ASSET_GROUPS_DISAPPROVED, HAS_ASSET_GROUPS_LIMITED_BY_POLICY, MOST_ASSET_GROUPS_UNDER_REVIEW. Added the following values to Campaign.RecommendationType: IMPROVE_PERFORMANCE_MAX_AD_STRENGTH, MIGRATE_DYNAMIC_SEARCH_ADS_CAMPAIGN_TO_PERFORMANCE_MAX, PERFORMANCE_MAX_OPT_IN. Added the following values to Recommendation.RecommendationType: IMPROVE_PERFORMANCE_MAX_AD_STRENGTH, MIGRATE_DYNAMIC_SEARCH_ADS_CAMPAIGN_TO_PERFORMANCE_MAX, PERFORMANCE_MAX_OPT_IN. Added views CampaignSearchTermInsight, CustomerSearchTermInsight.
2023-08-29	23.0.8641	Python		Added	Added support for SQLAlchemy 2.0.
2023-08-03	23.0.8615	Google Ads		Changed	Renamed the following pre-defined views, AccountStats to AccountStatsReport, AccountHourlyStats to AccountHourlyStatsReport, AdGroupStats to AdGroupStatsReport, AdGroupHourlyStats to AdGroupHourlyStatsReport, AdStats to AdStatsReport, AudienceStats to AudienceStatsReport, CampaignStats to CampaignStatsReport, CampaignHourlyStats to CampaignHourlyStatsReport, KeywordStats to KeywordStats Report.
2023-08-02	23.0.8614	Google Ads		Changed	Updated the GoogleAds schema to be compatible with Google Ads API v14.
2023-06-23	23.0.8574	Google Ads		Added	Added ClickViewFiltredReport view. Using this view, filtered operator in DATE column for getting data in multiple days are supported.
2023-06-20	23.0.8571	General		Added	Added the new sys_lastresultinfo system table.
2023-05-19	23.0.8539	Python		Added	Added support for Python 3.11 on Windows, Linux and Mac.
2023-05-16	23.0.8536	Python		Removed	Removed support for Python 3.7 on Windows and Linux
2023-04-25	23.0.8515	General		Removed	Removed support for the SELECT INTO CSV statement. The core code doesn't support it anymore.
2023-03-23	22.0.8482	Google Ads		Added	Added the following pre-defined views, AccountStats, AccountHourlyStats, AdGroupStats, AdGroupHourlyStats, AdStats, AudienceStats, CampaignStats, CampaignHourlyStats, KeywordStats.
2023-01-25	22.0.8425	Google Ads		Added	Added support for PKCE using the OAuthPKCE auth scheme
2023-01-16	22.0.8416	Google Ads		Changed	Changed FeedItemSet.FeedItemSetDynamicAffiliateLocationSetFilterChainIds's xs:type attribute from 'long' to 'string'. Changed Feed.FeedAffiliateLocationFeedDataChainIds's xs:type attribute from 'long' to 'string'. Changed AssetSet.AssetSetLocationSetBusinessProfileLocationSetListingIdFilters's xs:type attribute from 'long' to 'string'.
2022-12-14	22.0.8383	General		Changed	Added the Default column to the sys_procedureparameters table.
2022-12-06	22.0.8375	Google Ads		Added	Added WriteToFile as an input for CreateReportSchema. If set to True, the schema file will be written to the directory specified by the Location connection property. If set to False, the schema data will either be written to the FileStream or be output as BASE64 encoded data. Defaults to True.
2022-12-06	22.0.8375	Google Ads		Removed	Removed OutputFolder from the CreateReportSchema stored procedure. If WriteToFile is set to true, all schema files will be written to the directory specified by the Location connection property.
2022-11-15	22.0.8354	Python		Changed	Updated embedded JRE to jre8u345-b01(Linux x64 / MacOS x64) and jre-17.0.5+8(MacOS aarch64).
2022-11-11	22.0.8350	Google Ads		Added	Updated the driver to be compliant with the v12 release of GoogleAds. Added the following tables PerStoreView, CustomerAssetSet, AssetSetTypeView and AdGroupAssetSet. Added the following column to the AccountLink table, AccountLinkAdvertisingPartnerCustomer. Added the following column to the BiddingStrategy table, BiddingStrategyAlignedCampaignBudgetId. Added the following column to the CampaignBudget table, CampaignBudgetAlignedBiddingStrategyId. Added the following column to the CampaignCriterion table, CampaignCriterionLocationGroupEnableCustomerLevelLocationAssetSet. Added the following column to the LeadFormSubmissionData table, LeadFormSubmissionDataCustomLeadFormSubmissionFields. Added the following column to the AdGroup table, AdGroupExcludedParentAssetSetTypes. Added the following columns to the AdGroupAdAssetView table, AdGroupAdAssetViewPinnedField, ConversionAction. Added the following columns to the Asset table, AssetLocationAssetBusinessProfileLocations, AssetLocationAssetLocationOwnershipType, AssetLocationAssetPlaceId. Added the following columns to the AssetSet table, AssetSetBusinessProfileLocationGroupDynamicBusinessProfileLocationGroupFilterBusinessNameFilterBusinessName, AssetSetBusinessProfileLocationGroupDynamicBusinessProfileLocationGroupFilterBusinessNameFilterFilterType, AssetSetBusinessProfileLocationGroupDynamicBusinessProfileLocationGroupFilterLabelFilters, AssetSetLocationSetBusinessProfileLocationSetBusinessNameFilter, AssetSetLocationSetBusinessProfileLocationSetLabelFilters, AssetSetLocationSetBusinessProfileLocationSetListingIdFilters, AssetSetLocationSetChainLocationSetRelationshipType, AssetSetLocationSetLocationOwnershipType. Added the following columns to the AssetSetAsset table, AbsoluteTopImpressionPercentage, AllConversions, AllConversionsFromInteractionsRate, AllConversionsValue, AverageCost, AverageCpc, AverageCpm, Clicks, Conversions, ConversionsFromInteractionsRate, ConversionsValue, CostMicros, CostPerAllConversions, CostPerConversion, CrossDeviceConversions, Ctr, EngagementRate, Engagements, Impressions, InteractionEventTypes, InteractionRate, Interactions, PhoneCalls, PhoneImpressions, PhoneThroughRate, TopImpressionPercentage, ValuePerAllConversions, ValuePerConversion, AdNetworkType, AssetInteractionTargetAsset, AssetInteractionTargetInteractionOnThisAsset, ClickType, ConversionAction, ConversionActionCategory, ConversionActionName, Date, DayOfWeek, Device, ExternalConversionSource, Month, MonthOfYear, Period, Quarter, Slot, Week, Year. Added the following columns to the Campaign table, CampaignExcludedParentAssetSetTypes, CampaignPrimaryStatus, CampaignPrimaryStatusReasons, AllConversionsFromLocationAssetClickToCall, AllConversionsFromLocationAssetDirections, AllConversionsFromLocationAssetMenu, AllConversionsFromLocationAssetOrder, AllConversionsFromLocationAssetOtherEngagement, AllConversionsFromLocationAssetStoreVisits, AllConversionsFromLocationAssetWebsite, EligibleImpressionsFromLocationAssetStoreReach, PublisherOrganicClicks, PublisherPurchasedClicks, PublisherUnknownClicks, ViewThroughConversionsFromLocationAssetClickToCall, ViewThroughConversionsFromLocationAssetDirections, ViewThroughConversionsFromLocationAssetMenu, ViewThroughConversionsFromLocationAssetOrder, ViewThroughConversionsFromLocationAssetOtherEngagement, ViewThroughConversionsFromLocationAssetStoreVisits, ViewThroughConversionsFromLocationAssetWebsite. Added the following value to AccountLink.AccountLinkType: ADVERTISING_PARTNER. Added the following value to AdGroup.AdGroupExcludedParentAssetFieldTypes: AD_IMAGE. Added the following value to AdGroupAdAssetView.AdGroupAdAssetViewFieldType: AD_IMAGE. Added the following value to AdGroupAsset.AdGroupAssetFieldType: AD_IMAGE. Added the following value to Asset.AssetType: LOCATION. Added the following value to AssetFieldTypeView.AssetFieldTypeViewFieldType: AD_IMAGE. Added the following value to AssetGroupAsset.AssetGroupAssetFieldType: AD_IMAGE. Added the following value to Campaign.CampaignExcludedParentAssetFieldTypes: AD_IMAGE. Added the following value to Campaign.RecommendationType: FORECASTING_SET_TARGET_ROAS, RAISE_TARGET_CPA_BID_TOO_LOW. Added the following value to CampaignAsset.CampaignAssetFieldType: AD_IMAGE. Added the following value to CustomerAsset.CustomerAssetFieldType: AD_IMAGE. Added the following value to Recommendation.RecommendationType: FORECASTING_SET_TARGET_ROAS, RAISE_TARGET_CPA_BID_TOO_LOW. Added the following values to AssetSet.AssetSetType: BUSINESS_PROFILE_DYNAMIC_LOCATION_GROUP, CHAIN_DYNAMIC_LOCATION_GROUP, LOCATION_SYNC, STATIC_LOCATION_GROUP. Added the following values to OfflineUserDataJob.OfflineUserDataJobFailureReason: HIGH_AVERAGE_TRANSACTION_VALUE, LOW_AVERAGE_TRANSACTION_VALUE, NEWLY_OBSERVED_CURRENCY_CODE.
2022-11-11	22.0.8350	Google Ads		Changed	Updated the schema to be compatible with Google Ads API v12. The default APIVersion is now v12. Google has sunset V9. v10 will sunset on January 2023. v11 will sunset on March/April 2023. Renamed ExperimentArm.ExperimentArmTrial to ExperimentArm.ExperimentArmExperiment.
2022-11-11	22.0.8350	Google Ads		Removed	Removed the following columns from the AdGroupAd table, AdGroupAdAdGmailAdHeaderImage, AdGroupAdAdGmailAdMarketingImage, AdGroupAdAdGmailAdMarketingImageDescription,AdGroupAdAdGmailAdMarketingImageDisplayCallToActionText, AdGroupAdAdGmailAdMarketingImageDisplayCallToActionTextColor, AdGroupAdAdGmailAdMarketingImageDisplayCallToActionUrlCollectionId,AdGroupAdAdGmailAdMarketingImageHeadline, AdGroupAdAdGmailAdProductImages, AdGroupAdAdGmailAdProductVideos, AdGroupAdAdGmailAdTeaserBusinessName, AdGroupAdAdGmailAdTeaserDescription,AdGroupAdAdGmailAdTeaserHeadline, AdGroupAdAdGmailAdTeaserLogoImage. Removed the following value from AdGroupAd.AdGroupAdAdType: GMAIL_AD.
2022-11-11	22.0.8350	Google Ads		Deprecated	Deprecated CampaignExperiment. This table can only be used with APIVersion v11 or older.
2022-10-13	22.0.8321	Google Ads		Deprecated	The ClientCustomerId field now has support for multiple ids in addition to All, which will use all currently active ids. SELECT CustomerID FROM Customer can now be used to retrieve all the client's ids.
2022-09-30	22.0.8308	General		Changed	Added the IsPath column to the sys_procedureparameters table.
2022-09-01	22.0.8279	Google Ads		Added	Updated the driver to be compliant with the v11 release of GoogleAds. Added the following tables, LeadFormSubmissionData and CampaignGroup. Added the following columns to the AccountLink table, AccountLinkHotelCenterHotelCenterId. Added the following columns to the AdGroup table, AssetInteractionTargetAsset, AssetInteractionTargetInteractionOnThisAsset, AuctionInsightDomain. Added the following columns to the AdGroupAd table, AdGroupAdAdDiscoveryCarouselAdBusinessName, AdGroupAdAdDiscoveryCarouselAdCallToActionText, AdGroupAdAdDiscoveryCarouselAdCarouselCards, AdGroupAdAdDiscoveryCarouselAdDescription, AdGroupAdAdDiscoveryCarouselAdHeadline, AdGroupAdAdDiscoveryCarouselAdLogoImage, AdGroupAdAdDiscoveryMultiAssetAdBusinessName, AdGroupAdAdDiscoveryMultiAssetAdCallToActionText, AdGroupAdAdDiscoveryMultiAssetAdDescriptions, AdGroupAdAdDiscoveryMultiAssetAdHeadlines, AdGroupAdAdDiscoveryMultiAssetAdLeadFormOnly, AdGroupAdAdDiscoveryMultiAssetAdLogoImages, AdGroupAdAdDiscoveryMultiAssetAdMarketingImages, AdGroupAdAdDiscoveryMultiAssetAdPortraitMarketingImages, AdGroupAdAdDiscoveryMultiAssetAdSquareMarketingImages, AdGroupAdAdVideoResponsiveAdBreadcrumb1, AdGroupAdAdVideoResponsiveAdBreadcrumb2. Added the following columns to the AdGroupAdAssetCombinationView table, AdGroupAdAssetCombinationViewEnabled. Added the following columns to the AdGroupAsset table, AdGroupAssetSource. Added the following columns to the AdGroupAudienceView table, AbsoluteTopImpressionPercentage, TopImpressionPercentage. Added the following columns to the Asset table, AssetDiscoveryCarouselCardAssetCallToActionText, AssetDiscoveryCarouselCardAssetHeadline, AssetDiscoveryCarouselCardAssetMarketingImageAsset, AssetDiscoveryCarouselCardAssetPortraitMarketingImageAsset, AssetDiscoveryCarouselCardAssetSquareMarketingImageAsset, AssetDynamicCustomAssetAndroidAppLink, AssetDynamicCustomAssetContextualKeywords, AssetDynamicCustomAssetFormattedPrice, AssetDynamicCustomAssetFormattedSalePrice, AssetDynamicCustomAssetId, AssetDynamicCustomAssetId2, AssetDynamicCustomAssetImageUrl, AssetDynamicCustomAssetIosAppLink, AssetDynamicCustomAssetIosAppStoreId, AssetDynamicCustomAssetItemAddress, AssetDynamicCustomAssetItemCategory, AssetDynamicCustomAssetItemDescription, AssetDynamicCustomAssetItemSubtitle, AssetDynamicCustomAssetItemTitle, AssetDynamicCustomAssetPrice, AssetDynamicCustomAssetSalePrice, AssetDynamicCustomAssetSimilarIds, AssetDynamicFlightsAssetAndroidAppLink, AssetDynamicFlightsAssetCustomMapping, AssetDynamicFlightsAssetDestinationId, AssetDynamicFlightsAssetDestinationName, AssetDynamicFlightsAssetFlightDescription, AssetDynamicFlightsAssetFlightPrice, AssetDynamicFlightsAssetFlightSalePrice, AssetDynamicFlightsAssetFormattedPrice, AssetDynamicFlightsAssetFormattedSalePrice, AssetDynamicFlightsAssetImageUrl, AssetDynamicFlightsAssetIosAppLink, AssetDynamicFlightsAssetIosAppStoreId, AssetDynamicFlightsAssetOriginId, AssetDynamicFlightsAssetOriginName, AssetDynamicFlightsAssetSimilarDestinationIds, AssetDynamicHotelsAndRentalsAssetAddress, AssetDynamicHotelsAndRentalsAssetAndroidAppLink, AssetDynamicHotelsAndRentalsAssetCategory, AssetDynamicHotelsAndRentalsAssetContextualKeywords, AssetDynamicHotelsAndRentalsAssetDescription, AssetDynamicHotelsAndRentalsAssetDestinationName, AssetDynamicHotelsAndRentalsAssetFormattedPrice, AssetDynamicHotelsAndRentalsAssetFormattedSalePrice, AssetDynamicHotelsAndRentalsAssetImageUrl, AssetDynamicHotelsAndRentalsAssetIosAppLink, AssetDynamicHotelsAndRentalsAssetIosAppStoreId, AssetDynamicHotelsAndRentalsAssetPrice, AssetDynamicHotelsAndRentalsAssetPropertyId, AssetDynamicHotelsAndRentalsAssetPropertyName, AssetDynamicHotelsAndRentalsAssetSalePrice, AssetDynamicHotelsAndRentalsAssetSimilarPropertyIds, AssetDynamicHotelsAndRentalsAssetStarRating, AssetDynamicJobsAssetAddress, AssetDynamicJobsAssetAndroidAppLink, AssetDynamicJobsAssetContextualKeywords, AssetDynamicJobsAssetDescription, AssetDynamicJobsAssetImageUrl, AssetDynamicJobsAssetIosAppLink, AssetDynamicJobsAssetIosAppStoreId, AssetDynamicJobsAssetJobCategory, AssetDynamicJobsAssetJobId, AssetDynamicJobsAssetJobSubtitle, AssetDynamicJobsAssetJobTitle, AssetDynamicJobsAssetLocationId, AssetDynamicJobsAssetSalary, AssetDynamicJobsAssetSimilarJobIds, AssetDynamicLocalAssetAddress, AssetDynamicLocalAssetAndroidAppLink, AssetDynamicLocalAssetCategory, AssetDynamicLocalAssetContextualKeywords, AssetDynamicLocalAssetDealId, AssetDynamicLocalAssetDealName, AssetDynamicLocalAssetDescription, AssetDynamicLocalAssetFormattedPrice, AssetDynamicLocalAssetFormattedSalePrice, AssetDynamicLocalAssetImageUrl, AssetDynamicLocalAssetIosAppLink, AssetDynamicLocalAssetIosAppStoreId, AssetDynamicLocalAssetPrice, AssetDynamicLocalAssetSalePrice, AssetDynamicLocalAssetSimilarDealIds, AssetDynamicLocalAssetSubtitle, AssetDynamicRealEstateAssetAddress, AssetDynamicRealEstateAssetAndroidAppLink, AssetDynamicRealEstateAssetCityName, AssetDynamicRealEstateAssetContextualKeywords, AssetDynamicRealEstateAssetDescription, AssetDynamicRealEstateAssetFormattedPrice, AssetDynamicRealEstateAssetImageUrl, AssetDynamicRealEstateAssetIosAppLink, AssetDynamicRealEstateAssetIosAppStoreId, AssetDynamicRealEstateAssetListingId, AssetDynamicRealEstateAssetListingName, AssetDynamicRealEstateAssetListingType, AssetDynamicRealEstateAssetPrice, AssetDynamicRealEstateAssetPropertyType, AssetDynamicRealEstateAssetSimilarListingIds, AssetDynamicTravelAssetAndroidAppLink, AssetDynamicTravelAssetCategory, AssetDynamicTravelAssetContextualKeywords, AssetDynamicTravelAssetDestinationAddress, AssetDynamicTravelAssetDestinationId, AssetDynamicTravelAssetDestinationName, AssetDynamicTravelAssetFormattedPrice, AssetDynamicTravelAssetFormattedSalePrice, AssetDynamicTravelAssetImageUrl, AssetDynamicTravelAssetIosAppLink, AssetDynamicTravelAssetIosAppStoreId, AssetDynamicTravelAssetOriginId, AssetDynamicTravelAssetOriginName, AssetDynamicTravelAssetPrice, AssetDynamicTravelAssetSalePrice, AssetDynamicTravelAssetSimilarDestinationIds, AssetDynamicTravelAssetTitle, AssetLeadFormAssetCustomQuestionFields, AssetSource. Added the following columns to the AssetGroup table, AssetGroupAdStrength. Added the following columns to the AssetSet table, AssetSetId. Added the following columns to the Campaign table, CampaignBiddingStrategySystemStatus, CampaignCampaignGroup, CampaignLocalServicesCampaignSettingsCategoryBids, CampaignManualCpa, CampaignPerformanceMaxUpgradePerformanceMaxCampaign, CampaignPerformanceMaxUpgradePreUpgradeCampaign, CampaignPerformanceMaxUpgradeStatus, CampaignShoppingSettingFeedLabel, AllConversionsFromClickToCall, AllConversionsFromDirections, AllConversionsFromMenu, AllConversionsFromOrder, AllConversionsFromOtherEngagement, AllConversionsFromStoreVisit, AllConversionsFromStoreWebsite, AssetInteractionTargetAsset, AssetInteractionTargetInteractionOnThisAsset, AuctionInsightDomain, SkAdNetworkAttributionCredit. Added the following columns to the CampaignAsset table, CampaignAssetSource. Added the following columns to the CampaignAudienceView table, AbsoluteTopImpressionPercentage, TopImpressionPercentage. Added the following columns to the ConversionAction table, ConversionActionFirebaseSettingsPropertyId, ConversionActionFirebaseSettingsPropertyName, AllConversions, AllConversionsValue, Date, Month, Period, Quarter, Week. Added the following columns to the Customer table, CustomerConversionTrackingSettingGoogleAdsConversionCustomer. Added the following columns to the CustomerAsset table, CustomerAssetSource. Added the following columns to the KeywordView table, AuctionInsightDomain. Added the following columns to the Recommendation table, RecommendationDisplayExpansionOptInRecommendation, RecommendationResponsiveSearchAdImproveAdStrengthRecommendation, RecommendationUpgradeLocalCampaignToPerformanceMaxRecommendation, RecommendationUpgradeSmartShoppingCampaignToPerformanceMaxRecommendation. Added the following columns to the SmartCampaignSetting table, SmartCampaignSettingAdOptimizedBusinessProfileSettingIncludeLeadForm, SmartCampaignSettingBusinessProfileLocation. Added the following columns to the UserList table, UserListRuleBasedUserListFlexibleRuleUserListExclusiveOperands, UserListRuleBasedUserListFlexibleRuleUserListInclusiveOperands, UserListRuleBasedUserListFlexibleRuleUserListInclusiveRuleOperator.
2022-09-01	22.0.8279	Google Ads		Changed	Updated the schema to be compatible with Google Ads API v11. The default APIVersion is now v11. Google has sunset v7 and v8. V9 will sunset on September 2022. Renamed AccessibleBiddingStrategy.AccessibleBiddingStrategyMaximizeConversionsTargetCpa to AccessibleBiddingStrategy.AccessibleBiddingStrategyMaximizeConversionsTargetCpaMicros. Renamed BiddingStrategy.BiddingStrategyMaximizeConversionsTargetCpa to BiddingStrategy.BiddingStrategyMaximizeConversionsTargetCpaMicros. Renamed Campaign.CampaignMaximizeConversionsTargetCpa to Campaign.CampaignMaximizeConversionsTargetCpaMicros. Removed SmartCampaignSettings.SmartCampaignSettingBusinessLocationId. Removed UserList.UserListRuleBasedUserListDateSpecificRuleUserListEndDate. Removed UserList.UserListRuleBasedUserListDateSpecificRuleUserListRuleRuleItemGroups. Removed UserList.UserListRuleBasedUserListDateSpecificRuleUserListRuleRuleType. Removed UserList.UserListRuleBasedUserListDateSpecificRuleUserListStartDate. Removed 'SMART_DISPLAY' value for ExperimentType column (Experiment table).
2022-07-01	22.0.8217	Google Ads		Added	Added support for Google Ads Native Queries with Query Passthrough.
2022-06-23	22.0.8209	Google Ads		Added	Added back embedded credentials.
2022-05-18	22.0.8173	Python		Added	Added support for Python 3.10 on Windows, Linux, and Mac Added support for Python 3.9 on Mac Added support for Mac M1
2022-05-18	22.0.8173	Python		Removed	Removed support for Python 3.6 on Windows and Linux
2022-04-22	22.0.8147	Google Ads		Removed	Removed the AdWords schema as it has been sunset.
2022-03-23	21.0.8117	Google Ads		Added	Added support for using predefined date ranges by introducing the Period column to many tables.
2022-03-04	21.0.8098	Google Ads		Added	Added the tables AdGroupAdAssetCombinationView, AssetGroupSignal, Audience, Experiment, ExperimentArm Added the following columns to the AdGroup table: AdGroupAudienceSettingUseAudienceGrouped, AdGroupEffectiveCpcBidMicros Added the following columns to the AdGroupAdAssetView table: BiddableAppInstallConversions, BiddableAppPostInstallConversions Added the following columns to the AdGroupCriterion table: AdGroupCriterionAudienceAudience Added the following columns to the Campaign table: CampaignAudienceSettingUseAudienceGrouped, CampaignShoppingSettingUseVehicleInventory, SkAdNetworkAdEventType, SkAdNetworkSourceAppSkAdNetworkSourceAppId, SkAdNetworkUserType Added the following columns to the ConversionValueRuleSet table: ConversionValueRuleSetConversionActionCategories Added the following columns to the Customer table: CustomerConversionTrackingSettingAcceptedCustomerDataTerms, CustomerConversionTrackingSettingConversionTrackingStatus, CustomerConversionTrackingSettingEnhancedConversionsForLeadsEnabled, CustomerStatus Added the following columns to the CustomerClient table: CustomerClientStatus Added the following columns to the GeographicView table: AbsoluteTopImpressionPercentage, TopImpressionPercentage Added the following columns to the HotelReconciliation table: HotelReconciliationCampaign, HotelCommissionRateMicros, HotelExpectedCommissionCost Added the following columns to the Recommendation table: RecommendationResponsiveSearchAdAssetRecommendation, RecommendationUseBroadMatchKeywordRecommendation
2022-03-04	21.0.8098	Google Ads		Changed	Updated the GoogleAds schema to be compatible with Google Ads API v10. Renamed AdGroupAd.AdGroupAdAdVideoAdDiscoveryDescription1 to AdGroupAd.AdGroupAdAdVideoAdInFeedDescription1 Renamed AdGroupAd.AdGroupAdAdVideoAdDiscoveryDescription2 to AdGroupAd.AdGroupAdAdVideoAdInFeedDescription2 Renamed AdGroupAd.AdGroupAdAdVideoAdDiscoveryHeadline to AdGroupAd.AdGroupAdAdVideoAdInFeedHeadline Renamed AdGroupAd.AdGroupAdAdVideoAdDiscoveryThumbnail to AdGroupAd.AdGroupAdAdVideoAdInFeedThumbnail
2022-02-09	21.0.8075	Google Ads		Added	Added support for using CustomerId in a query. For example, let's say you have a lot of accounts from which you want to get data. Instead of opening multiple connections, each with their own ClientCustomerId connection property, you can now specify the customer ids in a list: SELECT * FROM AdGroupAd WHERE CustomerId IN ('1111111111', '2222222222'). You can also specify just one CustomerId: SELECT * FROM AdGroupAd WHERE CustomerId='3333333333'
2022-02-09	21.0.8075	Google Ads		Changed	ClientCustomerId is no longer a required connection property.
2022-02-09	21.0.8075	Google Ads		Removed	Removed unsupported columns from the tables: AdGroup, AdGroupAd, BiddingStrategy, Campaign, KeywordView. The unsupported columns can not be selected if the table is specified in the FROM clause of the query.
2021-11-12	21.0.7986	Google Ads		Added	Added the tables: AdGroupCriterionCustomizer, AdGroupCustomizer, AssetGroup, AssetGroupAsset, AssetGroupListingGroupFilter, AssetSet, AssetSetAsset, CampaignAssetSet, CampaignConversionGoal, CampaignCustomizer, ConversionGoalCampaignConfig, CustomConversionGoal, CustomerConversionGoal, CustomerCustomizer, CustomizerAttribute, HotelReconciliation.
2021-11-12	21.0.7986	Google Ads		Changed	The view Resources now shows the resource name, attribute resources and segmenting resources. They are needed when executing the stored procedure CreateReportSchema.
2021-11-12	21.0.7986	Google Ads		Removed	Removed CustomerId from the following tables where it is not available: CarrierConstant, CurrencyConstant, GeoTargetConstant, KeywordThemeConstant, LanguageConstant, LifeEvent, HotelPerformanceView, MobileAppCategoryConstant, MobileDeviceConstant, OperatingSystemVersionConstant, ProductBiddingCategoryConstant, TopicConstant, UserInterest
2021-11-04	21.0.7978	Google Ads		Added	Added the following columns to the Asset table: AssetCallAssetAdScheduleTargets, AssetCallAssetCallConversionAction, AssetCallAssetCallConversionReportingState, AssetCallAssetCountryCode, AssetCallAssetPhoneNumber, AssetCallToActionAssetCallToAction, AssetHotelCalloutAssetLanguageCode, AssetHotelCalloutAssetText, AssetMobileAppAssetAppId, AssetMobileAppAssetAppStore, AssetMobileAppAssetEndDate, AssetMobileAppAssetLinkText, AssetMobileAppAssetStartDate, AssetPriceAssetLanguageCode, AssetPriceAssetPriceOfferings, AssetPriceAssetPriceQualifier, AssetPriceAssetType. Added the following columns to the BiddingStrategy table: BiddingStrategyMaximizeConversionValueCpcBidCeilingMicros, BiddingStrategyMaximizeConversionValueCpcBidFloorMicros, BiddingStrategyMaximizeConversionValueTargetRoas, BiddingStrategyMaximizeConversionsCpcBidCeilingMicros, BiddingStrategyMaximizeConversionsCpcBidFloorMicros, BiddingStrategyMaximizeConversionsTargetCpa.
2021-11-04	21.0.7978	Google Ads		Changed	Updated the GoogleAds schema to be compatible with Google Ads API v9.
2021-09-02	21.0.7915	General		Added	Added support for the STRING_SPLIT table-valued function in the CROSS APPLY clause.
2021-08-07	21.0.7889	General		Changed	Added the KeySeq column to the sys_foreignkeys table.
2021-08-06	21.0.7888	General		Changed	Added the new sys_primarykeys system table.
2021-07-23	21.0.7874	General		Changed	Updated the Literal Function Names for relative date/datetime functions. Previously, relative date/datetime functions resolved to a different value when used in the projection as opposed to the predicate. For example: SELECT LAST_MONTH() AS lm, Col FROM Table WHERE Col > LAST_MONTH(). Formerly, the two LAST_MONTH() methods would resolve to different datetimes. Now, they will match. As a replacement for the previous behavior, the relative date/datetime functions in the criteria may have an 'L' appended to them. For example: WHERE col > L_LAST_MONTH(). This will continue to resolve to the same values that were previously calculated in the criteria. Note that the "L_" prefix will only work in the predicate - it not available for the projection.
2021-07-21	21.0.7872	Google Ads		Removed	Removed the embedded credentials since they are no longer working for other Developer Keys.
2021-06-21	21.0.7842	Google Ads		Added	Added the connection property APIVersion, which defaults to v8. This connection property controls the Google Ads API version.
2021-06-21	21.0.7842	Google Ads		Changed	Updated the GoogleAds schema to be compatible with Google Ads API v8. Renamed the v201809 schema to AdWords, and the googleadsv6 schema to GoogleAds.
2021-06-18	21.0.7839	Google Ads		Added	Added support for the GOOGLEJSONBLOB JWT certificate type. This works like the existing GOOGLEJSON certificate type except that the certificate is provided as JSON text instead of as a file path.
2021-04-23	21.0.7783	General		Changed	Updated how display sizes are determined for varchar primary key and foreign key columns so they will match the reported length of the column.
2021-04-16	21.0.7776	General		Changed	Reduced the length to 255 for varchar primary key and foreign key columns.
2021-04-16	21.0.7776	General		Changed	Updated implicit and metadata caching to improve performance and support for multiple connections. Old metadata caches are not compatible - you need to generate new metadata caches if you are currently using CacheMetadata.
2021-04-16	21.0.7776	General		Changed	Updated index naming convention to avoid duplicates.
2020-11-15	20.0.7624	Google Ads		Added	Added schema GoogleAdsV6 which uses the Google Ads API V6 to connect to Google Ads data. Added the corresponding 'Data Model' subsection in the Help Documentation. Removed deprecated columns (GoogleAdsV3 and GoogleAdsV6 schemas): HotelPerformanceView.CustomerId and BiddingStrategyTargetOutrankShareCompetitorDomain, BiddingStrategyTargetOutrankShareCpcBidCeilingMicros, BiddingStrategyTargetOutrankShareOnlyRaiseCpcBids, BiddingStrategyTargetOutrankShareRaiseCpcBidWhenQualityScoreIsLow, BiddingStrategyTargetOutrankShareTargetOutrankShareMicros from the BiddingStrategy View. The aggregate column AdGroupAdPolicySummary in the AdGroupAd and AdGroupAdAssetView views of the GoogleAdsV6 schema has been expanded to AdGroupAdPolicySummaryApprovalStatus, AdGroupAdPolicySummaryPolicyTopicEntries, AdGroupAdPolicySummaryReviewStatus. Added new columns (GoogleAdsV6 schema): Customer.CustomerOptimizationScore, AdGroupCriterion.AdGroupCriterionDisapprovalReasons, HotelGroupView.HotelEligibleImpressions, HotelPerformanceView.HotelEligibleImpressions, BiddingStrategy.BiddingStrategyEffectiveCurrencyCode, ClickView.ClickViewCampaignLocationTarget, ClickView.ClickViewUserList, CampaignCriterion.CampaignCriterionCustomAudience, AdGroupCriterion. AdGroupCriterionCustomAudience, Customer.CustomerOptimizationScoreWeight.

This section provides a walk-through for writing Google Ads data access code in Python script.

For more information on the available data source entities and how to query them with SQL, see Data Model. For the SQL syntax, see SQL Compliance.

Connecting from Code

For information on how to deploy the connector and configure the connection to Google Ads, see Package Installation and Establishing a Connection.

For information on how to connect with the googleads.connector module and its related classes, see Connecting.

Executing SQL

The connection's cursor object is used to directly execute SQL queries. For information on how to execute SELECT statements and process the returned result sets, see Querying Data.

Executing Stored Procedures

You can call stored procedures by using the EXECUTE statement. For further information, see Calling Stored Procedures.

Connecting with the cdata.googleads Module:

The connector's module is used directly to establish a connection with the data source. It does this by using a connection string as its argument. For example:

import cdata.googleads as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;DeveloperToken=myDeveloperToken;ClientCustomerId=myClientCustomerId;")

Once the connection is created, you can use it to execute subsequent SQL queries.

After connecting as described in Connecting, you can use the open connection to execute SQL statements.

Executing Queries

To execute SQL statements that return data, use the execute() method. Once a query is executed, the result set is fetched from the cursor. This result set can then be iterated over to process the records individually.

For example:

cur = conn.execute("SELECT Clicks, Device FROM CampaignPerformance")
rs = cur.fetchall()
for row in rs:
	print(row)

Parameterized Queries

Various Python collections, such as arrays and tuples, can act as additional arguments for the execute() method. This enables you to parameterize the queries executed and help to prevent SQL Injection.

For example:

cmd = "SELECT Clicks, Device FROM CampaignPerformance WHERE Device = ?"
params = ["Mobile devices with full browsers"]
cur = conn.execute(cmd, params)
rs = cur.fetchall()
for row in rs:
	print(row)

You can execute stored procedures using either the execute() or callproc() method of the connection.

Calling Stored Procedures Using Execute()

When you call stored procedures by issuing EXECUTE commands, the stored procedure arguments are parameterized. For example:

cmd = "EXECUTE GetOAuthAccessToken AuthMode = ?"
params = ["APP"]
conn.execute(cmd, params)

Calling Stored Procedures Using Callproc()

When you call stored procedured by issuing the callproc() method, the stored procedure arguments are a procedure name and a list of parameters. For example:

cur = conn.cursor()
params = ["APP"]
cur.callproc("GetOAuthAccessToken", params)

The connector is integrated with other tools and packages within Python.

Python Integration Guides

The following sections show how to create and use connections with the connector in common packages in Python:

• From SQLAlchemy
• From Pandas
• From Matplotlib
• From Petl

Complete List of Google Ads Integration Quickstarts

For information on connecting from other applications, see Google Ads integration guides.

The CData Python Connector for Google Ads includes a Dialect class that enables integration with SQLAlchemy. Bear in mind that several aspects of connector functionality are not currently supported in SQLAlchemy 2.0 or above. If necessary, downgrade SQLAlchemy to version 1.4 or 1.3 before using this connector.

The following sections detail various aspects of this integration:

Connecting From SQLAlchemy

To construct a URL with which SQLAlchemy loads and uses the appropriate connector automatically, see Connecting

Reflecting Metadata With SQLAlchemy

To learn how to model Google Ads tables with mapped classes, see Reflecting Metadata.

Querying Data From SQLAlchemy

To learn how to use mapped classes to query the associated tables, see Querying Data.

Connecting With a Dialect URL

Establishing a connection using SQLAlchemy requires a specific URL format.

from sqlalchemy import create_engine
engine = create_engine("googleads:///?InitiateOAuth=GETANDREFRESH;DeveloperToken=myDeveloperToken;ClientCustomerId=myClientCustomerId;")

For SQLAlchemy 2.0, the dialect name is googleads_2. To establish a connection, use the following URL format:

from sqlalchemy import create_engine
engine = create_engine("googleads_2:///?InitiateOAuth=GETANDREFRESH;DeveloperToken=myDeveloperToken;ClientCustomerId=myClientCustomerId;")

SQLAlchemy can act as an Object-relational Map (ORM). This enables you to treat records of a database table as instantiable records. To leverage this functionality, you must reflect the underlying metadata in one of the following ways.

Note: The following examples employ SQLAlchemy 1.4.

Modeling Data Using a Mapping Class

Use "sqlalchemy.ext.declarative.declarative_base" to declare a mapping class for the table you wish to model in the ORM. A known table in the data model is modeled either partially or completely, as shown in the following example:

from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
class CampaignPerformance(Base):
	__tablename__ = "CampaignPerformance"
	Id = Column(String, primary_key=True)
	Clicks = Column(String)
	Device = Column(String)

Automatically Reflecting Metadata

Rather than mapping tables manually, SQLAlchemy can discover the metadata for one or more tables automatically. To accomplish this across the entire data model, use automap_base:

from sqlalchemy import MetaData
from sqlalchemy.ext.automap import automap_base
meta = MetaData()
abase = automap_base(metadata=meta)
abase.prepare(autoload_with=engine)
CampaignPerformance = abase.classes.CampaignPerformance

You can also reflect a single table with an inspector. When reflecting this way, providing a list of specific columns to map is optional:

from sqlalchemy import MetaData, Table
from sqlalchemy import inspect
meta = MetaData()
insp = inspect(engine)
CampaignPerformance_table = Table("CampaignPerformance", meta)
insp.reflect_table(CampaignPerformance_table, ["Id","Device"])

After you use the steps in Connecting to connect, and use one of the methods in Reflecting Metadata to reflect some of the metadata, you can use a session object to query data.

Querying Data Using the Query Method

If the mapping class has been prepared, use it with a session object to query the data source. After binding the engine to the session, provide the mapping class to the session's query method.

For example:

engine = create_engine("googleads:///?InitiateOAuth=GETANDREFRESH;DeveloperToken=myDeveloperToken;ClientCustomerId=myClientCustomerId;")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(CampaignPerformance).filter_by(Device="Mobile devices with full browsers"):
	print("Id: ", instance.Id)
	print("Clicks: ", instance.Clicks)
	print("Device: ", instance.Device)
	print("---------")

Querying Data Using the Execute Method

The session object can also run the query with the execute() method alongside the appropriate Table object. Assuming you have an active session, the following is just as viable:

CampaignPerformance_table = CampaignPerformance.metadata.tables["CampaignPerformance"]
for instance in session.execute(CampaignPerformance_table.select().where(CampaignPerformance_table.c.Device == "Mobile devices with full browsers")):
	print("Id: ", instance.Id)
	print("FullName: ", instance.Name)
	print("City: ", instance.BillingCity)
	print("---------")

Implicit Joining

If mapped classes of related Google Ads objects have a singular foreign key relationship, the classes are implicitly joined. After importing the necessary objects, a relationship is established between your two mapped classes, as in the example below:

from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import Column, String, Integer, DateTime, ForeignKey
from sqlalchemy.orm import sessionmaker, relationship

Base = declarative_base()
class Contact(Base):
	__tablename__ = "Contact"
	Id = Column(Integer, primary_key=True)
	Name = Column(String)
	Email = Column(String)
	BirthDate = Column(DateTime)
	AccountId = Column(String, ForeignKey("Account.Id"))
	Account_Link = relationship("Account", back_populates="Contact_Link")

class Account(Base):
	__tablename__ = "Account"
	Id = Column(String, primary_key=True)
	Name = Column(String)
	BillingCity = Column(String)
	NumberOfEmployees = Column(Integer)
	Contact_Link = relationship("Contact", order_by=Contact.Id, back_populates="Account_Link")

Once the relationship is established, the tables are queried simultaneously using the session's query() method. For example:

rs = session.query(Account, Contact).filter(Account.Id == Contact.AccountId)
for Ac, Ct in rs:
  print("AccountId: ", Ac.Id)
  print("AccountName: ", Ac.Name)
  print("ContactId: ", Ct.Id)
  print("ContactName: ", Ct.Name)

Other Join Forms

In situations where mapped classes have either no foreign keys or multiple foreign keys, you may need different forms of the JOIN query to accommodate them. Using the earlier classes as examples, the following JOIN queries are possible as well:

• Explicit condition (necessary if there are no foreign keys in your mapped classes):
  

  rs = session.query(Account, Contact).join(Contact, Account.Id == Contact.AccountId)
  for Ac, Ct in rs:

• Left-to-right relationship:
  

  rs = session.query(Account, Contact).join(Account.Contact_Link)
  for Ac, Ct in rs:

• Left-to-right relationship with explicit target:
  

  rs = session.query(Account, Contact).join(Contact, Account.Contact_Link)
  for Ac, Ct in rs:

• String form of a left-to-right relationship:
  

  rs = session.query(Account, Contact).join("Contact_Link")
  for Ac, Ct in rs:

SQLAlchemy ORM also exposes support for other clauses in SQL, such as ORDER BY, GROUP BY, LIMIT, and OFFSET. All of these are supported by this connector:

ORDER BY

The following example sorts by a specified column using the session object's query() method:

rs = session.query(CampaignPerformance).order_by(CampaignPerformance.AnnualRevenue)
for instance in rs:
	print("Id: ", instance.Id)
	print("Clicks: ", instance.Clicks)
	print("Device: ", instance.Device)
	print("---------")

You can also use the session object's execute() method perform an ORDER BY. For example:

rs = session.execute(CampaignPerformance_table.select().order_by(CampaignPerformance_table.c.AnnualRevenue))
for instance in rs:

GROUP BY

The following example uses the session object's query() method to group records with a specified column:

rs = session.query(func.count(CampaignPerformance.Id).label("CustomCount"), CampaignPerformance.Clicks).group_by(CampaignPerformance.Clicks)
for instance in rs:
	print("Count: ", instance.CustomCount)
	print("Clicks: ", instance.Clicks)
	print("---------")

You can also use the session object's execute() method to perform a GROUP BY:

rs = session.execute(CampaignPerformance_table.select().with_only_columns([func.count(CampaignPerformance_table.c.Id).label("CustomCount"), CampaignPerformance_table.c.Clicks]).group_by(CampaignPerformance_table.c.Clicks))
for instance in rs:

LIMIT and OFFSET

The following example uses the session object's query() method to skip the first 100 records and fetch the following 25:

rs = session.query(CampaignPerformance).limit(25).offset(100)
for instance in rs:
	print("Id: ", instance.Id)
	print("Clicks: ", instance.Clicks)
	print("Device: ", instance.Device)
	print("---------")

You can also use the session object's execute() method to set a LIMIT or OFFSET:

rs = session.execute(CampaignPerformance_table.select().limit(25).offset(100))
for instance in rs:

Certain aggregate functions can also be used within SQLAlchemy by using the func module.

To import this module, execute:

from sqlalchemy.sql import func

Once func is imported, the following aggregate functions are available:

COUNT

The following example counts the number of records in a set of groups using the session object's query() method.

rs = session.query(func.count(CampaignPerformance.Id).label("CustomCount"), CampaignPerformance.Clicks).group_by(CampaignPerformance.Clicks)
for instance in rs:
	print("Count: ", instance.CustomCount)
	print("Clicks: ", instance.Clicks)
	print("---------")

You can also execute COUNT using the session object's execute() method:

rs = session.execute(CampaignPerformance_table.select().with_only_columns([func.count(CampaignPerformance_table.c.Id).label("CustomCount"), CampaignPerformance_table.c.Clicks])group_by(CampaignPerformance_table.c.Clicks))
for instance in rs:

SUM

This example calculates the cumulative amount of a numeric column in a set of groups.

rs = session.query(func.sum(CampaignPerformance.AnnualRevenue).label("CustomSum"), CampaignPerformance.Clicks).group_by(CampaignPerformance.Clicks)
for instance in rs:
	print("Sum: ", instance.CustomSum)
	print("Clicks: ", instance.Clicks)
	print("---------")

You can also invoke SUM using the session object's execute() method.

rs = session.execute(CampaignPerformance_table.select().with_only_columns([func.sum(CampaignPerformance_table.c.AnnualRevenue).label("CustomSum"), CampaignPerformance_table.c.Clicks]).group_by(CampaignPerformance_table.c.Clicks))
for instance in rs:

AVG

This example uses the session object's query() method to calculate the average amount of a numeric column in a set of groups:

rs = session.query(func.avg(CampaignPerformance.AnnualRevenue).label("CustomAvg"), CampaignPerformance.Clicks).group_by(CampaignPerformance.Clicks)
for instance in rs:
	print("Avg: ", instance.CustomAvg)
	print("Clicks: ", instance.Clicks)
	print("---------")

You can also use the session object's execute() method to invoke AVG:

rs = session.execute(CampaignPerformance_table.select().with_only_columns([func.avg(CampaignPerformance_table.c.AnnualRevenue).label("CustomAvg"), CampaignPerformance_table.c.Clicks]).group_by(CampaignPerformance_table.c.Clicks))
for instance in rs:

MAX and MIN

This example finds the maximum value and minimum value of a numeric column in a set of groups.

rs = session.query(func.max(CampaignPerformance.AnnualRevenue).label("CustomMax"), func.min(CampaignPerformance.AnnualRevenue).label("CustomMin"), CampaignPerformance.Clicks).group_by(CampaignPerformance.Clicks)
for instance in rs:
	print("Max: ", instance.CustomMax)
	print("Min: ", instance.CustomMin)
	print("Clicks: ", instance.Clicks)
	print("---------")

You can also use the session object's execute() method to invoke MAX and MIN:

rs = session.execute(CampaignPerformance_table.select().with_only_columns([func.max(CampaignPerformance_table.c.AnnualRevenue).label("CustomMax"), func.min(CampaignPerformance_table.c.AnnualRevenue).label("CustomMin"), CampaignPerformance_table.c.Clicks]).group_by(CampaignPerformance_table.c.Clicks))
for instance in rs:

When combined with the connector, Pandas can be used to generate data frames that contain your Google Ads data. Once created, a data frame can be passed to various other Python packages.

Connecting

Pandas relies on an SQLAlchemy engine to execute queries. Before you can use Pandas you must import it:

import pandas as pd
from sqlalchemy import create_engine
engine = create_engine("googleads:///?InitiateOAuth=GETANDREFRESH;DeveloperToken=myDeveloperToken;ClientCustomerId=myClientCustomerId;")

Querying Data

In Pandas, SELECT queries are provided in a call to the read_sql() method, alongside a relevant connection object. Pandas executes the query on that connection, and returns the results in the form of a data frame, which can be used for a variety of purposes.

df = pd.read_sql("""
	SELECT
	   Clicks,
	   Device,
     $exNumericCol;
	FROM CampaignPerformance;""", engine)
print(df)

Matplotlib contains a number of tools that can graphically model Google Ads data after being fed a data frame From Pandas.

Using PyPlot

Before any Matplotlib tool, such as pyplot, can be used, it must be imported:

from matplotlib import pyplot as plt

Once a Pandas data frame is obtained, it can be used to create a plot visualizing Google Ads data. For example, the following plot generates and displays a bar graph relating Clicks and AnnualRevenue values:

df.plot(kind="bar", x="Clicks", y=["AnnualRevenue"])
plt.show()

The connector can be used to create ETL applications and pipelines for CSV data in Python using Petl.

Install Required Modules

Install the Petl modules using the pip utility.

pip install petl

Connecting

After you import the modules, including the CData Python Connector for Google Ads, you can use the connector's connect function to create a connection using a valid Google Ads connection string. If you prefer not to use a direct connection, you can use a SQLAlchemy engine.

import petl as etl
import cdata.googleads as mod
cnxn = mod.connect("InitiateOAuth=GETANDREFRESH;DeveloperToken=myDeveloperToken;ClientCustomerId=myClientCustomerId;")

Extract, Transform, and Load the Google Ads Data

Create a SQL query string and store the query results in a DataFrame.

sql = "SELECT	Clicks, Device FROM CampaignPerformance "
table1 = etl.fromdb(cnxn,sql)

Loading Data

With the query results stored in a DataFrame, you can load your data into any supported Petl destination. The following example loads the data into a CSV file.

etl.tocsv(table1,'output.csv')

The extension supports schema discovery by using SQL queries to available System Tables.

Using SQL

The following sections describe the discovery of metadata through several System Tables:

• Tables and Views
• Columns
• Procedures

The connector possesses system tables that are used to discover the tables and views available in the data model. Of these system tables, "sys_tables" and "sys_views" are used to fetch information about the available tables and views respectively:

Tables

import cdata.googleads as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;DeveloperToken=myDeveloperToken;ClientCustomerId=myClientCustomerId;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_tables"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Views

import cdata.googleads as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;DeveloperToken=myDeveloperToken;ClientCustomerId=myClientCustomerId;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_views"
cur.execute(cmd, params)
rs = cur.fetchall()
for row in rs:
	print(row)

The available columns for any given table are fetched from a system table called "sys_tablecolumns". A specific table name is provided in the WHERE criteria to restrict the table from which the column information is fetched:

import cdata.googleads as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;DeveloperToken=myDeveloperToken;ClientCustomerId=myClientCustomerId;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_tablecolumns WHERE TableName = 'CampaignPerformance'"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Procedures

A system table called "sys_procedures" is queried to obtain the available stored procedures that are executed:

import cdata.googleads as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;DeveloperToken=myDeveloperToken;ClientCustomerId=myClientCustomerId;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_procedures"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

Parameters

The input parameters of any stored procedure are similarly obtained from the "sys_procedureparameters" system table:

import cdata.googleads as mod
conn = mod.connect("InitiateOAuth=GETANDREFRESH;DeveloperToken=myDeveloperToken;ClientCustomerId=myClientCustomerId;")
cur = conn.cursor()
cmd = "SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken'"
cur.execute(cmd)
rs = cur.fetchall()
for row in rs:
	print(row)

This section details a selection of advanced features of the Google Ads connector.

User Defined Views

The connector supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the connector for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Caching Data

Caching Data enables faster access to data and reduces the number of API calls, improving performance. The connector supports a simple caching model where multiple connections can also share the cache over time. When configuring the cache connection, you can specify automatic or explicit data caching.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to Google Ads and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Exception Handling

For an overview of how exceptions are reported and the components of an exception, see Exception Handling.

The CData Python Connector for Google Ads supports the use of user defined views: user-defined virtual tables whose contents are decided by a preconfigured query. User defined views are useful in situations where you cannot directly control the query being issued to the driver; for example, when using the driver from a tool.

Use a user defined view to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Defining Views Using a Configuration File

User defined views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This user defined view configuration file is formatted so that each root element defines the name of a view, and includes a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM CampaignPerformance WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"

Defining Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

In order to avoid a view's name clashing with an actual entity in the data model, user defined views are exposed in the UserViews schema by default. To change the name of the schema used for UserViews, reset the UserViewsSchemaName property.

Working with User Defined Views

For example, a SQL statement with a user defined view called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a user defined view that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

Customizing the SSL Configuration

By default, the connector attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

Note: The connector uses the system proxy settings by default, without further configuration needed. If you want to connect to other proxies, set ProxyAutoDetect to False and read further.

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the connector uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Caching Data

Caching data provides several benefits, including faster access to data and reducing the number of API calls, which improve performance. The connector supports a simple caching model where multiple connections can also share the cache over time. You can enable and configure caching features by setting the necessary connection properties.

Contents

The sections in this chapter detail the connector's caching functionality and link to the corresponding connection properties, as well as SQL statements.

Configuring the Cache Connection

Configuring the Cache Connection describes the properties that you can set when configuring the cache database.

Caching Metadata

Caching Metadata describes the CacheMetadata property. This property determines whether or not to cache the table metadata to a file store.

Automatically Caching Data

Automatically Caching Data describes how the connector automatically refreshes the cache when the AutoCache property is set.

Explicitly Caching Data

Explicitly Caching Data describes how you can decide what data is stored in the cache and when it is updated.

Data Type Mapping

Data Type Mapping shows the mappings between the data types configured in the schema and the data types in the database.

Configuring the Caching Database

This section describes the properties for caching data to the persistent store of your choice.

CacheLocation

The CacheLocation property species the path to a file-system-based database. When caching is enabled, a file-system-based database is used by default. If CacheLocation is not specified, this database is stored at the path in Location. If neither of these connection properties are specified, the connector uses a platform-dependent default location.

CacheConnection

The CacheConnection property specifies a database driver and the connection string to the caching database.

CacheDriver and CacheProvider

Both the CacheDriver and CacheProvider properties are supported. Each specifies a database driver and the connection string to the caching database. CacheDriver is designed for Linux and MacOS; CacheProvider is Windows-based.

This section describes how to enable caching metadata and how to update the metadata cache.

Before being able to query data, the connector requires relevant metadata to be retrieved. By default, metadata is cached in memory and shared across connections. But if you want to persist across processes, or if metadata requests are expensive, the solution is to cache the metadata to disk.

Enable Caching Metadata

To enable caching of metadata, set CacheMetadata = true and see Configuring the Cache Connection for instructions on how to configure your connection string. The connector caches the metadata the first time it is needed and uses the metadata cache for subsequent requests.

Update the Metadata Cache

Because metadata is cached, changes to metadata on the live source, for example, adding or removing a column or attribute, are not automatically reflected in the metadata cache. To get updates to the live metadata, you need to delete or drop the cached data.

Automatically caching data is useful when you do not want to rebuild the cache for each query. When you query data for the first time, the connector automatically initializes and builds a cache in the background. When AutoCache = true, the connector uses the cache for subsequent query executions, resulting in faster response times.

Configuring Automatic Caching

Caching the CampaignPerformance Table

The following example caches the CampaignPerformance table in the file specified by the CacheLocation property of the connection string.

SELECT Clicks, Device FROM CampaignPerformance WHERE Device = 'Mobile devices with full browsers'

Common Use Case

A common use for automatically caching data is to improve driver performance when making repeated requests to a live data source, such as building a report or creating a visualization. With auto caching enabled, repeated requests to the same data may be executed in a short period of time, but within an allowable tolerance (CacheTolerance) of what is considered "live" data.

With explicit caching (AutoCache = false), you decide exactly what data is cached and when to query the cache instead of the live data. Explicit caching gives you full control over the cache contents by using CACHE Statements. This section describes some strategies to use the caching features offered by the connector.

Creating the Cache

To load data in the cache, issue the following statement.

CACHE SELECT * FROM tableName WHERE ...

Once the statement is issued, any matching data in tableName is loaded into the corresponding table.

Updating the Cache

This section describes two ways to update the cache.

Updating with the SELECT Statement

The following example shows a statement that can update modified rows and add missing rows in the cached table. However, this statement does not delete extra rows that are already in the cache. This statement only merges the new rows or updates the existing rows.

CACHE SELECT * FROM CampaignPerformance WHERE Device = 'Mobile devices with full browsers'

Updating with the TRUNCATE Statement

The following example shows a statement that can update modified rows and add missing rows in the cached table. This statement can also delete rows in the cache table that are not present in the live data source.

  CACHE WITH TRUNCATE SELECT * FROM CampaignPerformance WHERE Device = 'Mobile devices with full browsers'
  

Query the Data in Online or Offline Mode

This section describes how to query the data in online or offline mode.

Online: Select Cached Tables

You can use the tableName#CACHE syntax to explicitly execute queries to the cache while still online, as shown in the following example.

SELECT * FROM CampaignPerformance#CACHE

Offline: Select Cached Tables

With Offline = true, SELECT statements always execute against the local cache database, regardless of whether you explicitly specify the cached table or not. Modification of the cache is disabled in Offline mode to prevent accidentally updating only the cached data. Executing a DELETE/UPDATE/INSERT statement while in Offline mode results in an exception.

The following example selects from the local cache but not the live data source because Offline = true.

SELECT * FROM CampaignPerformance WHERE Device='Mobile devices with full browsers' ORDER BY Device ASC

Delete Data from the Cache

You can delete data from the cache by building a direct connection to the database. Note that the connector does not support manually deleting data from the cache.

Common Use Case

A common use for caching is to have an application always query the cached data and only update the cache at set intervals, such as once every day or every two hours. There are two ways in which this can be implemented:

• AutoCache = false and Offline = false. All queries issued by the application explicitly reference the tableName#CACHE table. When the cache needs to be updated, the application executes a tableName#CACHE ... statement to bring the cached data up to date.
• Offline = true. Caching is transparent to the application. All queries are executed against the table as normal, so most application code does not need to be aware that caching is done. To update the cached data, simply create a separate connection with Offline = false and execute a tableName#CACHE ... statement.

The connector maps types from the data source to the corresponding data type available in the chosen cache database. The following table shows the mappings between the data types configured in the schema and the data types in the database. Some schema types have synonyms which are all listed in the Schema column.

Data Type Mapping

Note: String columns can map to different data types depending on their length.

Schema	.NET	JDBC	SQL Server	Derby	MySQL	Oracle	SQLite	Access
int, integer, int32	Int32	int	int	INTEGER	INT	NUMBER	integer	LONG
smallint, short, int16	Int16	short	smallint	SMALLINT	SMALLINT	NUMBER	integer	SHORT
double, float, real	Double	double	float	DOUBLE	DOUBLE	NUMBER	double	DOUBLE
date	DateTime	java.sql.Date	date	DATE	DATE	DATE	date	DATETIME
datetime, timestamp	DateTime	java.sql.Date	datetime	TIMESTAMP	DATETIME	TIMESTAMP	datetime	DATETIME
time, timespan	TimeSpan	java.sql.Time	time	TIME	TIME	TIMESTAMP	datetime	DATETIME
string, varchar	String	java.lang.String	If length > 4000: nvarchar(max), Otherwise: nvarchar(length)	If length > 32672: LONG VARCHAR, Otherwise VARCHAR(length)	If length > 255: LONGTEXT, Otherwise: VARCHAR(length)	If length > 4000: CLOB, Otherwise: VARCHAR2(length)	nvarchar(length)	If length > 255: LONGTEXT, Otherwise: VARCHAR(length)
long, int64, bigint	Int64	long	bigint	BIGINT	BIGINT	NUMBER	bigint	LONG
boolean, bool	Boolean	boolean	tinyint	SMALLINT	BIT	NUMBER	tinyint	BIT
decimal, numeric	Decimal	java.math.BigDecimal	decimal	DECIMAL	DECIMAL	DECIMAL	decimal	CURRENCY
uuid	Guid	java.util.UUID	nvarchar(length)	VARCHAR(length)	VARCHAR(length)	VARCHAR2(length)	nvarchar(length)	VARCHAR(length)
binary, varbinary, longvarbinary	byte[]	byte[]	binary(1000) or varbinary(max) after SQL Server 2000, image otherwise	BLOB	LONGBLOB	BLOB	BLOB	LONGBINARY

Query Processing

CData has a client-side SQL engine built into the connector library. This enables support for the full capabilities that SQL-92 offers, including filters, aggregations, functions, etc.

For sources that do not support SQL-92, the connector offloads as much of SQL statement processing as possible to Google Ads and then processes the rest of the query in memory (client-side). This results in optimal performance.

For data sources with limited query capabilities, the connector handles transformations of the SQL query to make it simpler for the connector. The goal is to make smart decisions based on the query capabilities of the data source to push down as much of the computation as possible. The Google Ads Query Evaluation component examines SQL queries and returns information indicating what parts of the query the connector is not capable of executing natively.

The Google Ads Query Slicer component is used in more specific cases to separate a single query into multiple independent queries. The client-side Query Engine makes decisions about simplifying queries, breaking queries into multiple queries, and pushing down or computing aggregations on the client-side while minimizing the size of the result set.

There's a significant trade-off in evaluating queries, even partially, client-side. There are always queries that are impossible to execute efficiently in this model, and some can be particularly expensive to compute in this manner. CData always pushes down as much of the query as is feasible for the data source to generate the most efficient query possible and provide the most flexible query capabilities.

More Information

For a full discussion of how CData handles query processing, see CData Architecture: Query Execution.

Logging

Capturing connector logging can be very helpful when diagnosing error messages or other unexpected behavior.

Basic Logging

To begin capturing connector logging, set these properties:

• Logfile: A filepath that designates the name and location of the log file.
• Verbosity: A numerical value (1-5) that determines the amount of detail in the log. See the page in the Connection Properties section for an explanation of the five levels.
• MaxLogFileSize: When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.
• MaxLogFileCount: A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. Minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.

Once these properties are set, the connector populates the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it is created.

Log Verbosity

The verbosity level determines the amount of detail that the connector reports to the Logfile. Supported Verbosity levels range from 1 to 5.

The following list describes each level:

1	Setting Verbosity to 1 logs the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2	Setting Verbosity to 2 logs everything included in Verbosity 1, cache queries, and additional information about the request.
3	Setting Verbosity to 3 also logs HTTP headers, as well as the body of the request and the response.
4	Setting Verbosity to 4 also logs transport-level communication with the data source. This includes SSL negotiation.
5	Setting Verbosity to 5 also logs communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands.

For normal operations, Verbosity should not be set to greater than 1. At higher verbosities you can log substantial amounts of data, which can delay execution times.

To refine the logged content further by showing/hiding specific categories of information, see LogModules.

Sensitive Data

Verbosity levels of 3 and higher may capture information that you do not want shared outside of your organization. The following lists information of concern for each level:

• Verbosity 3: The full body of the request and the response, which includes all the data returned by the connector
• Verbosity 4: SSL certificates
• Verbosity 5: Any extra transfer data not included at Verbosity 3, such as non human-readable binary transfer data

Note: Although we mask sensitive values, such as passwords, in the connection string and any request in the log, it is always best practice to review the logs for any sensitive information before sharing outside your organization.

Advanced Logging

You may want to refine the exact information that is recorded to the log file. This can be accomplished using the LogModules property. This property allows you to filter the logging using a semicolon-separated list of logging modules.

Example property value:

LogModules=INFO;EXEC;SSL;SQL;META;

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:

Module Name	Module Description	Submodules
INFO	General Information. Includes the connection string, product version (build number), and initial connection messages.	Connec – Information related to creating or destroying connections. Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the connector, rather than being received and passed along directly from the service.
EXEC	Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.	Messag – Messages pertaining to query execution. These messages are typically specific to the connector, rather than being received and passed along directly from the service. Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance. Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user). Page – Messages related to query paging. Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP	HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.	KERB – HTTP requests related to Kerberos. Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the connector, rather than being received and passed along directly from the service. Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product. Res – Messages containing HTTP responses. Req – Messages containing HTTP requests.
WSDL	Messages pertaining to the generation of WSDL/XSD files.	—
SSL	SSL certificate messages.	Certif – Messages pertaining to SSL certificates.
AUTH	Authentication related failure/success messages.	Messag – Messages pertaining to authentication. These messages are typically specific to the connector, rather than being received and passed along directly from the service. OAuth – Messages related to OAuth authentication. Krbros – Kerberos-related authentication messages.
SQL	Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.	Bulk – Messages pertaining to bulk query execution. Cache – Messages related to reading row data from and writing row data to the product's cache for better performance. Messag – Messages pertaining to SQL transactions. These messages are typically specific to the connector, rather than being received and passed along directly from the service. ResSet – Query resultsets. Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META	Metadata cache and schema messages.	Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance. Schema – Messages related to retrieving metadata from or modifying the service schema. MemSto – Messages related to writing to or reading from in-memory metadata cache. Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC	Information related to executing SQL functions.	Errmsg – Error messages related to executing SQL functions.
TCP	Incoming and outgoing raw bytes on TCP transport layer messages.	Send – Raw data sent via the TCP protocol. Receiv – Raw data received via the TCP protocol.
FTP	Messages pertaining to the File Transfer Protocol.	Info – Status messages related to communication in the FTP protocol. Client – Messages related to actions taken by the FTP client (the product) during FTP communication. Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP	Messages pertaining to the Secure File Transfer Protocol.	Info – Status messages related to communication in the SFTP protocol. To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication. From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP	Messages pertaining to data transferred via the Post Office Protocol.	Client – Messages related to actions taken by the POP client (the product) during POP communication. Server – Messages related to actions taken by the POP server during POP communication. Status – Status messages related to communication in the POP protocol.
SMTP	Messages pertaining to data transferred via the Simple Mail Transfer Protocol.	Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication. Server – Messages related to actions taken by the SMTP server during SMTP communication. Status – Status messages related to communication in the SMTP protocol.
CORE	Messages relating to various internal product operations not covered by other modules.	—
DEMN	Messages related to SQL remoting.	—
CLJB	Messages about bulk data uploads (cloud job).	Commit – Submissions for bulk data uploads.
SRCE	Miscellaneous messages produced by the product that don't belong in any other module.	—
TRANCE	Advanced messages concerning low-level product operations.	—

Exception Handling

Exceptions can be surfaced from either the API or the CData Python Connector for Google Ads. Each exception will have an error code, an error message, and a SQL state.

Error Codes

The error code classifies the type of error.

0	NONE	Used for unclassified errors and internally handled errors. This code also covers data source-specific errors that do not fit in any specific category.
65537	TCP_UNKNOWN_HOST	Unable to resolve a hostname (DNS failure).
65538	TCP_CONNECTION_REFUSED	Could not connect to the remote port.
65539	TCP_AUTH_FAILED	Login failed when using a binary authentication protocol. Use this for auth errors when the protocol is not HTTP (LDAP, SASL, Kerberos, ...).
65540	TCP_TIMEOUT	Did not receive a response after sending a request to the server.
65541	TCP_PROTOCOL	For wire protocol drivers. Either the server sent a bad packet that we are unable to process, or we cannot construct a packet to send.
131073	TLS_SERVER_UNTRUSTED	Could not verify SSL server certificate.
131074	TLS_CLIENT_UNTRUSTED	Server did not accept the client certificate we sent.
196609	OAUTH_DECRYPT_FAILED	OAuthEncryptKey did not decrypt the OAuthSettings file.
196610	OAUTH_MISSING_CLIENT_INFO	OAuthClientId / OAuthClientSecret / OAuthJWTCert is missing.
196611	OAUTH_MISSING_PROP	General OAuth property missing. OAUTH_MISSING_CLIENT_INFO is used for missing client ID/secret and JWT cert.
196612	OAUTH_NO_ACCESS_TOKEN	Unable to retrieve access token. Only use this when getting a token in GetOAuthAccessToken / RefreshOAuthAccessToken.
196613	OAUTH_TOKEN_EXPIRED	The access token expired. Normally used with a RefreshOAuth/OAuthException behavior.
196614	OAUTH_INVALID_PROP	OAuth property has an invalid value. OAUTH_MISSING_CLIENT_INFO / OAUTH_MISSING_PROP is used if the value is not set.
262145	HTTP_REQUEST_TIMEOUT	Did not receive a response from the HTTP server.
262146	HTTP_CLIENT_ERROR	Generic HTTP 4xx error. Only use for 4xx errors not covered by other codes.
262147	HTTP_AUTH_FAILED	HTTP 401 error.
262148	HTTP_LIMIT_EXCEEDED	HTTP 429 error.
262149	HTTP_SERVER_ERROR	HTTP 5xx error.
262150	HTTP_NOT_FOUND_ERROR	HTTP 404 error.
327681	CORE_TIMEOUT	General timeout. Not related to a specific network request.
327682	CORE_OP_NOT_ALLOWED	Operation blocked by provider permissions.
327683	CORE_CONNECTION_CONFIG	Connection configuration is not valid.
327684	CORE_SERIALIZE	Failed to encode data into a specific format (XML, JSON, CSV, ...).
327685	CORE_DESERIALIZE	Failed to decode data from a specific format (XML, JSON, CSV, ...).
393217	SQL_SYNTAX_ERROR	Unable to parse a SQL query.
393218	SQL_MISSING_COLUMNS	Query did not include required columns.
393219	SQL_MISSING_PARAMS	Stored procedure call did not include required parameters.
393220	SQL_QUERY_NOT_SUPPORTED	A part of the query is not allowed in the current context.
458753	SSH_SERVER_UNTRUSTED	Could not verify SSH server.
524289	STORAGE_LIST_EXCEPTION	Issue listing storage resources.
524290	STORAGE_RESOURCE_NOT_FOUND	Issue finding storage resources.
524291	STORAGE_ROOT_RESOURCE_NOT_FOUND	The root resource (bucket/share/drive) was not found; cannot create it in flat file drivers.
524292	STORAGE_RESOURCE_NOT_A_DIRECTORY	Storage resource is not a directory.
524293	STORAGE_RESOURCE_NOT_A_FILE	Storage resource is not a file.
524294	STORAGE_PERMISSIONS_DENIED	Storage permissions denied.

SQL State

The SQL state is used when throwing generic provider errors to the wrapper and indicates the success or failure of a call.

Some of the common SQL states are listed below:

07007	REQUIRED_CLAUSE	Class Code 07: Dynamic SQL Error.
08001	OPEN_CONNECTION	Class Code 08: Connection Exception. The connection was unable to be established to the application server or other server.
08004	REJECT_CONNECTION	The application server rejected establishment of the connection.
42501	PRIVILEGE_IDENTIFIED_OBJECT	Class Code 42: Syntax Error or Access Rule Violation. The authorization ID does not have the privilege to perform the specified operation on the identified object.
42506	AUTH_FAILED	Owner authorization failure occurred.
42601	SQL_SYNTAX	A character, token, or clause is invalid or missing.

Error Message

The error message provides more detailed reasoning about why the error occurred. It provides an explanation of the issue, and may include steps on how to resolve it.

SELECT Statements

See SELECT Statements for a syntax reference and examples.

See Data Model for information on the capabilities of the Google Ads API.

CACHE Statements

CACHE statements allow granular control over the connector's caching functionality. For a syntax reference and examples, see CACHE Statements.

For more information on the caching feature, see Caching Data.

EXECUTE Statements

Use EXECUTE or EXEC statements to execute stored procedures. See EXECUTE Statements for a syntax reference and examples.

Names and Quoting

• Table and column names are considered identifier names; as such, they are restricted to the following characters: [A-Z, a-z, 0-9, _:@].
• To use a table or column name with characters not listed above, the name must be quoted using square brackets ([name]) in any SQL statement.
• Parameter names can optionally start with the @ symbol (e.g., @p1 or @CustomerName) and cannot be quoted.
• Strings must be quoted using single quotes (e.g., 'John Doe').

The connector provides functions that are similar to those that are available with most standard databases. These functions are implemented in the CData provider engine and thus are available across all data sources with the same consistent API. Three categories of functions are available: string, date, and math.

The connector interprets all SQL function inputs as either strings or column identifiers, so you need to escape all literals as strings, with single quotes. For example, contrast the SQL Server syntax and connector syntax for the DATENAME function:

• SQL Server:
  

  SELECT DATENAME(yy,GETDATE())

• connector:
  

  SELECT DATENAME('yy',GETDATE())

String Functions

These functions perform string manipulations and return a string value. See STRING Functions for more details.

Date Functions

These functions perform date and date time manipulations. See DATE Functions for more details.

Math Functions

These functions provide mathematical operations. See MATH Functions for more details.

ASCII(character_expression)

Returns the ASCII code value of the left-most character of the character expression.

• character_expression: The character expression.

                      SELECT ASCII('0');
                      --  Result: 48
                    

BASE64_ENCODE(input_binary)

Returns the Base64-encoded string form of a binary input.

• input_binary: The binary value to encode.

                        SELECT BASE64_ENCODE(BinaryData);
                    -- Result: 'QmFzZTY0RW5jb2RlZA=='
                    

BASE64_DECODE(input_string)

Returns the binary result of decoding a Base64-encoded string.

• input_string: The Base64-encoded string.

                        SELECT BASE64_DECODE('QmFzZTY0RW5jb2RlZA==');
                    -- Result: (binary output)
                    

CHAR(integer_expression)

Converts the integer ASCII code to the corresponding character.

• integer_expression: The integer from 0 through 255.

                      SELECT CHAR(48);
                      -- Result: '0'
                    

CHARINDEX(expressionToFind ,expressionToSearch [,start_location ])

Returns the starting position of the specified expression in the character string.

• expressionToFind: The character expression to find.
• expressionToSearch: The character expression, typically a column, to search.
• start_location: An optional character position to start searching for expressionToFind in expressionToSearch.

                      SELECT CHARINDEX('456', '0123456');
                      -- Result: 4

                      SELECT CHARINDEX('456', '0123456', 5);
                      -- Result: -1
                    

CHAR_LENGTH(character_expression),

Returns the number of UTF-8 characters present in the expression.

• character_expression: The set of characters to be evaluated for length.

				 SELECT CHAR_LENGTH('sample text') FROM Account LIMIT 1
				 -- Result: 11			
				

CONCAT(string_value1, string_value2, ..., string_valueN)

Returns the string that is the concatenation of two or more string values.

• string_value1: The first string to be concatenated.
• string_value2: The second string to be concatenated.
• string_valueN: (optional) Any additional strings to be concatenated.

                      SELECT CONCAT('Hello, ', 'world!');
                      -- Result: 'Hello, world!'
                    

CONTAINS(expressionToSearch, expressionToFind)

Returns 1 if expressionToFind is found within expressionToSearch; otherwise, 0.

• expressionToSearch: The character expression, typically a column, to search.
• expressionToFind: The character expression to find.

                      SELECT CONTAINS('0123456', '456');
                      -- Result: 1

                      SELECT CONTAINS('0123456', 'Not a number');
                      -- Result: 0
                    

ENDSWITH(character_expression, character_suffix)

Returns 1 if character_expression ends with character_suffix; otherwise, 0.

• character_expression: The character expression.
• character_suffix: The character suffix to search for.

                      SELECT ENDSWITH('0123456', '456');
                      -- Result: 1

                      SELECT ENDSWITH('0123456', '012');
                      -- Result: 0
                    

FILESIZE(uri)

Returns the number of bytes present in the file at the specified file path.

• uri: The path of the file from which to read the size.

				SELECT FILESIZE('C:/Users/User1/Desktop/myfile.txt');
				-- Result: 23684
				

FORMAT(value [, parseFormat], format )

Returns the value formatted with the specified format.

• value: The string to format.
• format: The string specifying the output syntax of the date or numeric format.
• parseFormat: The string specifying the input syntax of the date value. Not applicable to numeric types.

                      SELECT FORMAT(12.34, '#');
                      -- Result: 12

                      SELECT FORMAT(12.34, '#.###');
                      -- Result: 12.34

                      SELECT FORMAT(1234, '0.000E0');
                      -- Result: 1.234E3
                      
                      SELECT FORMAT('2019/01/01', 'yyyy-MM-dd');
                      -- Result: 2019-01-01
                      
                      SELECT FORMAT('20190101', 'yyyyMMdd', 'yyyy-MM-dd');
                      -- Result: '2019-01-01'
                    

HASHBYTES(algorithm, value)

Returns the hash of the input value as a byte array using the given algorithm. The supported algorithms are MD5, SHA1, SHA2_256, SHA2_512, SHA3_224, SHA3_256, SHA3_384, and SHA3_512.

• algorithm: The algorithm to use for hashing. Must be one of MD5, SHA1, SHA2_256, SHA2_512, SHA3_224, SHA3_256, SHA3_384, or SHA3_512.
• value: The value to hash. Must be either a string or byte array.

                      SELECT HASHBYTES('MD5', 'Test');
                      -- Result (byte array): 0x0CBC6611F5540BD0809A388DC95A615B
                    

INDEXOF(expressionToSearch, expressionToFind [,start_location ])

Returns the starting position of the specified expression in the character string.

• expressionToSearch: The character expression, typically a column, to search.
• expressionToFind: The character expression to find.
• start_location: An optional character position to start searching for expressionToFind in expressionToSearch.

                      SELECT INDEXOF('0123456', '456');
                      -- Result: 4

                      SELECT INDEXOF('0123456', '456', 5);
                      -- Result: -1
                    

ISALPHABETIC(character_expression)

Returns 1 if the character expression consists only of alphabetic characters; otherwise, 0.

• character_expression: The string expression to evaluate.

                      SELECT ISALPHABETIC('Hello');
                      -- Result: 1

                      SELECT ISALPHABETIC('Hello123');
                      -- Result: 0

                      SELECT ISALPHABETIC('Hello!');
                      -- Result: 0
                    

ISALPHANUMERIC(character_expression)

Returns 1 if the character expression consists only of alphabetic and numeric characters; otherwise, 0.

• character_expression: The string expression to evaluate.

                      SELECT ISALPHANUMERIC('Hello123');
                      -- Result: 1

                      SELECT ISALPHANUMERIC('123');
                      -- Result: 1

                      SELECT ISALPHANUMERIC('Hello.123');
                      -- Result: 0
                    

ISNUMERIC(character_expression)

Returns 1 if the character expression consists only of numeric digits and up to one decimal point; otherwise, 0.

• character_expression: The string expression to evaluate.

                      SELECT ISNUMERIC('123');
                      -- Result: 1

                      SELECT ISNUMERIC('123.45');
                      -- Result: 1

                      SELECT ISNUMERIC('123.45.67');
                      -- Result: 0

                      SELECT ISNUMERIC('12a3');
                      -- Result: 0
                    

JSON_EXTRACT(json, jsonpath)

Selects any value in a JSON array or object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

• json: The JSON document to extract.
• jsonpath: The XPath used to select the nodes. The JSONPath must be a string constant. The values of the nodes selected will be returned in a token-separated list.

                      SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test');
                      -- Result: '{"data":1}'

                      SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test.data');
                      -- Result: 1

                      SELECT JSON_EXTRACT('{"test": {"data": [1, 2, 3]}}', '$.test.data[1]');
                      -- Result: 2
                    

LEFT ( character_expression , integer_expression )

Returns the specified number of characters counting from the left of the specified string.

• character_expression: The character expression.
• integer_expression: The positive integer that specifies how many characters will be returned counting from the left of character_expression.

                      SELECT LEFT('1234567890', 3);
                      -- Result: '123'
                    

LEN(string_expression)

Returns the number of characters of the specified string expression.

• string_expression: The string expression.

                      SELECT LEN('12345');
                      -- Result: 5
                    

LOCATE(substring,string)

Returns an integer representing how many characters into the string the substring appears.

• substring: The substring to find inside larger string.
• string: The larger string that is searched for the substring.
• start locations: An optional integer that sets the character position (offset) from which to start searching.

				SELECT LOCATE('sample','XXXXXsampleXXXXX');
				-- Result: 6

                SELECT LOCATE('sample', 'XXXXXsampleXXXXX', 7)
                -- Result: 0
				

LOWER ( character_expression )

Returns the character expression with the uppercase character data converted to lowercase.

• character_expression: The character expression.

                      SELECT LOWER('MIXED case');
                      -- Result: 'mixed case'
                    

LTRIM(character_expression)

Returns the character expression with leading blanks removed.

• character_expression: The character expression.

                      SELECT LTRIM('     trimmed');
                      -- Result: 'trimmed'
                    

MASK(string_expression, mask_character [, start_index [, end_index ]])

Replaces the characters between start_index and end_index with the mask_character within the string.

• string_expression: The string expression to be searched.
• mask_character: The character to mask with.
• start_index: The optional number of characters to leave unmasked at beginning of string. Defaults to 0.
• end_index: The optional number of characters to leave unmasked at end of string. Defaults to 0.

                        SELECT MASK('1234567890','*',);
                        -- Result: '**********'
                        SELECT MASK('1234567890','*', 4);
                        -- Result: '1234******'
                        SELECT MASK('1234567890','*', 4, 2);
                        -- Result: '1234****90'  
                    

NCHAR(integer_expression)

Returns the Unicode character with the specified integer code as defined by the Unicode standard.

• integer_expression: The integer from 0 through 65535 (0 through xFFFF).

OCTET_LENGTH(character_expression),

Returns the number of bytes present in the expression.

• character_expression: The set of characters to be be evaluated.

				 SELECT OCTET_LENGTH('text') FROM Account LIMIT 1
				 -- Result: 4
				

PATINDEX(pattern, expression)

Returns the starting position of the first occurrence of the pattern in the expression. Returns 0 if the pattern is not found.

• pattern: The character expression that contains the sequence to be found. The wild-card character % can be used only at the start or end of the expression.
• expression: The expression, typically a column, to search for the pattern.

                      SELECT PATINDEX('123%', '1234567890');
                      -- Result: 1

                      SELECT PATINDEX('%890', '1234567890');
                      -- Result: 8

                      SELECT PATINDEX('%456%', '1234567890');
                      -- Result: 4
                    

POSITION(expressionToFind IN expressionToSearch)

Returns the starting position of the specified expression in the character string.

• expressionToFind: The character expression to find.
• expressionToSearch: The character expression, typically a column, to search.

                      SELECT POSITION('456' IN '123456');
                      -- Result: 4

                      SELECT POSITION('x' IN '123456');
                      -- Result: 0
                    

QUOTENAME(character_string [, quote_character])

Returns a valid SQL Server-delimited identifier by adding the necessary delimiters to the specified Unicode string.

• character_string: The string of Unicode character data. The string is limited to 128 characters. Inputs greater than 128 characters return null.
• quote_character: An optional single character to be used as the delimiter. These include:
  • a single quotation mark (')
  • a left or right bracket ([])
  • a double quotation mark (")
  • a left or right parenthesis ( () )
  • a greater or less than sign (><)
  • a left or right brace ({})
  • a backtick (`)

  If quote_character is not specified brackets are used. If an unacceptable character is supplied, it returns NULL.

                      SELECT QUOTENAME('table_name');
                      -- Result: '[table_name]'

                      SELECT QUOTENAME('table_name', '"');
                      -- Result: '"table_name"'

                      SELECT QUOTENAME('table_name', '[');
                      -- Result: '[table_name]'
                    

REGEXP_REPLACE(expr, pattern [, replacement [, position [, occurrence [, match_type]]]])

Replaces occurrences of a regular expression pattern in the input string with a specified value and returns the resulting string.

• expr: The string expression to be searched.
• pattern: The regular expression pattern to match.
• replacement: (optional) The string to replace each matched occurrence of pattern with. Supports backreferences \1 through \9 and escape sequences \n, \r, \t, and \\. By default, this argument is an empty string, meaning matched portions are removed from the output string.
• position: (optional) The 1-based starting position used when searching for regular expression matches in expr. The default is 1. All characters prior to the starting position are included in the output string unaltered. Skipped characters are ignored when calculating regular expression matches, even if they match pattern.
• occurrence: (optional) Specifies whether all occurrences of pattern,, or only a specific occurrence of pattern are replaced. The default is 0, which means all occurrences of pattern are replaced with replacement. Set to 1 to only replace the first instance of the pattern; 2 to replace the second; etc.
• match_type: (optional) Modifiers used to customize matching behavior. Supported values are: 'c' (case-sensitive, default), 'i' (case-insensitive), 'm' (multiline), 'n' (dot matches newline), 'x' (extended mode). These can be freely combined by including the letters back to back. For example, 'im' applies the functionality of both 'i' and 'm'. The regular expression syntax used is that of the Extended mode ('x') ignores whitespace and allows inline comments. If the pattern needs to match a literal space, it must be explicitly escaped.

                      SELECT REGEXP_REPLACE('abc123def456', '\d+', 'NUM');
                      -- Result: 'abcNUMdefNUM'

                      SELECT REGEXP_REPLACE('Hello\nHELLO\nhello', '^hello', 'X', 1, 0, 'im');
                      -- Result: 'X\nX\nX'
                    

REPLACE(string_expression, string_pattern, string_replacement)

Replaces all occurrences of a string with another string.

• string_expression: The string expression to be searched. This can be a character or binary data type.
• string_pattern: The substring to be found. Cannot be an empty string.
• string_replacement: The replacement string.

                      SELECT REPLACE('1234567890', '456', '|');
                      -- Result: '123|7890'

                      SELECT REPLACE('123123123', '123', '.');
                      -- Result: '...'

                      SELECT REPLACE('1234567890', 'a', 'b');
                      -- Result: '1234567890'
                    

REPLICATE ( string_expression ,integer_expression )

Repeats the string value the specified number of times.

• string_expression: The string to replicate.
• integer_expression: The repeat count.

                      SELECT REPLACE('x', 5);
                      -- Result: 'xxxxx'
                    

REVERSE ( string_expression )

Returns the reverse order of the string expression.

• string_expression: The string.

                      SELECT REVERSE('1234567890');
                      -- Result: '0987654321'
                    

RIGHT ( character_expression , integer_expression )

Returns the right part of the string with the specified number of characters.

• character_expression: The character expression.
• integer_expression: The positive integer that specifies how many characters of the character expression will be returned.

                      SELECT RIGHT('1234567890', 3);
                      -- Result: '890'
                    

RTRIM(character_expression)

Returns the character expression after it removes trailing blanks.

• character_expression: The character expression.

                      SELECT RTRIM('trimmed     ');
                      -- Result: 'trimmed'
                    

SOUNDEX(character_expression)

Returns the four-character Soundex code, based on how the string sounds when spoken.

• character_expression: The alphanumeric expression of character data.

                      SELECT SOUNDEX('smith');
                      -- Result: 'S530'
                    

SPACE(repeatcount)

Returns the string that consists of repeated spaces.

• repeatcount: The number of spaces.

                      SELECT SPACE(5);
                      -- Result: '     '
                    

SPLIT(string, delimiter, offset)

Returns a section of the string between to delimiters.

• string: The string to split.
• delimiter: The character to split the string with.
• offset: The number of the split to return. Positive numbers are treated as offsets from the left, and negative numbers are treated as offsets from the right.

                      SELECT SPLIT('a/b/c/d', '/', 1);
                      -- Result: 'a'
                      SELECT SPLIT('a/b/c/d', '/', -2);
                      -- Result: 'c'
                    

STARTSWITH(character_expression, character_prefix)

Returns 1 if character_expression starts with character_prefix; otherwise, 0.

• character_expression: The character expression.
• character_prefix: The character prefix to search for.

                      SELECT STARTSWITH('0123456', '012');
                      -- Result: 1

                      SELECT STARTSWITH('0123456', '456');
                      -- Result: 0
                    

STR ( float_expression [ , integer_length [ , integer_decimal ] ] )

Returns the character data converted from the numeric data. For example, STR(123.45, 6, 1) returns 123.5.

• float_expression: The float expression.
• length: The optional total length to return. This includes decimal point, sign, digits, and spaces. The default is 10.
• decimal: The optional number of places to the right of the decimal point. The decimal must be less than or equal to 16.

                      SELECT STR('123.456');
                      -- Result: '123'

                      SELECT STR('123.456', 2);
                      -- Result: '**'

                      SELECT STR('123.456', 10, 2);
                      -- Result: '123.46'
                    

STUFF(character_expression , integer_start , integer_length , replaceWith_expression)

Inserts a string into another string. It deletes the specified length of characters in the first string at the start position and then inserts the second string into the first string at the start position.

• character_expression: The string expression.
• start: The integer value that specifies the location to start deletion and insertion. If start or length is negative, null is returned. If start is longer than the string to be modified, character_expression, null is returned.
• length: The integer that specifies the number of characters to delete. If length is longer than character_expression, deletion occurs up to the last character in replaceWith_expression.
• replaceWith_expression: The expression of character data that will replace length characters of character_expression beginning at the start value.

                      SELECT STUFF('1234567890', 3, 2, 'xx');
                      -- Result: '12xx567890'
                    

SUBSTRING(string_value FROM start FOR length)

Returns the part of the string with the specified length; starts at the specified index.

• string_value: The character string.
• start: The positive integer that specifies the start index of characters to return.
• length: Optional. The positive integer that specifies how many characters will be returned.

                      SELECT SUBSTRING('1234567890' FROM 3 FOR 2);
                      -- Result: '34'

                      SELECT SUBSTRING('1234567890' FROM 3);
                      -- Result: '34567890'
                    

You can also drop the FROM and FOR clauses:

                    SELECT SUBSTRING('1234567890', 3, 2)
                    --Result: '34'
                    SELECT SUBSTRING('1234567890', 3)
                    --Result: '34567890'
                    

TEXT_ENCODE(input_string, charset)

Returns binary output by encoding a string using the specified character set.

• input_string: The plain text string.
• charset: The character set to use, such as 'UTF-8', 'ISO-8859-1'.

                    SELECT TEXT_ENCODE('Café', 'UTF-8');
                    -- Result: (binary output)
                    

TEXT_DECODE(input_binary, charset)

Returns a string decoded from binary data using the specified character set.

• input_binary: The binary value to decode.
• charset: The character set used for decoding.

                    SELECT TEXT_DECODE(BinaryData, 'UTF-8');
                    -- Result: 'Café'
                    

TOSTRING(string_value1)

Converts the value of this instance to its equivalent string representation.

• string_value1: The string to be converted.

                      SELECT TOSTRING(123);
                      -- Result: '123'

                      SELECT TOSTRING(123.456);
                      -- Result: '123.456'

                      SELECT TOSTRING(null);
                      -- Result: ''
                    

TRIM(trimspec trimchar FROM string_value)

Returns the character expression with leading and/or trailing blanks removed.

• trimspec: Optional. If included must be one of the keywords BOTH, LEADING or TRAILING.
• trimchar: Optional. If included should be a one-character string value.
• string_value: The string value to trim.

                      SELECT TRIM('     trimmed     ');
                      -- Result: 'trimmed'

                      SELECT TRIM(LEADING FROM '     trimmed     ');
                      -- Result: 'trimmed     '

                      SELECT TRIM('-' FROM '-----trimmed-----');
                      -- Result: 'trimmed'

                      SELECT TRIM(BOTH '-' FROM '-----trimmed-----');
                      -- Result: 'trimmed'

                      SELECT TRIM(TRAILING '-' FROM '-----trimmed-----');
                      -- Result: '-----trimmed'
                    

UNICODE(ncharacter_expression)

Returns the integer value defined by the Unicode standard of the first character of the input expression.

• ncharacter_expression: The Unicode character expression.

UPPER ( character_expression )

Returns the character expression with lowercase character data converted to uppercase.

• character_expression: The character expression.

                      SELECT UPPER('MIXED case');
                      -- Result: 'MIXED CASE'
                    

XML_EXTRACT(xml, xpath [, separator])

Extracts an XML document using the specified XPath to flatten the XML. A comma is used to separate the outputs by default, but this can be changed by specifying the third parameter.

• xml: The XML document to extract.
• xpath: The XPath used to select the nodes. The nodes selected will be returned in a token-separated list.
• separator: The optional token used to separate the items in the flattened response. If this is not specified, the separator will be a comma.

                      SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch');
                      -- Result: 'a,e,i,o,u'

                      SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch', ';');
                      -- Result: 'a;e;i;o;u'
                    

ABS ( numeric_expression )

Returns the absolute (positive) value of the specified numeric expression.

• numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT ABS(15);
                      -- Result: 15

                      SELECT ABS(-15);
                      -- Result: 15
                    

ACOS ( float_expression )

Returns the arc cosine, the angle in radians whose cosine is the specified float expression.

• float_expression: The float expression that specifies the cosine of the angle to be returned. Values outside the range from -1 to 1 return null.

                      SELECT ACOS(0.5);
                      -- Result: 1.0471975511966
                    

ASIN ( float_expression )

Returns the arc sine, the angle in radians whose sine is the specified float expression.

• float_expression: The float expression that specifies the sine of the angle to be returned. Values outside the range from -1 to 1 return null.

                      SELECT ASIN(0.5);
                      -- Result: 0.523598775598299
                    

ATAN ( float_expression )

Returns the arc tangent, the angle in radians whose tangent is the specified float expression.

• float_expression: The float expression that specifies the tangent of the angle to be returned.

                      SELECT ATAN(10);
                      -- Result: 1.47112767430373
                    

ATN2 ( float_expression1 , float_expression2 )

Returns the angle in radians between the positive x-axis and the ray from the origin to the point (y, x) where x and y are the values of the two specified float expressions.

• float_expression1: The float expression that is the y-coordinate.
• float_expression2: The float expression that is the x-coordinate.

                      SELECT ATN2(1, 1);
                      -- Result: 0.785398163397448
                    

CEILING ( numeric_expression ) or CEIL( numeric_expression )

Returns the smallest integer greater than or equal to the specified numeric expression.

• numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT CEILING(1.3);
                      -- Result: 2

                      SELECT CEILING(1.5);
                      -- Result: 2

                      SELECT CEILING(1.7);
                      -- Result: 2
                    

COS ( float_expression )

Returns the trigonometric cosine of the specified angle in radians in the specified expression.

• float_expression: The float expression of the specified angle in radians.

                      SELECT COS(1);
                      -- Result: 0.54030230586814
                    

COT ( float_expression )

Returns the trigonometric cotangent of the angle in radians specified by float_expression.

• float_expression: The float expression of the angle in radians.

                      SELECT COT(1);
                      -- Result: 0.642092615934331
                    

DEGREES ( numeric_expression )

Returns the angle in degrees for the angle specified in radians.

• numeric_expression: The angle in radians, an expression of an indeterminate numeric data type except for the bit data type.

                      SELECT DEGREES(3.1415926);
                      -- Result: 179.999996929531
                    

EXP ( float_expression )

Returns the exponential value of the specified float expression. For example, EXP(LOG(20)) is 20.

• float_expression: The float expression.

                      SELECT EXP(2);
                      -- Result: 7.38905609893065
                    

EXPR ( expression )

Evaluates the expression.

• expression: The expression. Operators allowed are +, -, *, /, ==, !=, >, <, >=, and <=.

                      SELECT EXPR('1 + 2 * 3');
                      -- Result: 7

                      SELECT EXPR('1 + 2 * 3 == 7');
                      -- Result: true
                    

FLOOR ( numeric_expression )

Returns the largest integer less than or equal to the numeric expression.

• numeric_expression: The expression of an indeterminate numeric data type except for the bit data type.

                      SELECT FLOOR(1.3);
                      -- Result: 1

                      SELECT FLOOR(1.5);
                      -- Result: 1

                      SELECT FLOOR(1.7);
                      -- Result: 1
                    

GREATEST(int1,int2,....)

Returns the greatest of the supplied integers.

				SELECT GREATEST(3,5,8,10,1)
				-- Result: 10			
				

HEX(value)

Returns a the equivalent hex for the input value.

• value: A string or numerical value to be converted into hex.

				SELECT HEX(866849198);
				-- Result: 33AB11AE
				
				SELECT HEX('Sample Text');
				-- Result: 53616D706C652054657874
				

JSON_AVG(json, jsonpath)

Computes the average value of a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

• json: The JSON document to compute.
• jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_AVG('[1,2,3,4,5]', '$[x]');
                      -- Result: 3

                      SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 3

                      SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 4.5
                    

JSON_COUNT(json, jsonpath)

Returns the number of elements in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

• json: The JSON document to compute.
• jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_COUNT('[1,2,3,4,5]', '$[x]');
                      -- Result: 5

                      SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 5

                      SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 2
                    

JSON_MAX(json, jsonpath)

Gets the maximum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

• json: The JSON document to compute.
• jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_MAX('[1,2,3,4,5]', '$[x]');
                      -- Result: 5

                      SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 5

                      SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[..3]');
                      -- Result: 4
                    

JSON_MIN(json, jsonpath)

Gets the minimum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.

• json: The JSON document to compute.
• jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_MIN('[1,2,3,4,5]', '$[x]');
                      -- Result: 1

                      SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 1

                      SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 4
                    

JSON_SUM(json, jsonpath)

Computes the summary value in JSON according to the JSONPath expression. Return value is numeric or null.

• json: The JSON document to compute.
• jsonpath: The JSONPath used to select the nodes. [x], [2..], [..8], or [1..12] are accepted. [x] selects all nodes.

                      SELECT JSON_SUM('[1,2,3,4,5]', '$[x]');
                      -- Result: 15

                      SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
                      -- Result: 15

                      SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
                      -- Result: 9
                    

LEAST(int1,int2,....)

Returns the least of the supplied integers.

				SELECT LEAST(3,5,8,10,1)
				-- Result: 1			
				

LOG ( float_expression [, base ] )

Returns the natural logarithm of the specified float expression.

• float_expression: The float expression.
• base: The optional integer argument that sets the base for the logarithm.

                      SELECT LOG(7.3890560);
                      -- Result: 1.99999998661119
                    

LOG10 ( float_expression )

Returns the base-10 logarithm of the specified float expression.

• float_expression: The expression of type float.

                      SELECT LOG10(10000);
                      -- Result: 4
                    

MOD(dividend,divisor)

Returns the integer value associated with the remainder when dividing the dividend by the divisor.

• dividend: The number to take the modulus of.
• divisor: The number to divide the dividend by when determining the modulus.

				SELECT MOD(10,3);
				-- Result: 1
				

NEGATE(real_number)

Returns the opposite to the real number input.

• real_number: The real number to find the opposite of.

				SELECT NEGATE(10);
				-- Result: -10
				
				SELECT NEGATE(-12.4)
				--Result: 12.4
				

PI ( )

Returns the constant value of pi.

                  SELECT PI()
                  -- Result: 3.14159265358979 
                

POWER ( float_expression , y )

Returns the value of the specified expression raised to the specified power.

• float_expression: The float expression.
• y: The power to raise float_expression to.

                      SELECT POWER(2, 10);
                      -- Result: 1024

                      SELECT POWER(2, -2);
                      -- Result: 0.25
                    

RADIANS ( float_expression )

Returns the angle in radians of the angle in degrees.

• float_expression: The degrees of the angle as a float expression.

                      SELECT RADIANS(180);
                      -- Result: 3.14159265358979
                    

RAND ( [ integer_seed ] )

Returns a pseudorandom float value from 0 through 1, exclusive.

• seed: The optional integer expression that specifies the seed value. If seed is not specified, a seed value at random will be assigned.

                      SELECT RAND();
                      -- This result may be different, since the seed is randomized
                      -- Result: 0.873159630165044

                      SELECT RAND(1);
                      -- This result will always be the same, since the seed is constant
                      -- Result: 0.248668584157093
                    

ROUND ( numeric_expression [ ,integer_length] [ ,function ] )

Returns the numeric value rounded to the specified length or precision.

• numeric_expression: The expression of a numeric data type.
• length: The optional precision to round the numeric expression to. When this is omitted, the default behavior will be to round to the nearest whole number.
• function: The optional type of operation to perform. When the function parameter is omitted or has a value of 0 (default), numeric_expression is rounded. When a value other than 0 is specified, numeric_expression is truncated.

                      SELECT ROUND(1.3, 0);
                      -- Result: 1

                      SELECT ROUND(1.55, 1);
                      -- Result: 1.6

                      SELECT ROUND(1.7, 0, 0);
                      -- Result: 2

                      SELECT ROUND(1.7, 0, 1);
                      -- Result: 1
                      
                      SELECT ROUND (1.24);
                      -- Result: 1.0
                    

SIGN ( numeric_expression )

Returns the positive sign (1), 0, or negative sign (-1) of the specified expression.

• numeric_expression: The expression of an indeterminate data type except for the bit data type.

                      SELECT SIGN(0);
                      -- Result: 0

                      SELECT SIGN(10);
                      -- Result: 1

                      SELECT SIGN(-10);
                      -- Result: -1
                    

SIN ( float_expression )

Returns the trigonometric sine of the angle in radians.

• float_expression: The float expression specifying the angle in radians.

                     SELECT SIN(1);
                     -- Result: 0.841470984807897
                    

SQRT ( float_expression )

Returns the square root of the specified float value.

• float_expression: The expression of type float.

                      SELECT SQRT(100);
                      -- Result: 10
                    

SQUARE ( float_expression )

Returns the square of the specified float value.

• float_expression: The expression of type float.

                      SELECT SQUARE(10);
                      -- Result: 100

                      SELECT SQUARE(-10);
                      -- Result: 100
                    

TAN ( float_expression )

Returns the tangent of the input expression.

• float_expression: The expression of type float.

                      SELECT TAN(1);
                      -- Result: 1.5574077246549
                    

TRUNC(decimal_number,precision)

Returns the supplied decimal number truncated to have the supplied decimal precision.

• decimal_number: The decimal value to truncate.
• precision: The number of decimal places to truncate the decimal number to.

				SELECT TRUNC(10.3423,2);
				-- Result: 10.34
				

_ROW_NUMBER_()

Returns a row index as an additional column.

				SELECT ColumnName, _ROW_NUMBER_() FROM TableName
				-- Result: ColumnData, 0
				ColumnData2, 1
				ColumnData3, 2
				

CURRENT_DATE()

Returns the current date value.

                  SELECT CURRENT_DATE();
                  -- Result: 2018-02-01
                

CURRENT_TIMESTAMP()

Returns the current time stamp of the database system as a datetime value. This value is equal to GETDATE and SYSDATETIME, and is always in the local timezone.

                  SELECT CURRENT_TIMESTAMP();
                  -- Result: 2018-02-01 03:04:05
                

DATEADD (datepart , integer_number , date [, dateformat])

Returns the datetime value that results from adding the specified number (a signed integer) to the specified date part of the date.

• datepart: The part of the date to add the specified number to. The valid values and abbreviations are
  • year (yy, yyyy)
  • quarter (qq, q)
  • month (mm, m)
  • week (wk, ww)
  • weekday (dw)
  • dayofyear (dy, y)
  • day (dd, d)
  • hour (hh)
  • minute (mi, n)
  • second (ss, s)
  • millisecond (ms)
• number: The number to be added.
• date: The expression of the datetime data type.
• dateformat: The optional output date format.

                  SELECT DATEADD('d', 5, '2018-02-01');
                  -- Result: 2018-02-06

                  SELECT DATEADD('hh', 5, '2018-02-01 00:00:00');
                  -- Result: 2018-02-01 05:00:00
                

DATEDIFF ( datepart , startdate , enddate )

Returns the difference (a signed integer) of the specified time interval between the specified start date and end date.

• datepart: The part of the date that is the time interval of the difference between the start date and end date. The valid values and abbreviations are:
  • Year (year, yyyy, yy)
  • Quarter (quarter, qq, q)
  • Month (month, mm, m)
  • Week (week, wk, ww)
  • Weekday (weekday, dw)
  • Dayofyear (dayofyear, dy, y)
  • Day (day, dd, d)
  • Hour (hour, hh)
  • Minute (minute, mi, n)
  • Second (second, ss, s)
  • Millisecond (millisecond, ms)
• startdate: The datetime expression of the start date.
• enddate: The datetime expression of the end date.

                  SELECT DATEDIFF('d', '2018-02-01', '2018-02-10');
                  -- Result: 9

                  SELECT DATEDIFF('hh', '2018-02-01 00:00:00', '2018-02-01 12:00:00');
                  -- Result: 12
                

DATE_FORMAT(date,format)

Returns the date or timestamp in the format specified. This function mirrors the MySQL DATE_FORMAT function.

• date: A date or timestamp string.
• format: The specifier string of the desired output format. The list of supported format specifiers comes from the MySQL DATE_FORMAT function (see link to MySQL documentation above).

					SELECT DATE_FORMAT('9/4/2021 3:11:53 AM','%h')
					-- Result: 03
				  

DATEFROMPARTS(integer_year, integer_month, integer_day)

Returns the datetime value for the specified year, month, and day.

• year: The integer expression specifying the year.
• month: The integer expression specifying the month.
• day: The integer expression specifying the day.

                    SELECT DATEFROMPARTS(2018, 2, 1);
                    -- Result: 2018-02-01
                  

DATENAME(datepart , date)

Returns the character string that represents the specified date part of the specified date.

• datepart: The part of the date to return. The valid values and abbreviations are year (yy, yyyy), quarter (qq, q), month (mm, m), dayofyear (dy, y), day (dd, d), week (wk, ww), weekday (dw), hour (hh), minute (mi, n), second (ss, s), millisecond (ms), microsecond (mcs), and nanosecond (ns).
• date: The datetime expression.

                     SELECT DATENAME('yy', '2018-02-01');
                     -- Result: '2018'

                     SELECT DATENAME('dw', '2018-02-01');
                     -- Result: 'Thursday'
                   

DATEPART(datepart, date [,integer_datefirst])

Returns a character string that represents the specified date part of the specified date.

• datepart: The part of the date to return. The valid values and abbreviations are year (yy, yyyy), quarter (qq, q), month (mm, m), dayofyear (dy, y), day (dd, d), week (wk, ww), weekday (dw), hour (hh), minute (mi, n), second (ss, s), millisecond (ms), microsecond (mcs), nanosecond (ns), ISODOW, ISO_WEEK (isoweek, isowk,isoww), and ISOYEAR.
• date: The datetime string.
• datefirst: The optional integer representing the first day of the week. The default is 7, Sunday.

                    SELECT DATEPART('yy', '2018-02-01');
                    -- Result: 2018

                    SELECT DATEPART('dw', '2018-02-01');
                    -- Result: 5
                  

DATETIMEFROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute, integer_seconds, integer_milliseconds)

Returns the datetime value for the specified date parts.

• year: The integer expression specifying the year.
• month: The integer expression specifying the month.
• day: The integer expression specifying the day.
• hour: The integer expression specifying the hour.
• minute: The integer expression specifying the minute.
• seconds: The integer expression specifying the seconds.
• milliseconds: The integer expression specifying the milliseconds.

                    SELECT DATETIMEFROMPARTS(2018, 2, 1, 1, 2, 3, 456);
                    -- Result: 2018-02-01 01:02:03.456
                  

DATETIME2FROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute, integer_seconds, integer_fractions, integer_precision)

Returns the datetime value for the specified date parts.

• year: The integer expression specifying the year.
• month: The integer expression specifying the month.
• day: The integer expression specifying the day.
• hour: The integer expression specifying the hour.
• minute: The integer expression specifying the minute.
• seconds: The integer expression specifying the seconds.
• fractions: The integer expression specifying the fractions of the second.
• precision: The integer expression specifying the precision of the fraction.

				    SELECT DATETIME2FROMPARTS(2018, 2, 1, 1, 2, 3, 456, 3);
                    -- Result: 2018-02-01 01:02:03.456
                  

DATE_TRUNC(date, datepart)

Truncates the date to the precision of the given date part. Modeled after the Oracle TRUNC function.

• date: The datetime string that specifies the date.
• datepart: Refer to the Oracle documentation for valid datepart syntax.

				    SELECT DATE_TRUNC('05-04-2005', 'YY');
                    -- Result: '1/1/2005'
					
                    SELECT DATE_TRUNC('05-04-2005', 'MM');
                    -- Result: '5/1/2005'                    
                  

DATE_TRUNC2(datepart, date, [weekday])

Truncates the date to the precision of the given date part. Modeled after the PostgreSQL date_trunc function.

• datepart: One of 'millennium', 'century', 'decade', 'year', 'quarter', 'month', 'week', 'day', 'hour', 'minute' or 'second'.
• date: The datetime string that specifies the date.
• weekday: The optional day of the week to use as the first day for 'week'. One of 'sunday', 'monday', etc.

                    SELECT DATE_TRUNC2('year', '2020-02-04');
                    -- Result: '2020-01-01'

                    SELECT DATE_TRUNC2('week', '2020-02-04', 'monday');
                    -- Result: '2020-02-02', which is the previous Monday
                  

DAY(date)

Returns the integer that specifies the day component of the specified date.

• date: The datetime string that specifies the date.

                    SELECT DAY('2018-02-01');
                    -- Result: 1
                  

DAYNAME(date)

Returns the name of the day of the week of the specified date.

• date: The datetime string that specifies the date.

                    SELECT DAYNAME('8/18/2021');
                    -- Result: Wednesday
                  

DAYOFMONTH(date)

Returns the day of the month of the given date part.

• date: The datetime string that specifies the date.

				  SELECT DAYOFMONTH('04/15/2000');
				  -- Result: 15
				  

DAYOFWEEK(date)

Returns the day of the week of the given date part.

• date: The datetime string that specifies the date.

				  SELECT DAYOFWEEK('04/15/2000');
				  -- Result: 7
				  

DAYOFYEAR(date)

Returns the day of the year of the given date part.

• date: The datetime string that specifies the date.

				  SELECT DAYOFYEAR('04/15/2000');
				  -- Result: 106
				  

EOMONTH(date [, integer_month_to_add ]) or LAST_DAY(date)

Returns the last day of the month that contains the specified date with an optional offset.

• date: The datetime expression specifying the date for which to return the last day of the month.
• integer_month_to_add: The optional integer expression specifying the number of months to add to the date before calculating the end of the month.

                  SELECT EOMONTH('2018-02-01');
                  -- Result: 2018-02-28
                  
                  SELECT LAST_DAY('2018-02-01');
                  -- Result: 2018-02-28

                  SELECT EOMONTH('2018-02-01', 2);
                  -- Result: 2018-04-30
                

EXTRACT(date_part FROM date_column_name)

Returns the last day of the month that contains the specified date with an optional offset.

• date_part: One of the following date components: YEAR, MONTH, DAY, HOUR, MINUTE, SECOND.
• date_column_name: The name of a date column in a table.

                  SELECT EXTRACT(YEAR FROM DateColumn)
                  -- Result: 2021
                

FDWEEK(date)

Returns the first day of the week of the given date part.

• date: The datetime string that specifies the date.
• weeks to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the week.

				  SELECT FDWEEK('02-08-2018');
				  -- Result: 2/4/2018

          SELECT FDWEEK('02-08-2018', 1)
          --Result: 02/11/2018
				  

FDMONTH(date)

Returns the first day of the month of the given date part.

• date: The datetime string that specifies the date.
• month to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the month.

				  SELECT FDMONTH('02-08-2018');
				  -- Result: 2/1/2018

          SELECT FDMONTH('02-08-2018', 1) 
          --Result: 03/01/2018
				  

FDQUARTER(date)

Returns the first day of the quarter of the given date part.

• date: The datetime string that specifies the date.
• quarters to add: An optional integer expression specifying the number of months to add to the date before calculating the first day of the quarter.

				  SELECT FDQUARTER('05-08-2018');
				  -- Result: 4/1/2018

          SELECT FDQUARTER('05-08-2018',1)
          --Result: 07/01/2018
				  

FILEMODIFIEDTIME(uri)

Returns the time stamp associated with the Date Modified of the relevant file.

• uri: An absolute path pointing to a file on the local file system.

				 SELECT FILEMODIFIEDTIME('C:/Documents/myfile.txt');
				 -- Result: 6/25/2019 10:06:58 AM
				 

FROM_DAYS(datevalue)

Returns a date derived from the number of days after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL FROM_DAYS function.

• datevalue: A integer value representing the number of days since 1582-10-15.

				SELECT FROM_DAYS(736000);
				-- Result: 2/6/2015
				

FROM_UNIXTIME(time, issecond)

Returns a representation of the unix_timestamp argument as a value in YYYY-MM-DD HH:MM:SS expressed in the current time zone.

• time: The time stamp value from epoch time. Milliseconds are accepted.
• issecond: Indicates the time stamp value is milliseconds to epoch time.

                      SELECT FROM_UNIXTIME(1540495231, 1);
                      -- Result: 2018-10-25 19:20:31

                      SELECT FROM_UNIXTIME(1540495357385, 0);
                      -- Result: 2018-10-25 19:22:37
                    

GETDATE()

Returns the current time stamp of the database system as a datetime value. This value is equal to CURRENT_TIMESTAMP and SYSDATETIME, and is always in the local timezone.

                  SELECT GETDATE();
                  -- Result: 2018-02-01 03:04:05
                

GETUTCDATE()

Returns the current time stamp of the database system formatted as a UTC datetime value. This value is equal to SYSUTCDATETIME.

In addition, GETUTCDATE can take an optional second parameter, a date and time that are converted to UTC.

                  SELECT GETUTCDATE();
                  -- For example, if the local timezone is Eastern European Time (GMT+2)
                  -- Result: 2018-02-01 05:04:05

                  SELECT GETUTCDATE('2020/08/31 13:56:00')
                  --Result: '2020-08-31 17:56:00'
                

HOUR(date)

Returns the hour component from the provided datetime.

• date: The datetime string that specifies the date.

				SELECT HOUR('02-02-2020 11:30:00');
				-- Result: 11
				

ISDATE(date, [date_format])

Returns 1 if the value is a valid date, time, or datetime value; otherwise, 0.

• date: The datetime string.
• date_format: The optional datetime format.

                      SELECT ISDATE('2018-02-01', 'yyyy-MM-dd');
                      -- Result: 1

                      SELECT ISDATE('Not a date');
                      -- Result: 0
                    

LAST_WEEK()

Returns a time stamp equivalent to exactly one week before the current date.

				SELECT LAST_WEEK();	//Assume the date is 3/17/2020	
			 -- Result: 3/10/2020 00:00:00
				

LAST_MONTH()

Returns a time stamp equivalent to exactly one month before the current date.

	
				SELECT LAST_MONTH(); //Assume the date is 3/17/2020
				-- Result: 2/17/2020 00:00:00
				

LAST_YEAR()

Returns a time stamp equivalent to exactly one year before the current date.

				SELECT LAST_YEAR();	//Assume the date is 3/17/2020	
				-- Result: 3/10/2019 00:00:00
				

LDWEEK(date)

Returns the last day of the provided week.

• date: The datetime string.
• weeks to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the week.

				SELECT LDWEEK('02-02-2020');
				-- Result: 2/8/2020
				

LDMONTH(date)

Returns the last day of the provided month.

• date: The datetime string.
• months to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the month.

				SELECT LDMONTH('02-02-2020');
				-- Result: 2/29/2020

        SELECT LDMONTH('02-08-2020', 1)
        --Result: 03/31/2020
				

LDQUARTER(date)

Returns the last day of the provided quarter.

• date: The datetime string.
• quarters to add: An optional integer expression specifying the number of months to add to the date before calculating the last day of the quarter.

				SELECT LDQUARTER('02-02-2020');
				-- Result: 3/31/2020

        SELECT LDQUARTER('02-02-2020',1)
        --Result: 06/30/2020
				

MAKEDATE(year, days)

Returns a date value from a year and a number of days.

• year: The year
• days: The number of days into the year. Value must be greater than 0.

          SELECT MAKEDATE(2020, 1);
          -- Result: 2020-01-01
        

MINUTE(date)

Returns the minute component from the provided datetime.

• date: The datetime string that specifies the date.

				SELECT MINUTE('02-02-2020 11:15:00');
				-- Result: 15
				

MONTH(date)

Returns the month component from the provided datetime.

• date: The datetime string that specifies the date.

				SELECT MONTH('02-02-2020');
				-- Result: 2
				

QUARTER(date)

Returns the quarter associated with the provided datetime.

• date: The datetime string that specifies the date.

				SELECT QUARTER('02-02-2020');
				-- Result: 1
				

SECOND(date)

Returns the second component from the provided datetime.

• date: The datetime string that specifies the date.

				SELECT SECOND('02-02-2020 11:15:23');
				-- Result: 23
				

SMALLDATETIMEFROMPARTS(integer_year, integer_month, integer_day, integer_hour, integer_minute)

Returns the datetime value for the specified date and time.

• year: The integer expression specifying the year.
• month: The integer expression specifying the month.
• day: The integer expression specifying the day.
• hour: The integer expression specifying the hour.
• minute: The integer expression specifying the minute.

                      SELECT SMALLDATETIMEFROMPARTS(2018, 2, 1, 1, 2);
                      -- Result: 2018-02-01 01:02:00
                    

STRTODATE(string,format)

Parses the provided string value and returns the corresponding datetime.

• string: The string value to be converted to datetime format.
• format: A format string which describes how to interpret the first string input. A few special formats are available as well, including UNIX, UNIXMILIS, TICKS, and FILETICKS.

				SELECT STRTODATE('03*04*2020','dd*MM*yyyy');
				-- Result: 4/3/2020
				

SYSDATETIME()

Returns the current time stamp as a datetime value of the database system. It is equal to GETDATE and CURRENT_TIMESTAMP, and is always in the local timezone.

                  SELECT SYSDATETIME();
                  -- Result: 2018-02-01 03:04:05
                

SYSUTCDATETIME()

Returns the current system date and time as a UTC datetime value. It is equal to GETUTCDATE.

                  SELECT SYSUTCDATETIME();
                  -- For example, if the local timezone is Eastern European Time (GMT+2)
                  -- Result: 2018-02-01 05:04:05
                

TIMEFROMPARTS(integer_hour, integer_minute, integer_seconds, integer_fractions, integer_precision)

Returns the time value for the specified time and with the specified precision.

• hour: The integer expression specifying the hour.
• minute: The integer expression specifying the minute.
• seconds: The integer expression specifying the seconds.
• fractions: The integer expression specifying the fractions of the second.
• precision : The integer expression specifying the precision of the fraction.

                      SELECT TIMEFROMPARTS(1, 2, 3, 456, 3);
                      -- Result: 01:02:03.456
                    

TO_DAYS(date)

Returns the number of days since 0000-00-01. This will only return a value for dates on or after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL TO_DAYS function.

• date: The datetime string that specifies the date.

				SELECT TO_DAYS('02-06-2015');
				-- Result: 736000
				

WEEK(date)

Returns the week (of the year) associated with the provided datetime.

• date: The datetime string that specifies the date.

				SELECT WEEK('02-17-2020 11:15:23');
				-- Result: 8
				

YEAR(date)

Returns the integer that specifies the year of the specified date.

• date: The datetime string.

                      SELECT YEAR('2018-02-01');
                      -- Result: 2018
                    

The following date literal functions can be used to filter date fields using relative intervals. Note that while the <, >, and = operators are supported for these functions, <= and >= are not.

L_TODAY()

The current day.

  SELECT * FROM MyTable WHERE MyDateField = L_TODAY()

L_YESTERDAY()

The previous day.

  SELECT * FROM MyTable WHERE MyDateField = L_YESTERDAY()

L_TOMORROW()

The following day.

  SELECT * FROM MyTable WHERE MyDateField = L_TOMORROW()

L_LAST_WEEK()

Every day in the preceding week.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_WEEK()

L_THIS_WEEK()

Every day in the current week.

  SELECT * FROM MyTable WHERE MyDateField = L_THIS_WEEK()

L_NEXT_WEEK()

Every day in the following week.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_WEEK()

Also available:

• L_LAST/L_THIS/L_NEXT MONTH
• L_LAST/L_THIS/L_NEXT QUARTER
• L_LAST/L_THIS/L_NEXT YEAR

L_LAST_N_DAYS(n)

The previous n days, excluding the current day.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_DAYS(3)

L_NEXT_N_DAYS(n)

The following n days, including the current day.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_DAYS(3)

Also available:

• L_LAST/L_NEXT_90_DAYS

L_LAST_N_WEEKS(n)

Every day in every week, starting n weeks before current week, and ending in the previous week.

  SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_WEEKS(3)

L_NEXT_N_WEEKS(n)

Every day in every week, starting the following week, and ending n weeks in the future.

  SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_WEEKS(3)

Also available:

• L_LAST/L_NEXT_N_MONTHS(n)
• L_LAST/L_NEXT_N_QUARTERS(n)
• L_LAST/L_NEXT_N_YEARS(n)

A SELECT statement can consist of the following basic clauses.

• SELECT
• INTO
• FROM
• JOIN
• WHERE
• GROUP BY
• HAVING
• UNION
• ORDER BY
• LIMIT

SELECT Syntax

The following syntax diagram outlines the syntax supported by the SQL engine of the connector:

SELECT {
  [ TOP <numeric_literal> | DISTINCT ]
  { 
    * 
    | { 
        <expression> [ [ AS ] <column_reference> ] 
        | { <table_name> | <correlation_name> } .* 
      } [ , ... ] 
  }
  { 
    FROM <table_reference> [ [ AS ] <identifier> ] 
  } [ , ... ]
  [ [  
      INNER | { { LEFT | RIGHT | FULL } [ OUTER ] } 
    ] JOIN <table_reference> [ ON <search_condition> ] [ [ AS ] <identifier> ] 
  ] [ ... ] 
  [ WHERE <search_condition> ]
  [ GROUP BY <column_reference> [ , ... ]
  [ HAVING <search_condition> ]
  [ UNION [ ALL ] <select_statement> ]
  [ 
    ORDER BY 
    <column_reference> [ ASC | DESC ] [ NULLS FIRST | NULLS LAST ]
  ]
  [ 
    LIMIT <expression>
    [ 
      { OFFSET | , }
      <expression> 
    ]
  ] 
}

<expression> ::=
  | <column_reference>
  | @ <parameter> 
  | ?
  | COUNT( * | { [ DISTINCT ] <expression> } )
  | { AVG | MAX | MIN | SUM | COUNT } ( <expression> ) 
  | NULLIF ( <expression> , <expression> ) 
  | COALESCE ( <expression> , ... ) 
  | CASE <expression>
      WHEN { <expression> | <search_condition> } THEN { <expression> | NULL } [ ... ]
    [ ELSE { <expression> | NULL } ]
    END 
  | {RANK() | DENSE_RANK()} OVER ([PARTITION BY <column_reference>] {ORDER BY <column_reference>})
  | <literal>
  | <sql_function> 

<search_condition> ::= 
  {
    <expression> { = | > | < | >= | <= | <> | != | LIKE | NOT LIKE | IN | NOT IN | IS NULL | IS NOT NULL | AND | OR | CONTAINS | BETWEEN | IS DISTINCT FROM | IS NOT DISTINCT FROM } [ <expression> ]
  } [ { AND | OR } ... ] 

Examples

1. Return all columns:
   

   SELECT * FROM CampaignPerformance

2. Rename a column:
   

   SELECT [Device] AS MY_Device FROM CampaignPerformance

3. Cast a column's data as a different data type:
   

   SELECT CAST(AnnualRevenue AS VARCHAR) AS Str_AnnualRevenue FROM CampaignPerformance

4. Search data:
   

   SELECT * FROM CampaignPerformance WHERE Device = 'Mobile devices with full browsers'

5. Return the number of items matching the query criteria:
   

   SELECT COUNT(*) AS MyCount FROM CampaignPerformance 

6. Return the number of unique items matching the query criteria:
   

   SELECT COUNT(DISTINCT Device) FROM CampaignPerformance 

7. Return the unique items matching the query criteria:
   

   SELECT DISTINCT Device FROM CampaignPerformance 

8. Sort a result set in ascending order:
   

   SELECT Clicks, Device FROM CampaignPerformance  ORDER BY Device ASC

9. Restrict a result set to the specified number of rows:
   

   SELECT Clicks, Device FROM CampaignPerformance LIMIT 10 

10. Parameterize a query to pass in inputs at execution time. This enables you to create prepared statements and mitigate SQL injection attacks.
    

    SELECT * FROM CampaignPerformance WHERE Device = @param

See Explicitly Caching Data for information on using the SELECT statement in offline mode.

Pseudo Columns

Some input-only fields are available in SELECT statements. These fields, called pseudo columns, do not appear as regular columns in the results, yet may be specified as part of the WHERE clause. You can use pseudo columns to access additional features from Google Ads.

    SELECT * FROM CampaignPerformance WHERE PseudoColumn = '@PseudoColumn'
    

Aggregate Functions

For SELECT examples using aggregate functions, see Aggregate Functions.

JOIN Queries

See JOIN Queries for SELECT query examples using JOINs.

Date Literal Functions

Date Literal Functions contains SELECT examples with date literal functions.

COUNT

Returns the number of rows matching the query criteria.

SELECT COUNT(*) FROM CampaignPerformance WHERE Device = 'Mobile devices with full browsers'

COUNT(DISTINCT)

Returns the number of distinct, non-null field values matching the query criteria.

SELECT COUNT(DISTINCT Clicks) AS DistinctValues FROM CampaignPerformance WHERE Device = 'Mobile devices with full browsers'

AVG

Returns the average of the column values.

SELECT Device, AVG(AnnualRevenue) FROM CampaignPerformance WHERE Device = 'Mobile devices with full browsers'  GROUP BY Device

MIN

Returns the minimum column value.

SELECT MIN(AnnualRevenue), Device FROM CampaignPerformance WHERE Device = 'Mobile devices with full browsers' GROUP BY Device

MAX

Returns the maximum column value.

SELECT Device, MAX(AnnualRevenue) FROM CampaignPerformance WHERE Device = 'Mobile devices with full browsers' GROUP BY Device

SUM

Returns the total sum of the column values.

SELECT SUM(AnnualRevenue) FROM CampaignPerformance WHERE Device = 'Mobile devices with full browsers'

The CData Python Connector for Google Ads supports standard SQL joins like the following examples.

Inner Join

An inner join selects only rows from both tables that match the join condition:

SELECT CampaignPerformance.CampaignName, CampaignPerformance.Amount, ClickPerformance.Page FROM CampaignPerformance, ClickPerformance WHERE CampaignPerformance.CampaignId=ClickPerformance.CampaignId

Left Join

A left join selects all rows in the FROM table and only matching rows in the JOIN table:

SELECT CampaignPerformance.CampaignName, CampaignPerformance.Amount, ClickPerformance.Page FROM CampaignPerformance LEFT OUTER JOIN ClickPerformance ON CampaignPerformance.CampaignId=ClickPerformance.CampaignId

When caching is enabled, CACHE statements provide complete control over the data that is cached and the table to which it is cached. The CACHE statement executes the SELECT statement specified and caches its results to a table with the same name in the cache database or to table specified in <cached_table_name>. The connector updates or inserts rows to the cache depending on whether or not they already exist in the cache, so the primary key, which is used to identify existing rows, must be included in the selected columns.

See Caching Data for more information on different caching strategies.

CACHE Statement Syntax

The cache statement may include the following options that alter its behavior:

CACHE [ <cached_table_name> ] [ WITH TRUNCATE | AUTOCOMMIT | SCHEMA ONLY | DROP EXISTING | ALTER SCHEMA ] <select_statement> 

WITH TRUNCATE

If this option is set, the connector removes existing rows in the cache table before adding the selected rows. Use this option if you want to refresh the entire cache table but keep its existing schema.

AUTOCOMMIT

If this option is set, the connector commits each row individually. Use this option if you want to ignore the rows that could not be cached due to some reason. By default, the entire result set is cached as a single transaction.

DROP EXISTING

If this option is set, the connector drops the existing cache table before caching the new results. Use this option if you want to refresh the entire cache table, including its schema.

SCHEMA ONLY

If this option is set, the connector creates the cache table based on the SELECT statement without executing the query.

ALTER SCHEMA

If this option is set, the connector alters the schema of the existing table in the cache if it does not match the schema of the SELECT statement. This option results in new columns or dropped columns, if the schema of the SELECT statement does not match the cached table.

Common Queries

Use the following cache statement to cache all rows of a table:

CACHE SELECT * FROM CampaignPerformance

Use the following cache statement to cache all rows of a table into the cache table CachedCampaignPerformance:

CACHE CachedCampaignPerformance SELECT * FROM CampaignPerformance

Use the following cache statement for incremental caching. The DateModified column may not exist in all tables. The cache statement shows how incremental caching would work if there were such a column. Also, notice that, in this case, the WITH TRUNCATE and DROP EXISTING options are specifically omitted, which would have deleted all existing rows.

CACHE CachedCampaignPerformance SELECT * FROM CampaignPerformance WHERE DateModified > '2013-04-04'

Use the following cache statements to create a table with all available columns that will then cache only a few of them. The sequence of statements cache only Clicks and Device even though the cache table CachedCampaignPerformance has all the columns in CampaignPerformance.

CACHE CachedCampaignPerformance SCHEMA ONLY SELECT * FROM CampaignPerformance
CACHE CachedCampaignPerformance SELECT Clicks, Device FROM CampaignPerformance

To execute stored procedures, you can use EXECUTE or EXEC statements.

EXEC and EXECUTE assign stored procedure inputs, referenced by name, to values or parameter names.

Stored Procedure Syntax

To execute a stored procedure as an SQL statement, use the following syntax:

 
{ EXECUTE | EXEC } <stored_proc_name> 
{
  [ @ ] <input_name> = <expression>
} [ , ... ]

<expression> ::=
  | @ <parameter> 
  | ?
  | <literal>

Example Statements

Reference stored procedure inputs by name:

EXECUTE my_proc @second = 2, @first = 1, @third = 3;

Execute a parameterized stored procedure statement:

EXECUTE my_proc second = @p1, first = @p2, third = @p3; 

PIVOT and UNPIVOT can be used to change a table-valued expression into another table.

PIVOT

PIVOT rotates a table-value expression by turning unique values from one column into multiple columns in the output. PIVOT can run aggregations where required on any column value.

PIVOT Synax

 
"SELECT 'AverageCost' AS Cost_Sorted_By_Production_Days, [0], [1], [2], [3], [4]
FROM
(
SELECT DaysToManufacture, StandardCost
FROM Production.Product
) AS SourceTable
PIVOT
(
AVG(StandardCost)
FOR DaysToManufacture IN ([0], [1], [2], [3], [4])
) AS PivotTable;"

UNPIVOT

UNPIVOT carries out nearly the opposite to PIVOT by rotating columns of a table-valued expressions into column values.

UNPIVOT Sytax

 
"SELECT VendorID, Employee, Orders
FROM
(SELECT VendorID, Emp1, Emp2, Emp3, Emp4, Emp5
FROM pvt) p
UNPIVOT
(Orders FOR Employee IN
(Emp1, Emp2, Emp3, Emp4, Emp5)
)AS unpvt;"

For further information on PIVOT and UNPIVOT, see FROM clause plus JOIN, APPLY, PIVOT (Transact-SQL)

Overview

The CData Python Connector for Google Ads models Google Ads entities in relational views and stored procedures. The provided views will give you access to your Google Ads data using the Google Ads API. The CData CData Python Connector for Google Ads for Google Ads models Google Ads entities in relational views and stored procedures. The provided views give you access to your Google Ads data using the Google Ads API.

Key Features

• The connector models Google Ads entities like documents, folders, and groups as relational views, allowing you to write SQL to query Google Ads data.
• Stored procedures allow you to execute operations to Google Ads.
• Predefined Report views to make access to data easier.
• Live connectivity to these objects means any changes to your Google Ads account are immediately reflected when using the connector.

Views

Views describes the available views. Two types of views are made available:

• Base Views are statically defined to model Campaigns, AdGroups, Customers, and more. They are used to create your custom reports instead of being used standalone. By default. these views return data from all time aggregated into a single row.
• Predefined Report Views are a set of standard reports that mimic exactly what you see in the Google Ads UI. All Predefined Report Views have "report" appended to their name. By default, these views return data from all time with a daily breakdown.

The Resources view shows the names of the resources, attribute resources and segmenting resources, which you need for the CreateReportSchema stored procedure.

Stored Procedures

Stored Procedures are function-like interfaces to Google Ads. They allow you to execute operations to Google Ads, the most important being CreateReportSchema, which is used to create views from resources (like 'distance_view') with attribute resources (like 'customer' in this case) and segmenting resources (like 'campaign' in this case).

Date Ranges and Aggregation

All tables and views support date ranges and aggregation.

Date Ranges

Date ranges can be defined in the WHERE clause using the Date field using =, <,>, between delimiters.

Additional predefined date fields are available, specifically:

• week
• month
• quarter

When filtering on these, you can use the = operator with the date set to the first day of the time period. If you specify a different date, an error is returned.

For example, to specify the month of May in the year 2022, use the following condition, specifying the first day of that month:

month = '2022-05-01'

Aggregation

Aggregation can be applied at multiple levels:

“Date” returns daily data in the query results. For example,

SELECT CampaignBaseCampaign, CampaignName, CampaignStartDate, CampaignEndDate , Impressions, Clicks, "Date" FROM CData.GoogleAds.Campaign WHERE "Date" BETWEEN '2022-01-01' and '2023-01-31' and CampaignId = '17999934124'

“Hour” returns data aggregated by hour across the date range selected. For example, querying two years of data and selecting “Hour” returns 24 rows of data (one for each hour) with two years of data aggregated for each hour.

“DayofWeek” returns data aggregated by week across the date range selected. For example, querying two years of data and selecting “DayOfWeek” returns seven rows of data (one for each day) with two years of data aggregated for each day.

“Week” returns data aggregated by week across the date range selected. For example, querying two years of data and selecting “Week” returns 104 rows of data (one for each week) with data aggregated for each week.

“Month” returns data aggregated by month across the date range selected. For example, querying two years of data and selecting “Month” returns 24 rows of data (one for each month) with data aggregated for each month.

“MonthofYear” returns data aggregated by month across the date range selected. For example, querying two years of data and selecting “MonthofYear” returns 12 rows of data (one for each month) with two years of data aggregated for each month.

“Quarter” returns data aggregated by quarter across the date range selected. For example. querying two years of data and selecting “Quarter” return eight rows of data (one for each quarter). Note that a Quarter is defined as starting on the 1st of the month of January, April, July, and October.

“Year” returns data aggregated by year across the date range selected. For example, querying two years of data and selecting “Year” returns two rows of data (one for each year) with data aggregated by year.

NOTE: Selecting "Date" overrides any other date metric. It always returns daily data only.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Python Connector for Google Ads Views

Name	Description
AccessibleBiddingStrategy	Represents a view of BiddingStrategies owned by and shared with the customer.
AccountBudget	An account-level budget. It contains information about the budget itself,
AccountBudgetProposal	An account-level budget proposal.
AccountHourlyStatsReport	Account-level performance stats by Ad Network and Device. Hourly data is returned with a default date range of the last 7 days not including today.
AccountLink	Represents the data sharing connection between a Google Ads account and
AccountStatsReport	Account-level performance stats by Ad Network and Device. Daily data is returned with a default date range of the last 7 days not including today.
Ad	An ad.
AdGroup	An ad group.
AdGroupAd	An ad group ad.
AdGroupAdAssetCombinationView	A view on the usage of ad group ad asset combination.
AdGroupAdAssetView	Represents a link between an AdGroupAd and an Asset.
AdGroupAdLabel	A relationship between an ad group ad and a label.
AdGroupAsset	A link between an ad group and an asset.
AdGroupAssetSet	AdGroupAssetSet is the linkage between an ad group and an asset set.
AdGroupAudienceView	An ad group audience view.
AdGroupBidModifier	Represents an ad group bid modifier.
AdGroupCriterion	An ad group criterion.
AdGroupCriterionCustomizer	A customizer value for the associated CustomizerAttribute at the
AdGroupCriterionLabel	A relationship between an ad group criterion and a label.
AdGroupCriterionSimulation	An ad group criterion simulation. Supported combinations of advertising
AdGroupCustomizer	A customizer value for the associated CustomizerAttribute at the AdGroup
AdGroupHourlyStatsReport	Ad Group-level performance stats by Ad Network and Device. Hourly data is returned with a default date range of the last 7 days not including today.
AdGroupLabel	A relationship between an ad group and a label.
AdGroupSimulation	An ad group simulation. Supported combinations of advertising
AdGroupStatsReport	Ad Group-level performance stats by Ad Network and Device. Daily data is returned with a default date range of the last 7 days not including today.
AdParameter	An ad parameter that is used to update numeric values (such as prices or
AdScheduleView	An ad schedule view summarizes the performance of campaigns by
AdStatsReport	Ad-level performance stats by Ad Network and Device. Daily data is returned with a default date range of the last 7 days not including today.
AgeRangeView	An age range view.
AiMaxSearchTermAdCombinationView	AiMaxSearchTermAdCombinationView Resource.
AndroidPrivacySharedKeyGoogleAdGroup	An Android privacy shared key view for Google ad group key.
AndroidPrivacySharedKeyGoogleCampaign	An Android privacy shared key view for Google campaign key.
AndroidPrivacySharedKeyGoogleNetworkType	An Android privacy shared key view for Google network type key.
AppliedIncentive	Represents an applied incentive.
AppTopCombinationView	A view resource in the App Top Combination Report.
Asset	Asset is a part of an ad which can be shared across multiple ads.
AssetFieldTypeView	An asset field type view.
AssetGroup	An asset group.
AssetGroupAsset	AssetGroupAsset is the link between an asset and an asset group.
AssetGroupListingGroupFilter	AssetGroupListingGroupFilter represents a listing group filter tree node in
AssetGroupProductGroupView	An asset group product group view.
AssetGroupSignal	AssetGroupSignal represents a signal in an asset group. The existence of a
AssetGroupTopCombinationView	A view on the usage of asset group asset top combinations.
AssetSet	An asset set representing a collection of assets.
AssetSetAsset	AssetSetAsset is the link between an asset and an asset set.
AssetSetTypeView	An asset set type view.
Audience	Audience is an effective targeting option that lets you
AudienceStatsReport	Audience-level performance stats by Ad Network and Device. Daily data is returned with a default date range of the last 7 days not including today.
BatchJob	A list of mutates being processed asynchronously. The mutates are uploaded
BiddingDataExclusion	Represents a bidding data exclusion. Bidding data exclusions can be set in
BiddingSeasonalityAdjustment	Represents a bidding seasonality adjustment. Cannot be used in manager
BiddingStrategy	A bidding strategy.
BiddingStrategySimulation	A bidding strategy simulation. Supported combinations of simulation type
BillingSetup	A billing setup, which associates a payments account and an advertiser. A
CallView	A call view that includes data for call tracking of call-only ads or call
Campaign	A campaign.
CampaignAggregateAssetView	A campaign-level aggregate asset view that shows where the asset is linked,
CampaignAsset	A link between a Campaign and an Asset.
CampaignAssetSet	CampaignAssetSet is the linkage between a campaign and an asset set.
CampaignAudienceView	A campaign audience view.
CampaignBidModifier	Represents a bid-modifiable only criterion at the campaign level.
CampaignBudget	A campaign budget.
CampaignConversionGoal	The biddability setting for the specified campaign only for all
CampaignCriterion	A campaign criterion.
CampaignCustomizer	A customizer value for the associated CustomizerAttribute at the Campaign
CampaignDraft	A campaign draft.
CampaignGoalConfig	A link between a campaign and a goal enabling campaign-specific optimization.
CampaignGroup	A campaign group.
CampaignHourlyStatsReport	Campaign-level performance stats by Ad Network and Device. Hourly data is returned with a default date range of the last 7 days not including today.
CampaignLabel	Represents a relationship between a campaign and a label.
CampaignLifecycleGoal	Campaign level customer lifecycle goal settings.
CampaignSearchTermInsight	This report provides a high-level view of search demand at the campaign
CampaignSearchTermView	This report provides granular performance data, including cost metrics, for
CampaignSharedSet	CampaignSharedSets are used for managing the shared sets associated with a
CampaignSimulation	A campaign simulation. Supported combinations of advertising
CampaignStatsReport	Campaign-level performance stats by Ad Network and Device. Daily data is returned with a default date range of the last 7 days not including today.
CarrierConstant	A carrier criterion that can be used in campaign targeting.
ChangeEvent	Describes the granular change of returned resources of certain resource
ChangeStatus	Describes the status of returned resource. ChangeStatus could have up to 3
ChannelAggregateAssetView	A channel-level aggregate asset view that shows where the asset is linked,
ClickView	A click view with metrics aggregated at each click level, including both
ClickViewFilteredReport	A click view with metrics aggregated at each click level, including both valid and invalid clicks. For non-Search campaigns, metrics.clicks represents the number of valid and invalid interactions. Queries including ClickView must have a filter limiting the results to one day and can be requested for dates back to 90 days before the time of the request.
CombinedAudience	Describe a resource for combined audiences which includes different
ContentCriterionView	A content criterion view.
ConversionAction	A conversion action.
ConversionCustomVariable	A conversion custom variable
ConversionGoalCampaignConfig	Conversion goal settings for a Campaign.
ConversionValueRule	A conversion value rule
ConversionValueRuleSet	A conversion value rule set is a collection of conversion value rules that
CurrencyConstant	A currency constant.
CustomAudience	A custom audience. This is a list of users by interest.
CustomConversionGoal	Custom conversion goal that can make arbitrary conversion actions biddable.
Customer	A customer.
CustomerAsset	A link between a customer and an asset.
CustomerAssetSet	CustomerAssetSet is the linkage between a customer and an asset set.
CustomerClient	A link between the given customer and a client customer. CustomerClients only
CustomerClientLink	Represents customer client link relationship.
CustomerConversionGoal	Biddability control for conversion actions with a matching category and
CustomerCustomizer	A customizer value for the associated CustomizerAttribute at the Customer
CustomerLabel	Represents a relationship between a customer and a label. This customer may
CustomerLifecycleGoal	Account level customer lifecycle goal settings.
CustomerManagerLink	Represents customer-manager link relationship.
CustomerNegativeCriterion	A negative criterion for exclusions at the customer level.
CustomerSearchTermInsight	This report provides a high-level view of search demand at the customer
CustomerUserAccess	Represents the permission of a single user onto a single customer.
CustomerUserAccessInvitation	Represent an invitation to a new user on this customer account.
CustomInterest	A custom interest. This is a list of users by interest.
CustomizerAttribute	A customizer attribute.
DataLink	Represents the data sharing connection between a Google
DetailContentSuitabilityPlacementView	A detail content suitability placement view.
DetailedDemographic	A detailed demographic: a particular interest-based vertical to be targeted
DetailPlacementView	A view with metrics aggregated by ad group and URL or YouTube video.
DisplayKeywordView	A display keyword view.
DistanceView	A distance view with metrics aggregated by the user's distance from an
DomainCategory	A category generated automatically by crawling a domain. If a campaign uses
DynamicSearchAdsSearchTermView	A dynamic search ads search term view.
ExpandedLandingPageView	A landing page view with metrics aggregated at the expanded final URL
Experiment	A Google ads experiment for users to experiment changes on multiple
ExperimentArm	A Google ads experiment for users to experiment changes on multiple
FinalUrlExpansionAssetView	FinalUrlExpansionAssetView Resource.
GenderView	A gender view.
GeographicView	A geographic view.
GeoTargetConstant	A geo target constant.
Goal	Representation of goals.
GroupContentSuitabilityPlacementView	A group content suitability placement view.
GroupPlacementView	A group placement view.
HotelGroupView	A hotel group view.
HotelPerformanceView	A hotel performance view.
HotelReconciliation	A hotel reconciliation. It contains conversion information from Hotel
IncomeRangeView	An income range view.
KeywordPlan	A Keyword Planner plan.
KeywordPlanAdGroup	A Keyword Planner ad group.
KeywordPlanAdGroupKeyword	A Keyword Plan ad group keyword.
KeywordPlanCampaign	A Keyword Plan campaign.
KeywordPlanCampaignKeyword	A Keyword Plan Campaign keyword.
KeywordStatsReport	Keyword-level performance stats by Ad Network and Device. Daily data is returned with a default date range of the last 7 days not including today.
KeywordThemeConstant	A Smart Campaign keyword theme constant.
KeywordView	A keyword view.
Label	A label.
LandingPageView	A landing page view with metrics aggregated at the unexpanded final URL
LanguageConstant	A language.
LeadFormSubmissionData	Data from lead form submissions.
LifeEvent	A life event: a particular interest-based vertical to be targeted to reach
LocalServicesEmployee	A local services employee resource.
LocalServicesLead	Data from Local Services Lead.
LocalServicesLeadConversation	Data from Local Services Lead Conversation.
LocalServicesVerificationArtifact	A local services verification resource.
LocationInterestView	A location interest view summarizes the performance of adgroup location
LocationView	A location view summarizes the performance of campaigns by a Location
ManagedPlacementView	A managed placement view.
MatchedLocationInterestView	A view that reports metrics for locations where users showed interest, and
MediaFile	A media file.
MobileAppCategoryConstant	A mobile application category constant.
MobileDeviceConstant	A mobile device constant.
OfflineConversionUploadClientSummary	Offline conversion upload summary at customer level.
OfflineConversionUploadConversionActionSummary	Offline conversion upload summary at conversion action level.
OfflineUserDataJob	A job containing offline user data of store visitors, or user list members
OperatingSystemVersionConstant	A mobile operating system version or a range of versions, depending on
PaidOrganicSearchTermView	A paid organic search term view providing a view of search stats across
ParentalStatusView	A parental status view.
PerformanceMaxPlacementView	A view with impression metrics for Performance Max campaign placements.
PerStoreView	A per store view.
ProductCategoryConstant	A Product Category.
ProductGroupView	A product group view.
ProductLink	Represents the data sharing connection between a Google
ProductLinkInvitation	Represents an invitation for data sharing connection between a Google Ads
QualifyingQuestion	Qualifying Questions for Lead Form.
Recommendation	A recommendation.
RecommendationSubscription	Recommendation Subscription resource
RemarketingAction	A remarketing action. A snippet of JavaScript code that will collect the
Resources	List of resources that can be used in order to generate new Reports or re-generate the old one.
SearchTermView	A search term view with metrics aggregated by search term at the ad group
SharedCriterion	A criterion belonging to a shared set.
SharedSet	SharedSets are used for sharing criterion exclusions across multiple
ShoppingPerformanceView	Shopping performance view.
ShoppingProduct	A shopping product from Google Merchant Center that can be advertised by
SmartCampaignSearchTermView	A Smart campaign search term view.
SmartCampaignSetting	Settings for configuring Smart campaigns.
TargetingExpansionView	A targeting expansion view with metrics.
ThirdPartyAppAnalyticsLink	A data sharing connection, allowing the import of third party app analytics
TopicConstant	Use topics to target or exclude placements in the Google Display Network
TopicView	A topic view.
TravelActivityGroupView	A travel activity group view.
TravelActivityPerformanceView	A travel activity performance view.
UserInterest	A user interest: a particular interest-based vertical to be targeted.
UserList	A user list. This is a list of users a customer may target.
UserListCustomerType	A user list customer type
UserLocationView	A user location view.
Video	A video.
VideoEnhancement	Represents a video that can include both advertiser uploaded videos or
WebpageView	A webpage view.
YouTubeVideoUpload	Represents a video upload to YouTube using the Google Ads API.

Represents a view of BiddingStrategies owned by and shared with the customer.

Columns

Name	Type	Behavior	Description
AccessibleBiddingStrategyId	Long	ATTRIBUTE	Output only. The ID of the bidding strategy.
AccessibleBiddingStrategyMaximizeConversionValueTargetRoas	Double	ATTRIBUTE	Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.
AccessibleBiddingStrategyMaximizeConversionsTargetCpaMicros	Long	ATTRIBUTE	Output only. The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.
AccessibleBiddingStrategyName	String	ATTRIBUTE	Output only. The name of the bidding strategy.
AccessibleBiddingStrategyOwnerCustomerId	Long	ATTRIBUTE	Output only. The ID of the Customer which owns the bidding strategy.
AccessibleBiddingStrategyOwnerDescriptiveName	String	ATTRIBUTE	Output only. descriptive_name of the Customer which owns the bidding
AccessibleBiddingStrategyResourceName	String	ATTRIBUTE	Output only. The resource name of the accessible bidding strategy.
AccessibleBiddingStrategyTargetCpaTargetCpaMicros	Long	ATTRIBUTE	Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.
AccessibleBiddingStrategyTargetImpressionShareCpcBidCeilingMicros	Long	ATTRIBUTE	Output only. The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.
AccessibleBiddingStrategyTargetImpressionShareLocation	String	ATTRIBUTE	Output only. The targeted location on the search results page. The allowed values are ABSOLUTE_TOP_OF_PAGE, ANYWHERE_ON_PAGE, TOP_OF_PAGE, UNKNOWN.
AccessibleBiddingStrategyTargetImpressionShareLocationFractionMicros	Long	ATTRIBUTE	The chosen fraction of ads to be shown in the targeted location in micros. For example, 1% equals 10,000.
AccessibleBiddingStrategyTargetRoasTargetRoas	Double	ATTRIBUTE	Output only. The chosen revenue (based on conversion data) per unit of spend.
AccessibleBiddingStrategyTargetSpendCpcBidCeilingMicros	Long	ATTRIBUTE	Output only. Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.
AccessibleBiddingStrategyTargetSpendTargetSpendMicros	Long	ATTRIBUTE	Output only. The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.
AccessibleBiddingStrategyType	String	ATTRIBUTE	Output only. The type of the bidding strategy. The allowed values are COMMISSION, ENHANCED_CPC, FIXED_CPM, FIXED_SHARE_OF_VOICE, INVALID, MANUAL_CPA, MANUAL_CPC, MANUAL_CPM, MANUAL_CPV, MAXIMIZE_CONVERSIONS, MAXIMIZE_CONVERSION_VALUE, PAGE_ONE_PROMOTED, PERCENT_CPC, TARGET_CPA, TARGET_CPC, TARGET_CPM, TARGET_CPV, TARGET_IMPRESSION_SHARE, TARGET_OUTRANK_SHARE, TARGET_ROAS, TARGET_SPEND, UNKNOWN.
CustomerId	Long	ATTRIBUTE	Output only. The ID of the customer.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name	Type	Description
ManagerId	Long	Id of the manager account on behalf of which you are requesting customer data.

An account-level budget. It contains information about the budget itself,

Columns

Name	Type	Behavior	Description
AccountBudgetAdjustedSpendingLimitMicros	Long	ATTRIBUTE	Output only. The adjusted spending limit in micros. One million is
AccountBudgetAdjustedSpendingLimitType	String	ATTRIBUTE	Output only. The adjusted spending limit as a well-defined type, for The allowed values are INFINITE, UNKNOWN.
AccountBudgetAmountServedMicros	Long	ATTRIBUTE	Output only. The value of Ads that have been served, in micros.
AccountBudgetApprovedEndDateTime	Datetime	ATTRIBUTE	Output only. The approved end time in yyyy-MM-dd HH:mm:ss format.
AccountBudgetApprovedEndTimeType	String	ATTRIBUTE	Output only. The approved end time as a well-defined type, for example, The allowed values are FOREVER, NOW, UNKNOWN.
AccountBudgetApprovedSpendingLimitMicros	Long	ATTRIBUTE	Output only. The approved spending limit in micros. One million is
AccountBudgetApprovedSpendingLimitType	String	ATTRIBUTE	Output only. The approved spending limit as a well-defined type, for The allowed values are INFINITE, UNKNOWN.
AccountBudgetApprovedStartDateTime	Datetime	ATTRIBUTE	Output only. The approved start time of the account-level budget in
AccountBudgetBillingSetup	String	ATTRIBUTE	Output only. The resource name of the billing setup associated with this
AccountBudgetId	Long	ATTRIBUTE	Output only. The ID of the account-level budget.
AccountBudgetName	String	ATTRIBUTE	Output only. The name of the account-level budget.
AccountBudgetNotes	String	ATTRIBUTE	Output only. Notes associated with the budget.
AccountBudgetPendingProposalAccountBudgetProposal	String	ATTRIBUTE	Output only. The resource name of the proposal. AccountBudgetProposal resource names have the form: customers/{customer_id}/accountBudgetProposals/{account_budget_proposal_id}
AccountBudgetPendingProposalCreationDateTime	Datetime	ATTRIBUTE	Output only. The time when this account-level budget proposal was created. Formatted as yyyy-MM-dd HH:mm:ss.
AccountBudgetPendingProposalEndDateTime	Datetime	ATTRIBUTE	Output only. The end time in yyyy-MM-dd HH:mm:ss format.
AccountBudgetPendingProposalEndTimeType	String	ATTRIBUTE	Output only. The end time as a well-defined type, for example, FOREVER. The allowed values are FOREVER, NOW, UNKNOWN.
AccountBudgetPendingProposalName	String	ATTRIBUTE	Output only. The name to assign to the account-level budget.
AccountBudgetPendingProposalNotes	String	ATTRIBUTE	Output only. Notes associated with this budget.
AccountBudgetPendingProposalProposalType	String	ATTRIBUTE	Output only. The type of this proposal, for example, END to end the budget associated with this proposal. The allowed values are CREATE, END, REMOVE, UNKNOWN, UPDATE.
AccountBudgetPendingProposalPurchaseOrderNumber	String	ATTRIBUTE	Output only. A purchase order number is a value that helps users reference this budget in their monthly invoices.
AccountBudgetPendingProposalSpendingLimitMicros	Long	ATTRIBUTE	Output only. The spending limit in micros. One million is equivalent to one unit.
AccountBudgetPendingProposalSpendingLimitType	String	ATTRIBUTE	Output only. The spending limit as a well-defined type, for example, INFINITE. The allowed values are INFINITE, UNKNOWN.
AccountBudgetPendingProposalStartDateTime	Datetime	ATTRIBUTE	Output only. The start time in yyyy-MM-dd HH:mm:ss format.
AccountBudgetProposedEndDateTime	Datetime	ATTRIBUTE	Output only. The proposed end time in yyyy-MM-dd HH:mm:ss format.
AccountBudgetProposedEndTimeType	String	ATTRIBUTE	Output only. The proposed end time as a well-defined type, for example, The allowed values are FOREVER, NOW, UNKNOWN.
AccountBudgetProposedSpendingLimitMicros	Long	ATTRIBUTE	Output only. The proposed spending limit in micros. One million is
AccountBudgetProposedSpendingLimitType	String	ATTRIBUTE	Output only. The proposed spending limit as a well-defined type, for The allowed values are INFINITE, UNKNOWN.
AccountBudgetProposedStartDateTime	Datetime	ATTRIBUTE	Output only. The proposed start time of the account-level budget in
AccountBudgetPurchaseOrderNumber	String	ATTRIBUTE	Output only. A purchase order number is a value that helps users reference
AccountBudgetResourceName	String	ATTRIBUTE	Output only. The resource name of the account-level budget.
AccountBudgetStatus	String	ATTRIBUTE	Output only. The status of this account-level budget. The allowed values are APPROVED, CANCELLED, PENDING, UNKNOWN.
AccountBudgetTotalAdjustmentsMicros	Long	ATTRIBUTE	Output only. The total adjustments amount.
CustomerId	Long	ATTRIBUTE	Output only. The ID of the customer.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name	Type	Description
ManagerId	Long	Id of the manager account on behalf of which you are requesting customer data.

An account-level budget proposal.

Columns

Name	Type	Behavior	Description
AccountBudgetProposalAccountBudget	String	ATTRIBUTE	Immutable. The resource name of the account-level budget associated with
AccountBudgetProposalApprovalDateTime	Datetime	ATTRIBUTE	Output only. The date time when this account-level budget was approved, if
AccountBudgetProposalApprovedEndDateTime	Datetime	ATTRIBUTE	Output only. The approved end date time in yyyy-mm-dd hh:mm:ss format.
AccountBudgetProposalApprovedEndTimeType	String	ATTRIBUTE	Output only. The approved end date time as a well-defined type, for The allowed values are FOREVER, NOW, UNKNOWN.
AccountBudgetProposalApprovedSpendingLimitMicros	Long	ATTRIBUTE	Output only. The approved spending limit in micros. One million is
AccountBudgetProposalApprovedSpendingLimitType	String	ATTRIBUTE	Output only. The approved spending limit as a well-defined type, for The allowed values are INFINITE, UNKNOWN.
AccountBudgetProposalApprovedStartDateTime	Datetime	ATTRIBUTE	Output only. The approved start date time in yyyy-mm-dd hh:mm:ss format.
AccountBudgetProposalBillingSetup	String	ATTRIBUTE	Immutable. The resource name of the billing setup associated with this
AccountBudgetProposalCreationDateTime	Datetime	ATTRIBUTE	Output only. The date time when this account-level budget proposal was
AccountBudgetProposalId	Long	ATTRIBUTE	Output only. The ID of the proposal.
AccountBudgetProposalProposalType	String	ATTRIBUTE	Immutable. The type of this proposal, for example, END to end the budget The allowed values are CREATE, END, REMOVE, UNKNOWN, UPDATE.
AccountBudgetProposalProposedEndDateTime	Datetime	ATTRIBUTE	Immutable. The proposed end date time in yyyy-mm-dd hh:mm:ss format.
AccountBudgetProposalProposedEndTimeType	String	ATTRIBUTE	Immutable. The proposed end date time as a well-defined type, for The allowed values are FOREVER, NOW, UNKNOWN.
AccountBudgetProposalProposedName	String	ATTRIBUTE	Immutable. The name to assign to the account-level budget.
AccountBudgetProposalProposedNotes	String	ATTRIBUTE	Immutable. Notes associated with this budget.
AccountBudgetProposalProposedPurchaseOrderNumber	String	ATTRIBUTE	Immutable. A purchase order number is a value that enables the user to help
AccountBudgetProposalProposedSpendingLimitMicros	Long	ATTRIBUTE	Immutable. The proposed spending limit in micros. One million is
AccountBudgetProposalProposedSpendingLimitType	String	ATTRIBUTE	Immutable. The proposed spending limit as a well-defined type, for The allowed values are INFINITE, UNKNOWN.
AccountBudgetProposalProposedStartDateTime	Datetime	ATTRIBUTE	Immutable. The proposed start date time in yyyy-mm-dd hh:mm:ss format.
AccountBudgetProposalResourceName	String	ATTRIBUTE	Immutable. The resource name of the proposal.
AccountBudgetProposalStatus	String	ATTRIBUTE	Output only. The status of this proposal. The allowed values are APPROVED, APPROVED_HELD, CANCELLED, PENDING, REJECTED, UNKNOWN.
CustomerId	Long	ATTRIBUTE	Output only. The ID of the customer.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name	Type	Description
ManagerId	Long	Id of the manager account on behalf of which you are requesting customer data.

Account-level performance stats by Ad Network and Device. Hourly data is returned with a default date range of the last 7 days not including today.

Columns

Name	Type	Behavior	Description
CustomerId	Long	ATTRIBUTE	Output only. The ID of the customer.
Date	Date	SEGMENT	Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
ActiveViewCpm	Double	METRIC	Average cost of viewable impressions (active_view_impressions).
ActiveViewCtr	Double	METRIC	Active view measurable clicks divided by active view viewable impressions. This metric is reported only for display network.
ActiveViewImpressions	Long	METRIC	A measurement of how often your ad has become viewable on a Display Network site.
ActiveViewMeasurability	Double	METRIC	The ratio of impressions that could be measured by Active View over the number of served impressions.
ActiveViewMeasurableCostMicros	Long	METRIC	The cost of the impressions you received that were measurable by Active View.
ActiveViewMeasurableImpressions	Long	METRIC	The number of times your ads are appearing on placements in positions where they can be seen.
ActiveViewViewability	Double	METRIC	The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
AdNetworkType	String	SEGMENT	Ad network type. The allowed values are CONTENT, GOOGLE_OWNED_CHANNELS, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, YOUTUBE.
AverageCost	Double	METRIC	The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.
AverageCpc	Double	METRIC	The total cost of all clicks divided by the total number of clicks received.
AverageCpm	Double	METRIC	Average cost-per-thousand impressions (CPM).
ClickType	String	SEGMENT	Click type. The allowed values are AD_IMAGE, APP_DEEPLINK, BREADCRUMBS, BROADBAND_PLAN, CALLS, CALL_TRACKING, CLICK_ON_ENGAGEMENT_AD, CROSS_NETWORK, GET_DIRECTIONS, HOTEL_BOOK_ON_GOOGLE_ROOM_SELECTION, HOTEL_PRICE, LOCATION_EXPANSION, LOCATION_FORMAT_CALL, LOCATION_FORMAT_DIRECTIONS, LOCATION_FORMAT_IMAGE, LOCATION_FORMAT_LANDING_PAGE, LOCATION_FORMAT_MAP, LOCATION_FORMAT_STORE_INFO, LOCATION_FORMAT_TEXT, MOBILE_CALL_TRACKING, OFFER_PRINTS, OTHER, PRICE_EXTENSION, PRODUCT_AD_APP_DEEPLINK, PRODUCT_EXTENSION_CLICKS, PRODUCT_LISTING_ADS_COUPON, PRODUCT_LISTING_AD_CLICKS, PRODUCT_LISTING_AD_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_LOCAL, PRODUCT_LISTING_AD_MULTICHANNEL_ONLINE, PRODUCT_LISTING_AD_TRANSACTABLE, PROMOTION_EXTENSION, SHOPPING_COMPARISON_LISTING, SHOWCASE_AD_CATEGORY_LINK, SHOWCASE_AD_LOCAL_PRODUCT_LINK, SHOWCASE_AD_LOCAL_STOREFRONT_LINK, SHOWCASE_AD_ONLINE_PRODUCT_LINK, SITELINKS, STORE_LOCATOR, SWIPEABLE_GALLERY_AD_HEADLINE, SWIPEABLE_GALLERY_AD_SEE_MORE, SWIPEABLE_GALLERY_AD_SITELINK_FIVE, SWIPEABLE_GALLERY_AD_SITELINK_FOUR, SWIPEABLE_GALLERY_AD_SITELINK_ONE, SWIPEABLE_GALLERY_AD_SITELINK_THREE, SWIPEABLE_GALLERY_AD_SITELINK_TWO, SWIPEABLE_GALLERY_AD_SWIPES, TRAVEL_ASSETS, UNKNOWN, URL_CLICKS, VIDEO_APP_STORE_CLICKS, VIDEO_CALL_TO_ACTION_CLICKS, VIDEO_CARD_ACTION_HEADLINE_CLICKS, VIDEO_END_CAP_CLICKS, VIDEO_WEBSITE_CLICKS, VISUAL_SITELINKS, WIRELESS_PLAN.
Clicks	Long	METRIC	The number of clicks.
Conversions	Double	METRIC	The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsFromInteractionsRate	Double	METRIC	Conversions from interactions divided by the number of ad interactions (such as clicks for text ads or views for video ads). This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue	Double	METRIC	The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros	Long	METRIC	The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
CostPerConversion	Double	METRIC	The cost of ad interactions divided by conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Ctr	Double	METRIC	The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).
DayOfWeek	String	SEGMENT	Day of the week, for example, MONDAY. The allowed values are FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, UNKNOWN, WEDNESDAY.
Device	String	SEGMENT	Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN.
Hour	Int	SEGMENT	Hour of day as a number between 0 and 23, inclusive.
Impressions	Long	METRIC	Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes	String	METRIC	The types of payable and free interactions. The allowed values are UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
InteractionRate	Double	METRIC	How often people interact with your ad after it is shown to them. This is the number of interactions divided by the number of times your ad is shown.
Interactions	Long	METRIC	The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
Month	Date	SEGMENT	Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.
MonthOfYear	String	SEGMENT	Month of the year, for example, January. The allowed values are APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER, UNKNOWN.
Quarter	Date	SEGMENT	Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.
ValuePerConversion	Double	METRIC	The value of conversions divided by the number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
Week	Date	SEGMENT	Week as defined as Monday through Sunday, and represented by the date of Monday. Formatted as yyyy-MM-dd.
Year	Int	SEGMENT	Year, formatted as yyyy.

Represents the data sharing connection between a Google Ads account and

Columns

Name	Type	Behavior	Description
AccountLinkAccountLinkId	Long	ATTRIBUTE	Output only. The ID of the link.
AccountLinkResourceName	String	ATTRIBUTE	Immutable. Resource name of the account link.
AccountLinkStatus	String	ATTRIBUTE	The status of the link. The allowed values are ENABLED, PENDING_APPROVAL, REJECTED, REMOVED, REQUESTED, REVOKED, UNKNOWN.
AccountLinkThirdPartyAppAnalyticsAppAnalyticsProviderId	Long	ATTRIBUTE	Immutable. The ID of the app analytics provider. This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.
AccountLinkThirdPartyAppAnalyticsAppId	String	ATTRIBUTE	Immutable. A string that uniquely identifies a mobile application from which the data was collected to the Google Ads API. For iOS, the ID string is the 9 digit string that appears at the end of an App Store URL (for example, '422689480' for 'Gmail' whose App Store link is https://apps.apple.com/us/app/gmail-email-by-google/id422689480). For Android, the ID string is the application's package name (for example, 'com.google.android.gm' for 'Gmail' given Google Play link https://play.google.com/store/apps/details?id=com.google.android.gm) This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link.
AccountLinkThirdPartyAppAnalyticsAppVendor	String	ATTRIBUTE	Immutable. The vendor of the app. This field should not be empty when creating a new third party app analytics link. It is unable to be modified after the creation of the link. The allowed values are APPLE_APP_STORE, GOOGLE_APP_STORE, UNKNOWN.
AccountLinkType	String	ATTRIBUTE	Output only. The type of the linked account. The allowed values are THIRD_PARTY_APP_ANALYTICS, UNKNOWN.
CustomerId	Long	ATTRIBUTE	Output only. The ID of the customer.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name	Type	Description
ManagerId	Long	Id of the manager account on behalf of which you are requesting customer data.

Account-level performance stats by Ad Network and Device. Daily data is returned with a default date range of the last 7 days not including today.

Columns

Name	Type	Behavior	Description
CustomerId	Long	ATTRIBUTE	Output only. The ID of the customer.
Date	Date	SEGMENT	Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17.
ActiveViewImpressions	Long	METRIC	A measurement of how often your ad has become viewable on a Display Network site.
ActiveViewMeasurability	Double	METRIC	The ratio of impressions that could be measured by Active View over the number of served impressions.
ActiveViewMeasurableCostMicros	Long	METRIC	The cost of the impressions you received that were measurable by Active View.
ActiveViewMeasurableImpressions	Long	METRIC	The number of times your ads are appearing on placements in positions where they can be seen.
ActiveViewViewability	Double	METRIC	The percentage of time when your ad appeared on an Active View enabled site (measurable impressions) and was viewable (viewable impressions).
AdNetworkType	String	SEGMENT	Ad network type. The allowed values are CONTENT, GOOGLE_OWNED_CHANNELS, GOOGLE_TV, MIXED, SEARCH, SEARCH_PARTNERS, UNKNOWN, YOUTUBE.
Clicks	Long	METRIC	The number of clicks.
Conversions	Double	METRIC	The number of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
ConversionsValue	Double	METRIC	The value of conversions. This only includes conversion actions which include_in_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions.
CostMicros	Long	METRIC	The sum of your cost-per-click (CPC) and cost-per-thousand impressions (CPM) costs during this period.
Device	String	SEGMENT	Device to which metrics apply. The allowed values are CONNECTED_TV, DESKTOP, MOBILE, OTHER, TABLET, UNKNOWN.
Impressions	Long	METRIC	Count of how often your ad has appeared on a search results page or website on the Google Network.
InteractionEventTypes	String	METRIC	The types of payable and free interactions. The allowed values are UNKNOWN, CLICK, ENGAGEMENT, VIDEO_VIEW, NONE.
Interactions	Long	METRIC	The number of interactions. An interaction is the main user action associated with an ad format-clicks for text and shopping ads, views for video ads, and so on.
ViewThroughConversions	Long	METRIC	The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.