Google Apps Script API
    Preparing search index...

    Interface Spreadsheet

    Access and modify Google Sheets files. Common operations are adding new sheets and adding collaborators.

    interface Spreadsheet {
        addDeveloperMetadata(
            key: string,
        ): GoogleAppsScript.Spreadsheet.Spreadsheet;
        addDeveloperMetadata(
            key: string,
            visibility: DeveloperMetadataVisibility,
        ): GoogleAppsScript.Spreadsheet.Spreadsheet;
        addDeveloperMetadata(
            key: string,
            value: string,
        ): GoogleAppsScript.Spreadsheet.Spreadsheet;
        addDeveloperMetadata(
            key: string,
            value: string,
            visibility: DeveloperMetadataVisibility,
        ): GoogleAppsScript.Spreadsheet.Spreadsheet;
        addEditor(emailAddress: string): GoogleAppsScript.Spreadsheet.Spreadsheet;
        addEditor(
            user: GoogleAppsScript.Base.User,
        ): GoogleAppsScript.Spreadsheet.Spreadsheet;
        addEditors(
            emailAddresses: string[],
        ): GoogleAppsScript.Spreadsheet.Spreadsheet;
        addMenu(
            name: string,
            subMenus: { functionName: string; name: string }[],
        ): void;
        addViewer(emailAddress: string): GoogleAppsScript.Spreadsheet.Spreadsheet;
        addViewer(
            user: GoogleAppsScript.Base.User,
        ): GoogleAppsScript.Spreadsheet.Spreadsheet;
        addViewers(
            emailAddresses: string[],
        ): GoogleAppsScript.Spreadsheet.Spreadsheet;
        appendRow(rowContents: any[]): GoogleAppsScript.Spreadsheet.Sheet;
        autoResizeColumn(
            columnPosition: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        copy(name: string): GoogleAppsScript.Spreadsheet.Spreadsheet;
        createDeveloperMetadataFinder(): DeveloperMetadataFinder;
        createTextFinder(findText: string): TextFinder;
        deleteActiveSheet(): GoogleAppsScript.Spreadsheet.Sheet;
        deleteColumn(columnPosition: number): GoogleAppsScript.Spreadsheet.Sheet;
        deleteColumns(columnPosition: number, howMany: number): void;
        deleteRow(rowPosition: number): GoogleAppsScript.Spreadsheet.Sheet;
        deleteRows(rowPosition: number, howMany: number): void;
        deleteSheet(sheet: GoogleAppsScript.Spreadsheet.Sheet): void;
        duplicateActiveSheet(): GoogleAppsScript.Spreadsheet.Sheet;
        getActiveCell(): GoogleAppsScript.Spreadsheet.Range;
        getActiveRange(): GoogleAppsScript.Spreadsheet.Range;
        getActiveRangeList(): RangeList;
        getActiveSheet(): GoogleAppsScript.Spreadsheet.Sheet;
        getAs(contentType: string): Blob;
        getBandings(): Banding[];
        getBlob(): Blob;
        getColumnWidth(columnPosition: number): number;
        getCurrentCell(): GoogleAppsScript.Spreadsheet.Range;
        getDataRange(): GoogleAppsScript.Spreadsheet.Range;
        getDataSourceTables(): DataSourceTable[];
        getDeveloperMetadata(): GoogleAppsScript.Spreadsheet.DeveloperMetadata[];
        getEditors(): GoogleAppsScript.Base.User[];
        getFormUrl(): string;
        getFrozenColumns(): number;
        getFrozenRows(): number;
        getId(): string;
        getImages(): OverGridImage[];
        getIterativeCalculationConvergenceThreshold(): number;
        getLastColumn(): number;
        getLastRow(): number;
        getMaxIterativeCalculationCycles(): number;
        getName(): string;
        getNamedRanges(): GoogleAppsScript.Spreadsheet.NamedRange[];
        getNumSheets(): number;
        getOwner(): GoogleAppsScript.Base.User;
        getPredefinedSpreadsheetThemes(): SpreadsheetTheme[];
        getProtections(type: ProtectionType): Protection[];
        getRange(a1Notation: string): GoogleAppsScript.Spreadsheet.Range;
        getRangeByName(name: string): GoogleAppsScript.Spreadsheet.Range;
        getRangeList(a1Notations: string[]): RangeList;
        getRecalculationInterval(): RecalculationInterval;
        getRowHeight(rowPosition: number): number;
        getSelection(): GoogleAppsScript.Spreadsheet.Selection;
        getSheetById(id: number): GoogleAppsScript.Spreadsheet.Sheet;
        getSheetByName(name: string): GoogleAppsScript.Spreadsheet.Sheet;
        getSheetId(): number;
        getSheetName(): string;
        getSheetProtection(): PageProtection;
        getSheets(): GoogleAppsScript.Spreadsheet.Sheet[];
        getSheetValues(
            startRow: number,
            startColumn: number,
            numRows: number,
            numColumns: number,
        ): any[][];
        getSpreadsheetLocale(): string;
        getSpreadsheetTheme(): SpreadsheetTheme;
        getSpreadsheetTimeZone(): string;
        getUrl(): string;
        getViewers(): GoogleAppsScript.Base.User[];
        hideColumn(column: GoogleAppsScript.Spreadsheet.Range): void;
        hideRow(row: GoogleAppsScript.Spreadsheet.Range): void;
        insertColumnAfter(
            afterPosition: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        insertColumnBefore(
            beforePosition: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        insertColumnsAfter(
            afterPosition: number,
            howMany: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        insertColumnsBefore(
            beforePosition: number,
            howMany: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        insertImage(
            blobSource: BlobSource,
            column: number,
            row: number,
        ): OverGridImage;
        insertImage(
            blobSource: BlobSource,
            column: number,
            row: number,
            offsetX: number,
            offsetY: number,
        ): OverGridImage;
        insertImage(url: string, column: number, row: number): OverGridImage;
        insertImage(
            url: string,
            column: number,
            row: number,
            offsetX: number,
            offsetY: number,
        ): OverGridImage;
        insertRowAfter(afterPosition: number): GoogleAppsScript.Spreadsheet.Sheet;
        insertRowBefore(beforePosition: number): GoogleAppsScript.Spreadsheet.Sheet;
        insertRowsAfter(
            afterPosition: number,
            howMany: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        insertRowsBefore(
            beforePosition: number,
            howMany: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        insertSheet(): GoogleAppsScript.Spreadsheet.Sheet;
        insertSheet(sheetIndex: number): GoogleAppsScript.Spreadsheet.Sheet;
        insertSheet(
            sheetIndex: number,
            options: { template?: GoogleAppsScript.Spreadsheet.Sheet },
        ): GoogleAppsScript.Spreadsheet.Sheet;
        insertSheet(
            options: { template?: GoogleAppsScript.Spreadsheet.Sheet },
        ): GoogleAppsScript.Spreadsheet.Sheet;
        insertSheet(sheetName: string): GoogleAppsScript.Spreadsheet.Sheet;
        insertSheet(
            sheetName: string,
            sheetIndex: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        insertSheet(
            sheetName: string,
            sheetIndex: number,
            options: { template?: GoogleAppsScript.Spreadsheet.Sheet },
        ): GoogleAppsScript.Spreadsheet.Sheet;
        insertSheet(
            sheetName: string,
            options: { template?: GoogleAppsScript.Spreadsheet.Sheet },
        ): GoogleAppsScript.Spreadsheet.Sheet;
        insertSheetWithDataSourceTable(
            spec: DataSourceSpec,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        isAnonymousView(): boolean;
        isAnonymousWrite(): boolean;
        isColumnHiddenByUser(columnPosition: number): boolean;
        isIterativeCalculationEnabled(): boolean;
        isRowHiddenByFilter(rowPosition: number): boolean;
        isRowHiddenByUser(rowPosition: number): boolean;
        moveActiveSheet(pos: number): void;
        moveChartToObjectSheet(
            chart: GoogleAppsScript.Spreadsheet.EmbeddedChart,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        removeEditor(
            emailAddress: string,
        ): GoogleAppsScript.Spreadsheet.Spreadsheet;
        removeEditor(
            user: GoogleAppsScript.Base.User,
        ): GoogleAppsScript.Spreadsheet.Spreadsheet;
        removeMenu(name: string): void;
        removeNamedRange(name: string): void;
        removeViewer(
            emailAddress: string,
        ): GoogleAppsScript.Spreadsheet.Spreadsheet;
        removeViewer(
            user: GoogleAppsScript.Base.User,
        ): GoogleAppsScript.Spreadsheet.Spreadsheet;
        rename(newName: string): void;
        renameActiveSheet(newName: string): void;
        resetSpreadsheetTheme(): SpreadsheetTheme;
        setActiveRange(
            range: GoogleAppsScript.Spreadsheet.Range,
        ): GoogleAppsScript.Spreadsheet.Range;
        setActiveRangeList(rangeList: RangeList): RangeList;
        setActiveSelection(
            range: GoogleAppsScript.Spreadsheet.Range,
        ): GoogleAppsScript.Spreadsheet.Range;
        setActiveSelection(a1Notation: string): GoogleAppsScript.Spreadsheet.Range;
        setActiveSheet(
            sheet: GoogleAppsScript.Spreadsheet.Sheet,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        setActiveSheet(
            sheet: GoogleAppsScript.Spreadsheet.Sheet,
            restoreSelection: boolean,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        setAnonymousAccess(
            anonymousReadAllowed: boolean,
            anonymousWriteAllowed: boolean,
        ): void;
        setColumnWidth(
            columnPosition: number,
            width: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        setCurrentCell(
            cell: GoogleAppsScript.Spreadsheet.Range,
        ): GoogleAppsScript.Spreadsheet.Range;
        setFrozenColumns(columns: number): void;
        setFrozenRows(rows: number): void;
        setIterativeCalculationConvergenceThreshold(
            minThreshold: number,
        ): GoogleAppsScript.Spreadsheet.Spreadsheet;
        setIterativeCalculationEnabled(
            isEnabled: boolean,
        ): GoogleAppsScript.Spreadsheet.Spreadsheet;
        setMaxIterativeCalculationCycles(
            maxIterations: number,
        ): GoogleAppsScript.Spreadsheet.Spreadsheet;
        setNamedRange(
            name: string,
            range: GoogleAppsScript.Spreadsheet.Range,
        ): void;
        setRecalculationInterval(
            recalculationInterval: RecalculationInterval,
        ): GoogleAppsScript.Spreadsheet.Spreadsheet;
        setRowHeight(
            rowPosition: number,
            height: number,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        setSheetProtection(permissions: PageProtection): void;
        setSpreadsheetLocale(locale: string): void;
        setSpreadsheetTheme(theme: SpreadsheetTheme): SpreadsheetTheme;
        setSpreadsheetTimeZone(timezone: string): void;
        show(userInterface: HtmlOutput): void;
        sort(columnPosition: number): GoogleAppsScript.Spreadsheet.Sheet;
        sort(
            columnPosition: number,
            ascending: boolean,
        ): GoogleAppsScript.Spreadsheet.Sheet;
        toast(msg: string): void;
        toast(msg: string, title: string): void;
        toast(msg: string, title: string, timeoutSeconds: number): void;
        unhideColumn(column: GoogleAppsScript.Spreadsheet.Range): void;
        unhideRow(row: GoogleAppsScript.Spreadsheet.Range): void;
        updateMenu(
            name: string,
            subMenus: { functionName: string; name: string }[],
        ): void;
    }
    Index

    Methods

    addDeveloperMetadata addEditor addEditors addMenu addViewer addViewers appendRow autoResizeColumn copy createDeveloperMetadataFinder createTextFinder deleteActiveSheet deleteColumn deleteColumns deleteRow deleteRows deleteSheet duplicateActiveSheet getActiveCell getActiveRange getActiveRangeList getActiveSheet getAs getBandings getBlob getColumnWidth getCurrentCell getDataRange getDataSourceTables getDeveloperMetadata getEditors getFormUrl getFrozenColumns getFrozenRows getId getImages getIterativeCalculationConvergenceThreshold getLastColumn getLastRow getMaxIterativeCalculationCycles getName getNamedRanges getNumSheets getOwner getPredefinedSpreadsheetThemes getProtections getRange getRangeByName getRangeList getRecalculationInterval getRowHeight getSelection getSheetById getSheetByName getSheetId getSheetName getSheetProtection getSheets getSheetValues getSpreadsheetLocale getSpreadsheetTheme getSpreadsheetTimeZone getUrl getViewers hideColumn hideRow insertColumnAfter insertColumnBefore insertColumnsAfter insertColumnsBefore insertImage insertRowAfter insertRowBefore insertRowsAfter insertRowsBefore insertSheet insertSheetWithDataSourceTable isAnonymousView isAnonymousWrite isColumnHiddenByUser isIterativeCalculationEnabled isRowHiddenByFilter isRowHiddenByUser moveActiveSheet moveChartToObjectSheet removeEditor removeMenu removeNamedRange removeViewer rename renameActiveSheet resetSpreadsheetTheme setActiveRange setActiveRangeList setActiveSelection setActiveSheet setAnonymousAccess setColumnWidth setCurrentCell setFrozenColumns setFrozenRows setIterativeCalculationConvergenceThreshold setIterativeCalculationEnabled setMaxIterativeCalculationCycles setNamedRange setRecalculationInterval setRowHeight setSheetProtection setSpreadsheetLocale setSpreadsheetTheme setSpreadsheetTimeZone show sort toast unhideColumn unhideRow updateMenu

    Methods

    Settings
    Member Visibility

    On This Page
    Methods
    addDeveloperMetadata addEditor addEditors addMenu addViewer addViewers appendRow autoResizeColumn copy createDeveloperMetadataFinder createTextFinder deleteActiveSheet deleteColumn deleteColumns deleteRow deleteRows deleteSheet duplicateActiveSheet getActiveCell getActiveRange getActiveRangeList getActiveSheet getAs getBandings getBlob getColumnWidth getCurrentCell getDataRange getDataSourceTables getDeveloperMetadata getEditors getFormUrl getFrozenColumns getFrozenRows getId getImages getIterativeCalculationConvergenceThreshold getLastColumn getLastRow getMaxIterativeCalculationCycles getName getNamedRanges getNumSheets getOwner getPredefinedSpreadsheetThemes getProtections getRange getRangeByName getRangeList getRecalculationInterval getRowHeight getSelection getSheetById getSheetByName getSheetId getSheetName getSheetProtection getSheets getSheetValues getSpreadsheetLocale getSpreadsheetTheme getSpreadsheetTimeZone getUrl getViewers hideColumn hideRow insertColumnAfter insertColumnBefore insertColumnsAfter insertColumnsBefore insertImage insertRowAfter insertRowBefore insertRowsAfter insertRowsBefore insertSheet insertSheetWithDataSourceTable isAnonymousView isAnonymousWrite isColumnHiddenByUser isIterativeCalculationEnabled isRowHiddenByFilter isRowHiddenByUser moveActiveSheet moveChartToObjectSheet removeEditor removeMenu removeNamedRange removeViewer rename renameActiveSheet resetSpreadsheetTheme setActiveRange setActiveRangeList setActiveSelection setActiveSheet setAnonymousAccess setColumnWidth setCurrentCell setFrozenColumns setFrozenRows setIterativeCalculationConvergenceThreshold setIterativeCalculationEnabled setMaxIterativeCalculationCycles setNamedRange setRecalculationInterval setRowHeight setSheetProtection setSpreadsheetLocale setSpreadsheetTheme setSpreadsheetTimeZone show sort toast unhideColumn unhideRow updateMenu