Search

Google Sheets

Version 24.3.9120

Google Sheets

You can use the Google Sheets connector from the CData Sync application to capture data from Google Sheets and move it to any supported destination. To do so, you need to add the connector, authenticate to the connector, and complete your connection.

Add the Google Sheets Connector

To enable Sync to use data from Google Sheets, you first must add the connector, as follows:

  1. Open the Connections page of the Sync dashboard.

  2. Click Add Connection to open the Select Connectors page.

  3. Click the Sources tab and locate the Google Sheets row.

  4. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the Google Sheets connector. For more information about installing new connectors, see Connections.

Authenticate to Google Sheets

After you add the connector, you need to set the required properties.

On the New Connection page, enter the connection name of your choice.

CData Sync supports authenticating to Google Sheets in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

Token

To connect with token-based authentication, specify the following properties:

  • Auth Scheme - Select Token.

  • API Key - Enter the API key that you want your client application to use when it calls an API that is enabled in a Google Cloud Platform project.

    To create an API key in the Google Cloud console, select Create credentials > API Key. Use the key that is generated in the API Key text box on this page.

OAuth

CData Sync provides an embedded OAuth application with which to connect. To use the application, select OAuth for Auth Scheme. No additional properties are required.

OAuth JWT

To connect with a Google Sheets account, set the following properties:

  • OAuth Client Id - Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.

  • OAuth Client Secret - Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.

  • OAuth JWT Cert – Enter your Java web tokens (JWT) certificate store.

  • OAuth JWT Cert Type – Enter the type of key store that contains your JWT Certificate. The default type is PEMKEY_BLOB.

  • OAuth JWT Issuer – Enter the issuer of your Java web token. Typically, the issuer is either the client Id or the email address of the OAuth application.

  • OAuth JWT Cert Password (optional) – Enter the password for your OAuth JWT certificate.

  • OAuth JWT Cert Subject (optional) – Enter the subject of your OAuth JWT certificate.

  • OAuth JWT Subject (optional) – Enter the user subject for which the application is requesting delegated access.

  • OAuth JWT Subject Type (optional) - Select the subject type (enterprise or user) for the JWT authentication. The default type is enterprise.

  • OAuth JWT Public Key Id (optional) – Enter the Id of the public key for JWT.

GCP Instance Account

When you run CData Sync on a GCP virtual machine, Sync can authenticate by using the service account that is tied to the virtual machine. Select GCPInstanceAccount for Auth Scheme to use that account. No additional properties are required.

Complete Your Connection

To complete your connection:

  1. Specify the following properties:

    • Spreadsheet - Enter a comma-separated list of names or identifiers of the spreadsheets that you want to view. (Example: SpreadsheetName1,SpreadsheetName2)

    • Folder Name - Enter a comma-separated list of folder names from which to retrieve the spreadsheets. (Example: Name1,Name2)

  2. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)

  3. If you authenticate with OAuth, click Connect to Google Sheets to connect to your Google Sheets account.

  4. Click Create & Test to create your connection.

More Information

For more information about interactions between CData Sync and Google Sheets, see Google Sheets Connector for CData Sync.