airbyte/docs/integrations/sources/google-sheets.inapp.md

Prerequisites

• Spreadsheet Link - The link to the Google spreadsheet you want to sync.
• A Google Workspace user with access to the spreadsheet

:::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. :::

Setup guide

1. For Source name, enter a name to help you identify this source.
2. Select your authentication method:

For Airbyte Cloud

• (Recommended) Select Authenticate via Google (OAuth) from the Authentication dropdown, click Sign in with Google and complete the authentication workflow.

For Airbyte Open Source

• (Recommended) Select Service Account Key Authentication from the dropdown and enter your Google Cloud service account key in JSON format:

  { "type": "service_account", "project_id": "YOUR_PROJECT_ID", "private_key_id": "YOUR_PRIVATE_KEY", ... }
  

• To authenticate your Google account via OAuth, select Authenticate via Google (OAuth) from the dropdown and enter your Google application's client ID, client secret, and refresh token.

For detailed instructions on how to generate a service account key or OAuth credentials, refer to the full documentation.

3. 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.
4. (Optional) You may enable the option to Convert Column Names to SQL-Compliant Format. Enabling this option will allow the connector to convert column names to a standardized, SQL-friendly format. For example, a column name of Café Earnings 2022 will be converted to cafe_earnings_2022. We recommend enabling this option if your target destination is SQL-based (ie Postgres, MySQL). Set to false by default.
5. (Optional) For Row Batch Size, you may specify the number of records you want to fetch per request to the Google API. By adjusting this value, you can balance the efficiency of the data retrieval process with Google's request quotas. The default value of 200 should suffice for most use cases.
6. Click Set up source and wait for the tests to complete.

Output schema

• Airbyte only supports replicating Grid sheets.

For detailed information on supported sync modes, supported streams, performance considerations, refer to the full documentation for Google Sheets.