Skip to content

Commit

Permalink
📚 Docs Refresh: Google Analytics Source (#6669)
Browse files Browse the repository at this point in the history
* Docs Refresh: Google Analytics Source

* Just remove the whole thing.
  • Loading branch information
avaidyanatha authored Oct 4, 2021
1 parent 8c9422b commit b06faf7
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 34 deletions.
3 changes: 1 addition & 2 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,7 @@
* [GitLab](integrations/sources/gitlab.md)
* [Google Ads](integrations/sources/google-ads.md)
* [Google Adwords](integrations/sources/google-adwords.md)
* [Google Analytics](integrations/sources/googleanalytics.md)
* [Google Analytics v4](integrations/sources/google-analytics-v4.md)
* [Google Analytics](integrations/sources/google-analytics-v4.md)
* [Google Directory](integrations/sources/google-directory.md)
* [Google Search Console](integrations/sources/google-search-console.md)
* [Google Sheets](integrations/sources/google-sheets.md)
Expand Down
60 changes: 28 additions & 32 deletions docs/integrations/sources/googleanalytics.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,37 @@
# Google Analytics

## Overview

The Google Analytics source supports Full Refresh syncs. That is, every time a sync is run, Airbyte will copy all rows in the tables and columns you set up for replication into the destination in a new table.

This Google Analytics source wraps the [Pipelinewise Singer Google Analytics Tap](https://github.com/transferwise/pipelinewise-tap-google-analytics).

### Output streams

* `website_overview`
* `traffic_sources`
* `pages`
* `locations`
* `monthly_active_users`
* `four_weekly_active_users`
* `two_weekly_active_users`
* `weekly_active_users`
* `daily_active_users`
* `devices`
* Any custom reports you configure. See the section below on custom reports.

Please reach out to us on Slack or [create an issue](https://github.com/airbytehq/airbyte/issues) if you need to send custom Google Analytics report data with Airbyte.

### Features
## Features

| Feature | Supported? |
| :--- | :--- |
| Full Refresh Sync | Yes |
| Incremental Sync | Yes |
| Replicate Incremental Deletes | No |
| SSL connection | Yes |
| Namespaces | No |
| Custom Reports | Yes |

### Performance considerations
This Google Analytics source wraps the [Pipelinewise Singer Google Analytics Tap](https://github.com/transferwise/pipelinewise-tap-google-analytics).

The Google Analytics connector should not run into Google Analytics API limitations under normal usage. Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully.
## Supported Tables

* website_overview
* traffic_sources
* pages
* locations
* monthly_active_users
* four_weekly_active_users
* two_weekly_active_users
* weekly_active_users
* daily_active_users
* devices
* Any custom reports. See [below](googleanalytics.md#reading-custom-reports-from-google-analytics) for details on reading them.

## Getting Started (Airbyte Cloud)
Airbyte Cloud supports OAuth for the [GoogleAnalytics V4 connector](./google-analytics-v4.md), but not this one. If you can't use the V4 connector, just proceed with the open-source instructions below.

## Getting started
## Getting Started (Airbyte Open-Source)

### Create a Service Account
#### Create a Service Account

We recommend creating a service account specifically for Airbyte so you can set granular permissions.

Expand All @@ -49,16 +42,16 @@ First, need to select or create a project in the Google Developers Console:
3. Click `Create service account`.
4. Create a JSON key file for the service user. The contents of this file will be provided as the `credentials_json` in the UI when authorizing GA after you grant permissions \(see below\).

### Add service account to the Google Analytics account
#### Add service account to the Google Analytics account

Use the service account email address to [add a user](https://support.google.com/analytics/answer/1009702) to the Google analytics view you want to access via the API. You will need to grant [Read & Analyze permissions](https://support.google.com/analytics/answer/2884495).

### Enable the APIs
#### Enable the APIs

1. Go to the [Google Analytics Reporting API dashboard](https://console.developers.google.com/apis/api/analyticsreporting.googleapis.com/overview) in the project for your service user. Enable the API for your account. You can set quotas and check usage.
2. Go to the [Google Analytics API dashboard](https://console.developers.google.com/apis/api/analytics.googleapis.com/overview) in the project for your service user. Enable the API for your account.

### Reading custom reports from Google Analytics
#### Reading custom reports from Google Analytics

You can replicate Google Analytics [Custom Reports](https://support.google.com/analytics/answer/1033013?hl=en) using this source. To do this, input a JSON object as a string in the "Custom Reports" field when setting up the connector. The JSON is an array of objects where each object has the following schema:

Expand Down Expand Up @@ -113,7 +106,10 @@ A custom report can contain no more than 10 unique metrics. The default availabl
* `ga:uniquePageviews`
* `ga:users`

### Limits and Quotas on API Requests

## Rate Limiting & Performance Considerations

The Google Analytics connector should not run into Google Analytics API limitations under normal usage. Please [create an issue](https://github.com/airbytehq/airbyte/issues) if you see any rate limit issues that are not automatically retried successfully.

[Analytics Reporting API v4](https://developers.google.com/analytics/devguides/reporting/core/v4/limits-quotas)

Expand Down

0 comments on commit b06faf7

Please sign in to comment.