Adapter properties and commands

Specifies the file with the private key of the GCP service account used to access the Google Sheets API service. It is the reference to the private key file of the GCP service account used to establish the Google Sheets connection.

The corresponding adapter command is -CF (or -CREDENTIALSFILE).

Specifies the name of the folder that contains the spreadsheet to access.

The corresponding adapter command is -F (or -FOLDER).

Specifies the name of the spreadsheet to access. The Fetch button displayed next to the property can be used to retrieve the list of all spreadsheets in a folder (if the folder is not specified, a list of all spreadsheets in up to 10 folders), and a selection can be made from the list. Alternatively, you can type the name manually.

The corresponding adapter command is -SP (or -SPREADSHEET).

Specifies the A1 notation or R1C1 notation of the range to access in the spreadsheet.

• A1 notation

  A1 notation is a syntax used to define a cell or range of cells with a string that contains the sheet name plus the starting and ending cell coordinates using column letters and row numbers. This method is the most common and useful when referencing an absolute range of cells.

  For example:

  • Sheet1!A1:B2

    Refers to all the cells in the first two rows and columns of Sheet1.

  • Sheet1!A:A

    Refers to all the cells in the first column of Sheet1.

  • Sheet1!1:2

    Refers to all the cells in the first two rows of Sheet1.

  • Sheet1!A5:A

    Refers to all the cells of the first column of Sheet 1, from row 5 onward.

  • A1:B2

    Refers to all the cells in the first two rows and columns of the first visible sheet.

  • Sheet1

    Refers to all the cells in Sheet1.

• R1C1 notation

  R1C1 notation is a syntax used to define a cell or range of cells with a string that contains the sheet name and the starting and ending cell coordinates using row numbers and column numbers.

  For example:

  • Sheet1!R1C1:R2C2

    Refers to the first two cells in the top two rows of Sheet1.

  • R1C1:R2C2

    Refers to the first two cells in the top two rows of the first visible sheet.

The corresponding adapter command is -R (or -RANGE).

Specifies whether the Spreadsheet Range includes a header. If true, the first row will be used as column names of the generated schema and will not be displayed in the output data. Otherwise, the column names of the generated schema will be Field1, Field2, Field3, and so on.

The corresponding adapter command is -H (or -HEADER).

Specifies the number of rows to analyze when determining the data structure, to generate a schema. The default value is 100.

The corresponding adapter command is -SS (or -SAMPLESIZE).

Specifies the settings for the adapter log severity, append mode, and file location. This property, along with its two sub-properties Append Log and Log File Name, is used to enable logging at the adapter level. When enabled, the adapter logs messages with details about the operations it is performing on the Google Sheets API service. The default logging level is Info.

The corresponding adapter command is -T[V|E][+] [log_file] (or -TRACE[V|E][+] [log_file]).

-T (or -TRACE) -> The level Info is used to log informational level messages.

-TE (or -TRACEE) -> The level Error can be specified to enable logging of error level messages only.

-TV (or -TRACEV) -> The level Verbose can be used to enable logging of all messages.

+ -> The sub-property Append Log can be set to instruct the adapter to append messages to the log file if the log file exists already, instead of overwriting it, which is the default option.

log_file -> The sub-property Log File Name can be used to specify the file name for the log file. By default, the log file name is m4gsheets.mtr and the file is created in the current map directory.

The corresponding adapter command is -RM (or -READMODE).