初心者でもわかるGoogle Apps Script活用のススメ

今日からGoogleスプレッドシートで使えるGASのコード一覧

Google Apps Scriptではスプレッドシートを操作するための基本的なコードがSpreadsheetAppという名称で用意されています。
今回は、SpreadsheetAppのリファレンスを用意しました。コードの数がかなり多いですが、非常によく使う機能が集まっていますので、プログラマーを目指していなくても、作業効率が飛躍的に向上しますのでぜひ覚えてほしいコード達です。

SpreadsheetAppの概要

SpreadsheetAppとは、Google Apps ScriptでGoogleスプレッドシートの操作を行う際に利用するコードのことですが、SpreadsheetAppでは、みなさんが普段スプレッドシートを操作して実行していることをプログラムで実行するための様々なコードが用意されています。
例えば、

などなど、手動でできる操作はプログラムでもほとんど実現することができます。

本ページでは、SpreadsheetAppで利用可能なメソッドなどを一覧でアクセスできるようにしてあります。
説明欄が英語のところはまだ記事を書いていないためリンク先はGoogleの公式ドキュメントになっています。順次使い方解説ページの投稿を増やしていく予定です。

クラス名一覧

BandingBigQueryDataSourceSpecBigQueryDataSourceSpecBuilder
BooleanConditionColorColorBuilder
ConditionalFormatRuleConditionalFormatRuleBuilderContainerInfo
DataExecutionStatusDataSourceDataSourceChart
DataSourceColumnDataSourceFormulaDataSourceParameter
DataSourcePivotTableDataSourceRefreshScheduleDataSourceRefreshScheduleFrequency
DataSourceSheetDataSourceSheetFilterDataSourceSpec
DataSourceSpecBuilderDataSourceTableDataSourceTableColumn
DataSourceTableFilterDataValidationDataValidationBuilder
DateTimeGroupingRuleDeveloperMetadataDeveloperMetadataFinder
DeveloperMetadataLocationDrawingEmbeddedAreaChartBuilder
EmbeddedBarChartBuilderEmbeddedChartEmbeddedChartBuilder
EmbeddedColumnChartBuilderEmbeddedComboChartBuilderEmbeddedHistogramChartBuilder
EmbeddedLineChartBuilderEmbeddedPieChartBuilderEmbeddedScatterChartBuilder
EmbeddedTableChartBuilderFilterFilterCriteria
FilterCriteriaBuilderGradientConditionGroup
NamedRangeOverGridImagePivotFilter
PivotGroupPivotGroupLimitPivotTable
PivotValueProtectionRange
RangeListRichTextValueRichTextValueBuilder
SelectionSheetSlicer
SortSpecSpreadsheetSpreadsheetApp
SpreadsheetThemeTextFinderTextRotation
TextStyleTextStyleBuilderThemeColor

列挙型一覧

AutoFillSeriesBandingThemeBooleanCriteria
BorderStyleDataExecutionErrorCodeDataExecutionState
DataSourceRefreshScopeDataSourceTypeDataValidationCriteria
DateTimeGroupingRuleTypeDeveloperMetadataLocationTypeDeveloperMetadataVisibility
DimensionDirectionFrequencyType
GroupControlTogglePositionInterpolationTypePivotTableSummarizeFunction
PivotValueDisplayTypeProtectionTypeRecalculationInterval
RelativeDateSheetTypeSortOrder
TextDirectionTextToColumnsDelimiterThemeColorType
WrapStrategy

クラス別メソッド一覧

Class Banding

メソッド名返り値簡単な説明
copyToBandingCopies this banding to another range.
getFirstColumnColorStringReturns the first column color that is alternating, or nullif no color is set.
getFirstColumnColorObjectColorReturns the first alternating column color in the banding, or nullif no color is set.
getFirstRowColorStringReturns the first row color that is alternating or null if no color is set.
getFirstRowColorObjectColorReturns the first alternating row color, or nullif no color is set.
getFooterColumnColorStringReturns the color of the last column, or nullif no color is set.
getFooterColumnColorObjectColorReturns the color of the last column in the banding, or nullif no color is set.
getFooterRowColorStringReturns the color of the last row, or nullif no color is set.
getFooterRowColorObjectColorReturns the last row color in the banding, or nullif no color is set.
getHeaderColumnColorStringReturns the color of the header column, or nullif no color is set.
getHeaderColumnColorObjectColorReturns the color of the first column in the banding, or nullif no color is set.
getHeaderRowColorStringReturns the color of the header row or nullif no color is set.
getHeaderRowColorObjectColorReturns the color of the header row or nullif no color is set.
getRangeRangeReturns the range for this banding.
getSecondColumnColorStringReturns the second column color that is alternating, or nullif no color is set.
getSecondColumnColorObjectColorReturns the second alternating column color in the banding, or nullif no color is set.
getSecondRowColorStringReturns the second row color that is alternating or null if no color is set.
getSecondRowColorObjectColorReturns the second alternating row color, or nullif no color is set.
removevoidRemoves this banding.
setFirstColumnColorBandingSets the first column color that is alternating.
setFirstColumnColorObjectBandingSets the first alternating column color in the banding.
setFirstRowColorBandingSets the first row color that is alternating.
setFirstRowColorObjectBandingSets the first alternating row color in the banding.
setFooterColumnColorBandingSets the color of the last column.
setFooterColumnColorObjectBandingSets the color of the last column in the banding.
setFooterRowColorBandingSets the color of the last row.
setFooterRowColorObjectBandingSets the color of the footer row in the banding.
setHeaderColumnColorBandingSets the color of the header column.
setHeaderColumnColorObjectBandingSets the color of the header column.
setHeaderRowColorBandingSets the color of the header row.
setHeaderRowColorObjectBandingSets the color of the header row.
setRangeBandingSets the range for this banding.
setSecondColumnColorBandingSets the second column color that is alternating.
setSecondColumnColorObjectBandingSets the second alternating column color in the banding.
setSecondRowColorBandingSets the second row color that is alternating.
setSecondRowColorObjectBandingSets the second alternating color in the banding.

Class BigQueryDataSourceSpec

メソッド名返り値簡単な説明
copyDataSourceSpecBuilderCreates a DataSourceSpecBuilder based on this data source’s settings.
getDatasetIdStringGets the BigQuery dataset ID.
getParametersDataSourceParameter[]Gets the parameters of the data source.
getProjectIdStringGets the billing project ID.
getRawQueryStringGets the raw query string.
getTableIdStringGets the BigQuery table ID.
getTableProjectIdStringGets the BigQuery project ID for the table.
getTypeDataSourceTypeGets the type of the data source.

Class BigQueryDataSourceSpecBuilder

メソッド名返り値簡単な説明
buildDataSourceSpecBuilds a data source specification from the settings in this builder.
copyDataSourceSpecBuilderCreates a DataSourceSpecBuilder based on this data source’s settings.
getDatasetIdStringGets the BigQuery dataset ID.
getParametersDataSourceParameter[]Gets the parameters of the data source.
getProjectIdStringGets the billing project ID.
getRawQueryStringGets the raw query string.
getTableIdStringGets the BigQuery table ID.
getTableProjectIdStringGets the BigQuery project ID for the table.
getTypeDataSourceTypeGets the type of the data source.
removeAllParametersBigQueryDataSourceSpecBuilderRemoves all the parameters.
removeParameterBigQueryDataSourceSpecBuilderRemoves the specified parameter.
setDatasetIdBigQueryDataSourceSpecBuilderSets the BigQuery dataset ID.
setParameterFromCellBigQueryDataSourceSpecBuilderAdds a parameter, or if the parameter with the name exists, updates its source cell.
setProjectIdBigQueryDataSourceSpecBuilderSets the billing BigQuery project ID.
setRawQueryBigQueryDataSourceSpecBuilderSets the raw query string.
setTableIdBigQueryDataSourceSpecBuilderSets the BigQuery table ID.
setTableProjectIdBigQueryDataSourceSpecBuilderSets the BigQuery project ID for the table.

Class BooleanCondition

メソッド名返り値簡単な説明
getBackgroundStringGets the background color string for this boolean condition.
getBackgroundObjectColorGets the background color for this boolean condition.
getBoldBooleanReturns true if this boolean condition bolds the text and returns false if this boolean condition removes bolding from the text.
getCriteriaTypeBooleanCriteriaGets the rule’s criteria type as defined in the BooleanCriteria enum.
getCriteriaValuesObject[]Gets an array of arguments for the rule’s criteria.
getFontColorStringGets the font color string for this boolean condition.
getFontColorObjectColorGets the font color for this boolean condition.
getItalicBooleanReturns true if this boolean condition italicises the text and returns false if this boolean condition removes italics from the text.
getStrikethroughBooleanReturns true if this boolean condition strikes through the text and returns false if this boolean condition removes strikethrough from the text.
getUnderlineBooleanReturns true if this boolean condition underlines the text and returns false if this boolean condition removes underlining from the text.

Class Color

メソッド名返り値簡単な説明
asRgbColorRgbColorConverts this color to an RgbColor.
asThemeColorThemeColorConverts this color to a ThemeColor.
getColorTypeColorTypeGet the type of this color.

Class ColorBuilder

メソッド名返り値簡単な説明
asRgbColorRgbColorConverts this color to an RgbColor.
asThemeColorThemeColorConverts this color to a ThemeColor.
buildColorCreates a color object from the settings supplied to the builder.
getColorTypeColorTypeGet the type of this color.
setRgbColorColorBuilderSets as RGB color.
setThemeColorColorBuilderSets as theme color.

Class ConditionalFormatRule

メソッド名返り値簡単な説明
copyConditionalFormatRuleBuilderReturns a rule builder preset with this rule’s settings.
getBooleanConditionBooleanConditionRetrieves the rule’s BooleanCondition information if this rule uses boolean condition criteria.
getGradientConditionGradientConditionRetrieves the rule’s GradientCondition information, if this rule uses gradient condition criteria.
getRangesRange[]Retrieves the ranges to which this conditional format rule is applied.

Class ConditionalFormatRuleBuilder

メソッド名返り値簡単な説明
buildConditionalFormatRuleConstructs a conditional format rule from the settings applied to the builder.
copyConditionalFormatRuleBuilderReturns a rule builder preset with this rule’s settings.
getBooleanConditionBooleanConditionRetrieves the rule’s BooleanCondition information if this rule uses boolean condition criteria.
getGradientConditionGradientConditionRetrieves the rule’s GradientCondition information, if this rule uses gradient condition criteria.
getRangesRange[]Retrieves the ranges to which this conditional format rule is applied.
setBackgroundConditionalFormatRuleBuilderSets the background color for the conditional format rule’s format.
setBackgroundObjectConditionalFormatRuleBuilderSets the background color for the conditional format rule’s format.
setBoldConditionalFormatRuleBuilderSets text bolding for the conditional format rule’s format.
setFontColorConditionalFormatRuleBuilderSets the font color for the conditional format rule’s format.
setFontColorObjectConditionalFormatRuleBuilderSets the font color for the conditional format rule’s format.
setGradientMaxpointConditionalFormatRuleBuilderClears the conditional format rule’s gradient maxpoint value, and instead uses the maximum value in the rule’s ranges.
setGradientMaxpointObjectConditionalFormatRuleBuilderClears the conditional format rule’s gradient maxpoint value, and instead uses the maximum value in the rule’s ranges.
setGradientMaxpointObjectWithValueConditionalFormatRuleBuilderSets the conditional format rule’s gradient maxpoint fields.
setGradientMaxpointWithValueConditionalFormatRuleBuilderSets the conditional format rule’s gradient maxpoint fields.
setGradientMidpointObjectWithValueConditionalFormatRuleBuilderSets the conditional format rule’s gradient midpoint fields.
setGradientMidpointWithValueConditionalFormatRuleBuilderSets the conditional format rule’s gradient midpoint fields.
setGradientMinpointConditionalFormatRuleBuilderClears the conditional format rule’s gradient minpoint value, and instead uses the minimum value in the rule’s ranges.
setGradientMinpointObjectConditionalFormatRuleBuilderClears the conditional format rule’s gradient minpoint value, and instead uses the minimum value in the rule’s ranges.
setGradientMinpointObjectWithValueConditionalFormatRuleBuilderSets the conditional format rule’s gradient minpoint fields.
setGradientMinpointWithValueConditionalFormatRuleBuilderSets the conditional format rule’s gradient minpoint fields.
setItalicConditionalFormatRuleBuilderSets text italics for the conditional format rule’s format.
setRangesConditionalFormatRuleBuilderSets one or more ranges to which this conditional format rule is applied.
setStrikethroughConditionalFormatRuleBuilderSets text strikethrough for the conditional format rule’s format.
setUnderlineConditionalFormatRuleBuilderSets text underlining for the conditional format rule’s format.
whenCellEmptyConditionalFormatRuleBuilderセルが空欄の場合に適用される条件付き書式ルールを設定する。
whenCellNotEmptyConditionalFormatRuleBuilderセルが空欄でない場合に適用される条件付き書式ルールを設定する。
whenDateAfterConditionalFormatRuleBuilderSets the conditional format rule to trigger when a date is after the given value.
whenDateAfterConditionalFormatRuleBuilderSets the conditional format rule to trigger when a date is after the given relative date.
whenDateBeforeConditionalFormatRuleBuilderSets the conditional format rule to trigger when a date is before the given date.
whenDateBeforeConditionalFormatRuleBuilderSets the conditional format rule to trigger when a date is before the given relative date.
whenDateEqualToConditionalFormatRuleBuilderSets the conditional format rule to trigger when a date is equal to the given date.
whenDateEqualToConditionalFormatRuleBuilderSets the conditional format rule to trigger when a date is equal to the given relative date.
whenFormulaSatisfiedConditionalFormatRuleBuilderSets the conditional format rule to trigger when that the given formula evaluates to true.
whenNumberBetweenConditionalFormatRuleBuilderSets the conditional format rule to trigger when a number falls between, or is either of, two specified values.
whenNumberEqualToConditionalFormatRuleBuilderSets the conditional format rule to trigger when a number is equal to the given value.
whenNumberGreaterThanConditionalFormatRuleBuilderSets the conditional format rule to trigger when a number is greater than the given value.
whenNumberGreaterThanOrEqualToConditionalFormatRuleBuilderSets the conditional format rule to trigger when a number is greater than or equal to the given value.
whenNumberLessThanConditionalFormatRuleBuilderSets the conditional conditional format rule to trigger when a number less than the given value.
whenNumberLessThanOrEqualToConditionalFormatRuleBuilderSets the conditional format rule to trigger when a number less than or equal to the given value.
whenNumberNotBetweenConditionalFormatRuleBuilderSets the conditional format rule to trigger when a number does not fall between, and is neither of, two specified values.
whenNumberNotEqualToConditionalFormatRuleBuilderSets the conditional format rule to trigger when a number is not equal to the given value.
whenTextContainsConditionalFormatRuleBuilderSets the conditional format rule to trigger when that the input contains the given value.
whenTextDoesNotContainConditionalFormatRuleBuilderSets the conditional format rule to trigger when that the input does not contain the given value.
whenTextEndsWithConditionalFormatRuleBuilderSets the conditional format rule to trigger when that the input ends with the given value.
whenTextEqualToConditionalFormatRuleBuilderSets the conditional format rule to trigger when that the input is equal to the given value.
whenTextStartsWithConditionalFormatRuleBuilderSets the conditional format rule to trigger when that the input starts with the given value.
withCriteriaConditionalFormatRuleBuilderSets the conditional format rule to criteria defined by BooleanCriteria values, typically taken from the criteria and arguments of an existing rule.

Class ContainerInfo

メソッド名返り値簡単な説明
getAnchorColumnIntegerThe chart’s left side is anchored in this column.
getAnchorRowIntegerThe chart’s top side is anchored in this row.
getOffsetXIntegerThe chart’s upper left hand corner is offset from the anchor column by this many pixels.
getOffsetYIntegerThe chart’s upper left hand corner is offset from the anchor row by this many pixels.

Class DataExecutionStatus

メソッド名返り値簡単な説明
getErrorCodeDataExecutionErrorCodeGets the error code of the data execution.
getErrorMessageStringGets the error message of the data execution.
getExecutionStateDataExecutionStateGets the state of the data execution.
getLastExecutionTimeDateGets the time the last data execution completed regardless of the execution state.
getLastRefreshedTimeDateGets the time the data last successfully refreshed.
isTruncatedBooleanReturns true if the data from last successful execution is truncated, or false otherwise.

Class DataSource

メソッド名返り値簡単な説明
createCalculatedColumnDataSourceColumnCreates a calculated column.
createDataSourcePivotTableOnNewSheetDataSourcePivotTableCreates a data source pivot table from this data source in the first cell of a new sheet.
createDataSourceTableOnNewSheetDataSourceTableCreates a data source table from this data source in the first cell of a new sheet.
getCalculatedColumnByNameDataSourceColumnReturns the calculated column in the data source that matches the column name.
getCalculatedColumnsDataSourceColumn[]Returns all the calculated columns in the data source.
getColumnsDataSourceColumn[]Returns all the columns in the data source.
getDataSourceSheetsDataSourceSheet[]Returns the data source sheets associated with this data source.
getSpecDataSourceSpecGets the data source specification.
refreshAllLinkedDataSourceObjectsvoidRefreshes all data source objects linked to the data source.
updateSpecDataSourceUpdates the data source specification and refreshes the data source objects linked with this data source with the new specification.
waitForAllDataExecutionsCompletionvoidWaits until all the current executions of the linked data source objects complete, timing out after the provided number of seconds.

Class DataSourceChart

メソッド名返り値簡単な説明
forceRefreshDataDataSourceChartRefreshes the data of this object regardless of the current state.
getDataSourceDataSourceGets the data source the object is linked to.
getStatusDataExecutionStatusGets the data execution status of the object.
refreshDataDataSourceChartRefreshes the data of the object.
waitForCompletionDataExecutionStatusWaits until the current execution completes, timing out after the provided number of seconds.

Class DataSourceColumn

メソッド名返り値簡単な説明
getDataSourceDataSourceGets the data source associated with the data source column.
getFormulaStringGets the formula for the data source column.
getNameStringGets the name for the data source column.
hasArrayDependencyBooleanReturns whether the column has an array dependency.
isCalculatedColumnBooleanReturns whether the column is a calculated column.
removevoidRemoves the data source column.
setFormulaDataSourceColumnSets the formula for the data source column.
setNameDataSourceColumnSets the name of the data source column.

Class DataSourceFormula

