Google Sheets: Read from Sheet¶
Plugin ID: eca_google_sheets_read_sheet
Available since: 1.0.0
Reads data from a Google Sheet and makes it available as ECA tokens. Specify the sheet range to read specific cells or rows. Supports token replacement for dynamic sheet access.
Fields¶
Authentication Type— config key:auth_type-
Choose between API Client (OAuth2) or Service Account authentication.
Type:
select· Required: yes · Default:api_clientAllowed values:
api_client,service_account Authentication Source— config key:auth_from-
Choose whether to select authentication directly or use a token for dynamic selection.
Type:
select· Required: yes · Default:directAllowed values:
direct,token API Client— config key:api_client_id-
Search and select an API Client for OAuth2 authentication.
Type:
textfield· Required: no · Default: empty string Service Account— config key:service_account_id-
Search and select a Service Account for server-to-server authentication.
Type:
textfield· Required: no · Default: empty string Client ID from Token— config key:auth_client_from_token-
Token that resolves to a client ID (e.g., [user:field_google_client_id]). The token should contain just the client ID, not the auth type prefix.
This field supports tokens.Type:
textfield· Required: no · Default: empty string Spreadsheet ID— config key:spreadsheet_id-
The Google Spreadsheet ID (from the URL). Supports token replacement.
This field supports tokens.Type:
textfield· Required: yes · Default: empty string Sheet Range— config key:sheet_range-
The sheet name or range (e.g., "Sheet1", "Data!A1:C1"). Supports token replacement.
This field supports tokens.Type:
textfield· Required: yes · Default:Sheet1 Token Name— config key:token_name-
Name for the token that will contain the sheet data. Access data using Google Sheets syntax: [token:Row1:Col1] for first row/column, [token:Row2:Col3] for second row/third column.
Type:
textfield· Required: yes · Default:sheet_data Headers Token Name— config key:headers_token_name-
Optional token name for the header row data. Leave blank to skip creating this token.
Type:
textfield· Required: no · Default: empty string Count Token Name— config key:count_token_name-
Optional token name for the row count. Leave blank to skip creating this token.
Type:
textfield· Required: no · Default: empty string Skip Header Row— config key:skip_header_row-
If checked, the first row will be removed from the returned data (useful when the first row contains column headers).
Type:
checkbox· Required: no · Default:false Use Header Row as Keys— config key:use_header_as_keys-
If checked, the first row will be used as keys for each data row, making it easier to access columns by name (e.g., [sheet_data:Row1:Name] instead of [sheet_data:Row1:Col1]).
Type:
checkbox· Required: no · Default:false