このサービスを使用すると、スクリプトで Google スプレッドシート ファイルの作成、アクセス、変更を行うことができます。スプレッドシートにデータを保存するガイドもご覧ください。
メソッドを複数回呼び出す場合など、パフォーマンスを向上させるためにスプレッドシート オペレーションがまとめられることがあります。保留中の変更がすべて直ちに行われるようにする場合(たとえば、スクリプトの実行中にユーザー情報を表示する場合など)は、SpreadsheetApp.flush()
を呼び出します。
クラス
名前 | 概要 |
---|---|
AutoFillSeries | 自動入力値の計算に使用されるシリーズのタイプを列挙します。 |
Banding | 範囲の行や列に適用されるカラーパターンであるバンディングにアクセスして変更する。 |
BandingTheme | バンディング テーマの列挙。 |
BigQueryDataSourceSpec | 既存の BigQuery データソース仕様にアクセスします。 |
BigQueryDataSourceSpecBuilder | BigQueryDataSourceSpecBuilder のビルダー。 |
BooleanCondition | ConditionalFormatRules のブール条件へのアクセス。 |
BooleanCriteria | 条件付き形式またはフィルタで使用できるブール型の条件を表す列挙型。 |
BorderStyle | Range.setBorder(top, left, bottom, right, vertical, horizontal, color, style) を使用して範囲に設定できるスタイル。 |
CellImage | セルに追加する画像を表します。 |
CellImageBuilder | CellImage のビルダー。 |
Color | 色の表現。 |
ColorBuilder | ColorBuilder のビルダー。 |
ConditionalFormatRule | 条件付き書式ルールにアクセスします。 |
ConditionalFormatRuleBuilder | 条件付き書式ルールのビルダー。 |
ContainerInfo | シート内のグラフの位置にアクセスします。 |
CopyPasteType | 使用可能な特殊な貼り付けの種類を列挙します。 |
DataExecutionErrorCode | データ実行エラーコードの列挙型。 |
DataExecutionState | データ実行状態の列挙型。 |
DataExecutionStatus | データの実行ステータス。 |
DataSource | 既存のデータソースにアクセスして変更する。 |
DataSourceChart | 既存のデータソース グラフにアクセスして変更する。 |
DataSourceColumn | データソースの列にアクセスして変更する。 |
DataSourceFormula | 既存のデータソースの数式にアクセスして変更する。 |
DataSourceParameter | 既存のデータソース パラメータにアクセスする。 |
DataSourceParameterType | データソース パラメータの型の列挙型。 |
DataSourcePivotTable | 既存のデータソース ピボット テーブルにアクセスして変更する。 |
DataSourceRefreshSchedule | 既存の更新スケジュールにアクセスして変更する。 |
DataSourceRefreshScheduleFrequency | 更新スケジュールの頻度(更新の頻度とタイミングを指定)にアクセスします。 |
DataSourceRefreshScope | 更新のスコープの列挙。 |
DataSourceSheet | 既存のデータソースシートにアクセスして変更する。 |
DataSourceSheetFilter | 既存のデータソースのシートフィルタにアクセスして変更する。 |
DataSourceSpec | 既存のデータソース仕様の一般設定にアクセスします。 |
DataSourceSpecBuilder | DataSourceSpec のビルダー。 |
DataSourceTable | 既存のデータソース テーブルにアクセスして変更する。 |
DataSourceTableColumn | DataSourceTable 内の既存の列にアクセスして変更します。 |
DataSourceTableFilter | 既存のデータソース テーブル フィルタにアクセスして変更する。 |
DataSourceType | データソース タイプの列挙型。 |
DataValidation | データの入力規則にアクセスする。 |
DataValidationBuilder | データの入力規則のビルダー。 |
DataValidationCriteria | 範囲に設定できるデータの入力規則を表す列挙型。 |
DateTimeGroupingRule | 既存の日時のグループ化ルールにアクセスします。 |
DateTimeGroupingRuleType | 日時のグループ化ルールの種類。 |
DeveloperMetadata | デベロッパーのメタデータにアクセスして変更する。 |
DeveloperMetadataFinder | スプレッドシートでデベロッパー メタデータを検索する。 |
DeveloperMetadataLocation | デベロッパーのメタデータの位置情報にアクセスする。 |
DeveloperMetadataLocationType | デベロッパー メタデータの場所の種類の列挙型。 |
DeveloperMetadataVisibility | デベロッパー メタデータの公開設定の種類の列挙型。 |
Dimension | スプレッドシートにデータを保存できる方向の列挙型。 |
Direction | 矢印キーを使用してスプレッドシート内で移動できる方向を表す列挙型。 |
Drawing | スプレッドシートのシート上に描画された図形を表します。 |
EmbeddedAreaChartBuilder | 面グラフのビルダー。 |
EmbeddedBarChartBuilder | 棒グラフのビルダー。 |
EmbeddedChart | スプレッドシートに埋め込まれたグラフを表します。 |
EmbeddedChartBuilder | EmbeddedChart の編集に使用されるビルダー。 |
EmbeddedColumnChartBuilder | 縦棒グラフのビルダー。 |
EmbeddedComboChartBuilder | 複合グラフのビルダー。 |
EmbeddedHistogramChartBuilder | ヒストグラム グラフのビルダー。 |
EmbeddedLineChartBuilder | 折れ線グラフのビルダー。 |
EmbeddedPieChartBuilder | 円グラフのビルダー。 |
EmbeddedScatterChartBuilder | 散布図のビルダー。 |
EmbeddedTableChartBuilder | 表グラフのビルダー。 |
Filter | このクラスを使用して、Grid シート(シートのデフォルト タイプ)の既存のフィルタを変更します。 |
FilterCriteria | このクラスを使用すると、既存のフィルタの条件に関する情報を取得したり、既存のフィルタの条件をコピーしたりできます。 |
FilterCriteriaBuilder | フィルタに条件を追加するには、次の操作を行います。
|
FrequencyType | フリークエンシー タイプの列挙型。 |
GradientCondition | ConditionalFormatRuleApis のグラデーション(色)条件にアクセスします。 |
Group | スプレッドシート グループにアクセスして変更する。 |
GroupControlTogglePosition | グループ コントロールの切り替えボタンが配置できる位置を表す列挙型。 |
InterpolationType | ConditionalFormatRule の GradientCondition で使用する値を計算するための補間オプションを表す列挙型。 |
LookerDataSourceSpec | DataSourceSpec 。既存の Looker データソース仕様へのアクセスに使用されます。 |
LookerDataSourceSpecBuilder | LookerDataSourceSpecBuilder のビルダー。 |
NamedRange | スプレッドシートで名前付き範囲を作成、アクセス、変更する。 |
OverGridImage | スプレッドシートのグリッド上の画像を表します。 |
| 古いバージョンの Google スプレッドシートで保護されたシートにアクセスして変更する。 |
PivotFilter | ピボット テーブルのフィルタにアクセスして変更する。 |
PivotGroup | ピボット テーブルの分割グループにアクセスして変更する。 |
PivotGroupLimit | ピボット テーブル グループの制限にアクセスして変更する。 |
PivotTable | ピボット テーブルにアクセスして変更する。 |
PivotTableSummarizeFunction | ピボット テーブルのデータを集計する関数の列挙です。 |
PivotValue | ピボット テーブルで値グループにアクセスしたり、値グループを変更したりできます。 |
PivotValueDisplayType | ピボット値を別の値の関数として表示する方法の列挙型。 |
Protection | 保護された範囲とシートにアクセスして変更する。 |
ProtectionType | 編集から保護できるスプレッドシートの部分を表す列挙型。 |
Range | スプレッドシートの範囲にアクセスして変更する。 |
RangeList | 同じシート内の 1 つ以上の Range インスタンスのコレクション。 |
RecalculationInterval | スプレッドシートの再計算で使用できる間隔を表す列挙型。 |
RelativeDate | 日付ベースの BooleanCriteria で使用される値を計算するための相対日付オプションを表す列挙型。 |
RichTextValue | セルのテキストを表すために使用される定型化されたテキスト文字列。 |
RichTextValueBuilder | リッチテキスト値のビルダー。 |
Selection | アクティブなシートで現在アクティブな選択範囲にアクセスします。 |
Sheet | スプレッドシートのシートにアクセスして変更する。 |
SheetType | スプレッドシートに存在するさまざまな種類のシートを紹介します。 |
Slicer | スライサーを表します。範囲、グラフ、ピボット テーブルを非共同編集方式でフィルタするために使用されます。 |
SortOrder | 並べ替え順序を表す列挙型。 |
SortSpec | 並べ替えの仕様。 |
Spreadsheet | Google スプレッドシート ファイルにアクセスして変更する。 |
SpreadsheetApp | Google スプレッドシート ファイルにアクセスして作成する。 |
SpreadsheetTheme | 既存のテーマにアクセスして変更する。 |
TextDirection | テキストによる経路案内の列挙型。 |
TextFinder | 範囲、シート、スプレッドシート内のテキストを検索または置換します。 |
TextRotation | セルのテキストの回転設定にアクセスします。 |
TextStyle | セル内のテキストのレンダリング スタイル。 |
TextStyleBuilder | テキスト スタイルのビルダー。 |
TextToColumnsDelimiter | テキスト列を複数の列に分割できる、プリセットの区切り文字の種類を列挙したリスト。 |
ThemeColor | テーマの色を表します。 |
ThemeColorType | テーマでサポートされているさまざまな色エントリを表す列挙型。 |
ValueType | Spreadsheet サービスの Range クラスから Range.getValue() と Range.getValues() によって返される値型の列挙型。 |
WrapStrategy | セルのテキストの折り返しを処理するために使用される戦略の列挙型。 |
AutoFillSeries
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DEFAULT_SERIES | Enum | デフォルトです。 |
ALTERNATE_SERIES | Enum | この設定で自動入力すると、拡張された範囲の空のセルに既存の値のコピーが入力されます。 |
Banding
メソッド
BandingTheme
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
LIGHT_GREY | Enum | 明るいグレーのバンディング テーマ。 |
CYAN | Enum | シアンの縞模様が描かれたテーマ。 |
GREEN | Enum | 緑色のバンドのテーマ。 |
YELLOW | Enum | 黄色のバンディング テーマ。 |
ORANGE | Enum | オレンジ色の縞模様がテーマです。 |
BLUE | Enum | 青色の縞模様がテーマです。 |
TEAL | Enum | 青緑色のバンディング テーマ。 |
GREY | Enum | グレーの縞模様がテーマ。 |
BROWN | Enum | 茶色の帯状のパターン。 |
LIGHT_GREEN | Enum | 明るい緑色のバンドのテーマ。 |
INDIGO | Enum | インディゴ色のバンドリング テーマ。 |
PINK | Enum | ピンクのバンドのテーマ。 |
BigQueryDataSourceSpec
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | DataSourceSpecBuilder | このデータソースの設定に基づいて DataSourceSpecBuilder を作成します。 |
getDatasetId() | String | BigQuery データセット ID を取得します。 |
getParameters() | DataSourceParameter[] | データソースのパラメータを取得します。 |
getProjectId() | String | 課金プロジェクト ID を取得します。 |
getRawQuery() | String | 未加工のクエリ文字列を取得します。 |
getTableId() | String | BigQuery テーブル ID を取得します。 |
getTableProjectId() | String | テーブルの BigQuery プロジェクト ID を取得します。 |
getType() | DataSourceType | データソースのタイプを取得します。 |
BigQueryDataSourceSpecBuilder
メソッド
BooleanCondition
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getBackgroundObject() | Color | このブール条件の背景色を取得します。 |
getBold() | Boolean | このブール値の条件でテキストが太字になった場合は true を返し、このブール値の条件でテキストから太字が削除された場合は false を返します。 |
getCriteriaType() | BooleanCriteria | BooleanCriteria 列挙型で定義されているルールの条件タイプを取得します。 |
getCriteriaValues() | Object[] | ルールの条件を表す引数の配列を取得します。 |
getFontColorObject() | Color | このブール値条件のフォントの色を取得します。 |
getItalic() | Boolean | このブール値の条件でテキストが斜体化される場合は true を返し、このブール値の条件でテキストから斜体化が削除される場合は false を返します。 |
getStrikethrough() | Boolean | このブール条件でテキストに取り消し線が引かれた場合は true を返し、このブール値条件でテキストから取り消し線を取り除いた場合は false を返します。 |
getUnderline() | Boolean | このブール条件でテキストの下線が引かれる場合は true を返し、このブール条件でテキストの下線が削除される場合は false を返します。 |
BooleanCriteria
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
CELL_EMPTY | Enum | セルが空の場合、条件を満たしています。 |
CELL_NOT_EMPTY | Enum | セルが空でない場合、条件が満たされます。 |
DATE_AFTER | Enum | 指定された値より後の日付の場合、条件が満たされます。 |
DATE_BEFORE | Enum | 指定された値より前の日付の場合、条件が満たされます。 |
DATE_EQUAL_TO | Enum | 条件は、指定した値と日付が等しい場合に満たされます。 |
DATE_NOT_EQUAL_TO | Enum | 日付が指定された値と等しくない場合、条件が満たされます。 |
DATE_AFTER_RELATIVE | Enum | 日付が相対日付値より後の場合、条件が満たされます。 |
DATE_BEFORE_RELATIVE | Enum | 日付が相対日付値より前の場合、条件が満たされます。 |
DATE_EQUAL_TO_RELATIVE | Enum | 日付が相対日付値と等しい場合に条件が満たされます。 |
NUMBER_BETWEEN | Enum | 数値が指定した値の間にあると、条件が満たされています。 |
NUMBER_EQUAL_TO | Enum | 指定された値に等しい数値が条件を満たします。 |
NUMBER_GREATER_THAN | Enum | 指定された値より大きい数値の場合、条件が満たされます。 |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | 指定された値以上の数値が条件を満たします。 |
NUMBER_LESS_THAN | Enum | 指定した値より小さい数値の場合、条件が満たされます。 |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | 指定された値以下の数値の場合、条件が満たされます。 |
NUMBER_NOT_BETWEEN | Enum | 指定された値の範囲外の数値が条件を満たします。 |
NUMBER_NOT_EQUAL_TO | Enum | 指定した値と等しくない数値がある場合、条件が満たされています。 |
TEXT_CONTAINS | Enum | 入力に指定された値が含まれている場合、条件が満たされます。 |
TEXT_DOES_NOT_CONTAIN | Enum | 入力に指定された値が含まれていない場合、条件が満たされます。 |
TEXT_EQUAL_TO | Enum | 入力値が指定された値と等しい場合、条件が満たされます。 |
TEXT_NOT_EQUAL_TO | Enum | 入力が指定された値と等しくない場合、条件が満たされます。 |
TEXT_STARTS_WITH | Enum | 入力が指定された値で始まると、条件が満たされます。 |
TEXT_ENDS_WITH | Enum | 入力が指定された値で終わると、条件が満たされます。 |
CUSTOM_FORMULA | Enum | 条件が満たされると、指定された数式が true と評価されます。 |
BorderStyle
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DOTTED | Enum | 点線の枠線。 |
DASHED | Enum | 破線の枠線。 |
SOLID | Enum | 細い実線の枠線。 |
SOLID_MEDIUM | Enum | 中程度の実線の枠線。 |
SOLID_THICK | Enum | 太い実線の枠線。 |
DOUBLE | Enum | 2 本の線で囲まれた枠線。 |
CellImage
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
valueType | ValueType | ValueType.IMAGE に設定されたフィールド。画像の値の型を表します。 |
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getAltTextDescription() | String | この画像の代替テキストの説明を返します。 |
getAltTextTitle() | String | この画像の代替テキストのタイトルを返します。 |
getContentUrl() | String | Google がホストする画像の URL を返します。 |
getUrl() | String | 画像のソース URL を取得します。URL が使用できない場合は null を返します。 |
toBuilder() | CellImageBuilder | 画像を画像値型に変換してセルに配置できるようにするビルダーを作成します。 |
CellImageBuilder
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
valueType | ValueType | ValueType.IMAGE に設定されたフィールド。画像の値の型を表します。 |
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
build() | CellImage | セルに画像を追加するために必要な画像値の型を作成します。 |
getAltTextDescription() | String | この画像の代替テキストの説明を返します。 |
getAltTextTitle() | String | この画像の代替テキストのタイトルを返します。 |
getContentUrl() | String | Google がホストする画像の URL を返します。 |
getUrl() | String | 画像のソース URL を取得します。URL が使用できない場合は null を返します。 |
setAltTextDescription(description) | CellImage | この画像の代替テキストの説明を設定します。 |
setAltTextTitle(title) | CellImage | この画像の代替テキストのタイトルを設定します。 |
setSourceUrl(url) | CellImageBuilder | 画像のソース URL を設定します。 |
toBuilder() | CellImageBuilder | 画像を画像値型に変換し、セルに配置できるようにするビルダーを作成します。 |
Color
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
asRgbColor() | RgbColor | この色を RgbColor に変換します。 |
asThemeColor() | ThemeColor | この色を ThemeColor に変換します。 |
getColorType() | ColorType | この色のタイプを取得します。 |
ColorBuilder
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
asRgbColor() | RgbColor | この色を RgbColor に変換します。 |
asThemeColor() | ThemeColor | この色を ThemeColor に変換します。 |
build() | Color | ビルダーに指定された設定からカラー オブジェクトを作成します。 |
getColorType() | ColorType | この色のタイプを取得します。 |
setRgbColor(cssString) | ColorBuilder | RGB 色として設定します。 |
setThemeColor(themeColorType) | ColorBuilder | テーマの色として設定します。 |
ConditionalFormatRule
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | ConditionalFormatRuleBuilder | このルールの設定を含むルール作成ツールのプリセットを返します。 |
getBooleanCondition() | BooleanCondition | このルールがブール値の条件条件を使用している場合、ルールの BooleanCondition 情報を取得します。 |
getGradientCondition() | GradientCondition | このルールがグラデーション条件の条件を使用している場合、ルールの GradientCondition 情報を取得します。 |
getRanges() | Range[] | この条件付き書式ルールが適用される範囲を取得します。 |
ConditionalFormatRuleBuilder
メソッド
ContainerInfo
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getAnchorColumn() | Integer | グラフの左側はこの列に固定されます。 |
getAnchorRow() | Integer | グラフの上部がこの行に固定されます。 |
getOffsetX() | Integer | グラフの左上は、アンカー列からこのピクセル数だけオフセットされます。 |
getOffsetY() | Integer | グラフの左上隅がアンカー行からこのピクセル分ずれます。 |
CopyPasteType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
PASTE_NORMAL | Enum | 値、数式、書式、結合を貼り付ける。 |
PASTE_NO_BORDERS | Enum | 値、数式、書式、結合を枠線なしで貼り付けます。 |
PASTE_FORMAT | Enum | 書式のみを貼り付けます。 |
PASTE_FORMULA | Enum | 数式のみを貼り付けます。 |
PASTE_DATA_VALIDATION | Enum | データの入力規則のみを貼り付けます。 |
PASTE_VALUES | Enum | 書式、数式、結合を使わず、値のみを貼り付けます。 |
PASTE_CONDITIONAL_FORMATTING | Enum | 色のルールのみを貼り付けます。 |
PASTE_COLUMN_WIDTHS | Enum | 列幅のみを貼り付けます。 |
DataExecutionErrorCode
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DATA_EXECUTION_ERROR_CODE_UNSUPPORTED | Enum | Apps Script でサポートされていないデータ実行エラーコード。 |
NONE | Enum | データ実行にエラーはありません。 |
TIME_OUT | Enum | データの実行がタイムアウトしました。 |
TOO_MANY_ROWS | Enum | データの実行により、上限を超える行が返されます。 |
TOO_MANY_COLUMNS | Enum | データの実行により、上限を超える数の列が返されます。 |
TOO_MANY_CELLS | Enum | データの実行で、上限を超えるセルが返される。 |
ENGINE | Enum | データ実行エンジンのエラー。 |
PARAMETER_INVALID | Enum | データ実行パラメータが無効です。 |
UNSUPPORTED_DATA_TYPE | Enum | データの実行で、サポートされていないデータ型が返されました。 |
DUPLICATE_COLUMN_NAMES | Enum | データの実行により、重複する列名が返されます。 |
INTERRUPTED | Enum | データの実行は中断されます。 |
OTHER | Enum | その他のエラー。 |
TOO_MANY_CHARS_PER_CELL | Enum | データの実行により、1 つのセルに許可されている最大文字数を超える値が返されます。 |
DATA_NOT_FOUND | Enum | データソースが参照するデータベースが見つかりません。 |
PERMISSION_DENIED | Enum | ユーザーに、データソースが参照するデータベースへのアクセス権がない。 |
DataExecutionState
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DATA_EXECUTION_STATE_UNSUPPORTED | Enum | データ実行状態は Apps Script ではサポートされていません。 |
RUNNING | Enum | データの実行が開始され、実行中です。 |
SUCCESS | Enum | データの実行が完了し、正常に完了しました。 |
ERROR | Enum | データの実行が完了し、エラーが発生しています。 |
NOT_STARTED | Enum | データの実行は開始されていません。 |
DataExecutionStatus
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getErrorCode() | DataExecutionErrorCode | データ実行のエラーコードを取得します。 |
getErrorMessage() | String | データ実行のエラー メッセージを取得します。 |
getExecutionState() | DataExecutionState | データ実行の状態を取得します。 |
getLastExecutionTime() | Date | 実行ステータスに関係なく、最後にデータ実行が完了した時刻を取得します。 |
getLastRefreshedTime() | Date | データが最後に正常に更新された時刻を取得します。 |
isTruncated() | Boolean | 前回の正常な実行のデータが切り捨てられた場合は true 、それ以外の場合は false を返します。 |
DataSource
メソッド
DataSourceChart
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
cancelDataRefresh() | DataSourceChart | このオブジェクトに関連付けられているデータ更新が現在実行中の場合は、その更新をキャンセルします。 |
forceRefreshData() | DataSourceChart | 現在の状態に関係なく、このオブジェクトのデータを更新します。 |
getDataSource() | DataSource | オブジェクトがリンクされているデータソースを取得します。 |
getStatus() | DataExecutionStatus | オブジェクトのデータ実行ステータスを取得します。 |
refreshData() | DataSourceChart | オブジェクトのデータを更新します。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 指定された秒数経過後にタイムアウトし、現在の実行が完了するまで待機します。 |
DataSourceColumn
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getDataSource() | DataSource | データソース列に関連付けられているデータソースを取得します。 |
getFormula() | String | データソース列の数式を取得します。 |
getName() | String | データソース列の名前を取得します。 |
hasArrayDependency() | Boolean | 列に配列の依存関係があるかどうかを返します。 |
isCalculatedColumn() | Boolean | 列が計算された列かどうかを返します。 |
remove() | void | データソースの列を削除します。 |
setFormula(formula) | DataSourceColumn | データソース列の式を設定します。 |
setName(name) | DataSourceColumn | データソース列の名前を設定します。 |
DataSourceFormula
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
cancelDataRefresh() | DataSourceFormula | このオブジェクトに関連付けられているデータ更新が現在実行中の場合は、その更新をキャンセルします。 |
forceRefreshData() | DataSourceFormula | 現在の状態に関係なく、このオブジェクトのデータを更新します。 |
getAnchorCell() | Range | このデータソースの式がアンカーされているセルを表す Range を返します。 |
getDataSource() | DataSource | オブジェクトがリンクされているデータソースを取得します。 |
getDisplayValue() | String | データソースの数式の表示値を返します。 |
getFormula() | String | このデータソースの数式を返します。 |
getStatus() | DataExecutionStatus | オブジェクトのデータ実行ステータスを取得します。 |
refreshData() | DataSourceFormula | オブジェクトのデータを更新します。 |
setFormula(formula) | DataSourceFormula | 数式を更新します。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 指定された秒数経過後にタイムアウトし、現在の実行が完了するまで待機します。 |
DataSourceParameter
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getName() | String | パラメータ名を取得します。 |
getSourceCell() | String | パラメータの値の基になるソースセルを取得します。パラメータの型が DataSourceParameterType.CELL でない場合は null です。 |
getType() | DataSourceParameterType | パラメータの型を取得します。 |
DataSourceParameterType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTED | Enum | Apps Script でサポートされていないデータソース パラメータの型。 |
CELL | Enum | データソース パラメータの値は、セルに基づいて設定されます。 |
DataSourcePivotTable
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
addColumnGroup(columnName) | PivotGroup | 指定したデータソース列に基づいて、新しいピボット列グループを追加します。 |
addFilter(columnName, filterCriteria) | PivotFilter | 指定したデータソース列に基づいて、指定したフィルタ条件で新しいフィルタを追加します。 |
addPivotValue(columnName) | PivotValue | 指定されたデータソース列に基づいて、集計関数なしで新しいピボット値を追加します。 |
addPivotValue(columnName, summarizeFunction) | PivotValue | 指定されたデータソース列と指定された集計関数に基づいて、新しいピボット値を追加します。 |
addRowGroup(columnName) | PivotGroup | 指定されたデータソース列に基づいて、新しいピボット行グループを追加します。 |
asPivotTable() | PivotTable | データソースのピボット テーブルを通常のピボット テーブル オブジェクトとして返します。 |
cancelDataRefresh() | DataSourcePivotTable | このオブジェクトに関連付けられているデータ更新が現在実行中の場合は、その更新をキャンセルします。 |
forceRefreshData() | DataSourcePivotTable | 現在の状態に関係なく、このオブジェクトのデータを更新します。 |
getDataSource() | DataSource | オブジェクトがリンクされているデータソースを取得します。 |
getStatus() | DataExecutionStatus | オブジェクトのデータ実行ステータスを取得します。 |
refreshData() | DataSourcePivotTable | オブジェクトのデータを更新します。 |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | 指定された秒数経過後にタイムアウトし、現在の実行が完了するまで待機します。 |
DataSourceRefreshSchedule
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getFrequency() | DataSourceRefreshScheduleFrequency | 更新スケジュールの頻度を取得します。この頻度には、更新する頻度とタイミングを指定します。 |
getScope() | DataSourceRefreshScope | この更新スケジュールのスコープを取得します。 |
getTimeIntervalOfNextRun() | TimeInterval | この更新スケジュールの次回の実行時間枠を取得します。 |
isEnabled() | Boolean | この更新スケジュールが有効かどうかを判断します。 |
DataSourceRefreshScheduleFrequency
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getDaysOfTheMonth() | Integer[] | データソースを更新する日付を数値(1 ~ 28)として取得します。 |
getDaysOfTheWeek() | Weekday[] | データソースを更新する曜日を取得します。 |
getFrequencyType() | FrequencyType | フリークエンシー タイプを取得します。 |
getStartHour() | Integer | 更新スケジュールが実行される時間帯の開始時間(0 ~ 23 の整数)を取得します。 |
DataSourceRefreshScope
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DATA_SOURCE_REFRESH_SCOPE_UNSUPPORTED | Enum | データソースの更新範囲がサポートされていません。 |
ALL_DATA_SOURCES | Enum | 更新はスプレッドシート内のすべてのデータソースに適用されます。 |
DataSourceSheet
メソッド
DataSourceSheetFilter
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getDataSourceColumn() | DataSourceColumn | このフィルタが適用されるデータソース列を返します。 |
getDataSourceSheet() | DataSourceSheet | このフィルタが属する DataSourceSheet を返します。 |
getFilterCriteria() | FilterCriteria | このフィルタのフィルタ条件を返します。 |
remove() | void | データソース オブジェクトからこのフィルタを削除します。 |
setFilterCriteria(filterCriteria) | DataSourceSheetFilter | このフィルタのフィルタ条件を設定します。 |
DataSourceSpec
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
asBigQuery() | BigQueryDataSourceSpec | BigQuery データソースの仕様を取得します。 |
asLooker() | LookerDataSourceSpec | Looker データソースの仕様を取得します。 |
copy() | DataSourceSpecBuilder | このデータソースの設定に基づいて DataSourceSpecBuilder を作成します。 |
getParameters() | DataSourceParameter[] | データソースのパラメータを取得します。 |
getType() | DataSourceType | データソースのタイプを取得します。 |
DataSourceSpecBuilder
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
asBigQuery() | BigQueryDataSourceSpecBuilder | BigQuery データソースのビルダーを取得します。 |
asLooker() | LookerDataSourceSpecBuilder | Looker データソースのビルダーを取得します。 |
build() | DataSourceSpec | このビルダーの設定からデータソース仕様を作成します。 |
copy() | DataSourceSpecBuilder | このデータソースの設定に基づいて DataSourceSpecBuilder を作成します。 |
getParameters() | DataSourceParameter[] | データソースのパラメータを取得します。 |
getType() | DataSourceType | データソースのタイプを取得します。 |
removeAllParameters() | DataSourceSpecBuilder | すべてのパラメータを削除します。 |
removeParameter(parameterName) | DataSourceSpecBuilder | 指定されたパラメータを削除します。 |
setParameterFromCell(parameterName, sourceCell) | DataSourceSpecBuilder | パラメータを追加します。名前が同じパラメータが存在する場合は、DataSourceType.BIGQUERY タイプのデータソース仕様ビルダーのソースセルを更新します。 |
DataSourceTable
メソッド
DataSourceTableColumn
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getDataSourceColumn() | DataSourceColumn | データソース列を取得します。 |
remove() | void | DataSourceTable から列を削除します。 |
DataSourceTableFilter
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getDataSourceColumn() | DataSourceColumn | このフィルタが適用されるデータソース列を返します。 |
getDataSourceTable() | DataSourceTable | このフィルタが属する DataSourceTable を返します。 |
getFilterCriteria() | FilterCriteria | このフィルタのフィルタ条件を返します。 |
remove() | void | データソース オブジェクトからこのフィルタを削除します。 |
setFilterCriteria(filterCriteria) | DataSourceTableFilter | このフィルタのフィルタ条件を設定します。 |
DataSourceType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DATA_SOURCE_TYPE_UNSUPPORTED | Enum | Apps Script でサポートされていないデータソースの種類。 |
BIGQUERY | Enum | BigQuery データソース。 |
LOOKER | Enum | Looker データソース。 |
DataValidation
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | DataValidationBuilder | このルールの設定に基づいて、データ入力規則のビルダーを作成します。 |
getAllowInvalid() | Boolean | 入力データの検証に失敗したときにルールが警告を表示する場合は true を返します。入力全体を拒否する場合は false を返します。 |
getCriteriaType() | DataValidationCriteria | DataValidationCriteria 列挙型で定義されているルールの条件タイプを取得します。 |
getCriteriaValues() | Object[] | ルールの条件を表す引数の配列を取得します。 |
getHelpText() | String | ルールのヘルプテキストを取得します。ヘルプテキストが設定されていない場合は null を返します。 |
DataValidationBuilder
メソッド
DataValidationCriteria
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DATE_AFTER | Enum | 指定された値より後の日付が必要です。 |
DATE_BEFORE | Enum | 指定した値より前の日付が必要です。 |
DATE_BETWEEN | Enum | 指定された値の範囲内にある日付が必要です。 |
DATE_EQUAL_TO | Enum | 指定された値と等しい日付が必要です。 |
DATE_IS_VALID_DATE | Enum | 日付が必要です。 |
DATE_NOT_BETWEEN | Enum | 指定した値の範囲外の日付が必要です。 |
DATE_ON_OR_AFTER | Enum | 指定した値以降の日付を必須にします。 |
DATE_ON_OR_BEFORE | Enum | 指定した値より前の日付を指定する必要があります。 |
NUMBER_BETWEEN | Enum | 指定された値の間の数値が必要です。 |
NUMBER_EQUAL_TO | Enum | 指定された値に等しい数値が必要です。 |
NUMBER_GREATER_THAN | Enum | 指定された値より大きい数値を必須にします。 |
NUMBER_GREATER_THAN_OR_EQUAL_TO | Enum | 指定した値以上の数値が必要です。 |
NUMBER_LESS_THAN | Enum | 指定された値より小さい数値が必要です。 |
NUMBER_LESS_THAN_OR_EQUAL_TO | Enum | 指定された値以下の数値が必要です。 |
NUMBER_NOT_BETWEEN | Enum | 指定された値の範囲外の数値を指定する必要があります。 |
NUMBER_NOT_EQUAL_TO | Enum | 指定された値と等しくない数値が必要です。 |
TEXT_CONTAINS | Enum | 入力に指定された値が含まれている必要があります。 |
TEXT_DOES_NOT_CONTAIN | Enum | 入力に指定された値が含まれていないことを必須とします。 |
TEXT_EQUAL_TO | Enum | 入力が指定された値と等しいことを必須とします。 |
TEXT_IS_VALID_EMAIL | Enum | メールアドレスの形式で入力する必要があります。 |
TEXT_IS_VALID_URL | Enum | 入力は URL 形式である必要があります。 |
VALUE_IN_LIST | Enum | 入力が指定された値のいずれかと等しいことを要求します。 |
VALUE_IN_RANGE | Enum | 入力が指定された範囲内の値と等しいことを要求します。 |
CUSTOM_FORMULA | Enum | 入力により、指定された数式が true と評価される必要があります。 |
CHECKBOX | Enum | 入力はカスタム値またはブール値である必要があります。チェックボックスとしてレンダリングされます。 |
DateTimeGroupingRule
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getRuleType() | DateTimeGroupingRuleType | 日時のグループ化ルールのタイプを取得します。 |
DateTimeGroupingRuleType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
UNSUPPORTED | Enum | サポートされていない日時のグループ化ルールの種類。 |
SECOND | Enum | 日時を秒単位でグループ化(0 ~ 59)。 |
MINUTE | Enum | 日時を分単位でグループ化(0 ~ 59)。 |
HOUR | Enum | 24 時間制(0 ~ 23)で日時を時間単位でグループ化します。 |
HOUR_MINUTE | Enum | 24 時間制を使用して日時を時間と分単位でグループ化します(例: 19:45 )。 |
HOUR_MINUTE_AMPM | Enum | 12 時間制を使用して日時を時間と分単位でグループ化します(例: 7:45 PM )。 |
DAY_OF_WEEK | Enum | 日付と時刻を曜日別にグループ化します(例: Sunday )。 |
DAY_OF_YEAR | Enum | 日付と時刻を、1 ~ 366 の年の日付でグループ化します。 |
DAY_OF_MONTH | Enum | 日付と時刻を日(1 ~ 31)でグループ化します。 |
DAY_MONTH | Enum | 日付と月で日時をグループ化します(例: 22-Nov )。 |
MONTH | Enum | 日時を月別にグループ化します(例: Nov )。 |
QUARTER | Enum | 日時を四半期ごとにグループ化します(例: Q1(1 月~ 3 月))。 |
YEAR | Enum | 日時を年(2008 年など)でグループ化します。 |
YEAR_MONTH | Enum | 年と月で日時をグループ化します(例: 2008-Nov )。 |
YEAR_QUARTER | Enum | 年および四半期ごとに日時をグループ化します(例: 2008 Q4 )。 |
YEAR_MONTH_DAY | Enum | 日時を年、月、日でグループ化します(例: 2008-11-22 )。 |
DeveloperMetadata
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getId() | Integer | このデベロッパー メタデータに関連付けられた一意の ID を返します。 |
getKey() | String | このデベロッパー メタデータに関連付けられているキーを返します。 |
getLocation() | DeveloperMetadataLocation | このデベロッパー メタデータの場所を返します。 |
getValue() | String | このデベロッパー メタデータに関連付けられている値を返します。このメタデータに値がない場合は null を返します。 |
getVisibility() | DeveloperMetadataVisibility | このデベロッパー メタデータの公開設定を返します。 |
moveToColumn(column) | DeveloperMetadata | このデベロッパー メタデータを指定された列に移動します。 |
moveToRow(row) | DeveloperMetadata | このデベロッパー メタデータを指定した行に移動します。 |
moveToSheet(sheet) | DeveloperMetadata | このデベロッパー メタデータを指定したシートに移動します。 |
moveToSpreadsheet() | DeveloperMetadata | このデベロッパー メタデータを最上位のスプレッドシートに移動します。 |
remove() | void | このメタデータを削除します。 |
setKey(key) | DeveloperMetadata | このデベロッパー メタデータのキーを指定された値に設定します。 |
setValue(value) | DeveloperMetadata | このデベロッパー メタデータに関連付けられた値を指定された値に設定します。 |
setVisibility(visibility) | DeveloperMetadata | このデベロッパー メタデータの公開設定を、指定した公開設定に設定します。 |
DeveloperMetadataFinder
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
find() | DeveloperMetadata[] | この検索を実行し、一致するメタデータを返します。 |
onIntersectingLocations() | DeveloperMetadataFinder | メタデータを含む交差する場所を考慮するように検索を構成します。 |
withId(id) | DeveloperMetadataFinder | 指定した ID に一致するメタデータのみを対象に検索を制限します。 |
withKey(key) | DeveloperMetadataFinder | 指定したキーに一致するメタデータのみを対象に検索を制限します。 |
withLocationType(locationType) | DeveloperMetadataFinder | 指定した場所のタイプに一致するメタデータのみを対象に検索を制限します。 |
withValue(value) | DeveloperMetadataFinder | 指定した値に一致するメタデータのみを検索対象にします。 |
withVisibility(visibility) | DeveloperMetadataFinder | 指定した公開設定に一致するメタデータのみを対象に検索を制限します。 |
DeveloperMetadataLocation
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getColumn() | Range | このメタデータの列位置の Range を返します。位置のタイプが DeveloperMetadataLocationType.COLUMN でない場合は null を返します。 |
getLocationType() | DeveloperMetadataLocationType | ビジネスのタイプを取得します。 |
getRow() | Range | このメタデータの行ロケーションの Range を返します。ロケーション タイプが DeveloperMetadataLocationType.ROW でない場合は null を返します。 |
getSheet() | Sheet | このメタデータの Sheet ロケーションを返します。ロケーション タイプが DeveloperMetadataLocationType.SHEET でない場合は null を返します。 |
getSpreadsheet() | Spreadsheet | このメタデータの Spreadsheet ロケーションを返します。ロケーション タイプが DeveloperMetadataLocationType.SPREADSHEET でない場合は null を返します。 |
DeveloperMetadataLocationType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
SPREADSHEET | Enum | 最上位のスプレッドシートに関連付けられているデベロッパー メタデータの場所のタイプ。 |
SHEET | Enum | シート全体に関連付けられたデベロッパー メタデータの場所のタイプ。 |
ROW | Enum | 行に関連付けられたデベロッパー メタデータのロケーション タイプ。 |
COLUMN | Enum | 列に関連付けられているデベロッパー メタデータのロケーション タイプ。 |
DeveloperMetadataVisibility
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DOCUMENT | Enum | ドキュメントに表示されるメタデータには、ドキュメントへのアクセス権を持つすべてのデベロッパー プロジェクトからアクセスできます。 |
PROJECT | Enum | プロジェクト公開メタデータは、そのメタデータを作成したデベロッパー プロジェクトからのみ表示でき、アクセスできます。 |
Dimension
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
COLUMNS | Enum | 列(縦方向)のディメンション。 |
ROWS | Enum | 行(水平)ディメンション。 |
Direction
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
UP | Enum | 行番号を小さくする方向。 |
DOWN | Enum | 行番号が増加する方向。 |
PREVIOUS | Enum | 列番号が小さくなる方向。 |
NEXT | Enum | 列番号が増加する方向。 |
Drawing
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getContainerInfo() | ContainerInfo | シート内の描画の位置に関する情報を取得します。 |
getHeight() | Integer | この描画の実際の高さをピクセル単位で返します。 |
getOnAction() | String | この図面に適用されているマクロの名前を返します。 |
getSheet() | Sheet | この描画が表示されているシートを返します。 |
getWidth() | Integer | この図形描画の実際の幅をピクセル単位で返します。 |
getZIndex() | Number | この描画の z インデックスを返します。 |
remove() | void | この描画がスプレッドシートから削除されます。 |
setHeight(height) | Drawing | この描画の実際の高さをピクセル単位で設定します。 |
setOnAction(macroName) | Drawing | この図面にマクロ関数を割り当てます。 |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | Drawing | シート上に描画が表示される位置を設定します。 |
setWidth(width) | Drawing | この図形描画の実際の幅をピクセル単位で設定します。 |
setZIndex(zIndex) | Drawing | この描画の Z-Index を設定します。 |
EmbeddedAreaChartBuilder
メソッド
EmbeddedBarChartBuilder
メソッド
EmbeddedChart
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
asDataSourceChart() | DataSourceChart | グラフがデータソース グラフの場合はデータソース グラフ インスタンスにキャストし、それ以外の場合は null にキャストします。 |
getAs(contentType) | Blob | このオブジェクト内のデータを指定したコンテンツ タイプに変換された BLOB として返します。 |
getBlob() | Blob | このオブジェクト内のデータを blob として返します。 |
getChartId() | Integer | グラフを含むスプレッドシート内で一意のグラフの安定した識別子を返します。グラフがスプレッドシートにない場合は null を返します。 |
getContainerInfo() | ContainerInfo | グラフがシート内で配置されている場所に関する情報を返します。 |
getHiddenDimensionStrategy() | ChartHiddenDimensionStrategy | 非表示の行と列の処理に使用する戦略を返します。 |
getMergeStrategy() | ChartMergeStrategy | 複数の範囲が存在する場合に使用される結合戦略を返します。 |
getNumHeaders() | Integer | 範囲内でヘッダーとして扱われる行または列の数を返します。 |
getOptions() | ChartOptions | このグラフのオプション(高さ、色、軸など)を返します。 |
getRanges() | Range[] | このグラフがデータソースとして使用する範囲を返します。 |
getTransposeRowsAndColumns() | Boolean | true の場合、グラフへのデータ入力に使用される行と列が切り替わります。 |
modify() | EmbeddedChartBuilder | このグラフの変更に使用できる EmbeddedChartBuilder を返します。 |
EmbeddedChartBuilder
メソッド
EmbeddedColumnChartBuilder
メソッド
EmbeddedComboChartBuilder
メソッド
EmbeddedHistogramChartBuilder
メソッド
EmbeddedLineChartBuilder
メソッド
EmbeddedPieChartBuilder
メソッド
EmbeddedScatterChartBuilder
メソッド
EmbeddedTableChartBuilder
メソッド
Filter
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getColumnFilterCriteria(columnPosition) | FilterCriteria | 指定した列のフィルタ条件を取得します。列にフィルタ条件が適用されていない場合は null を取得します。 |
getRange() | Range | このフィルタが適用される範囲を取得します。 |
remove() | void | このフィルタを削除します。 |
removeColumnFilterCriteria(columnPosition) | Filter | 指定した列からフィルタ条件を削除します。 |
setColumnFilterCriteria(columnPosition, filterCriteria) | Filter | 指定した列にフィルタ条件を設定します。 |
sort(columnPosition, ascending) | Filter | フィルタされた範囲を、指定した列で並べ替えます。ただし、このフィルタが適用される範囲の最初の行(ヘッダー行)は除外します。 |
FilterCriteria
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | FilterCriteriaBuilder | このフィルタ条件をコピーし、別のフィルタに適用できる条件ビルダーを作成します。 |
getCriteriaType() | BooleanCriteria | 条件のブール値型(CELL_EMPTY など)を返します。 |
getCriteriaValues() | Object[] | ブール条件の引数の配列を返します。 |
getHiddenValues() | String[] | フィルタによって非表示にされた値を返します。 |
getVisibleBackgroundColor() | Color | フィルタ条件として使用される背景色を返します。 |
getVisibleForegroundColor() | Color | フィルタ条件として使用される前景色を返します。 |
getVisibleValues() | String[] | ピボット テーブル フィルタに表示される値を返します。 |
FilterCriteriaBuilder
メソッド
FrequencyType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
FREQUENCY_TYPE_UNSUPPORTED | Enum | フリークエンシーの種類がサポートされていません。 |
DAILY | Enum | これは毎日更新されます。 |
WEEKLY | Enum | 毎週特定の曜日に更新します。 |
MONTHLY | Enum | 毎月特定の日に更新します。 |
GradientCondition
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getMaxColorObject() | Color | このグラデーション条件の最大値に設定された色を取得します。 |
getMaxType() | InterpolationType | このグラデーション条件の最大値の補間タイプを取得します。 |
getMaxValue() | String | このグラデーション条件の最大値を取得します。 |
getMidColorObject() | Color | このグラデーション条件の中央値に設定された色を取得します。 |
getMidType() | InterpolationType | このグラデーション条件の中間値の補間タイプを取得します。 |
getMidValue() | String | この勾配条件の中間値を取得します。 |
getMinColorObject() | Color | このグラデーション条件の最小値に設定された色を取得します。 |
getMinType() | InterpolationType | この勾配条件の最小値の補間タイプを取得します。 |
getMinValue() | String | このグラデーション条件の最小値を取得します。 |
Group
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
collapse() | Group | このグループを閉じます。 |
expand() | Group | このグループを開きます。 |
getControlIndex() | Integer | このグループのコントロール切り替えインデックスを返します。 |
getDepth() | Integer | このグループの深さを返します。 |
getRange() | Range | このグループが存在する範囲を返します。 |
isCollapsed() | Boolean | このグループが折りたたまれている場合は true を返します。 |
remove() | void | シートからこのグループを削除し、range のグループ深度を 1 つ減らします。 |
GroupControlTogglePosition
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
BEFORE | Enum | コントロール トグルがグループより前(インデックスが小さい)にある位置。 |
AFTER | Enum | コントロールの切り替えがグループの後にある位置(インデックスの大きい方)。 |
InterpolationType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
NUMBER | Enum | この数値は、グラデーション条件の特定の補間ポイントとして使用します。 |
PERCENT | Enum | この数値は、グラデーション条件の割合補間ポイントとして使用します。 |
PERCENTILE | Enum | この数値は、グラデーション条件のパーセンタイル補間ポイントとして使用します。 |
MIN | Enum | 最小数を勾配条件の特定の補間点として推測します。 |
MAX | Enum | 最大数を勾配条件の特定の補間点として推測します。 |
LookerDataSourceSpec
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | DataSourceSpecBuilder | このデータソースの設定に基づいて DataSourceSpecBuilder を作成します。 |
getExploreName() | String | モデル内の Looker Explore の名前を取得します。 |
getInstanceUrl() | String | Looker インスタンスの URL を取得します。 |
getModelName() | String | インスタンス内の Looker モデルの名前を取得します。 |
getParameters() | DataSourceParameter[] | データソースのパラメータを取得します。 |
getType() | DataSourceType | データソースのタイプを取得します。 |
LookerDataSourceSpecBuilder
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
build() | DataSourceSpec | このビルダーの設定からデータソース仕様を作成します。 |
copy() | DataSourceSpecBuilder | このデータソースの設定に基づいて DataSourceSpecBuilder を作成します。 |
getExploreName() | String | モデル内の Looker Explore の名前を取得します。 |
getInstanceUrl() | String | Looker インスタンスの URL を取得します。 |
getModelName() | String | インスタンス内の Looker モデルの名前を取得します。 |
getParameters() | DataSourceParameter[] | データソースのパラメータを取得します。 |
getType() | DataSourceType | データソースのタイプを取得します。 |
removeAllParameters() | LookerDataSourceSpecBuilder | すべてのパラメータを削除します。 |
removeParameter(parameterName) | LookerDataSourceSpecBuilder | 指定されたパラメータを削除します。 |
setExploreName(exploreName) | LookerDataSourceSpecBuilder | Looker モデルに Explore 名を設定します。 |
setInstanceUrl(instanceUrl) | LookerDataSourceSpecBuilder | Looker のインスタンス URL を設定します。 |
setModelName(modelName) | LookerDataSourceSpecBuilder | Looker インスタンスで Looker モデル名を設定します。 |
setParameterFromCell(parameterName, sourceCell) | LookerDataSourceSpecBuilder | パラメータを追加します。名前が同じパラメータが存在する場合は、DataSourceType.BIGQUERY タイプのデータソース仕様ビルダーのソースセルを更新します。 |
NamedRange
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getName() | String | この名前付き範囲の名前を取得します。 |
getRange() | Range | この名前付き範囲が参照する範囲を取得します。 |
remove() | void | この名前付き範囲を削除します。 |
setName(name) | NamedRange | 名前付き範囲の名前を設定または更新します。 |
setRange(range) | NamedRange | この名前付き範囲の範囲を設定または更新します。 |
OverGridImage
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
assignScript(functionName) | OverGridImage | 指定された関数名の関数をこのイメージに割り当てます。 |
getAltTextDescription() | String | この画像の代替テキストの説明を返します。 |
getAltTextTitle() | String | この画像の代替テキストのタイトルを返します。 |
getAnchorCell() | Range | 画像が固定されているセルを返します。 |
getAnchorCellXOffset() | Integer | アンカーセルからの水平方向のピクセル オフセットを返します。 |
getAnchorCellYOffset() | Integer | アンカーセルからの垂直方向のピクセル オフセットを返します。 |
getHeight() | Integer | この画像の実際の高さをピクセル単位で返します。 |
getInherentHeight() | Integer | この画像の本質的な高さ(ピクセル単位)を返します。 |
getInherentWidth() | Integer | この画像固有の高さをピクセル単位で返します。 |
getScript() | String | このイメージに割り当てられた関数の名前を返します。 |
getSheet() | Sheet | この画像が表示されているシートを返します。 |
getUrl() | String | 画像のソース URL を取得します。URL が使用できない場合は null を返します。 |
getWidth() | Integer | この画像の実際の幅をピクセル単位で返します。 |
remove() | void | この画像をスプレッドシートから削除します。 |
replace(blob) | OverGridImage | この画像を、指定された BlobSource で指定された画像に置き換えます。 |
replace(url) | OverGridImage | この画像を、指定した URL の画像に置き換えます。 |
resetSize() | OverGridImage | この画像を固有のサイズにリセットします。 |
setAltTextDescription(description) | OverGridImage | この画像の代替テキストの説明を設定します。 |
setAltTextTitle(title) | OverGridImage | この画像の代替テキストのタイトルを設定します。 |
setAnchorCell(cell) | OverGridImage | 画像を固定するセルを設定します。 |
setAnchorCellXOffset(offset) | OverGridImage | アンカーセルからの水平方向のピクセル オフセットを設定します。 |
setAnchorCellYOffset(offset) | OverGridImage | アンカーセルからの垂直方向のピクセル オフセットを設定します。 |
setHeight(height) | OverGridImage | この画像の実際の高さをピクセル単位で設定します。 |
setWidth(width) | OverGridImage | この画像の実際の幅をピクセル単位で設定します。 |
PageProtection
PivotFilter
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getFilterCriteria() | FilterCriteria | このピボット フィルタのフィルタ条件を返します。 |
getPivotTable() | PivotTable | このフィルタが属する PivotTable を返します。 |
getSourceDataColumn() | Integer | このフィルタが適用されるソースデータ列の数を返します。 |
getSourceDataSourceColumn() | DataSourceColumn | フィルタが適用されるデータソース列を返します。 |
remove() | void | このピボット フィルタをピボット テーブルから削除します。 |
setFilterCriteria(filterCriteria) | PivotFilter | このピボット フィルタのフィルタ条件を設定します。 |
PivotGroup
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
addManualGroupingRule(groupName, groupMembers) | PivotGroup | このピボット グループの手動グループ化ルールを追加します。 |
areLabelsRepeated() | Boolean | ラベルが繰り返しとして表示されるかどうかを返します。 |
clearGroupingRule() | PivotGroup | このピボット グループからすべてのグループ化ルールを削除します。 |
clearSort() | PivotGroup | このグループに適用されている並べ替えをすべて削除します。 |
getDateTimeGroupingRule() | DateTimeGroupingRule | ピボット グループの日時のグループ化ルールを返します。日時のグループ化ルールが設定されていない場合は null を返します。 |
getDimension() | Dimension | これが行グループか列グループかを返します。 |
getGroupLimit() | PivotGroupLimit | ピボット グループのピボット グループの制限を返します。 |
getIndex() | Integer | 現在のグループ順序におけるこのピボット グループのインデックスを返します。 |
getPivotTable() | PivotTable | このグループが属する PivotTable を返します。 |
getSourceDataColumn() | Integer | このグループが要約するソースデータ列の番号を返します。 |
getSourceDataSourceColumn() | DataSourceColumn | ピボット グループが操作するデータソース列を返します。 |
hideRepeatedLabels() | PivotGroup | このグループ化の重複するラベルを非表示にします。 |
isSortAscending() | Boolean | 並べ替えが昇順の場合は true を返し、並べ替え順が降順の場合は false を返します。 |
moveToIndex(index) | PivotGroup | このグループを、行または列グループの現在のリスト内の指定した位置に移動します。 |
remove() | void | このピボット グループをテーブルから削除します。 |
removeManualGroupingRule(groupName) | PivotGroup | 指定された groupName の手動グループ化ルールを削除します。 |
resetDisplayName() | PivotGroup | ピボット テーブル内のこのグループの表示名をデフォルト値にリセットします。 |
setDateTimeGroupingRule(dateTimeGroupingRuleType) | PivotGroup | ピボット グループに日時のグループ化ルールを設定します。 |
setDisplayName(name) | PivotGroup | ピボット テーブル内のこのグループの表示名を設定します。 |
setGroupLimit(countLimit) | PivotGroup | ピボット グループにピボット グループの上限を設定します。 |
setHistogramGroupingRule(minValue, maxValue, intervalSize) | PivotGroup | このピボット グループのヒストグラムのグループ化ルールを設定します。 |
showRepeatedLabels() | PivotGroup | 行または列のグループ化が複数ある場合、この方法では、後続のグループ化のエントリごとにこのグループのラベルが表示されます。 |
showTotals(showTotals) | PivotGroup | 表内にこのピボット グループの合計値を表示するかどうかを設定します。 |
sortAscending() | PivotGroup | 並べ替え順を昇順に設定します。 |
sortBy(value, oppositeGroupValues) | PivotGroup | oppositeGroupValues の値に対して、指定された PivotValue でこのグループを並べ替えます。 |
sortDescending() | PivotGroup | 並べ替え順を降順に設定します。 |
totalsAreShown() | Boolean | このピボット グループに合計値が現在表示されているかどうかを返します。 |
PivotGroupLimit
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getCountLimit() | Integer | ピボット グループ内の行または列の数上限を取得します。 |
getPivotGroup() | PivotGroup | 制限が属するピボット グループを返します。 |
remove() | void | ピボット グループの上限を削除します。 |
setCountLimit(countLimit) | PivotGroupLimit | ピボット グループ内の行または列の数上限を設定します。 |
PivotTable
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
addCalculatedPivotValue(name, formula) | PivotValue | 指定された name を使用して、指定された formula から計算された新しいピボット値をピボット テーブルに作成します。 |
addColumnGroup(sourceDataColumn) | PivotGroup | ピボット テーブルに新しいピボット列のグループ化を定義します。 |
addFilter(sourceDataColumn, filterCriteria) | PivotFilter | ピボット テーブルの新しいピボット フィルタを作成します。 |
addPivotValue(sourceDataColumn, summarizeFunction) | PivotValue | 指定された summarizeFunction を使用して、ピボット テーブル内に新しいピボット値を定義します。 |
addRowGroup(sourceDataColumn) | PivotGroup | ピボット テーブルに新しいピボット行のグループ化を定義します。 |
asDataSourcePivotTable() | DataSourcePivotTable | ピボット テーブルが DataSource にリンクされている場合はデータソース ピボット テーブルとして、そうでない場合は null としてピボット テーブルを返します。 |
getAnchorCell() | Range | このピボット テーブルが固定されているセルを表す Range を返します。 |
getColumnGroups() | PivotGroup[] | このピボット テーブルの列グループの順序付きリストを返します。 |
getFilters() | PivotFilter[] | このピボット テーブルのフィルタの順序付きリストを返します。 |
getPivotValues() | PivotValue[] | このピボット テーブルのピボット値の順序付きリストを返します。 |
getRowGroups() | PivotGroup[] | このピボット テーブルの行グループの順序付きリストを返します。 |
getSourceDataRange() | Range | ピボット テーブルが構築されたソースデータの範囲を返します。 |
getValuesDisplayOrientation() | Dimension | 値を行として表示するか、列として表示するかを返します。 |
remove() | void | このピボット テーブルを削除します。 |
setValuesDisplayOrientation(dimension) | PivotTable | 値を列または行として表示するように、このピボット テーブルのレイアウトを設定します。 |
PivotTableSummarizeFunction
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
CUSTOM | Enum | カスタム関数。この値は計算フィールドでのみ有効です。 |
SUM | Enum | SUM 関数 |
COUNTA | Enum | COUNTA 関数 |
COUNT | Enum | COUNT 関数 |
COUNTUNIQUE | Enum | COUNTUNIQUE 関数 |
AVERAGE | Enum | AVERAGE 関数 |
MAX | Enum | MAX 関数 |
MIN | Enum | MIN 関数 |
MEDIAN | Enum | MEDIAN 関数 |
PRODUCT | Enum | PRODUCT 関数 |
STDEV | Enum | STDEV 関数 |
STDEVP | Enum | STDEVP 関数 |
VAR | Enum | VAR 関数 |
VARP | Enum | VARP 関数 |
PivotValue
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getDisplayType() | PivotValueDisplayType | このピボット値が現在表にどのように表示されているかを表す表示タイプを返します。 |
getFormula() | String | この値の計算に使用された式を返します。 |
getPivotTable() | PivotTable | この値が属する PivotTable を返します。 |
getSourceDataColumn() | Integer | ピボット値が集計するソースデータ列の数を返します。 |
getSourceDataSourceColumn() | DataSourceColumn | ピボット値によって集計されたデータソース列を返します。 |
getSummarizedBy() | PivotTableSummarizeFunction | このグループの要約関数を返します。 |
remove() | void | ピボット テーブルからこの値を削除してください。 |
setDisplayName(name) | PivotValue | ピボット テーブルでこの値の表示名を設定します。 |
setFormula(formula) | PivotValue | この値の計算に使用する数式を設定します。 |
showAs(displayType) | PivotValue | この値を別の値の関数としてピボット テーブルで表示します。 |
summarizeBy(summarizeFunction) | PivotValue | 要約関数を設定します。 |
PivotValueDisplayType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
DEFAULT | Enum | デフォルトです。 |
PERCENT_OF_ROW_TOTAL | Enum | ピボット値をその行の合計の割合として表示します。 |
PERCENT_OF_COLUMN_TOTAL | Enum | ピボット値をその列の合計の割合として表示します。 |
PERCENT_OF_GRAND_TOTAL | Enum | ピボット値を総合計の割合として表示します。 |
Protection
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
addEditor(emailAddress) | Protection | 指定したユーザーを、保護されたシートまたは範囲の編集者のリストに追加します。 |
addEditor(user) | Protection | 指定したユーザーを、保護されたシートまたは範囲の編集者のリストに追加します。 |
addEditors(emailAddresses) | Protection | 指定されたユーザーの配列を、保護されたシートまたは範囲の編集者のリストに追加します。 |
addTargetAudience(audienceId) | Protection | 指定された対象グループを保護された範囲の編集者として追加します。 |
canDomainEdit() | Boolean | スプレッドシートを所有するドメイン内のすべてのユーザーに、保護された範囲またはシートを編集する権限があるかどうかを決定します。 |
canEdit() | Boolean | ユーザーが保護された範囲またはシートを編集する権限を持っているかどうかを判断します。 |
getDescription() | String | 保護されている範囲またはシートの説明を取得します。 |
getEditors() | User[] | 保護されている範囲またはシートの編集者のリストを取得します。 |
getProtectionType() | ProtectionType | 保護区域のタイプ(RANGE または SHEET )を取得します。 |
getRange() | Range | 保護されている範囲を取得します。 |
getRangeName() | String | 保護された範囲が名前付き範囲に関連付けられている場合は、その名前を取得します。 |
getTargetAudiences() | TargetAudience[] | 保護された範囲を編集できるターゲット オーディエンスの ID を返します。 |
getUnprotectedRanges() | Range[] | 保護されているシート内の保護されていない範囲の配列を取得します。 |
isWarningOnly() | Boolean | 保護領域で「警告ベース」の保護が使用されているかどうかを判断します。 |
remove() | void | 範囲またはシートの保護を解除します。 |
removeEditor(emailAddress) | Protection | 保護されているシートまたは範囲の編集者のリストから、指定したユーザーを削除します。 |
removeEditor(user) | Protection | 保護されたシートまたは範囲の編集者のリストから指定したユーザーを削除します。 |
removeEditors(emailAddresses) | Protection | 保護されているシートまたは範囲の編集者のリストから、指定したユーザーの配列を削除します。 |
removeTargetAudience(audienceId) | Protection | 保護されている範囲の編集者として指定した対象グループを削除します。 |
setDescription(description) | Protection | 保護された範囲またはシートの説明を設定します。 |
setDomainEdit(editable) | Protection | スプレッドシートを所有するドメイン内のすべてのユーザーに、保護された範囲またはシートを編集する権限があるかどうかを設定します。 |
setNamedRange(namedRange) | Protection | 保護された範囲を既存の名前付き範囲に関連付けます。 |
setRange(range) | Protection | 保護されている範囲を調整します。 |
setRangeName(rangeName) | Protection | 保護された範囲を既存の名前付き範囲に関連付けます。 |
setUnprotectedRanges(ranges) | Protection | 保護されたシート内の指定された範囲の配列の保護を解除します。 |
setWarningOnly(warningOnly) | Protection | この保護範囲で「警告ベース」の保護を使用するかどうかを設定します。 |
ProtectionType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
RANGE | Enum | 範囲の保護。 |
SHEET | Enum | シートの保護。 |
Range
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
activate() | Range | 指定された範囲を active range として設定し、範囲の左上のセルを current cell として設定します。 |
activateAsCurrentCell() | Range | 指定されたセルを current cell として設定します。 |
addDeveloperMetadata(key) | Range | 指定されたキーを持つデベロッパー メタデータを範囲に追加します。 |
addDeveloperMetadata(key, visibility) | Range | 指定したキーと公開設定を持つデベロッパー メタデータを範囲に追加します。 |
addDeveloperMetadata(key, value) | Range | 指定したキーと値を持つデベロッパー メタデータを範囲に追加します。 |
addDeveloperMetadata(key, value, visibility) | Range | 指定したキー、値、公開設定を持つデベロッパー メタデータを範囲に追加します。 |
applyColumnBanding() | Banding | 範囲にデフォルトの列のバンドリング テーマを適用します。 |
applyColumnBanding(bandingTheme) | Banding | 指定した列バンディング テーマを範囲に適用します。 |
applyColumnBanding(bandingTheme, showHeader, showFooter) | Banding | 指定された列のバンドリング テーマを、指定されたヘッダーとフッターの設定で範囲に適用します。 |
applyRowBanding() | Banding | デフォルトの行バンディング テーマを範囲に適用します。 |
applyRowBanding(bandingTheme) | Banding | 指定した行バンディング テーマを範囲に適用します。 |
applyRowBanding(bandingTheme, showHeader, showFooter) | Banding | 指定したヘッダーとフッターの設定がある範囲に、指定した行帯テーマを適用します。 |
autoFill(destination, series) | void | この範囲内のデータに基づいて、destinationRange にデータを入力します。 |
autoFillToNeighbor(series) | void | 隣接するセルに基づいて新しいデータで入力する範囲を計算し、この範囲に含まれるデータに基づいてその範囲に新しい値を自動的に入力します。 |
breakApart() | Range | 範囲内の複数列セルを個々のセルに分割し直します。 |
canEdit() | Boolean | ユーザーが範囲内のすべてのセルを編集する権限を持っているかどうかを判断します。 |
check() | Range | 範囲内のチェックボックスの状態を「オン」に変更します。 |
clear() | Range | コンテンツと形式の範囲をクリアします。 |
clear(options) | Range | 指定された詳細オプションで指定されている内容、形式、データ検証ルール、コメントの範囲を消去します。 |
clearContent() | Range | 書式はそのままにして、範囲の内容をクリアします。 |
clearDataValidations() | Range | 範囲のデータ入力規則をクリアします。 |
clearFormat() | Range | この範囲の書式をクリアします。 |
clearNote() | Range | 指定したセルのノートを消去します。 |
collapseGroups() | Range | 範囲内に完全に含まれるすべてのグループを折りたたみます。 |
copyFormatToRange(gridId, column, columnEnd, row, rowEnd) | void | 範囲の書式を指定された場所にコピーします。 |
copyFormatToRange(sheet, column, columnEnd, row, rowEnd) | void | 範囲の書式を指定の場所にコピーします。 |
copyTo(destination) | void | セル範囲のデータを別のセル範囲にコピーします。 |
copyTo(destination, copyPasteType, transposed) | void | セル範囲のデータを別のセル範囲にコピーします。 |
copyTo(destination, options) | void | セル範囲のデータを別のセル範囲にコピーします。 |
copyValuesToRange(gridId, column, columnEnd, row, rowEnd) | void | 範囲の内容を指定された場所にコピーします。 |
copyValuesToRange(sheet, column, columnEnd, row, rowEnd) | void | 範囲の内容を指定された場所にコピーします。 |
createDataSourcePivotTable(dataSource) | DataSourcePivotTable | データソースから空のデータソースのピボット テーブルを作成し、この範囲の最初のセルに固定します。 |
createDataSourceTable(dataSource) | DataSourceTable | この範囲の最初のセルをアンカーとして、データソースから空のデータソース テーブルを作成します。 |
createDeveloperMetadataFinder() | DeveloperMetadataFinder | この範囲内のデベロッパー メタデータを検索するための DeveloperMetadataFinderApi を返します。 |
createFilter() | Filter | フィルタを作成し、シート上の指定した範囲に適用します。 |
createPivotTable(sourceData) | PivotTable | この範囲の最初のセルに固定された指定された sourceData から空のピボット テーブルを作成します。 |
createTextFinder(findText) | TextFinder | 範囲のテキスト検索ツールを作成します。このツールを使用すると、範囲内のテキストを検索して置換できます。 |
deleteCells(shiftDimension) | void | このセル範囲を削除します。 |
expandGroups() | Range | この範囲と範囲またはコントロール トグルが交差する、閉じられたグループを開きます。 |
getA1Notation() | String | A1 表記で範囲の文字列の説明を返します。 |
getBackground() | String | 範囲内の左上のセルの背景色を返します(例: '#ffffff' )。 |
getBackgroundObject() | Color | 範囲内の左上のセルの背景色を返します。 |
getBackgroundObjects() | Color[][] | 範囲内のセルの背景色を返します。 |
getBackgrounds() | String[][] | 範囲内のセルの背景色を返します(例: '#ffffff' )。 |
getBandings() | Banding[] | この範囲の任意のセルに適用されるすべてのバンディングを返します。 |
getCell(row, column) | Range | 範囲内の指定したセルを返します。 |
getColumn() | Integer | この範囲の開始列位置を返します。 |
getDataRegion() | Range | 4 つの基本方向の Direction で拡張された範囲のコピーを返します。これにより、データを含む隣接するすべてのセルが対象になります。 |
getDataRegion(dimension) | Range | 指定されたディメンションが Dimension.ROWS の場合は範囲拡張された Direction.UP と Direction.DOWN のコピーを返します。ディメンションが Dimension.COLUMNS の場合は Direction.NEXT と Direction.PREVIOUS を返します。 |
getDataSourceFormula() | DataSourceFormula | 範囲内の最初のセルの DataSourceFormula を返します。セルにデータソースの式が含まれていない場合は null を返します。 |
getDataSourceFormulas() | DataSourceFormula[] | 範囲内のセルの DataSourceFormula を返します。 |
getDataSourcePivotTables() | DataSourcePivotTable[] | 範囲と交差するすべてのデータソースのピボット テーブルを取得します。 |
getDataSourceTables() | DataSourceTable[] | 範囲と交差するすべてのデータソース テーブルを取得します。 |
getDataSourceUrl() | String | この範囲内のデータの URL を返します。この URL は、グラフやクエリの作成に使用できます。 |
getDataTable() | DataTable | このオブジェクト内のデータは DataTable として返されます。 |
getDataTable(firstRowIsHeader) | DataTable | この範囲内のデータを DataTable として返します。 |
getDataValidation() | DataValidation | 範囲内の左上のセルのデータ入力規則を返します。 |
getDataValidations() | DataValidation[][] | 範囲内のすべてのセルのデータ入力規則を返します。 |
getDeveloperMetadata() | DeveloperMetadata[] | この範囲に関連付けられているデベロッパーのメタデータを取得します。 |
getDisplayValue() | String | 範囲内の左上のセルの表示値を返します。 |
getDisplayValues() | String[][] | この範囲の値の長方形グリッドを返します。 |
getFilter() | Filter | この範囲が属するシートのフィルタを返します。シートにフィルタがない場合、null を返します。 |
getFontColorObject() | Color | 範囲の左上にあるセルのフォント色を返します。 |
getFontColorObjects() | Color[][] | 範囲内のセルのフォントの色を返します。 |
getFontFamilies() | String[][] | 範囲内のセルのフォント ファミリーを返します。 |
getFontFamily() | String | 範囲の左上にあるセルのフォント ファミリーを返します。 |
getFontLine() | String | 範囲の左上隅にあるセルの線のスタイルを取得します('underline' 、'line-through' 、'none' )。 |
getFontLines() | String[][] | 範囲内のセルの線のスタイルを取得します('underline' 、'line-through' 、'none' )。 |
getFontSize() | Integer | 範囲の左上にあるセルのフォントサイズをポイント単位で返します。 |
getFontSizes() | Integer[][] | 範囲内のセルのフォントサイズを返します。 |
getFontStyle() | String | 範囲の左上にあるセルのフォント スタイル('italic' または 'normal' )を返します。 |
getFontStyles() | String[][] | 範囲内のセルのフォント スタイルを返します。 |
getFontWeight() | String | 範囲の左上隅にあるセルのフォントの太さ(標準/太字)を返します。 |
getFontWeights() | String[][] | 範囲内のセルのフォント重みを返します。 |
getFormula() | String | 範囲の左上のセルの式(A1 表記)を返します。セルが空であるか式が含まれていない場合は、空の文字列を返します。 |
getFormulaR1C1() | String | 指定されたセルの数式(R1C1 表記)を返します。数式がない場合、null を返します。 |
getFormulas() | String[][] | 範囲内のセルの数式(A1 表記)を返します。 |
getFormulasR1C1() | String[][] | 範囲内のセルの数式(R1C1 表記)を返します。 |
getGridId() | Integer | 範囲の親シートのグリッド ID を返します。 |
getHeight() | Integer | 範囲の高さを返します。 |
getHorizontalAlignment() | String | 範囲の左上にあるセルのテキストの水平方向の配置(左/中央/右)を返します。 |
getHorizontalAlignments() | String[][] | 範囲内のセルの水平方向の配置を返します。 |
getLastColumn() | Integer | 終了列の位置を返します。 |
getLastRow() | Integer | 終了行の位置を返します。 |
getMergedRanges() | Range[] | 現在の範囲内に完全に収まっているか、現在の範囲内に 1 つ以上のセルを含む結合されたセルを表す Range オブジェクトの配列を返します。 |
getNextDataCell(direction) | Range | 範囲の最初の列と行のセルから、指定された方向の次のセルを返します。このセルは、データを含む連続したセルの範囲の端にあるセルか、その方向のスプレッドシートの端にあるセルです。 |
getNote() | String | 指定された範囲に関連付けられているメモを返します。 |
getNotes() | String[][] | 範囲内のセルに関連付けられたメモを返します。 |
getNumColumns() | Integer | この範囲内の列数を返します。 |
getNumRows() | Integer | この範囲内の行数を返します。 |
getNumberFormat() | String | 指定した範囲の左上のセルの数値または日付の書式を取得します。 |
getNumberFormats() | String[][] | 範囲内のセルの数値または日付の形式を返します。 |
getRichTextValue() | RichTextValue | 範囲の左上のセルのリッチテキスト値を返します。セル値がテキストでない場合、null を返します。 |
getRichTextValues() | RichTextValue[][] | 範囲内のセルの HTML 形式のテキスト値を返します。 |
getRow() | Integer | この範囲の行番号を返します。 |
getRowIndex() | Integer | この範囲の行番号を返します。 |
getSheet() | Sheet | この範囲が属するシートを返します。 |
getTextDirection() | TextDirection | 範囲の左上セルの文章方向を返します。 |
getTextDirections() | TextDirection[][] | 範囲内のセルのテキストの向きを返します。 |
getTextRotation() | TextRotation | 範囲の左上セルのテキストの回転設定を返します。 |
getTextRotations() | TextRotation[][] | 範囲内のセルのテキストの回転設定を返します。 |
getTextStyle() | TextStyle | 範囲の左上にあるセルのテキスト スタイルを返します。 |
getTextStyles() | TextStyle[][] | 範囲内のセルのテキスト スタイルを返します。 |
getValue() | Object | 範囲内の左上のセルの値を返します。 |
getValues() | Object[][] | この範囲の値の長方形グリッドを返します。 |
getVerticalAlignment() | String | 範囲の左上にあるセルの垂直方向の配置(上/中央/下)を返します。 |
getVerticalAlignments() | String[][] | 範囲内のセルの垂直方向の配置を返します。 |
getWidth() | Integer | 範囲の幅を列単位で返します。 |
getWrap() | Boolean | セル内のテキストが折り返されるかどうかを返します。 |
getWrapStrategies() | WrapStrategy[][] | 範囲内のセルのテキストの折り返し方法を返します。 |
getWrapStrategy() | WrapStrategy | 範囲の左上セルのテキストの折り返し方法を返します。 |
getWraps() | Boolean[][] | セル内のテキストが折り返されるかどうかを返します。 |
insertCells(shiftDimension) | Range | この範囲に空白セルを挿入します。 |
insertCheckboxes() | Range | 範囲内の各セルにチェックボックスを挿入します。チェックボックスがオンの場合は true 、オフの場合は false で構成されます。 |
insertCheckboxes(checkedValue) | Range | 範囲内の各セルにチェックボックスを挿入します。チェックボックスがオンの場合はカスタム値、オフの場合は空の文字列に設定されます。 |
insertCheckboxes(checkedValue, uncheckedValue) | Range | 範囲内の各セルにチェックボックスを挿入します。チェックボックスは、オンとオフの状態のカスタム値で構成されます。 |
isBlank() | Boolean | 範囲が完全に空白の場合、true を返します。 |
isChecked() | Boolean | 範囲内のすべてのセルのチェックボックスの状態が「オン」かどうかを返します。 |
isEndColumnBounded() | Boolean | 範囲の終了が特定の列にバインドされているかどうかを判断します。 |
isEndRowBounded() | Boolean | 範囲の終了が特定の行にバインドされているかどうかを決定します。 |
isPartOfMerge() | Boolean | 現在の範囲内のセルが結合セルと重複している場合は、true を返します。 |
isStartColumnBounded() | Boolean | 範囲の先頭を特定の列にバインドするかどうかを決定します。 |
isStartRowBounded() | Boolean | 範囲の先頭を特定の行にバインドするかどうかを決定します。 |
merge() | Range | 範囲内のセルを 1 つのブロックに結合します。 |
mergeAcross() | Range | 範囲の複数の列を結合して範囲内のセルを結合します。 |
mergeVertically() | Range | 範囲内のセルを結合します。 |
moveTo(target) | void | この範囲から対象範囲に(形式と値の両方を)カットして貼り付けます。 |
offset(rowOffset, columnOffset) | Range | この範囲から指定された行数と列数(負数でも可)だけオフセットされた新しい範囲を返します。 |
offset(rowOffset, columnOffset, numRows) | Range | 現在の範囲を基準とする新しい範囲を返します。この範囲の左上は、指定された行と列で現在の範囲からオフセットされ、セルの高さも指定されます。 |
offset(rowOffset, columnOffset, numRows, numColumns) | Range | 現在の範囲を基準とする新しい範囲を返します。この範囲の左上の点は、現在の範囲から指定された行と列の数、セルで指定された高さと幅でオフセットされます。 |
protect() | Protection | 権限を持つユーザー以外が範囲を編集できないように保護できるオブジェクトを作成します。 |
randomize() | Range | 指定した範囲内の行の順序をランダムにします。 |
removeCheckboxes() | Range | 範囲内のすべてのチェックボックスを削除します。 |
removeDuplicates() | Range | この範囲内の、前の行の値と重複する値を含む行を削除します。 |
removeDuplicates(columnsToCompare) | Range | この範囲内で、指定された列の値が前の行の値と重複する行を削除します。 |
setBackground(color) | Range | 範囲内のすべてのセルの背景色を CSS 表記('#ffffff' や 'white' など)で設定します。 |
setBackgroundObject(color) | Range | 範囲内のすべてのセルの背景色を設定します。 |
setBackgroundObjects(color) | Range | 背景色の長方形のグリッドを設定します(この範囲のサイズと一致している必要があります)。 |
setBackgroundRGB(red, green, blue) | Range | RGB 値(0 ~ 255 の整数)を使用して、背景を指定された色に設定します。 |
setBackgrounds(color) | Range | 背景色の長方形のグリッドを設定します(この範囲のサイズと一致している必要があります)。 |
setBorder(top, left, bottom, right, vertical, horizontal) | Range | 境界プロパティを設定します。 |
setBorder(top, left, bottom, right, vertical, horizontal, color, style) | Range | 色やスタイルを指定して、枠線プロパティを設定します。 |
setDataValidation(rule) | Range | 範囲内のすべてのセルに対して 1 つのデータ入力規則を設定します。 |
setDataValidations(rules) | Range | 範囲内のすべてのセルにデータ入力規則を設定します。 |
setFontColor(color) | Range | CSS 記法('#ffffff' や 'white' など)でフォントの色を設定します。 |
setFontColorObject(color) | Range | 指定された範囲のフォントの色を設定します。 |
setFontColorObjects(colors) | Range | フォント色の長方形のグリッドを設定します(この範囲のサイズと一致する必要があります)。 |
setFontColors(colors) | Range | フォント色の長方形のグリッドを設定します(この範囲のサイズと一致する必要があります)。 |
setFontFamilies(fontFamilies) | Range | フォント ファミリーの長方形のグリッドを設定します(この範囲のサイズと一致する必要があります)。 |
setFontFamily(fontFamily) | Range | フォント ファミリー(「Arial」や「Helvetica」など)を設定します。 |
setFontLine(fontLine) | Range | 指定された範囲('underline' 、'line-through' 、'none' )のフォント線のスタイルを設定します。 |
setFontLines(fontLines) | Range | 線スタイルの長方形のグリッドを設定します(この範囲のディメンションと一致している必要があります)。 |
setFontSize(size) | Range | フォントサイズを設定します。サイズは、使用するポイントサイズです。 |
setFontSizes(sizes) | Range | フォントサイズの長方形のグリッドを設定します(この範囲のサイズと一致する必要があります)。 |
setFontStyle(fontStyle) | Range | 指定した範囲のフォント スタイルを設定します('italic' または 'normal' )。 |
setFontStyles(fontStyles) | Range | フォント スタイルの長方形のグリッドを設定します(この範囲のサイズと一致している必要があります)。 |
setFontWeight(fontWeight) | Range | 指定した範囲のフォントウェイトを設定します(通常/太字)。 |
setFontWeights(fontWeights) | Range | フォントの太さの長方形のグリッドを設定します(この範囲のサイズと一致する必要があります)。 |
setFormula(formula) | Range | この範囲の数式を更新します。 |
setFormulaR1C1(formula) | Range | この範囲の数式を更新します。 |
setFormulas(formulas) | Range | 数式の長方形のグリッドを設定します(この範囲のサイズと一致している必要があります)。 |
setFormulasR1C1(formulas) | Range | 長方形の数式グリッドを設定します(この範囲の寸法と一致する必要があります)。 |
setHorizontalAlignment(alignment) | Range | 指定した範囲の水平方向(左から右)の配置を設定します(左揃え/中央揃え/右揃え)。 |
setHorizontalAlignments(alignments) | Range | 水平方向に配置された長方形のグリッドを設定します。 |
setNote(note) | Range | メモを指定された値に設定します。 |
setNotes(notes) | Range | メモの長方形のグリッドを設定します(この範囲のサイズと一致している必要があります)。 |
setNumberFormat(numberFormat) | Range | 数値または日付の形式を指定された書式文字列に設定します。 |
setNumberFormats(numberFormats) | Range | 数値または日付形式の長方形のグリッドを設定します(この範囲のディメンションと一致する必要があります)。 |
setRichTextValue(value) | Range | 範囲内のセルにリッチテキスト値を設定します。 |
setRichTextValues(values) | Range | リッチテキスト値の長方形のグリッドを設定します。 |
setShowHyperlink(showHyperlink) | Range | 範囲にハイパーリンクを表示するかどうかを設定します。 |
setTextDirection(direction) | Range | 範囲内のセルのテキスト方向を設定します。 |
setTextDirections(directions) | Range | 文章方向の長方形のグリッドを設定します。 |
setTextRotation(degrees) | Range | 範囲内のセルのテキストの回転設定を設定します。 |
setTextRotation(rotation) | Range | 範囲内のセルのテキスト回転設定を設定します。 |
setTextRotations(rotations) | Range | テキストの回転の長方形グリッドを設定します。 |
setTextStyle(style) | Range | 範囲内のセルのテキスト スタイルを設定します。 |
setTextStyles(styles) | Range | テキスト スタイルの長方形のグリッドを設定します。 |
setValue(value) | Range | 範囲の値を設定します。 |
setValues(values) | Range | 値の長方形のグリッドを設定します(この範囲のディメンションと一致している必要があります)。 |
setVerticalAlignment(alignment) | Range | 指定した範囲の垂直(上から下)の配置を設定します(上部/中央/下部)。 |
setVerticalAlignments(alignments) | Range | 垂直方向の配置の長方形のグリッドを設定します(この範囲の寸法と一致する必要があります)。 |
setVerticalText(isVertical) | Range | 範囲内のセルのテキストを積み重ねるかどうかを設定します。 |
setWrap(isWrapEnabled) | Range | 指定した範囲のセル折り返しを設定します。 |
setWrapStrategies(strategies) | Range | 折り返し戦略の長方形のグリッドを設定します。 |
setWrapStrategy(strategy) | Range | 範囲内のセルのテキストの折り返し方法を設定します。 |
setWraps(isWrapEnabled) | Range | 折り返しポリシーの長方形のグリッドを設定します(この範囲のサイズと一致している必要があります)。 |
shiftColumnGroupDepth(delta) | Range | 範囲の列グループの階層を指定された量だけ変更します。 |
shiftRowGroupDepth(delta) | Range | 範囲の行グループ化の深さを指定の金額で変更します。 |
sort(sortSpecObj) | Range | 指定した範囲のセルを、指定された列と順序で並べ替えます。 |
splitTextToColumns() | void | 自動検出された区切り文字に基づいて、テキストの列を複数の列に分割します。 |
splitTextToColumns(delimiter) | void | 指定した文字列をカスタム区切り文字として使用して、テキストの列を複数の列に分割します。 |
splitTextToColumns(delimiter) | void | 指定された区切り文字に基づいて、テキストの列を複数の列に分割します。 |
trimWhitespace() | Range | この範囲のすべてのセルの空白(スペース、タブ、改行など)を削除します。 |
uncheck() | Range | 範囲内のチェックボックスの状態を [オフ] に変更します。 |
RangeList
メソッド
RecalculationInterval
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
ON_CHANGE | Enum | 値が変更された場合にのみ再計算する。 |
MINUTE | Enum | 値が変更されたときと 1 分ごとに再計算します。 |
HOUR | Enum | 値が変更されたときと 1 時間ごとに再計算します。 |
RelativeDate
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
TODAY | Enum | 現在の日付と比較される日付。 |
TOMORROW | Enum | 現在の日付より後の日付と比較される日付。 |
YESTERDAY | Enum | 現在の日付より前の日付と比較される日付。 |
PAST_WEEK | Enum | 過去 1 週間以内の日付。 |
PAST_MONTH | Enum | 過去 1 か月以内の日付。 |
PAST_YEAR | Enum | 過去 1 年以内の日付。 |
RichTextValue
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | RichTextValueBuilder | このリッチテキスト値の値で初期化されたリッチテキスト値のビルダーを返します。 |
getEndIndex() | Integer | セル内のこの値の末尾インデックスを取得します。 |
getLinkUrl() | String | この値のリンク URL を返します。 |
getLinkUrl(startOffset, endOffset) | String | テキストのリンク URL を startOffset から endOffset に変更します。 |
getRuns() | RichTextValue[] | リッチテキスト文字列を、実行の配列に分割して返します。各実行は、一貫したテキスト スタイルを持つ可能な限り長いサブ文字列です。 |
getStartIndex() | Integer | セル内のこの値の開始インデックスを取得します。 |
getText() | String | この値のテキストを返します。 |
getTextStyle() | TextStyle | この値のテキスト スタイルを返します。 |
getTextStyle(startOffset, endOffset) | TextStyle | テキストのテキスト スタイルを startOffset から endOffset に返します。 |
RichTextValueBuilder
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
build() | RichTextValue | このビルダーからリッチテキスト値を作成します。 |
setLinkUrl(startOffset, endOffset, linkUrl) | RichTextValueBuilder | この値の指定された部分文字列のリンク URL を設定するか、linkUrl が null の場合はクリアします。 |
setLinkUrl(linkUrl) | RichTextValueBuilder | 値全体のリンク URL を設定するか、linkUrl が null の場合はクリアします。 |
setText(text) | RichTextValueBuilder | この値のテキストを設定し、既存のテキスト スタイルをすべて消去します。 |
setTextStyle(startOffset, endOffset, textStyle) | RichTextValueBuilder | この値の指定した部分文字列にテキスト スタイルを適用します。 |
setTextStyle(textStyle) | RichTextValueBuilder | 値全体にテキスト スタイルを適用します。 |
Selection
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getActiveRange() | Range | アクティブなシートで選択されている範囲を返します。アクティブな範囲がない場合、null を返します。 |
getActiveRangeList() | RangeList | アクティブなシート内のアクティブな範囲のリストを返します。アクティブな範囲がない場合、null を返します。 |
getActiveSheet() | Sheet | スプレッドシート内のアクティブなシートを返します。 |
getCurrentCell() | Range | アクティブな範囲のいずれかで選択されている現在の(ハイライト表示された)セルを返します。現在のセルがない場合、null を返します。 |
getNextDataRange(direction) | Range | current cell と active range から指定された方向に移動し、現在のセルをカバーしながら next data cell をカバーするように範囲の適切な端がシフトされた調整済み範囲を返します。 |
Sheet
メソッド
SheetType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
GRID | Enum | グリッドを含むシート。 |
OBJECT | Enum | 単一の埋め込みオブジェクト(EmbeddedChart など)を含むシート。 |
DATASOURCE | Enum | DataSource を含むシート。 |
Slicer
メソッド
SortOrder
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
ASCENDING | Enum | 昇順の並べ替え。 |
DESCENDING | Enum | 降順で並べ替えます。 |
SortSpec
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getBackgroundColor() | Color | 並べ替えに使用される背景色を返します。存在しない場合は null を返します。 |
getDataSourceColumn() | DataSourceColumn | 並べ替え仕様が適用されるデータソースの列を取得します。 |
getDimensionIndex() | Integer | ディメンションのインデックスを返します。ローカル フィルタにリンクされていない場合は null を返します。 |
getForegroundColor() | Color | 並べ替えに使用される前景色を返します。存在しない場合は null を返します。 |
getSortOrder() | SortOrder | 並べ替え順を返します。 |
isAscending() | Boolean | 並べ替え順序が昇順かどうかを返します。 |
Spreadsheet
メソッド
SpreadsheetApp
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
AutoFillSeries | AutoFillSeries | 自動入力された値の計算に使用される系列の型を列挙します。 |
BandingTheme | BandingTheme | 考えられるバンディング テーマの列挙。 |
BooleanCriteria | BooleanCriteria | 条件付き書式のブール値の条件の列挙型。 |
BorderStyle | BorderStyle | Range に枠線を設定するために有効なスタイルの列挙型。 |
ColorType | ColorType | 使用可能なカラータイプを列挙します。 |
CopyPasteType | CopyPasteType | 可能な貼り付けタイプの列挙型。 |
DataExecutionErrorCode | DataExecutionErrorCode | データ実行で発生する可能性のあるエラーコードの列挙型。 |
DataExecutionState | DataExecutionState | データ実行の可能な状態の列挙型。 |
DataSourceParameterType | DataSourceParameterType | 使用可能なデータソース パラメータの型の列挙型。 |
DataSourceRefreshScope | DataSourceRefreshScope | 使用可能なデータソースの更新スコープの列挙型。 |
DataSourceType | DataSourceType | 使用可能なデータソースのタイプを列挙します。 |
DataValidationCriteria | DataValidationCriteria | 範囲に設定できるデータ検証条件を表す列挙型。 |
DateTimeGroupingRuleType | DateTimeGroupingRuleType | 日時のグループ化ルールの列挙型。 |
DeveloperMetadataLocationType | DeveloperMetadataLocationType | デベロッパー メタデータの場所の種類の列挙型。 |
DeveloperMetadataVisibility | DeveloperMetadataVisibility | デベロッパー メタデータの公開設定の列挙型。 |
Dimension | Dimension | スプレッドシートで使用できるディメンションを列挙します。 |
Direction | Direction | 矢印キーを使用してスプレッドシート内で移動できる方向の列挙型。 |
FrequencyType | FrequencyType | 使用可能な頻度の種類を列挙します。 |
GroupControlTogglePosition | GroupControlTogglePosition | グループ コントロールの切り替えボタンが設定できる位置の列挙型。 |
InterpolationType | InterpolationType | 条件付き形式勾配補間タイプの列挙型。 |
PivotTableSummarizeFunction | PivotTableSummarizeFunction | ピボット テーブルの値の集計に使用できる関数の列挙型。 |
PivotValueDisplayType | PivotValueDisplayType | ピボット値の表示方法の列挙。 |
ProtectionType | ProtectionType | 編集から保護できるスプレッドシートの各部分を表す列挙型。 |
RecalculationInterval | RecalculationInterval | スプレッドシートの再計算で使用できる間隔の列挙型。 |
RelativeDate | RelativeDate | 日付ベースの BooleanCriteria で使用する値を計算するための相対日付オプションの列挙型。 |
SheetType | SheetType | スプレッドシートに存在するさまざまな種類のシートを列挙します。 |
SortOrder | SortOrder | 並べ替え順序の列挙。 |
TextDirection | TextDirection | 有効なテキストによる経路案内の列挙型。 |
TextToColumnsDelimiter | TextToColumnsDelimiter | テキストを列に分割するための事前定義された区切り文字の列挙型。 |
ThemeColorType | ThemeColorType | テーマのカラータイプの列挙。 |
ValueType | ValueType | スプレッドシート サービスの Range クラスから Range.getValue() と Range.getValues() によって返される値の型の列挙型。 |
WrapStrategy | WrapStrategy | セルの折り返しに使用される戦略の列挙型。 |
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
create(name) | Spreadsheet | 指定された名前の新しいスプレッドシートを作成します。 |
create(name, rows, columns) | Spreadsheet | 指定された名前と行数と列数を持つ新しいスプレッドシートを作成します。 |
enableAllDataSourcesExecution() | void | すべてのタイプのデータソースでデータ実行を有効にします。 |
enableBigQueryExecution() | void | BigQuery データソースのデータ実行を有効にします。 |
enableLookerExecution() | void | Looker データソースでデータの実行を有効にします。 |
flush() | void | 保留中のスプレッドシートの変更をすべて適用します。 |
getActive() | Spreadsheet | 現在アクティブなスプレッドシートを返します。アクティブなスプレッドシートがない場合、null を返します。 |
getActiveRange() | Range | アクティブなシートで選択されている範囲を返します。アクティブな範囲がない場合、null を返します。 |
getActiveRangeList() | RangeList | アクティブなシート内のアクティブな範囲のリストを返します。範囲が選択されていない場合は null を返します。 |
getActiveSheet() | Sheet | スプレッドシート内のアクティブなシートを取得します。 |
getActiveSpreadsheet() | Spreadsheet | 現在アクティブなスプレッドシートを返します。スプレッドシートがない場合は null を返します。 |
getCurrentCell() | Range | アクティブなシートのアクティブな範囲のいずれかで選択されている現在の(ハイライト表示された)セルを返します。現在のセルがない場合、null を返します。 |
getSelection() | Selection | スプレッドシート内の現在の Selection を返します。 |
getUi() | Ui | スプレッドシートのユーザー インターフェース環境のインスタンスを返します。これにより、スクリプトでメニュー、ダイアログ、サイドバーなどの機能を追加できます。 |
newCellImage() | CellImageBuilder | CellImage のビルダーを作成します。 |
newColor() | ColorBuilder | Color のビルダーを作成します。 |
newConditionalFormatRule() | ConditionalFormatRuleBuilder | 条件付き書式ルールのビルダーを作成します。 |
newDataSourceSpec() | DataSourceSpecBuilder | DataSourceSpec のビルダーを作成します。 |
newDataValidation() | DataValidationBuilder | データ入力規則のビルダーを作成します。 |
newFilterCriteria() | FilterCriteriaBuilder | FilterCriteria のビルダーを作成します。 |
newRichTextValue() | RichTextValueBuilder | リッチテキスト値のビルダーを作成します。 |
newTextStyle() | TextStyleBuilder | テキスト スタイルのビルダーを作成します。 |
open(file) | Spreadsheet | 指定された File オブジェクトに対応するスプレッドシートを開きます。 |
openById(id) | Spreadsheet | 指定された ID のスプレッドシートを開きます。 |
openByUrl(url) | Spreadsheet | 指定された URL のスプレッドシートを開きます。 |
setActiveRange(range) | Range | 指定した範囲を active range として設定し、範囲内の左上のセルを current cell として設定します。 |
setActiveRangeList(rangeList) | RangeList | 指定した範囲のリストを active ranges として設定します。 |
setActiveSheet(sheet) | Sheet | スプレッドシート内のアクティブなシートを設定します。 |
setActiveSheet(sheet, restoreSelection) | Sheet | スプレッドシート内のアクティブなシートを設定し、そのシート内の最新の選択を復元するオプションを設定します。 |
setActiveSpreadsheet(newActiveSpreadsheet) | void | アクティブなスプレッドシートを設定します。 |
setCurrentCell(cell) | Range | 指定したセルを current cell に設定します。 |
SpreadsheetTheme
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getConcreteColor(themeColorType) | Color | 有効なテーマカラータイプに対する具体的な Color を返します。 |
getFontFamily() | String | テーマのフォント ファミリーを返します。null テーマの場合は null を返します。 |
getThemeColors() | ThemeColorType[] | 現在のテーマで使用可能なすべてのテーマカラー タイプのリストを返します。 |
setConcreteColor(themeColorType, color) | SpreadsheetTheme | このカラーパターンの ThemeColorType に関連付けられているコンクリート色を指定された色に設定します。 |
setConcreteColor(themeColorType, red, green, blue) | SpreadsheetTheme | このカラーパターンの ThemeColorType に関連付けられた具体的な色を、指定された色(RGB 形式)に設定します。 |
setFontFamily(fontFamily) | SpreadsheetTheme | テーマのフォント ファミリーを設定します。 |
TextDirection
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
LEFT_TO_RIGHT | Enum | 文章方向(左から右へ)。 |
RIGHT_TO_LEFT | Enum | 文章方向が右から左。 |
TextFinder
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
findAll() | Range[] | 検索条件に一致するすべてのセルを返します。 |
findNext() | Range | 検索条件に一致する次のセルを返します。 |
findPrevious() | Range | 検索条件に一致する前のセルを返します。 |
getCurrentMatch() | Range | 検索条件に一致する現在のセルを返します。 |
ignoreDiacritics(ignoreDiacritics) | TextFinder | true の場合、照合中にアクセント記号を無視するように検索を構成します。それ以外の場合は、アクセント記号が一致します。 |
matchCase(matchCase) | TextFinder | true の場合、検索テキストの大文字と小文字を完全に一致させるように検索を構成します。それ以外の場合は、検索はデフォルトで大文字と小文字を区別しない照合になります。 |
matchEntireCell(matchEntireCell) | TextFinder | true の場合、セルの内容全体と一致するように検索を構成します。それ以外の場合は、検索はデフォルトで部分一致になります。 |
matchFormulaText(matchFormulaText) | TextFinder | true の場合、数式のテキスト内に表示される一致を返すように検索を構成します。それ以外の場合は、数式を含むセルは表示される値に基づいて考慮されます。 |
replaceAllWith(replaceText) | Integer | 一致したすべてのテキストを指定されたテキストに置き換えます。 |
replaceWith(replaceText) | Integer | 現在一致しているセル内の検索テキストを指定されたテキストに置き換え、置換された回数を返します。 |
startFrom(startRange) | TextFinder | 指定したセル範囲の直後に検索を開始するように検索を構成します。 |
useRegularExpression(useRegEx) | TextFinder | true の場合、検索文字列を正規表現として解釈するように検索を構成します。それ以外の場合は、検索文字列を通常のテキストとして解釈します。 |
TextRotation
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getDegrees() | Integer | 標準のテキストの向きと現在のテキストの向きの間の角度を取得します。 |
isVertical() | Boolean | テキストが縦方向に積み重ねられている場合は true 、それ以外の場合は false を返します。 |
TextStyle
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | TextStyleBuilder | このテキスト スタイルの値で初期化されたテキスト スタイル ビルダーを作成します。 |
getFontFamily() | String | テキストのフォント ファミリーを取得します。 |
getFontSize() | Integer | テキストのフォントサイズをポイント単位で取得します。 |
getForegroundColorObject() | Color | テキストのフォントの色を取得します。 |
isBold() | Boolean | テキストが太字かどうかを取得します。 |
isItalic() | Boolean | セルが斜体かどうかを取得します。 |
isStrikethrough() | Boolean | セルに取り消し線が引かれているかどうかを取得します。 |
isUnderline() | Boolean | セルが下線付きかどうかを取得します。 |
TextStyleBuilder
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
build() | TextStyle | このビルダーからテキスト スタイルを作成します。 |
setBold(bold) | TextStyleBuilder | テキストを太字にするかどうかを設定します。 |
setFontFamily(fontFamily) | TextStyleBuilder | テキストのフォント ファミリー(「Arial」など)を設定します。 |
setFontSize(fontSize) | TextStyleBuilder | テキストのフォントサイズをポイントで設定します。 |
setForegroundColor(cssString) | TextStyleBuilder | テキストのフォントの色を設定します。 |
setForegroundColorObject(color) | TextStyleBuilder | テキストのフォントの色を設定します。 |
setItalic(italic) | TextStyleBuilder | テキストを斜体にするかどうかを設定します。 |
setStrikethrough(strikethrough) | TextStyleBuilder | テキストに取り消し線を付けるかどうかを設定します。 |
setUnderline(underline) | TextStyleBuilder | テキストに下線を付けるかどうかを設定します。 |
TextToColumnsDelimiter
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
COMMA | Enum | "," 区切り文字。 |
SEMICOLON | Enum | ";" 区切り文字。 |
PERIOD | Enum | "." 区切り文字。 |
SPACE | Enum | " " 区切り文字。 |
ThemeColor
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getColorType() | ColorType | この色のタイプを取得します。 |
getThemeColorType() | ThemeColorType | この色のテーマカラータイプを取得します。 |
ThemeColorType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
UNSUPPORTED | Enum | サポートされていないテーマの色を表します。 |
TEXT | Enum | テキストの色を表します。 |
BACKGROUND | Enum | グラフの背景に使用する色を表します。 |
ACCENT1 | Enum | 最初のアクセント カラーを表します。 |
ACCENT2 | Enum | 2 つ目のアクセント カラーを表します。 |
ACCENT3 | Enum | 3 つ目のアクセント カラーを表します。 |
ACCENT4 | Enum | 4 番目のアクセント カラーを表します。 |
ACCENT5 | Enum | 5 番目のアクセント カラーを表します。 |
ACCENT6 | Enum | 6 番目のアクセント カラーを表します。 |
HYPERLINK | Enum | ハイパーリンクに使用する色を表します。 |
ValueType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
IMAGE | Enum | セルに画像が含まれている場合の値の型。 |
WrapStrategy
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
WRAP | Enum | セルの幅よりも長い行は、新しい行に折り返します。 |
OVERFLOW | Enum | 次のセルが空白であれば、そのセルに線がオーバーフローします。 |
CLIP | Enum | セルの幅よりも長い行をクリップします。 |