メソッド名返り値簡単な説明
forceRefreshDataDataSourceFormulaRefreshes the data of this object regardless of the current state.
getAnchorCellRangeReturns the Range representing the cell where this data source formula is anchored.
getDataSourceDataSourceGets the data source the object is linked to.
getDisplayValueStringReturns the display value of the data source formula.
getFormulaStringReturns the formula for this data source formula.
getStatusDataExecutionStatusGets the data execution status of the object.
refreshDataDataSourceFormulaRefreshes the data of the object.
setFormulaDataSourceFormulaUpdates the formula.
waitForCompletionDataExecutionStatusWaits until the current execution completes, timing out after the provided number of seconds.

Class DataSourceParameter

メソッド名返り値簡単な説明
getNameStringGets the parameter name.
getSourceCellStringGets the source cell the parameter is valued based on, or null if the parameter type is not DataSourceParameterType.CELL.
getTypeDataSourceParameterTypeGets the parameter type.

Class DataSourcePivotTable

メソッド名返り値簡単な説明
addColumnGroupPivotGroupAdds a new pivot column group based on the specified data source column.
addFilterPivotFilterAdds a new filter based on the specified data source column with the specified filter criteria.
addPivotValuePivotValueAdds a new pivot value based on the specified data source column with the specified summarize function.
addRowGroupPivotGroupAdds a new pivot row group based on the specified data source column.
asPivotTablePivotTableReturns the data source pivot table as a regular pivot table object.
forceRefreshDataDataSourcePivotTableRefreshes the data of this object regardless of the current state.
getDataSourceDataSourceGets the data source the object is linked to.
getStatusDataExecutionStatusGets the data execution status of the object.
refreshDataDataSourcePivotTableRefreshes the data of the object.
waitForCompletionDataExecutionStatusWaits until the current execution completes, timing out after the provided number of seconds.

Class DataSourceRefreshSchedule

メソッド名返り値簡単な説明
getFrequencyDataSourceRefreshScheduleFrequencyGets the refresh schedule frequency, which specifies how often and when to refresh.
getScopeDataSourceRefreshScopeGets the scope of this refresh schedule.
getTimeIntervalOfNextRunTimeIntervalGets the time window of the next run of this refresh schedule.
isEnabledBooleanDetermines whether this refresh schedule is enabled.

Class DataSourceRefreshScheduleFrequency

メソッド名返り値簡単な説明
getDaysOfTheMonthInteger[]Gets the days of the month as numbers (1-28) on which to refresh the data source.
getDaysOfTheWeekWeekday[]Gets the days of the week on which to refresh the data source.
getFrequencyTypeFrequencyTypeGets the frequency type.
getStartHourIntegerGets the start hour (as a number 0-23) of the time interval during which the refresh schedule runs.

Class DataSourceSheet

メソッド名返り値簡単な説明
addFilterDataSourceSheetAdds a filter applied to the data source sheet.
asSheetSheetReturns the data source sheet as a regular sheet object.
autoResizeColumnDataSourceSheetAuto resizes the width of the specified column.
autoResizeColumnsDataSourceSheetAuto resizes the width of the specified columns.
forceRefreshDataDataSourceSheetRefreshes the data of this object regardless of the current state.
getColumnWidthIntegerReturns the width of the specified column.
getDataSourceDataSourceGets the data source the object is linked to.
getFiltersDataSourceSheetFilter[]Returns all filters applied to the data source sheet.
getSheetValuesObject[]Returns all the values for the data source sheet for the provided column name.
getSortSpecsSortSpec[]Gets all the sort specs in the data source sheet.
getStatusDataExecutionStatusGets the data execution status of the object.
refreshDataDataSourceSheetRefreshes the data of the object.
removeFiltersDataSourceSheetRemoves all filters applied to the data source sheet column.
removeSortSpecDataSourceSheetRemoves the sort spec on a column in the data source sheet.
setColumnWidthDataSourceSheetSets the width of the specified column.
setColumnWidthsDataSourceSheetSets the width of the specified columns.
setSortSpecDataSourceSheetSets the sort spec on a column in the data source sheet.
waitForCompletionDataExecutionStatusWaits until the current execution completes, timing out after the provided number of seconds.

Class DataSourceSheetFilter

メソッド名返り値簡単な説明
getDataSourceColumnDataSourceColumnReturns the data source column this filter applies to.
getDataSourceSheetDataSourceSheetReturns the DataSourceSheet that this filter belongs to.
getFilterCriteriaFilterCriteriaReturns the filter criteria for this filter.
removevoidRemoves this filter from the data source object.
setFilterCriteriaDataSourceSheetFilterSets the filter criteria for this filter.

Class DataSourceSpec

メソッド名返り値簡単な説明
asBigQueryBigQueryDataSourceSpecGets the spec for BigQuery data source.
copyDataSourceSpecBuilderCreates a DataSourceSpecBuilder based on this data source’s settings.
getParametersDataSourceParameter[]Gets the parameters of the data source.
getTypeDataSourceTypeGets the type of the data source.

Class DataSourceSpecBuilder

メソッド名返り値簡単な説明
asBigQueryBigQueryDataSourceSpecBuilderGets the builder for BigQuery data source.
buildDataSourceSpecBuilds a data source specification from the settings in this builder.
copyDataSourceSpecBuilderCreates a DataSourceSpecBuilder based on this data source’s settings.
getParametersDataSourceParameter[]Gets the parameters of the data source.
getTypeDataSourceTypeGets the type of the data source.
removeAllParametersDataSourceSpecBuilderRemoves all the parameters.
removeParameterDataSourceSpecBuilderRemoves the specified parameter.
setParameterFromCellDataSourceSpecBuilderAdds a parameter, or if the parameter with the name exists, updates its source cell.

Class DataSourceTable

メソッド名返り値簡単な説明
addColumnsDataSourceTableAdds columns to the data source table.
addFilterDataSourceTableAdds a filter applied to the data source table.
addSortSpecDataSourceTableAdds a sort spec on a column in the data source table.
addSortSpecDataSourceTableAdds a sort spec on a column in the data source table.
forceRefreshDataDataSourceTableRefreshes the data of this object regardless of the current state.
getColumnsDataSourceTableColumn[]Gets all the data source columns added to the data source table.
getDataSourceDataSourceGets the data source the object is linked to.
getFiltersDataSourceTableFilter[]Returns all filters applied to the data source table.
getRangeRangeGets the Range this data source table spans.
getRowLimitIntegerReturns the row limit for the data source table.
getSortSpecsSortSpec[]Gets all the sort specs in the data source table.
getStatusDataExecutionStatusGets the data execution status of the object.
isSyncingAllColumnsBooleanReturns whether the data source table is syncing all columns in the associated data source.
refreshDataDataSourceTableRefreshes the data of the object.
removeAllColumnsDataSourceTableRemoves all the columns in the data source table.
removeAllSortSpecsDataSourceTableRemoves all the sort specs in the data source table.
setRowLimitDataSourceTableUpdates the row limit for the data source table.
syncAllColumnsDataSourceTableSync all current and future columns in the associated data source to the data source table.
waitForCompletionDataExecutionStatusWaits until the current execution completes, timing out after the provided number of seconds.

Class DataSourceTableColumn

メソッド名返り値簡単な説明
getDataSourceColumnDataSourceColumnGets the data souce column.
removevoidRemoves the column from the DataSourceTable.

Class DataSourceTableFilter

メソッド名返り値簡単な説明
getDataSourceColumnDataSourceColumnReturns the data source column this filter applies to.
getDataSourceTableDataSourceTableReturns the DataSourceTable that this filter belongs to.
getFilterCriteriaFilterCriteriaReturns the filter criteria for this filter.
removevoidRemoves this filter from the data source object.
setFilterCriteriaDataSourceTableFilterSets the filter criteria for this filter.

Class DataValidation

メソッド名返り値簡単な説明
copyDataValidationBuilderCreates a builder for a data validation rule based on this rule’s settings.
getAllowInvalidBooleanReturns true if the rule shows a warning when input fails data validation, or false if it rejects the input entirely.
getCriteriaTypeDataValidationCriteriaGets the rule’s criteria type as defined in the DataValidationCriteria enum.
getCriteriaValuesObject[]Gets an array of arguments for the rule’s criteria.
getHelpTextStringGets the rule’s help text, or null if no help text is set.

Class DataValidationBuilder

メソッド名返り値簡単な説明
buildDataValidationConstructs a data validation rule from the settings applied to the builder.
copyDataValidationBuilderCreates a builder for a data validation rule based on this rule’s settings.
getAllowInvalidBooleanReturns true if the rule shows a warning when input fails data validation, or false if it rejects the input entirely.
getCriteriaTypeDataValidationCriteriaGets the rule’s criteria type as defined in the DataValidationCriteria enum.
getCriteriaValuesObject[]Gets an array of arguments for the rule’s criteria.
getHelpTextStringGets the rule’s help text, or null if no help text is set.
requireCheckboxDataValidationBuilderSets the data validation rule to require that the input is a boolean value; this value is rendered as a checkbox.
requireDateDataValidationBuilderSets the data validation rule to require a date.
requireDateAfterDataValidationBuilderSets the data validation rule to require a date after the given value.
requireDateBeforeDataValidationBuilderSets the data validation rule to require a date before the given value.
requireDateBetweenDataValidationBuilderSets the data validation rule to require a date that falls between, or is either of, two specified dates.
requireDateEqualToDataValidationBuilderSets the data validation rule to require a date equal to the given value.
requireDateNotBetweenDataValidationBuilderSets the data validation rule to require a date that does not fall between, and is neither of, two specified dates.
requireDateOnOrAfterDataValidationBuilderSets the data validation rule to require a date on or after the given value.
requireDateOnOrBeforeDataValidationBuilderSets the data validation rule to require a date on or before the given value.
requireFormulaSatisfiedDataValidationBuilderSets the data validation rule to require that the given formula evaluates to true.
requireNumberBetweenDataValidationBuilderSets the data validation rule to require a number that falls between, or is either of, two specified numbers.
requireNumberEqualToDataValidationBuilderSets the data validation rule to require a number equal to the given value.
requireNumberGreaterThanDataValidationBuilderSets the data validation rule to require a number greater than the given value.
requireNumberGreaterThanOrEqualToDataValidationBuilderSets the data validation rule to require a number greater than or equal to the given value.
requireNumberLessThanDataValidationBuilderSets the data validation rule to require a number less than the given value.
requireNumberLessThanOrEqualToDataValidationBuilderSets the data validation rule to require a number less than or equal to the given value.
requireNumberNotBetweenDataValidationBuilderSets the data validation rule to require a number that does not fall between, and is neither of, two specified numbers.
requireNumberNotEqualToDataValidationBuilderSets the data validation rule to require a number not equal to the given value.
requireTextContainsDataValidationBuilderSets the data validation rule to require that the input contains the given value.
requireTextDoesNotContainDataValidationBuilderSets the data validation rule to require that the input does not contain the given value.
requireTextEqualToDataValidationBuilderSets the data validation rule to require that the input is equal to the given value.
requireTextIsEmailDataValidationBuilderSets the data validation rule to require that the input is in the form of an email address.
requireTextIsUrlDataValidationBuilderSets the data validation rule to require that the input is in the form of a URL.
requireValueInListDataValidationBuilderSets the data validation rule to require that the input is equal to one of the given values.
requireValueInRangeDataValidationBuilderSets the data validation rule to require that the input is equal to a value in the given range.
setAllowInvalidDataValidationBuilderSets whether to show a warning when input fails data validation or whether to reject the input entirely.
setHelpTextDataValidationBuilderSets the help text that appears when the user hovers over the cell on which data validation is set.
withCriteriaDataValidationBuilderSets the data validation rule to criteria defined by DataValidationCriteria values, typically taken from the criteria and arguments of an existing rule.

Class DateTimeGroupingRule

メソッド名返り値簡単な説明
getRuleTypeDateTimeGroupingRuleTypeGets the type of the date-time grouping rule.

Class DeveloperMetadata

メソッド名返り値簡単な説明
getIdIntegerReturns the unique ID associated with this developer metadata.
getKeyStringReturns the key associated with this developer metadata.
getLocationDeveloperMetadataLocationReturns the location of this developer metadata.
getValueStringReturns the value associated with this developer metadata, or null if this metadata has no value.
getVisibilityDeveloperMetadataVisibilityReturns the visibility of this developer metadata.
moveToColumnDeveloperMetadataMoves this developer metadata to the specified column.
moveToRowDeveloperMetadataMoves this developer metadata to the specified row.
moveToSheetDeveloperMetadataMoves this developer metadata to the specified sheet.
moveToSpreadsheetDeveloperMetadataMoves this developer metadata to the top-level spreadsheet.
removevoidDeletes this metadata.
setKeyDeveloperMetadataSets the key of this developer metadata to the specified value.
setValueDeveloperMetadataSets the value associated with this developer metadata to the specified value.
setVisibilityDeveloperMetadataSets the visibility of this developer metadata to the specified visibility.

Class DeveloperMetadataFinder

メソッド名返り値簡単な説明
findDeveloperMetadata[]Executes this search and returns the matching metadata.
onIntersectingLocationsDeveloperMetadataFinderConfigures the search to consider intersecting locations that have metadata.
withIdDeveloperMetadataFinderLimits this search to consider only metadata that match the specified ID.
withKeyDeveloperMetadataFinderLimits this search to consider only metadata that match the specified key.
withLocationTypeDeveloperMetadataFinderLimits this search to consider only metadata that match the specified location type.
withValueDeveloperMetadataFinderLimits this search to consider only metadata that match the specified value.
withVisibilityDeveloperMetadataFinderLimits this search to consider only metadata that match the specified visibility.

Class DeveloperMetadataLocation

メソッド名返り値簡単な説明
getColumnRangeReturns the Range for the column location of this metadata, or null if the location type is not DeveloperMetadataLocationType.COLUMN.
getLocationTypeDeveloperMetadataLocationTypeGets the type of location.
getRowRangeReturns the Range for the row location of this metadata, or null if the location type is not DeveloperMetadataLocationType.ROW.
getSheetSheetReturns the Sheet location of this metadata, or null if the location type is not DeveloperMetadataLocationType.SHEET.
getSpreadsheetSpreadsheetReturns the Spreadsheet location of this metadata, or null if the location type is not DeveloperMetadataLocationType.SPREADSHEET.

Class Drawing

メソッド名返り値簡単な説明
getContainerInfoContainerInfoGets information about where the drawing is positioned in the sheet.
getHeightIntegerReturns the actual height of this drawing in pixels.
getOnActionStringReturns the name of the macro attached to this drawing.
getSheetSheetReturns the sheet this drawing appears on.
getWidthIntegerReturns the actual width of this drawing in pixels.
getZIndexNumberReturns the z-index of this drawing.
removevoidDeletes this drawing from the spreadsheet.
setHeightDrawingSets the actual height of this drawing in pixels.
setOnActionDrawingAssigns a macro function to this drawing.
setPositionDrawingSets the position where the drawing appears on the sheet.
setWidthDrawingSets the actual width of this drawing in pixels.
setZIndexDrawingSets the z-index of this drawing.

Class EmbeddedAreaChartBuilder

メソッド名返り値簡単な説明
addRangeEmbeddedChartBuilderAdds a range to the chart this builder modifies.
asAreaChartEmbeddedAreaChartBuilderSets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder.
asBarChartEmbeddedBarChartBuilderSets the chart type to BarChart and returns an EmbeddedBarChartBuilder.
asColumnChartEmbeddedColumnChartBuilderSets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder.
asComboChartEmbeddedComboChartBuilderSets the chart type to ComboChart and returns an EmbeddedComboChartBuilder.
asHistogramChartEmbeddedHistogramChartBuilderSets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder.
asLineChartEmbeddedLineChartBuilderSets the chart type to LineChart and returns an EmbeddedLineChartBuilder.
asPieChartEmbeddedPieChartBuilderSets the chart type to PieChart and returns an EmbeddedPieChartBuilder.
asScatterChartEmbeddedScatterChartBuilderSets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder.
asTableChartEmbeddedTableChartBuilderSets the chart type to TableChart and returns an EmbeddedTableChartBuilder.
buildEmbeddedChartBuilds the chart to reflect all changes made to it.
clearRangesEmbeddedChartBuilderRemoves all ranges from the chart this builder modifies.
getChartTypeChartTypeReturns the current chart type.
getContainerContainerInfoReturn the chart ContainerInfo, which encapsulates where the chart appears on the sheet.
getRangesRange[]Returns a copy of the list of ranges currently providing data for this chart.
removeRangeEmbeddedChartBuilderRemoves the specified range from the chart this builder modifies.
reverseCategoriesEmbeddedBarChartBuilderReverses the drawing of series in the domain axis.
reverseDirectionEmbeddedBarChartBuilderReverses the direction in which the bars grow along the horizontal axis.
setBackgroundColorEmbeddedBarChartBuilderSets the background color for the chart.
setChartTypeEmbeddedChartBuilderChanges the type of chart.
setColorsEmbeddedBarChartBuilderSets the colors for the lines in the chart.
setHiddenDimensionStrategyEmbeddedChartBuilderSets the strategy to use for hidden rows and columns.
setLegendPositionEmbeddedBarChartBuilderSets the position of the legend with respect to the chart.
setLegendTextStyleEmbeddedBarChartBuilderSets the text style of the chart legend.
setMergeStrategyEmbeddedChartBuilderSets the merge strategy to use when more than one range exists.
setNumHeadersEmbeddedChartBuilderSets the number of rows or columns of the range that should be treated as headers.
setOptionEmbeddedChartBuilderSets advanced options for this chart.
setPositionEmbeddedChartBuilderSets the position, changing where the chart appears on the sheet.
setRangeEmbeddedBarChartBuilderSets the range for the chart.
setStackedEmbeddedBarChartBuilderUses stacked lines, meaning that line and bar values are stacked (accumulated).
setTitleEmbeddedBarChartBuilderSets the title of the chart.
setTitleTextStyleEmbeddedBarChartBuilderSets the text style of the chart title.
setTransposeRowsAndColumnsEmbeddedChartBuilderSets whether the chart’s rows and columns are transposed.
setXAxisTextStyleEmbeddedBarChartBuilderSets the horizontal axis text style.
setXAxisTitleEmbeddedBarChartBuilderAdds a title to the horizontal axis.
setXAxisTitleTextStyleEmbeddedBarChartBuilderSets the horizontal axis title text style.
setYAxisTextStyleEmbeddedBarChartBuilderSets the vertical axis text style.
setYAxisTitleEmbeddedBarChartBuilderAdds a title to the vertical axis.
setYAxisTitleTextStyleEmbeddedBarChartBuilderSets the vertical axis title text style.
useLogScaleEmbeddedBarChartBuilderMakes the range axis into a logarithmic scale (requires all values to be positive).

