nodes/generated

Interface GoogleSheetsV2NodeParameters

Source


interface GoogleSheetsV2NodeParameters {
    authentication?: "oAuth2" | "serviceAccount";
    clear?:
        | "wholeSheet"
        | "specificRows"
        | "specificColumns"
        | "specificRange";
    columnsToDelete?: number;
    columnToMatchOn?: string;
    combineFilters?: "AND"
    | "OR";
    dataMode?:
        | "autoMapInputData"
        | "defineBelow"
        | "nothing";
    documentId?: {
        mode: "id"
        | "list"
        | "url";
        value: string;
    };
    fieldsUi?: | {
        fieldValues: {
            fieldId?: string;
            fieldValue?: string;
        }[];
    }
    | {
        values: {
            column?: string;
            columnName?: string;
            fieldValue?: string;
        }[];
    };
    filtersUI?: {
        values: {
            lookupColumn?: string;
            lookupValue?: string;
        }[];
    };
    keepFirstRow?: boolean;
    numberToDelete?: number;
    operation?: | "create"
    | "update"
    | "remove"
    | "delete"
    | "append"
    | "read"
    | "clear"
    | "appendOrUpdate"
    | "deleteSpreadsheet";
    options?: | {
        cellFormat?: "RAW"
        | "USER_ENTERED";
        handlingExtraData?:
            | "insertInNewColumn"
            | "ignoreIt"
            | "error";
        locationDefine?: { values: { headerRow?: number } };
        useAppend?: boolean;
    }
    | {
        hidden?: boolean;
        index?: number;
        rightToLeft?: boolean;
        sheetId?: number;
        tabColor?: string;
    }
    | {
        dataLocationOnSheet?: {
            values: {
                firstDataRow?: number;
                headerRow?: number;
                range?: string;
                rangeDefinition?: | "specifyRangeA1"
                | "specifyRange"
                | "detectAutomatically";
                readRowsUntil?: "firstEmptyRow"
                | "lastRowInSheet";
            };
        };
        outputFormatting?: {
            values: {
                date?: "SERIAL_NUMBER"
                | "FORMATTED_STRING";
                general?:
                    | "UNFORMATTED_VALUE"
                    | "FORMATTED_VALUE"
                    | "FORMULA";
            };
        };
        returnAllMatches?: | "returnFirstMatch"
        | "returnAllMatches";
        returnFirstMatch?: boolean;
    }
    | {
        cellFormat?: "RAW"
        | "USER_ENTERED";
        handlingExtraData?:
            | "insertInNewColumn"
            | "ignoreIt"
            | "error";
        locationDefine?: {
            values: {
                firstDataRow?: number;
                headerRow?: number;
            };
        };
    }
    | {
        cellFormat?: "RAW"
        | "USER_ENTERED";
        handlingExtraData?:
            | "insertInNewColumn"
            | "ignoreIt"
            | "error";
        locationDefine?: {
            values: {
                firstDataRow?: number;
                headerRow?: number;
            };
        };
        useAppend?: boolean;
    }
    | {
        autoRecalc?: ""
        | "ON_CHANGE"
        | "MINUTE"
        | "HOUR";
        locale?: string;
    };
    range?: string;
    resource?: "spreadsheet"
    | "sheet";
    rowsToDelete?: number;
    sheetName?: {
        mode: "id" | "list" | "url" | "name";
        value: string;
    };
    sheetsUi?: {
        sheetValues: { hidden?: boolean; title?: string }[];
    };
    startIndex?: string
    | number;
    title?: string;
    toDelete?: "rows" | "columns";
    valueToMatchOn?: string;
}

Properties§

§readonly authentication?: "oAuth2" | "serviceAccount"

Default: "oAuth2"

§readonly clear?:
    | "wholeSheet"
    | "specificRows"
    | "specificColumns"
    | "specificRange"

What to clear Default: "wholeSheet"

§readonly columnsToDelete?: number

Default: 1 Type options: {"minValue":1}

§readonly columnToMatchOn?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsDependsOn":["sheetName.value"],"loadOptionsMethod":"getSheetHeaderRowAndSkipEmpty"}

