Google Sheets Stream

Since Camel 2.23

Only consumer is supported

The Google Sheets component provides access to Sheets via the Google Sheets Web APIs.

Google Sheets uses the OAuth 2.0 protocol for authenticating a Google account and authorizing access to user data. Before you can use this component, you will need to create an account and generate OAuth credentials. Credentials comprise of a clientId, clientSecret, and a refreshToken. A handy resource for generating a long-lived refreshToken is the OAuth playground.

Maven users will need to add the following dependency to their pom.xml for this component:

<dependency>
        <groupId>org.apache.camel</groupId>
        <artifactId>camel-google-sheets</artifactId>
        <!-- use the same version as your Camel core version -->
        <version>x.x.x</version>
</dependency>

URI Format

The Google Sheets Component uses the following URI format:

google-sheets-stream://apiName?[options]

Component options

The Google Sheets Stream component supports 17 options, which are listed below.

Name	Description	Default	Type
applicationName (consumer)	Google sheets application name. Example would be camel-google-sheets/1.0		String
bridgeErrorHandler (consumer)	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.	false	boolean
clientId (consumer)	Client ID of the sheets application		String
configuration (consumer)	To use the shared configuration		GoogleSheetsStreamConfiguration
includeGridData (consumer)	True if grid data should be returned.	false	boolean
majorDimension (consumer)	Specifies the major dimension that results should use.. There are 3 enums and the value can be one of: ROWS, COLUMNS, DIMENSION_UNSPECIFIED	ROWS	String
maxResults (consumer)	Specify the maximum number of returned results. This will limit the number of rows in a returned value range data set or the number of returned value ranges in a batch request.		int
range (consumer)	Specifies the range of rows and columns in a sheet to get data from.		String
scopes (consumer)	Specifies the level of permissions you want a sheets application to have to a user account. See https://developers.google.com/identity/protocols/googlescopes for more info.		List
splitResults (consumer)	True if value range result should be split into rows or columns to process each of them individually. When true each row or column is represented with a separate exchange in batch processing. Otherwise value range object is used as exchange junk size.	false	boolean
spreadsheetId (consumer)	Specifies the spreadsheet identifier that is used to identify the target to obtain.		String
valueRenderOption (consumer)	Determines how values should be rendered in the output. There are 3 enums and the value can be one of: FORMATTED_VALUE, UNFORMATTED_VALUE, FORMULA	FORMATTED_VALUE	String
basicPropertyBinding (advanced)	Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	boolean
clientFactory (advanced)	To use the GoogleSheetsClientFactory as factory for creating the client. Will by default use BatchGoogleSheetsClientFactory		GoogleSheetsClientFactory
accessToken (security)	OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.		String
clientSecret (security)	Client secret of the sheets application		String
refreshToken (security)	OAuth 2 refresh token. 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

Name

Description

Default

Type

applicationName (consumer)

Google sheets application name. Example would be camel-google-sheets/1.0

String

bridgeErrorHandler (consumer)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

boolean

clientId (consumer)

Client ID of the sheets application

String

configuration (consumer)

To use the shared configuration

GoogleSheetsStreamConfiguration

includeGridData (consumer)

True if grid data should be returned.

false

boolean

majorDimension (consumer)

Specifies the major dimension that results should use.. There are 3 enums and the value can be one of: ROWS, COLUMNS, DIMENSION_UNSPECIFIED

ROWS

String

maxResults (consumer)

Specify the maximum number of returned results. This will limit the number of rows in a returned value range data set or the number of returned value ranges in a batch request.

int

range (consumer)

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

String

scopes (consumer)

Specifies the level of permissions you want a sheets application to have to a user account. See https://developers.google.com/identity/protocols/googlescopes for more info.

List

splitResults (consumer)

True if value range result should be split into rows or columns to process each of them individually. When true each row or column is represented with a separate exchange in batch processing. Otherwise value range object is used as exchange junk size.

false

boolean

spreadsheetId (consumer)

Specifies the spreadsheet identifier that is used to identify the target to obtain.

String

valueRenderOption (consumer)

