Skip to content

Latest commit

 

History

History
91 lines (65 loc) · 8.09 KB

google-sheets.md

File metadata and controls

91 lines (65 loc) · 8.09 KB

Google Sheets

This page guides you through the process of setting up the Google Sheets source connector.

:::info The Google Sheets source connector pulls data from a single Google Sheets spreadsheet. To replicate multiple spreadsheets, set up multiple Google Sheets source connectors in your Airbyte instance. :::

Set up Google Sheets as a source in Airbyte

For Airbyte Cloud

To set up Google Sheets as a source in Airbyte Cloud:

  1. Log into your Airbyte Cloud account.
  2. In the left navigation bar, click Sources. In the top-right corner, click + New source.
  3. On the Set up the source page, select Google Sheets from the Source type dropdown.
  4. For Name, enter a name for the Google Sheets connector.
  5. Authenticate your Google account via OAuth or Service Account Key Authentication.
    • (Recommended) To authenticate your Google account via OAuth, click Sign in with Google and complete the authentication workflow.
    • To authenticate your Google account via Service Account Key Authentication, enter your Google Cloud service account key in JSON format. Make sure the Service Account has the Project Viewer permission. If your spreadsheet is viewable by anyone with its link, no further action is needed. If not, give your Service account access to your spreadsheet.
  6. For Spreadsheet Link, enter the link to the Google spreadsheet. To get the link, go to the Google spreadsheet you want to sync, click Share in the top right corner, and click Copy Link.

For Airbyte OSS

To set up Google Sheets as a source in Airbyte OSS:

  1. Enable the Google Cloud Platform APIs for your personal or organization account.

    :::info The connector only finds the spreadsheet you want to replicate; it does not access any of your other files in Google Drive. :::

  2. Go to the Airbyte UI and in the left navigation bar, click Sources. In the top-right corner, click + New source.

  3. On the Set up the source page, select Google Sheets from the Source type dropdown.

  4. For Name, enter a name for the Google Sheets connector.

  5. Authenticate your Google account via OAuth or Service Account Key Authentication:

  6. For Spreadsheet Link, enter the link to the Google spreadsheet. To get the link, go to the Google spreadsheet you want to sync, click Share in the top right corner, and click Copy Link.

Output schema

Each sheet in the selected spreadsheet is synced as a separate stream. Each selected column in the sheet is synced as a string field.

Note: Sheet names and column headers must contain only alphanumeric characters or _, as specified in the Airbyte Protocol. For example, if your sheet or column header is named the data, rename it to the_data. This restriction does not apply to non-header cell values.

Airbyte only supports replicating Grid sheets.

Supported sync modes

The Google Sheets source connector supports the following sync modes:

Data type mapping

Integration Type Airbyte Type Notes
any type string

Performance consideration

The Google API rate limit is 100 requests per 100 seconds per user and 500 requests per 100 seconds per project. Airbyte batches requests to the API in order to efficiently pull data and respects these rate limits. We recommended not using the same service user for more than 3 instances of the Google Sheets source connector to ensure high transfer speeds.

Changelog

Version Date Pull Request Subject
0.2.16 2022-07-07 13729 Improve configuration field description
0.2.15 2022-06-02 13446 Retry requests resulting in a server error
0.2.13 2022-05-06 12685 Update CDK to v0.1.56 to emit an AirbyeTraceMessage on uncaught exceptions
0.2.12 2022-04-20 12230 Update connector to use a spec.yaml
0.2.11 2022-04-13 11977 Replace leftover print statement with airbyte logger
0.2.10 2022-03-25 11404 Allow using Spreadsheet Link/URL instead of Spreadsheet ID
0.2.9 2022-01-25 9208 Update title and descriptions
0.2.7 2021-09-27 8470 Migrate to the CDK
0.2.6 2021-09-27 6354 Support connecting via Oauth webflow
0.2.5 2021-09-12 5972 Fix full_refresh test by adding supported_sync_modes to Stream initialization
0.2.4 2021-08-05 5233 Fix error during listing sheets with diagram only
0.2.3 2021-06-09 3973 Add AIRBYTE_ENTRYPOINT for Kubernetes support
0.2.2 2021-04-20 2994 Formatting spec
0.2.1 2021-04-03 2726 Fix base connector versioning
0.2.0 2021-03-09 2238 Protocol allows future/unknown properties
0.1.7 2021-01-21 1762 Fix issue large spreadsheet
0.1.6 2021-01-27 1668 Adopt connector best practices
0.1.5 2020-12-30 1438 Implement backoff
0.1.4 2020-11-30 1046 Add connectors using an index YAML file