§readonly combineFilters?: "AND" | "OR"

How to combine the conditions defined in "Filters": AND requires all conditions to be true, OR requires at least one condition to be true Default: "OR"

§readonly dataMode?: "autoMapInputData" | "defineBelow" | "nothing"

Whether to insert the input data this node receives in the new row Default: "defineBelow"

§readonly documentId?: { ... }

Default: {"mode":"list","value":""}

§readonly fieldsUi?:
    | {
        fieldValues: {
            fieldId?: string;
            fieldValue?: string;
        }[];
    }
    | {
        values: {
            column?: string;
            columnName?: string;
            fieldValue?: string;
        }[];
    }

Default: {} Type options: {"multipleValueButtonText":"Add Field to Send","multipleValues":true}

§readonly filtersUI?: { ... }

Default: {} Type options: {"multipleValueButtonText":"Add Filter","multipleValues":true}

§readonly keepFirstRow?: boolean
§readonly numberToDelete?: number

Default: 1 Type options: {"minValue":1}

§readonly operation?:
    | "create"
    | "update"
    | "remove"
    | "delete"
    | "append"
    | "read"
    | "clear"
    | "appendOrUpdate"
    | "deleteSpreadsheet"

Default: "read"

§readonly options?:
    | {
        cellFormat?: "RAW"
        | "USER_ENTERED";
        handlingExtraData?:
            | "insertInNewColumn"
            | "ignoreIt"
            | "error";
        locationDefine?: { values: { headerRow?: number } };
        useAppend?: boolean;
    }
    | {
        hidden?: boolean;
        index?: number;
        rightToLeft?: boolean;
        sheetId?: number;
        tabColor?: string;
    }
    | {
        dataLocationOnSheet?: {
            values: {
                firstDataRow?: number;
                headerRow?: number;
                range?: string;
                rangeDefinition?: | "specifyRangeA1"
                | "specifyRange"
                | "detectAutomatically";
                readRowsUntil?: "firstEmptyRow"
                | "lastRowInSheet";
            };
        };
        outputFormatting?: {
            values: {
                date?: "SERIAL_NUMBER"
                | "FORMATTED_STRING";
                general?:
                    | "UNFORMATTED_VALUE"
                    | "FORMATTED_VALUE"
                    | "FORMULA";
            };
        };
        returnAllMatches?: | "returnFirstMatch"
        | "returnAllMatches";
        returnFirstMatch?: boolean;
    }
    | {
        cellFormat?: "RAW"
        | "USER_ENTERED";
        handlingExtraData?:
            | "insertInNewColumn"
            | "ignoreIt"
            | "error";
        locationDefine?: {
            values: {
                firstDataRow?: number;
                headerRow?: number;
            };
        };
    }
    | {
        cellFormat?: "RAW"
        | "USER_ENTERED";
        handlingExtraData?:
            | "insertInNewColumn"
            | "ignoreIt"
            | "error";
        locationDefine?: {
            values: {
                firstDataRow?: number;
                headerRow?: number;
            };
        };
        useAppend?: boolean;
    }
    | {
        autoRecalc?: ""
        | "ON_CHANGE"
        | "MINUTE"
        | "HOUR";
        locale?: string;
    }

Default: {}

§readonly range?: string

The table range to read from or to append data to. See the Google documentation for the details. If it contains multiple sheets it can also be added like this: "MySheet!A:F" Default: "A:F"

§readonly resource?: "spreadsheet" | "sheet"

Default: "sheet"

§readonly rowsToDelete?: number

Default: 1 Type options: {"minValue":1}

§readonly sheetName?: { ... }

Default: {"mode":"list","value":""} Type options: {"loadOptionsDependsOn":["documentId.value"]}

§readonly sheetsUi?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly startIndex?: string | number

The row number to delete from, The first row is 1 Default: 1 Type options: {"minValue":1}

§readonly title?: string

The name of the sheet Default: "n8n-sheet"

§readonly toDelete?: "rows" | "columns"

What to delete Default: "rows"

§readonly valueToMatchOn?: string