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.
| 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).
| Dimension Name | Column ID | Scope | Type | Database Type | Nullable | Notes |
|---|---|---|---|---|---|---|
| Source | source | session | str_nocase | string | False | |
| Medium | medium | session | str_nocase | string | False | |
| Source/Medium | source_medium | session | str_nocase | 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 | True | |
| 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 | True | |
| 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).
| Dimension Name | Column ID | Scope | Type | Database Type | Nullable | Notes |
|---|---|---|---|---|---|---|
| Source | source | session | str_nocase | string | False | |
| Medium | medium | session | str_nocase | string | False | |
| Source/Medium | source_medium | session | str_nocase | 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 | True | |
| 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 | True | |
| 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.