Class EmbeddedBarChartBuilder

メソッド名返り値簡単な説明
addRangeEmbeddedChartBuilderAdds a range to the chart this builder modifies.
asAreaChartEmbeddedAreaChartBuilderSets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder.
asBarChartEmbeddedBarChartBuilderSets the chart type to BarChart and returns an EmbeddedBarChartBuilder.
asColumnChartEmbeddedColumnChartBuilderSets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder.
asComboChartEmbeddedComboChartBuilderSets the chart type to ComboChart and returns an EmbeddedComboChartBuilder.
asHistogramChartEmbeddedHistogramChartBuilderSets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder.
asLineChartEmbeddedLineChartBuilderSets the chart type to LineChart and returns an EmbeddedLineChartBuilder.
asPieChartEmbeddedPieChartBuilderSets the chart type to PieChart and returns an EmbeddedPieChartBuilder.
asScatterChartEmbeddedScatterChartBuilderSets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder.
asTableChartEmbeddedTableChartBuilderSets the chart type to TableChart and returns an EmbeddedTableChartBuilder.
buildEmbeddedChartBuilds the chart to reflect all changes made to it.
clearRangesEmbeddedChartBuilderRemoves all ranges from the chart this builder modifies.
getChartTypeChartTypeReturns the current chart type.
getContainerContainerInfoReturn the chart ContainerInfo, which encapsulates where the chart appears on the sheet.
getRangesRange[]Returns a copy of the list of ranges currently providing data for this chart.
removeRangeEmbeddedChartBuilderRemoves the specified range from the chart this builder modifies.
reverseCategoriesEmbeddedBarChartBuilderReverses the drawing of series in the domain axis.
reverseDirectionEmbeddedBarChartBuilderReverses the direction in which the bars grow along the horizontal axis.
setBackgroundColorEmbeddedBarChartBuilderSets the background color for the chart.
setChartTypeEmbeddedChartBuilderChanges the type of chart.
setColorsEmbeddedBarChartBuilderSets the colors for the lines in the chart.
setHiddenDimensionStrategyEmbeddedChartBuilderSets the strategy to use for hidden rows and columns.
setLegendPositionEmbeddedBarChartBuilderSets the position of the legend with respect to the chart.
setLegendTextStyleEmbeddedBarChartBuilderSets the text style of the chart legend.
setMergeStrategyEmbeddedChartBuilderSets the merge strategy to use when more than one range exists.
setNumHeadersEmbeddedChartBuilderSets the number of rows or columns of the range that should be treated as headers.
setOptionEmbeddedChartBuilderSets advanced options for this chart.
setPositionEmbeddedChartBuilderSets the position, changing where the chart appears on the sheet.
setRangeEmbeddedBarChartBuilderSets the range for the chart.
setStackedEmbeddedBarChartBuilderUses stacked lines, meaning that line and bar values are stacked (accumulated).
setTitleEmbeddedBarChartBuilderSets the title of the chart.
setTitleTextStyleEmbeddedBarChartBuilderSets the text style of the chart title.
setTransposeRowsAndColumnsEmbeddedChartBuilderSets whether the chart’s rows and columns are transposed.
setXAxisTextStyleEmbeddedBarChartBuilderSets the horizontal axis text style.
setXAxisTitleEmbeddedBarChartBuilderAdds a title to the horizontal axis.
setXAxisTitleTextStyleEmbeddedBarChartBuilderSets the horizontal axis title text style.
setYAxisTextStyleEmbeddedBarChartBuilderSets the vertical axis text style.
setYAxisTitleEmbeddedBarChartBuilderAdds a title to the vertical axis.
setYAxisTitleTextStyleEmbeddedBarChartBuilderSets the vertical axis title text style.
useLogScaleEmbeddedBarChartBuilderMakes the range axis into a logarithmic scale (requires all values to be positive).

Class EmbeddedChart

メソッド名返り値簡単な説明
asDataSourceChartDataSourceChartCasts to a data source chart instance if the chart is a data source chart, or null otherwise.
getAsBlobReturn the data inside this object as a blob converted to the specified content type.
getBlobBlobReturn the data inside this object as a blob.
getChartIdIntegerReturns a stable identifier for the chart that is unique across the spreadsheet containing the chart or null if the chart is not in a spreadsheet.
getContainerInfoContainerInfoReturns information about where the chart is positioned within a sheet.
getHiddenDimensionStrategyChartHiddenDimensionStrategyReturns the strategy to use for handling hidden rows and columns.
getMergeStrategyChartMergeStrategyReturns the merge strategy used when more than one range exists.
getNumHeadersIntegerReturns the number of rows or columns the range that are treated as headers.
getOptionsChartOptionsReturns the options for this chart, such as height, colors, and axes.
getRangesRange[]Returns the ranges that this chart uses as a data source.
getTransposeRowsAndColumnsBooleanIf true, the rows and columns used to populate the chart are switched.
modifyEmbeddedChartBuilderReturns an EmbeddedChartBuilder that can be used to modify this chart.

Class EmbeddedChartBuilder

 メソッド名  返り値  簡単な説明
 addRange  EmbeddedChartBuilder  Adds a range to the chart this builder modifies.
 asAreaChart  EmbeddedAreaChartBuilder  Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder.
 asBarChart  EmbeddedBarChartBuilder  Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder.
 asColumnChart  EmbeddedColumnChartBuilder  Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder.
 asComboChart  EmbeddedComboChartBuilder  Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder.
 asHistogramChart  EmbeddedHistogramChartBuilder  Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder.
 asLineChart  EmbeddedLineChartBuilder  Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder.
 asPieChart  EmbeddedPieChartBuilder  Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder.
 asScatterChart  EmbeddedScatterChartBuilder  Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder.
 asTableChart  EmbeddedTableChartBuilder  Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder.
 build  EmbeddedChart  Builds the chart to reflect all changes made to it.
 clearRanges  EmbeddedChartBuilder  Removes all ranges from the chart this builder modifies.
 getChartType  ChartType  Returns the current chart type.
 getContainer  ContainerInfo  Return the chart ContainerInfo, which encapsulates where the chart appears on the sheet.
 getRanges  Range[]  Returns a copy of the list of ranges currently providing data for this chart.
 removeRange  EmbeddedChartBuilder  Removes the specified range from the chart this builder modifies.
 setChartType  EmbeddedChartBuilder  Changes the type of chart.
 setHiddenDimensionStrategy  EmbeddedChartBuilder  Sets the strategy to use for hidden rows and columns.
 setMergeStrategy  EmbeddedChartBuilder  Sets the merge strategy to use when more than one range exists.
 setNumHeaders  EmbeddedChartBuilder  Sets the number of rows or columns of the range that should be treated as headers.
 setOption  EmbeddedChartBuilder  Sets advanced options for this chart.
 setPosition  EmbeddedChartBuilder  Sets the position, changing where the chart appears on the sheet.
 setTransposeRowsAndColumns  EmbeddedChartBuilder  Sets whether the chart’s rows and columns are transposed.

Class EmbeddedColumnChartBuilder

 メソッド名  返り値  簡単な説明
 addRange  EmbeddedChartBuilder  Adds a range to the chart this builder modifies.
 asAreaChart  EmbeddedAreaChartBuilder  Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder.
 asBarChart  EmbeddedBarChartBuilder  Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder.
 asColumnChart  EmbeddedColumnChartBuilder  Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder.
 asComboChart  EmbeddedComboChartBuilder  Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder.
 asHistogramChart  EmbeddedHistogramChartBuilder  Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder.
 asLineChart  EmbeddedLineChartBuilder  Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder.
 asPieChart  EmbeddedPieChartBuilder  Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder.
 asScatterChart  EmbeddedScatterChartBuilder  Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder.
 asTableChart  EmbeddedTableChartBuilder  Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder.
 build  EmbeddedChart  Builds the chart to reflect all changes made to it.
 clearRanges  EmbeddedChartBuilder  Removes all ranges from the chart this builder modifies.
 getChartType  ChartType  Returns the current chart type.
 getContainer  ContainerInfo  Return the chart ContainerInfo, which encapsulates where the chart appears on the sheet.
 getRanges  Range[]  Returns a copy of the list of ranges currently providing data for this chart.
 removeRange  EmbeddedChartBuilder  Removes the specified range from the chart this builder modifies.
 reverseCategories  EmbeddedColumnChartBuilder  Reverses the drawing of series in the domain axis.
 setBackgroundColor  EmbeddedColumnChartBuilder  Sets the background color for the chart.
 setChartType  EmbeddedChartBuilder  Changes the type of chart.
 setColors  EmbeddedColumnChartBuilder  Sets the colors for the lines in the chart.
 setHiddenDimensionStrategy  EmbeddedChartBuilder  Sets the strategy to use for hidden rows and columns.
 setLegendPosition  EmbeddedColumnChartBuilder  Sets the position of the legend with respect to the chart.
 setLegendTextStyle  EmbeddedColumnChartBuilder  Sets the text style of the chart legend.
 setMergeStrategy  EmbeddedChartBuilder  Sets the merge strategy to use when more than one range exists.
 setNumHeaders  EmbeddedChartBuilder  Sets the number of rows or columns of the range that should be treated as headers.
 setOption  EmbeddedChartBuilder  Sets advanced options for this chart.
 setPosition  EmbeddedChartBuilder  Sets the position, changing where the chart appears on the sheet.
 setRange  EmbeddedColumnChartBuilder  Sets the range for the chart.
 setStacked  EmbeddedColumnChartBuilder  Uses stacked lines, meaning that line and bar values are stacked (accumulated).
 setTitle  EmbeddedColumnChartBuilder  Sets the title of the chart.
 setTitleTextStyle  EmbeddedColumnChartBuilder  Sets the text style of the chart title.
 setTransposeRowsAndColumns  EmbeddedChartBuilder  Sets whether the chart’s rows and columns are transposed.
 setXAxisTextStyle  EmbeddedColumnChartBuilder  Sets the horizontal axis text style.
 setXAxisTitle  EmbeddedColumnChartBuilder  Adds a title to the horizontal axis.
 setXAxisTitleTextStyle  EmbeddedColumnChartBuilder  Sets the horizontal axis title text style.
 setYAxisTextStyle  EmbeddedColumnChartBuilder  Sets the vertical axis text style.
 setYAxisTitle  EmbeddedColumnChartBuilder  Adds a title to the vertical axis.
 setYAxisTitleTextStyle  EmbeddedColumnChartBuilder  Sets the vertical axis title text style.
 useLogScale  EmbeddedColumnChartBuilder  Makes the range axis into a logarithmic scale (requires all values to be positive).

Class EmbeddedComboChartBuilder

 メソッド名  返り値  簡単な説明
 addRange  EmbeddedChartBuilder  Adds a range to the chart this builder modifies.
 asAreaChart  EmbeddedAreaChartBuilder  Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder.
 asBarChart  EmbeddedBarChartBuilder  Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder.
 asColumnChart  EmbeddedColumnChartBuilder  Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder.
 asComboChart  EmbeddedComboChartBuilder  Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder.
 asHistogramChart  EmbeddedHistogramChartBuilder  Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder.
 asLineChart  EmbeddedLineChartBuilder  Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder.
 asPieChart  EmbeddedPieChartBuilder  Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder.
 asScatterChart  EmbeddedScatterChartBuilder  Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder.
 asTableChart  EmbeddedTableChartBuilder  Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder.
 build  EmbeddedChart  Builds the chart to reflect all changes made to it.
 clearRanges  EmbeddedChartBuilder  Removes all ranges from the chart this builder modifies.
 getChartType  ChartType  Returns the current chart type.
 getContainer  ContainerInfo  Return the chart ContainerInfo, which encapsulates where the chart appears on the sheet.
 getRanges  Range[]  Returns a copy of the list of ranges currently providing data for this chart.
 removeRange  EmbeddedChartBuilder  Removes the specified range from the chart this builder modifies.
 reverseCategories  EmbeddedComboChartBuilder  Reverses the drawing of series in the domain axis.
 setBackgroundColor  EmbeddedComboChartBuilder  Sets the background color for the chart.
 setChartType  EmbeddedChartBuilder  Changes the type of chart.
 setColors  EmbeddedComboChartBuilder  Sets the colors for the lines in the chart.
 setHiddenDimensionStrategy  EmbeddedChartBuilder  Sets the strategy to use for hidden rows and columns.
 setLegendPosition  EmbeddedComboChartBuilder  Sets the position of the legend with respect to the chart.
 setLegendTextStyle  EmbeddedComboChartBuilder  Sets the text style of the chart legend.
 setMergeStrategy  EmbeddedChartBuilder  Sets the merge strategy to use when more than one range exists.
 setNumHeaders  EmbeddedChartBuilder  Sets the number of rows or columns of the range that should be treated as headers.
 setOption  EmbeddedChartBuilder  Sets advanced options for this chart.
 setPosition  EmbeddedChartBuilder  Sets the position, changing where the chart appears on the sheet.
 setRange  EmbeddedComboChartBuilder  Sets the range for the chart.
 setStacked  EmbeddedComboChartBuilder  Uses stacked lines, meaning that line and bar values are stacked (accumulated).
 setTitle  EmbeddedComboChartBuilder  Sets the title of the chart.
 setTitleTextStyle  EmbeddedComboChartBuilder  Sets the text style of the chart title.
 setTransposeRowsAndColumns  EmbeddedChartBuilder  Sets whether the chart’s rows and columns are transposed.
 setXAxisTextStyle  EmbeddedComboChartBuilder  Sets the horizontal axis text style.
 setXAxisTitle  EmbeddedComboChartBuilder  Adds a title to the horizontal axis.
 setXAxisTitleTextStyle  EmbeddedComboChartBuilder  Sets the horizontal axis title text style.
 setYAxisTextStyle  EmbeddedComboChartBuilder  Sets the vertical axis text style.
 setYAxisTitle  EmbeddedComboChartBuilder  Adds a title to the vertical axis.
 setYAxisTitleTextStyle  EmbeddedComboChartBuilder  Sets the vertical axis title text style.
 useLogScale  EmbeddedComboChartBuilder  Makes the range axis into a logarithmic scale (requires all values to be positive).

Class EmbeddedHistogramChartBuilder

 メソッド名  返り値  簡単な説明
 addRange  EmbeddedChartBuilder  Adds a range to the chart this builder modifies.
 asAreaChart  EmbeddedAreaChartBuilder  Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder.
 asBarChart  EmbeddedBarChartBuilder  Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder.
 asColumnChart  EmbeddedColumnChartBuilder  Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder.
 asComboChart  EmbeddedComboChartBuilder  Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder.
 asHistogramChart  EmbeddedHistogramChartBuilder  Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder.
 asLineChart  EmbeddedLineChartBuilder  Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder.
 asPieChart  EmbeddedPieChartBuilder  Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder.
 asScatterChart  EmbeddedScatterChartBuilder  Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder.
 asTableChart  EmbeddedTableChartBuilder  Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder.
 build  EmbeddedChart  Builds the chart to reflect all changes made to it.
 clearRanges  EmbeddedChartBuilder  Removes all ranges from the chart this builder modifies.
 getChartType  ChartType  Returns the current chart type.
 getContainer  ContainerInfo  Return the chart ContainerInfo, which encapsulates where the chart appears on the sheet.
 getRanges  Range[]  Returns a copy of the list of ranges currently providing data for this chart.
 removeRange  EmbeddedChartBuilder  Removes the specified range from the chart this builder modifies.
 reverseCategories  EmbeddedHistogramChartBuilder  Reverses the drawing of series in the domain axis.
 setBackgroundColor  EmbeddedHistogramChartBuilder  Sets the background color for the chart.
 setChartType  EmbeddedChartBuilder  Changes the type of chart.
 setColors  EmbeddedHistogramChartBuilder  Sets the colors for the lines in the chart.
 setHiddenDimensionStrategy  EmbeddedChartBuilder  Sets the strategy to use for hidden rows and columns.
 setLegendPosition  EmbeddedHistogramChartBuilder  Sets the position of the legend with respect to the chart.
 setLegendTextStyle  EmbeddedHistogramChartBuilder  Sets the text style of the chart legend.
 setMergeStrategy  EmbeddedChartBuilder  Sets the merge strategy to use when more than one range exists.
 setNumHeaders  EmbeddedChartBuilder  Sets the number of rows or columns of the range that should be treated as headers.
 setOption  EmbeddedChartBuilder  Sets advanced options for this chart.
 setPosition  EmbeddedChartBuilder  Sets the position, changing where the chart appears on the sheet.
 setRange  EmbeddedHistogramChartBuilder  Sets the range for the chart.
 setStacked  EmbeddedHistogramChartBuilder  Uses stacked lines, meaning that line and bar values are stacked (accumulated).
 setTitle  EmbeddedHistogramChartBuilder  Sets the title of the chart.
 setTitleTextStyle  EmbeddedHistogramChartBuilder  Sets the text style of the chart title.
 setTransposeRowsAndColumns  EmbeddedChartBuilder  Sets whether the chart’s rows and columns are transposed.
 setXAxisTextStyle  EmbeddedHistogramChartBuilder  Sets the horizontal axis text style.
 setXAxisTitle  EmbeddedHistogramChartBuilder  Adds a title to the horizontal axis.
 setXAxisTitleTextStyle  EmbeddedHistogramChartBuilder  Sets the horizontal axis title text style.
 setYAxisTextStyle  EmbeddedHistogramChartBuilder  Sets the vertical axis text style.
 setYAxisTitle  EmbeddedHistogramChartBuilder  Adds a title to the vertical axis.
 setYAxisTitleTextStyle  EmbeddedHistogramChartBuilder  Sets the vertical axis title text style.
 useLogScale  EmbeddedHistogramChartBuilder  Makes the range axis into a logarithmic scale (requires all values to be positive).

