此服务允许脚本创建、访问和修改 Google 表格文件。另请参阅在电子表格中存储数据的指南。
有时,电子表格操作会捆绑在一起以提升性能,例如对某方法进行多次调用时。如果您想确保立即执行所有待处理的更改(例如,在脚本执行时显示用户信息),请调用 SpreadsheetApp.flush()
。
类
AutoFillSeries
属性
媒体资源 | 类型 | 说明 |
---|---|---|
DEFAULT_SERIES | Enum | 默认此值。 |
ALTERNATE_SERIES | Enum | 自动填充此设置会导致扩展范围中的空白单元格被现有值的副本填充。 |
Banding
方法
BandingTheme
属性
媒体资源 | 类型 | 说明 |
---|---|---|
LIGHT_GREY | Enum | 浅灰色条带主题。 |
CYAN | Enum | 青色条带主题。 |
GREEN | Enum | 绿色条带主题。 |
YELLOW | Enum | 黄色条带主题。 |
ORANGE | Enum | 橙色条带主题。 |
BLUE | Enum | 蓝色条带主题。 |
TEAL | Enum | 蓝青色主题。 |
GREY | Enum | 灰色条带主题。 |
BROWN | Enum | 棕色条纹主题。 |
LIGHT_GREEN | Enum | 浅绿色条带主题。 |
INDIGO | Enum | 靛蓝色条带主题。 |
PINK | Enum | 粉色条带主题。 |
BigQueryDataSourceSpec
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | DataSourceSpecBuilder | 根据此数据源的设置创建 DataSourceSpecBuilder 。 |
getDatasetId() | String | 获取 BigQuery 数据集 ID。 |
getParameters() | DataSourceParameter[] | 获取数据源的参数。 |
getProjectId() | String | 获取结算项目 ID。 |
getRawQuery() | String | 获取原始查询字符串。 |
getTableId() | String | 获取 BigQuery 表 ID。 |
getTableProjectId() | String | 获取该表的 BigQuery 项目 ID。 |
getType() | DataSourceType | 获取数据源的类型。 |
BigQueryDataSourceSpecBuilder
方法
方法 | 返回类型 | 简介 |
---|---|---|
build() | DataSourceSpec | 根据此构建器中的设置构建数据源规范。 |
copy() | DataSourceSpecBuilder | 根据此数据源的设置创建 DataSourceSpecBuilder 。 |
getDatasetId() | String | 获取 BigQuery 数据集 ID。 |
getParameters() | DataSourceParameter[] | 获取数据源的参数。 |
getProjectId() | String | 获取结算项目 ID。 |
getRawQuery() | String | 获取原始查询字符串。 |
getTableId() | String | 获取 BigQuery 表 ID。 |
getTableProjectId() | String | 获取该表的 BigQuery 项目 ID。 |
getType() | DataSourceType | 获取数据源的类型。 |
removeAllParameters() | BigQueryDataSourceSpecBuilder | 移除所有参数。 |
removeParameter(parameterName) | BigQueryDataSourceSpecBuilder | 移除指定的参数。 |
setDatasetId(datasetId) | BigQueryDataSourceSpecBuilder | 设置 BigQuery 数据集 ID。 |
setParameterFromCell(parameterName, sourceCell) | BigQueryDataSourceSpecBuilder | 添加一个参数,或者如果名称已存在,则更新其源单元格。 |
setProjectId(projectId) | BigQueryDataSourceSpecBuilder | 设置结算 BigQuery 项目 ID。 |
setRawQuery(rawQuery) | BigQueryDataSourceSpecBuilder | 设置原始查询字符串。 |
setTableId(tableId) | BigQueryDataSourceSpecBuilder | 设置 BigQuery 表 ID。 |
setTableProjectId(projectId) | BigQueryDataSourceSpecBuilder | 设置该表的 BigQuery 项目 ID。 |
BooleanCondition
方法
方法 | 返回类型 | 简介 |
---|---|---|
getBackgroundObject() | Color | 获取此布尔值条件的背景颜色。 |
getBold() | Boolean | 如果此布尔值条件为文本加粗,则返回 true ;如果此布尔值条件消除文本中的粗体内容,则返回 false 。 |
getCriteriaType() | BooleanCriteria | 获取 BooleanCriteria 枚举中定义的规则的条件类型。 |
getCriteriaValues() | Object[] | 获取规则的条件参数数组。 |
getFontColorObject() | Color | 获取此布尔值的字体颜色。 |
getItalic() | Boolean | 如果此布尔值条件将文本设为斜体,则返回 true ;如果此布尔值条件从文本中移除斜体,则返回 false 。 |
getStrikethrough() | Boolean | 如果此布尔条件在文本后添加删除线,则返回 true ;如果布尔条件会从文本中移除删除线,则返回 false 。 |
getUnderline() | Boolean | 如果布尔条件为文本加下划线,则返回 true ;如果此布尔值条件移除了文本的下划线,则返回 false 。 |
BooleanCriteria
属性
媒体资源 | 类型 | 说明 |
---|---|---|
CELL_EMPTY | Enum | 当单元格为空时,满足条件。 |
CELL_NOT_EMPTY | Enum | 当单元格不为空时,满足条件。 |
DATE_AFTER | Enum | 当日期晚于指定的值时,满足条件。 |
DATE_BEFORE | Enum | 当日期早于指定值时,满足条件。 |
DATE_EQUAL_TO | Enum | 当日期等于指定值时,符合条件。 |
DATE_NOT_EQUAL_TO | Enum | 当日期不等于指定值时,满足条件。 |
DATE_AFTER_RELATIVE | Enum | 当日期晚于相对日期值,则满足条件。 |
DATE_BEFORE_RELATIVE | Enum | 当日期早于相对日期值时,满足条件。 |
DATE_EQUAL_TO_RELATIVE | Enum | 当日期等于相对日期值时,符合条件。 |
NUMBER_BETWEEN | Enum | 当数值介于指定值之间时,满足条件。 |
NUMBER_EQUAL_TO | Enum | 当数字等于指定值时,满足条件。 |
NUMBER_GREATER_THAN | Enum | 当数字大于指定值时,满足条件。 |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | 当某个数字大于或等于指定值时,则满足条件。 |
NUMBER_LESS_THAN | Enum | 当数字小于指定值时,满足条件。 |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | 当数字小于或等于指定值时,满足条件。 |
NUMBER_NOT_BETWEEN | Enum | 当数字不在指定值之间时,满足条件。 |
NUMBER_NOT_EQUAL_TO | Enum | 当数字不等于指定值时,满足条件。 |
TEXT_CONTAINS | Enum | 如果输入包含指定值,则满足条件。 |
TEXT_DOES_NOT_CONTAIN | Enum | 如果输入不包含指定的值,则满足条件。 |
TEXT_EQUAL_TO | Enum | 如果输入等于指定值,则满足条件。 |
TEXT_NOT_EQUAL_TO | Enum | 如果输入值不等于指定值,则满足条件。 |
TEXT_STARTS_WITH | Enum | 如果输入以给定值开头,则满足条件。 |
TEXT_ENDS_WITH | Enum | 如果输入以给定值结尾,则满足条件。 |
CUSTOM_FORMULA | Enum | 当输入使给定公式的求值结果为 true 时,满足条件。 |
BorderStyle
属性
媒体资源 | 类型 | 说明 |
---|---|---|
DOTTED | Enum | 点线边框。 |
DASHED | Enum | 虚线边框。 |
SOLID | Enum | 细实线边框。 |
SOLID_MEDIUM | Enum | 中等粗细的实线边框。 |
SOLID_THICK | Enum | 粗实线边框。 |
DOUBLE | Enum | 两条实线边框。 |
CellImage
属性
媒体资源 | 类型 | 说明 |
---|---|---|
valueType | ValueType | 一个设置为 ValueType.IMAGE 的字段,表示图片值类型。 |
方法
方法 | 返回类型 | 简介 |
---|---|---|
getAltTextDescription() | String | 返回此图片的替代文本说明。 |
getAltTextTitle() | String | 返回此图片的替代文本标题。 |
getContentUrl() | String | 返回图片的 Google 托管网址。 |
getUrl() | String | 获取图片的源网址;如果网址不可用,则返回 null 。 |
toBuilder() | CellImageBuilder | 创建一个将图片转换为图片值类型的构建器,以便您将其放入单元格中。 |
CellImageBuilder
属性
媒体资源 | 类型 | 说明 |
---|---|---|
valueType | ValueType | 一个设置为 ValueType.IMAGE 的字段,表示图片值类型。 |
方法
方法 | 返回类型 | 简介 |
---|---|---|
build() | CellImage | 创建在单元格中添加图片所需的图片值类型。 |
getAltTextDescription() | String | 返回此图片的替代文本说明。 |
getAltTextTitle() | String | 返回此图片的替代文本标题。 |
getContentUrl() | String | 返回图片的 Google 托管网址。 |
getUrl() | String | 获取图片的源网址;如果网址不可用,则返回 null 。 |
setAltTextDescription(description) | CellImage | 设置此图片的替代文本说明。 |
setAltTextTitle(title) | CellImage | 设置此图片的替代文本标题。 |
setSourceUrl(url) | CellImageBuilder | 设置图片来源网址。 |
toBuilder() | CellImageBuilder | 创建一个将图片转换为图片值类型的构建器,以便您将其放入单元格中。 |
Color
方法
方法 | 返回类型 | 简介 |
---|---|---|
asRgbColor() | RgbColor | 将此颜色转换为 RgbColor 。 |
asThemeColor() | ThemeColor | 将此颜色转换为 ThemeColor 。 |
getColorType() | ColorType | 获取此颜色的类型。 |
ColorBuilder
方法
方法 | 返回类型 | 简介 |
---|---|---|
asRgbColor() | RgbColor | 将此颜色转换为 RgbColor 。 |
asThemeColor() | ThemeColor | 将此颜色转换为 ThemeColor 。 |
build() | Color | 根据提供给构建器的设置创建颜色对象。 |
getColorType() | ColorType | 获取此颜色的类型。 |
setRgbColor(cssString) | ColorBuilder | 设为 RGB 颜色。 |
setThemeColor(themeColorType) | ColorBuilder | 设为主题颜色。 |
ConditionalFormatRule
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | ConditionalFormatRuleBuilder | 返回采用此规则的设置的规则构建器预设。 |
getBooleanCondition() | BooleanCondition | 如果此规则使用布尔值条件,则会检索规则的 BooleanCondition 信息。 |
getGradientCondition() | GradientCondition | 检索规则的 GradientCondition 信息(如果此规则使用渐变条件条件)。 |
getRanges() | Range[] | 检索应用此条件格式规则的范围。 |
ConditionalFormatRuleBuilder
方法
ContainerInfo
方法
方法 | 返回类型 | 简介 |
---|---|---|
getAnchorColumn() | Integer | 图表左侧锚定在此列中。 |
getAnchorRow() | Integer | 图表的上方锚定在该行中。 |
getOffsetX() | Integer | 图表的左上角与锚点列相差这么多像素。 |
getOffsetY() | Integer | 图表的左上角与锚点行偏移这么多像素。 |
CopyPasteType
属性
媒体资源 | 类型 | 说明 |
---|---|---|
PASTE_NORMAL | Enum | 粘贴值、公式、格式以及合并。 |
PASTE_NO_BORDERS | Enum | 粘贴值、公式、格式以及合并,但不显示边框。 |
PASTE_FORMAT | Enum | 仅粘贴格式。 |
PASTE_FORMULA | Enum | 仅粘贴公式。 |
PASTE_DATA_VALIDATION | Enum | 仅粘贴数据验证。 |
PASTE_VALUES | Enum | 请仅粘贴值,不要粘贴格式、公式或合并。 |
PASTE_CONDITIONAL_FORMATTING | Enum | 请仅粘贴颜色规则。 |
PASTE_COLUMN_WIDTHS | Enum | 仅粘贴列宽。 |
DataExecutionErrorCode
属性
媒体资源 | 类型 | 说明 |
---|---|---|
DATA_EXECUTION_ERROR_CODE_UNSUPPORTED | Enum | Apps 脚本不支持的数据执行错误代码。 |
NONE | Enum | 数据执行没有错误。 |
TIME_OUT | Enum | 数据执行超时。 |
TOO_MANY_ROWS | Enum | 数据执行返回的行数超出上限。 |
TOO_MANY_COLUMNS | Enum | 数据执行返回的列数超出了上限。 |
TOO_MANY_CELLS | Enum | 数据执行返回的单元格数量超出限制。 |
ENGINE | Enum | 数据执行引擎错误。 |
PARAMETER_INVALID | Enum | 数据执行参数无效。 |
UNSUPPORTED_DATA_TYPE | Enum | 数据执行返回不受支持的数据类型。 |
DUPLICATE_COLUMN_NAMES | Enum | 数据执行结果会返回重复的列名称。 |
INTERRUPTED | Enum | 数据执行中断。 |
OTHER | Enum | 其他错误。 |
TOO_MANY_CHARS_PER_CELL | Enum | 数据执行返回的值超出单个单元格允许的字符数上限。 |
DATA_NOT_FOUND | Enum | 未找到数据源引用的数据库。 |
PERMISSION_DENIED | Enum | 用户无权访问数据源引用的数据库。 |
DataExecutionState
属性
媒体资源 | 类型 | 说明 |
---|---|---|
DATA_EXECUTION_STATE_UNSUPPORTED | Enum | Apps 脚本不支持数据执行状态。 |
RUNNING | Enum | 数据执行操作已开始运行。 |
SUCCESS | Enum | 数据执行成功完成。 |
ERROR | Enum | 数据执行已完成,但存在错误。 |
NOT_STARTED | Enum | 数据执行操作尚未开始。 |
DataExecutionStatus
方法
方法 | 返回类型 | 简介 |
---|---|---|
getErrorCode() | DataExecutionErrorCode | 获取数据执行的错误代码。 |
getErrorMessage() | String | 获取数据执行的错误消息。 |
getExecutionState() | DataExecutionState | 获取数据执行的状态。 |
getLastExecutionTime() | Date | 获取上次执行数据的执行时间(无论执行状态如何)。 |
getLastRefreshedTime() | Date | 获取上次成功刷新数据的时间。 |
isTruncated() | Boolean | 如果上次成功执行的数据被截断,则返回 true ,否则返回 false 。 |
DataSource
方法
方法 | 返回类型 | 简介 |
---|---|---|
createCalculatedColumn(name, formula) | DataSourceColumn | 创建计算列。 |
createDataSourcePivotTableOnNewSheet() | DataSourcePivotTable | 在新工作表的第一个单元格中,基于此数据源创建数据源数据透视表。 |
createDataSourceTableOnNewSheet() | DataSourceTable | 在新工作表的第一个单元格中,基于此数据源创建数据源表。 |
getCalculatedColumnByName(columnName) | DataSourceColumn | 返回数据源中与列名称匹配的计算列。 |
getCalculatedColumns() | DataSourceColumn[] | 返回数据源中的所有计算列。 |
getColumns() | DataSourceColumn[] | 返回数据源中的所有列。 |
getDataSourceSheets() | DataSourceSheet[] | 返回与此数据源相关联的数据源表格。 |
getSpec() | DataSourceSpec | 获取数据源规范。 |
refreshAllLinkedDataSourceObjects() | void | 刷新与数据源关联的所有数据源对象。 |
updateSpec(spec) | DataSource | 更新数据源规范,并使用新规范刷新与此数据源关联的数据源对象。 |
updateSpec(spec, refreshAllLinkedObjects) | DataSource | 更新数据源规范,并使用新的规范刷新关联的 data
source sheets 。 |
waitForAllDataExecutionsCompletion(timeoutInSeconds) | void | 等到关联数据源对象的所有当前执行完成时,在所提供的秒数后超时。 |
DataSourceChart
方法
方法 | 返回类型 | 简介 |
---|---|---|
forceRefreshData() | DataSourceChart | 刷新此对象的数据(无论当前状态如何)。 |
getDataSource() | DataSource | 获取对象所关联的数据源。 |
getStatus() | DataExecutionStatus | 获取对象的数据执行状态。 |
refreshData() | DataSourceChart | 刷新对象的数据。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 等待当前执行完成,在提供的秒数后超时。 |
DataSourceColumn
方法
方法 | 返回类型 | 简介 |
---|---|---|
getDataSource() | DataSource | 获取与数据源列关联的数据源。 |
getFormula() | String | 获取数据源列的公式。 |
getName() | String | 获取数据源列名称。 |
hasArrayDependency() | Boolean | 返回此列是否具有数组依赖项。 |
isCalculatedColumn() | Boolean | 返回此列是否为计算列。 |
remove() | void | 移除数据源列。 |
setFormula(formula) | DataSourceColumn | 设置数据源列的公式。 |
setName(name) | DataSourceColumn | 设置数据源列名称。 |
DataSourceFormula
方法
方法 | 返回类型 | 简介 |
---|---|---|
forceRefreshData() | DataSourceFormula | 刷新此对象的数据(无论当前状态如何)。 |
getAnchorCell() | Range | 返回表示锚定此数据源公式的单元格的 Range 。 |
getDataSource() | DataSource | 获取对象所关联的数据源。 |
getDisplayValue() | String | 返回数据源公式的显示值。 |
getFormula() | String | 返回此数据源公式的公式。 |
getStatus() | DataExecutionStatus | 获取对象的数据执行状态。 |
refreshData() | DataSourceFormula | 刷新对象的数据。 |
setFormula(formula) | DataSourceFormula | 更新公式。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 等待当前执行完成,在提供的秒数后超时。 |
DataSourceParameter
方法
方法 | 返回类型 | 简介 |
---|---|---|
getName() | String | 获取参数名称。 |
getSourceCell() | String | 根据参数值获取来源单元格;如果参数类型不是 DataSourceParameterType.CELL ,获取 null 。 |
getType() | DataSourceParameterType | 获取参数类型。 |
DataSourceParameterType
属性
媒体资源 | 类型 | 说明 |
---|---|---|
DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTED | Enum | Apps 脚本不支持的数据源参数类型。 |
CELL | Enum | 数据源参数的值是根据单元格进行计算的。 |
DataSourcePivotTable
方法
方法 | 返回类型 | 简介 |
---|---|---|
addColumnGroup(columnName) | PivotGroup | 根据指定的数据源列添加新的数据透视表列组。 |
addFilter(columnName, filterCriteria) | PivotFilter | 根据具有指定过滤条件的指定数据源列添加新的过滤条件。 |
addPivotValue(columnName, summarizeFunction) | PivotValue | 根据具有指定汇总函数的指定数据源列添加新的数据透视值。 |
addRowGroup(columnName) | PivotGroup | 根据指定的数据源列添加新的数据透视表行组。 |
asPivotTable() | PivotTable | 以常规数据透视表对象的形式返回数据源数据透视表。 |
forceRefreshData() | DataSourcePivotTable | 刷新此对象的数据(无论当前状态如何)。 |
getDataSource() | DataSource | 获取对象所关联的数据源。 |
getStatus() | DataExecutionStatus | 获取对象的数据执行状态。 |
refreshData() | DataSourcePivotTable | 刷新对象的数据。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 等待当前执行完成,在提供的秒数后超时。 |
DataSourceRefreshSchedule
方法
方法 | 返回类型 | 简介 |
---|---|---|
getFrequency() | DataSourceRefreshScheduleFrequency | 获取刷新频率,用于指定刷新频率和刷新时间。 |
getScope() | DataSourceRefreshScope | 获取此刷新时间表的范围。 |
getTimeIntervalOfNextRun() | TimeInterval | 获取此刷新时间表的下一次运行的时间窗口。 |
isEnabled() | Boolean | 确定此刷新时间表是否已启用。 |
DataSourceRefreshScheduleFrequency
方法
方法 | 返回类型 | 简介 |
---|---|---|
getDaysOfTheMonth() | Integer[] | 获取数字(1-28)作为一个月的刷新日期。 |
getDaysOfTheWeek() | Weekday[] | 获取在星期几刷新数据源。 |
getFrequencyType() | FrequencyType | 获取频次类型。 |
getStartHour() | Integer | 获取运行刷新时间表的时间间隔的起始小时(以 0-23 表示)。 |
DataSourceRefreshScope
属性
媒体资源 | 类型 | 说明 |
---|---|---|
DATA_SOURCE_REFRESH_SCOPE_UNSUPPORTED | Enum | 数据源刷新范围不受支持。 |
ALL_DATA_SOURCES | Enum | 更新会应用于电子表格中的所有数据源。 |
DataSourceSheet
方法
DataSourceSheetFilter
方法
方法 | 返回类型 | 简介 |
---|---|---|
getDataSourceColumn() | DataSourceColumn | 返回此过滤条件应用到的数据源列。 |
getDataSourceSheet() | DataSourceSheet | 返回此过滤条件所属的 DataSourceSheet 。 |
getFilterCriteria() | FilterCriteria | 返回此过滤条件的过滤条件。 |
remove() | void | 从数据源对象中移除此过滤条件。 |
setFilterCriteria(filterCriteria) | DataSourceSheetFilter | 设置此过滤条件的过滤条件。 |
DataSourceSpec
方法
方法 | 返回类型 | 简介 |
---|---|---|
asBigQuery() | BigQueryDataSourceSpec | 获取 BigQuery 数据源的规范。 |
copy() | DataSourceSpecBuilder | 根据此数据源的设置创建 DataSourceSpecBuilder 。 |
getParameters() | DataSourceParameter[] | 获取数据源的参数。 |
getType() | DataSourceType | 获取数据源的类型。 |
DataSourceSpecBuilder
方法
方法 | 返回类型 | 简介 |
---|---|---|
asBigQuery() | BigQueryDataSourceSpecBuilder | 获取 BigQuery 数据源的构建器。 |
build() | DataSourceSpec | 根据此构建器中的设置构建数据源规范。 |
copy() | DataSourceSpecBuilder | 根据此数据源的设置创建 DataSourceSpecBuilder 。 |
getParameters() | DataSourceParameter[] | 获取数据源的参数。 |
getType() | DataSourceType | 获取数据源的类型。 |
removeAllParameters() | DataSourceSpecBuilder | 移除所有参数。 |
removeParameter(parameterName) | DataSourceSpecBuilder | 移除指定的参数。 |
setParameterFromCell(parameterName, sourceCell) | DataSourceSpecBuilder | 添加一个参数,或者如果名称已存在,则更新其源单元格。 |
DataSourceTable
方法
方法 | 返回类型 | 简介 |
---|---|---|
addColumns(columnNames) | DataSourceTable | 向数据源表添加列。 |
addFilter(columnName, filterCriteria) | DataSourceTable | 添加应用于数据源表格的过滤条件。 |
addSortSpec(columnName, ascending) | DataSourceTable | 为数据源表中的列添加排序规范。 |
addSortSpec(columnName, sortOrder) | DataSourceTable | 为数据源表中的列添加排序规范。 |
forceRefreshData() | DataSourceTable | 刷新此对象的数据(无论当前状态如何)。 |
getColumns() | DataSourceTableColumn[] | 获取添加到数据源表中的所有数据源列。 |
getDataSource() | DataSource | 获取对象所关联的数据源。 |
getFilters() | DataSourceTableFilter[] | 返回应用于数据源表的所有过滤条件。 |
getRange() | Range | 获取此数据源表涵盖的 Range 。 |
getRowLimit() | Integer | 返回数据源表的行数限制。 |
getSortSpecs() | SortSpec[] | 获取数据源表中的所有排序规范。 |
getStatus() | DataExecutionStatus | 获取对象的数据执行状态。 |
isSyncingAllColumns() | Boolean | 返回数据源表是否同步关联数据源中的所有列。 |
refreshData() | DataSourceTable | 刷新对象的数据。 |
removeAllColumns() | DataSourceTable | 移除数据源表中的所有列。 |
removeAllSortSpecs() | DataSourceTable | 移除数据源表中的所有排序规范。 |
setRowLimit(rowLimit) | DataSourceTable | 更新数据源表的行数限制。 |
syncAllColumns() | DataSourceTable | 将关联数据源中的所有当前列和未来列同步到数据源表。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 等待当前执行完成,在提供的秒数后超时。 |
DataSourceTableColumn
方法
方法 | 返回类型 | 简介 |
---|---|---|
getDataSourceColumn() | DataSourceColumn | 获取数据登记列。 |
remove() | void | 从 DataSourceTable 中移除此列。 |
DataSourceTableFilter
方法
方法 | 返回类型 | 简介 |
---|---|---|
getDataSourceColumn() | DataSourceColumn | 返回此过滤条件应用到的数据源列。 |
getDataSourceTable() | DataSourceTable | 返回此过滤条件所属的 DataSourceTable 。 |
getFilterCriteria() | FilterCriteria | 返回此过滤条件的过滤条件。 |
remove() | void | 从数据源对象中移除此过滤条件。 |
setFilterCriteria(filterCriteria) | DataSourceTableFilter | 设置此过滤条件的过滤条件。 |
DataSourceType
属性
媒体资源 | 类型 | 说明 |
---|---|---|
DATA_SOURCE_TYPE_UNSUPPORTED | Enum | Apps 脚本不支持的数据源类型。 |
BIGQUERY | Enum | BigQuery 数据源。 |
DataValidation
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | DataValidationBuilder | 根据此规则的设置,为数据验证规则创建构建器。 |
getAllowInvalid() | Boolean | 如果规则在输入验证失败时显示警告,则返回 true ;如果输入完全拒绝输入,则返回 false 。 |
getCriteriaType() | DataValidationCriteria | 获取 DataValidationCriteria 枚举中定义的规则的条件类型。 |
getCriteriaValues() | Object[] | 获取规则的条件参数数组。 |
getHelpText() | String | 获取规则的帮助文本;如果未设置帮助文本,则返回 null 。 |
DataValidationBuilder
方法
DataValidationCriteria
属性
媒体资源 | 类型 | 说明 |
---|---|---|
DATE_AFTER | Enum | 要求的日期应晚于指定值。 |
DATE_BEFORE | Enum | 要求的日期早于指定值。 |
DATE_BETWEEN | Enum | 要求日期应介于指定值之间。 |
DATE_EQUAL_TO | Enum | 要求日期必须等于指定值。 |
DATE_IS_VALID_DATE | Enum | 需要指定日期。 |
DATE_NOT_BETWEEN | Enum | 要求的日期不在指定值之间。 |
DATE_ON_OR_AFTER | Enum | 要求日期不能晚于指定值。 |
DATE_ON_OR_BEFORE | Enum | 要求的日期不得早于指定值。 |
NUMBER_BETWEEN | Enum | 需要一个介于指定值之间的数字。 |
NUMBER_EQUAL_TO | Enum | 需要等于指定值的数字。 |
NUMBER_GREATER_THAN | Enum | 数字必须大于指定值。 |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | 需要一个大于或等于指定值的数字。 |
NUMBER_LESS_THAN | Enum | 要求数字小于指定的值。 |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | 需要小于或等于指定值的数字。 |
NUMBER_NOT_BETWEEN | Enum | 需要输入的值不在指定值之间。 |
NUMBER_NOT_EQUAL_TO | Enum | 要求数字不等于指定的值。 |
TEXT_CONTAINS | Enum | 要求输入内容包含指定值。 |
TEXT_DOES_NOT_CONTAIN | Enum | 要求输入内容不包含指定的值。 |
TEXT_EQUAL_TO | Enum | 要求输入值等于指定值。 |
TEXT_IS_VALID_EMAIL | Enum | 要求输入内容作为电子邮件地址。 |
TEXT_IS_VALID_URL | Enum | 要求所输入的内容为网址。 |
VALUE_IN_LIST | Enum | 要求输入值等于任一指定值。 |
VALUE_IN_RANGE | Enum | 要求输入值等于给定范围内的值。 |
CUSTOM_FORMULA | Enum | 要求输入使给定公式的求值结果为 true 。 |
CHECKBOX | Enum | 要求输入内容为自定义值或布尔值;呈现为复选框。 |
DateTimeGroupingRule
方法
方法 | 返回类型 | 简介 |
---|---|---|
getRuleType() | DateTimeGroupingRuleType | 获取日期时间分组规则的类型。 |
DateTimeGroupingRuleType
属性
媒体资源 | 类型 | 说明 |
---|---|---|
UNSUPPORTED | Enum | 日期时间分组规则不受支持。 |
SECOND | Enum | 按日期分组时间(从 0 到 59)。 |
MINUTE | Enum | 按分钟分组日期-时间,范围为 0-59。 |
HOUR | Enum | 按 24 小时制按日期分组时间(0 到 23)。 |
HOUR_MINUTE | Enum | 使用 24 小时制按小时和分钟对日期时间进行分组,例如 19:45 。 |
HOUR_MINUTE_AMPM | Enum | 使用 12 小时制(例如 7:45 PM )按小时和分钟对日期时间进行分组。 |
DAY_OF_WEEK | Enum | 按星期几对日期时间进行分组,例如 Sunday 。 |
DAY_OF_YEAR | Enum | 按一年中的各天(1 到 366)对日期时间进行分组。 |
DAY_OF_MONTH | Enum | 按日期(1 到 31)对日期时间进行分组。 |
DAY_MONTH | Enum | 按日期和月份对日期时间进行分组,例如 22-Nov 。 |
MONTH | Enum | 按月份对日期时间进行分组,例如 Nov 。 |
QUARTER | Enum | 按季度对日期时间进行分组,例如 Q1(代表 1 月至 3 月)。 |
YEAR | Enum | 按日期对日期-时间分组,例如 2008。 |
YEAR_MONTH | Enum | 按年和月对日期时间进行分组,例如 2008-Nov 。 |
YEAR_QUARTER | Enum | 按年和季度对日期时间进行分组,例如 2008 Q4 。 |
YEAR_MONTH_DAY | Enum | 按年、月、日对日期时间进行分组,例如 2008-11-22 。 |
DeveloperMetadata
方法
方法 | 返回类型 | 简介 |
---|---|---|
getId() | Integer | 返回与此开发者元数据相关联的唯一 ID。 |
getKey() | String | 返回与此开发者元数据相关联的密钥。 |
getLocation() | DeveloperMetadataLocation | 返回此开发者元数据的位置。 |
getValue() | String | 返回与此开发者元数据相关联的值,如果此元数据没有值,则返回 null 。 |
getVisibility() | DeveloperMetadataVisibility | 返回此开发者元数据的可见性。 |
moveToColumn(column) | DeveloperMetadata | 将此开发者元数据移动到指定的列。 |
moveToRow(row) | DeveloperMetadata | 将此开发者元数据移至指定行。 |
moveToSheet(sheet) | DeveloperMetadata | 将此开发者元数据移至指定的工作表。 |
moveToSpreadsheet() | DeveloperMetadata | 将此开发者元数据移至顶级电子表格。 |
remove() | void | 删除此元数据。 |
setKey(key) | DeveloperMetadata | 将此开发者元数据的键设置为指定值。 |
setValue(value) | DeveloperMetadata | 将与此开发者元数据关联的值设为指定值。 |
setVisibility(visibility) | DeveloperMetadata | 将此开发者元数据的公开范围设置为指定的公开范围。 |
DeveloperMetadataFinder
方法
方法 | 返回类型 | 简介 |
---|---|---|
find() | DeveloperMetadata[] | 执行此搜索并返回匹配的元数据。 |
onIntersectingLocations() | DeveloperMetadataFinder | 将搜索配置为考虑包含元数据的相交位置。 |
withId(id) | DeveloperMetadataFinder | 限制此搜索,使其仅考虑与指定 ID 匹配的元数据。 |
withKey(key) | DeveloperMetadataFinder | 限制此搜索,使其仅考虑与指定键匹配的元数据。 |
withLocationType(locationType) | DeveloperMetadataFinder | 将此搜索限制为仅考虑与指定位置类型匹配的元数据。 |
withValue(value) | DeveloperMetadataFinder | 将此搜索限制为仅考虑与指定值匹配的元数据。 |
withVisibility(visibility) | DeveloperMetadataFinder | 将此搜索限制为仅考虑与指定公开范围匹配的元数据。 |
DeveloperMetadataLocation
方法
方法 | 返回类型 | 简介 |
---|---|---|
getColumn() | Range | 返回此元数据的列位置的 Range ;如果位置类型不是 DeveloperMetadataLocationType.COLUMN ,则返回 null 。 |
getLocationType() | DeveloperMetadataLocationType | 获取营业地点的类型。 |
getRow() | Range | 返回此元数据的行位置的 Range ;如果位置类型不是 DeveloperMetadataLocationType.ROW ,则返回 null 。 |
getSheet() | Sheet | 返回此元数据的 Sheet 位置;如果位置类型不是 DeveloperMetadataLocationType.SHEET ,则返回 null 。 |
getSpreadsheet() | Spreadsheet | 返回此元数据的 Spreadsheet 位置;如果位置类型不是 DeveloperMetadataLocationType.SPREADSHEET ,则返回 null 。 |
DeveloperMetadataLocationType
属性
媒体资源 | 类型 | 说明 |
---|---|---|
SPREADSHEET | Enum | 与顶级电子表格关联的开发者元数据的位置类型。 |
SHEET | Enum | 与整个工作表关联的开发者元数据的位置类型。 |
ROW | Enum | 与行关联的开发者元数据的位置类型。 |
COLUMN | Enum | 与列关联的开发者元数据的位置类型。 |
DeveloperMetadataVisibility
属性
媒体资源 | 类型 | 说明 |
---|---|---|
DOCUMENT | Enum | 任何有权访问该文档的开发者项目都可以访问文档可见的元数据。 |
PROJECT | Enum | 只有创建元数据的开发者项目可以查看和访问项目可见的元数据。 |
Dimension
属性
媒体资源 | 类型 | 说明 |
---|---|---|
COLUMNS | Enum | “列(维度)”维度。 |
ROWS | Enum | 行(水平)维度。 |
Direction
属性
媒体资源 | 类型 | 说明 |
---|---|---|
UP | Enum | 减少行索引的方向。 |
DOWN | Enum | 行索引的增大方向。 |
PREVIOUS | Enum | 降低列索引的方向。 |
NEXT | Enum | 列索引的增大方向。 |
Drawing
方法
方法 | 返回类型 | 简介 |
---|---|---|
getContainerInfo() | ContainerInfo | 获取有关绘图在工作表中的位置的信息。 |
getHeight() | Integer | 返回此绘图的实际高度(以像素为单位)。 |
getOnAction() | String | 返回附加到此绘图的宏的名称。 |
getSheet() | Sheet | 返回显示此绘图的工作表。 |
getWidth() | Integer | 返回此绘图的实际宽度(以像素为单位)。 |
getZIndex() | Number | 返回此绘图的 Z-index。 |
remove() | void | 从电子表格中删除此绘图。 |
setHeight(height) | Drawing | 设置此绘图的实际高度(以像素为单位)。 |
setOnAction(macroName) | Drawing | 向此绘图分配宏函数。 |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | Drawing | 设置绘图在工作表中的显示位置。 |
setWidth(width) | Drawing | 设置此绘图的实际宽度(以像素为单位)。 |
setZIndex(zIndex) | Drawing | 设置此绘图的 Z-index。 |
EmbeddedAreaChartBuilder
方法
EmbeddedBarChartBuilder
方法
EmbeddedChart
方法
方法 | 返回类型 | 简介 |
---|---|---|
asDataSourceChart() | DataSourceChart | 如果图表是数据源图表,则投射到数据源图表实例,否则转换为 null 。 |
getAs(contentType) | Blob | 将此对象中的数据作为 blob 转换为指定内容类型返回。 |
getBlob() | Blob | 以 blob 形式返回此对象中的数据。 |
getChartId() | Integer | 返回一个图表稳定标识符,该图表在包含该图表的电子表格中唯一,如果图表不在电子表格中,则返回 null 。 |
getContainerInfo() | ContainerInfo | 返回图表在工作表中的位置的相关信息。 |
getHiddenDimensionStrategy() | ChartHiddenDimensionStrategy | 返回用于处理隐藏行和列的策略。 |
getMergeStrategy() | ChartMergeStrategy | 返回有多个范围时使用的合并策略。 |
getNumHeaders() | Integer | 返回范围中被视为标题的行数或列数。 |
getOptions() | ChartOptions | 返回此图表的选项,例如高度、颜色和轴。 |
getRanges() | Range[] | 返回此图表用作数据源的范围。 |
getTransposeRowsAndColumns() | Boolean | 如果为 true ,则会切换用于填充图表的行和列。 |
modify() | EmbeddedChartBuilder | 返回可用于修改此图表的 EmbeddedChartBuilder 。 |
EmbeddedChartBuilder
方法
EmbeddedColumnChartBuilder
方法
EmbeddedComboChartBuilder
方法
EmbeddedHistogramChartBuilder
方法
EmbeddedLineChartBuilder
方法
EmbeddedPieChartBuilder
方法
EmbeddedScatterChartBuilder
方法
EmbeddedTableChartBuilder
方法
Filter
方法
方法 | 返回类型 | 简介 |
---|---|---|
getColumnFilterCriteria(columnPosition) | FilterCriteria | 获取指定列的过滤条件;如果列没有应用过滤条件,则返回 null 。 |
getRange() | Range | 获取此过滤条件应用到的范围。 |
remove() | void | 移除此过滤条件。 |
removeColumnFilterCriteria(columnPosition) | Filter | 从指定列中移除过滤条件。 |
setColumnFilterCriteria(columnPosition, filterCriteria) | Filter | 根据指定列设置过滤条件。 |
sort(columnPosition, ascending) | Filter | 按指定列对过滤的范围进行排序,但不包括此过滤范围中的第一行(标题行)。 |
FilterCriteria
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | FilterCriteriaBuilder | 复制此过滤条件,并创建条件过滤条件并将其应用于另一个过滤条件。 |
getCriteriaType() | BooleanCriteria | 返回条件的布尔值类型,例如 CELL_EMPTY 。 |
getCriteriaValues() | Object[] | 返回布尔值条件的参数数组。 |
getHiddenValues() | String[] | 返回该过滤器隐藏的值。 |
getVisibleBackgroundColor() | Color | 返回用作过滤条件的背景颜色。 |
getVisibleForegroundColor() | Color | 返回用作过滤条件的前景颜色。 |
getVisibleValues() | String[] | 返回数据透视表过滤器显示的值。 |
FilterCriteriaBuilder
方法
FrequencyType
属性
媒体资源 | 类型 | 说明 |
---|---|---|
FREQUENCY_TYPE_UNSUPPORTED | Enum | 频次类型不受支持。 |
DAILY | Enum | 每天刷新。 |
WEEKLY | Enum | 每周刷新一次,在一周中的特定几天刷新。 |
MONTHLY | Enum | 在每月的给定几天刷新。 |
GradientCondition
方法
方法 | 返回类型 | 简介 |
---|---|---|
getMaxColorObject() | Color | 获取为该渐变条件的最大值设置的颜色。 |
getMaxType() | InterpolationType | 获取此渐变条件的最大值的插值类型。 |
getMaxValue() | String | 获取此渐变条件的最大值。 |
getMidColorObject() | Color | 获取为该渐变条件的中点值设置的颜色。 |
getMidType() | InterpolationType | 获取此渐变条件的中点值的插值类型。 |
getMidValue() | String | 获取此渐变条件的中点值。 |
getMinColorObject() | Color | 获取为该渐变条件的最小值设置的颜色。 |
getMinType() | InterpolationType | 获取此渐变条件的最小值的插值类型。 |
getMinValue() | String | 获取此渐变条件的最小值。 |
Group
方法
方法 | 返回类型 | 简介 |
---|---|---|
collapse() | Group | 收起此群组。 |
expand() | Group | 展开此组。 |
getControlIndex() | Integer | 返回此组的控件切换开关索引。 |
getDepth() | Integer | 返回此组的深度。 |
getRange() | Range | 返回此组存在的范围。 |
isCollapsed() | Boolean | 如果此群组已收起,则返回 true 。 |
remove() | void | 从工作表中移除此群组,将 range 的群组深度减少 1。 |
GroupControlTogglePosition
属性
媒体资源 | 类型 | 说明 |
---|---|---|
BEFORE | Enum | 控件切换开关在组前面的位置(索引较低)。 |
AFTER | Enum | 控件切换开关位于组之后(索引更高)的位置。 |
InterpolationType
属性
媒体资源 | 类型 | 说明 |
---|---|---|
NUMBER | Enum | 将该数值用作渐变条件的特定插值点。 |
PERCENT | Enum | 将该数字用作渐变条件的百分比插值点。 |
PERCENTILE | Enum | 将该数值用作渐变条件的百分位插值点。 |
MIN | Enum | 推断最小数值,作为渐变条件的特定插值点。 |
MAX | Enum | 推断最大值,作为渐变条件的特定插值点。 |
NamedRange
方法
方法 | 返回类型 | 简介 |
---|---|---|
getName() | String | 获取此命名范围的名称。 |
getRange() | Range | 获取此命名范围引用的范围。 |
remove() | void | 删除此命名范围。 |
setName(name) | NamedRange | 设置/更新命名范围的名称。 |
setRange(range) | NamedRange | 设置/更新此命名范围的范围。 |
OverGridImage
方法
PageProtection
PivotFilter
方法
方法 | 返回类型 | 简介 |
---|---|---|
getFilterCriteria() | FilterCriteria | 返回此数据透视过滤条件的过滤条件。 |
getPivotTable() | PivotTable | 返回此过滤条件所属的 PivotTable 。 |
getSourceDataColumn() | Integer | 返回此过滤器处理的源数据列的数量。 |
getSourceDataSourceColumn() | DataSourceColumn | 返回对过滤器执行操作的数据源列。 |
remove() | void | 从数据透视表中移除此数据透视表过滤器。 |
setFilterCriteria(filterCriteria) | PivotFilter | 设置此数据透视过滤条件的过滤条件。 |
PivotGroup
方法
PivotGroupLimit
方法
方法 | 返回类型 | 简介 |
---|---|---|
getCountLimit() | Integer | 获取数据透视表元素组中的行数或列数。 |
getPivotGroup() | PivotGroup | 返回限制所属的数据透视组。 |
remove() | void | 取消了数据透视组限制。 |
setCountLimit(countLimit) | PivotGroupLimit | 设置数据透视表元素行中的行数或列数。 |
PivotTable
方法
方法 | 返回类型 | 简介 |
---|---|---|
addCalculatedPivotValue(name, formula) | PivotValue | 在数据透视表中创建新的数据透视表值,根据指定的 formula 和指定的 name 计算得出。 |
addColumnGroup(sourceDataColumn) | PivotGroup | 在数据透视表中定义新的数据透视表列分组。 |
addFilter(sourceDataColumn, filterCriteria) | PivotFilter | 为数据透视表创建新的数据透视表过滤器。 |
addPivotValue(sourceDataColumn, summarizeFunction) | PivotValue | 在数据透视表中定义具有指定 summarizeFunction 的新数据透视表值。 |
addRowGroup(sourceDataColumn) | PivotGroup | 在数据透视表中定义新的数据透视表行分组。 |
asDataSourcePivotTable() | DataSourcePivotTable | 如果数据透视表已关联到 DataSource ,则返回数据透视表作为数据源数据透视表,否则返回 null 。 |
getAnchorCell() | Range | 返回表示锚定数据透视表的单元格的 Range 。 |
getColumnGroups() | PivotGroup[] | 返回此数据透视表中列组的有序列表。 |
getFilters() | PivotFilter[] | 返回此数据透视表中过滤条件的有序列表。 |
getPivotValues() | PivotValue[] | 返回此数据透视表中数据透视表值的有序列表。 |
getRowGroups() | PivotGroup[] | 返回此数据透视表中行组的有序列表。 |
getSourceDataRange() | Range | 返回构建数据透视表的来源数据范围。 |
getValuesDisplayOrientation() | Dimension | 返回值是显示行还是列。 |
remove() | void | 删除此数据透视表。 |
setValuesDisplayOrientation(dimension) | PivotTable | 设置此数据透视表的布局,使其以列或行的形式显示。 |
PivotTableSummarizeFunction
属性
媒体资源 | 类型 | 说明 |
---|---|---|
CUSTOM | Enum | 自定义函数,此值仅对计算字段有效。 |
SUM | Enum | SUM 函数 |
COUNTA | Enum | COUNTA 函数 |
COUNT | Enum | COUNT 函数 |
COUNTUNIQUE | Enum | COUNTUNIQUE 函数 |
AVERAGE | Enum | AVERAGE 函数 |
MAX | Enum | MAX 函数 |
MIN | Enum | MIN 函数 |
MEDIAN | Enum | MEDIAN 函数 |
PRODUCT | Enum | PRODUCT 函数 |
STDEV | Enum | STDEV 函数 |
STDEVP | Enum | STDEVP 函数 |
VAR | Enum | VAR 函数 |
VARP | Enum | VARP 函数 |
PivotValue
方法
方法 | 返回类型 | 简介 |
---|