Google Apps Script API
Preparing search index...
google-apps-script-events
GoogleAppsScript
Spreadsheet
SpreadsheetApp
Interface SpreadsheetApp
Access and create Google Sheets files. This class is the parent class for the Spreadsheet service.
interface
SpreadsheetApp
{
AutoFillSeries
:
typeof
AutoFillSeries
;
BandingTheme
:
typeof
BandingTheme
;
BooleanCriteria
:
typeof
BooleanCriteria
;
BorderStyle
:
typeof
GoogleAppsScript
.
Spreadsheet
.
BorderStyle
;
ColorType
:
typeof
ColorType
;
CopyPasteType
:
typeof
CopyPasteType
;
DataExecutionErrorCode
:
typeof
DataExecutionErrorCode
;
DataExecutionState
:
typeof
DataExecutionState
;
DataSourceParameterType
:
typeof
DataSourceParameterType
;
DataSourceType
:
typeof
DataSourceType
;
DataValidationCriteria
:
typeof
DataValidationCriteria
;
DeveloperMetadataLocationType
:
typeof
DeveloperMetadataLocationType
;
DeveloperMetadataVisibility
:
typeof
DeveloperMetadataVisibility
;
Dimension
:
typeof
GoogleAppsScript
.
Spreadsheet
.
Dimension
;
Direction
:
typeof
Direction
;
GroupControlTogglePosition
:
typeof
GroupControlTogglePosition
;
InterpolationType
:
typeof
InterpolationType
;
PivotTableSummarizeFunction
:
typeof
PivotTableSummarizeFunction
;
PivotValueDisplayType
:
typeof
PivotValueDisplayType
;
ProtectionType
:
typeof
ProtectionType
;
RecalculationInterval
:
typeof
RecalculationInterval
;
RelativeDate
:
typeof
RelativeDate
;
SheetType
:
typeof
SheetType
;
TextDirection
:
typeof
GoogleAppsScript
.
Spreadsheet
.
TextDirection
;
TextToColumnsDelimiter
:
typeof
TextToColumnsDelimiter
;
ThemeColorType
:
typeof
GoogleAppsScript
.
Spreadsheet
.
ThemeColorType
;
ValueType
:
typeof
ValueType
;
WrapStrategy
:
typeof
WrapStrategy
;
create
(
name
:
string
)
:
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
;
create
(
name
:
string
,
rows
:
number
,
columns
:
number
,
)
:
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
;
enableAllDataSourcesExecution
()
:
void
;
enableBigQueryExecution
()
:
void
;
flush
()
:
void
;
getActive
()
:
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
;
getActiveRange
()
:
GoogleAppsScript
.
Spreadsheet
.
Range
;
getActiveRangeList
()
:
RangeList
;
getActiveSheet
()
:
GoogleAppsScript
.
Spreadsheet
.
Sheet
;
getActiveSpreadsheet
()
:
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
;
getCurrentCell
()
:
GoogleAppsScript
.
Spreadsheet
.
Range
;
getSelection
()
:
GoogleAppsScript
.
Spreadsheet
.
Selection
;
getUi
()
:
Ui
;
newCellImage
()
:
CellImageBuilder
;
newColor
()
:
ColorBuilder
;
newConditionalFormatRule
()
:
ConditionalFormatRuleBuilder
;
newDataSourceSpec
()
:
DataSourceSpecBuilder
;
newDataValidation
()
:
DataValidationBuilder
;
newFilterCriteria
()
:
FilterCriteriaBuilder
;
newRichTextValue
()
:
RichTextValueBuilder
;
newTextStyle
()
:
GoogleAppsScript
.
Spreadsheet
.
TextStyleBuilder
;
open
(
file
:
GoogleAppsScript
.
Drive
.
File
,
)
:
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
;
openById
(
id
:
string
)
:
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
;
openByUrl
(
url
:
string
)
:
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
;
setActiveRange
(
range
:
GoogleAppsScript
.
Spreadsheet
.
Range
,
)
:
GoogleAppsScript
.
Spreadsheet
.
Range
;
setActiveRangeList
(
rangeList
:
RangeList
)
:
RangeList
;
setActiveSheet
(
sheet
:
GoogleAppsScript
.
Spreadsheet
.
Sheet
,
)
:
GoogleAppsScript
.
Spreadsheet
.
Sheet
;
setActiveSheet
(
sheet
:
GoogleAppsScript
.
Spreadsheet
.
Sheet
,
restoreSelection
:
boolean
,
)
:
GoogleAppsScript
.
Spreadsheet
.
Sheet
;
setActiveSpreadsheet
(
newActiveSpreadsheet
:
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
,
)
:
void
;
setCurrentCell
(
cell
:
GoogleAppsScript
.
Spreadsheet
.
Range
,
)
:
GoogleAppsScript
.
Spreadsheet
.
Range
;
}
Index
Properties
Auto
Fill
Series
Banding
Theme
Boolean
Criteria
Border
Style
Color
Type
Copy
Paste
Type
Data
Execution
Error
Code
Data
Execution
State
Data
Source
Parameter
Type
Data
Source
Type
Data
Validation
Criteria
Developer
Metadata
Location
Type
Developer
Metadata
Visibility
Dimension
Direction
Group
Control
Toggle
Position
Interpolation
Type
Pivot
Table
Summarize
Function
Pivot
Value
Display
Type
Protection
Type
Recalculation
Interval
Relative
Date
Sheet
Type
Text
Direction
Text
To
Columns
Delimiter
Theme
Color
Type
Value
Type
Wrap
Strategy
Methods
create
enable
All
Data
Sources
Execution
enable
Big
Query
Execution
flush
get
Active
get
Active
Range
get
Active
Range
List
get
Active
Sheet
get
Active
Spreadsheet
get
Current
Cell
get
Selection
get
Ui
new
Cell
Image
new
Color
new
Conditional
Format
Rule
new
Data
Source
Spec
new
Data
Validation
new
Filter
Criteria
new
Rich
Text
Value
new
Text
Style
open
open
By
Id
open
By
Url
set
Active
Range
set
Active
Range
List
set
Active
Sheet
set
Active
Spreadsheet
set
Current
Cell
Properties
Auto
Fill
Series
AutoFillSeries
:
typeof
AutoFillSeries
Banding
Theme
BandingTheme
:
typeof
BandingTheme
Boolean
Criteria
BooleanCriteria
:
typeof
BooleanCriteria
Border
Style
BorderStyle
:
typeof
GoogleAppsScript
.
Spreadsheet
.
BorderStyle
Color
Type
ColorType
:
typeof
ColorType
Copy
Paste
Type
CopyPasteType
:
typeof
CopyPasteType
Data
Execution
Error
Code
DataExecutionErrorCode
:
typeof
DataExecutionErrorCode
Data
Execution
State
DataExecutionState
:
typeof
DataExecutionState
Data
Source
Parameter
Type
DataSourceParameterType
:
typeof
DataSourceParameterType
Data
Source
Type
DataSourceType
:
typeof
DataSourceType
Data
Validation
Criteria
DataValidationCriteria
:
typeof
DataValidationCriteria
Developer
Metadata
Location
Type
DeveloperMetadataLocationType
:
typeof
DeveloperMetadataLocationType
Developer
Metadata
Visibility
DeveloperMetadataVisibility
:
typeof
DeveloperMetadataVisibility
Dimension
Dimension
:
typeof
GoogleAppsScript
.
Spreadsheet
.
Dimension
Direction
Direction
:
typeof
Direction
Group
Control
Toggle
Position
GroupControlTogglePosition
:
typeof
GroupControlTogglePosition
Interpolation
Type
InterpolationType
:
typeof
InterpolationType
Pivot
Table
Summarize
Function
PivotTableSummarizeFunction
:
typeof
PivotTableSummarizeFunction
Pivot
Value
Display
Type
PivotValueDisplayType
:
typeof
PivotValueDisplayType
Protection
Type
ProtectionType
:
typeof
ProtectionType
Recalculation
Interval
RecalculationInterval
:
typeof
RecalculationInterval
Relative
Date
RelativeDate
:
typeof
RelativeDate
Sheet
Type
SheetType
:
typeof
SheetType
Text
Direction
TextDirection
:
typeof
GoogleAppsScript
.
Spreadsheet
.
TextDirection
Text
To
Columns
Delimiter
TextToColumnsDelimiter
:
typeof
TextToColumnsDelimiter
Theme
Color
Type
ThemeColorType
:
typeof
GoogleAppsScript
.
Spreadsheet
.
ThemeColorType
Value
Type
ValueType
:
typeof
ValueType
Wrap
Strategy
WrapStrategy
:
typeof
WrapStrategy
Methods
create
create
(
name
:
string
)
:
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
Parameters
name
:
string
Returns
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
create
(
name
:
string
,
rows
:
number
,
columns
:
number
,
)
:
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
Parameters
name
:
string
rows
:
number
columns
:
number
Returns
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
enable
All
Data
Sources
Execution
enableAllDataSourcesExecution
()
:
void
Returns
void
enable
Big
Query
Execution
enableBigQueryExecution
()
:
void
Returns
void
flush
flush
()
:
void
Returns
void
get
Active
getActive
()
:
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
Returns
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
get
Active
Range
getActiveRange
()
:
GoogleAppsScript
.
Spreadsheet
.
Range
Returns
GoogleAppsScript
.
Spreadsheet
.
Range
get
Active
Range
List
getActiveRangeList
()
:
RangeList
Returns
RangeList
get
Active
Sheet
getActiveSheet
()
:
GoogleAppsScript
.
Spreadsheet
.
Sheet
Returns
GoogleAppsScript
.
Spreadsheet
.
Sheet
get
Active
Spreadsheet
getActiveSpreadsheet
()
:
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
Returns
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
get
Current
Cell
getCurrentCell
()
:
GoogleAppsScript
.
Spreadsheet
.
Range
Returns
GoogleAppsScript
.
Spreadsheet
.
Range
get
Selection
getSelection
()
:
GoogleAppsScript
.
Spreadsheet
.
Selection
Returns
GoogleAppsScript
.
Spreadsheet
.
Selection
get
Ui
getUi
()
:
Ui
Returns
Ui
new
Cell
Image
newCellImage
()
:
CellImageBuilder
Returns
CellImageBuilder
new
Color
newColor
()
:
ColorBuilder
Returns
ColorBuilder
new
Conditional
Format
Rule
newConditionalFormatRule
()
:
ConditionalFormatRuleBuilder
Returns
ConditionalFormatRuleBuilder
new
Data
Source
Spec
newDataSourceSpec
()
:
DataSourceSpecBuilder
Returns
DataSourceSpecBuilder
new
Data
Validation
newDataValidation
()
:
DataValidationBuilder
Returns
DataValidationBuilder
new
Filter
Criteria
newFilterCriteria
()
:
FilterCriteriaBuilder
Returns
FilterCriteriaBuilder
new
Rich
Text
Value
newRichTextValue
()
:
RichTextValueBuilder
Returns
RichTextValueBuilder
new
Text
Style
newTextStyle
()
:
GoogleAppsScript
.
Spreadsheet
.
TextStyleBuilder
Returns
GoogleAppsScript
.
Spreadsheet
.
TextStyleBuilder
open
open
(
file
:
GoogleAppsScript
.
Drive
.
File
,
)
:
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
Parameters
file
:
GoogleAppsScript
.
Drive
.
File
Returns
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
open
By
Id
openById
(
id
:
string
)
:
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
Parameters
id
:
string
Returns
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
open
By
Url
openByUrl
(
url
:
string
)
:
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
Parameters
url
:
string
Returns
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
set
Active
Range
setActiveRange
(
range
:
GoogleAppsScript
.
Spreadsheet
.
Range
,
)
:
GoogleAppsScript
.
Spreadsheet
.
Range
Parameters
range
:
GoogleAppsScript
.
Spreadsheet
.
Range
Returns
GoogleAppsScript
.
Spreadsheet
.
Range
set
Active
Range
List
setActiveRangeList
(
rangeList
:
RangeList
)
:
RangeList
Parameters
rangeList
:
RangeList
Returns
RangeList
set
Active
Sheet
setActiveSheet
(
sheet
:
GoogleAppsScript
.
Spreadsheet
.
Sheet
,
)
:
GoogleAppsScript
.
Spreadsheet
.
Sheet
Parameters
sheet
:
GoogleAppsScript
.
Spreadsheet
.
Sheet
Returns
GoogleAppsScript
.
Spreadsheet
.
Sheet
setActiveSheet
(
sheet
:
GoogleAppsScript
.
Spreadsheet
.
Sheet
,
restoreSelection
:
boolean
,
)
:
GoogleAppsScript
.
Spreadsheet
.
Sheet
Parameters
sheet
:
GoogleAppsScript
.
Spreadsheet
.
Sheet
restoreSelection
:
boolean
Returns
GoogleAppsScript
.
Spreadsheet
.
Sheet
set
Active
Spreadsheet
setActiveSpreadsheet
(
newActiveSpreadsheet
:
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
,
)
:
void
Parameters
newActiveSpreadsheet
:
GoogleAppsScript
.
Spreadsheet
.
Spreadsheet
Returns
void
set
Current
Cell
setCurrentCell
(
cell
:
GoogleAppsScript
.
Spreadsheet
.
Range
,
)
:
GoogleAppsScript
.
Spreadsheet
.
Range
Parameters
cell
:
GoogleAppsScript
.
Spreadsheet
.
Range
Returns
GoogleAppsScript
.
Spreadsheet
.
Range
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
Auto
Fill
Series
Banding
Theme
Boolean
Criteria
Border
Style
Color
Type
Copy
Paste
Type
Data
Execution
Error
Code
Data
Execution
State
Data
Source
Parameter
Type
Data
Source
Type
Data
Validation
Criteria
Developer
Metadata
Location
Type
Developer
Metadata
Visibility
Dimension
Direction
Group
Control
Toggle
Position
Interpolation
Type
Pivot
Table
Summarize
Function
Pivot
Value
Display
Type
Protection
Type
Recalculation
Interval
Relative
Date
Sheet
Type
Text
Direction
Text
To
Columns
Delimiter
Theme
Color
Type
Value
Type
Wrap
Strategy
Methods
create
enable
All
Data
Sources
Execution
enable
Big
Query
Execution
flush
get
Active
get
Active
Range
get
Active
Range
List
get
Active
Sheet
get
Active
Spreadsheet
get
Current
Cell
get
Selection
get
Ui
new
Cell
Image
new
Color
new
Conditional
Format
Rule
new
Data
Source
Spec
new
Data
Validation
new
Filter
Criteria
new
Rich
Text
Value
new
Text
Style
open
open
By
Id
open
By
Url
set
Active
Range
set
Active
Range
List
set
Active
Sheet
set
Active
Spreadsheet
set
Current
Cell
Google Apps Script API
Loading...
Access and create Google Sheets files. This class is the parent class for the Spreadsheet service.