Determines how values should be rendered in the output. There are 3 enums and the value can be one of: FORMATTED_VALUE, UNFORMATTED_VALUE, FORMULA

FORMATTED_VALUE

String

basicPropertyBinding (advanced)

Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

clientFactory (advanced)

To use the GoogleSheetsClientFactory as factory for creating the client. Will by default use BatchGoogleSheetsClientFactory

GoogleSheetsClientFactory

accessToken (security)

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

String

clientSecret (security)

Client secret of the sheets application

String

refreshToken (security)

OAuth 2 refresh token. 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

The Google Sheets Stream endpoint is configured using URI syntax:

google-sheets-stream:apiName

with the following path and query parameters:

Path Parameters (1 parameters):

Name	Description	Default	Type
apiName	Required Sets the apiName.		String

Name

Description

Default

Type

apiName

Required Sets the apiName.

String

Query Parameters (34 parameters):

Name	Description	Default	Type
applicationName (consumer)	Google sheets application name. Example would be camel-google-sheets/1.0		String
bridgeErrorHandler (consumer)	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.	false	boolean
clientId (consumer)	Client ID of the sheets application		String
includeGridData (consumer)	True if grid data should be returned.	false	boolean
majorDimension (consumer)	Specifies the major dimension that results should use.. There are 3 enums and the value can be one of: ROWS, COLUMNS, DIMENSION_UNSPECIFIED	ROWS	String
maxResults (consumer)	Specify the maximum number of returned results. This will limit the number of rows in a returned value range data set or the number of returned value ranges in a batch request.		int
range (consumer)	Specifies the range of rows and columns in a sheet to get data from.		String
scopes (consumer)	Specifies the level of permissions you want a sheets application to have to a user account. See https://developers.google.com/identity/protocols/googlescopes for more info.		List
sendEmptyMessageWhenIdle (consumer)	If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.	false	boolean
splitResults (consumer)	True if value range result should be split into rows or columns to process each of them individually. When true each row or column is represented with a separate exchange in batch processing. Otherwise value range object is used as exchange junk size.	false	boolean
spreadsheetId (consumer)	Specifies the spreadsheet identifier that is used to identify the target to obtain.		String
valueRenderOption (consumer)	Determines how values should be rendered in the output. There are 3 enums and the value can be one of: FORMATTED_VALUE, UNFORMATTED_VALUE, FORMULA	FORMATTED_VALUE	String
exceptionHandler (consumer)	To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.		ExceptionHandler
exchangePattern (consumer)	Sets the exchange pattern when the consumer creates an exchange. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut		ExchangePattern
pollStrategy (consumer)	A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.		PollingConsumerPollStrategy
basicPropertyBinding (advanced)	Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	boolean
synchronous (advanced)	Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).	false	boolean
backoffErrorThreshold (scheduler)	The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.		int
backoffIdleThreshold (scheduler)	The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.		int
backoffMultiplier (scheduler)	To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.		int
delay (scheduler)	Milliseconds before the next poll.	500	long
greedy (scheduler)	If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.	false	boolean
initialDelay (scheduler)	Milliseconds before the first poll starts.	1000	long
repeatCount (scheduler)	Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.	0	long
runLoggingLevel (scheduler)	The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF	TRACE	LoggingLevel
scheduledExecutorService (scheduler)	Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.		ScheduledExecutorService
scheduler (scheduler)	To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler	none	Object
schedulerProperties (scheduler)	To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.		Map
startScheduler (scheduler)	Whether the scheduler should be auto started.	true	boolean
timeUnit (scheduler)	Time unit for initialDelay and delay options. There are 7 enums and the value can be one of: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS	MILLISECONDS	TimeUnit
useFixedDelay (scheduler)	Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.	true	boolean
accessToken (security)	OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.		String
clientSecret (security)	Client secret of the sheets application		String
refreshToken (security)	OAuth 2 refresh token. 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

Name

Description

Default

Type

applicationName (consumer)

Google sheets application name. Example would be camel-google-sheets/1.0

String

bridgeErrorHandler (consumer)

false

boolean

clientId (consumer)

Client ID of the sheets application

String

