Developers
Piwik PRO Analytics Suite
latest
  • Analytics
    • Columns
    • Integrations
      • Google Ads
        • Metrics
        • Dimensions
        • Mixed Queries
      • Google Search Console
      • SharePoint
    • HTTP API
    • Object management API
    • Metrics Mapping
  • Data Collection
  • Customer Data Platform
  • Consent Manager
  • Tag Manager
  • Administration
  • Audience Manager
  • Glossary
Piwik PRO Analytics Suite
  • Docs »
  • Analytics »
  • Integrations »
  • Google Ads
  • Edit on GitHub

Google Ads¶

The HTTP API supports querying Google Ads data just like the internal analytics data.

Note

You must configure the Google Ads integration before any data from it will become available. This can be done in the Settings / Integrations application’s section.

Metrics¶

The table below lists metrics provided by Google Ads integration.

Google Ads Metrics¶
Metric Name Column ID Scope Type
Impressions (Google Ads) google_ads_impressions external int
Clicks (Google Ads) google_ads_clicks external int
Cost (Google Ads) google_ads_cost external float
Average CPC (Google Ads) google_ads_average_cpc external float
CTR (Google Ads) google_ads_ctr external float
ROAS (Google Ads) google_ads_roas session float

Dimensions¶

The table below lists dimensions provided by Google Ads integration.

Note: “Database type” column presents the type of source column of the dimension (in case of enum - type of the ID, in case of dynamic dimensions - not applicable).

Google Ads Dimensions¶
Dimension Name Column ID Scope Type Database Type Nullable Notes
Source source session str string False  
Medium medium session str string False  
Source/Medium source_medium session str string False  
Keyword keyword session str string False  
Device type device_type session [int, str] uint8 True device_type.json
Session entry URL session_entry_url session str string False  
Timestamp timestamp session date not applicable False by default in Raw data API
Website Name website_name session [str, str] not applicable False website UUID
Customer ID (Google Ads) google_ads_customer_id session str_id string False  
Customer Name (Google Ads) google_ads_customer_name session [str, str] not applicable False  
Campaign ID (Google Ads) google_ads_campaign_id session int_id int64 False  
Campaign Name (Google Ads) google_ads_campaign_name session [int, str] not applicable False  
Ad Group ID (Google Ads) google_ads_ad_group_id session int_id int64 False  
Ad Group Name (Google Ads) google_ads_ad_group_name session [int, str] not applicable False  
Ad Group Ad ID (Google Ads) google_ads_ad_group_ad_id session str_id string False  
Ad Group Ad Network Type (Google Ads) google_ads_ad_network_type session [str, str] string False google_ads_ad_network_type.json
Ad Group Keyword Match Type (Google Ads) google_ads_keyword_match_type external [str, str] string False google_ads_keyword_match_type.json, not available in Raw data API

Mixed Queries¶

It is possible to request both internal analytics and Google Ads metrics in a single query (for example: “Sessions” and “Clicks (Google Ads)”), however only the common dimensions listed below may be used in such queries.

Note: “Database type” column presents the type of source column of the dimension (in case of enum - type of the ID, in case of dynamic dimensions - not applicable).

Common Dimensions¶
Dimension Name Column ID Scope Type Database Type Nullable Notes
Source source session str string False  
Medium medium session str string False  
Source/Medium source_medium session str string False  
Keyword keyword session str string False  
Device type device_type session [int, str] uint8 True device_type.json
Session entry URL session_entry_url session str string False  
Timestamp timestamp session date not applicable False by default in Raw data API
Website Name website_name session [str, str] not applicable False website UUID
Customer ID (Google Ads) google_ads_customer_id session str_id string False  
Customer Name (Google Ads) google_ads_customer_name session [str, str] not applicable False  
Campaign ID (Google Ads) google_ads_campaign_id session int_id int64 False  
Campaign Name (Google Ads) google_ads_campaign_name session [int, str] not applicable False  
Ad Group ID (Google Ads) google_ads_ad_group_id session int_id int64 False  
Ad Group Name (Google Ads) google_ads_ad_group_name session [int, str] not applicable False  
Ad Group Ad ID (Google Ads) google_ads_ad_group_ad_id session str_id string False  
Ad Group Ad Network Type (Google Ads) google_ads_ad_network_type session [str, str] string False google_ads_ad_network_type.json