Class EmbeddedLineChartBuilder

 メソッド名  返り値  簡単な説明
 addRange  EmbeddedChartBuilder  Adds a range to the chart this builder modifies.
 asAreaChart  EmbeddedAreaChartBuilder  Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder.
 asBarChart  EmbeddedBarChartBuilder  Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder.
 asColumnChart  EmbeddedColumnChartBuilder  Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder.
 asComboChart  EmbeddedComboChartBuilder  Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder.
 asHistogramChart  EmbeddedHistogramChartBuilder  Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder.
 asLineChart  EmbeddedLineChartBuilder  Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder.
 asPieChart  EmbeddedPieChartBuilder  Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder.
 asScatterChart  EmbeddedScatterChartBuilder  Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder.
 asTableChart  EmbeddedTableChartBuilder  Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder.
 build  EmbeddedChart  Builds the chart to reflect all changes made to it.
 clearRanges  EmbeddedChartBuilder  Removes all ranges from the chart this builder modifies.
 getChartType  ChartType  Returns the current chart type.
 getContainer  ContainerInfo  Return the chart ContainerInfo, which encapsulates where the chart appears on the sheet.
 getRanges  Range[]  Returns a copy of the list of ranges currently providing data for this chart.
 removeRange  EmbeddedChartBuilder  Removes the specified range from the chart this builder modifies.
 reverseCategories  EmbeddedLineChartBuilder  Reverses the drawing of series in the domain axis.
 setBackgroundColor  EmbeddedLineChartBuilder  Sets the background color for the chart.
 setChartType  EmbeddedChartBuilder  Changes the type of chart.
 setColors  EmbeddedLineChartBuilder  Sets the colors for the lines in the chart.
 setCurveStyle  EmbeddedLineChartBuilder  Sets the style to use for curves in the chart.
 setHiddenDimensionStrategy  EmbeddedChartBuilder  Sets the strategy to use for hidden rows and columns.
 setLegendPosition  EmbeddedLineChartBuilder  Sets the position of the legend with respect to the chart.
 setLegendTextStyle  EmbeddedLineChartBuilder  Sets the text style of the chart legend.
 setMergeStrategy  EmbeddedChartBuilder  Sets the merge strategy to use when more than one range exists.
 setNumHeaders  EmbeddedChartBuilder  Sets the number of rows or columns of the range that should be treated as headers.
 setOption  EmbeddedChartBuilder  Sets advanced options for this chart.
 setPointStyle  EmbeddedLineChartBuilder  Sets the style for points in the line.
 setPosition  EmbeddedChartBuilder  Sets the position, changing where the chart appears on the sheet.
 setRange  EmbeddedLineChartBuilder  Sets the range for the chart.
 setTitle  EmbeddedLineChartBuilder  Sets the title of the chart.
 setTitleTextStyle  EmbeddedLineChartBuilder  Sets the text style of the chart title.
 setTransposeRowsAndColumns  EmbeddedChartBuilder  Sets whether the chart’s rows and columns are transposed.
 setXAxisTextStyle  EmbeddedLineChartBuilder  Sets the horizontal axis text style.
 setXAxisTitle  EmbeddedLineChartBuilder  Adds a title to the horizontal axis.
 setXAxisTitleTextStyle  EmbeddedLineChartBuilder  Sets the horizontal axis title text style.
 setYAxisTextStyle  EmbeddedLineChartBuilder  Sets the vertical axis text style.
 setYAxisTitle  EmbeddedLineChartBuilder  Adds a title to the vertical axis.
 setYAxisTitleTextStyle  EmbeddedLineChartBuilder  Sets the vertical axis title text style.
 useLogScale  EmbeddedLineChartBuilder  Makes the range axis into a logarithmic scale (requires all values to be positive).

Class EmbeddedPieChartBuilder

 メソッド名  返り値  簡単な説明
 addRange  EmbeddedChartBuilder  Adds a range to the chart this builder modifies.
 asAreaChart  EmbeddedAreaChartBuilder  Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder.
 asBarChart  EmbeddedBarChartBuilder  Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder.
 asColumnChart  EmbeddedColumnChartBuilder  Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder.
 asComboChart  EmbeddedComboChartBuilder  Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder.
 asHistogramChart  EmbeddedHistogramChartBuilder  Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder.
 asLineChart  EmbeddedLineChartBuilder  Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder.
 asPieChart  EmbeddedPieChartBuilder  Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder.
 asScatterChart  EmbeddedScatterChartBuilder  Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder.
 asTableChart  EmbeddedTableChartBuilder  Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder.
 build  EmbeddedChart  Builds the chart to reflect all changes made to it.
 clearRanges  EmbeddedChartBuilder  Removes all ranges from the chart this builder modifies.
 getChartType  ChartType  Returns the current chart type.
 getContainer  ContainerInfo  Return the chart ContainerInfo, which encapsulates where the chart appears on the sheet.
 getRanges  Range[]  Returns a copy of the list of ranges currently providing data for this chart.
 removeRange  EmbeddedChartBuilder  Removes the specified range from the chart this builder modifies.
 reverseCategories  EmbeddedPieChartBuilder  Reverses the drawing of series in the domain axis.
 set3D  EmbeddedPieChartBuilder  Sets the chart to be three-dimensional.
 setBackgroundColor  EmbeddedPieChartBuilder  Sets the background color for the chart.
 setChartType  EmbeddedChartBuilder  Changes the type of chart.
 setColors  EmbeddedPieChartBuilder  Sets the colors for the lines in the chart.
 setHiddenDimensionStrategy  EmbeddedChartBuilder  Sets the strategy to use for hidden rows and columns.
 setLegendPosition  EmbeddedPieChartBuilder  Sets the position of the legend with respect to the chart.
 setLegendTextStyle  EmbeddedPieChartBuilder  Sets the text style of the chart legend.
 setMergeStrategy  EmbeddedChartBuilder  Sets the merge strategy to use when more than one range exists.
 setNumHeaders  EmbeddedChartBuilder  Sets the number of rows or columns of the range that should be treated as headers.
 setOption  EmbeddedChartBuilder  Sets advanced options for this chart.
 setPosition  EmbeddedChartBuilder  Sets the position, changing where the chart appears on the sheet.
 setTitle  EmbeddedPieChartBuilder  Sets the title of the chart.
 setTitleTextStyle  EmbeddedPieChartBuilder  Sets the text style of the chart title.
 setTransposeRowsAndColumns  EmbeddedChartBuilder  Sets whether the chart’s rows and columns are transposed.

Class EmbeddedScatterChartBuilder

 メソッド名  返り値  簡単な説明
 addRange  EmbeddedChartBuilder  Adds a range to the chart this builder modifies.
 asAreaChart  EmbeddedAreaChartBuilder  Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder.
 asBarChart  EmbeddedBarChartBuilder  Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder.
 asColumnChart  EmbeddedColumnChartBuilder  Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder.
 asComboChart  EmbeddedComboChartBuilder  Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder.
 asHistogramChart  EmbeddedHistogramChartBuilder  Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder.
 asLineChart  EmbeddedLineChartBuilder  Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder.
 asPieChart  EmbeddedPieChartBuilder  Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder.
 asScatterChart  EmbeddedScatterChartBuilder  Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder.
 asTableChart  EmbeddedTableChartBuilder  Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder.
 build  EmbeddedChart  Builds the chart to reflect all changes made to it.
 clearRanges  EmbeddedChartBuilder  Removes all ranges from the chart this builder modifies.
 getChartType  ChartType  Returns the current chart type.
 getContainer  ContainerInfo  Return the chart ContainerInfo, which encapsulates where the chart appears on the sheet.
 getRanges  Range[]  Returns a copy of the list of ranges currently providing data for this chart.
 removeRange  EmbeddedChartBuilder  Removes the specified range from the chart this builder modifies.
 setBackgroundColor  EmbeddedScatterChartBuilder  Sets the background color for the chart.
 setChartType  EmbeddedChartBuilder  Changes the type of chart.
 setColors  EmbeddedScatterChartBuilder  Sets the colors for the lines in the chart.
 setHiddenDimensionStrategy  EmbeddedChartBuilder  Sets the strategy to use for hidden rows and columns.
 setLegendPosition  EmbeddedScatterChartBuilder  Sets the position of the legend with respect to the chart.
 setLegendTextStyle  EmbeddedScatterChartBuilder  Sets the text style of the chart legend.
 setMergeStrategy  EmbeddedChartBuilder  Sets the merge strategy to use when more than one range exists.
 setNumHeaders  EmbeddedChartBuilder  Sets the number of rows or columns of the range that should be treated as headers.
 setOption  EmbeddedChartBuilder  Sets advanced options for this chart.
 setPointStyle  EmbeddedScatterChartBuilder  Sets the style for points in the line.
 setPosition  EmbeddedChartBuilder  Sets the position, changing where the chart appears on the sheet.
 setTitle  EmbeddedScatterChartBuilder  Sets the title of the chart.
 setTitleTextStyle  EmbeddedScatterChartBuilder  Sets the text style of the chart title.
 setTransposeRowsAndColumns  EmbeddedChartBuilder  Sets whether the chart’s rows and columns are transposed.
 setXAxisLogScale  EmbeddedScatterChartBuilder  Makes the horizontal axis into a logarithmic scale (requires all values to be positive).
 setXAxisRange  EmbeddedScatterChartBuilder  Sets the range for the horizontal axis of the chart.
 setXAxisTextStyle  EmbeddedScatterChartBuilder  Sets the horizontal axis text style.
 setXAxisTitle  EmbeddedScatterChartBuilder  Adds a title to the horizontal axis.
 setXAxisTitleTextStyle  EmbeddedScatterChartBuilder  Sets the horizontal axis title text style.
 setYAxisLogScale  EmbeddedScatterChartBuilder  Makes the vertical axis into a logarithmic scale (requires all values to be positive).
 setYAxisRange  EmbeddedScatterChartBuilder  Sets the range for the vertical axis of the chart.
 setYAxisTextStyle  EmbeddedScatterChartBuilder  Sets the vertical axis text style.
 setYAxisTitle  EmbeddedScatterChartBuilder  Adds a title to the vertical axis.
 setYAxisTitleTextStyle  EmbeddedScatterChartBuilder  Sets the vertical axis title text style.

Class EmbeddedEmbeddedTableChartBuilder

 メソッド名  返り値  簡単な説明
 addRange  EmbeddedChartBuilder  Adds a range to the chart this builder modifies.
 asAreaChart  EmbeddedAreaChartBuilder  Sets the chart type to AreaChart and returns an EmbeddedAreaChartBuilder.
 asBarChart  EmbeddedBarChartBuilder  Sets the chart type to BarChart and returns an EmbeddedBarChartBuilder.
 asColumnChart  EmbeddedColumnChartBuilder  Sets the chart type to ColumnChart and returns an EmbeddedColumnChartBuilder.
 asComboChart  EmbeddedComboChartBuilder  Sets the chart type to ComboChart and returns an EmbeddedComboChartBuilder.
 asHistogramChart  EmbeddedHistogramChartBuilder  Sets the chart type to HistogramChart and returns an EmbeddedHistogramChartBuilder.
 asLineChart  EmbeddedLineChartBuilder  Sets the chart type to LineChart and returns an EmbeddedLineChartBuilder.
 asPieChart  EmbeddedPieChartBuilder  Sets the chart type to PieChart and returns an EmbeddedPieChartBuilder.
 asScatterChart  EmbeddedScatterChartBuilder  Sets the chart type to ScatterChart and returns an EmbeddedScatterChartBuilder.
 asTableChart  EmbeddedTableChartBuilder  Sets the chart type to TableChart and returns an EmbeddedTableChartBuilder.
 build  EmbeddedChart  Builds the chart to reflect all changes made to it.
 clearRanges  EmbeddedChartBuilder  Removes all ranges from the chart this builder modifies.
 enablePaging  EmbeddedTableChartBuilder  Sets whether to enable paging through the data.
 enablePaging  EmbeddedTableChartBuilder  Enables paging and sets the number of rows in each page.
 enablePaging  EmbeddedTableChartBuilder  Enables paging, sets the number of rows in each page and the first table page to display (page numbers are zero based).
 enableRtlTable  EmbeddedTableChartBuilder  Adds basic support for right-to-left languages (such as Arabic or Hebrew) by reversing the column order of the table, so that column zero is the right-most column, and the last column is the left-most column.
 enableSorting  EmbeddedTableChartBuilder  Sets whether to sort columns when the user clicks a column heading.
 getChartType  ChartType  Returns the current chart type.
 getContainer  ContainerInfo  Return the chart ContainerInfo, which encapsulates where the chart appears on the sheet.
 getRanges  Range[]  Returns a copy of the list of ranges currently providing data for this chart.
 removeRange  EmbeddedChartBuilder  Removes the specified range from the chart this builder modifies.
 setChartType  EmbeddedChartBuilder  Changes the type of chart.
 setFirstRowNumber  EmbeddedTableChartBuilder  Sets the row number for the first row in the data table.
 setHiddenDimensionStrategy  EmbeddedChartBuilder  Sets the strategy to use for hidden rows and columns.
 setInitialSortingAscending  EmbeddedTableChartBuilder  Sets the index of the column according to which the table should be initially sorted (ascending).
 setInitialSortingDescending  EmbeddedTableChartBuilder  Sets the index of the column according to which the table should be initially sorted (descending).
 setMergeStrategy  EmbeddedChartBuilder  Sets the merge strategy to use when more than one range exists.
 setNumHeaders  EmbeddedChartBuilder  Sets the number of rows or columns of the range that should be treated as headers.
 setOption  EmbeddedChartBuilder  Sets advanced options for this chart.
 setPosition  EmbeddedChartBuilder  Sets the position, changing where the chart appears on the sheet.
 setTransposeRowsAndColumns  EmbeddedChartBuilder  Sets whether the chart’s rows and columns are transposed.
 showRowNumberColumn  EmbeddedTableChartBuilder  Sets whether to show the row number as the first column of the table.
 useAlternatingRowStyle  EmbeddedTableChartBuilder  Sets whether alternating color style is assigned to odd and even rows of a table chart.

Class Filter

 メソッド名  返り値  簡単な説明
 getColumnFilterCriteria  FilterCriteria  Gets the filter criteria on the specified column, or null if no filter criteria is set.
 getRange  Range  Gets the range this filter is applied to.
 remove  void  Removes this filter.
 removeColumnFilterCriteria  Filter  Removes the filter criteria from the specified column.
 setColumnFilterCriteria  Filter  Sets the filter criteria on the specified column.
 sort  Filter  Sorts the filtered range by the specified column, excluding the first row (the header row) in the range this filter is applied to.

Class FilterCriteria

 メソッド名  返り値  簡単な説明
 copy  FilterCriteriaBuilder  Creates a builder for a filter criteria based on this filter criteria’s settings.
 getCriteriaType  BooleanCriteria  Returns the boolean criteria type as defined in the BooleanCriteria enum.
 getCriteriaValues  Object[]  Returns an array of arguments for the boolean criteria.
 getHiddenValues  String[]  Returns the values to hide.
 getVisibleBackgroundColor  Color  Returns the background color used as a filter criteria.
 getVisibleForegroundColor  Color  Returns the foreground color used as a filter criteria.
 getVisibleValues  String[]  Returns the values to show.

Class FilterCriteriaBuilder

 メソッド名  返り値  簡単な説明
 build  FilterCriteria  Constructs a filter criteria from the settings supplied to the builder.
 copy  FilterCriteriaBuilder  Creates a builder for a filter criteria based on this filter criteria’s settings.
 getCriteriaType  BooleanCriteria  Returns the boolean criteria type as defined in the BooleanCriteria enum.
 getCriteriaValues  Object[]  Returns an array of arguments for the boolean criteria.
 getHiddenValues  String[]  Returns the values to hide.
 getVisibleBackgroundColor  Color  Returns the background color used as a filter criteria.
 getVisibleForegroundColor  Color  Returns the foreground color used as a filter criteria.
 getVisibleValues  String[]  Returns the values to show.
 setHiddenValues  FilterCriteriaBuilder  Sets the values to hide.
 setVisibleBackgroundColor  FilterCriteriaBuilder  Sets the background color used as a filter criteria.
 setVisibleForegroundColor  FilterCriteriaBuilder  Sets the foreground color used as a filter criteria.
 setVisibleValues  FilterCriteriaBuilder  Sets the values to show.
 whenCellEmpty  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell is empty.
 whenCellNotEmpty  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell is not empty.
 whenDateAfter  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell date is after the specified value.
 whenDateAfter  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell date is after the specified relative date.
 whenDateBefore  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell date is before the specified date.
 whenDateBefore  FilterCriteriaBuilder  Sets the filter criteria to show cells where a cell date is before the specified relative date.
 whenDateEqualTo  FilterCriteriaBuilder  Sets the filter criteria to show cells where a cell date is equal to the specified date.
 whenDateEqualTo  FilterCriteriaBuilder  Sets the filter criteria to show cells where a cell date is equal to the specified relative date.
 whenDateEqualToAny  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell date is equal to any of the specified dates.
 whenDateNotEqualTo  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell date is not equal to the specified date.
 whenDateNotEqualToAny  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell date is not equal to any of the specified dates.
 whenFormulaSatisfied  FilterCriteriaBuilder  Sets the filter criteria to show cells where the specified formula (such as =B:B<c:c) evaluates=”” to=”” true.<=”” td=””> </c:c)>
 whenNumberBetween  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell number is falls between, or is either of, two specified numbers.
 whenNumberEqualTo  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell number is equal to the specified value.
 whenNumberEqualToAny  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell number is equal to any of the specified numbers.
 whenNumberGreaterThan  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell number is greater than the specified value.
 whenNumberGreaterThanOrEqualTo  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell number is greater than or equal to the specified value.
 whenNumberLessThan  FilterCriteriaBuilder  Sets the conditional conditional format rule to show cells where the cell number is less than the specified value.
 whenNumberLessThanOrEqualTo  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell number is less than or equal to the specified value.
 whenNumberNotBetween  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell number does not fall between, and is neither of, two specified numbers.
 whenNumberNotEqualTo  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell number is not equal to the specified value.
 whenNumberNotEqualToAny  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell number is not equal to any of the specified numbers.
 whenTextContains  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell text contains the specified text.
 whenTextDoesNotContain  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell text does not contain the specified text.
 whenTextEndsWith  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell text ends with the specified text.
 whenTextEqualTo  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell text is equal to the specified text.
 whenTextEqualToAny  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell text is equal to any of the specified values.
 whenTextNotEqualTo  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell text is not equal to the specified text.
 whenTextNotEqualToAny  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell text is not equal to any of the specified values.
 whenTextStartsWith  FilterCriteriaBuilder  Sets the filter criteria to show cells where the cell text starts with the specified text.
 withCriteria  FilterCriteriaBuilder  Sets the boolean criteria to criteria defined by BooleanCriteria values, typically taken from the criteria and arguments of an existing criteria.

Class GradientCondition

 メソッド名  返り値  簡単な説明
 getMaxColor  String  Gets the color set for the maximum value of this gradient condition.
 getMaxColorObject  Color  Gets the color set for the maximum value of this gradient condition.
 getMaxType  InterpolationType  Gets the interpolation type for the maximum value of this gradient condition.
 getMaxValue  String  Gets the max value of this gradient condition.
 getMidColor  String  Gets the color set for the mid-point value of this gradient condition.
 getMidColorObject  Color  Gets the color set for the midpoint value of this gradient condition.
 getMidType  InterpolationType  Gets the interpolation type for the mid-point value of this gradient condition.
 getMidValue  String  Gets the mid-point value of this gradient condition.
 getMinColor  String  Gets the color set for the minimum value of this gradient condition.
 getMinColorObject  Color  Gets the color set for the minimum value of this gradient condition.
 getMinType  InterpolationType  Gets the interpolation type for the minimum value of this gradient condition.
 getMinValue  String  Gets the minimum value of this gradient condition.