includeGridData (consumer)

True if grid data should be returned.

false

boolean

majorDimension (consumer)

Specifies the major dimension that results should use.. There are 3 enums and the value can be one of: ROWS, COLUMNS, DIMENSION_UNSPECIFIED

ROWS

String

maxResults (consumer)

Specify the maximum number of returned results. This will limit the number of rows in a returned value range data set or the number of returned value ranges in a batch request.

int

range (consumer)

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

String

scopes (consumer)

Specifies the level of permissions you want a sheets application to have to a user account. See https://developers.google.com/identity/protocols/googlescopes for more info.

List

sendEmptyMessageWhenIdle (consumer)

If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.

false

boolean

splitResults (consumer)

false

boolean

spreadsheetId (consumer)

Specifies the spreadsheet identifier that is used to identify the target to obtain.

String

valueRenderOption (consumer)

Determines how values should be rendered in the output. There are 3 enums and the value can be one of: FORMATTED_VALUE, UNFORMATTED_VALUE, FORMULA

FORMATTED_VALUE

String

exceptionHandler (consumer)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

ExceptionHandler

exchangePattern (consumer)

Sets the exchange pattern when the consumer creates an exchange. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut

ExchangePattern

pollStrategy (consumer)

A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.

PollingConsumerPollStrategy

basicPropertyBinding (advanced)

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

synchronous (advanced)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

boolean

backoffErrorThreshold (scheduler)

The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.

int

backoffIdleThreshold (scheduler)

The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.

int

backoffMultiplier (scheduler)

To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.

int

delay (scheduler)

Milliseconds before the next poll.

500

long

greedy (scheduler)

If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.

false

boolean

initialDelay (scheduler)

Milliseconds before the first poll starts.

1000

long

repeatCount (scheduler)

Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.

long

runLoggingLevel (scheduler)

The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF

TRACE

LoggingLevel

scheduledExecutorService (scheduler)

Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.

ScheduledExecutorService

scheduler (scheduler)

To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler

none

Object

schedulerProperties (scheduler)

To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.

Map

startScheduler (scheduler)

Whether the scheduler should be auto started.

true

boolean

timeUnit (scheduler)

Time unit for initialDelay and delay options. There are 7 enums and the value can be one of: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS

MILLISECONDS

TimeUnit

useFixedDelay (scheduler)

Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.

true

boolean

accessToken (security)

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

String

clientSecret (security)

Client secret of the sheets application

String

refreshToken (security)

OAuth 2 refresh token. 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

API Parameters (2 APIs):

The Google Sheets Stream endpoint is an API based component and has additional parameters based on which API name and API method is used. The API name and API method is located in the endpoint URI as the null path parameters:

google-sheets-stream:apiName

There are 2 API names as listed in the table below:

API Name	Type	Description
data	Consumer	The values collection of methods
spreadsheets	Consumer	The spreadsheets collection of methods

API Name

Type

Description

data

Consumer

The values collection of methods

spreadsheets

Consumer

The spreadsheets collection of methods

Each API is documented in the following sections to come.

API: data

Only consumer is supported

The data API has 10 method(s) which is represented by the following method signatures (an API method may have multiple signatures due to overloading):

com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.Append append(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ValueRange content);

com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchClear batchClear(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchClearValuesRequest content);

com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchClearByDataFilter batchClearByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchClearValuesByDataFilterRequest content);

com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchGet batchGet(String spreadsheetId);

com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchGetByDataFilter batchGetByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchGetValuesByDataFilterRequest content);

com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchUpdate batchUpdate(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateValuesRequest content);

com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.BatchUpdateByDataFilter batchUpdateByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateValuesByDataFilterRequest content);

com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.Clear clear(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ClearValuesRequest content);

com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.Get get(String spreadsheetId, String range);

com.google.api.services.sheets.v4.Sheets.Spreadsheets.Values.Update update(String spreadsheetId, String range, com.google.api.services.sheets.v4.model.ValueRange content);

The data API is defined in the syntax as follows:

google-sheets-stream:data/methodName?[parameters]

The 10 method(s) is listed in the table below. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)

