You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/integrations/sources/google-ads.md
+16-6
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,9 @@ This page contains the setup guide and reference information for the Google Ads
10
10
<!-- /env:oss -->
11
11
12
12
## Setup guide
13
+
13
14
<!-- env:oss -->
15
+
14
16
### Step 1: (For Airbyte Open Source) Apply for a developer token
15
17
16
18
:::note
@@ -29,6 +31,7 @@ When you apply for a token, make sure to mention:
29
31
- That you have full access to the server running the code (because you're self-hosting Airbyte)
30
32
31
33
### Step 2: Set up the Google Ads connector in Airbyte
34
+
32
35
<!-- /env:oss -->
33
36
<!-- env:cloud -->
34
37
@@ -51,6 +54,7 @@ To set up Google Ads as a source in Airbyte Cloud:
51
54
<!-- /env:cloud -->
52
55
53
56
<!-- env:oss -->
57
+
54
58
**For Airbyte Open Source:**
55
59
56
60
To set up Google Ads as a source in Airbyte Open Source:
@@ -116,21 +120,25 @@ Due to Google Ads API constraints, the `click_view` stream retrieves data one da
116
120
:::
117
121
118
122
For incremental streams, data is synced up to the previous day using your Google Ads account time zone since Google Ads can filter data only by [date](https://developers.google.com/google-ads/api/fields/v11/ad_group_ad#segments.date) without time. Also, some reports cannot load data real-time due to Google Ads [limitations](https://support.google.com/google-ads/answer/2544985?hl=en).
123
+
119
124
<!-- /env:oss -->
120
125
121
126
## Custom Query: Understanding Google Ads Query Language
122
-
Additional streams for Google Ads can be dynamically created using custom queries.
127
+
128
+
Additional streams for Google Ads can be dynamically created using custom queries.
123
129
124
130
The Google Ads Query Language queries the Google Ads API. Review the [Google Ads Query Language](https://developers.google.com/google-ads/api/docs/query/overview) and the [query builder](https://developers.google.com/google-ads/api/fields/v13/query_validator) to validate your query. You can then add these as custom queries when configuring the Google Ads source.
125
131
126
132
Example GAQL Custom Query:
133
+
127
134
```
128
-
SELECT
129
-
campaign.name,
130
-
metrics.conversions,
131
-
metrics.conversions_by_conversion_date
135
+
SELECT
136
+
campaign.name,
137
+
metrics.conversions,
138
+
metrics.conversions_by_conversion_date
132
139
FROM ad_group
133
140
```
141
+
134
142
Note the segments.date is automatically added to the output, and does not need to be specified in the custom query. All custom reports will by synced by day.
135
143
136
144
Each custom query in the input configuration must work for all the customer account IDs. Otherwise, the customer ID will be skipped for every query that fails the validation test. For example, if your query contains metrics fields in the select clause, it will not be executed against manager accounts.
@@ -142,6 +150,7 @@ For an existing Google Ads source, when you are updating or removing Custom GAQL
142
150
:::
143
151
144
152
<!-- env:oss -->
153
+
145
154
## Performance considerations
146
155
147
156
This source is constrained by the [Google Ads API limits](https://developers.google.com/google-ads/api/docs/best-practices/quotas)
@@ -151,7 +160,8 @@ Due to a limitation in the Google Ads API which does not allow getting performan
|`0.2.24`| 2023-06-06 |[27608](https://github.com/airbytehq/airbyte/pull/27608)| Improve Google Ads exception handling |
156
166
|`0.2.23`| 2023-06-06 |[26905](https://github.com/airbytehq/airbyte/pull/26905)| Replace deprecated `authSpecification` in the connector specification with `advancedAuth`|
157
167
|`0.2.22`| 2023-06-02 |[26948](https://github.com/airbytehq/airbyte/pull/26948)| Refactor error messages; add `pattern_descriptor` for fields in spec |
Copy file name to clipboardExpand all lines: docs/integrations/sources/google-analytics-data-api.md
+21-21
Original file line number
Diff line number
Diff line change
@@ -4,17 +4,17 @@ This page contains the setup guide and reference information for the Google Anal
4
4
5
5
:::note
6
6
7
-
[Google Analytics Universal Analytics (UA) connector](https://docs.airbyte.com/integrations/sources/google-analytics-v4), uses the older version of Google Analytics, which has been the standard for tracking website and app user behavior since 2012.
7
+
[Google Analytics Universal Analytics (UA) connector](https://docs.airbyte.com/integrations/sources/google-analytics-v4), uses the older version of Google Analytics, which has been the standard for tracking website and app user behavior since 2012.
8
8
9
9
Google Analytics 4 (GA4) connector is the latest version of Google Analytics, which was introduced in 2020. It offers a new data model that emphasizes events and user properties, rather than pageviews and sessions. This new model allows for more flexible and customizable reporting, as well as more accurate measurement of user behavior across devices and platforms.
10
10
11
11
:::
12
12
13
13
## Prerequisites
14
14
15
-
* JSON credentials for the service account that has access to Google Analytics. For more details check [instructions](https://support.google.com/analytics/answer/1009702)
16
-
* OAuth 2.0 credentials for the service account that has access to Google Analytics
17
-
* Property ID
15
+
- JSON credentials for the service account that has access to Google Analytics. For more details check [instructions](https://support.google.com/analytics/answer/1009702)
16
+
- OAuth 2.0 credentials for the service account that has access to Google Analytics
17
+
- Property ID
18
18
19
19
## Step 1: Set up Source
20
20
@@ -61,7 +61,6 @@ Use the service account email address to [add a user](https://support.google.com
61
61
7. Enter the **Custom Reports (Optional)** a JSON array describing the custom reports you want to sync from Google Analytics.
62
62
8. Enter the **Data request time increment in days (Optional)**. The bigger this value is, the faster the sync will be, but the more likely that sampling will be applied to your data, potentially causing inaccuracies in the returned results. We recommend setting this to 1 unless you have a hard requirement to make the sync faster at the expense of accuracy. The minimum allowed value for this field is 1, and the maximum is 364. (Not applied to custom Cohort reports).
63
63
64
-
65
64
## Supported sync modes
66
65
67
66
The Google Analytics source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
@@ -75,25 +74,25 @@ The Google Analytics source connector supports the following [sync modes](https:
75
74
76
75
This connector outputs the following incremental streams:
* Custom reports should be provided in format `[{"name": "<report-name>", "dimensions": ["<dimension-name>", ...], "metrics": ["<metric-name>", ...], "cohortSpec": "<cohortSpec>", "pivots": "<pivots>"}]`
94
-
* Both `pivots` and `cohortSpec` are optional. Detailed description of the `cohortSpec` and the `pivots` objects you can find [here](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/CohortSpec) and [here](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/Pivot).
95
-
* To enable Incremental sync for Custom reports, you need to include the `date` dimension (except for custom Cohort reports).
96
-
:::
92
+
- Custom reports should be provided in format `[{"name": "<report-name>", "dimensions": ["<dimension-name>", ...], "metrics": ["<metric-name>", ...], "cohortSpec": "<cohortSpec>", "pivots": "<pivots>"}]`
93
+
- Both `pivots` and `cohortSpec` are optional. Detailed description of the `cohortSpec` and the `pivots` objects you can find [here](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/CohortSpec) and [here](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/Pivot).
94
+
- To enable Incremental sync for Custom reports, you need to include the `date` dimension (except for custom Cohort reports).
95
+
:::
97
96
98
97
## Performance Considerations
99
98
@@ -102,7 +101,7 @@ This connector outputs the following incremental streams:
102
101
## Data type map
103
102
104
103
| Integration Type | Airbyte Type | Notes |
105
-
|:-----------------|:-------------|:------|
104
+
|:---------------|:-----------|:----|
106
105
|`string`|`string`||
107
106
|`number`|`number`||
108
107
|`array`|`array`||
@@ -111,7 +110,8 @@ This connector outputs the following incremental streams:
0 commit comments