> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sync.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

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

<ol>
  <li>Open the **Connections** page of the Sync dashboard.</li>
  <li>Click **Add Connection** to open the **Select Connectors** page.</li>
  <li>Click the **Sources** tab and locate
  the **Google Sheets** row.</li>

  <li>
    Click the **Configure Connection** icon at the end of that row to open
    the **New Connection** page. This action opens the
    **Add Connection** dialog.

    **Note:** If the **Configure Connection** icon is not
    available, click the **Download Connector** icon to install
    the Google Sheets connector.
  </li>

  <li>Enter a name for your connection in the **Add Connection** dialog.</li>
  <li>Click **Add** to open the **Settings** tab for your connector.</li>
</ol>

For more information about installing new connectors, see
[Connections](https://docs.sync.cdata.com/26.4/en/connections/connections.md).

## 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**](#token)
* [**OAuth**](#oauth) (default)
* [**OAuth JWT**](#oauth-jwt)
* [**GCP Instance Account**](#gcp-instance-account)
* [**AWS Workload Identity**](#aws-workload-identity)
* [**Azure Workload Identity**](#azure-workload-identity)

### 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, specify the following properties:

<ul><li>**Auth Scheme:** Select **OAuthJWT**.</li>
<li>**OAuth Client Id:** Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.</li>
<li>**OAuth Client Secret:** Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.</li>
<li>**Scope:** Enter the scope of your access to the application.</li>
<li>**OAuth JWT Cert:** Enter your Java web tokens (JWT) certificate store.</li>
<li>**OAuth JWT Cert Type:** Enter the type of key store that contains your JWT certificate. The default type is **PEMKEY\_BLOB**.</li>
<li>**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.</li>
<li>(Optional) **OAuth JWT Cert Subject:** Enter the subject of your OAuth JWT certificate.</li>
<li>(Optional) **OAuth JWT Subject:** Enter the user subject for which the application is requesting delegated access.</li>
<li>(Optional) **OAuth JWT Subject Type:** Select the subject type (**enterprise** or **user**) for the JWT authentication. The default type is **enterprise**.</li>
<li>(Optional) **OAuth JWT Public Key Id:** Enter the Id of the public key for JWT.</li></ul>

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

### AWS Workload Identity

To connect with AWS Workload Identity federation credentials, specify the following properties:

<ul>
  <li>**Auth Scheme:** Select **AWSWorkloadIdentity**.</li>

  <li>
    **AWS Workload Identity Config:** Enter a semicolon-separated list of `Key=Value` properties, as shown in this example:

    `AWSWorkloadIdentityConfig="AuthScheme=AwsRootKeys;AccessKey='AKIAABCDEF123456';SecretKey=...;Region=us-east-1"`

    Note that it is optional as to whether you want to include the value within quotes.
  </li>

  <li>**Workload Pool Id:** Enter The identifier (Id) of your Workload Identity Federation pool.</li>
  <li>**Workload Project Id:** Enter the Id of the Google Cloud project that hosts your Workload Identity Federation pool.</li>
  <li>**Workload Provider Id:** Enter the Id of your Workload Identity Federation pool provider.</li>
</ul>

### Azure Workload Identity

To connect with single sign-on via PingFederate, specify the following properties:

<ul>
  <li>**Auth Scheme:** Select **AzureWorkloadIdentity**.</li>

  <li>
    **Azure Workload Identity Config:** Enter a semicolon-separated list of `Key=Value` properties, as shown in this example:

    `AzureWorkloadIdentityConfig="AuthScheme=AzureServicePrincipal;AzureTenant=directory (tenant) id;OAuthClientID=application (client) id;OAuthClientSecret=client secret;AzureResource=application id uri;"`

    Note that it is optional as to whether you want to include the value within quotes.
  </li>

  <li>**Workload Pool Id:** Enter The identifier (Id) of your Workload Identity Federation pool.</li>
  <li>**Workload Project Id:** Enter the Id of the Google Cloud project that hosts your Workload Identity Federation pool.</li>
</ul>

## 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](https://cdn.cdata.com/help/RLN/synch/default.htm).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.