Method	Alias	Description
append		Appends values to a spreadsheet
batchClear		Clears one or more ranges of values from a spreadsheet
batchClearByDataFilter		Clears one or more ranges of values from a spreadsheet
batchGet		Returns one or more ranges of values from a spreadsheet
batchGetByDataFilter		Returns one or more ranges of values that match the specified data filters
batchUpdate		Sets values in one or more ranges of a spreadsheet
batchUpdateByDataFilter		Sets values in one or more ranges of a spreadsheet
clear		Clears values from a spreadsheet
get		Returns a range of values from a spreadsheet
update		Sets values in a range of a spreadsheet

Method

Alias

Description

append

Appends values to a spreadsheet

batchClear

Clears one or more ranges of values from a spreadsheet

batchClearByDataFilter

Clears one or more ranges of values from a spreadsheet

batchGet

Returns one or more ranges of values from a spreadsheet

batchGetByDataFilter

Returns one or more ranges of values that match the specified data filters

batchUpdate

Sets values in one or more ranges of a spreadsheet

batchUpdateByDataFilter

Sets values in one or more ranges of a spreadsheet

clear

Clears values from a spreadsheet

get

Returns a range of values from a spreadsheet

update

Sets values in a range of a spreadsheet

The data API method(s) has the following set of parameters listed in the table below:

Method	Parameter	Description	Type
append	range	The A1 notation of a range to search for a logical table of data. Values will be appended after the last row of the table.	String
append	spreadsheetId	The ID of the spreadsheet to update	String
append	values	The com.google.api.services.sheets.v4.model.ValueRange	ValueRange
batchClear	batchClearValuesRequest	The com.google.api.services.sheets.v4.model.BatchClearValuesRequest	BatchClearValuesRequest
batchClear	spreadsheetId	The ID of the spreadsheet to update	String
batchClearByDataFilter	content	The com.google.api.services.sheets.v4.model.BatchClearValuesByDataFilterRequest	BatchClearValuesByDataFilterRequest
batchClearByDataFilter	spreadsheetId	The ID of the spreadsheet to update	String
batchGet	spreadsheetId	The ID of the spreadsheet to retrieve data from	String
batchGetByDataFilter	batchGetValuesByDataFilterRequest	The com.google.api.services.sheets.v4.model.BatchGetValuesByDataFilterRequest	BatchGetValuesByDataFilterRequest
batchGetByDataFilter	spreadsheetId	The ID of the spreadsheet to retrieve data from	String
batchUpdate	batchUpdateValuesRequest	The com.google.api.services.sheets.v4.model.BatchUpdateValuesRequest	BatchUpdateValuesRequest
batchUpdate	spreadsheetId	The ID of the spreadsheet to update	String
batchUpdateByDataFilter	batchUpdateValuesByDataFilterRequest	The com.google.api.services.sheets.v4.model.BatchUpdateValuesByDataFilterRequest	BatchUpdateValuesByDataFilterRequest
batchUpdateByDataFilter	spreadsheetId	The ID of the spreadsheet to update	String
clear	clearValuesRequest	The com.google.api.services.sheets.v4.model.ClearValuesRequest	ClearValuesRequest
clear	range	The A1 notation of the values to clear.	String
clear	spreadsheetId	The ID of the spreadsheet to update	String
get	range	The A1 notation of the values to retrieve.	String
get	spreadsheetId	The ID of the spreadsheet to retrieve data from	String
update	range	The A1 notation of the values to update.	String
update	spreadsheetId	The ID of the spreadsheet to update	String
update	values	The com.google.api.services.sheets.v4.model.ValueRange	ValueRange

Method

Parameter

Description

Type

append

range

The A1 notation of a range to search for a logical table of data. Values will be appended after the last row of the table.

String

append

spreadsheetId

The ID of the spreadsheet to update

String

append

values

The com.google.api.services.sheets.v4.model.ValueRange

ValueRange

batchClear

batchClearValuesRequest

The com.google.api.services.sheets.v4.model.BatchClearValuesRequest

BatchClearValuesRequest

batchClear

