Google Sheets input transform Icon Google Sheets input

Description

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.

Supported Engines

Hop Engine

Supported

Single Threaded

Supported

Native Spark

Supported

Beam Spark

Maybe Supported

Beam Flink

Maybe Supported

Beam Dataflow

Maybe Supported

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

The columns below appear on many field tables. They are field metadata: they control how Hop converts a string to a typed value, and how a typed value is written back to a string. They do not change the value stored in a database.

Column Description

Format / Conversion mask

Number or date pattern used to parse and print the value. See Formatting numbers and dates.

Length

String: maximum characters. Number / BigNumber: significant digits. Integer: display width (leading zeros when writing). Date: length of the printed string (for example 4 prints only the year). Use -1 when unset.

Precision

Decimal digits after the radix for Number and BigNumber. Not used for String, Date or Boolean.

Decimal

Character that separates the integer and fractional parts. . in 10,000.00 (US) or , in 10.000,00 (DE).

Group / Grouping

Thousands grouping symbol. , in 10,000.00 (US) or . in 10.000,00 (DE). This is not a row group or category.

Currency

Optional currency symbol used when the format mask contains a currency sign (¤). Examples: $, .

Value

A single constant, entered as a string and parsed with Type, Format, Decimal, Group and Currency. Not a comma-separated list of values. Use Data Grid when you need several different rows.

Set empty string?

When the constant is empty, emit an empty string ("") instead of null.

Column Description

Name

Name of the output field. Taken from the first row of the sheet when you click Get Fields.

Type

Hop data type used to parse the cell text. See Data types.

Trim type

How to trim whitespace from the cell text before conversion: none, left, right, or both.