Class Group

 メソッド名  返り値  簡単な説明
 collapse  Group  Collapses this group.
 expand  Group  Expands this group.
 getControlIndex  Integer  Returns the control toggle index of this group.
 getDepth  Integer  Returns the depth of this group.
 getRange  Range  Returns the range over which this group exists.
 isCollapsed  Boolean  Returns true if this group is collapsed.
 remove  void  Removes this group from the sheet, reducing the group depth of the range by one.

Class NamedRange

 メソッド名  返り値  簡単な説明
 getName  String  Gets the name of this named range.
 getRange  Range  Gets the range referenced by this named range.
 remove  void  Deletes this named range.
 setName  NamedRange  Sets/updates the name of the named range.
 setRange  NamedRange  Sets/updates the range for this named range.

Class OverGridImage

 メソッド名  返り値  簡単な説明
 assignScript  OverGridImage  Assigns the function with the specified function name to this image.
 getAltTextDescription  String  Returns the alt text description for this image.
 getAltTextTitle  String  Returns the alt text title for this image.
 getAnchorCell  Range  Returns the cell where an image is anchored.
 getAnchorCellXOffset  Integer  Returns the horizontal pixel offset from the anchor cell.
 getAnchorCellYOffset  Integer  Returns the vertical pixel offset from the anchor cell.
 getHeight  Integer  Returns the actual height of this image in pixels.
 getInherentHeight  Integer  Returns the inherent height of this image in pixels.
 getInherentWidth  Integer  Returns the inherent height of this image in pixels.
 getScript  String  Returns the name of the function assigned to this image.
 getSheet  Sheet  Returns the sheet this image appears on.
 getUrl  String  Gets the image’s source URL; returns null if the URL is unavailable.
 getWidth  Integer  Returns the actual width of this image in pixels.
 remove  void  Deletes this image from the spreadsheet.
 replace  OverGridImage  Replaces this image with the one specified by the provided BlobSource.
 resetSize  OverGridImage  Resets this image to its inherent dimensions.
 setAltTextDescription  OverGridImage  Sets the alt-text description for this image.
 setAltTextTitle  OverGridImage  Sets the alt text title for this image.
 setAnchorCell  OverGridImage  Sets the cell where an image is anchored.
 setAnchorCellXOffset  OverGridImage  Sets the horizontal pixel offset from the anchor cell.
 setAnchorCellYOffset  OverGridImage  Sets the vertical pixel offset from the anchor cell.
 setHeight  OverGridImage  Sets the actual height of this image in pixels.
 setWidth  OverGridImage  Sets the actual width of this image in pixels.

Class PivotFilter

 メソッド名  返り値  簡単な説明
 getFilterCriteria  FilterCriteria  Returns the filter criteria for this pivot filter.
 getPivotTable  PivotTable  Returns the PivotTable that this filter belongs to.
 getSourceDataColumn  Integer  Returns the number of the source data column this filter operates on.
 getSourceDataSourceColumn  DataSourceColumn  Returns the data source column the filter operates on.
 remove  void  Removes this pivot filter from the pivot table.
 setFilterCriteria  PivotFilter  Sets the filter criteria for this pivot filter.

Class PivotGroup

 メソッド名  返り値  簡単な説明
 addManualGroupingRule  PivotGroup  Adds a manual grouping rule for this pivot group.
 areLabelsRepeated  Boolean  Returns whether labels are displayed as repeated.
 clearGroupingRule  PivotGroup  Removes any grouping rules from this pivot group.
 clearSort  PivotGroup  Removes any sorting applied to this group.
 getDateTimeGroupingRule  DateTimeGroupingRule  Returns the date-time grouping rule on the pivot group, or null if no date-time grouping rule is set.
 getDimension  Dimension  Returns whether this is a row or column group.
 getGroupLimit  PivotGroupLimit  Returns the pivot group limit on the pivot group.
 getIndex  Integer  Returns the index of this pivot group in the current group order.
 getPivotTable  PivotTable  Returns the PivotTable which this grouping belongs to.
 getSourceDataColumn  Integer  Returns the number of the source data column this group summarizes.
 getSourceDataSourceColumn  DataSourceColumn  Returns the data source column the pivot group operates on.
 hideRepeatedLabels  PivotGroup  Hides repeated labels for this grouping.
 isSortAscending  Boolean  Returns true if the sort is ascending, returns false if the sort order is descending.
 moveToIndex  PivotGroup  Moves this group to the specified position in the current list of row or column groups.
 remove  void  Removes this pivot group from the table.
 removeManualGroupingRule  PivotGroup  Removes the manual grouping rule with the specified groupName.
 resetDisplayName  PivotGroup  Resets the display name of this group in the pivot table to its default value.
 setDateTimeGroupingRule  PivotGroup  Sets the date-time grouping rule on the pivot group.
 setDisplayName  PivotGroup  Sets the display name of this group in the pivot table.
 setGroupLimit  PivotGroup  Sets the pivot group limit on the pivot group.
 setHistogramGroupingRule  PivotGroup  Sets a histogram grouping rule for this pivot group.
 showRepeatedLabels  PivotGroup  When there is more than one row or column grouping, this method displays this grouping’s label for each entry of the subsequent grouping.
 showTotals  PivotGroup  Sets whether to show total values for this pivot group in the table.
 sortAscending  PivotGroup  Sets the sort order to be ascending.
 sortBy  PivotGroup  Sorts this group by the specified PivotValue for the values from the oppositeGroupValues.
 sortDescending  PivotGroup  Sets the sort order to be descending.
 totalsAreShown  Boolean  Returns whether total values are currently shown for this pivot group.

Class PivotGroupLimit

 メソッド名  返り値  簡単な説明
 getCountLimit  Integer  Gets the count limit on rows or columns in the pivot group.
 getPivotGroup  PivotGroup  Returns the pivot group the limit belongs to.
 remove  void  Removes the pivot group limit.
 setCountLimit  PivotGroupLimit  Sets the count limit on rows or columns in the pivot group.

Class PivotTable

 メソッド名  返り値  簡単な説明
 addCalculatedPivotValue  PivotValue  Creates a new pivot value in the pivot table calculated from the specified formula with the specified name.
 addColumnGroup  PivotGroup  Defines a new pivot column grouping in the pivot table.
 addFilter  PivotFilter  Creates a new pivot filter for the pivot table.
 addPivotValue  PivotValue  Defines a new pivot value in the pivot table with the specified summarizeFunction.
 addRowGroup  PivotGroup  Defines a new pivot row grouping in the pivot table.
 asDataSourcePivotTable  DataSourcePivotTable  Returns the pivot table as a data source pivot table if the pivot table is linked to a DataSource, or null otherwise.
 getAnchorCell  Range  Returns the Range representing the cell where this pivot table is anchored.
 getColumnGroups  PivotGroup[]  Returns an ordered list of the column groups in this pivot table.
 getFilters  PivotFilter[]  Returns an ordered list of the filters in this pivot table.
 getPivotValues  PivotValue[]  Returns an ordered list of the pivot values in this pivot table.
 getRowGroups  PivotGroup[]  Returns an ordered list of the row groups in this pivot table.
 getSourceDataRange  Range  Returns the source data range on which the pivot table is constructed.
 getValuesDisplayOrientation  Dimension  Returns whether values are displayed as rows or columns.
 remove  void  Deletes this pivot table.
 setValuesDisplayOrientation  PivotTable  Sets the layout of this pivot table to display values as columns or rows.

Class PivotValue

 メソッド名  返り値  簡単な説明
 getDisplayType  PivotValueDisplayType  Returns the display type describing how this pivot value is currently displayed in the table.
 getFormula  String  Returns the formula used to calculate this value.
 getPivotTable  PivotTable  Returns the PivotTable which this value belongs to.
 getSourceDataColumn  Integer  Returns the number of the source data column the pivot value summarizes.
 getSourceDataSourceColumn  DataSourceColumn  Returns the data source column the pivot value summarizes.
 getSummarizedBy  PivotTableSummarizeFunction  Returns this group’s summarization function.
 remove  void  Remove this value from the pivot table.
 setDisplayName  PivotValue  Sets the display name for this value in the pivot table.
 setFormula  PivotValue  Sets the formula used to calculate this value.
 showAs  PivotValue  Displays this value in the pivot table as a function of another value.
 summarizeBy  PivotValue  Sets the summarization function.

Class Protection

 メソッド名  返り値  簡単な説明
 addEditor  Protection  Adds the given user to the list of editors for the protected sheet or range.
 addEditors  Protection  Adds the given array of users to the list of editors for the protected sheet or range.
 addTargetAudience  Protection  Adds the specified target audience as an editor of the protected range.
 canDomainEdit  Boolean  Determines whether all users in the domain that owns the spreadsheet have permission to edit the protected range or sheet.
 canEdit  Boolean  Determines whether the user has permission to edit the protected range or sheet.
 getDescription  String  Gets the description of the protected range or sheet.
 getEditors  User[]  Gets the list of editors for the protected range or sheet.
 getProtectionType  ProtectionType  Gets the type of the protected area, either RANGE or SHEET.
 getRange  Range  Gets the range that is being protected.
 getRangeName  String  Gets the name of the protected range if it is associated with a named range.
 getTargetAudiences  TargetAudience[]  Returns the IDs of the target audiences that can edit the protected range.
 getUnprotectedRanges  Range[]  Gets an array of unprotected ranges within a protected sheet.
 isWarningOnly  Boolean  Determines if the protected area is using “warning based” protection.
 remove  void  Unprotects the range or sheet.
 removeEditor  Protection  Removes the given user from the list of editors for the protected sheet or range.
 removeEditors  Protection  Removes the given array of users from the list of editors for the protected sheet or range.
 removeTargetAudience  Protection  Removes the specified target audience as an editor of the protected range.
 setDescription  Protection  Sets the description of the protected range or sheet.
 setDomainEdit  Protection  Sets whether all users in the domain that owns the spreadsheet have permission to edit the protected range or sheet.
 setNamedRange  Protection  Associates the protected range with an existing named range.
 setRange  Protection  Adjusts the range that is being protected.
 setRangeName  Protection  Associates the protected range with an existing named range.
 setUnprotectedRanges  Protection  Unprotects the given array of ranges within a protected sheet.
 setWarningOnly  Protection  Sets whether or not this protected range is using “warning based” protection.

Class Range