spreadsheetId

The ID of the spreadsheet to update

String

batchClearByDataFilter

content

The com.google.api.services.sheets.v4.model.BatchClearValuesByDataFilterRequest

BatchClearValuesByDataFilterRequest

batchClearByDataFilter

spreadsheetId

The ID of the spreadsheet to update

String

batchGet

spreadsheetId

The ID of the spreadsheet to retrieve data from

String

batchGetByDataFilter

batchGetValuesByDataFilterRequest

The com.google.api.services.sheets.v4.model.BatchGetValuesByDataFilterRequest

BatchGetValuesByDataFilterRequest

batchGetByDataFilter

spreadsheetId

The ID of the spreadsheet to retrieve data from

String

batchUpdate

batchUpdateValuesRequest

The com.google.api.services.sheets.v4.model.BatchUpdateValuesRequest

BatchUpdateValuesRequest

batchUpdate

spreadsheetId

The ID of the spreadsheet to update

String

batchUpdateByDataFilter

batchUpdateValuesByDataFilterRequest

The com.google.api.services.sheets.v4.model.BatchUpdateValuesByDataFilterRequest

BatchUpdateValuesByDataFilterRequest

batchUpdateByDataFilter

spreadsheetId

The ID of the spreadsheet to update

String

clear

clearValuesRequest

The com.google.api.services.sheets.v4.model.ClearValuesRequest

ClearValuesRequest

clear

range

The A1 notation of the values to clear.

String

clear

spreadsheetId

The ID of the spreadsheet to update

String

get

range

The A1 notation of the values to retrieve.

String

get

spreadsheetId

The ID of the spreadsheet to retrieve data from

String

update

range

The A1 notation of the values to update.

String

update

spreadsheetId

The ID of the spreadsheet to update

String

update

values

The com.google.api.services.sheets.v4.model.ValueRange

ValueRange

In addition to the parameters above, the data API can also use from the 34 endpoint query option which is listed in the Query Parameters section.

Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelGoogleSheetsStream.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelGoogleSheetsStream.myParameterNameHere header.

API: spreadsheets

Only consumer is supported

The spreadsheets API has 4 method(s) which is represented by the following method signatures (an API method may have multiple signatures due to overloading):

com.google.api.services.sheets.v4.Sheets.Spreadsheets.BatchUpdate batchUpdate(String spreadsheetId, com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetRequest content);

com.google.api.services.sheets.v4.Sheets.Spreadsheets.Create create(com.google.api.services.sheets.v4.model.Spreadsheet content);

com.google.api.services.sheets.v4.Sheets.Spreadsheets.Get get(String spreadsheetId);

com.google.api.services.sheets.v4.Sheets.Spreadsheets.GetByDataFilter getByDataFilter(String spreadsheetId, com.google.api.services.sheets.v4.model.GetSpreadsheetByDataFilterRequest content);

The spreadsheets API is defined in the syntax as follows:

google-sheets-stream:spreadsheets/methodName?[parameters]

The 4 method(s) is listed in the table below. (API methods can have a shorthand alias name which can be used in the syntax instead of the name)

Method	Alias	Description
batchUpdate		Applies one or more updates to the spreadsheet
create		Creates a spreadsheet, returning the newly created spreadsheet
get		Returns the spreadsheet at the given ID
getByDataFilter		Returns the spreadsheet at the given ID

Method

Alias

Description

batchUpdate

Applies one or more updates to the spreadsheet

create

Creates a spreadsheet, returning the newly created spreadsheet

get

Returns the spreadsheet at the given ID

getByDataFilter

Returns the spreadsheet at the given ID

The spreadsheets API method(s) has the following set of parameters listed in the table below:

Method	Parameter	Description	Type
batchUpdate	batchUpdateSpreadsheetRequest	The com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetRequest	BatchUpdateSpreadsheetRequest
batchUpdate	spreadsheetId	The spreadsheet to apply the updates to	String
create	content	The com.google.api.services.sheets.v4.model.Spreadsheet	Spreadsheet
get	spreadsheetId	The spreadsheet to request	String
getByDataFilter	getSpreadsheetByDataFilterRequest	The com.google.api.services.sheets.v4.model.GetSpreadsheetByDataFilterRequest	GetSpreadsheetByDataFilterRequest
getByDataFilter	spreadsheetId	The spreadsheet to request	String

