Google Sheets Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Receive data from Google Sheets.

Configuration Options

The following table summarizes the configuration options available for the google-sheets-source Kamelet:

Property	Name	Description	Type	Default	Example
accessToken	Access Token	Required OAuth 2 access token for google sheets application. This typically expires after an hour so refreshToken is recommended for long term usage.	string
clientId	Client Id	Required Client ID of the sheets application.	string
clientSecret	Client Secret	Required Client Secret of the sheets application.	string
refreshToken	Refresh Token	Required OAuth 2 refresh token for google sheets application. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived.	string
spreadsheetId	Spreadsheet ID	Required The Spreadsheet ID to be used as events source.	string
applicationName	Application name	Google Sheets application name.	string
columnNames	Column Names	Optional custom column names that map to cell coordinates based on their position.	string	A
delay	Delay	The number of milliseconds before the next poll.	integer	500
majorDimension	Major Dimension	Specifies the major dimension that the given values should use (ROWS or COLUMNS). Enum values: * COLUMNS * ROWS	string	ROWS	ROWS
range	Cells Range	The range of rows and columns in a sheet to get data from.	string		A1:B3
repeatCount	Repeat Count	Specifies a maximum limit of number of fires.	integer
splitResults	Split Results	True if value range result should be split into rows or columns to process each of them individually.	boolean	true

Property

Name

Description

Type

Default

Example

accessToken

Access Token

Required OAuth 2 access token for google sheets application. This typically expires after an hour so refreshToken is recommended for long term usage.

string

clientId

Client Id

Required Client ID of the sheets application.

string

clientSecret

Client Secret

Required Client Secret of the sheets application.

string

refreshToken

Refresh Token

Required OAuth 2 refresh token for google sheets application. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived.

string

spreadsheetId

Spreadsheet ID

Required The Spreadsheet ID to be used as events source.

string

applicationName

Application name

Google Sheets application name.

string

columnNames

Column Names

Optional custom column names that map to cell coordinates based on their position.

string

delay

Delay

The number of milliseconds before the next poll.

integer

500

majorDimension

Major Dimension

Specifies the major dimension that the given values should use (ROWS or COLUMNS).

Enum values:

* COLUMNS * ROWS

string

ROWS

range

Cells Range

The range of rows and columns in a sheet to get data from.

string

A1:B3

repeatCount

Repeat Count

Specifies a maximum limit of number of fires.

integer

splitResults

Split Results

True if value range result should be split into rows or columns to process each of them individually.

boolean

true

Dependencies

At runtime, the google-sheets-source Kamelet relies upon the presence of the following dependencies:

camel:core
camel:jackson
camel:kamelet
camel:google-sheets

Camel JBang usage

Prerequisites

You’ve installed JBang.
You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:google-sheets-source"
      parameters:
        .
        .
        .
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/google-sheets-source.kamelet.yaml