nodes/generated

Interface GoogleSheetsV1NodeParameters

Source


interface GoogleSheetsV1NodeParameters {
    authentication?: "oAuth2" | "serviceAccount";
    dataProperty?: string;
    dataStartRow?: number;
    id?: string;
    key?: string;
    keyRow?: number;
    lookupColumn?: string;
    lookupValue?: string;
    operation?:
        | "create"
        | "update"
        | "remove"
        | "delete"
        | "append"
        | "read"
        | "upsert"
        | "clear"
        | "lookup";
    options?: | {
        continue?: boolean;
        returnAllMatches?: boolean;
        usePathForKeyRow?: boolean;
        valueInputMode?: "RAW"
        | "USER_ENTERED";
        valueRenderMode?:
            | "UNFORMATTED_VALUE"
            | "FORMATTED_VALUE"
            | "FORMULA";
    }
    | {
        autoRecalc?: ""
        | "ON_CHANGE"
        | "MINUTE"
        | "HOUR";
        locale?: string;
    }
    | {
        gridProperties?: {
            columnCount?: number;
            columnGroupControlAfter?: boolean;
            frozenColumnCount?: number;
            frozenRowCount?: number;
            hideGridlines?: boolean;
            rowCount?: number;
            rowGroupControlAfter?: boolean;
        };
        hidden?: boolean;
        index?: number;
        rightToLeft?: boolean;
        sheetId?: number;
        tabColor?: string;
        title?: string;
    };
    range?: string;
    rawData?: boolean;
    resource?: "spreadsheet"
    | "sheet";
    sheetId?: string;
    sheetsUi?: {
        sheetValues: {
            propertiesUi?: {
                hidden?: boolean;
                title?: string;
            };
        }[];
    };
    simple?: boolean;
    title?: string;
    toDelete?: {
        columns: {
            amount?: number;
            sheetId: string;
            startIndex?: number;
        }[];
        rows: {
            amount?: number;
            sheetId: string;
            startIndex?: number;
        }[];
    };
}

Properties§

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

Default: "serviceAccount"

§readonly dataProperty?: string

The name of the property into which to write the RAW data Default: "data"

§readonly dataStartRow?: number

Index of the first row which contains the actual data and not the keys. Starts with 0. Default: 1 Type options: {"minValue":1}

§readonly id?: string

The ID of the sheet to delete

§readonly key?: string

The name of the key to identify which data should be updated in the sheet Default: "id"

§readonly keyRow?: number

Index of the row which contains the keys. Starts at 0. The incoming node data is matched to the keys for assignment. The matching is case sensitive. Type options: {"minValue":0}

§readonly lookupColumn?: string

The name of the column in which to look for value

§readonly lookupValue?: string

The value to look for in column

§readonly operation?:
    | "create"
    | "update"
    | "remove"
    | "delete"
    | "append"
    | "read"
    | "upsert"
    | "clear"
    | "lookup"

Default: "read"

§readonly options?:
    | {
        continue?: boolean;
        returnAllMatches?: boolean;
        usePathForKeyRow?: boolean;
        valueInputMode?: "RAW"
        | "USER_ENTERED";
        valueRenderMode?:
            | "UNFORMATTED_VALUE"
            | "FORMATTED_VALUE"
            | "FORMULA";
    }
    | {
        autoRecalc?: ""
        | "ON_CHANGE"
        | "MINUTE"
        | "HOUR";
        locale?: string;
    }
    | {
        gridProperties?: {
            columnCount?: number;
            columnGroupControlAfter?: boolean;
            frozenColumnCount?: number;
            frozenRowCount?: number;
            hideGridlines?: boolean;
            rowCount?: number;
            rowGroupControlAfter?: boolean;
        };
        hidden?: boolean;
        index?: number;
        rightToLeft?: boolean;
        sheetId?: number;
        tabColor?: string;
        title?: 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 rawData?: boolean

Whether the data should be returned RAW instead of parsed into keys according to their header

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

Default: "sheet"

§readonly sheetId?: string

The ID of the Google Spreadsheet. Found as part of the sheet URL https://docs.google.com/spreadsheets/d/{ID}/.

§readonly sheetsUi?: { ... }

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

§readonly simple?: boolean

Whether to return a simplified version of the response instead of the raw data Default: true

§readonly title?: string

The title of the spreadsheet

§readonly toDelete?: { ... }

Deletes columns and rows from a sheet Default: {} Type options: {"multipleValues":true}