Method

Parameter

Description

Type

batchUpdate

batchUpdateSpreadsheetRequest

The com.google.api.services.sheets.v4.model.BatchUpdateSpreadsheetRequest

BatchUpdateSpreadsheetRequest

batchUpdate

spreadsheetId

The spreadsheet to apply the updates to

String

create

content

The com.google.api.services.sheets.v4.model.Spreadsheet

Spreadsheet

get

spreadsheetId

The spreadsheet to request

String

getByDataFilter

getSpreadsheetByDataFilterRequest

The com.google.api.services.sheets.v4.model.GetSpreadsheetByDataFilterRequest

GetSpreadsheetByDataFilterRequest

getByDataFilter

spreadsheetId

The spreadsheet to request

String

In addition to the parameters above, the spreadsheets API can also use from the 34 endpoint query option which is listed in the Query Parameters section.

More information

For more information on the endpoints and options see API documentation at: https://developers.google.com/sheets/api/reference/rest/

Spring Boot Auto-Configuration

When using google-sheets with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-google-sheets-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 30 options, which are listed below.

Name	Description	Default	Type
camel.component.google-sheets-stream.access-token	OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.		String
camel.component.google-sheets-stream.application-name	Google sheets application name. Example would be camel-google-sheets/1.0		String
camel.component.google-sheets-stream.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.google-sheets-stream.bridge-error-handler	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.	false	Boolean
camel.component.google-sheets-stream.client-factory	To use the GoogleSheetsClientFactory as factory for creating the client. Will by default use BatchGoogleSheetsClientFactory. The option is a org.apache.camel.component.google.sheets.GoogleSheetsClientFactory type.		GoogleSheetsClientFactory
camel.component.google-sheets-stream.client-id	Client ID of the sheets application		String
camel.component.google-sheets-stream.client-secret	Client secret of the sheets application		String
camel.component.google-sheets-stream.configuration	To use the shared configuration. The option is a org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration type.		GoogleSheetsStreamConfiguration
camel.component.google-sheets-stream.enabled	Whether to enable auto configuration of the google-sheets-stream component. This is enabled by default.		Boolean
camel.component.google-sheets-stream.include-grid-data	True if grid data should be returned.	false	Boolean
camel.component.google-sheets-stream.major-dimension	Specifies the major dimension that results should use..	ROWS	String
camel.component.google-sheets-stream.max-results	Specify the maximum number of returned results. This will limit the number of rows in a returned value range data set or the number of returned value ranges in a batch request.		Integer
camel.component.google-sheets-stream.range	Specifies the range of rows and columns in a sheet to get data from.		String
camel.component.google-sheets-stream.refresh-token	OAuth 2 refresh token. 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
camel.component.google-sheets-stream.scopes	Specifies the level of permissions you want a sheets application to have to a user account. See https://developers.google.com/identity/protocols/googlescopes for more info.		List
camel.component.google-sheets-stream.split-results	True if value range result should be split into rows or columns to process each of them individually. When true each row or column is represented with a separate exchange in batch processing. Otherwise value range object is used as exchange junk size.	false	Boolean
camel.component.google-sheets-stream.spreadsheet-id	Specifies the spreadsheet identifier that is used to identify the target to obtain.		String
camel.component.google-sheets-stream.value-render-option	Determines how values should be rendered in the output.	FORMATTED_VALUE	String
camel.component.google-sheets.access-token	OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.		String
camel.component.google-sheets.application-name	Google Sheets application name. Example would be camel-google-sheets/1.0		String
camel.component.google-sheets.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.google-sheets.bridge-error-handler	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.	false	Boolean
camel.component.google-sheets.client-factory	To use the GoogleSheetsClientFactory as factory for creating the client. Will by default use BatchGoogleSheetsClientFactory. The option is a org.apache.camel.component.google.sheets.GoogleSheetsClientFactory type.		GoogleSheetsClientFactory
camel.component.google-sheets.client-id	Client ID of the sheets application		String
camel.component.google-sheets.client-secret	Client secret of the sheets application		String
camel.component.google-sheets.configuration	To use the shared configuration. The option is a org.apache.camel.component.google.sheets.GoogleSheetsConfiguration type.		GoogleSheetsConfiguration
camel.component.google-sheets.enabled	Whether to enable auto configuration of the google-sheets component. This is enabled by default.		Boolean
camel.component.google-sheets.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean
camel.component.google-sheets.refresh-token	OAuth 2 refresh token. Using this, the Google Sheets component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived.		String
camel.component.google-sheets.split-result	When consumer return an array or collection this will generate one exchange per element, and their routes will be executed once for each exchange. Set this value to false to use a single exchange for the entire list or array.	true	Boolean