メソッド名返り値簡単な説明
activateRangeSets the specified range as the active range, with the top left cell in the range as the current cell.
activateAsCurrentCellRangeSets the specified cell as the current cell.
addDeveloperMetadataRangeAdds developer metadata with the specified key to the range.
applyColumnBandingBandingApplies a default column banding theme to the range.
applyRowBandingBandingApplies a default row banding theme to the range.
autoFillvoidFills the destinationRange with data based on the data in this range.
autoFillToNeighborvoidCalculates a range to fill with new data based on neighboring cells and automatically fills that range with new values based on the data contained in this range.
breakApartRangeBreak any multi-column cells in the range into individual cells again.
canEditBooleanDetermines whether the user has permission to edit every cell in the range.
checkRangeChanges the state of the checkboxes in the range to “checked”.
clearRangeClears the range of contents, formats, and data validation rules.
clearContentRangeClears the content of the range, leaving the formatting intact.
clearDataValidationsRangeClears the data validation rules for the range.
clearFormatRangeClears formatting for this range.
clearNoteRangeClears the note in the given cell or cells.
collapseGroupsRangeCollapses all groups that are wholly contained within the range.
copyFormatToRangevoidCopy the formatting of the range to the given location.
copyTovoidCopies the data from a range of cells to another range of cells.
copyValuesToRangevoidCopy the content of the range to the given location.
createDataSourcePivotTableDataSourcePivotTableCreates an empty data source pivot table from the data source, anchored at the first cell in this range.
createDataSourceTableDataSourceTableCreates an empty data source table from the data source, anchored at the first cell in this range.
createDeveloperMetadataFinderDeveloperMetadataFinderReturns a DeveloperMetadataFinderApi for finding developer metadata within the scope of this range.
createFilterFilterCreates a filter applied to the range.
createPivotTablePivotTableCreates an empty pivot table from the specified sourceData anchored at the first cell in this range.
createTextFinderTextFinderCreates a text finder for the range, which can find and replace text in this range.
deleteCellsvoidDeletes this range of cells.
expandGroupsRangeExpands the collapsed groups whose range or control toggle intersects with this range.
getA1NotationStringReturns a string description of the range, in A1 notation.
getBackgroundStringReturns the background color of the top-left cell in the range (for example, ‘#ffffff’).
getBackgroundObjectColorReturns the background color of the top-left cell in the range.
getBackgroundObjectsColor[][]Returns the background colors of the cells in the range.
getBackgroundsString[][]Returns the background colors of the cells in the range (for example, ‘#ffffff’).
getBandingsBanding[]Returns all the bandings that are applied to any cells in this range.
getCellRangeReturns a given cell within a range.
getColumnIntegerReturns the starting column position for this range.
getDataRegionRangeReturns a copy of the range expanded in the four cardinal Directions to cover all adjacent cells with data in them.
getDataRegionRangeReturns a copy of the range expanded Direction.UP and Direction.DOWN if the specified dimension is Dimension.ROWS, or Direction.NEXT and Direction.PREVIOUS if the dimension is Dimension.COLUMNS.
getDataSourceFormulaDataSourceFormulaReturns the DataSourceFormula for the first cell in the range, or null if the cell doesn’t contain a data source formula.
getDataSourceFormulasDataSourceFormula[]Returns the DataSourceFormulas for the cells in the range.
getDataSourcePivotTablesDataSourcePivotTable[]Gets all the data source pivot tables intersecting with the range.
getDataSourceTablesDataSourceTable[]Gets all the data source tables intersecting with the range.
getDataSourceUrlStringReturns a URL for the data in this range, which can be used to create charts and queries.
getDataTableDataTableReturn the data inside this object as a DataTable.
getDataValidationDataValidationReturns the data validation rule for the top-left cell in the range.
getDataValidationsDataValidation[][]Returns the data validation rules for all cells in the range.
getDeveloperMetadataDeveloperMetadata[]Get the developer metadata associated with this range.
getDisplayValueStringReturns the displayed value of the top-left cell in the range.
getDisplayValuesString[][]Returns the rectangular grid of values for this range.
getFilterFilterReturns the filter in the sheet this range belongs to, or null if there is no filter on the sheet.
getFontColorStringReturns the font color of the cell in the top-left corner of the range, in CSS notation (such as ‘#ffffff’ or ‘white’).
getFontColorObjectColorReturns the font color of the cell in the top-left corner of the range.
getFontColorObjectsColor[][]Returns the font colors of the cells in the range.
getFontColorsString[][]Returns the font colors of the cells in the range in CSS notation (such as ‘#ffffff’ or ‘white’).
getFontFamiliesString[][]Returns the font families of the cells in the range.
getFontFamilyStringReturns the font family of the cell in the top-left corner of the range.
getFontLineStringGets the line style of the cell in the top-left corner of the range (‘underline’, ‘line-through’, or ‘none’).
getFontLinesString[][]Gets the line style of the cells in the range (‘underline’, ‘line-through’, or ‘none’).
getFontSizeIntegerReturns the font size in point size of the cell in the top-left corner of the range.
getFontSizesInteger[][]Returns the font sizes of the cells in the range.
getFontStyleStringReturns the font style (‘italic’ or ‘normal’) of the cell in the top-left corner of the range.
getFontStylesString[][]Returns the font styles of the cells in the range.
getFontWeightStringReturns the font weight (normal/bold) of the cell in the top-left corner of the range.
getFontWeightsString[][]Returns the font weights of the cells in the range.
getFormulaStringReturns the formula (A1 notation) for the top-left cell of the range, or an empty string if the cell is empty or doesn’t contain a formula.
getFormulaR1C1StringReturns the formula (R1C1 notation) for a given cell, or null if none.
getFormulasString[][]Returns the formulas (A1 notation) for the cells in the range.
getFormulasR1C1String[][]Returns the formulas (R1C1 notation) for the cells in the range.
getGridIdIntegerReturns the grid ID of the range’s parent sheet.
getHeightIntegerReturns the height of the range.
getHorizontalAlignmentStringReturns the horizontal alignment of the text (left/center/right) of the cell in the top-left corner of the range.
getHorizontalAlignmentsString[][]Returns the horizontal alignments of the cells in the range.
getLastColumnInteger取得したセルの中で最終列の列数を取得
getLastRowInteger取得したセルの中で最終行の行数を取得
getMergedRangesRange[]Returns an array of Range objects representing merged cells that either are fully within the current range, or contain at least one cell in the current range.
getNextDataCellRangeStarting at the cell in the first column and row of the range, returns the next cell in the given direction that is the edge of a contiguous range of cells with data in them or the cell at the edge of the spreadsheet in that direction.
getNoteStringReturns the note associated with the given range.
getNotesString[][]Returns the notes associated with the cells in the range.
getNumColumnsIntegerReturns the number of columns in this range.
getNumRowsIntegerReturns the number of rows in this range.
getNumberFormatStringGet the number or date formatting of the top-left cell of the given range.
getNumberFormatsString[][]Returns the number or date formats for the cells in the range.
getRichTextValueRichTextValueReturns the Rich Text value for the top left cell of the range, or null if the cell value is not text.
getRichTextValuesRichTextValue[][]Returns the Rich Text values for the cells in the range.
getRowIntegerReturns the row position for this range.
getRowIndexIntegerReturns the row position for this range.
getSheetSheetReturns the sheet this range belongs to.
getTextDirectionTextDirectionReturns the text direction for the top left cell of the range.
getTextDirectionsTextDirection[][]Returns the text directions for the cells in the range.
getTextRotationTextRotationReturns the text rotation settings for the top left cell of the range.
getTextRotationsTextRotation[][]Returns the text rotation settings for the cells in the range.
getTextStyleTextStyleReturns the text style for the top left cell of the range.
getTextStylesTextStyle[][]Returns the text styles for the cells in the range.
getValueObject指定されたセル範囲の一番左上のセルの値を取得する
getValuesObject[][]指定されたセル範囲の値を一括で取得する
getVerticalAlignmentStringReturns the vertical alignment (top/middle/bottom) of the cell in the top-left corner of the range.
getVerticalAlignmentsString[][]Returns the vertical alignments of the cells in the range.
getWidthIntegerReturns the width of the range in columns.
getWrapBooleanReturns whether the text in the cell wraps.
getWrapStrategiesWrapStrategy[][]Returns the text wrapping strategies for the cells in the range.
getWrapStrategyWrapStrategyReturns the text wrapping strategy for the top left cell of the range.
getWrapsBoolean[][]Returns whether the text in the cells wrap.
insertCellsRangeInserts empty cells into this range.
insertCheckboxesRangeInserts checkboxes into each cell in the range, configured with true for checked and false for unchecked.
isBlankBooleanReturns true if the range is totally blank.
isCheckedBooleanReturns whether all cells in the range have their checkbox state as ‘checked’.
isEndColumnBoundedBooleanDetermines whether the end of the range is bound to a particular column.
isEndRowBoundedBooleanDetermines whether the end of the range is bound to a particular row.
isPartOfMergeBooleanReturns true if the cells in the current range overlap any merged cells.
isStartColumnBoundedBooleanDetermines whether the start of the range is bound to a particular column.
isStartRowBoundedBooleanDetermines whether the start of the range is bound to a particular row.
mergeRangeMerges the cells in the range together into a single block.
mergeAcrossRangeMerge the cells in the range across the columns of the range.
mergeVerticallyRangeMerges the cells in the range together.
moveTovoidCut and paste (both format and values) from this range to the target range.
offsetRangeReturns a new range that is offset from this range by the given number of rows and columns (which can be negative).
protectProtectionCreates an object that can protect the range from being edited except by users who have permission.
randomizeRangeRandomizes the order of the rows in the given range.
removeCheckboxesRangeRemoves all checkboxes from the range.
removeDuplicatesRangeRemoves rows within this range that contain values that are duplicates of values in any previous row.
removeDuplicatesRangeRemoves rows within this range that contain values in the specified columns that are duplicates of values any previous row.
setBackgroundRangeSets the background color of all cells in the range in CSS notation (such as ‘#ffffff’ or ‘white’).
setBackgroundObjectRangeSets the background color of all cells in the range.
setBackgroundObjectsRangeSets a rectangular grid of background colors (must match dimensions of this range).
setBackgroundRGBRangeSets the background to the given color using RGB values (integers between 0 and 255 inclusive).
setBackgroundsRangeSets a rectangular grid of background colors (must match dimensions of this range).
setBorderRangeSets the border property.
setBorderRangeSets the border property with color and/or style.
setDataValidationRangeSets one data validation rule for all cells in the range.
setDataValidationsRangeSets the data validation rules for all cells in the range.
setFontColorRangeSets the font color in CSS notation (such as ‘#ffffff’ or ‘white’).
setFontColorObjectRangeSets the font color of the given range.
setFontColorObjectsRangeSets a rectangular grid of font colors (must match dimensions of this range).
setFontColorsRangeSets a rectangular grid of font colors (must match dimensions of this range).
setFontFamiliesRangeSets a rectangular grid of font families (must match dimensions of this range).
setFontFamilyRangeSets the font family, such as “Arial” or “Helvetica”.
setFontLineRangeSets the font line style of the given range (‘underline’, ‘line-through’, or ‘none’).
setFontLinesRangeSets a rectangular grid of line styles (must match dimensions of this range).
setFontSizeRangeSets the font size, with the size being the point size to use.
setFontSizesRangeSets a rectangular grid of font sizes (must match dimensions of this range).
setFontStyleRangeSet the font style for the given range (‘italic’ or ‘normal’).
setFontStylesRangeSets a rectangular grid of font styles (must match dimensions of this range).
setFontWeightRangeSet the font weight for the given range (normal/bold).
setFontWeightsRangeSets a rectangular grid of font weights (must match dimensions of this range).
setFormulaRangeUpdates the formula for this range.
setFormulaR1C1RangeUpdates the formula for this range.
setFormulasRangeSets a rectangular grid of formulas (must match dimensions of this range).
setFormulasR1C1RangeSets a rectangular grid of formulas (must match dimensions of this range).
setHorizontalAlignmentRangeSet the horizontal (left to right) alignment for the given range (left/center/right).
setHorizontalAlignmentsRangeSets a rectangular grid of horizontal alignments.
setNoteRangeSets the note to the given value.
setNotesRangeSets a rectangular grid of notes (must match dimensions of this range).
setNumberFormatRangeSets the number or date format to the given formatting string.
setNumberFormatsRangeSets a rectangular grid of number or date formats (must match dimensions of this range).
setRichTextValueRangeSets the Rich Text value for the cells in the range.
setRichTextValuesRangeSets a rectangular grid of Rich Text values.
setShowHyperlinkRangeSets whether or not the range should show hyperlinks.
setTextDirectionRangeSets the text direction for the cells in the range.
setTextDirectionsRangeSets a rectangular grid of text directions.
setTextRotationRangeSets the text rotation settings for the cells in the range.
setTextRotationRangeSets the text rotation settings for the cells in the range.
setTextRotationsRangeSets a rectangular grid of text rotations.
setTextStyleRangeSets the text style for the cells in the range.
setTextStylesRangeSets a rectangular grid of text styles.
setValueRange値を出力する(書き出す)
setValuesRange複数のセルに値を一括で出力する(書き出す)
setVerticalAlignmentRangeSet the vertical (top to bottom) alignment for the given range (top/middle/bottom).
setVerticalAlignmentsRangeSets a rectangular grid of vertical alignments (must match dimensions of this range).
setVerticalTextRangeSets whether or not to stack the text for the cells in the range.
setWrapRangeSet the cell wrap of the given range.
setWrapStrategiesRangeSets a rectangular grid of wrap strategies.
setWrapStrategyRangeSets the text wrapping strategy for the cells in the range.
setWrapsRangeSets a rectangular grid of word wrap policies (must match dimensions of this range).
shiftColumnGroupDepthRangeChanges the column grouping depth of the range by the specified amount.
shiftRowGroupDepthRangeChanges the row grouping depth of the range by the specified amount.
sortRangeSorts the cells in the given range, by column and order specified.
splitTextToColumnsvoidSplits a column of text into multiple columns based on an auto-detected delimiter.
splitTextToColumnsvoidSplits a column of text into multiple columns using the specified string as a custom delimiter.
splitTextToColumnsvoidSplits a column of text into multiple columns based on the specified delimiter.
trimWhitespaceRangeTrims the whitespace (such as spaces, tabs, or new lines) in every cell in this range.
uncheckRangeChanges the state of the checkboxes in the range to “unchecked”.

Class RangeList

 メソッド名  返り値  簡単な説明
 activate  RangeList  Selects the list of Range instances.
 breakApart  RangeList  Break all horizontally- or vertically-merged cells contained within the range list into individual cells again.
 check  RangeList  Changes the state of the checkboxes in the range to “checked”.
 clear  RangeList  Clears the range of contents, formats, and data validation rules for each Range in the range list.
 clearContent  RangeList  Clears the content of each Range in the range list, leaving the formatting intact.
 clearDataValidations  RangeList  Clears the data validation rules for each Range in the range list.
 clearFormat  RangeList  Clears text formatting for each Range in the range list.
 clearNote  RangeList  Clears the note for each Range in the range list.
 getRanges  Range[]  Returns a list of one or more Range instances in the same sheet.
 insertCheckboxes  RangeList  Inserts checkboxes into each cell in the range, configured with true for checked and false for unchecked.
 removeCheckboxes  RangeList  Removes all checkboxes from the range.
 setBackground  RangeList  Sets the background color for each Range in the range list.
 setBackgroundRGB  RangeList  Sets the background to the given RGB color.
 setBorder  RangeList  Sets the border property for each Range in the range list.
 setBorder  RangeList  Sets the border property with color and/or style for each Range in the range list.
 setFontColor  RangeList  Sets the font color for each Range in the range list.
 setFontFamily  RangeList  Sets the font family for each Range in the range list.
 setFontLine  RangeList  Sets the font line style for each Range in the range list.
 setFontSize  RangeList  Sets the font size (in points) for each Range in the range list.
 setFontStyle  RangeList  Set the font style for each Range in the range list.
 setFontWeight  RangeList  Set the font weight for each Range in the range list.
 setFormula  RangeList  Updates the formula for each Range in the range list.
 setFormulaR1C1  RangeList  Updates the formula for each Range in the range list.
 setHorizontalAlignment  RangeList  Set the horizontal alignment for each Range in the range list.
 setNote  RangeList  Sets the note text for each Range in the range list.
 setNumberFormat  RangeList  Sets the number or date format for each Range in the range list.
 setShowHyperlink  RangeList  Sets whether or not each Range in the range list should show hyperlinks.
 setTextDirection  RangeList  Sets the text direction for the cells in each Range in the range list.
 setTextRotation  RangeList  Sets the text rotation settings for the cells in each Range in the range list.
 setValue  RangeList  Sets the value for each Range in the range list.
 setVerticalAlignment  RangeList  Set the vertical alignment for each Range in the range list.
 setVerticalText  RangeList  Sets whether or not to stack the text for the cells for each Range in the range list.
 setWrap  RangeList  Set text wrapping for each Range in the range list.
 setWrapStrategy  RangeList  Sets the text wrapping strategy for each Range in the range list.
 trimWhitespace  RangeList  Trims the whitespace (such as spaces, tabs, or new lines) in every cell in this range list.
 uncheck  RangeList  Changes the state of the checkboxes in the range to “unchecked”.

Class RichTextValue

 メソッド名  返り値  簡単な説明
 copy  RichTextValueBuilder  Returns a builder for a Rich Text value initialized with the values of this Rich Text value.
 getEndIndex  Integer  Gets the end index of this value in the cell.
 getLinkUrl  String  Returns the link URL for this value.
 getRuns  RichTextValue[]  Returns the Rich Text string split into an array of runs, wherein each run is the longest possible substring having a consistent text style.
 getStartIndex  Integer  Gets the start index of this value in the cell.
 getText  String  Returns the text of this value.
 getTextStyle  TextStyle  Returns the text style of this value.

Class RichTextValueBuilder

 メソッド名  返り値  簡単な説明
 build  RichTextValue  Creates a Rich Text value from this builder.
 setLinkUrl  RichTextValueBuilder  Sets the link URL for the given substring of this value, or clears it if linkUrl is null.
 setText  RichTextValueBuilder  Sets the text for this value and clears any existing text style.
 setTextStyle  RichTextValueBuilder  Applies a text style to the given substring of this value.

Class Selection

メソッド名返り値簡単な説明
getActiveRangeRangeアクティブシートの選択範囲を取得します。範囲が選択されてない場合はnullを返します。
getActiveRangeListRangeListアクティブシートの選択範囲のリストを取得します。範囲が選択されてない場合はnullを返します。
getActiveSheetSheetスプレッドシートのアクティブシートを取得します。
getCurrentCellRange選択中のセルを取得します。複数セルが選択されている場合は一番左上乗せるを返します。何も選択されていない場合はnullを返します。
getNextDataRangeRangeStarting from the current cell and active range and moving in the given direction, returns an adjusted range where the appropriate edge of the range has been shifted to cover the next data cell while still covering the current cell.

Class Sheet

メソッド名返り値簡単な説明
activateSheetActivates this sheet.
addDeveloperMetadataSheetAdds developer metadata with the specified key to the sheet.
appendRowSheetAppends a row to the spreadsheet.
asDataSourceSheetDataSourceSheetReturns the sheet as a DataSourceSheet if the sheet is of type SheetType.DATASOURCE, or null otherwise.
autoResizeColumnSheetSets the width of the given column to fit its contents.
autoResizeColumnsSheetSets the width of all columns starting at the given column position to fit their contents.
autoResizeRowsSheetSets the height of all rows starting at the given row position to fit their contents.
clearSheetClears the sheet of content and formatting information.
clearConditionalFormatRulesvoidRemoves all conditional format rules from the sheet.
clearContentsSheetClears the sheet of contents, while preserving formatting information.
clearFormatsSheetClears the sheet of formatting, while preserving contents.
clearNotesSheetClears the sheet of all notes.
collapseAllColumnGroupsSheetCollapses all column groups on the sheet.
collapseAllRowGroupsSheetCollapses all row groups on the sheet.
copyToSheetCopies the sheet to a given spreadsheet, which can be the same spreadsheet as the source.
createDeveloperMetadataFinderDeveloperMetadataFinderReturns a DeveloperMetadataFinder for finding developer metadata within the scope of this sheet.
createTextFinderTextFinderCreates a text finder for the sheet, which can find and replace text within the sheet.
deleteColumnSheet列数を指定して1列を削除する
deleteColumnsvoid列数を指定して複数行を削除する
deleteRowSheet行数を指定して1行を削除する
deleteRowsvoid行数を指定して複数行を削除する
expandAllColumnGroupsSheetExpands all column groups on the sheet.
expandAllRowGroupsSheetExpands all row groups on the sheet.
expandColumnGroupsUpToDepthSheetExpands all column groups up to the given depth, and collapses all others.
expandRowGroupsUpToDepthSheetExpands all row groups up to the given depth, and collapses all others.
getActiveCellRangeReturns the active cell in this sheet.
getActiveRangeRangeアクティブシートの選択範囲を取得します。範囲が選択されてない場合はnullを返します。
getActiveRangeListRangeListアクティブシートの選択範囲のリストを取得します。範囲が選択されてない場合はnullを返します。
getBandingsBanding[]Returns all the bandings in this sheet.
getChartsEmbeddedChart[]Returns an array of charts on this sheet.
getColumnGroupGroupReturns the column group at the given index and group depth.
getColumnGroupControlPositionGroupControlTogglePositionReturns the GroupControlTogglePosition for all column groups on the sheet.
getColumnGroupDepthIntegerReturns the group depth of the column at the given index.
getColumnWidthIntegerGets the width in pixels of the given column.
getConditionalFormatRulesConditionalFormatRule[]Get all conditional format rules in this sheet.
getCurrentCellRange選択中のセルを取得します。複数セルが選択されている場合は一番左上乗せるを返します。何も選択されていない場合はnullを返します。
getDataRangeRangeReturns a Range corresponding to the dimensions in which data is present.
getDataSourceFormulasDataSourceFormula[]Gets all the data source formulas.
getDataSourcePivotTablesDataSourcePivotTable[]Gets all the data source pivot tables.
getDataSourceTablesDataSourceTable[]Gets all the data source tables.
getDeveloperMetadataDeveloperMetadata[]Get all developer metadata associated with this sheet.
getDrawingsDrawing[]Returns an array of drawings on the sheet.
getFilterFilterReturns the filter in this sheet, or null if there is no filter.
getFormUrlStringReturns the URL for the form that sends its responses to this sheet, or null if this sheet has no associated form.
getFrozenColumnsIntegerReturns the number of frozen columns.
getFrozenRowsIntegerReturns the number of frozen rows.
getImagesOverGridImage[]Returns all over-the-grid images on the sheet.
getIndexIntegerGets the position of the sheet in its parent spreadsheet.
getLastColumnIntegerデータが入っている最終列の列数を取得
getLastRowIntegerデータが入っている最終行の行数を取得
getMaxColumnsIntegerReturns the current number of columns in the sheet, regardless of content.
getMaxRowsIntegerデータの有無に関わらずシートの最終行を取得
getNameStringReturns the name of the sheet.
getNamedRangesNamedRange[]Gets all the named ranges in this sheet.
getParentSpreadsheetReturns the Spreadsheet that contains this sheet.
getPivotTablesPivotTable[]Returns all the pivot tables on this sheet.
getProtectionsProtection[]Gets an array of objects representing all protected ranges in the sheet, or a single-element array representing the protection on the sheet itself.
getRangeRange指定したセル範囲の一番左上のセルを返す
getRangeListRangeListReturns the RangeList collection representing the ranges in the same sheet specified by a non-empty list of A1 notations or R1C1 notations.
getRowGroupGroupReturns the row group at the given index and group depth.
getRowGroupControlPositionGroupControlTogglePositionReturns the GroupControlTogglePosition for all row groups on the sheet.
getRowGroupDepthIntegerReturns the group depth of the row at the given index.
getRowHeightIntegerGets the height in pixels of the given row.
getSelectionSelection選択しているセルを取得する
getSheetIdIntegerReturns the ID of the sheet represented by this object.
getSheetNameStringReturns the sheet name.
getSheetValuesObject[][]Returns the rectangular grid of values for this range starting at the given coordinates.
getSlicersSlicer[]Returns an array of slicers on the sheet.
getTabColorStringGets the sheet tab color, or null if the sheet tab has no color.
getTabColorObjectColorGets the sheet tab color, or null if the sheet tab has no color.
getTypeSheetTypeReturns the type of the sheet.
hasHiddenGridlinesBooleanReturns true if the sheet’s gridlines are hidden; otherwise returns false.
hideColumnvoidHides the columns in the given range.
hideColumnsvoidHides the column at the given index.
hideColumnsvoidHides one or more consecutive columns starting at the given index.
hideRowvoidHides the rows in the given range.
hideRowsvoidHides the row at the given index.
hideSheetSheetHides this sheet.
insertChartvoidAdds a new chart to this sheet.
insertColumnAfterSheetInserts a column after the given column position.
insertColumnBeforeSheetInserts a column before the given column position.
insertColumnsvoidInserts a blank column in a sheet at the specified location.
insertColumnsAfterSheetInserts a number of columns after the given column position.
insertColumnsBeforeSheetInserts a number of columns before the given column position.
insertImageOverGridImageBlobデータを画像としてスプレッドシートの特定のセルに挿入する。
insertRowAfterSheetInserts a row after the given row position.
insertRowBeforeSheetInserts a row before the given row position.
insertRowsvoidInserts a blank row in a sheet at the specified location.
insertRowsAfterSheetInserts a number of rows after the given row position.
insertRowsBeforeSheetInserts a number of rows before the given row position.
insertSlicerSlicerAdds a new slicer to this sheet.
isColumnHiddenByUserBooleanReturns whether the given column is hidden by the user.
isRightToLeftBooleanReturns true if this sheet layout is right-to-left.
isRowHiddenByFilterBooleanReturns whether the given row is hidden by a filter (not a filter view).
isRowHiddenByUserBooleanReturns whether the given row is hidden by the user.
isSheetHiddenBooleanReturns true if the sheet is currently hidden.
moveColumnsvoidMoves the columns selected by the given range to the position indicated by the destinationIndex.
moveRowsvoidMoves the rows selected by the given range to the position indicated by the destinationIndex.
newChartEmbeddedChartBuilderReturns a builder to create a new chart for this sheet.
protectProtectionCreates an object that can protect the sheet from being edited except by users who have permission.
removeChartvoidRemoves a chart from the parent sheet.
setActiveRangeRange特定のセルをアクティブセルに設定する。指定されたセルの一番左上のセルを取得セルとして返す
setActiveRangeListRangeList特定のセル範囲をアクティセル範囲として設定する。
setActiveSelectionRangeSets the active selection region for this sheet.
setColumnGroupControlPositionSheetSets the position of the column group control toggle on the sheet.
setColumnWidthSheetSets the width of the given column in pixels.
setColumnWidthsSheetSets the width of the given columns in pixels.
setConditionalFormatRulesvoidReplaces all currently existing conditional format rules in the sheet with the input rules.
setCurrentCellRangeSets the specified cell as the current cell.
setFrozenColumnsvoidFreezes the given number of columns.
setFrozenRowsvoidFreezes the given number of rows.
setHiddenGridlinesSheetHides or reveals the sheet gridlines.
setNameSheetSets the sheet name.
setRightToLeftSheetSets or unsets the sheet layout to right-to-left.
setRowGroupControlPositionSheetSets the position of the row group control toggle on the sheet.
setRowHeightSheetSets the row height of the given row in pixels.
setRowHeightsSheetSets the height of the given rows in pixels.
setRowHeightsForcedSheetSets the height of the given rows in pixels.
setTabColorSheetSets the sheet tab color.
setTabColorObjectSheetSets the sheet tab color.
showColumnsvoidUnhides the column at the given index.
showRowsvoidUnhides the row at the given index.
showRowsvoidUnhides one or more consecutive rows starting at the given index.
showSheetSheetMakes the sheet visible.
sortSheetSorts a sheet by column, ascending.
unhideColumnvoidUnhides the column in the given range.
unhideRowvoidUnhides the row in the given range.
updateChartvoidUpdates the chart on this sheet.

Class Slicer

 メソッド名  返り値  簡単な説明
 getBackgroundColor  String  Returns the background color of the slicer in CSS notation (such as ‘#ffffff’).
 getBackgroundColorObject  Color  Return the background Color of the slicer.
 getColumnPosition  Integer  Returns the column position (relative to the data range of the slicer) on which the filter is applied in the slicer, or null if the column position is not set.
 getContainerInfo  ContainerInfo  Gets information about where the slicer is positioned in the sheet.
 getFilterCriteria  FilterCriteria  Returns the filter criteria of the slicer, or null if the filter criteria is not set.
 getRange  Range  Gets the data range on which the slicer is applied to.
 getTitle  String  Returns the title of the slicer.
 getTitleHorizontalAlignment  String  Gets the horizontal alignment of the title.
 getTitleTextStyle  TextStyle  Returns the text style of the slicer’s title.
 isAppliedToPivotTables  Boolean  Returns whether the given slicer is applied to pivot tables.
 remove  void  Deletes the slicer.
 setApplyToPivotTables  Slicer  Sets if the given slicer should be applied to pivot tables in the worksheet.
 setBackgroundColor  Slicer  Sets the background color of the slicer.
 setBackgroundColorObject  Slicer  Sets the background Color of the slicer.
 setColumnFilterCriteria  Slicer  Sets the column index and filtering criteria of the slicer.
 setPosition  Slicer  Sets the position where the slicer appears on the sheet.
 setRange  Slicer  Sets the data range on which the slicer is applied.
 setTitle  Slicer  Sets the title of the slicer.
 setTitleHorizontalAlignment  Slicer  Sets the horizontal alignment of the title in the slicer.
 setTitleTextStyle  Slicer  Sets the text style of the slicer.

Class SortSpec

 メソッド名  返り値  簡単な説明
 getBackgroundColor  Color  Returns the background color used for sorting, or null if absent.
 getDataSourceColumn  DataSourceColumn  Gets the data source column the sort spec acts on.
 getDimensionIndex  Integer  Returns the dimension index or null if not linked to a local filter.
 getForegroundColor  Color  Returns the foreground color used for sorting, or null if absent.
 getSortOrder  SortOrder  Returns the sort order.
 isAscending  Boolean  Returns whether the sort order is ascending.

Class Spreadsheet

メソッド名返り値簡単な説明
addDeveloperMetadataSpreadsheetAdds developer metadata with the specified key to the top-level spreadsheet.
addEditorSpreadsheetAdds the given user to the list of editors for the Spreadsheet.
addEditorsSpreadsheetAdds the given array of users to the list of editors for the Spreadsheet.
addMenuvoidCreates a new menu in the Spreadsheet UI.
addViewerSpreadsheetAdds the given user to the list of viewers for the Spreadsheet.
addViewersSpreadsheetAdds the given array of users to the list of viewers for the Spreadsheet.
appendRowSheetAppends a row to the spreadsheet.
autoResizeColumnSheetSets the width of the given column to fit its contents.
copySpreadsheetCopies the spreadsheet and returns the new one.
createDeveloperMetadataFinderDeveloperMetadataFinderReturns a DeveloperMetadataFinder for finding developer metadata within the scope of this spreadsheet.
createTextFinderTextFinderCreates a text finder for the spreadsheet, which can be used to find and replace text within the spreadsheet.
deleteActiveSheetSheetDeletes the currently active sheet.
deleteColumnSheet列数を指定して1列を削除する
deleteColumnsvoid列数を指定して複数行を削除する
deleteRowSheet行数を指定して1行を削除する
deleteRowsvoid行数を指定して複数行を削除する
deleteSheetvoidDeletes the specified sheet.
duplicateActiveSheetSheetDuplicates the active sheet and makes it the active sheet.
getActiveCellRangeReturns the active cell in this sheet.
getActiveRangeRangeアクティブシートの選択範囲を取得します。範囲が選択されてない場合はnullを返します。
getActiveRangeListRangeListアクティブシートの選択範囲のリストを取得します。範囲が選択されてない場合はnullを返します。
getActiveSheetSheetスプレッドシートのアクティブシートを取得します。
getAsBlobReturn the data inside this object as a blob converted to the specified content type.
getBandingsBanding[]Returns all the bandings in this spreadsheet.
getBlobBlobReturn the data inside this object as a blob.
getColumnWidthIntegerGets the width in pixels of the given column.
getCurrentCellRange選択中のセルを取得します。複数セルが選択されている場合は一番左上乗せるを返します。何も選択されていない場合はnullを返します。
getDataRangeRangeReturns a Range corresponding to the dimensions in which data is present.
getDataSourceFormulasDataSourceFormula[]Gets all the data source formulas.
getDataSourcePivotTablesDataSourcePivotTable[]Gets all the data source pivot tables.
getDataSourceRefreshSchedulesDataSourceRefreshSchedule[]Gets the refresh schedules of this spreadsheet.
getDataSourceSheetsDataSourceSheet[]Returns all the data source sheets in the spreadsheet.
getDataSourceTablesDataSourceTable[]Gets all the data source tables.
getDataSourcesDataSource[]Returns all the data sources in the spreadsheet.
getDeveloperMetadataDeveloperMetadata[]Get the developer metadata associated with the top-level spreadsheet.
getEditorsUser[]Gets the list of editors for this Spreadsheet.
getFormUrlStringReturns the URL for the form that sends its responses to this spreadsheet, or null if this spreadsheet has no associated form.
getFrozenColumnsIntegerReturns the number of frozen columns.
getFrozenRowsIntegerReturns the number of frozen rows.
getIdStringGets a unique identifier for this spreadsheet.
getImagesOverGridImage[]Returns all over-the-grid images on the sheet.
getIterativeCalculationConvergenceThresholdNumberReturns the threshold value used during iterative calculation.
getLastColumnIntegerデータが入っている最終列の列数 を取得
getLastRowIntegerデータが入っている最終行の行数を取得
getMaxIterativeCalculationCyclesIntegerReturns the maximum number of iterations to use during iterative calculation.
getNameStringスプレッドシートのファイル名を取得
getNamedRangesNamedRange[]Gets all the named ranges in this spreadsheet.
getNumSheetsIntegerReturns the number of sheets in this spreadsheet.
getOwnerUserReturns the owner of the document, or null for a document in a shared drive.
getPredefinedSpreadsheetThemesSpreadsheetTheme[]Returns the list of predefined themes.
getProtectionsProtection[]Gets an array of objects representing all protected ranges or sheets in the spreadsheet.
getRangeRangeA1形式、あるいはR1C1形式で指定されたセル範囲を返す
getRangeByNameRange指定した名前付きのセル範囲を返す。指定のセル範囲名がなければnullを返す
getRangeListRangeListReturns the RangeList collection representing the ranges in the same sheet specified by a non-empty list of A1 notations or R1C1 notations.
getRecalculationIntervalRecalculationIntervalReturns the calculation interval for this spreadsheet.
getRowHeightIntegerGets the height in pixels of the given row.
getSelectionSelection選択しているセルを取得する
getSheetByNameSheet指定したシート名のシートを取得する
getSheetIdIntegerReturns the ID of the sheet represented by this object.
getSheetNameStringReturns the sheet name.
getSheetValuesObject[][]Returns the rectangular grid of values for this range starting at the given coordinates.
getSheetsSheet[]スプレッドシートのすべてのシートを配列で取得する
getSpreadsheetLocaleStringGets the spreadsheet locale.
getSpreadsheetThemeSpreadsheetThemeReturns the current theme of the spreadsheet, or null if no theme is applied.
getSpreadsheetTimeZoneStringGets the time zone for the spreadsheet.
getUrlStringReturns the URL for the given spreadsheet.
getViewersUser[]Gets the list of viewers and commenters for this Spreadsheet.
hideColumnvoidHides the columns in the given range.
hideRowvoidHides the rows in the given range.
insertColumnAfterSheetInserts a column after the given column position.
insertColumnBeforeSheetInserts a column before the given column position.
insertColumnsAfterSheetInserts a number of columns after the given column position.
insertColumnsBeforeSheetInserts a number of columns before the given column position.
insertDataSourceSheetDataSourceSheetInserts a new DataSourceSheet in the spreadsheet and starts data execution.
insertImageOverGridImageBlobデータを画像としてスプレッドシートの特定のセルに挿入する。
insertRowAfterSheetInserts a row after the given row position.
insertRowBeforeSheetInserts a row before the given row position.
insertRowsAfterSheetInserts a number of rows after the given row position.
insertRowsBeforeSheetInserts a number of rows before the given row position.
insertSheetSheetInserts a new sheet into the spreadsheet, using a default sheet name.
insertSheetWithDataSourceTableSheetInserts a new sheet in the spreadsheet, creates a DataSourceTable spanning the entire sheet with the given data source specification, and starts data execution.
isColumnHiddenByUserBooleanReturns whether the given column is hidden by the user.
isIterativeCalculationEnabledBooleanReturns whether iterative calculation is enabled in this spreadsheet.
isRowHiddenByFilterBooleanReturns whether the given row is hidden by a filter (not a filter view).
isRowHiddenByUserBooleanReturns whether the given row is hidden by the user.
moveActiveSheetvoidMoves the active sheet to the given position in the list of sheets.
moveChartToObjectSheetSheetCreates a new SheetType.OBJECT sheet and moves the provided chart to it.
refreshAllDataSourcesvoidRefreshes all supported data sources and their linked data source objects, skipping invalid data source objects.
removeEditorSpreadsheetRemoves the given user from the list of editors for the Spreadsheet.
removeEditorSpreadsheetRemoves the given user from the list of editors for the Spreadsheet.
removeMenuvoidRemoves a menu that was added by addMenu(name, subMenus).
removeNamedRangevoidDeletes a named range with the given name.
removeViewerSpreadsheetRemoves the given user from the list of viewers and commenters for the Spreadsheet.
removeViewerSpreadsheetRemoves the given user from the list of viewers and commenters for the Spreadsheet.
renamevoidRenames the document.
renameActiveSheetvoidRenames the current active sheet to the given new name.
resetSpreadsheetThemeSpreadsheetThemeRemoves the applied theme and sets the default theme on the spreadsheet.
setActiveRangeRange特定のセルをアクティブセルに設定する。指定されたセルの一番左上のセルを取得セルとして返す。
setActiveRangeListRangeList特定のセル範囲をアクティセル範囲として設定する。
setActiveSelectionRangeSets the active selection region for this sheet.
setActiveSheetSheet特定のシートをアクティブシートとして設定する。
setColumnWidthSheetSets the width of the given column in pixels.
setCurrentCellRangeSets the specified cell as the current cell.
setFrozenColumnsvoidFreezes the given number of columns.
setFrozenRowsvoidFreezes the given number of rows.
setIterativeCalculationConvergenceThresholdSpreadsheetSets the minimum threshold value for iterative calculation.
setIterativeCalculationEnabledSpreadsheetSets whether iterative calculation is enabled in this spreadsheet.
setMaxIterativeCalculationCyclesSpreadsheetSets the maximum number of calculation iterations that should be performed during iterative calculation.
setNamedRangevoidNames a range.
setRecalculationIntervalSpreadsheetSets how often this spreadsheet should recalculate.
setRowHeightSheetSets the row height of the given row in pixels.
setSpreadsheetLocalevoidSets the spreadsheet locale.
setSpreadsheetThemeSpreadsheetThemeSets a theme on the spreadsheet.
setSpreadsheetTimeZonevoidSets the time zone for the spreadsheet.
showvoidDisplays a custom user interface component in a dialog centered in the user’s browser’s viewport.
sortSheetSorts a sheet by column, ascending.
toastvoidShows a popup window in the lower right corner of the spreadsheet with the given message.
unhideColumnvoidUnhides the column in the given range.
unhideRowvoidUnhides the row in the given range.
updateMenuvoidUpdates a menu that was added by addMenu(name, subMenus).
waitForAllDataExecutionsCompletionvoidWaits until all the current executions in the spreadsheet complete, timing out after the provided number of seconds.

Class SpreadsheetApp

メソッド名返り値簡単な説明
createSpreadsheet新しいスプレッドシートを作成する
enableAllDataSourcesExecutionvoidEnables data execution for all types of data sources.
enableBigQueryExecutionvoidEnables data execution for BigQuery data source.
flushvoidスプレッドシートの変更を反映させる
getActiveSpreadsheetスプレッドシートオブジェクトを取得します。値がない場合はnullを返します。
getActiveRangeRangeアクティブシートの選択範囲を取得します。範囲が選択されてない場合はnullを返します。
getActiveRangeListRangeListアクティブシートの選択範囲のリストを取得します。範囲が選択されてない場合はnullを返します。
getActiveSheetSheetスプレッドシートのアクティブシートを取得します。
getActiveSpreadsheetSpreadsheetアクティブスプレッドシートをオブジェクトで取得します。対象がない場合nullを返します。
getCurrentCellRange選択中のセルを取得します。複数セルが選択されている場合は一番左上乗せるを返します。何も選択されていない場合はnullを返します。
getSelectionSelection選択しているセルを取得する
getUiUiReturns an instance of the spreadsheet’s user-interface environment that allows the script to add features like menus, dialogs, and sidebars.
newColorColorBuilderCreates a builder for a Color.
newConditionalFormatRuleConditionalFormatRuleBuilder条件付き書式のビルダーを作成します。
newDataSourceSpecDataSourceSpecBuilderCreates a builder for a DataSourceSpec.
newDataValidationDataValidationBuilder入力規則ビルダーを作成します。
newFilterCriteriaFilterCriteriaBuilderフィルタービルダーを作成します。
newRichTextValueRichTextValueBuilderリッチテキストビルダーを作成します。
newTextStyleTextStyleBuilderテキストスタイルビルダーを作成します。
openSpreadsheetファイルオブジェクトでスプレッドシートを開く
openByIdSpreadsheetファイルIDでスプレッドシートを開く
openByUrlSpreadsheetスプレッドシートURLでスプレッドシートを開く
setActiveRangeRange特定のセルをアクティブセルに設定する。指定されたセルの一番左上のセルを取得セルとして返す
setActiveRangeListRangeList特定のセル範囲をアクティセル範囲として設定する。
setActiveSheetSheet特定のシートをアクチブシートとして設定する。
setActiveSpreadsheetvoidアクティブスプレッドシートとして設定する。
setCurrentCellRangeSets the specified cell as the current cell.

Class SpreadsheetTheme

 メソッド名  返り値  簡単な説明
 getConcreteColor  Color  Returns the concrete Color for a valid theme color type.
 getFontFamily  String  Returns the font family of the theme, or null if it’s a null theme.
 getThemeColors  ThemeColorType[]  Returns a list of all possible theme color types for the current theme.
 setConcreteColor  SpreadsheetTheme  Sets the concrete color associated with the ThemeColorType in this color scheme to the given color.
 setFontFamily  SpreadsheetTheme  Sets the font family for the theme.

Class TextFinder

 メソッド名  返り値  簡単な説明
 findAll  Range[]  Returns all cells matching the search criteria.
 findNext  Range  Returns the next cell matching the search criteria.
 findPrevious  Range  Returns the previous cell matching the search criteria.
 getCurrentMatch  Range  Returns the current cell matching the search criteria.
 ignoreDiacritics  TextFinder  If true, configures the search to ignore diacritics while matching; otherwise the search matches diacritics.
 matchCase  TextFinder  If true, configures the search to match the search text’s case exactly, otherwise the search defaults to case-insensitive matching.
 matchEntireCell  TextFinder  If true, configures the search to match the entire contents of a cell; otherwise, the search defaults to partial matching.
 matchFormulaText  TextFinder  If true, configures the search to return matches that appear within formula text; otherwise cells with formulas are considered based on their displayed value.
 replaceAllWith  Integer  Replaces all matches with the specified text.
 replaceWith  Integer  Replaces the search text in the currently matched cell with the specified text and returns the number of occurrences replaced.
 startFrom  TextFinder  Configures the search to start searching immediately after the specified cell range.
 useRegularExpression  TextFinder  If true, configures the search to interpret the search string as a regular expression; otherwise the search interprets the search string as normal text.

Class TextRotation

 メソッド名  返り値  簡単な説明
 getDegrees  Integer  Gets the angle between standard text orientation and the current text orientation.
 isVertical  Boolean  Returns true if the text is stacked vertically; returns false otherwise.

Class TextStyle

 メソッド名  返り値  簡単な説明
 copy  TextStyleBuilder  Creates a text style builder initialized with the values of this text style.
 getFontFamily  String  Gets the font family of the text.
 getFontSize  Integer  Gets the font size of the text in points.
 getForegroundColor  String  Gets the font color of the text.
 getForegroundColorObject  Color  Gets the font color of the text.
 isBold  Boolean  Gets whether or not the text is bold.
 isItalic  Boolean  Gets whether or not the cell is italic.
 isStrikethrough  Boolean  Gets whether or not the cell has strikethrough.
 isUnderline  Boolean  Gets whether or not the cell is underlined.

Class TextStyleBuilder

 メソッド名  返り値  簡単な説明
 build  TextStyle  Creates a text style from this builder.
 setBold  TextStyleBuilder  Sets whether or not the text is bold.
 setFontFamily  TextStyleBuilder  Sets the text font family, such as “Arial”.
 setFontSize  TextStyleBuilder  Sets the text font size in points.
 setForegroundColor  TextStyleBuilder  Sets the text font color.
 setForegroundColorObject  TextStyleBuilder  Sets the text font color.
 setItalic  TextStyleBuilder  Sets whether or not the text is italic.
 setStrikethrough  TextStyleBuilder  Sets whether or not the text has strikethrough.
 setUnderline  TextStyleBuilder  Sets whether or not the text is underlined.

Class ThemeColor

 メソッド名  返り値  簡単な説明
 getColorType  ColorType  Get the type of this color.
 getThemeColorType  ThemeColorType  Gets the theme color type of this color.

列挙型名一覧

列挙型のメソッドを利用するときには、基本的には『SpreadsheetApp.列挙型名.プロパティ名』の形で利用します。例えば、BandingThemeのGREYを設定したい場合は、『SpreadsheetApp.BandingTheme.GREY』という形で記述します。

SpreadsheetApp

 メソッド名  返り値  簡単な説明
 AutoFillSeries  AutoFillSeries  An enumeration of the types of series used to calculate auto-filled values.
 BandingTheme  BandingTheme  An enumeration of the possible banding themes.
 BooleanCriteria  BooleanCriteria  An enumeration of conditional formatting boolean criteria.
 BorderStyle  BorderStyle  An enumeration of the valid styles for setting borders on a Range.
 ColorType  ColorType  An enumeration of possible color types.
 CopyPasteType  CopyPasteType  An enumeration of the possible paste types.
 DataExecutionErrorCode  DataExecutionErrorCode  An enumeration of the possible data execution error codes.
 DataExecutionState  DataExecutionState  An enumeration of the possible data execution states.
 DataSourceParameterType  DataSourceParameterType  An enumeration of the possible data source parameter types.
 DataSourceRefreshScope  DataSourceRefreshScope  An enumeration of possible data source refresh scopes.
 DataSourceType  DataSourceType  An enumeration of the possible data source types.
 DataValidationCriteria  DataValidationCriteria  An enumeration representing the data validation criteria that can be set on a range.
 DateTimeGroupingRuleType  DateTimeGroupingRuleType  An enumeration of date time grouping rule.
 DeveloperMetadataLocationType  DeveloperMetadataLocationType  An enumeration of possible developer metadata location types.
 DeveloperMetadataVisibility  DeveloperMetadataVisibility  An enumeration of the possible developer metadata visibilities.
 Dimension  Dimension  An enumeration of the possible dimensions of a spreadsheet.
 Direction  Direction  A enumeration of the possible directions that one can move within a spreadsheet using the arrow keys.
 FrequencyType  FrequencyType  An enumeration of possible frequency types.
 GroupControlTogglePosition  GroupControlTogglePosition  An enumeration of the positions that the group control toggle can be in.
 InterpolationType  InterpolationType  An enumeration of conditional format gradient interpolation types.
 PivotTableSummarizeFunction  PivotTableSummarizeFunction  An enumeration of the functions that may be used to summarize values in a pivot table.
 PivotValueDisplayType  PivotValueDisplayType  An enumeration of the ways that a pivot value may be displayed.
 ProtectionType  ProtectionType  An enumeration representing the parts of a spreadsheet that can be protected from edits.
 RecalculationInterval  RecalculationInterval  An enumeration of the possible intervals that can be used in spreadsheet recalculation.
 RelativeDate  RelativeDate  An enumeration of relative date options for calculating a value to be used in date-based BooleanCriteria.
 SheetType  SheetType  An enumeration of the different types of sheets that can exist in a spreadsheet.
 SortOrder  SortOrder  An enumeration of sort order.
 TextDirection  TextDirection  An enumeration of valid text directions.
 TextToColumnsDelimiter  TextToColumnsDelimiter  An enumeration of the preset delimiters for split text to columns.
 ThemeColorType  ThemeColorType  An enumeration of possible theme color types.
 WrapStrategy  WrapStrategy  An enumeration of the strategies used for wrapping cells.

Enum AutoFillSeries

 プロパティ名  返り値  簡単な説明
 DEFAULT_SERIES  Enom  オートフィルがデフォルト設定の場合は、入力済みの値の増分が空欄セルに出力されます。
 ALTERNATE_SERIES  Enom  オートフィルがこちらの設定の場合は、入力済みの値と同じ値が空欄セルに出力されます。

Enum 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  ピンクのテーマ色

Enum 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  カスタム数式

Enum BorderStyle

罫線の形式を設定する事ができます。Range.setBorder(top, left, bottom, right, vertical, horizontal, color, style)と一緒に使用します。

 プロパティ  タイプ  説明
 DOTTED  Enum  点線
 DASHED  Enum  破線
 SOLID  Enum  細い実線
 SOLID_MEDIUM  Enum  中くらいの太さの実線
 SOLID_THICK  Enum  太い実線
 DOUBLE  Enum  二重線

Enum 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  列幅だけ貼り付け

Enum DataExecutionErrorCode

 プロパティ  タイプ  説明
 DATA_EXECUTION_ERROR_CODE_UNSUPPORTED  Enum  Apps Scriptでサポートされていない実行エラー
 NONE  Enum  実行データにエラーなし
 TIME_OUT  Enum  タイムアウト。データを更新する必要があります。
 TOO_MANY_ROWS  Enum  列数上限をオーバー。データを更新する必要があります。
 TOO_MANY_CELLS  Enum  セル数上限をオーバー。データを更新する必要があります。
 ENGINE  Enum  実行エンジンのエラー。詳細はDataExecutionStatus.getErrorMessage()で確認できます。
 PARAMETER_INVALID  Enum  パラメータが不正。参照元のセルが存在し、数値かテキストだけが含まれる値でなければなりません。データを更新する必要があります。
 UNSUPPORTED_DATA_TYPE  Enum  サポートされていないデータ形式。データを更新する必要があります。*BigQueryでは、ARRAYタイプやSTRUCTタイプはサポートされていません。
 DUPLICATE_COLUMN_NAMES  Enum  The data execution returns duplicate column names.
 INTERRUPTED  Enum  実行データが妨害されました。後で再読み込みして下さい。
 OTHER  Enum  その他のエラー
 TOO_MANY_CHARS_PER_CELL  Enum  セルの値が1セルの文字数制限をオーバーしています。。データを更新する必要があります。
 DATA_NOT_FOUND  Enum  参照データが見つかりません。。データを更新する必要があります。
 PERMISSION_DENIED  Enum  ユーザーに対象のデータにアクセスする権限がありません。

Enum DataExecutionState

実行データの状況を表します。

 プロパティ  タイプ  説明
 DATA_EXECUTION_STATE_UNSUPPORTED  Enum Apps Scriptではサポートされていない実行状態です。
 RUNNING  Enum  実行中です。
 SUCCESS  Enum  実行完了しました。
 ERROR  Enum  実行失敗しました。
 NOT_STARTED  Enum  実行されていません。

Enum DataSourceRefreshScope

 プロパティ  タイプ  説明
 DATA_SOURCE_REFRESH_SCOPE_UNSUPPORTED  Enum  The data source refresh scope is unsupported.
 ALL_DATA_SOURCES  Enum  The refresh applies to all data sources in the spreadsheet.

Enum DataSourceType

 プロパティ  タイプ  説明
 DATA_SOURCE_TYPE_UNSUPPORTED  Enum  A data source type that is not supported in Apps Script.
 BIGQUERY  Enum  A BigQuery data source.

Enum DataValidationCriteria

 プロパティ  タイプ  説明
 DATE_AFTER  Enum  Requires a date that is after the given value.
 DATE_BEFORE  Enum  Requires a date that is before the given value.
 DATE_BETWEEN  Enum  Requires a date that is between the given values.
 DATE_EQUAL_TO  Enum  Requires a date that is equal to the given value.
 DATE_IS_VALID_DATE  Enum  Requires a date.
 DATE_NOT_BETWEEN  Enum  Requires a date that is not between the given values.
 DATE_ON_OR_AFTER  Enum  Require a date that is on or after the given value.
 DATE_ON_OR_BEFORE  Enum  Requires a date that is on or before the given value.
 NUMBER_BETWEEN  Enum  Requires a number that is between the given values.
 NUMBER_EQUAL_TO  Enum  Requires a number that is equal to the given value.
 NUMBER_GREATER_THAN  Enum  Require a number that is greater than the given value.
 NUMBER_GREATER_THAN_OR_EQUAL_TO  Enum  Requires a number that is greater than or equal to the given value.
 NUMBER_LESS_THAN  Enum  Requires a number that is less than the given value.
 NUMBER_LESS_THAN_OR_EQUAL_TO  Enum  Requires a number that is less than or equal to the given value.
 NUMBER_NOT_BETWEEN  Enum  Requires a number that is not between the given values.
 NUMBER_NOT_EQUAL_TO  Enum  Requires a number that is not equal to the given value.
 TEXT_CONTAINS  Enum  Requires that the input contains the given value.
 TEXT_DOES_NOT_CONTAIN  Enum  Requires that the input does not contain the given value.
 TEXT_EQUAL_TO  Enum  Requires that the input is equal to the given value.
 TEXT_IS_VALID_EMAIL  Enum  Requires that the input is in the form of an email address.
 TEXT_IS_VALID_URL  Enum  Requires that the input is in the form of a URL.
 VALUE_IN_LIST  Enum  Requires that the input is equal to one of the given values.
 VALUE_IN_RANGE  Enum  Requires that the input is equal to a value in the given range.
 CUSTOM_FORMULA  Enum  Requires that the input makes the given formula evaluate to true.
 CHECKBOX  Enum  Requires that the input is a custom value or a boolean; rendered as a checkbox.

Enum DateTimeGroupingRuleType

 プロパティ  タイプ  説明
 UNSUPPORTED  Enum  A date-time grouping rule type that is not supported.
 SECOND  Enum  Group date-time by second, from 0 to 59.
 MINUTE  Enum  Group date-time by minute, from 0 to 59.
 HOUR  Enum  Group date-time by hour using a 24-hour system, from 0 to 23.
 HOUR_MINUTE  Enum  Group date-time by hour and minute using a 24-hour system, for example 19:45.
 HOUR_MINUTE_AMPM  Enum  Group date-time by hour and minute using a 12-hour system, for example 7:45 PM.
 DAY_OF_WEEK  Enum  Group date-time by day of week, for example Sunday.
 DAY_OF_YEAR  Enum  Group date-time by day of year, from 1 to 366.
 DAY_OF_MONTH  Enum  Group date-time by day of month, from 1 to 31.
 DAY_MONTH  Enum  Group date-time by day and month, for example 22-Nov.
 MONTH  Enum  Group date-time by month, for example Nov.
 QUARTER  Enum  Group date-time by quarter, for example Q1 (which represents Jan-Mar).
 YEAR  Enum  Group date-time by year, for example 2008.
 YEAR_MONTH  Enum  Group date-time by year and month, for example 2008-Nov.
 YEAR_QUARTER  Enum  Group date-time by year and quarter, for example 2008 Q4 .
 YEAR_MONTH_DAY  Enum  Group date-time by year, month, and day, for example 2008-11-22.

Enum DeveloperMetadataLocationType

 プロパティ  タイプ  説明
 SPREADSHEET  Enum  The location type for developer metadata associated with the top-level spreadsheet.
 SHEET  Enum  The location type for developer metadata associated with a whole sheet.
 ROW  Enum  The location type for developer metadata associated with a row.
 COLUMN  Enum  The location type for developer metadata associated with a column.

Enum DeveloperMetadataVisibility

 プロパティ  タイプ  説明
 DOCUMENT  Enum  Document-visible metadata is accessible from any developer project with access to the document.
 PROJECT  Enum  Project-visible metadata is only visible to and accessible by the developer project that created the metadata.

Enum Dimension

スプレッドシートにデータを保存できる方向の列挙型

 プロパティ  タイプ  説明
 COLUMNS  Enum  列次元(垂直方向)
 ROWS  Enum  行次元(水平方向)

Enum Direction

ユーザーが矢印キーを使ってスプレッドシート内で移動できる方向を表す列挙型

 プロパティ  タイプ  説明
 UP  Enum  行インデックスが減少する方向
 DOWN  Enum  行インデックスが増加する方向
 PREVIOUS  Enum  列インデックスが減少する方向
 NEXT  Enum  列インデックスが増加する方向

Enum FrequencyType

更新頻度を表す列挙型

 プロパティ  タイプ  説明
 FREQUENCY_TYPE_UNSUPPORTED  Enum  頻度はサポートされていません。
 DAILY  Enum  日次で更新
 WEEKLY  Enum  特定の曜日で週次で更新
 MONTHLY  Enum  特定の曜日で月次で更新

Enum GroupControlTogglePosition

 プロパティ  タイプ  説明
 BEFORE  Enum  The position where the control toggle is before the group (at lower indices).
 AFTER  Enum  The position where the control toggle is after the group (at higher indices).

Enum InterpolationType

 プロパティ  タイプ  説明
 NUMBER  Enum  Use the number as as specific interpolation point for a gradient condition.
 PERCENT  Enum  Use the number as a percentage interpolation point for a gradient condition.
 PERCENTILE  Enum  Use the number as a percentile interpolation point for a gradient condition.
 MIN  Enum  Infer the minimum number as a specific interpolation point for a gradient condition.
 MAX  Enum  Infer the maximum number as a specific interpolation point for a gradient condition.

Enum PivotTableSummarizeFunction

 プロパティ  タイプ  説明
 CUSTOM  Enum  A custom fuction, this value is only valid for calcuated fields.
 SUM  Enum  The SUM function
 COUNTA  Enum  The COUNTA function
 COUNT  Enum  The COUNT function
 COUNTUNIQUE  Enum  The COUNTUNIQUE function
 AVERAGE  Enum  The AVERAGE function
 MAX  Enum  The MAX function
 MIN  Enum  The MIN function
 MEDIAN  Enum  The MEDIAN function
 PRODUCT  Enum  The PRODUCT function
 STDEV  Enum  The STDEV function
 STDEVP  Enum  The STDEVP function
 VAR  Enum  The VAR function
 VARP  Enum  The VARP function

Enum PivotValueDisplayType

 プロパティ  タイプ  説明
 DEFAULT  Enum  Default.
 PERCENT_OF_ROW_TOTAL  Enum  Displays pivot values as a percent of the total for that row.
 PERCENT_OF_COLUMN_TOTAL  Enum  Displays pivot values as a percent of the total for that column.
 PERCENT_OF_GRAND_TOTAL  Enum  Displays pivot values as a percent of the grand total.

Enum ProtectionType

スプレッドシートの一部が保護されているセルやシートを取得できます。getProtections()と併用して利用します。

保護されたセルの保護をすべて解除する
//スプレッドシートの保護されたセルの保護をすべて解除するサンプルコード
function sampleCodeForGetAllCalendars() {
  var ss = SpreadsheetApp.getActive();
  var protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE); //ここで保護されたセルをすべて取得している
  for (var i = 0; i < protections.length; i++) {
    var protection = protections[i];
    if (protection.canEdit()) {
      protection.remove();
    }
  }
}
アクティブなシートから保護を解除する
//アクティブなシートから保護を解除するサンプルコード
function sampleCodeForGetAllCalendars() {
  var sheet = SpreadsheetApp.getActiveSheet();
  var protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];
  if (protection && protection.canEdit()) {
    protection.remove();
  }
}
 プロパティ  タイプ  説明
 RANGE  Enum  保護されたセル
 SHEET  Enum  保護されたシート

Enum RecalculationInterval

スプレッドシートに入力されている関数の再計算の間隔を設定

 プロパティ  タイプ  説明
 ON_CHANGE  Enum  セルの値が変更されたときのみ再計算を実行
 MINUTE  Enum  セルの値が変更されたときと1分毎に再計算を実行
 HOUR  Enum  ルの値が変更されたときと1時間毎に再計算を実行

Enum RelativeDate

日付ベースのBooleanCriteriaで値を算出するために使う相対日付を表す列挙型

 プロパティ  タイプ  説明
 TODAY  Enum  当日を表す
 TOMORROW  Enum  1日後の日を表す
 YESTERDAY  Enum  1日前の日を表す
 PAST_WEEK  Enum  1週間前の日付を表す
 PAST_MONTH  Enum  1ヶ月前の日付を表す
 PAST_YEAR  Enum  1年前の日付を表す

Enum SheetType

スプレッドシートに存在するシートタイプ

 プロパティ  タイプ  説明
 GRID  Enum  グリッドを含むシートA sheet containing a grid.
 OBJECT  Enum  埋め込みオブジェクト(グラフ等)が含まれるシート
 DATASOURCE  Enum  データソースが含まれるシート

Enum SortOrder

並び順を表す列挙型

 プロパティ  タイプ  説明
 ASCENDING  Enum  昇順
 DESCENDING  Enum  降順

Enum TextDirection

テキストの方向を表す列挙型

 プロパティ  タイプ  説明
 LEFT_TO_RIGHT  Enum  左から右へ
 RIGHT_TO_LEFT  Enum  右から左へ

Enum TextToColumnsDelimiter

文字列を複数の列に分ける区切り文字タイプの列挙型

 プロパティ  タイプ  説明
 COMMA  Enum  区切り文字「 , 」(カンマ)
 SEMICOLON  Enum  区切り文字「 ; 」(セミコロン)
 PERIOD  Enum  区切り文字「 . 」(ピリオド)
 SPACE  Enum  区切り文字「 」(半角スペース)

Enum ThemeColorType

テーマでサポートされている様々な色を表す列挙型

 プロパティ  タイプ  説明
 UNSUPPORTED  Enum  サポートされていないテーマの色
 TEXT  Enum  テキストの色
 BACKGROUND  Enum  グラフの背景色
 ACCENT1  Enum  第一アクセント色
 ACCENT2  Enum  第二アクセント色
 ACCENT3  Enum  第三アクセント色
 ACCENT4  Enum  第四アクセント色
 ACCENT5  Enum  第五アクセント色
 ACCENT6  Enum  第六アクセント色
 HYPERLINK  Enum  ハイパーリンクの色

Enum WrapStrategy

テキストの折返し設定を表す列挙型

 プロパティ  タイプ  説明
 WRAP  Enum  セルの横幅を超える場合折り返す
 OVERFLOW  Enum  セルの横幅を超える場合隣のセルが空白ならはみ出す
 CLIP  Enum  セルの横幅を超える場合切り詰める
Exit mobile version