# Google Sheets Input

## <img src="/files/n6FD71zGFq1QHNdH74EK" alt="" data-size="line"> Google Sheets Input

### Description <a href="#description" id="description"></a>

The Google Sheets Input transform reads data from a Google Sheets worksheets.

This transform requires a Google service account (JSON file) and a Google Cloud project with the Google Drive and Google Sheets API enabled.

| Hop Engine | <sup>✓</sup> |
| ---------- | ------------ |
| Spark      | ?            |
| Flink      | ?            |
| Dataflow   | ?            |

### Options

#### Service account tab

| option                   | description                                                                                                                                                |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| JSON credential key file | Lets you specify or browse for spreadsheets existing in the service account drive or for the ones that are shared with the service account email.          |
| Application Name         | Your application name for the service account in the Google Developer Console.                                                                             |
| Timeout                  | lets you specify an https timeout (in minutes, defaults to 5).                                                                                             |
| Impersonation            | lets you impersonate your service account. Check the [Google docs](https://cloud.google.com/iam/docs/impersonating-service-accounts) for more information. |

Click the `Test Connection` button to verify your specified JSON credential key file for your service account can use the Google Drive and Spreadsheets APIs and has access to your Google Spreadsheets. On success, you will see a `Google Drive API: Success!` message.

#### Spreadsheet tab

| option          | description                                                                                                                                                                                            |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Spreadsheet Key | specify the key for the Google Spreadsheet you want to read from. Click the "Browse" button to get a list of available spreadsheets.                                                                   |
| Worksheet Id    | specify the worksheet id (title) for the sheet in your Google Spreadsheet you want to read from. Click the "Browse" button to get the list of available worksheets in the selected Google Spreadsheet. |

#### Proxy tab

| option     | description           |
| ---------- | --------------------- |
| Proxy host | Proxy server hostname |
| Proxy port | Proxy server port     |

#### Fields tab

Lets you select from the fields of the sheet.

Fields name are always defined in the first line of the google spreadsheet.

**Get Fields** lets you get fields and guess their types, format, precision, decimal and group delimiter as well as trim type.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.primeur.com/data-shaper-1.21/knowing-the-data-shaper-designer/pipelines/transforms/google-sheets-input.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