Name

Description

Default

Type

camel.component.google-sheets-stream.access-token

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

String

camel.component.google-sheets-stream.application-name

Google sheets application name. Example would be camel-google-sheets/1.0

String

camel.component.google-sheets-stream.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.google-sheets-stream.bridge-error-handler

false

Boolean

camel.component.google-sheets-stream.client-factory

To use the GoogleSheetsClientFactory as factory for creating the client. Will by default use BatchGoogleSheetsClientFactory. The option is a org.apache.camel.component.google.sheets.GoogleSheetsClientFactory type.

GoogleSheetsClientFactory

camel.component.google-sheets-stream.client-id

Client ID of the sheets application

String

camel.component.google-sheets-stream.client-secret

Client secret of the sheets application

String

camel.component.google-sheets-stream.configuration

To use the shared configuration. The option is a org.apache.camel.component.google.sheets.stream.GoogleSheetsStreamConfiguration type.

GoogleSheetsStreamConfiguration

camel.component.google-sheets-stream.enabled

Whether to enable auto configuration of the google-sheets-stream component. This is enabled by default.

Boolean

camel.component.google-sheets-stream.include-grid-data

True if grid data should be returned.

false

Boolean

camel.component.google-sheets-stream.major-dimension

Specifies the major dimension that results should use..

ROWS

String

camel.component.google-sheets-stream.max-results

Specify the maximum number of returned results. This will limit the number of rows in a returned value range data set or the number of returned value ranges in a batch request.

Integer

camel.component.google-sheets-stream.range

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

String

camel.component.google-sheets-stream.refresh-token

OAuth 2 refresh token. 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

camel.component.google-sheets-stream.scopes

Specifies the level of permissions you want a sheets application to have to a user account. See https://developers.google.com/identity/protocols/googlescopes for more info.

List

camel.component.google-sheets-stream.split-results

false

Boolean

camel.component.google-sheets-stream.spreadsheet-id

Specifies the spreadsheet identifier that is used to identify the target to obtain.

String

camel.component.google-sheets-stream.value-render-option

Determines how values should be rendered in the output.

FORMATTED_VALUE

String

camel.component.google-sheets.access-token

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

String

camel.component.google-sheets.application-name

Google Sheets application name. Example would be camel-google-sheets/1.0

String

camel.component.google-sheets.autowired-enabled

true

Boolean

camel.component.google-sheets.bridge-error-handler

false

Boolean

camel.component.google-sheets.client-factory

GoogleSheetsClientFactory

camel.component.google-sheets.client-id

Client ID of the sheets application

String

camel.component.google-sheets.client-secret

Client secret of the sheets application

String

camel.component.google-sheets.configuration

To use the shared configuration. The option is a org.apache.camel.component.google.sheets.GoogleSheetsConfiguration type.

GoogleSheetsConfiguration

camel.component.google-sheets.enabled

Whether to enable auto configuration of the google-sheets component. This is enabled by default.

Boolean

camel.component.google-sheets.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.google-sheets.refresh-token

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

String

camel.component.google-sheets.split-result

When consumer return an array or collection this will generate one exchange per element, and their routes will be executed once for each exchange. Set this value to false to use a single exchange for the entire list or array.

true

Boolean