Warning

Using dimensions that are not explicitly listed in the table above in such queries (either as query columns or as filters) will result in a Bad Request response.

Next Previous

© Copyright 2023, Piwik PRO - Enterprise Analytics and Tag Management Platform. Revision 6f9626b6.

Built with Sphinx using a theme provided by Read the Docs.
v: latest
Versions
latest
16.32
16.19
16.16
16.13
16.12
16.11
16.10
16.9
16.8
16.7
16.6
16.5
16.4
16.3
16.2
16.1
16.0
15.7
15.6
15.5
15.4
15.3
7.0
tm-12009-update-tag-manager-docs
pptt-4032-documentation-fixes
pptt-3801_goal_uuid
pptt-3647_change_event_detection_order
pptt-2956-sharepoint-integration
pptt-2918_fetch_app_settings_by_app_url_endpoint
pptt-2753-user-id-guide
pppsys-36591_channel_documentation
ppna-5271-add-sampling-option-to-analytics-http-api
feature-tracker-guide-fixes
feature-tracker-documentation
feature-tm-9702-spa-tracking-api-docs
feature-tm-9374-element-presence-trigger
feature-tm-9247-update-custom-dl-name-docs-16
feature-tm-9247-update-custom-dl-name-docs-15
feature-tm-9188-update-ppms-apidocs-if-necessary
feature-tm-9047-update-tm-api-docs
feature-tm-8746-container-settings-api-documentation
feature-tm-8725-update-tm-api-docs
feature-tm-8601-data-disable-delay-docs-16
feature-tm-8601-data-disable-delay-docs-15
feature-tm-5981-add-builtin-variables-list
feature-tm-10063-lookup-table
feature-pptt-4066-added-setiptracking
feature-pptt-4041-ecommerce-fixes
feature-pptt-4021-updated-guides-to-ecommerce-v2
feature-pptt-3538-added-missing-jstc-methods
feature-pptt-3254-restrict-tracking-source-verstion-to-semver
feature-pptt-3233
feature-pptt-3137-added-setsessionidstrictprivacymode
feature-pptt-3102-source-tracking
feature-pptt-3101-source-tracking-docs
feature-pptt-3045-replace-cpp-shortcut
feature-pptt-2923-web-log-import-update-for-new-tracker
feature-pptt-2715-add-links-to-help-center
feature-pptt-2706
feature-pptt-2696-site-search
feature-pptt-2605-unique-js-error
feature-pptechdoc-97-upgrade-analytics-documentation-to-openapi-3.0
feature-pptechdoc-90-copyright
feature-pptechdoc-87-copy
feature-pptechdoc-83-gimme-opengraph-plox
feature-pptechdoc-79-redirects-and-improvements
feature-ppsdk-74-88-90
feature-ppsdk-117
feature-ppna-3983-new-ui
feature-ppi-95-add-piwik-pro-sdk-for-react-native
feature-ppi-177-add-piwik-pro-pwa-documentation
feature-ppi-102-add-piwik-pro-library-for-angular-8
feature-ppcdp-842-cdp-on-developers-piwik-pro
feature-ppcdev-16606-meta-sites-and-users-update
feature-ppcdev-16523-middleware-for-16.35
feature-ppcdev-16402-users-services-clear-up
feature-ppcdev-15456-release-16.23-docs
feature-ppcdev-15235-middleware-16.19
feature-ppcdev-13911-platform-docs-for-16.0
feature-ppcdev-13485-authorized-api-doc
feature-new-ecommerce
feature-middleware-16.32
feature-jtc-code-tabs
bug-ppna-4014-fix-api-inconsistency
bugfix-pptt-3435-remove-auth-token
bugfix-pptt-3037-r-param
bugfix-ppcdev-14236-modules-fixes-16.0
bugfix-ppcdev-14236-modules-fixes
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.