【GAS】Google Apps Scriptリファレンス一覧【日本語版】

2020-02-13

Google Apps Scriptリファレンス【36万字で一覧を紹介】
mono
mono
こんにちは、monoです。

ありそうでなかったGoogle Apps Scriptの総まとめリファレンス(日本語版)を作成しました。

量が多いので、Chromeの検索機能(Mac:「command + F」 Windows:「Ctrl + F」)を活用して、目当ての情報を探してくださいませ。

本でリファレンスを勉強したい人は下記の本がおすすめです。

created by Rinker
¥2,970 (2021/09/20 09:12:55時点 Amazon調べ-詳細)

目次

スプレッドシートサービス

このサービスを使用すると、スクリプトでGoogleスプレッドシートファイルを作成、アクセス、変更できますデータをスプレッドシートに保存するためのガイドも参照してください

クラス

名前 簡単な説明
AutoFillSeries 自動入力値の計算に使用されるシリーズのタイプの列挙
Banding バンディング、範囲の行または列に適用されるカラーパターンにアクセスして変更します
BandingTheme バンディングテーマの列挙
BigQueryDataSourceSpec 既存のBigQueryデータソース仕様にアクセスします
BigQueryDataSourceSpecBuilder のビルダーBigQueryDataSourceSpecBuilder
BooleanCondition のブール条件にアクセスしConditionalFormatRulesます
BooleanCriteria 条件付き形式またはフィルターで使用できるブール条件を表す列挙体
BorderStyle を使用して範囲に設定できるスタイルRange.setBorder(top, left, bottom, right, vertical, horizontal, color, style)
Color 色の表現
ColorBuilder のビルダーColorBuilder
ConditionalFormatRule 条件付き書式設定ルールにアクセスします
ConditionalFormatRuleBuilder 条件付き書式ルールのビルダー
ContainerInfo シート内のチャートの位置にアクセスします
CopyPasteType 可能な特殊な貼り付けタイプの列挙
DataExecutionErrorCode データ実行エラーコードの列挙
DataExecutionState データ実行状態の列挙
DataExecutionStatus データ実行ステータス
DataSource 既存のデータソースにアクセスして変更します
DataSourceParameter 既存のデータソースパラメータにアクセスします
DataSourceParameterType データソースパラメータタイプの列挙
DataSourceSpec 既存のデータソース仕様の一般設定にアクセスします
DataSourceSpecBuilder のビルダーDataSourceSpec
DataSourceTable 既存のデータソーステーブルにアクセスして変更します
DataSourceType データソースタイプの列挙
DataValidation データ検証ルールにアクセスします
DataValidationBuilder データ検証ルールのビルダー
DataValidationCriteria 範囲に設定できるデータ検証基準を表す列挙体
DeveloperMetadata 開発者のメタデータにアクセスして変更します
DeveloperMetadataFinder スプレッドシートで開発者のメタデータを検索します
DeveloperMetadataLocation 開発者のメタデータの場所情報にアクセスします
DeveloperMetadataLocationType 開発者メタデータの場所の種類の種類の列挙
DeveloperMetadataVisibility 開発者のメタデータの可視性の種類の列挙
Dimension スプレッドシートにデータを保存できる方向の列挙
Direction 矢印キーを使用してスプレッドシート内で移動できる方向を表す列挙体
EmbeddedAreaChartBuilder 面グラフのビルダー
EmbeddedBarChartBuilder 棒グラフのビルダー
EmbeddedChart スプレッドシートに埋め込まれたグラフを表します
EmbeddedChartBuilder を使用してビルダーを編集しましたEmbeddedChart
EmbeddedColumnChartBuilder 縦棒グラフのビルダー
EmbeddedComboChartBuilder コンボチャートのビルダー
EmbeddedHistogramChartBuilder ヒストグラムチャートのビルダー
EmbeddedLineChartBuilder 折れ線グラフのビルダー
EmbeddedPieChartBuilder 円グラフのビルダー
EmbeddedScatterChartBuilder 散布図のビルダー
EmbeddedTableChartBuilder テーブルチャートのビルダー
Filter 既存のフィルターにアクセスして変更します
FilterCriteria フィルタ条件にアクセスします
FilterCriteriaBuilder のビルダーFilterCriteria
GradientCondition のグラデーション(色)条件にアクセスしConditionalFormatRuleApisます
Group スプレッドシートグループにアクセスして変更します
GroupControlTogglePosition グループコントロールのトグルが取り得る位置を表す列挙体
InterpolationType a ConditionalFormatRule
NamedRange スプレッドシートで名前付き範囲を作成、アクセス、および変更します
OverGridImage スプレッドシートのグリッド上の画像を表します
PageProt 古いバージョンのGoogleスプレッドシートの保護されたシートにアクセスして変更します
PivotFilter ピボットテーブルフィルターにアクセスして変更します
PivotGroup ピボットテーブルのブレークアウトグループにアクセスして変更します
PivotTable ピボットテーブルにアクセスして変更します
PivotTableSummarizeFunction ピボットテーブルデータを要約する関数の列挙
PivotValue ピボットテーブルの値グループにアクセスして変更します
PivotValueDisplayType ピボット値を別の値の関数として表示するメソッドの列挙
Protection 保護された範囲とシートにアクセスして変更します
ProtectionType 編集から保護できるスプレッドシートの部分を表す列挙体
Range スプレッドシートの範囲にアクセスして変更します
RangeList Range同じシート内の1つ以上のインスタンスのコレクション
RecalculationInterval スプレッドシートの再計算で使用される可能性のある間隔を表す列挙体
RelativeDate 日付ベースで使用される値を計算するための相対的な日付オプションを表す列挙体BooleanCriteria
RichTextValue セルテキストを表すために使用される定型化されたテキスト文字列
RichTextValueBuilder リッチテキスト値のビルダー
Selection アクティブなシートで現在アクティブな選択にアクセスします
Sheet スプレッドシートにアクセスして変更します
SheetType スプレッドシートに存在できるさまざまな種類のシート
Slicer 表しスライサ非協調メソッドでフィルタ範囲、チャート、ピボットテーブルに使用されます
Spreadsheet Googleスプレッドシートファイルにアクセスして変更します
SpreadsheetApp Googleスプレッドシートファイルにアクセスして作成します
SpreadsheetTheme 既存のテーマにアクセスして変更します
TextDirection テキストの方向の列挙
TextFinder 範囲、シート、スプレッドシート内のテキストを検索または置換します
TextRotation セルのテキスト回転設定にアクセスします
TextStyle セル内のテキストのレンダリングスタイル
TextStyleBuilder テキストスタイルのビルダー
TextToColumnsDelimiter テキストの列を複数の列に分割できるプリセット区切り文字の種類の列挙
ThemeColor テーマの色の表現
ThemeColorType テーマでサポートされているさまざまな色のエントリを記述する列挙体
WrapStrategy セルテキストの折り返しを処理するために使用される戦略の列挙

AutoFillSeries

プロパティ

物件 タイプ 説明
DEFAULT_SERIES Enum デフォルト
ALTERNATE_SERIES Enum この設定で自動入力すると、拡張範囲内の空のセルに既存の値のコピーが入力されます

Banding

メソッド

メソッド 戻りタイプ 簡単な説明
copyTo(range) Banding このバンディングを別の範囲にコピーします
getFirstColumnColor() String 交互になっている最初の列の色を返しますnull色が設定されていない場合
getFirstColumnColorObject() Color バンディングの最初の交互の列の色を返しますnull色が設定されていない場合
getFirstRowColor() String Returns the first row color that is alternating or null if no color is set.
getFirstRowColorObject() Color Returns the first alternating row color, or null if no color is set.
getFooterColumnColor() String Returns the color of the last column, or null if no color is set.
getFooterColumnColorObject() Color Returns the color of the last column in the banding, or null if no color is set.
getFooterRowColor() String Returns the color of the last row, or null if no color is set.
getFooterRowColorObject() Color Returns the last row color in the banding, or null if no color is set.
getHeaderColumnColor() String Returns the color of the header column, or null if no color is set.
getHeaderColumnColorObject() Color Returns the color of the first column in the banding, or null if no color is set.
getHeaderRowColor() String Returns the color of the header row or null if no color is set.
getHeaderRowColorObject() Color Returns the color of the header row or null if no color is set.
getRange() Range Returns the range for this banding.
getSecondColumnColor() String Returns the second column color that is alternating, or null if no color is set.
getSecondColumnColorObject() Color Returns the second alternating column color in the banding, or null if no color is set.
getSecondRowColor() String Returns the second row color that is alternating or null if no color is set.
getSecondRowColorObject() Color Returns the second alternating row color, or null if no color is set.
remove() void Removes this banding.
setFirstColumnColor(color) Banding Sets the first column color that is alternating.
setFirstColumnColorObject(color) Banding Sets the first alternating column color in the banding.
setFirstRowColor(color) Banding Sets the first row color that is alternating.
setFirstRowColorObject(color) Banding Sets the first alternating row color in the banding.
setFooterColumnColor(color) Banding Sets the color of the last column.
setFooterColumnColorObject(color) Banding Sets the color of the last column in the banding.
setFooterRowColor(color) Banding Sets the color of the last row.
setFooterRowColorObject(color) Banding Sets the color of the footer row in the banding.
setHeaderColumnColor(color) Banding Sets the color of the header column.
setHeaderColumnColorObject(color) Banding Sets the color of the header column.
setHeaderRowColor(color) Banding Sets the color of the header row.
setHeaderRowColorObject(color) Banding Sets the color of the header row.
setRange(range) Banding Sets the range for this banding.
setSecondColumnColor(color) Banding Sets the second column color that is alternating.
setSecondColumnColorObject(color) Banding Sets the second alternating column color in the banding.
setSecondRowColor(color) Banding Sets the second row color that is alternating.
setSecondRowColorObject(color) Banding Sets the second alternating color in the banding.

BandingTheme

プロパティ

Property Type Description
LIGHT_GREY Enum A light grey banding theme.
CYAN Enum A cyan banding theme.
GREEN Enum A green banding theme.
YELLOW Enum A yellow banding theme.
ORANGE Enum An orange banding theme.
BLUE Enum A blue banding theme.
TEAL Enum A teal banding theme.
GREY Enum A grey banding theme.
BROWN Enum A brown banding theme.
LIGHT_GREEN Enum A light green banding theme.
INDIGO Enum An indigo banding theme.
PINK Enum A pink banding theme.

BigQueryDataSourceSpec

メソッド

Method Return type Brief description
copy() DataSourceSpecBuilder Creates a DataSourceSpecBuilder based on this data source's settings.
getParameters() DataSourceParameter[] Gets the parameters of the data source.
getProjectId() String Gets the billing project ID.
getRawQuery() String Gets the raw query string.
getType() DataSourceType Gets the type of the data source.

BigQueryDataSourceSpecBuilder

メソッド

Method Return type Brief description
build() DataSourceSpec Builds a data source specification from the settings in this builder.
copy() DataSourceSpecBuilder Creates a DataSourceSpecBuilder based on this data source's settings.
getParameters() DataSourceParameter[] Gets the parameters of the data source.
getProjectId() String Gets the billing project ID.
getRawQuery() String Gets the raw query string.
getType() DataSourceType Gets the type of the data source.
removeAllParameters() BigQueryDataSourceSpecBuilder Removes all the parameters.
removeParameter(parameterName) BigQueryDataSourceSpecBuilder Removes the specified parameter.
setParameterFromCell(parameterName, sourceCell) BigQueryDataSourceSpecBuilder Adds a parameter, or if the parameter with the name exists, updates its source cell.
setProjectId(projectId) BigQueryDataSourceSpecBuilder Sets the billing BigQuery project ID.
setRawQuery(rawQuery) BigQueryDataSourceSpecBuilder Sets the raw query string.

BooleanCondition

メソッド

Method Return type Brief description
getBackground() String Gets the background color string for this boolean condition.
getBackgroundObject() Color Gets the background color for this boolean condition.
getBold() Boolean Returns true if this boolean condition bolds the text and returns false if this boolean condition removes bolding from the text.
getCriteriaType() BooleanCriteria Gets the rule's criteria type as defined in the BooleanCriteria enum.
getCriteriaValues() Object[] Gets an array of arguments for the rule's criteria.
getFontColor() String Gets the font color string for this boolean condition.
getFontColorObject() Color Gets the font color for this boolean condition.
getItalic() Boolean Returns true if this boolean condition italicises the text and returns false if this boolean condition removes italics from the text.
getStrikethrough() Boolean Returns true if this boolean condition strikes through the text and returns false if this boolean condition removes strikethrough from the text.
getUnderline() Boolean Returns true if this boolean condition underlines the text and returns false if this boolean condition removes underlining from the text.

BooleanCriteria

プロパティ

Property Type Description
CELL_EMPTY Enum The criteria is met when a cell is empty.
CELL_NOT_EMPTY Enum The criteria is met when a cell is not empty.
DATE_AFTER Enum The criteria is met when a date is after the given value.
DATE_BEFORE Enum The criteria is met when a date is before the given value.
DATE_EQUAL_TO Enum The criteria is met when a date is equal to the given value.
DATE_AFTER_RELATIVE Enum The criteria is met when a date is after the relative date value.
DATE_BEFORE_RELATIVE Enum The criteria is met when a date is before the relative date value.
DATE_EQUAL_TO_RELATIVE Enum The criteria is met when a date is equal to the relative date value.
NUMBER_BETWEEN Enum The criteria is met when a number that is between the given values.
NUMBER_EQUAL_TO Enum The criteria is met when a number that is equal to the given value.
NUMBER_GREATER_THAN Enum The criteria is met when a number that is greater than the given value.
NUMBER_GREATER_THAN_OR_EQUAL_TO Enum The criteria is met when a number that is greater than or equal to the given value.
NUMBER_LESS_THAN Enum The criteria is met when a number that is less than the given value.
NUMBER_LESS_THAN_OR_EQUAL_TO Enum The criteria is met when a number that is less than or equal to the given value.
NUMBER_NOT_BETWEEN Enum The criteria is met when a number that is not between the given values.
NUMBER_NOT_EQUAL_TO Enum The criteria is met when a number that is not equal to the given value.
TEXT_CONTAINS Enum The criteria is met when the input contains the given value.
TEXT_DOES_NOT_CONTAIN Enum The criteria is met when the input does not contain the given value.
TEXT_EQUAL_TO Enum The criteria is met when the input is equal to the given value.
TEXT_STARTS_WITH Enum The criteria is met when the input begins with the given value.
TEXT_ENDS_WITH Enum The criteria is met when the input ends with the given value.
CUSTOM_FORMULA Enum The criteria is met when the input makes the given formula evaluate to true.

BorderStyle

プロパティ

Property Type Description
DOTTED Enum Dotted line borders.
DASHED Enum Dashed line borders.
SOLID Enum Thin solid line borders.
SOLID_MEDIUM Enum Medium solid line borders.
SOLID_THICK Enum Thick solid line borders.
DOUBLE Enum Two solid line borders.

Color

メソッド

Method Return type Brief description
asRgbColor() RgbColor Converts this color to an RgbColor.
asThemeColor() ThemeColor Converts this color to a ThemeColor.
getColorType() ColorType Get the type of this color.

ColorBuilder

メソッド

Method Return type Brief description
asRgbColor() RgbColor Converts this color to an RgbColor.
asThemeColor() ThemeColor Converts this color to a ThemeColor.
build() Color Creates a color object from the settings supplied to the builder.
getColorType() ColorType Get the type of this color.
setRgbColor(cssString) ColorBuilder Sets as RGB color.
setThemeColor(themeColorType) ColorBuilder Sets as theme color.

ConditionalFormatRule

メソッド

Method Return type Brief description
copy() ConditionalFormatRuleBuilder Returns a rule builder preset with this rule's settings.
getBooleanCondition() BooleanCondition Retrieves the rule's BooleanCondition information if this rule uses boolean condition criteria.
getGradientCondition() GradientCondition Retrieves the rule's GradientCondition information, if this rule uses gradient condition criteria.
getRanges() Range[] Retrieves the ranges to which this conditional format rule is applied.

ConditionalFormatRuleBuilder

メソッド

Method Return type Brief description
build() ConditionalFormatRule Constructs a conditional format rule from the settings applied to the builder.
copy() ConditionalFormatRuleBuilder Returns a rule builder preset with this rule's settings.
getBooleanCondition() BooleanCondition Retrieves the rule's BooleanCondition information if this rule uses boolean condition criteria.
getGradientCondition() GradientCondition Retrieves the rule's GradientCondition information, if this rule uses gradient condition criteria.
getRanges() Range[] Retrieves the ranges to which this conditional format rule is applied.
setBackground(color) ConditionalFormatRuleBuilder Sets the background color for the conditional format rule's format.
setBackgroundObject(color) ConditionalFormatRuleBuilder Sets the background color for the conditional format rule's format.
setBold(bold) ConditionalFormatRuleBuilder Sets text bolding for the conditional format rule's format.
setFontColor(color) ConditionalFormatRuleBuilder Sets the font color for the conditional format rule's format.
setFontColorObject(color) ConditionalFormatRuleBuilder Sets the font color for the conditional format rule's format.
setGradientMaxpoint(color) ConditionalFormatRuleBuilder Clears the conditional format rule's gradient maxpoint value, and instead uses the maximum value in the rule's ranges.
setGradientMaxpointObject(color) ConditionalFormatRuleBuilder Clears the conditional format rule's gradient maxpoint value, and instead uses the maximum value in the rule's ranges.
setGradientMaxpointObjectWithValue(color, type, value) ConditionalFormatRuleBuilder Sets the conditional format rule's gradient maxpoint fields.
setGradientMaxpointWithValue(color, type, value) ConditionalFormatRuleBuilder Sets the conditional format rule's gradient maxpoint fields.
setGradientMidpointObjectWithValue(color, type, value) ConditionalFormatRuleBuilder Sets the conditional format rule's gradient midpoint fields.
setGradientMidpointWithValue(color, type, value) ConditionalFormatRuleBuilder Sets the conditional format rule's gradient midpoint fields.
setGradientMinpoint(color) ConditionalFormatRuleBuilder Clears the conditional format rule's gradient minpoint value, and instead uses the minimum value in the rule's ranges.
setGradientMinpointObject(color) ConditionalFormatRuleBuilder Clears the conditional format rule's gradient minpoint value, and instead uses the minimum value in the rule's ranges.
setGradientMinpointObjectWithValue(color, type, value) ConditionalFormatRuleBuilder Sets the conditional format rule's gradient minpoint fields.
setGradientMinpointWithValue(color, type, value) ConditionalFormatRuleBuilder Sets the conditional format rule's gradient minpoint fields.
setItalic(italic) ConditionalFormatRuleBuilder Sets text italics for the conditional format rule's format.
setRanges(ranges) ConditionalFormatRuleBuilder Sets one or more ranges to which this conditional format rule is applied.
setStrikethrough(strikethrough) ConditionalFormatRuleBuilder Sets text strikethrough for the conditional format rule's format.
setUnderline(underline) ConditionalFormatRuleBuilder Sets text underlining for the conditional format rule's format.
whenCellEmpty() ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when the cell is empty.
whenCellNotEmpty() ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when the cell is not empty.
whenDateAfter(date) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when a date is after the given value.
whenDateAfter(date) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when a date is after the given relative date.
whenDateBefore(date) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when a date is before the given date.
whenDateBefore(date) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when a date is before the given relative date.
whenDateEqualTo(date) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when a date is equal to the given date.
whenDateEqualTo(date) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when a date is equal to the given relative date.
whenFormulaSatisfied(formula) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when that the given formula evaluates to true.
whenNumberBetween(start, end) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when a number falls between, or is either of, two specified values.
whenNumberEqualTo(number) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when a number is equal to the given value.
whenNumberGreaterThan(number) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when a number is greater than the given value.
whenNumberGreaterThanOrEqualTo(number) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when a number is greater than or equal to the given value.
whenNumberLessThan(number) ConditionalFormatRuleBuilder Sets the conditional conditional format rule to trigger when a number less than the given value.
whenNumberLessThanOrEqualTo(number) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when a number less than or equal to the given value.
whenNumberNotBetween(start, end) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when a number does not fall between, and is neither of, two specified values.
whenNumberNotEqualTo(number) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when a number is not equal to the given value.
whenTextContains(text) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when that the input contains the given value.
whenTextDoesNotContain(text) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when that the input does not contain the given value.
whenTextEndsWith(text) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when that the input ends with the given value.
whenTextEqualTo(text) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when that the input is equal to the given value.
whenTextStartsWith(text) ConditionalFormatRuleBuilder Sets the conditional format rule to trigger when that the input starts with the given value.
withCriteria(criteria, args) ConditionalFormatRuleBuilder Sets the conditional format rule to criteria defined by arguments of an existing rule.

ContainerInfo

メソッド

Method Return type Brief description
getAnchorColumn() Integer The chart's left side is anchored in this column.
getAnchorRow() Integer The chart's top side is anchored in this row.
getOffsetX() Integer The chart's upper left hand corner is offset from the anchor column by this many pixels.
getOffsetY() Integer The chart's upper left hand corner is offset from the anchor row by this many pixels.

CopyPasteType

プロパティ

Property Type Description
PASTE_NORMAL Enum Paste values, formulas, formats and merges.
PASTE_NO_BORDERS Enum Paste values, formulas, formats and merges but without borders.
PASTE_FORMAT Enum Paste the format and data validation only.
PASTE_FORMULA Enum Paste the formulas only.
PASTE_DATA_VALIDATION Enum Paste the data validation only.
PASTE_VALUES Enum Paste the values ONLY without formats, formulas or merges.
PASTE_CONDITIONAL_FORMATTING Enum Paste the color rules only.
PASTE_COLUMN_WIDTHS Enum Paste the column widths only.

DataExecutionErrorCode

プロパティ

Property Type Description
DATA_EXECUTION_ERROR_CODE_UNSUPPORTED Enum A data execution error code that is not supported in Apps Script.
NONE Enum The data execution has no error.
TIME_OUT Enum The data execution timed out.
TOO_MANY_ROWS Enum The data execution returns more rows than the limit.
TOO_MANY_CELLS Enum The data execution returns more cells than the limit.
ENGINE Enum Data execution engine error.
PARAMETER_INVALID Enum Invalid data execution parameter.
UNSUPPORTED_DATA_TYPE Enum The data execution returns unsupported data type.
DUPLICATE_COLUMN_NAMES Enum The data execution returns duplicate column names.
INTERRUPTED Enum The data execution is interrupted.
OTHER Enum Other errors.
TOO_MANY_CHARS_PER_CELL Enum The data execution returns values that exceed the maximum characters allowed in a single cell.

DataExecutionState

プロパティ

Property Type Description
DATA_EXECUTION_STATE_UNSUPPORTED Enum A data execution state is not supported in Apps Script.
RUNNING Enum The data execution has started and is running.
SUCCESS Enum The data execution is completed and successful.
ERROR Enum The data execution is completed and has errors.
NOT_STARTED Enum The data execution has not started.

DataExecutionStatus

メソッド

Method Return type Brief description
getErrorCode() DataExecutionErrorCode Gets the error code of the data execution.
getErrorMessage() String Gets the error message of the data execution.
getExecutionState() DataExecutionState Gets the state of the data execution.
getLastRefreshedTime() Date Gets the time the data last successfully refreshed.
isTruncated() Boolean Returns true if the data from last successful execution is truncated, or false otherwise.

DataSource

メソッド

Method Return type Brief description
getSpec() DataSourceSpec Gets the data source specification.
updateSpec(spec) DataSource Updates the data source specification and refreshes the data source objects linked with this data source with the new specification.

DataSourceParameter

メソッド

Method Return type Brief description
getName() String Gets the parameter name.
getSourceCell() String Gets the source cell the parameter is valued based on, or null if the parameter type is not DataSourceParameterType.CELL.
getType() DataSourceParameterType Gets the parameter type.

DataSourceParameterType

プロパティ

Property Type Description
DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTED Enum A data source parameter type that is not supported in Apps Script.
CELL Enum The data source parameter is valued based on a cell.

DataSourceSpec

メソッド

Method Return type Brief description
asBigQuery() BigQueryDataSourceSpec Gets the spec for BigQuery data source.
copy() DataSourceSpecBuilder Creates a DataSourceSpecBuilder based on this data source's settings.
getParameters() DataSourceParameter[] Gets the parameters of the data source.
getType() DataSourceType Gets the type of the data source.

DataSourceSpecBuilder

メソッド

Method Return type Brief description
asBigQuery() BigQueryDataSourceSpecBuilder Gets the builder for BigQuery data source.
build() DataSourceSpec Builds a data source specification from the settings in this builder.
copy() DataSourceSpecBuilder Creates a DataSourceSpecBuilder based on this data source's settings.
getParameters() DataSourceParameter[] Gets the parameters of the data source.
getType() DataSourceType Gets the type of the data source.
removeAllParameters() DataSourceSpecBuilder Removes all the parameters.
removeParameter(parameterName) DataSourceSpecBuilder Removes the specified parameter.
setParameterFromCell(parameterName, sourceCell) DataSourceSpecBuilder Adds a parameter, or if the parameter with the name exists, updates its source cell.

DataSourceTable

メソッド

Method Return type Brief description
forceRefreshData() DataSourceTable Refreshes the data of this object regardless of the current state.
getDataSource() DataSource Gets the data source the object is linked to.
getRange() Range Rangeこのデータソーステーブルのスパンを取得します
getStatus() DataExecutionStatus オブジェクトのデータ実行ステータスを取得します
refreshData() DataSourceTable オブジェクトのデータを更新します
waitForCompletion(timeoutInSeconds) DataExecutionStatus 現在の実行が完了するまで待機し、指定された秒数後にタイムアウトします

DataSourceType

プロパティ

物件 タイプ 説明
DATA_SOURCE_TYPE_UNSUPPORTED Enum Appsスクリプトでサポートされていないデータソースタイプ
BIGQUERY Enum BigQueryデータソース

DataValidation

メソッド

メソッド 戻りタイプ 簡単な説明
copy() DataValidationBuilder このルールの設定に基づいて、データ検証ルールのビルダーを作成します
getAllowInvalid() Boolean true入力がデータ検証に失敗したときにルールが警告を表示するかfalse、入力を完全に拒否するかを返します
getCriteriaType() DataValidationCriteria DataValidationCriteria列挙で定義されているルールの条件タイプを取得します
getCriteriaValues() Object[] ルールの条件の引数の配列を取得します
getHelpText() String ルールのヘルプテキストを取得しますnullヘルプテキストが設定されていない場合

DataValidationBuilder

メソッド

メソッド 戻りタイプ 簡単な説明
build() DataValidation ビルダーに適用された設定からデータ検証ルールを構築します
copy() DataValidationBuilder このルールの設定に基づいて、データ検証ルールのビルダーを作成します
getAllowInvalid() Boolean true入力がデータ検証に失敗したときにルールが警告を表示するかfalse、入力を完全に拒否するかを返します
getCriteriaType() DataValidationCriteria DataValidationCriteria列挙で定義されているルールの条件タイプを取得します
getCriteriaValues() Object[] ルールの条件の引数の配列を取得します
getHelpText() String ルールのヘルプテキストを取得しますnullヘルプテキストが設定されていない場合
requireCheckbox() DataValidationBuilder 入力がブール値であることを要求するデータ検証ルールを設定しますこの値はチェックボックスとして表示されます
requireCheckbox(checkedValue) DataValidationBuilder 入力が指定された値または空白であることを要求するデータ検証ルールを設定します
requireCheckbox(checkedValue, uncheckedValue) DataValidationBuilder 入力が指定された値の1つであることを要求するデータ検証ルールを設定します
requireDate() DataValidationBuilder 日付を要求するデータ検証ルールを設定します
requireDateAfter(date) DataValidationBuilder 指定された値より後の日付を要求するデータ検証ルールを設定します
requireDateBefore(date) DataValidationBuilder 指定された値の前に日付を必要とするデータ検証ルールを設定します
requireDateBetween(start, end) DataValidationBuilder 指定された2つの日付の間にある、またはそのいずれかである日付を要求するようにデータ検証ルールを設定します
requireDateEqualTo(date) DataValidationBuilder 指定された値と等しい日付を要求するデータ検証ルールを設定します
requireDateNotBetween(start, end) DataValidationBuilder データ検証ルールを設定して、2つの指定された日付の間にある日付であり、どちらの日付でもない日付を要求します
requireDateOnOrAfter(date) DataValidationBuilder 指定された値以降の日付を要求するデータ検証ルールを設定します
requireDateOnOrBefore(date) DataValidationBuilder 指定された値またはそれ以前の日付を要求するデータ検証ルールを設定します
requireFormulaSatisfied(formula) DataValidationBuilder 指定されtrueた式がに評価されることを要求するデータ検証ルールを設定します
requireNumberBetween(start, end) DataValidationBuilder データ検証ルールを設定して、指定された2つの数値の間にある、またはそのいずれかである数値を要求します
requireNumberEqualTo(number) DataValidationBuilder 指定された値に等しい数値を要求するようにデータ検証ルールを設定します
requireNumberGreaterThan(number) DataValidationBuilder 指定された値より大きい数値を要求するようにデータ検証ルールを設定します
requireNumberGreaterThanOrEqualTo(number) DataValidationBuilder 指定された値以上の数を要求するデータ検証ルールを設定します
requireNumberLessThan(number) DataValidationBuilder 指定された値より小さい数値を要求するようにデータ検証ルールを設定します
requireNumberLessThanOrEqualTo(number) DataValidationBuilder 指定された値以下の数を必要とするデータ検証ルールを設定します
requireNumberNotBetween(start, end) DataValidationBuilder データ検証ルールを設定して、指定された2つの数値の間に収まらず、どちらでもない数値を要求します
requireNumberNotEqualTo(number) DataValidationBuilder Sets the data validation rule to require a number not equal to the given value.
requireTextContains(text) DataValidationBuilder Sets the data validation rule to require that the input contains the given value.
requireTextDoesNotContain(text) DataValidationBuilder Sets the data validation rule to require that the input does not contain the given value.
requireTextEqualTo(text) DataValidationBuilder Sets the data validation rule to require that the input is equal to the given value.
requireTextIsEmail() DataValidationBuilder Sets the data validation rule to require that the input is in the form of an email address.
requireTextIsUrl() DataValidationBuilder Sets the data validation rule to require that the input is in the form of a URL.
requireValueInList(values) DataValidationBuilder Sets the data validation rule to require that the input is equal to one of the given values.
requireValueInList(values, showDropdown) DataValidationBuilder Sets the data validation rule to require that the input is equal to one of the given values, with an option to hide the dropdown menu.
requireValueInRange(range) DataValidationBuilder Sets the data validation rule to require that the input is equal to a value in the given range.
requireValueInRange(range, showDropdown) DataValidationBuilder Sets the data validation rule to require that the input is equal to a value in the given range, with an option to hide the dropdown menu.
setAllowInvalid(allowInvalidData) DataValidationBuilder Sets whether to show a warning when input fails data validation or whether to reject the input entirely.
setHelpText(helpText) DataValidationBuilder Sets the help text that appears when the user hovers over the cell on which data validation is set.
withCriteria(criteria, args) DataValidationBuilder Sets the data validation rule to criteria defined by arguments of an existing rule.

DataValidationCriteria

プロパティ

Property Type Description
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.

DeveloperMetadata

メソッド

Method Return type Brief description
getId() Integer Returns the unique ID associated with this developer metadata.
getKey() String Returns the key associated with this developer metadata.
getLocation() DeveloperMetadataLocation Returns the location of this developer metadata.
getValue() String Returns the value associated with this developer metadata, or null if this metadata has no value.
getVisibility() DeveloperMetadataVisibility Returns the visibility of this developer metadata.
moveToColumn(column) DeveloperMetadata Moves this developer metadata to the specified column.
moveToRow(row) DeveloperMetadata Moves this developer metadata to the specified row.
moveToSheet(sheet) DeveloperMetadata Moves this developer metadata to the specified sheet.
moveToSpreadsheet() DeveloperMetadata Moves this developer metadata to the top-level spreadsheet.
remove() void Deletes this metadata.
setKey(key) DeveloperMetadata Sets the key of this developer metadata to the specified value.
setValue(value) DeveloperMetadata Sets the value associated with this developer metadata to the specified value.
setVisibility(visibility) DeveloperMetadata Sets the visibility of this developer metadata to the specified visibility.

DeveloperMetadataFinder

メソッド

Method Return type Brief description
find() DeveloperMetadata[] Executes this search and returns the matching metadata.
onIntersectingLocations() DeveloperMetadataFinder Configures the search to consider intersecting locations that have metadata.
withId(id) DeveloperMetadataFinder Limits this search to consider only metadata that match the specified ID.
withKey(key) DeveloperMetadataFinder Limits this search to consider only metadata that match the specified key.
withLocationType(locationType) DeveloperMetadataFinder Limits this search to consider only metadata that match the specified location type.
withValue(value) DeveloperMetadataFinder Limits this search to consider only metadata that match the specified value.
withVisibility(visibility) DeveloperMetadataFinder Limits this search to consider only metadata that match the specified visibility.

DeveloperMetadataLocation

メソッド

Method Return type Brief description
getColumn() Range Returns the Range for the column location of this metadata, or null if the location type is not DeveloperMetadataLocationType.COLUMN.
getLocationType() DeveloperMetadataLocationType Gets the type of location.
getRow() Range Rangeこのメタデータの行の場所のを返しますnull場所のタイプがでない場合DeveloperMetadataLocationType.ROW
getSheet() Sheet Sheetこのメタデータの場所を返しますnull場所のタイプがでない場合DeveloperMetadataLocationType.SHEET
getSpreadsheet() Spreadsheet Spreadsheetこのメタデータの場所を返しますnull場所のタイプがでない場合DeveloperMetadataLocationType.SPREADSHEET

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 列インデックスの増加の方向

EmbeddedAreaChartBuilder

メソッド

メソッド 戻りタイプ 簡単な説明
addRange(range) EmbeddedChartBuilder このビルダーが変更するグラフに範囲を追加します
asAreaChart() EmbeddedAreaChartBuilder チャートタイプをAreaChartに設定し、を返しますEmbeddedAreaChartBuilder
asBarChart() EmbeddedBarChartBuilder チャートタイプをBarChartに設定し、を返しますEmbeddedBarChartBuilder
asColumnChart() EmbeddedColumnChartBuilder チャートタイプをColumnChartに設定し、を返しますEmbeddedColumnChartBuilder
asComboChart() EmbeddedComboChartBuilder チャートタイプをComboChartに設定し、を返しますEmbeddedComboChartBuilder
asHistogramChart() EmbeddedHistogramChartBuilder チャートタイプをHistogramChartに設定し、を返しますEmbeddedHistogramChartBuilder
asLineChart() EmbeddedLineChartBuilder チャートタイプをLineChartに設定し、を返しますEmbeddedLineChartBuilder
asPieChart() EmbeddedPieChartBuilder チャートタイプをPieChartに設定し、を返しますEmbeddedPieChartBuilder
asScatterChart() EmbeddedScatterChartBuilder チャートタイプをScatterChartに設定し、を返します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(range) EmbeddedChartBuilder Removes the specified range from the chart this builder modifies.
reverseCategories() EmbeddedAreaChartBuilder Reverses the drawing of series in the domain axis.
setBackgroundColor(cssValue) EmbeddedAreaChartBuilder Sets the background color for the chart.
setChartType(type) EmbeddedChartBuilder Changes the type of chart.
setColors(cssValues) EmbeddedAreaChartBuilder Sets the colors for the lines in the chart.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Sets the strategy to use for hidden rows and columns.
setLegendPosition(position) EmbeddedAreaChartBuilder Sets the position of the legend with respect to the chart.
setLegendTextStyle(textStyle) EmbeddedAreaChartBuilder Sets the text style of the chart legend.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Sets the merge strategy to use when more than one range exists.
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPointStyle(style) EmbeddedAreaChartBuilder Sets the style for points in the line.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setRange(start, end) EmbeddedAreaChartBuilder Sets the range for the chart.
setStacked() EmbeddedAreaChartBuilder Uses stacked lines, meaning that line and bar values are stacked (accumulated).
setTitle(chartTitle) EmbeddedAreaChartBuilder Sets the title of the chart.
setTitleTextStyle(textStyle) EmbeddedAreaChartBuilder Sets the text style of the chart title.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Sets whether the chart's rows and columns are transposed.
setXAxisTextStyle(textStyle) EmbeddedAreaChartBuilder Sets the horizontal axis text style.
setXAxisTitle(title) EmbeddedAreaChartBuilder Adds a title to the horizontal axis.
setXAxisTitleTextStyle(textStyle) EmbeddedAreaChartBuilder Sets the horizontal axis title text style.
setYAxisTextStyle(textStyle) EmbeddedAreaChartBuilder Sets the vertical axis text style.
setYAxisTitle(title) EmbeddedAreaChartBuilder Adds a title to the vertical axis.
setYAxisTitleTextStyle(textStyle) EmbeddedAreaChartBuilder Sets the vertical axis title text style.
useLogScale() EmbeddedAreaChartBuilder Makes the range axis into a logarithmic scale (requires all values to be positive).

EmbeddedBarChartBuilder

メソッド

Method Return type Brief description
addRange(range) 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(range) EmbeddedChartBuilder Removes the specified range from the chart this builder modifies.
reverseCategories() EmbeddedBarChartBuilder Reverses the drawing of series in the domain axis.
reverseDirection() EmbeddedBarChartBuilder Reverses the direction in which the bars grow along the horizontal axis.
setBackgroundColor(cssValue) EmbeddedBarChartBuilder Sets the background color for the chart.
setChartType(type) EmbeddedChartBuilder Changes the type of chart.
setColors(cssValues) EmbeddedBarChartBuilder Sets the colors for the lines in the chart.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Sets the strategy to use for hidden rows and columns.
setLegendPosition(position) EmbeddedBarChartBuilder Sets the position of the legend with respect to the chart.
setLegendTextStyle(textStyle) EmbeddedBarChartBuilder Sets the text style of the chart legend.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Sets the merge strategy to use when more than one range exists.
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setRange(start, end) EmbeddedBarChartBuilder Sets the range for the chart.
setStacked() EmbeddedBarChartBuilder Uses stacked lines, meaning that line and bar values are stacked (accumulated).
setTitle(chartTitle) EmbeddedBarChartBuilder Sets the title of the chart.
setTitleTextStyle(textStyle) EmbeddedBarChartBuilder Sets the text style of the chart title.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Sets whether the chart's rows and columns are transposed.
setXAxisTextStyle(textStyle) EmbeddedBarChartBuilder Sets the horizontal axis text style.
setXAxisTitle(title) EmbeddedBarChartBuilder Adds a title to the horizontal axis.
setXAxisTitleTextStyle(textStyle) EmbeddedBarChartBuilder Sets the horizontal axis title text style.
setYAxisTextStyle(textStyle) EmbeddedBarChartBuilder Sets the vertical axis text style.
setYAxisTitle(title) EmbeddedBarChartBuilder Adds a title to the vertical axis.
setYAxisTitleTextStyle(textStyle) EmbeddedBarChartBuilder Sets the vertical axis title text style.
useLogScale() EmbeddedBarChartBuilder Makes the range axis into a logarithmic scale (requires all values to be positive).

EmbeddedChart

メソッド

Method Return type Brief description
getAs(contentType) Blob Return the data inside this object as a blob converted to the specified content type.
getBlob() Blob Return the data inside this object as a blob.
getChartId() Integer Returns 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.
getContainerInfo() ContainerInfo Returns information about where the chart is positioned within a sheet.
getHiddenDimensionStrategy() ChartHiddenDimensionStrategy Returns the strategy to use for handling hidden rows and columns.
getMergeStrategy() ChartMergeStrategy Returns the merge strategy used when more than one range exists.
getNumHeaders() Integer Returns the number of rows or columns the range that are treated as headers.
getOptions() ChartOptions Returns the options for this chart, such as height, colors, and axes.
getRanges() Range[] Returns the ranges that this chart uses as a data source.
getTransposeRowsAndColumns() Boolean If true, the rows and columns used to populate the chart are switched.
modify() EmbeddedChartBuilder Returns an EmbeddedChartBuilder that can be used to modify this chart.

EmbeddedChartBuilder

メソッド

Method Return type Brief description
addRange(range) 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(range) EmbeddedChartBuilder Removes the specified range from the chart this builder modifies.
setChartType(type) EmbeddedChartBuilder Changes the type of chart.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Sets the strategy to use for hidden rows and columns.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Sets the merge strategy to use when more than one range exists.
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Sets whether the chart's rows and columns are transposed.

EmbeddedColumnChartBuilder

メソッド

Method Return type Brief description
addRange(range) 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(range) EmbeddedChartBuilder Removes the specified range from the chart this builder modifies.
reverseCategories() EmbeddedColumnChartBuilder Reverses the drawing of series in the domain axis.
setBackgroundColor(cssValue) EmbeddedColumnChartBuilder Sets the background color for the chart.
setChartType(type) EmbeddedChartBuilder Changes the type of chart.
setColors(cssValues) EmbeddedColumnChartBuilder Sets the colors for the lines in the chart.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Sets the strategy to use for hidden rows and columns.
setLegendPosition(position) EmbeddedColumnChartBuilder Sets the position of the legend with respect to the chart.
setLegendTextStyle(textStyle) EmbeddedColumnChartBuilder Sets the text style of the chart legend.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Sets the merge strategy to use when more than one range exists.
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setRange(start, end) EmbeddedColumnChartBuilder Sets the range for the chart.
setStacked() EmbeddedColumnChartBuilder Uses stacked lines, meaning that line and bar values are stacked (accumulated).
setTitle(chartTitle) EmbeddedColumnChartBuilder Sets the title of the chart.
setTitleTextStyle(textStyle) EmbeddedColumnChartBuilder Sets the text style of the chart title.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Sets whether the chart's rows and columns are transposed.
setXAxisTextStyle(textStyle) EmbeddedColumnChartBuilder Sets the horizontal axis text style.
setXAxisTitle(title) EmbeddedColumnChartBuilder Adds a title to the horizontal axis.
setXAxisTitleTextStyle(textStyle) EmbeddedColumnChartBuilder Sets the horizontal axis title text style.
setYAxisTextStyle(textStyle) EmbeddedColumnChartBuilder Sets the vertical axis text style.
setYAxisTitle(title) EmbeddedColumnChartBuilder Adds a title to the vertical axis.
setYAxisTitleTextStyle(textStyle) EmbeddedColumnChartBuilder Sets the vertical axis title text style.
useLogScale() EmbeddedColumnChartBuilder Makes the range axis into a logarithmic scale (requires all values to be positive).

EmbeddedComboChartBuilder

メソッド

Method Return type Brief description
addRange(range) 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 チャートを返しContainerInfoますこれは、シート上のチャートの表示場所をカプセル化します
getRanges() Range[] このチャートに現在データを提供している範囲のリストのコピーを返します
removeRange(range) EmbeddedChartBuilder このビルダーが変更するチャートから指定された範囲を削除します
reverseCategories() EmbeddedComboChartBuilder ドメイン軸のシリーズの描画を反転します
setBackgroundColor(cssValue) EmbeddedComboChartBuilder チャートの背景色を設定します
setChartType(type) EmbeddedChartBuilder チャートのタイプを変更します
setColors(cssValues) EmbeddedComboChartBuilder チャートの線の色を設定します
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder 非表示の行と列に使用する戦略を設定します
setLegendPosition(position) EmbeddedComboChartBuilder チャートに対する凡例の位置を設定します
setLegendTextStyle(textStyle) EmbeddedComboChartBuilder グラフの凡例のテキストスタイルを設定します
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder 複数の範囲が存在する場合に使用するマージ戦略を設定します
setNumHeaders(headers) EmbeddedChartBuilder ヘッダーとして処理される範囲の行または列の数を設定します
setOption(option, value) EmbeddedChartBuilder このチャートの詳細オプションを設定します
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder チャート上のシートの表示位置を変更して、位置を設定します
setRange(start, end) EmbeddedComboChartBuilder チャートの範囲を設定します
setStacked() EmbeddedComboChartBuilder 積み上げ行を使用しますつまり、行とバーの値は積み上げられます(累積されます)
setTitle(chartTitle) EmbeddedComboChartBuilder チャートのタイトルを設定します
setTitleTextStyle(textStyle) EmbeddedComboChartBuilder チャートタイトルのテキストスタイルを設定します
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder チャートの行と列を転置するかどうかを設定します
setXAxisTextStyle(textStyle) EmbeddedComboChartBuilder 水平軸のテキストスタイルを設定します
setXAxisTitle(title) EmbeddedComboChartBuilder 水平軸にタイトルを追加します
setXAxisTitleTextStyle(textStyle) EmbeddedComboChartBuilder 水平軸のタイトルテキストスタイルを設定します
setYAxisTextStyle(textStyle) EmbeddedComboChartBuilder 垂直軸のテキストスタイルを設定します
setYAxisTitle(title) EmbeddedComboChartBuilder 垂直軸にタイトルを追加します
setYAxisTitleTextStyle(textStyle) EmbeddedComboChartBuilder 垂直軸のタイトルのテキストスタイルを設定します
useLogScale() EmbeddedComboChartBuilder 範囲軸を対数目盛にします(すべての値が正である必要があります)

EmbeddedHistogramChartBuilder

メソッド

メソッド 戻りタイプ 簡単な説明
addRange(range) EmbeddedChartBuilder このビルダーが変更するグラフに範囲を追加します
asAreaChart() EmbeddedAreaChartBuilder チャートタイプをAreaChartに設定し、を返しますEmbeddedAreaChartBuilder
asBarChart() EmbeddedBarChartBuilder チャートタイプをBarChartに設定し、を返しますEmbeddedBarChartBuilder
asColumnChart() EmbeddedColumnChartBuilder チャートタイプをColumnChartに設定し、を返しますEmbeddedColumnChartBuilder
asComboChart() EmbeddedComboChartBuilder チャートタイプをComboChartに設定し、を返します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(range) EmbeddedChartBuilder Removes the specified range from the chart this builder modifies.
reverseCategories() EmbeddedHistogramChartBuilder Reverses the drawing of series in the domain axis.
setBackgroundColor(cssValue) EmbeddedHistogramChartBuilder Sets the background color for the chart.
setChartType(type) EmbeddedChartBuilder Changes the type of chart.
setColors(cssValues) EmbeddedHistogramChartBuilder Sets the colors for the lines in the chart.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Sets the strategy to use for hidden rows and columns.
setLegendPosition(position) EmbeddedHistogramChartBuilder Sets the position of the legend with respect to the chart.
setLegendTextStyle(textStyle) EmbeddedHistogramChartBuilder Sets the text style of the chart legend.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Sets the merge strategy to use when more than one range exists.
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setRange(start, end) EmbeddedHistogramChartBuilder Sets the range for the chart.
setStacked() EmbeddedHistogramChartBuilder Uses stacked lines, meaning that line and bar values are stacked (accumulated).
setTitle(chartTitle) EmbeddedHistogramChartBuilder Sets the title of the chart.
setTitleTextStyle(textStyle) EmbeddedHistogramChartBuilder Sets the text style of the chart title.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Sets whether the chart's rows and columns are transposed.
setXAxisTextStyle(textStyle) EmbeddedHistogramChartBuilder Sets the horizontal axis text style.
setXAxisTitle(title) EmbeddedHistogramChartBuilder Adds a title to the horizontal axis.
setXAxisTitleTextStyle(textStyle) EmbeddedHistogramChartBuilder Sets the horizontal axis title text style.
setYAxisTextStyle(textStyle) EmbeddedHistogramChartBuilder Sets the vertical axis text style.
setYAxisTitle(title) EmbeddedHistogramChartBuilder Adds a title to the vertical axis.
setYAxisTitleTextStyle(textStyle) EmbeddedHistogramChartBuilder 垂直軸のタイトルのテキストスタイルを設定します
useLogScale() EmbeddedHistogramChartBuilder 範囲軸を対数目盛にします(すべての値が正である必要があります)

EmbeddedLineChartBuilder

メソッド

メソッド 戻りタイプ 簡単な説明
addRange(range) EmbeddedChartBuilder このビルダーが変更するグラフに範囲を追加します
asAreaChart() EmbeddedAreaChartBuilder チャートタイプをAreaChartに設定し、を返しますEmbeddedAreaChartBuilder
asBarChart() EmbeddedBarChartBuilder チャートタイプをBarChartに設定し、を返しますEmbeddedBarChartBuilder
asColumnChart() EmbeddedColumnChartBuilder チャートタイプをColumnChartに設定し、を返しますEmbeddedColumnChartBuilder
asComboChart() EmbeddedComboChartBuilder チャートタイプをComboChartに設定し、を返しますEmbeddedComboChartBuilder
asHistogramChart() EmbeddedHistogramChartBuilder チャートタイプをHistogramChartに設定し、を返しますEmbeddedHistogramChartBuilder
asLineChart() EmbeddedLineChartBuilder チャートタイプをLineChartに設定し、を返しますEmbeddedLineChartBuilder
asPieChart() EmbeddedPieChartBuilder チャートタイプをPieChartに設定し、を返しますEmbeddedPieChartBuilder
asScatterChart() EmbeddedScatterChartBuilder チャートタイプをScatterChartに設定し、を返しますEmbeddedScatterChartBuilder
asTableChart() EmbeddedTableChartBuilder チャートタイプをTableChartに設定し、を返しますEmbeddedTableChartBuilder
build() EmbeddedChart 行われたすべての変更を反映するチャートを作成します
clearRanges() EmbeddedChartBuilder このビルダーが変更するチャートからすべての範囲を削除します
getChartType() ChartType 現在のチャートタイプを返します
getContainer() ContainerInfo チャートを返しContainerInfoますこれは、シート上のチャートの表示場所をカプセル化します
getRanges() Range[] このチャートに現在データを提供している範囲のリストのコピーを返します
removeRange(range) EmbeddedChartBuilder このビルダーが変更するチャートから指定された範囲を削除します
reverseCategories() EmbeddedLineChartBuilder ドメイン軸のシリーズの描画を反転します
setBackgroundColor(cssValue) EmbeddedLineChartBuilder チャートの背景色を設定します
setChartType(type) EmbeddedChartBuilder チャートのタイプを変更します
setColors(cssValues) EmbeddedLineChartBuilder チャートの線の色を設定します
setCurveStyle(style) EmbeddedLineChartBuilder チャートの曲線に使用するスタイルを設定します
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder 非表示の行と列に使用する戦略を設定します
setLegendPosition(position) EmbeddedLineChartBuilder チャートに対する凡例の位置を設定します
setLegendTextStyle(textStyle) EmbeddedLineChartBuilder グラフの凡例のテキストスタイルを設定します
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder 複数の範囲が存在する場合に使用するマージ戦略を設定します
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPointStyle(style) EmbeddedLineChartBuilder Sets the style for points in the line.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setRange(start, end) EmbeddedLineChartBuilder Sets the range for the chart.
setTitle(chartTitle) EmbeddedLineChartBuilder Sets the title of the chart.
setTitleTextStyle(textStyle) EmbeddedLineChartBuilder Sets the text style of the chart title.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Sets whether the chart's rows and columns are transposed.
setXAxisTextStyle(textStyle) EmbeddedLineChartBuilder Sets the horizontal axis text style.
setXAxisTitle(title) EmbeddedLineChartBuilder Adds a title to the horizontal axis.
setXAxisTitleTextStyle(textStyle) EmbeddedLineChartBuilder Sets the horizontal axis title text style.
setYAxisTextStyle(textStyle) EmbeddedLineChartBuilder Sets the vertical axis text style.
setYAxisTitle(title) EmbeddedLineChartBuilder Adds a title to the vertical axis.
setYAxisTitleTextStyle(textStyle) EmbeddedLineChartBuilder Sets the vertical axis title text style.
useLogScale() EmbeddedLineChartBuilder Makes the range axis into a logarithmic scale (requires all values to be positive).

EmbeddedPieChartBuilder

メソッド

Method Return type Brief description
addRange(range) 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(range) 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(cssValue) EmbeddedPieChartBuilder Sets the background color for the chart.
setChartType(type) EmbeddedChartBuilder Changes the type of chart.
setColors(cssValues) EmbeddedPieChartBuilder Sets the colors for the lines in the chart.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Sets the strategy to use for hidden rows and columns.
setLegendPosition(position) EmbeddedPieChartBuilder Sets the position of the legend with respect to the chart.
setLegendTextStyle(textStyle) EmbeddedPieChartBuilder Sets the text style of the chart legend.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Sets the merge strategy to use when more than one range exists.
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setTitle(chartTitle) EmbeddedPieChartBuilder Sets the title of the chart.
setTitleTextStyle(textStyle) EmbeddedPieChartBuilder Sets the text style of the chart title.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Sets whether the chart's rows and columns are transposed.

EmbeddedScatterChartBuilder

メソッド

Method Return type Brief description
addRange(range) 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(range) EmbeddedChartBuilder Removes the specified range from the chart this builder modifies.
setBackgroundColor(cssValue) EmbeddedScatterChartBuilder Sets the background color for the chart.
setChartType(type) EmbeddedChartBuilder Changes the type of chart.
setColors(cssValues) EmbeddedScatterChartBuilder Sets the colors for the lines in the chart.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Sets the strategy to use for hidden rows and columns.
setLegendPosition(position) EmbeddedScatterChartBuilder Sets the position of the legend with respect to the chart.
setLegendTextStyle(textStyle) EmbeddedScatterChartBuilder Sets the text style of the chart legend.
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Sets the merge strategy to use when more than one range exists.
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPointStyle(style) EmbeddedScatterChartBuilder Sets the style for points in the line.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setTitle(chartTitle) EmbeddedScatterChartBuilder Sets the title of the chart.
setTitleTextStyle(textStyle) EmbeddedScatterChartBuilder Sets the text style of the chart title.
setTransposeRowsAndColumns(transpose) 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(start, end) EmbeddedScatterChartBuilder Sets the range for the horizontal axis of the chart.
setXAxisTextStyle(textStyle) EmbeddedScatterChartBuilder Sets the horizontal axis text style.
setXAxisTitle(title) EmbeddedScatterChartBuilder Adds a title to the horizontal axis.
setXAxisTitleTextStyle(textStyle) 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(start, end) EmbeddedScatterChartBuilder Sets the range for the vertical axis of the chart.
setYAxisTextStyle(textStyle) EmbeddedScatterChartBuilder Sets the vertical axis text style.
setYAxisTitle(title) EmbeddedScatterChartBuilder Adds a title to the vertical axis.
setYAxisTitleTextStyle(textStyle) EmbeddedScatterChartBuilder Sets the vertical axis title text style.

EmbeddedTableChartBuilder

メソッド

Method Return type Brief description
addRange(range) 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(enablePaging) EmbeddedTableChartBuilder Sets whether to enable paging through the data.
enablePaging(pageSize) EmbeddedTableChartBuilder Enables paging and sets the number of rows in each page.
enablePaging(pageSize, startPage) EmbeddedTableChartBuilder Enables paging, sets the number of rows in each page and the first table page to display (page numbers are zero based).
enableRtlTable(rtlEnabled) 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(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(range) EmbeddedChartBuilder Removes the specified range from the chart this builder modifies.
setChartType(type) EmbeddedChartBuilder Changes the type of chart.
setFirstRowNumber(number) EmbeddedTableChartBuilder Sets the row number for the first row in the data table.
setHiddenDimensionStrategy(strategy) EmbeddedChartBuilder Sets the strategy to use for hidden rows and columns.
setInitialSortingAscending(column) EmbeddedTableChartBuilder Sets the index of the column according to which the table should be initially sorted (ascending).
setInitialSortingDescending(column) EmbeddedTableChartBuilder Sets the index of the column according to which the table should be initially sorted (descending).
setMergeStrategy(mergeStrategy) EmbeddedChartBuilder Sets the merge strategy to use when more than one range exists.
setNumHeaders(headers) EmbeddedChartBuilder Sets the number of rows or columns of the range that should be treated as headers.
setOption(option, value) EmbeddedChartBuilder Sets advanced options for this chart.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) EmbeddedChartBuilder Sets the position, changing where the chart appears on the sheet.
setTransposeRowsAndColumns(transpose) EmbeddedChartBuilder Sets whether the chart's rows and columns are transposed.
showRowNumberColumn(showRowNumber) EmbeddedTableChartBuilder Sets whether to show the row number as the first column of the table.
useAlternatingRowStyle(alternate) EmbeddedTableChartBuilder Sets whether alternating color style is assigned to odd and even rows of a table chart.

Filter

メソッド

Method Return type Brief description
getColumnFilterCriteria(columnPosition) 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(columnPosition) Filter 指定した列からフィルター条件を削除します
setColumnFilterCriteria(columnPosition, filterCriteria) Filter 指定した列にフィルター条件を設定します
sort(columnPosition, ascending) Filter このフィルターが適用される範囲の最初の行(ヘッダー行)を除いて、フィルターされた範囲を指定された列で並べ替えます

FilterCriteria

メソッド

メソッド 戻りタイプ 簡単な説明
copy() FilterCriteriaBuilder このフィルター条件の設定に基づいて、フィルター条件のビルダーを作成します
getCriteriaType() BooleanCriteria BooleanCriteria列挙で定義されているブール基準タイプを返します
getCriteriaValues() Object[] ブール条件の引数の配列を返します
getHiddenValues() String[] 非表示にする値を返します
getVisibleValues() String[] 表示する値を返します

FilterCriteriaBuilder

メソッド

メソッド 戻りタイプ 簡単な説明
build() FilterCriteria ビルダーに提供された設定からフィルター基準を作成します
copy() FilterCriteriaBuilder このフィルター条件の設定に基づいて、フィルター条件のビルダーを作成します
getCriteriaType() BooleanCriteria BooleanCriteria列挙で定義されているブール基準タイプを返します
getCriteriaValues() Object[] ブール条件の引数の配列を返します
getHiddenValues() String[] 非表示にする値を返します
getVisibleValues() String[] 表示する値を返します
setHiddenValues(values) FilterCriteriaBuilder 非表示にする値を設定します
setVisibleValues(values) FilterCriteriaBuilder 表示する値を設定します
whenCellEmpty() FilterCriteriaBuilder セルが空のセルを表示するフィルター条件を設定します
whenCellNotEmpty() FilterCriteriaBuilder フィルター条件を設定して、セルが空でないセルを表示します
whenDateAfter(date) FilterCriteriaBuilder セルの日付が指定された値より後のセルを表示するフィルター条件を設定します
whenDateAfter(date) FilterCriteriaBuilder セルの日付が指定された相対日付より後のセルを表示するフィルター条件を設定します
whenDateBefore(date) FilterCriteriaBuilder セルの日付が指定された日付より前のセルを表示するフィルター条件を設定します
whenDateBefore(date) FilterCriteriaBuilder セルの日付が指定された相対日付より前のセルを表示するようにフィルター条件を設定します
whenDateEqualTo(date) FilterCriteriaBuilder セルの日付が指定された日付と等しいセルを表示するフィルター条件を設定します
whenDateEqualTo(date) FilterCriteriaBuilder セルの日付が指定された相対的な日付と等しいセルを表示するためのフィルター基準を設定します
whenFormulaSatisfied(formula) FilterCriteriaBuilder 指定した数式(など=B:B<C:C)が評価されるセルを表示するフィルター条件を設定しますtrue
whenNumberBetween(start, end) FilterCriteriaBuilder セル番号が2つの指定された数値の間にある、またはそのいずれかであるセルを表示するフィルター条件を設定します
whenNumberEqualTo(number) FilterCriteriaBuilder セル番号が指定された値に等しいセルを表示するフィルター基準を設定します
whenNumberGreaterThan(number) FilterCriteriaBuilder セル番号が指定された値より大きいセルを表示するフィルター基準を設定します
whenNumberGreaterThanOrEqualTo(number) FilterCriteriaBuilder セル番号が指定された値以上のセルを表示するようにフィルター条件を設定します
whenNumberLessThan(number) FilterCriteriaBuilder セル番号が指定された値よりも小さいセルを表示するように条件付き条件付き書式ルールを設定します
whenNumberLessThanOrEqualTo(number) FilterCriteriaBuilder セル番号が指定値以下のセルを表示するためのフィルター基準を設定します
whenNumberNotBetween(start, end) FilterCriteriaBuilder セル番号が2つの指定された数値の間に収まらず、どちらでもないセルを表示するようにフィルター条件を設定します
whenNumberNotEqualTo(number) FilterCriteriaBuilder セル番号が指定された値と等しくないセルを表示するためのフィルター基準を設定します
whenTextContains(text) FilterCriteriaBuilder セルテキストに指定されたテキストが含まれるセルを表示するフィルター条件を設定します
whenTextDoesNotContain(text) FilterCriteriaBuilder セルテキストに指定されたテキストが含まれていないセルを表示するようにフィルター条件を設定します
whenTextEndsWith(text) FilterCriteriaBuilder セルテキストが指定したテキストで終わるセルを表示するためのフィルター条件を設定します
whenTextEqualTo(text) FilterCriteriaBuilder セルテキストが指定されたテキストと等しいセルを表示するようにフィルター条件を設定します
whenTextStartsWith(text) FilterCriteriaBuilder セルテキストが指定されたテキストで始まるセルを表示するフィルター条件を設定します
withCriteria(criteria, args) FilterCriteriaBuilder 定義された基準にブール条件を設定しarguments既存の基準

GradientCondition

メソッド

メソッド 戻りタイプ 簡単な説明
getMaxColor() String このグラデーション条件の最大値に設定された色を取得します
getMaxColorObject() Color このグラデーション条件の最大値に設定された色を取得します
getMaxType() InterpolationType この勾配条件の最大値の補間タイプを取得します
getMaxValue() String この勾配条件の最大値を取得します
getMidColor() String このグラデーション条件の中間値に設定された色を取得します
getMidColorObject() Color このグラデーション条件の中点値に設定された色を取得します
getMidType() InterpolationType この勾配条件の中点値の補間タイプを取得します
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.

Group

メソッド

Method Return type Brief description
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.

GroupControlTogglePosition

プロパティ

Property Type Description
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).

InterpolationType

プロパティ

Property Type Description
NUMBER Enum Use the number as as specific interpolation point for a gradient condition.
PERCENT Enum 勾配条件のパーセンテージ補間ポイントとして数値を使用します
PERCENTILE Enum 数値を勾配条件のパーセンタイル補間点として使用します
MIN Enum 勾配条件の特定の補間点として最小数を推測します
MAX Enum 勾配条件の特定の補間点として最大数を推測します

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を取得しますnullURLが利用できない場合に返します
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 この画像の実際の幅をピクセル単位で設定します

PageProt

PivotFilter

メソッド

メソッド 戻りタイプ 簡単な説明
getFilterCriteria() FilterCriteria このピボットフィルターのフィルター条件を返します
getPivotTable() PivotTable PivotTableこのフィルターが属するを返します
getSourceDataColumn() Integer このフィルターが動作するソースデータ列の数を返します
remove() void このピボットフィルターをピボットテーブルから削除します
setFilterCriteria(filterCriteria) PivotFilter このピボットフィルターのフィルター条件を設定します

PivotGroup

メソッド

メソッド 戻りタイプ 簡単な説明
addManualGroupingRule(groupName, groupMembers) PivotGroup このピボットグループの手動グループ化ルールを追加します
areLabelsRepeated() Boolean ラベルが繰り返し表示されるかどうかを返します
clearGroupingRule() PivotGroup このピボットグループからグループ化ルールを削除します
clearSort() PivotGroup このグループに適用されている並べ替えを削除します
getDimension() Dimension これが行グループか列グループかを返します
getIndex() Integer 現在のグループ順でこのピボットグループのインデックスを返します
getPivotTable() PivotTable PivotTableこのグループが属するグループを返します
getSourceDataColumn() Integer このグループが要約するソースデータ列の数を返します
hideRepeatedLabels() PivotGroup このグループの繰り返しラベルを非表示にします
isSortAscending() Boolean Returns true if the sort is ascending, returns false if the sort order is descending.
moveToIndex(index) 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(groupName) 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.
setDisplayName(name) PivotGroup Sets the display name of this group in the pivot table.
setHistogramGroupingRule(minValue, maxValue, intervalSize) 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(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(value, oppositeGroupValues) 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.

PivotTable

メソッド

Method Return type Brief description
addCalculatedPivotValue(name, formula) PivotValue Creates a new pivot value in the pivot table calculated from the specified formula with the specified name.
addColumnGroup(sourceDataColumn) PivotGroup Defines a new pivot column grouping in the pivot table.
addFilter(sourceDataColumn, filterCriteria) PivotFilter Creates a new pivot filter for the pivot table.
addPivotValue(sourceDataColumn, summarizeFunction) PivotValue Defines a new pivot value in the pivot table with the specified summarizeFunction.
addRowGroup(sourceDataColumn) PivotGroup Defines a new pivot row grouping in the pivot table.
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.
getValuesDisplayOrientation() Dimension Returns whether values are displayed as rows or columns.
remove() void Deletes this pivot table.
setValuesDisplayOrientation(dimension) PivotTable Sets the layout of this pivot table to display values as columns or rows.

PivotTableSummarizeFunction

プロパティ

Property Type Description
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

PivotValue

メソッド

Method Return type Brief description
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.
getSummarizedBy() PivotTableSummarizeFunction Returns this group’s summarization function.
setDisplayName(name) PivotValue Sets the display name for this value in the pivot table.
setFormula(formula) PivotValue Sets the formula used to calculate this value.
showAs(displayType) PivotValue Displays this value in the pivot table as a function of another value.
summarizeBy(summarizeFunction) PivotValue Sets the summarization function.

PivotValueDisplayType

プロパティ

Property Type Description
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.

Protection

メソッド

Method Return type Brief description
addEditor(emailAddress) Protection Adds the given user to the list of editors for the protected sheet or range.
addEditor(user) Protection Adds the given user to the list of editors for the protected sheet or range.
addEditors(emailAddresses) Protection Adds the given array of users to the list of editors for the protected sheet or 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 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.
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(emailAddress) Protection Removes the given user from the list of editors for the protected sheet or range.
removeEditor(user) Protection Removes the given user from the list of editors for the protected sheet or range.
removeEditors(emailAddresses) Protection Removes the given array of users from the list of editors for the protected sheet or range.
setDescription(description) Protection Sets the description of the protected range or sheet.
setDomainEdit(editable) Protection Sets whether all users in the domain that owns the spreadsheet have permission to edit the protected range or sheet.
setNamedRange(namedRange) Protection Associates the protected range with an existing named range.
setRange(range) Protection Adjusts the range that is being protected.
setRangeName(rangeName) Protection Associates the protected range with an existing named range.
setUnprotectedRanges(ranges) Protection Unprotects the given array of ranges within a protected sheet.
setWarningOnly(warningOnly) Protection Sets whether or not this protected range is using "warning based" protection.

ProtectionType

プロパティ

Property Type Description
RANGE Enum Protection for a range.
SHEET Enum Protection for a sheet.

Range

メソッド

Method Return type Brief description
activate() Range Sets the specified range as the current cell.
activateAsCurrentCell() Range Sets the specified cell as the current cell.
addDeveloperMetadata(key) Range Adds developer metadata with the specified key to the range.
addDeveloperMetadata(key, visibility) Range Adds developer metadata with the specified key and visibility to the range.
addDeveloperMetadata(key, value) Range Adds developer metadata with the specified key and value to the range.
addDeveloperMetadata(key, value, visibility) Range Adds developer metadata with the specified key, value, and visibility to the range.
applyColumnBanding() Banding Applies a default column banding theme to the range.
applyColumnBanding(bandingTheme) Banding Applies a specified column banding theme to the range.
applyColumnBanding(bandingTheme, showHeader, showFooter) Banding Applies a specified column banding theme to the range with specified header and footer settings.
applyRowBanding() Banding Applies a default row banding theme to the range.
applyRowBanding(bandingTheme) Banding Applies a specified row banding theme to the range.
applyRowBanding(bandingTheme, showHeader, showFooter) Banding Applies a specified row banding theme to the range with specified header and footer settings.
autoFill(destination, series) void Fills the destinationRange with data based on the data in this range.
autoFillToNeighbor(series) void Calculates 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.
breakApart() Range Break any multi-column cells in the range into individual cells again.
canEdit() Boolean Determines whether the user has permission to edit every cell in the range.
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 範囲のコンテンツを指定された場所にコピーします
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つのカーディナルDirectionsで拡張された範囲のコピーを返し、データが含まれるすべての隣接セルをカバーします
getDataRegion(dimension) Range 戻り値の範囲のコピーが拡大し、指定された次元がある場合、またはおよび寸法がある場合Dimension.COLUMNS
getDataSourceTables() DataSourceTable[] 範囲と交差するすべてのデータソーステーブルを取得します
getDataSourceUrl() String この範囲のデータのURLを返しますこれを使用して、グラフとクエリを作成できます
getDataTable() DataTable このオブジェクト内のデータをDataTableとして返します
getDataTable(firstRowIsHeader) DataTable この範囲内のデータをDataTableとして返します
getDataValidation() DataValidation 範囲内の左上のセルのデータ検証ルールを返します
getDataValidations() DataValidation[][] 範囲内のすべてのセルのデータ検証ルールを返します
getDeveloperMetadata() DeveloperMetadata[] この範囲に関連付けられた開発者メタデータを取得します
getDisplayValue() String 範囲内の左上のセルの表示値を返します
getDisplayValues() String[][] この範囲の値の長方形グリッドを返します
getFilter() Filter Returns the filter in the sheet this range belongs to, or null if there is no filter on the sheet.
getFontColor() String Returns the font color of the cell in the top-left corner of the range, in CSS notation (such as '#ffffff' or 'white').
getFontColorObject() Color Returns the font color of the cell in the top-left corner of the range.
getFontColorObjects() Color[][] Returns the font colors of the cells in the range.
getFontColors() String[][] Returns the font colors of the cells in the range in CSS notation (such as '#ffffff' or 'white').
getFontFamilies() String[][] Returns the font families of the cells in the range.
getFontFamily() String Returns the font family of the cell in the top-left corner of the range.
getFontLine() String Gets the line style of the cell in the top-left corner of the range ('underline', 'line-through', or 'none').
getFontLines() String[][] Gets the line style of the cells in the range ('underline', 'line-through', or 'none').
getFontSize() Integer Returns the font size in point size of the cell in the top-left corner of the range.
getFontSizes() Integer[][] Returns the font sizes of the cells in the range.
getFontStyle() String Returns the font style ('italic' or 'normal') of the cell in the top-left corner of the range.
getFontStyles() String[][] Returns the font styles of the cells in the range.
getFontWeight() String Returns the font weight (normal/bold) of the cell in the top-left corner of the range.
getFontWeights() String[][] Returns the font weights of the cells in the range.
getFormula() String Returns 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.
getFormulaR1C1() String Returns the formula (R1C1 notation) for a given cell, or null if none.
getFormulas() String[][] Returns the formulas (A1 notation) for the cells in the range.
getFormulasR1C1() String[][] Returns the formulas (R1C1 notation) for the cells in the range.
getGridId() Integer Returns the grid ID of the range's parent sheet.
getHeight() Integer Returns the height of the range.
getHorizontalAlignment() String Returns the horizontal alignment of the text (left/center/right) of the cell in the top-left corner of the range.
getHorizontalAlignments() String[][] Returns the horizontal alignments of the cells in the range.
getLastColumn() Integer Returns the end column position.
getLastRow() Integer Returns the end row position.
getMergedRanges() Range[] 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.
getNextDataCell(direction) Range Starting 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.
getNote() String Returns the note associated with the given range.
getNotes() String[][] Returns the notes associated with the cells in the range.
getNumColumns() Integer Returns the number of columns in this range.
getNumRows() Integer Returns the number of rows in this range.
getNumberFormat() String Get the number or date formatting of the top-left cell of the given range.
getNumberFormats() String[][] Returns the number or date formats for the cells in the range.
getRichTextValue() RichTextValue Returns the Rich Text value for the top left cell of the range, or null if the cell value is not text.
getRichTextValues() RichTextValue[][] Returns the Rich Text values for the cells in the range.
getRow() Integer Returns the row position for this range.
getRowIndex() Integer Returns the row position for this range.
getSheet() Sheet Returns the sheet this range belongs to.
getTextDirection() TextDirection Returns the text direction for the top left cell of the range.
getTextDirections() TextDirection[][] Returns the text directions for the cells in the range.
getTextRotation() TextRotation Returns the text rotation settings for the top left cell of the range.
getTextRotations() TextRotation[][] Returns the text rotation settings for the cells in the range.
getTextStyle() TextStyle Returns the text style for the top left cell of the range.
getTextStyles() TextStyle[][] Returns the text styles for the cells in the range.
getValue() Object Returns the value of the top-left cell in the range.
getValues() Object[][] Returns the rectangular grid of values for this range.
getVerticalAlignment() String Returns the vertical alignment (top/middle/bottom) of the cell in the top-left corner of the range.
getVerticalAlignments() String[][] Returns the vertical alignments of the cells in the range.
getWidth() Integer Returns the width of the range in columns.
getWrap() Boolean Returns the wrapping policy of the cell in the top-left corner of the range.
getWrapStrategies() WrapStrategy[][] Returns the text wrapping strategies for the cells in the range.
getWrapStrategy() WrapStrategy Returns the text wrapping strategy for the top left cell of the range.
getWraps() Boolean[][] Returns the wrapping policy of the cells in the range.
insertCells(shiftDimension) Range Inserts empty cells into this range.
insertCheckboxes() Range Inserts checkboxes into each cell in the range, configured with true for checked and false for unchecked.
insertCheckboxes(checkedValue) Range Inserts checkboxes into each cell in the range, configured with a custom value for checked and the empty string for unchecked.
insertCheckboxes(checkedValue, uncheckedValue) Range Inserts checkboxes into each cell in the range, configured with custom values for the checked and unchecked states.
isBlank() Boolean Returns true if the range is totally blank.
isChecked() Boolean Returns whether all cells in the range have their checkbox state as 'checked'.
isEndColumnBounded() Boolean Determines whether the end of the range is bound to a particular column.
isEndRowBounded() Boolean Determines whether the end of the range is bound to a particular row.
isPartOfMerge() Boolean Returns true if the cells in the current range overlap any merged cells.
isStartColumnBounded() Boolean Determines whether the start of the range is bound to a particular column.
isStartRowBounded() Boolean Determines whether the start of the range is bound to a particular row.
merge() Range Merges the cells in the range together into a single block.
mergeAcross() Range Merge the cells in the range across the columns of the range.
mergeVertically() Range Merges the cells in the range together.
moveTo(target) void Cut and paste (both format and values) from this range to the target range.
offset(rowOffset, columnOffset) Range Returns a new range that is offset from this range by the given number of rows and columns (which can be negative).
offset(rowOffset, columnOffset, numRows) Range Returns a new range that is relative to the current range, whose upper left point is offset from the current range by the given rows and columns, and with the given height in cells.
offset(rowOffset, columnOffset, numRows, numColumns) Range Returns a new range that is relative to the current range, whose upper left point is offset from the current range by the given rows and columns, and with the given height and width in cells.
protect() Protection Creates an object that can protect the range from being edited except by users who have permission.
randomize() Range Randomizes the order of the rows in the given range.
removeCheckboxes() Range Removes all checkboxes from the range.
removeDuplicates() Range Removes rows within this range that contain values that are duplicates of values in any previous row.
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

メソッド

メソッド 戻りタイプ 簡単な説明
activate() RangeList Rangeインスタンスのリストを選択します
breakApart() RangeList 範囲リスト内に含まれる水平方向または垂直方向に結合されたセルをすべて個別のセルに再度分割します
check() RangeList 範囲内のチェックボックスの状態を「チェック済み」に変更します
clear() RangeList Range範囲リスト内のそれぞれのコンテンツ、フォーマット、およびデータ検証ルールの範囲をクリアします
clear(options) RangeList 指定されたオプションで指定されたコンテンツ、フォーマット、データ検証ルール、コメントの範囲をクリアします
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.
insertCheckboxes(checkedValue) RangeList Inserts checkboxes into each cell in the range, configured with a custom value for checked and the empty string for unchecked.
insertCheckboxes(checkedValue, uncheckedValue) RangeList Inserts checkboxes into each cell in the range, configured with custom values for the checked and unchecked states.
removeCheckboxes() RangeList Removes all checkboxes from the range.
setBackground(color) RangeList Sets the background color for each Range in the range list.
setBackgroundRGB(red, green, blue) RangeList Sets the background to the given RGB color.
setBorder(top, left, bottom, right, vertical, horizontal) RangeList Sets the border property for each Range in the range list.
setBorder(top, left, bottom, right, vertical, horizontal, color, style) RangeList Sets the border property with color and/or style for each Range in the range list.
setFontColor(color) RangeList Sets the font color for each Range in the range list.
setFontFamily(fontFamily) RangeList Sets the font family for each Range in the range list.
setFontLine(fontLine) RangeList Sets the font line style for each Range in the range list.
setFontSize(size) RangeList Sets the font size (in points) for each Range in the range list.
setFontStyle(fontStyle) RangeList Set the font style for each Range in the range list.
setFontWeight(fontWeight) RangeList Set the font weight for each Range in the range list.
setFormula(formula) RangeList Updates the formula for each Range in the range list.
setFormulaR1C1(formula) RangeList Updates the formula for each Range in the range list.
setHorizontalAlignment(alignment) RangeList Set the horizontal alignment for each Range in the range list.
setNote(note) RangeList Sets the note text for each Range in the range list.
setNumberFormat(numberFormat) RangeList Sets the number or date format for each Range in the range list.
setShowHyperlink(showHyperlink) RangeList Sets whether or not each Range in the range list should show hyperlinks.
setTextDirection(direction) RangeList Sets the text direction for the cells in each Range in the range list.
setTextRotation(degrees) RangeList Sets the text rotation settings for the cells in each Range in the range list.
setValue(value) RangeList Sets the value for each Range in the range list.
setVerticalAlignment(alignment) RangeList Set the vertical alignment for each Range in the range list.
setVerticalText(isVertical) RangeList Sets whether or not to stack the text for the cells for each Range in the range list.
setWrap(isWrapEnabled) RangeList Set text wrapping for each Range in the range list.
setWrapStrategy(strategy) 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”.

RecalculationInterval

プロパティ

Property Type Description
ON_CHANGE Enum Recalculate only when values are changed.
MINUTE Enum Recalculate when values are changed, and every minute.
HOUR Enum Recalculate when values are changed, and every hour.

RelativeDate

プロパティ

Property Type Description
TODAY Enum Dates compared against the current date.
TOMORROW Enum Dates compared against the date after the current date.
YESTERDAY Enum Dates compared against the date before the current date.
PAST_WEEK Enum Dates that fall within the past week period.
PAST_MONTH Enum Dates that fall within the past month period.
PAST_YEAR Enum Dates that fall within the past year period.

RichTextValue

メソッド

Method Return type Brief description
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.
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.
getTextStyle(startOffset, endOffset) TextStyle Returns the text style of the text from startOffset to endOffset.

RichTextValueBuilder

メソッド

Method Return type Brief description
build() RichTextValue Creates a Rich Text value from this builder.
setText(text) RichTextValueBuilder Sets the text for this value and clears any existing text style.
setTextStyle(startOffset, endOffset, textStyle) RichTextValueBuilder Applies a text style to the given substring of this value.
setTextStyle(textStyle) RichTextValueBuilder Applies a text style to the entire value.

Selection

メソッド

Method Return type Brief description
getActiveRange() Range Returns the selected range in the active sheet, or null if there is no active range.
getActiveRangeList() RangeList Returns the list of active ranges in the active sheet or null if there are no active ranges.
getActiveSheet() Sheet Returns the active sheet in the spreadsheet.
getCurrentCell() Range Returns the current (highlighted) cell that is selected in one of the active ranges or null if there is no current cell.
getNextDataRange(direction) Range Starting from the next data cell while still covering the current cell.

Sheet

メソッド

Method Return type Brief description
activate() Sheet Activates this sheet.
addDeveloperMetadata(key) Sheet Adds developer metadata with the specified key to the sheet.
addDeveloperMetadata(key, visibility) Sheet Adds developer metadata with the specified key and visibility to the sheet.
addDeveloperMetadata(key, value) Sheet Adds developer metadata with the specified key and value to the sheet.
addDeveloperMetadata(key, value, visibility) Sheet Adds developer metadata with the specified key, value, and visibility to the sheet.
appendRow(rowContents) Sheet Appends a row to the spreadsheet.
autoResizeColumn(columnPosition) Sheet Sets the width of the given column to fit its contents.
autoResizeColumns(startColumn, numColumns) Sheet Sets the width of all columns starting at the given column position to fit their contents.
autoResizeRows(startRow, numRows) Sheet Sets the height of all rows starting at the given row position to fit their contents.
clear() Sheet Clears the sheet of content and formatting information.
clear(options) Sheet Clears the sheet of contents and/or format, as specified with the given advanced options.
clearConditionalFormatRules() void Removes all conditional format rules from the sheet.
clearContents() Sheet Clears the sheet of contents, while preserving formatting information.
clearFormats() Sheet Clears the sheet of formatting, while preserving contents.
clearNotes() Sheet Clears the sheet of all notes.
collapseAllColumnGroups() Sheet Collapses all column groups on the sheet.
collapseAllRowGroups() Sheet Collapses all row groups on the sheet.
copyTo(spreadsheet) Sheet Copies the sheet to a given spreadsheet, which can be the same spreadsheet as the source.
createDeveloperMetadataFinder() DeveloperMetadataFinder Returns a DeveloperMetadataFinder for finding developer metadata within the scope of this sheet.
createTextFinder(findText) TextFinder Creates a text finder for the sheet, which can find and replace text within the sheet.
deleteColumn(columnPosition) Sheet Deletes the column at the given column position.
deleteColumns(columnPosition, howMany) void Deletes a number of columns starting at the given column position.
deleteRow(rowPosition) Sheet Deletes the row at the given row position.
deleteRows(rowPosition, howMany) void Deletes a number of rows starting at the given row position.
expandAllColumnGroups() Sheet Expands all column groups on the sheet.
expandAllRowGroups() Sheet Expands all row groups on the sheet.
expandColumnGroupsUpToDepth(groupDepth) Sheet Expands all column groups up to the given depth, and collapses all others.
expandRowGroupsUpToDepth(groupDepth) Sheet Expands all row groups up to the given depth, and collapses all others.
getActiveCell() Range Returns the active cell in this sheet.
getActiveRange() Range Returns the selected range in the active sheet, or null if there is no active range.
getActiveRangeList() RangeList Returns the list of active ranges in the active sheet or null if there are no active ranges.
getBandings() Banding[] Returns all the bandings in this sheet.
getCharts() EmbeddedChart[] Returns an array of charts on this sheet.
getColumnGroup(columnIndex, groupDepth) Group Returns the column group at the given index and group depth.
getColumnGroupControlPosition() GroupControlTogglePosition Returns the GroupControlTogglePosition for all column groups on the sheet.
getColumnGroupDepth(columnIndex) Integer Returns the group depth of the column at the given index.
getColumnWidth(columnPosition) Integer Gets the width in pixels of the given column.
getConditionalFormatRules() ConditionalFormatRule[] Get all conditional format rules in this sheet.
getCurrentCell() Range Returns the current cell in the active sheet or null if there is no current cell.
getDataRange() Range Returns a Range corresponding to the dimensions in which data is present.
getDataSourceTables() DataSourceTable[] Gets all the data source tables.
getDeveloperMetadata() DeveloperMetadata[] Get all developer metadata associated with this sheet.
getFilter() Filter Returns the filter in this sheet, or null if there is no filter.
getFormUrl() String Returns the URL for the form that sends its responses to this sheet, or null if this sheet has no associated form.
getFrozenColumns() Integer Returns the number of frozen columns.
getFrozenRows() Integer Returns the number of frozen rows.
getImages() OverGridImage[] Returns all over-the-grid images on the sheet.
getIndex() Integer Gets the position of the sheet in its parent spreadsheet.
getLastColumn() Integer Returns the position of the last column that has content.
getLastRow() Integer Returns the position of the last row that has content.
getMaxColumns() Integer Returns the current number of columns in the sheet, regardless of content.
getMaxRows() Integer Returns the current number of rows in the sheet, regardless of content.
getName() String Returns the name of the sheet.
getNamedRanges() NamedRange[] Gets all the named ranges in this sheet.
getParent() Spreadsheet Returns the Spreadsheet that contains this sheet.
getPivotTables() PivotTable[] Returns all the pivot tables on this sheet.
getProtections(type) Protection[] Gets an array of objects representing all protected ranges in the sheet, or a single-element array representing the protection on the sheet itself.
getRange(row, column) Range Returns the range with the top left cell at the given coordinates.
getRange(row, column, numRows) Range Returns the range with the top left cell at the given coordinates, and with the given number of rows.
getRange(row, column, numRows, numColumns) Range Returns the range with the top left cell at the given coordinates with the given number of rows and columns.
getRange(a1Notation) Range Returns the range as specified in A1 notation or R1C1 notation.
getRangeList(a1Notations) RangeList Returns the RangeList collection representing the ranges in the same sheet specified by a non-empty list of A1 notations or R1C1 notations.
getRowGroup(rowIndex, groupDepth) Group Returns the row group at the given index and group depth.
getRowGroupControlPosition() GroupControlTogglePosition Returns the GroupControlTogglePosition for all row groups on the sheet.
getRowGroupDepth(rowIndex) Integer Returns the group depth of the row at the given index.
getRowHeight(rowPosition) Integer Gets the height in pixels of the given row.
getSelection() Selection Returns the current Selection in the spreadsheet.
getSheetId() Integer Returns the ID of the sheet represented by this object.
getSheetName() String Returns the sheet name.
getSheetValues(startRow, startColumn, numRows, numColumns) Object[][] Returns the rectangular grid of values for this range starting at the given coordinates.
getSlicers() Slicer[] Returns an array of slicers on the sheet.
getTabColor() String Gets the sheet tab color, or null if the sheet tab has no color.
getTabColorObject() Color Gets the sheet tab color, or null if the sheet tab has no color.
getType() SheetType Returns the type of the sheet.
hasHiddenGridlines() Boolean Returns true if the sheet's gridlines are hidden; otherwise returns false.
hideColumn(column) void Hides the columns in the given range.
hideColumns(columnIndex) void Hides the column at the given index.
hideColumns(columnIndex, numColumns) void Hides one or more consecutive columns starting at the given index.
hideRow(row) void Hides the rows in the given range.
hideRows(rowIndex) void Hides the row at the given index.
hideRows(rowIndex, numRows) void Hides one or more consecutive rows starting at the given index.
hideSheet() Sheet Hides this sheet.
insertChart(chart) void Adds a new chart to this sheet.
insertColumnAfter(afterPosition) Sheet Inserts a column after the given column position.
insertColumnBefore(beforePosition) Sheet Inserts a column before the given column position.
insertColumns(columnIndex) void Inserts a blank column in a sheet at the specified location.
insertColumns(columnIndex, numColumns) void Inserts one or more consecutive blank columns in a sheet starting at the specified location.
insertColumnsAfter(afterPosition, howMany) Sheet Inserts a number of columns after the given column position.
insertColumnsBefore(beforePosition, howMany) Sheet 指定された列位置の前にいくつかの列を挿入します
insertImage(blobSource, column, row) OverGridImage BlobSource文書の特定の行と列にaを画像として挿入します
insertImage(blobSource, column, row, offsetX, offsetY) OverGridImage BlobSourceピクセルオフセットを使用して、ドキュメントの特定の行と列に画像としてを挿入します
insertImage(url, column, row) OverGridImage 文書の特定の行と列に画像を挿入します
insertImage(url, column, row, offsetX, offsetY) OverGridImage ピクセルオフセットを使用して、ドキュメントの指定された行と列に画像を挿入します
insertRowAfter(afterPosition) Sheet 指定された行位置の後に行を挿入します
insertRowBefore(beforePosition) Sheet 指定された行位置の前に行を挿入します
insertRows(rowIndex) void シートの指定された場所に空白行を挿入します
insertRows(rowIndex, numRows) void 指定された位置から始まる1つ以上の連続した空白行をシートに挿入します
insertRowsAfter(afterPosition, howMany) Sheet 指定された行位置の後に複数の行を挿入します
insertRowsBefore(beforePosition, howMany) Sheet 指定された行位置の前に複数の行を挿入します
insertSlicer(range, anchorRowPos, anchorColPos) Slicer このシートに新しいスライサーを追加します
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY) Slicer このシートに新しいスライサーを追加します
isColumnHiddenByUser(columnPosition) Boolean 指定された列がユーザーによって非表示になっているかどうかを返します
isRightToLeft() Boolean trueこのシートレイアウトが右から左かどうかを返します
isRowHiddenByFilter(rowPosition) Boolean 指定された行がフィルター(フィルタービューではなく)によって非表示になっているかどうかを返します
isRowHiddenByUser(rowPosition) Boolean 指定された行がユーザーによって非表示になっているかどうかを返します
isSheetHidden() Boolean trueシートが現在非表示かどうかを返します
moveColumns(columnSpec, destinationIndex) void 指定された範囲で選択された列を、で示される位置に移動しますdestinationIndex
moveRows(rowSpec, destinationIndex) void 指定された範囲で選択された行を、で示される位置に移動しますdestinationIndex
newChart() EmbeddedChartBuilder このシートの新しいグラフを作成するビルダーを返します
protect() Protection 権限を持つユーザー以外によるシートの編集を保護できるオブジェクトを作成します
removeChart(chart) void 親シートからチャートを削除します
setActiveRange(range) Range 指定した範囲をcurrent cellます
setActiveRangeList(rangeList) RangeList 指定された範囲のリストをactive rangesアクティブシートのように設定します
setActiveSelection(range) Range このシートのアクティブな選択領域を設定します
setActiveSelection(a1Notation) Range A1表記またはR1C1表記で指定されているように、アクティブな選択を設定します
setColumnGroupControlPosition(position) Sheet シート上の列グループコントロールトグルの位置を設定します
setColumnWidth(columnPosition, width) Sheet 指定された列の幅をピクセル単位で設定します
setColumnWidths(startColumn, numColumns, width) Sheet 指定された列の幅をピクセル単位で設定します
setConditionalFormatRules(rules) void シートに現在存在するすべての条件付き書式ルールを入力ルールに置き換えます
setCurrentCell(cell) Range 指定されたセルをとして設定しますcurrent cell
setFrozenColumns(columns) void 指定された数の列を固定します
setFrozenRows(rows) void 指定された行数を固定します
setHiddenGridlines(hideGridlines) Sheet シートのグリッド線を非表示または表示します
setName(name) Sheet シート名を設定します
setRightToLeft(rightToLeft) Sheet シートレイアウトを右から左に設定または設定解除します
setRowGroupControlPosition(position) Sheet シート上の行グループコントロールトグルの位置を設定します
setRowHeight(rowPosition, height) Sheet 指定された行の行の高さをピクセル単位で設定します
setRowHeights(startRow, numRows, height) Sheet 指定された行の高さをピクセル単位で設定します
setTabColor(color) Sheet シートのタブの色を設定します
setTabColorObject(color) Sheet シートのタブの色を設定します
showColumns(columnIndex) void 指定されたインデックスの列を再表示します
showColumns(columnIndex, numColumns) void 指定されたインデックスで始まる1つ以上の連続した列を再表示します
showRows(rowIndex) void 指定されたインデックスの行を再表示します
showRows(rowIndex, numRows) void 指定されたインデックスで始まる1つ以上の連続する行を再表示します
showSheet() Sheet シートを表示します
sort(columnPosition) Sheet 列ごとにシートを昇順で並べ替えます
sort(columnPosition, ascending) Sheet 列でシートを並べ替えます
unhideColumn(column) void 指定された範囲の列を再表示します
unhideRow(row) void 指定された範囲の行を再表示します
updateChart(chart) void このシートのチャートを更新します

SheetType

プロパティ

物件 タイプ 説明
GRID Enum グリッドを含むシート
OBJECT Enum などの単一の埋め込みオブジェクトを含むシートEmbeddedChart

Slicer

メソッド

メソッド 戻りタイプ 簡単な説明
getBackgroundColor() String CSS表記( '#ffffff'など)でスライサーの背景色を返します
getBackgroundColorObject() Color Colorスライサーの背景を返します
getColumnPosition() Integer スライサーでフィルターが適用される列の位置(スライサーのデータ範囲に対する)を返しますnull列の位置が設定されていない場合
getContainerInfo() ContainerInfo スライサーがシートのどこに配置されているかに関する情報を取得します
getFilterCriteria() FilterCriteria スライサーのフィルター条件を返しますnullフィルター条件が設定されていない場合
getRange() Range スライサーが適用されるデータ範囲を取得します
getTitle() String スライサーのタイトルを返します
getTitleHorizontalAlignment() String タイトルの水平方向の配置を取得します
getTitleTextStyle() TextStyle スライサーのタイトルのテキストスタイルを返します
isAppliedToPivotTables() Boolean 指定されたスライサーがピボットテーブルに適用されるかどうかを返します
remove() void スライサーを削除します
setApplyToPivotTables(applyToPivotTables) Slicer 指定したスライサーをワークシートのピボットテーブルに適用するかどうかを設定します
setBackgroundColor(color) Slicer スライサーの背景色を設定します
setBackgroundColorObject(color) Slicer Colorスライサーの背景を設定します
setColumnFilterCriteria(columnPosition, filterCriteria) Slicer スライサーの列インデックスとフィルター条件を設定します
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) Slicer スライサーがシート上に表示される位置を設定します
setRange(rangeApi) Slicer スライサーが適用されるデータ範囲を設定します
setTitle(title) Slicer スライサーのタイトルを設定します
setTitleHorizontalAlignment(horizontalAlignment) Slicer スライサーのタイトルの水平方向の配置を設定します
setTitleTextStyle(textStyle) Slicer スライサーのテキストスタイルを設定します

Spreadsheet

メソッド

メソッド 戻りタイプ 簡単な説明
addDeveloperMetadata(key) Spreadsheet 指定されたキーを持つ開発者メタデータをトップレベルのスプレッドシートに追加します
addDeveloperMetadata(key, visibility) Spreadsheet 指定したキーと可視性を持つ開発者メタデータをスプレッドシートに追加します
addDeveloperMetadata(key, value) Spreadsheet 指定したキーと値を持つ開発者メタデータをスプレッドシートに追加します
addDeveloperMetadata(key, value, visibility) Spreadsheet 指定したキー、値、および可視性を持つ開発者メタデータをスプレッドシートに追加します
addEditor(emailAddress) Spreadsheet 指定されたユーザーをのエディターのリストに追加しますSpreadsheet
addEditor(user) Spreadsheet 指定されたユーザーをのエディターのリストに追加しますSpreadsheet
addEditors(emailAddresses) Spreadsheet 指定されたユーザーの配列をのエディターのリストに追加しSpreadsheetます
addMenu(name, subMenus) void スプレッドシートUIに新しいメニューを作成します
addViewer(emailAddress) Spreadsheet 指定されたユーザーをの視聴者リストに追加しますSpreadsheet
addViewer(user) Spreadsheet 指定されたユーザーをの視聴者リストに追加しますSpreadsheet
addViewers(emailAddresses) Spreadsheet 指定されたユーザーの配列をの視聴者のリストに追加しSpreadsheetます
appendRow(rowContents) Sheet スプレッドシートに行を追加します
autoResizeColumn(columnPosition) Sheet 指定された列の幅を内容に合わせて設定します
copy(name) Spreadsheet スプレッドシートをコピーして、新しいものを返します
createDeveloperMetadataFinder() DeveloperMetadataFinder DeveloperMetadataFinderこのスプレッドシートの範囲内で開発者メタデータを検索するためのを返します
createTextFinder(findText) TextFinder スプレッドシートのテキストファインダを作成しますこれを使用して、スプレッドシート内のテキストを検索および置換できます
deleteActiveSheet() Sheet 現在アクティブなシートを削除します
deleteColumn(columnPosition) Sheet 指定された列位置の列を削除します
deleteColumns(columnPosition, howMany) void 指定された列の位置から始まるいくつかの列を削除します
deleteRow(rowPosition) Sheet 指定された行位置の行を削除します
deleteRows(rowPosition, howMany) void 指定された行位置から始まる行を削除します
deleteSheet(sheet) void 指定したシートを削除します
duplicateActiveSheet() Sheet アクティブシートを複製し、アクティブシートにします
getActiveCell() Range このシートのアクティブセルを返します
getActiveRange() Range アクティブなシートで選択した範囲を返しますnullアクティブな範囲がない場合
getActiveRangeList() RangeList アクティブなシート内のアクティブな範囲のリストを返しますnullアクティブな範囲がない場合
getActiveSheet() Sheet スプレッドシートのアクティブシートを取得します
getAs(contentType) Blob このオブジェクト内のデータを、指定されたコンテンツタイプに変換されたblobとして返します
getBandings() Banding[] このスプレッドシートのすべてのバンディングを返します
getBlob() Blob このオブジェクト内のデータをblobとして返します
getColumnWidth(columnPosition) Integer 指定された列の幅をピクセル単位で取得します
getCurrentCell() Range アクティブシートの現在のセルを返しますnull現在のセルがない場合は返します
getDataRange() Range Rangeデータが存在するディメンションに対応するを返します
getDataSourceTables() DataSourceTable[] すべてのデータソーステーブルを取得します
getDeveloperMetadata() DeveloperMetadata[] トップレベルのスプレッドシートに関連付けられた開発者のメタデータを取得します
getEditors() User[] こののエディターのリストを取得しますSpreadsheet
getFormUrl() String 回答をこのスプレッドシートに送信するフォームのURLを返しますnullこのスプレッドシートにフォームが関連付けられていない場合
getFrozenColumns() Integer 固定列の数を返します
getFrozenRows() Integer 凍結された行の数を返します
getId() String このスプレッドシートの一意の識別子を取得します
getImages() OverGridImage[] シート上のすべてのグリッド上の画像を返します
getIterativeCalculationConvergenceThreshold() Number 反復計算中に使用されるしきい値を返します
getLastColumn() Integer コンテンツがある最後の列の位置を返します
getLastRow() Integer コンテンツがある最後の行の位置を返します
getMaxIterativeCalculationCycles() Integer 反復計算中に使用する反復の最大数を返します
getName() String ドキュメントの名前を取得します
getNamedRanges() NamedRange[] このスプレッドシートのすべての名前付き範囲を取得します
getNumSheets() Integer このスプレッドシートのシートの数を返します
getOwner() User ドキュメントの所有者、またはnull共有ドライブ内のドキュメントの所有者を返します
getPredefinedSpreadsheetThemes() SpreadsheetTheme[] 事前定義されたテーマのリストを返します
getProtections(type) Protection[] スプレッドシート内のすべての保護範囲またはシートを表すオブジェクトの配列を取得します
getRange(a1Notation) Range A1表記またはR1C1表記で指定された範囲を返します
getRangeByName(name) Range 名前付き範囲を返します指定された名前の範囲nullが見つからない場合
getRangeList(a1Notations) RangeList RangeListA1表記またはR1C1表記の空でないリストで指定された同じシート内の範囲を表すコレクションを返します
getRecalculationInterval() RecalculationInterval このスプレッドシートの計算間隔を返します
getRowHeight(rowPosition) Integer 指定された行の高さをピクセル単位で取得します
getSelection() Selection Selectionスプレッドシートの現在の値を返します
getSheetByName(name) Sheet 指定された名前のシートを返します
getSheetId() Integer このオブジェクトによって表されるシートのIDを返します
getSheetName() String シート名を返します
getSheetValues(startRow, startColumn, numRows, numColumns) Object[][] 指定された座標から始まるこの範囲の値の長方形グリッドを返します
getSheets() Sheet[] このスプレッドシートのすべてのシートを取得します
getSpreadsheetLocale() String スプレッドシートのロケールを取得します
getSpreadsheetTheme() SpreadsheetTheme スプレッドシートの現在のテーマを返しますnullテーマが適用されていない場合
getSpreadsheetTimeZone() String スプレッドシートのタイムゾーンを取得します
getUrl() String 指定されたスプレッドシートのURLを返します
getViewers() User[] このの閲覧者とコメント投稿者のリストを取得しますSpreadsheet
hideColumn(column) void 指定された範囲の列を非表示にします
hideRow(row) void 指定された範囲の行を非表示にします
insertColumnAfter(afterPosition) Sheet 指定された列位置の後に列を挿入します
insertColumnBefore(beforePosition) Sheet 指定された列位置の前に列を挿入します
insertColumnsAfter(afterPosition, howMany) Sheet 指定された列位置の後にいくつかの列を挿入します
insertColumnsBefore(beforePosition, howMany) Sheet 指定された列位置の前にいくつかの列を挿入します
insertImage(blobSource, column, row) OverGridImage Spreadsheet文書の特定の行と列にaを画像として挿入します
insertImage(blobSource, column, row, offsetX, offsetY) OverGridImage Spreadsheetピクセルオフセットを使用して、ドキュメントの特定の行と列に画像としてを挿入します
insertImage(url, column, row) OverGridImage 文書の特定の行と列に画像を挿入します
insertImage(url, column, row, offsetX, offsetY) OverGridImage ピクセルオフセットを使用して、ドキュメントの指定された行と列に画像を挿入します
insertRowAfter(afterPosition) Sheet 指定された行位置の後に行を挿入します
insertRowBefore(beforePosition) Sheet 指定された行位置の前に行を挿入します
insertRowsAfter(afterPosition, howMany) Sheet 指定された行位置の後に複数の行を挿入します
insertRowsBefore(beforePosition, howMany) Sheet 指定された行位置の前に複数の行を挿入します
insertSheet() Sheet デフォルトのシート名を使用して、スプレッドシートに新しいシートを挿入します
insertSheet(sheetIndex) Sheet 指定したインデックスでスプレッドシートに新しいシートを挿入します
insertSheet(sheetIndex, options) Sheet 指定したインデックスでスプレッドシートに新しいシートを挿入し、オプションの高度な引数を使用します
insertSheet(options) Sheet デフォルトのシート名とオプションの拡張引数を使用して、スプレッドシートに新しいシートを挿入します
insertSheet(sheetName) Sheet 指定した名前で新しいシートをスプレッドシートに挿入します
insertSheet(sheetName, sheetIndex) Sheet 指定されたインデックスで指定された名前で新しいシートをスプレッドシートに挿入します
insertSheet(sheetName, sheetIndex, options) Sheet 指定されたインデックスで指定された名前でスプレッドシートに新しいシートを挿入し、オプションの高度な引数を使用します
insertSheet(sheetName, options) Sheet 指定した名前で新しいシートをスプレッドシートに挿入し、オプションの高度な引数を使用します
insertSheetWithDataSourceTable(spec) Sheet スプレッドシートに新しいシートを挿入DataSourceTableし、指定されたデータソース仕様でシート全体に広がるスパンを作成し、データの実行を開始します
isColumnHiddenByUser(columnPosition) Boolean 指定された列がユーザーによって非表示になっているかどうかを返します
isIterativeCalculationEnabled() Boolean このスプレッドシートで反復計算が有効になっているかどうかを返します
isRowHiddenByFilter(rowPosition) Boolean 指定された行がフィルター(フィルタービューではなく)によって非表示になっているかどうかを返します
isRowHiddenByUser(rowPosition) Boolean 指定された行がユーザーによって非表示になっているかどうかを返します
moveActiveSheet(pos) void アクティブなシートをシートのリスト内の指定された位置に移動します
moveChartToObjectSheet(chart) Sheet 新しいシートを作成し、提供されたチャートをそのシートに移動しますSheetType.OBJECT
removeEditor(emailAddress) Spreadsheet のエディターのリストから指定されたユーザーを削除しますSpreadsheet
removeEditor(user) Spreadsheet のエディターのリストから指定されたユーザーを削除しますSpreadsheet
removeMenu(name) void によって追加されたメニューを削除しますaddMenu(name, subMenus)
removeNamedRange(name) void 指定された名前の名前付き範囲を削除します
removeViewer(emailAddress) Spreadsheet の閲覧者とコメント投稿者のリストから指定されたユーザーを削除しますSpreadsheet
removeViewer(user) Spreadsheet の閲覧者とコメント投稿者のリストから指定されたユーザーを削除しますSpreadsheet
rename(newName) void ドキュメントの名前を変更します
renameActiveSheet(newName) void 現在のアクティブシートの名前を指定された新しい名前に変更します
resetSpreadsheetTheme() SpreadsheetTheme 適用されたテーマを削除し、スプレッドシートのデフォルトテーマを設定します
setActiveRange(range) Range Sets the specified range as the current cell.
setActiveRangeList(rangeList) RangeList Sets the specified list of ranges as the active ranges in the active sheet.
setActiveSelection(range) Range Sets the active selection region for this sheet.
setActiveSelection(a1Notation) Range Sets the active selection, as specified in A1 notation or R1C1 notation.
setActiveSheet(sheet) Sheet Sets the given sheet to be the active sheet in the spreadsheet.
setActiveSheet(sheet, restoreSelection) Sheet Sets the given sheet to be the active sheet in the spreadsheet, with an option to restore the most recent selection within that sheet.
setColumnWidth(columnPosition, width) Sheet Sets the width of the given column in pixels.
setCurrentCell(cell) Range Sets the specified cell as the current cell.
setFrozenColumns(columns) void Freezes the given number of columns.
setFrozenRows(rows) void Freezes the given number of rows.
setIterativeCalculationConvergenceThreshold(minThreshold) Spreadsheet Sets the minimum threshold value for iterative calculation.
setIterativeCalculationEnabled(isEnabled) Spreadsheet Sets whether iterative calculation is enabled in this spreadsheet.
setMaxIterativeCalculationCycles(maxIterations) Spreadsheet Sets the maximum number of calculation iterations that should be performed during iterative calculation.
setNamedRange(name, range) void Names a range.
setRecalculationInterval(recalculationInterval) Spreadsheet Sets how often this spreadsheet should recalculate.
setRowHeight(rowPosition, height) Sheet Sets the row height of the given row in pixels.
setSpreadsheetLocale(locale) void Sets the spreadsheet locale.
setSpreadsheetTheme(theme) SpreadsheetTheme Sets a theme on the spreadsheet.
setSpreadsheetTimeZone(timezone) void Sets the time zone for the spreadsheet.
show(userInterface) void Displays a custom user interface component in a dialog centered in the user's browser's viewport.
sort(columnPosition) Sheet Sorts a sheet by column, ascending.
sort(columnPosition, ascending) Sheet Sorts a sheet by column.
toast(msg) void Shows a popup window in the lower right corner of the spreadsheet with the given message.
toast(msg, title) void Shows a popup window in the lower right corner of the spreadsheet with the given message and title.
toast(msg, title, timeoutSeconds) void Shows a popup window in the lower right corner of the spreadsheet with the given title and message, that stays visible for a certain length of time.
unhideColumn(column) void Unhides the column in the given range.
unhideRow(row) void 指定された範囲の行を再表示します
updateMenu(name, subMenus) void によって追加されたメニューを更新しますaddMenu(name, subMenus)

SpreadsheetApp

プロパティ

物件 タイプ 説明
AutoFillSeries AutoFillSeries 自動入力値の計算に使用されるシリーズのタイプの列挙
BandingTheme BandingTheme 可能なバンディングテーマの列挙
BooleanCriteria BooleanCriteria 条件付き書式のブール条件の列挙
BorderStyle BorderStyle に境界線を設定するための有効なスタイルの列挙Range
ColorType ColorType 可能な色の種類の列挙
CopyPasteType CopyPasteType 可能な貼り付けタイプの列挙
DataExecutionErrorCode DataExecutionErrorCode 考えられるデータ実行エラーコードの列挙
DataExecutionState DataExecutionState 可能なデータ実行状態の列挙
DataSourceParameterType DataSourceParameterType 可能なデータソースパラメータタイプの列挙
DataSourceType DataSourceType 可能なデータソースタイプの列挙
DataValidationCriteria DataValidationCriteria 範囲に設定できるデータ検証基準を表す列挙体
DeveloperMetadataLocationType DeveloperMetadataLocationType 可能な開発者メタデータの場所の種類の列挙
DeveloperMetadataVisibility DeveloperMetadataVisibility 可能な開発者メタデータの可視性の列挙
Dimension Dimension スプレッドシートの可能な寸法の列挙
Direction Direction 矢印キーを使用してスプレッドシート内を移動できる方向の列挙
GroupControlTogglePosition GroupControlTogglePosition グループコントロールの切り替えが可能な位置の列挙
InterpolationType InterpolationType 条件付き形式の勾配補間タイプの列挙
PivotTableSummarizeFunction PivotTableSummarizeFunction ピボットテーブルの値を要約するために使用できる関数の列挙
PivotValueDisplayType PivotValueDisplayType ピボット値が表示されるメソッドの列挙
ProtectionType ProtectionType 編集から保護できるスプレッドシートの部分を表す列挙体
RecalculationInterval RecalculationInterval スプレッドシートの再計算で使用できる可能な間隔の列挙
RelativeDate RelativeDate 日付ベースで使用される値を計算するための相対日付オプションの列挙BooleanCriteria
SheetType SheetType スプレッドシートに存在できるさまざまな種類のシートの列挙
TextDirection TextDirection 有効なテキスト方向の列挙
TextToColumnsDelimiter TextToColumnsDelimiter テキストを列に分割するためのプリセット区切り文字の列挙
ThemeColorType ThemeColorType 可能なテーマの色の種類の列挙
WrapStrategy WrapStrategy セルのラッピングに使用される戦略の列挙

メソッド

メソッド 戻りタイプ 簡単な説明
create(name) Spreadsheet 指定された名前で新しいスプレッドシートを作成します
create(name, rows, columns) Spreadsheet 指定された名前と指定された行数と列数で新しいスプレッドシートを作成します
enableAllDataSourcesExecution() void すべてのタイプのデータソースのデータ実行を有効にします
enableBigQueryExecution() void BigQueryデータソースのデータ実行を有効にします
flush() void 保留中のスプレッドシートのすべての変更を適用します
getActive() Spreadsheet 現在アクティブなスプレッドシートを返しますnullない場合は返します
getActiveRange() Range アクティブなシートで選択した範囲を返しますnullアクティブな範囲がない場合
getActiveRangeList() RangeList アクティブなシート内のアクティブな範囲のリストを返しますnull範囲が選択されていない場合
getActiveSheet() Sheet スプレッドシートのアクティブシートを取得します
getActiveSpreadsheet() Spreadsheet 現在アクティブなスプレッドシートを返しますnullない場合は返します
getCurrentCell() Range アクティブなシートのアクティブな範囲のいずれかで選択されている、またはnull現在のセルがない場合に、現在の(強調表示された)セルを返します
getSelection() Selection Selectionスプレッドシートの現在の値を返します
getUi() Ui スクリプトがメニュー、ダイアログ、サイドバーなどの機能を追加できるようにするスプレッドシートのユーザーインターフェイス環境のインスタンスを返します
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 指定された範囲をとして設定し、範囲の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 テキストのフォントサイズをポイント単位で取得します
getForegroundColor() String テキストのフォントの色を取得します
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 ハイパーリンクに使用する色を表します

WrapStrategy

プロパティ

物件 タイプ 説明
WRAP Enum セル幅より長い行を新しい行に折り返します
OVERFLOW Enum そのセルが空である限り、次のセルに行がオーバーフローします
CLIP Enum セルの幅より長いクリップ行

カレンダーサービス

このサービスにより、スクリプトは、ユーザーが登録している追加のカレンダーなど、ユーザーのGoogleカレンダーにアクセスして変更できます

クラス

名前 簡単な説明
Calendar ユーザーが所有または購読しているカレンダーを表します
CalendarApp スクリプトがユーザーのGoogleカレンダーを読み取って更新できるようにします
CalendarEvent 単一のカレンダーイベントを表します
CalendarEventSeries 一連のイベント(繰り返しイベント)を表します
Color Calendarサービスで使用可能な名前付きの色を表す列挙体
EventColor Calendarサービスで使用可能な名前付きイベントの色を表す列挙体
EventGuest イベントのゲストを表します
EventRecurrence 一連のイベントの繰り返し設定を表します
GuestStatus ゲストがイベントに対して持つことができるステータスを表す列挙体
RecurrenceRule イベントシリーズの繰り返しルールを表します
Visibility イベントの可視性を表す列挙体

Calendar

メソッド

メソッド 戻りタイプ 簡単な説明
createAllDayEvent(title, date) CalendarEvent 新しい終日イベントを作成します
createAllDayEvent(title, startDate, endDate) CalendarEvent 新しい終日イベントを作成します
createAllDayEvent(title, startDate, endDate, options) CalendarEvent 新しい終日イベントを作成します
createAllDayEvent(title, date, options) CalendarEvent 新しい終日イベントを作成します
createAllDayEventSeries(title, startDate, recurrence) CalendarEventSeries 新しい終日イベントシリーズを作成します
createAllDayEventSeries(title, startDate, recurrence, options) CalendarEventSeries 新しい終日イベントシリーズを作成します
createEvent(title, startTime, endTime) CalendarEvent 新しいイベントを作成します
createEvent(title, startTime, endTime, options) CalendarEvent 新しいイベントを作成します
createEventFromDescription(description) CalendarEvent 自由形式の説明からイベントを作成します
createEventSeries(title, startTime, endTime, recurrence) CalendarEventSeries 新しいイベントシリーズを作成します
createEventSeries(title, startTime, endTime, recurrence, options) CalendarEventSeries 新しいイベントシリーズを作成します
deleteCalendar() void カレンダーを完全に削除します
getColor() String カレンダーの色を取得します
getDescription() String カレンダーの説明を取得します
getEventById(iCalId) CalendarEvent 指定されたIDのイベントを取得します
getEventSeriesById(iCalId) CalendarEventSeries 指定されたIDのイベントシリーズを取得します
getEvents(startTime, endTime) CalendarEvent[] 特定の時間範囲内に発生するすべてのイベントを取得します
getEvents(startTime, endTime, options) CalendarEvent[] 指定された時間範囲内に発生し、指定された基準を満たすすべてのイベントを取得します
getEventsForDay(date) CalendarEvent[] 特定の日に発生するすべてのイベントを取得します
getEventsForDay(date, options) CalendarEvent[] 特定の日に発生し、指定された基準を満たすすべてのイベントを取得します
getId() String カレンダーのIDを取得します
getName() String カレンダーの名前を取得します
getTimeZone() String カレンダーのタイムゾーンを取得します
isHidden() Boolean ユーザーインターフェイスでカレンダーを非表示にするかどうかを決定します
isMyPrimaryCalendar() Boolean カレンダーが有効なユーザーのデフォルトのカレンダーであるかどうかを決定します
isOwnedByMe() Boolean カレンダーが有効なユーザーによって所有されているかどうかを決定します
isSelected() Boolean カレンダーのイベントをユーザーインターフェイスに表示するかどうかを決定します
setColor(color) Calendar カレンダーの色を設定します
setDescription(description) Calendar カレンダーの説明を設定します
setHidden(hidden) Calendar カレンダーをユーザーインターフェイスに表示するかどうかを設定します
setName(name) Calendar カレンダーの名前を設定します
setSelected(selected) Calendar カレンダーのイベントをユーザーインターフェイスに表示するかどうかを設定します
setTimeZone(timeZone) Calendar カレンダーのタイムゾーンを設定します
unsubscribeFromCalendar() void ユーザーをカレンダーから購読解除します

CalendarApp

プロパティ

物件 タイプ 説明
Color Color Calendarサービスで使用可能な名前付きの色を表す列挙体
EventColor EventColor Calendarサービスで使用可能な名前付きイベントの色を表す列挙体
GuestStatus GuestStatus ゲストがイベントに対して持つことができるステータスを表す列挙体
Month Month 年の月を表す列挙体
Visibility Visibility イベントの可視性を表す列挙体
Weekday Weekday 曜日を表す列挙体

メソッド

メソッド 戻りタイプ 簡単な説明
createAllDayEvent(title, date) CalendarEvent 新しい終日イベントを作成します
createAllDayEvent(title, startDate, endDate) CalendarEvent 新しい終日イベントを作成します
createAllDayEvent(title, startDate, endDate, options) CalendarEvent 新しい終日イベントを作成します
createAllDayEvent(title, date, options) CalendarEvent 新しい終日イベントを作成します
createAllDayEventSeries(title, startDate, recurrence) CalendarEventSeries 新しい終日イベントシリーズを作成します
createAllDayEventSeries(title, startDate, recurrence, options) CalendarEventSeries 新しい終日イベントシリーズを作成します
createCalendar(name) Calendar ユーザーが所有する新しいカレンダーを作成します
createCalendar(name, options) Calendar ユーザーが所有する新しいカレンダーを作成します
createEvent(title, startTime, endTime) CalendarEvent 新しいイベントを作成します
createEvent(title, startTime, endTime, options) CalendarEvent 新しいイベントを作成します
createEventFromDescription(description) CalendarEvent 自由形式の説明からイベントを作成します
createEventSeries(title, startTime, endTime, recurrence) CalendarEventSeries 新しいイベントシリーズを作成します
createEventSeries(title, startTime, endTime, recurrence, options) CalendarEventSeries 新しいイベントシリーズを作成します
getAllCalendars() Calendar[] ユーザーが所有または購読しているすべてのカレンダーを取得します
getAllOwnedCalendars() Calendar[] ユーザーが所有するすべてのカレンダーを取得します
getCalendarById(id) Calendar 指定されたIDのカレンダーを取得します
getCalendarsByName(name) Calendar[] ユーザーが所有または購読している特定の名前を持つすべてのカレンダーを取得します
getColor() String カレンダーの色を取得します
getDefaultCalendar() Calendar ユーザーのデフォルトのカレンダーを取得します
getDescription() String カレンダーの説明を取得します
getEventById(iCalId) CalendarEvent 指定されたIDのイベントを取得します
getEventSeriesById(iCalId) CalendarEventSeries 指定されたIDのイベントシリーズを取得します
getEvents(startTime, endTime) CalendarEvent[] 特定の時間範囲内に発生するすべてのイベントを取得します
getEvents(startTime, endTime, options) CalendarEvent[] 指定された時間範囲内に発生し、指定された基準を満たすすべてのイベントを取得します
getEventsForDay(date) CalendarEvent[] 特定の日に発生するすべてのイベントを取得します
getEventsForDay(date, options) CalendarEvent[] 特定の日に発生し、指定された基準を満たすすべてのイベントを取得します
getId() String カレンダーのIDを取得します
getName() String カレンダーの名前を取得します
getOwnedCalendarById(id) Calendar ユーザーが所有している場合、指定されたIDのカレンダーを取得します
getOwnedCalendarsByName(name) Calendar[] ユーザーが所有する特定の名前を持つすべてのカレンダーを取得します
getTimeZone() String カレンダーのタイムゾーンを取得します
isHidden() Boolean ユーザーインターフェイスでカレンダーを非表示にするかどうかを決定します
isMyPrimaryCalendar() Boolean カレンダーが有効なユーザーのデフォルトのカレンダーであるかどうかを決定します
isOwnedByMe() Boolean カレンダーが有効なユーザーによって所有されているかどうかを決定します
isSelected() Boolean カレンダーのイベントをユーザーインターフェイスに表示するかどうかを決定します
newRecurrence() EventRecurrence イベントの繰り返しのルールを作成するために使用できる新しい繰り返しオブジェクトを作成します
setColor(color) Calendar カレンダーの色を設定します
setDescription(description) Calendar カレンダーの説明を設定します
setHidden(hidden) Calendar カレンダーをユーザーインターフェイスに表示するかどうかを設定します
setName(name) Calendar カレンダーの名前を設定します
setSelected(selected) Calendar カレンダーのイベントをユーザーインターフェイスに表示するかどうかを設定します
setTimeZone(timeZone) Calendar カレンダーのタイムゾーンを設定します
subscribeToCalendar(id) Calendar ユーザーが購読を許可されている場合、指定されたIDでユーザーをカレンダーに購読します
subscribeToCalendar(id, options) Calendar ユーザーが購読を許可されている場合、指定されたIDでユーザーをカレンダーに購読します

CalendarEvent

メソッド

メソッド 戻りタイプ 簡単な説明
addEmailReminder(minutesBefore) CalendarEvent 新しいメール通知をイベントに追加します
addGuest(email) CalendarEvent ゲストをイベントに追加します
addPopupReminder(minutesBefore) CalendarEvent イベントに新しいポップアップリマインダーを追加します
addSmsReminder(minutesBefore) CalendarEvent 新しいSMSリマインダーをイベントに追加します
anyoneCanAddSelf() Boolean 誰でも自分自身を招待できるかどうかを決定します
deleteEvent() void イベントを削除します
deleteTag(key) CalendarEvent イベントからキー/値タグを削除します
getAllDayEndDate() Date この終日カレンダーイベントが終了する日付を取得します
getAllDayStartDate() Date この終日カレンダーイベントが始まる日付を取得します
getAllTagKeys() String[] イベントに設定されているタグのすべてのキーを取得します
getColor() String カレンダーイベントの色を返します
getCreators() String[] イベントの作成者を取得します
getDateCreated() Date イベントが作成された日付を取得します
getDescription() String イベントの説明を取得します
getEmailReminders() Integer[] イベントのすべての電子メールアラームの分の値を取得します
getEndTime() Date このカレンダーイベントが終了する日付と時刻を取得します
getEventSeries() CalendarEventSeries このイベントが属する一連の定期的なイベントを取得します
getGuestByEmail(email) EventGuest メールアドレスでゲストを取得します
getGuestList() EventGuest[] イベントのゲストを取得しますイベントの所有者は含まれません
getGuestList(includeOwner) EventGuest[] 潜在的にイベント所有者を含む、イベントのゲストを取得します
getId() String イベントの一意のiCalUIDを取得します
getLastUpdated() Date イベントが最後に更新された日付を取得します
getLocation() String イベントの場所を取得します
getMyStatus() GuestStatus 有効なユーザーのイベントステータス(出席など)を取得します
getOriginalCalendarId() String このイベントが最初に作成されたカレンダーのIDを取得します
getPopupReminders() Integer[] イベントのすべてのポップアップリマインダーの分の値を取得します
getSmsReminders() Integer[] イベントのすべてのSMSリマインダーの分の値を取得します
getStartTime() Date このカレンダーイベントが開始する日付と時刻を取得します
getTag(key) String イベントのタグ値を取得します
getTitle() String イベントのタイトルを取得します
getVisibility() Visibility イベントの可視性を取得します
guestsCanInviteOthers() Boolean ゲストが他のゲストを招待できるかどうかを決定します
guestsCanModify() Boolean ゲストがイベントを変更できるかどうかを決定します
guestsCanSeeGuests() Boolean ゲストが他のゲストを見ることができるかどうかを決定します
isAllDayEvent() Boolean これが終日イベントかどうかを決定します
isOwnedByMe() Boolean イベントが有効なユーザーによって所有されているかどうかを判別します
isRecurringEvent() Boolean イベントがイベントシリーズの一部であるかどうかを決定します
removeAllReminders() CalendarEvent イベントからすべてのアラームを削除します
removeGuest(email) CalendarEvent イベントからゲストを削除します
resetRemindersToDefault() CalendarEvent カレンダーのデフォルト設定を使用してリマインダーをリセットします
setAllDayDate(date) CalendarEvent イベントの日付を設定します
setAllDayDates(startDate, endDate) CalendarEvent イベントの日付を設定します
setAnyoneCanAddSelf(anyoneCanAddSelf) CalendarEvent ゲスト以外がイベントに自分自身を追加できるかどうかを設定します
setColor(color) CalendarEvent カレンダーイベントの色を設定します
setDescription(description) CalendarEvent イベントの説明を設定します
setGuestsCanInviteOthers(guestsCanInviteOthers) CalendarEvent ゲストが他のゲストを招待できるかどうかを設定します
setGuestsCanModify(guestsCanModify) CalendarEvent ゲストがイベントを変更できるかどうかを設定します
setGuestsCanSeeGuests(guestsCanSeeGuests) CalendarEvent ゲストが他のゲストを表示できるかどうかを設定します
setLocation(location) CalendarEvent イベントの場所を設定します
setMyStatus(status) CalendarEvent 有効なユーザーのイベントステータス(出席など)を設定します
setTag(key, value) CalendarEvent カスタムメタデータを保存するために、イベントにキー/値タグを設定します
setTime(startTime, endTime) CalendarEvent イベントの開始と終了の日付と時刻を設定します
setTitle(title) CalendarEvent イベントのタイトルを設定します
setVisibility(visibility) CalendarEvent イベントの可視性を設定します

CalendarEventSeries

メソッド

メソッド 戻りタイプ 簡単な説明
addEmailReminder(minutesBefore) CalendarEventSeries 新しいメール通知をイベントに追加します
addGuest(email) CalendarEventSeries ゲストをイベントに追加します
addPopupReminder(minutesBefore) CalendarEventSeries イベントに新しいポップアップリマインダーを追加します
addSmsReminder(minutesBefore) CalendarEventSeries 新しいSMSリマインダーをイベントに追加します
anyoneCanAddSelf() Boolean 誰でも自分自身を招待できるかどうかを決定します
deleteEventSeries() void イベントシリーズを削除します
deleteTag(key) CalendarEventSeries イベントからキー/値タグを削除します
getAllTagKeys() String[] イベントに設定されているタグのすべてのキーを取得します
getColor() String カレンダーイベントの色を返します
getCreators() String[] イベントの作成者を取得します
getDateCreated() Date イベントが作成された日付を取得します
getDescription() String イベントの説明を取得します
getEmailReminders() Integer[] イベントのすべての電子メールアラームの分の値を取得します
getGuestByEmail(email) EventGuest メールアドレスでゲストを取得します
getGuestList() EventGuest[] イベントのゲストを取得しますイベントの所有者は含まれません
getGuestList(includeOwner) EventGuest[] 潜在的にイベント所有者を含む、イベントのゲストを取得します
getId() String イベントの一意のiCalUIDを取得します
getLastUpdated() Date イベントが最後に更新された日付を取得します
getLocation() String イベントの場所を取得します
getMyStatus() GuestStatus 有効なユーザーのイベントステータス(出席など)を取得します
getOriginalCalendarId() String このイベントが最初に作成されたカレンダーのIDを取得します
getPopupReminders() Integer[] イベントのすべてのポップアップリマインダーの分の値を取得します
getSmsReminders() Integer[] イベントのすべてのSMSリマインダーの分の値を取得します
getTag(key) String イベントのタグ値を取得します
getTitle() String イベントのタイトルを取得します
getVisibility() Visibility イベントの可視性を取得します
guestsCanInviteOthers() Boolean ゲストが他のゲストを招待できるかどうかを決定します
guestsCanModify() Boolean ゲストがイベントを変更できるかどうかを決定します
guestsCanSeeGuests() Boolean ゲストが他のゲストを見ることができるかどうかを決定します
isOwnedByMe() Boolean イベントが有効なユーザーによって所有されているかどうかを判別します
removeAllReminders() CalendarEventSeries イベントからすべてのアラームを削除します
removeGuest(email) CalendarEventSeries イベントからゲストを削除します
resetRemindersToDefault() CalendarEventSeries カレンダーのデフォルト設定を使用してリマインダーをリセットします
setAnyoneCanAddSelf(anyoneCanAddSelf) CalendarEventSeries ゲスト以外がイベントに自分自身を追加できるかどうかを設定します
setColor(color) CalendarEventSeries カレンダーイベントの色を設定します
setDescription(description) CalendarEventSeries イベントの説明を設定します
setGuestsCanInviteOthers(guestsCanInviteOthers) CalendarEventSeries ゲストが他のゲストを招待できるかどうかを設定します
setGuestsCanModify(guestsCanModify) CalendarEventSeries ゲストがイベントを変更できるかどうかを設定します
setGuestsCanSeeGuests(guestsCanSeeGuests) CalendarEventSeries ゲストが他のゲストを表示できるかどうかを設定します
setLocation(location) CalendarEventSeries イベントの場所を設定します
setMyStatus(status) CalendarEventSeries 有効なユーザーのイベントステータス(出席など)を設定します
setRecurrence(recurrence, startDate) CalendarEventSeries 終日のイベントシリーズの繰り返しルールを設定します
setRecurrence(recurrence, startTime, endTime) CalendarEventSeries このイベントシリーズの繰り返しルールを設定します
setTag(key, value) CalendarEventSeries カスタムメタデータを保存するために、イベントにキー/値タグを設定します
setTitle(title) CalendarEventSeries イベントのタイトルを設定します
setVisibility(visibility) CalendarEventSeries イベントの可視性を設定します

Color

プロパティ

物件 タイプ 説明
BLUE Enum

青(#2952A3)

BROWN Enum

ブラウン(#8D6F47)

CHARCOAL Enum

炭(#4E5D6C)

CHESTNUT Enum

栗(#865A5A)

GRAY Enum

グレー(#5A6986)

GREEN Enum

緑(#0D7813)

INDIGO Enum

インディゴ(#5229A3)

LIME Enum

ライム(#528800)

MUSTARD Enum

マスタード(#88880E)

OLIVE Enum

オリーブ(#6E6E41)

ORANGE Enum

オレンジ(#BE6D00)

PINK Enum

ピンク(#B1365F)

PLUM Enum

プラム(#705770)

PURPLE Enum

パープル(#7A367A)

RED Enum

赤(#A32929)

RED_ORANGE Enum

赤オレンジ(#B1440E)

SEA_BLUE Enum

シーブルー(#29527A)

SLATE Enum

スレート(#4A716C)

TEAL Enum

ティール(#28754E)

TURQOISE Enum

ターコイズ(#1B887A)

YELLOW Enum

黄色(#AB8B00)

EventColor

プロパティ

物件 タイプ 説明
PALE_BLUE Enum

ペールブルー("1")

PALE_GREEN Enum

ペールグリーン("2")

MAUVE Enum

藤色("3")

PALE_RED Enum

ペールレッド("4")

YELLOW Enum

黄色("5")

ORANGE Enum

オレンジ("6")

CYAN Enum

シアン("7")

GRAY Enum

グレー("8")

BLUE Enum

青("9")

GREEN Enum

緑("10")

RED Enum

赤("11")

EventGuest

メソッド

メソッド 戻りタイプ 簡単な説明
getAdditionalGuests() Integer このゲストが参加していると言った追加の人数を取得します
getEmail() String ゲストのメールアドレスを取得します
getGuestStatus() GuestStatus イベントのゲストのステータスを取得します
getName() String ゲストの名前を取得します

EventRecurrence

メソッド

メソッド 戻りタイプ 簡単な説明
addDailyExclusion() RecurrenceRule 毎日発生を除外するルールを追加します
addDailyRule() RecurrenceRule イベントを毎日繰り返すようにするルールを追加します
addDate(date) EventRecurrence 特定の日にイベントを繰り返すルールを追加します
addDateExclusion(date) EventRecurrence 特定の日付のオカレンスを除外するルールを追加します
addMonthlyExclusion() RecurrenceRule 月ごとに発生を除外するルールを追加します
addMonthlyRule() RecurrenceRule イベントを毎月繰り返しさせるルールを追加します
addWeeklyExclusion() RecurrenceRule 発生を毎週除外するルールを追加します
addWeeklyRule() RecurrenceRule イベントを毎週繰り返すルールを追加します
addYearlyExclusion() RecurrenceRule 発生を毎年除外するルールを追加します
addYearlyRule() RecurrenceRule イベントを毎年繰り返すルールを追加します
setTimeZone(timeZone) EventRecurrence この繰り返しのタイムゾーンを設定します

GuestStatus

プロパティ

物件 タイプ 説明
INVITED Enum ゲストは招待されていますが、出席しているかどうかは示されていません
MAYBE Enum ゲストは、彼または彼女が出席する可能性があることを示しています
NO Enum ゲストは出席していないことを示しています
OWNER Enum ゲストはイベントの所有者です
YES Enum ゲストは彼または彼女が出席していることを示しています

RecurrenceRule

メソッド

メソッド 戻りタイプ 簡単な説明
addDailyExclusion() RecurrenceRule 毎日発生を除外するルールを追加します
addDailyRule() RecurrenceRule イベントを毎日繰り返すようにするルールを追加します
addDate(date) EventRecurrence 特定の日にイベントを繰り返すルールを追加します
addDateExclusion(date) EventRecurrence 特定の日付のオカレンスを除外するルールを追加します
addMonthlyExclusion() RecurrenceRule 月ごとに発生を除外するルールを追加します
addMonthlyRule() RecurrenceRule イベントを毎月繰り返しさせるルールを追加します
addWeeklyExclusion() RecurrenceRule 発生を毎週除外するルールを追加します
addWeeklyRule() RecurrenceRule イベントを毎週繰り返すルールを追加します
addYearlyExclusion() RecurrenceRule 発生を毎年除外するルールを追加します
addYearlyRule() RecurrenceRule イベントを毎年繰り返すルールを追加します
interval(interval) RecurrenceRule ルールの時間単位のこの間隔でのみ適用されるようにルールを構成します
onlyInMonth(month) RecurrenceRule 特定の月にのみ適用されるようにルールを構成します
onlyInMonths(months) RecurrenceRule 特定の月にのみ適用されるようにルールを構成します
onlyOnMonthDay(day) RecurrenceRule 月の特定の日にのみ適用されるようにルールを構成します
onlyOnMonthDays(days) RecurrenceRule 月の特定の日にのみ適用されるようにルールを構成します
onlyOnWeek(week) RecurrenceRule 年の特定の週にのみ適用されるようにルールを構成します
onlyOnWeekday(day) RecurrenceRule 特定の曜日にのみ適用されるようにルールを構成します
onlyOnWeekdays(days) RecurrenceRule 特定の曜日にのみ適用されるようにルールを構成します
onlyOnWeeks(weeks) RecurrenceRule 年の特定の週にのみ適用されるようにルールを構成します
onlyOnYearDay(day) RecurrenceRule 年の特定の日にのみ適用されるようにルールを構成します
onlyOnYearDays(days) RecurrenceRule 年の特定の日にのみ適用されるようにルールを構成します
setTimeZone(timeZone) EventRecurrence この繰り返しのタイムゾーンを設定します
times(times) RecurrenceRule 指定された回数の発生後に終了するようにルールを設定します
until(endDate) RecurrenceRule 指定された日付(包括的)で終了するようにルールを構成します
weekStartsOn(day) RecurrenceRule ルールを適用するために、週の開始日を構成します

Visibility

プロパティ

物件 タイプ 説明
CONFIDENTIAL Enum イベントはプライベートです
DEFAULT Enum カレンダーのイベントにデフォルトの可視性を使用します
PRIVATE Enum イベントは非公開であり、イベントの参加者のみがイベントの詳細を表示できます
PUBLIC Enum イベントは公開されており、イベントの詳細はカレンダーのすべての読者に表示されます

連絡先サービス

このサービスにより、スクリプトは、個々の連絡先とグループの両方について、Google連絡先にアクセスして変更できます

クラス

名前 簡単な説明
AddressField 連絡先の住所フィールド
CompanyField 連絡先の会社フィールド
Contact 連絡先には、連絡先の名前、住所、およびさまざまな連絡先の詳細が含まれます
ContactGroup ContactGroupは、連絡先のグループです
ContactsApp このクラスを使用すると、ユーザーは自分のGoogleコンタクトにアクセスして、そこにリストされている連絡先を作成、削除、更新できます
CustomField 連絡先のカスタムフィールド
DateField 連絡先の日付フィールド
EmailField 連絡先の電子メールフィールド
ExtendedField 拡張連絡先フィールドの列挙
Field 連絡先フィールドの列挙
Gender 連絡先の性別の列挙
IMField 連絡先のインスタントメッセージングフィールド
PhoneField 連絡先の電話番号フィールド
Priority 連絡先の優先度の列挙
Sensitivity 連絡先の感度の列挙
UrlField 連絡先のURLフィールド

AddressField

メソッド

メソッド 戻りタイプ 簡単な説明
deleteAddressField() void この住所フィールドを削除します
getAddress() String このフィールドのアドレスを取得します
getLabel() Object このフィールドのラベルを取得します
isPrimary() Boolean これがプライマリフィールド値かどうかを取得します
setAddress(address) AddressField このフィールドのアドレスを設定します
setAsPrimary() AddressField このフィールドをプライマリに設定します
setLabel(field) AddressField このフィールドのラベルを設定します
setLabel(label) AddressField このフィールドのラベルを設定します

CompanyField

メソッド

メソッド 戻りタイプ 簡単な説明
deleteCompanyField() void この会社フィールドを削除します
getCompanyName() String 会社名を取得します
getJobTitle() String 役職を取得します
isPrimary() Boolean これが主要企業かどうかを取得します
setAsPrimary() CompanyField この会社を主要会社として設定し、以前に主要だった会社の設定を解除します
setCompanyName(company) CompanyField 会社名を設定します
setJobTitle(title) CompanyField 役職を設定します

Contact

メソッド

メソッド 戻りタイプ 簡単な説明
addAddress(label, address) AddressField 標準またはカスタムラベルを使用して連絡先に住所を追加します
addCompany(company, title) CompanyField 連絡先に会社を追加します
addCustomField(label, content) CustomField 拡張ラベルまたはカスタムラベルを使用して、連絡先にカスタムフィールドを追加します
addDate(label, month, day, year) DateField 標準またはカスタムラベルを使用して連絡先に日付を追加します
addEmail(label, address) EmailField 標準ラベル(自宅、職場など)またはカスタムラベルの付いたメールアドレスを追加します
addIM(label, address) IMField 標準またはカスタムラベルを使用して、連絡先にIMアドレスを追加します
addPhone(label, number) PhoneField 標準またはカスタムラベルを使用して電話番号を連絡先に追加します
addToGroup(group) Contact この連絡先を特定の連絡先グループに追加します
addUrl(label, url) UrlField 標準またはカスタムラベルを使用して、連絡先にURLを追加します
deleteContact() void この連絡先を削除します
getAddresses() AddressField[] この連絡先のすべての住所を取得します
getAddresses(label) AddressField[] 特定のフィールドに一致するこの連絡先のすべての住所を取得します
getCompanies() CompanyField[] この連絡先のすべての会社を取得します
getContactGroups() ContactGroup[] この連絡先を含むすべての連絡先グループを取得します
getCustomFields() CustomField[] この連絡先のすべてのカスタムフィールドを取得します
getCustomFields(label) CustomField[] 特定のフィールドに一致するこの連絡先のすべてのカスタムフィールドを取得します
getDates() DateField[] この連絡先のすべての日付を取得します
getDates(label) DateField[] 特定のフィールドに一致するこの連絡先のすべての日付を取得します
getEmails() EmailField[] この連絡先の電子メールアドレスを取得します
getEmails(label) EmailField[] 特定のフィールドに一致するこの連絡先の電子メールアドレスを取得します
getFamilyName() String 連絡先の姓(姓)を文字列として取得します
getFullName() String 連絡先の氏名(名と姓)を文字列として取得します
getGivenName() String 連絡先の名(名)を文字列として取得します
getIMs() IMField[] この連絡先のすべてのIMアドレスを取得します
getIMs(label) IMField[] 特定のフィールドに一致するこの連絡先のすべてのIMアドレスを取得します
getId() String この連絡先の一意のIDを返します
getInitials() String 連絡先のイニシャルを取得します
getLastUpdated() Date この連絡先が最後に更新された日付を取得します
getMaidenName() String 連絡先の旧姓を文字列として取得します
getMiddleName() String 連絡先のミドルネームを文字列として取得します
getNickname() String 連絡先のニックネームを文字列として取得します
getNotes() String この連絡先に関連付けられているメモを取得しますメモがない場合は空の文字列を取得します
getPhones() PhoneField[] この連絡先のすべての電話番号を取得します
getPhones(label) PhoneField[] 特定のフィールドに一致するこの連絡先のすべての電話番号を取得します
getPrefix() String 連絡先の名前のプレフィックスを取得します
getPrimaryEmail() String 連絡先のプライマリメールアドレスを文字列として取得します
getShortName() String 連絡先の短い名前を文字列として取得します
getSuffix() String 連絡先の名前の接尾辞を取得します
getUrls() UrlField[] この連絡先のすべてのURLを取得します
getUrls(label) UrlField[] 特定のフィールドに一致するこの連絡先のすべてのURLを取得します
removeFromGroup(group) Contact 指定された連絡先グループからこの連絡先を削除します
setFamilyName(familyName) Contact 連絡先の姓(姓)を設定します
setFullName(fullName) Contact 連絡先の氏名(名と姓)を設定します
setGivenName(givenName) Contact 連絡先の名(名)を設定します
setInitials(initials) Contact 連絡先のイニシャルを設定します
setMaidenName(maidenName) Contact 連絡先の旧姓を設定します
setMiddleName(middleName) Contact 連絡先のミドルネームを設定します
setNickname(nickname) Contact 連絡先のニックネームを設定します
setNotes(notes) Contact この連絡先に関連付けられているメモを設定します
setPrefix(prefix) Contact 連絡先の名前にプレフィックスを設定します
setShortName(shortName) Contact 連絡先の短縮名を設定します
setSuffix(suffix) Contact 接尾辞を連絡先の名前に設定します

ContactGroup

メソッド

メソッド 戻りタイプ 簡単な説明
addContact(contact) ContactGroup 指定された連絡先をこのグループに追加します
deleteGroup() void この連絡先グループを削除します
getContacts() Contact[] この連絡先グループのすべての連絡先を取得します
getId() String この連絡先グループのIDを取得します
getName() String この連絡先グループの名前を取得します
isSystemGroup() Boolean この連絡先グループがシステムグループ(削除不可)かどうかを決定するブール値を取得します
removeContact(contact) ContactGroup このグループから指定された連絡先を削除します
setName(name) ContactGroup この連絡先グループの名前を設定します

ContactsApp

プロパティ

物件 タイプ 説明
ExtendedField ExtendedField
Field Field
Gender Gender
Month Month
Priority Priority
Sensitivity Sensitivity

メソッド

メソッド 戻りタイプ 簡単な説明
createContact(givenName, familyName, email) Contact 新しい連絡先を作成します
createContactGroup(name) ContactGroup 指定された名前で連絡先グループを作成します
deleteContact(contact) void 連絡先を削除します
deleteContactGroup(group) void 連絡先グループを削除します
getContact(emailAddress) Contact メールアドレスで連絡先を取得します
getContactById(id) Contact このIDを持つ連絡先を取得します
getContactGroup(name) ContactGroup 指定された名前の連絡先グループを取得しますそのような連絡先グループが見つからない場合はnullを返します
getContactGroupById(id) ContactGroup 指定されたIDの連絡先グループを取得しますそのような連絡先グループが見つからない場合はnullを返します
getContactGroups() ContactGroup[] ユーザーの連絡先グループの完全なリストを取得します
getContacts() Contact[] ユーザーのすべての連絡先を取得します
getContactsByAddress(query) Contact[] アドレスに一致する連絡先を取得します
getContactsByAddress(query, label) Contact[] 特定のフィールドに限定して、アドレスに一致する連絡先を取得します
getContactsByAddress(query, label) Contact[] 指定したカスタムアドレスラベルに限定された、アドレスに一致する連絡先を取得します
getContactsByCompany(query) Contact[] 会社フィールドに一致する連絡先を取得します
getContactsByCustomField(query, label) Contact[] カスタムフィールドの特定の値に一致する連絡先を取得します
getContactsByDate(month, day, label) Contact[] 特定の標準フィールドの特定の月と日に一致する連絡先を取得します
getContactsByDate(month, day, year, label) Contact[] 特定の標準フィールドの特定の月、日、年に一致する連絡先を取得します
getContactsByDate(month, day, year, label) Contact[] 特定のカスタムフィールドの特定の月、日、年に一致する連絡先を取得します
getContactsByDate(month, day, label) Contact[] 特定のカスタムフィールドの特定の月と日に一致する連絡先を取得します
getContactsByEmailAddress(query) Contact[] メールアドレスに一致する連絡先を取得します
getContactsByEmailAddress(query, label) Contact[] 特定のフィールドに限定して、メールアドレスに一致する連絡先を取得します
getContactsByEmailAddress(query, label) Contact[] 指定したカスタム電子メールアドレスラベルに制限された、電子メールアドレスに一致する連絡先を取得します
getContactsByGroup(group) Contact[] 指定されたContactGroupの連絡先を取得します
getContactsByIM(query) Contact[] インスタントメッセージングアドレスに一致する連絡先を取得します
getContactsByIM(query, label) Contact[] 特定のフィールドに限定して、インスタントメッセージングアドレスに一致する連絡先を取得します
getContactsByIM(query, label) Contact[] 指定したカスタムインスタントメッセージングラベルに限定された、インスタントメッセージングアドレスに一致する連絡先を取得します
getContactsByJobTitle(query) Contact[] 役職フィールドに一致する連絡先を取得します
getContactsByName(query) Contact[] 名前に一致する連絡先を取得します
getContactsByName(query, label) Contact[] 特定のフィールドに限定された名前に一致する連絡先を取得します
getContactsByNotes(query) Contact[] メモフィールドに一致する連絡先を取得します
getContactsByPhone(query) Contact[] 電話番号に一致する連絡先を取得します
getContactsByPhone(query, label) Contact[] 特定のフィールドに限定して、電話番号に一致する連絡先を取得します
getContactsByPhone(query, label) Contact[] 指定されたカスタム電話番号ラベルに限定された、電話番号に一致する連絡先を取得します
getContactsByUrl(query) Contact[] URLに一致する連絡先を取得します
getContactsByUrl(query, label) Contact[] 特定のフィールドに限定して、URLに一致する連絡先を取得します
getContactsByUrl(query, label) Contact[] 指定されたカスタムURLラベルに制限された、URLに一致する連絡先を取得します

CustomField

メソッド

メソッド 戻りタイプ 簡単な説明
deleteCustomField() void このフィールドを削除します
getLabel() Object このフィールドのラベルを取得します
getValue() Object フィールドの値を取得します
setLabel(field) CustomField このフィールドのラベルを設定します
setLabel(label) CustomField このフィールドのラベルを設定します
setValue(value) CustomField このフィールドの値を設定します

DateField

メソッド

メソッド 戻りタイプ 簡単な説明
deleteDateField() void この日付を削除します
getDay() Integer この日付の月の日を取得します
getLabel() Object このフィールドのラベルを取得します
getMonth() Month この日付の月を取得します
getYear() Integer この日付の年を取得します
setDate(month, day) DateField 日付を年なしでこの日に設定します
setDate(month, day, year) DateField 日付をこの日に設定します
setLabel(label) DateField 「誕生日」や「記念日」など、このフィールドのラベルを設定します
setLabel(label) DateField このフィールドのラベルを設定します

EmailField

メソッド

メソッド 戻りタイプ 簡単な説明
deleteEmailField() void 連絡先からこのメールアドレスを削除します
getAddress() String このフィールドのアドレスを取得します
getDisplayName() String このメールアドレスの表示名を返します
getLabel() Object このフィールドのラベルを取得します
isPrimary() Boolean これがプライマリフィールド値かどうかを取得します
setAddress(address) EmailField このフィールドのアドレスを設定します
setAsPrimary() EmailField このフィールドをプライマリに設定します
setDisplayName(name) EmailField このメールアドレスの表示名を設定します
setLabel(field) EmailField このフィールドのラベルを設定します
setLabel(label) EmailField このフィールドのラベルを設定します

ExtendedField

プロパティ

物件 タイプ 説明
HOBBY Enum 連絡先の趣味
MILEAGE Enum 連絡先の走行距離
LANGUAGE Enum 連絡先の言語
GENDER Enum 連絡先の性別
BILLING_INFORMATION Enum 連絡先の請求情報
DIRECTORY_SERVER Enum 連絡先のディレクトリサーバー
SENSITIVITY Enum 連絡先の感度
PRIORITY Enum 連絡先の優先度
HOME Enum 連絡先の自宅情報
WORK Enum 連絡先の仕事情報
USER Enum 連絡先のユーザー情報
OTHER Enum 連絡先のその他の情報

Field

プロパティ

物件 タイプ 説明
FULL_NAME Enum 連絡先の氏名
GIVEN_NAME Enum 連絡先の名(最初の)
MIDDLE_NAME Enum 連絡先のミドルネーム
FAMILY_NAME Enum 連絡先の姓(姓)
MAIDEN_NAME Enum 連絡先の旧姓
NICKNAME Enum 連絡先のニックネーム
SHORT_NAME Enum 連絡先の短縮名
INITIALS Enum 連絡先のイニシャル
PREFIX Enum 連絡先の名前のプレフィックス
SUFFIX Enum 連絡先の名前の接尾辞
HOME_EMAIL Enum 連絡先の自宅のメールアドレス
WORK_EMAIL Enum 連絡先の仕事用メールアドレス
BIRTHDAY Enum 連絡先の誕生日
ANNIVERSARY Enum 連絡先の記念日
HOME_ADDRESS Enum 連絡先の自宅住所
WORK_ADDRESS Enum 連絡先の勤務先住所
ASSISTANT_PHONE Enum 連絡先のアシスタントの電話番号
CALLBACK_PHONE Enum 連絡先のコールバック電話番号
MAIN_PHONE Enum 連絡先のメイン電話番号
PAGER Enum 連絡先のポケットベル番号
HOME_FAX Enum 連絡先の自宅のファックス番号
WORK_FAX Enum 連絡先の仕事用ファックス番号
HOME_PHONE Enum 連絡先の自宅の電話番号
WORK_PHONE Enum 連絡先の勤務先電話番号
MOBILE_PHONE Enum 連絡先の携帯電話番号
GOOGLE_VOICE Enum 連絡先のGoogle Voice番号
NOTES Enum 連絡先に関するメモ
GOOGLE_TALK Enum 連絡先のGoogleトークID
AIM Enum 連絡先のAIM識別子
YAHOO Enum 連絡先のYahooインスタントメッセージング識別子
SKYPE Enum 連絡先のSkype識別子
QQ Enum 連絡先のQQ識別子
MSN Enum 連絡先のMSN識別子
ICQ Enum 連絡先のICQ識別子
JABBER Enum 連絡先のJabber識別子
BLOG Enum 連絡先のブログURL
FTP Enum 連絡先のFTP URL
PROFILE Enum 連絡先のプロフィールURL
HOME_PAGE Enum 連絡先のホームページURL
WORK_WEBSITE Enum 連絡先の仕事のWebサイトのURL
HOME_WEBSITE Enum 連絡先のホームWebサイトのURL
JOB_TITLE Enum 連絡先の役職
COMPANY Enum 連絡先の会社

Gender

プロパティ

物件 タイプ 説明
MALE Enum 男性の性別
FEMALE Enum 女性の性別

IMField

メソッド

メソッド 戻りタイプ 簡単な説明
deleteIMField() void このインスタントメッセージングフィールドを削除します
getAddress() String このフィールドのアドレスを取得します
getLabel() Object このフィールドのラベルを取得します
isPrimary() Boolean これがプライマリフィールド値かどうかを取得します
setAddress(address) IMField このフィールドのアドレスを設定します
setAsPrimary() IMField このフィールドをプライマリに設定します
setLabel(field) IMField このフィールドのラベルを設定します
setLabel(label) IMField このフィールドのラベルを設定します

PhoneField

メソッド

メソッド 戻りタイプ 簡単な説明
deletePhoneField() void この電話番号フィールドを削除します
getLabel() Object このフィールドのラベルを取得します
getPhoneNumber() String このフィールドの電話番号を取得します
isPrimary() Boolean これがプライマリフィールド値かどうかを取得します
setAsPrimary() PhoneField このフィールドをプライマリに設定します
setLabel(field) PhoneField このフィールドのラベルを設定します
setLabel(label) PhoneField このフィールドのラベルを設定します
setPhoneNumber(number) PhoneField このフィールドの電話番号を設定します

Priority

プロパティ

物件 タイプ 説明
HIGH Enum 優先度が高い
LOW Enum 低優先度
NORMAL Enum 通常の優先順位

Sensitivity

プロパティ

物件 タイプ 説明
CONFIDENTIAL Enum 機密性
NORMAL Enum 通常の感度
PERSONAL Enum 個人的な感性
PRIVATE Enum プライベート感性

UrlField

メソッド

メソッド 戻りタイプ 簡単な説明
deleteUrlField() void このURLフィールドを削除します
getAddress() String このフィールドのアドレスを取得します
getLabel() Object このフィールドのラベルを取得します
isPrimary() Boolean これがプライマリフィールド値かどうかを取得します
setAddress(address) UrlField このフィールドのアドレスを設定します
setAsPrimary() UrlField このフィールドをプライマリに設定します
setLabel(field) UrlField このフィールドのラベルを設定します
setLabel(label) UrlField このフィールドのラベルを設定します

データスタジオサービス

このサービスにより、スクリプトはData Studio Community Connectorsにアクセスして変更できます 

クラス

名前 簡単な説明
AggregationType に設定できる集計タイプを定義する列挙型Field
AuthType コネクタに設定できる認証タイプを定義する列挙
BigQueryConfig ネイティブBigQueryコネクタの構成オブジェクト
BigQueryParameterType 設定可能なBigQueryパラメータータイプを定義する列挙
Checkbox 構成のチェックボックス情報が含まれます
CommunityConnector CommunityConnectorを使用すると、スクリプトがビルダーやユーティリティにアクセスして、Data Studio用のコミュニティコネクタの開発を支援できます
Config コネクタの構成エントリが含まれます
DataStudioApp DataStudioAppにより、スクリプトは開発者向けのData Studioの機能と対話できます
DebugError コネクタの管理者にのみ表示されるエラー
Field フィールド関連のデータが含まれます
FieldType に設定できる型を定義する列挙体Field
Fields Fieldコミュニティコネクタののセットが含まれます
GetAuthTypeResponse getAuthType()スクリプトプロジェクトの応答を作成するビルダー
GetDataResponse getData()スクリプトプロジェクトの応答を作成するビルダー
GetSchemaResponse getSchema()スクリプトプロジェクトの応答を作成するビルダー
Info 構成の情報データが含まれます
OptionBuilder SelectMultiplesのオプションを作成するためのビルダー
SelectMultiple 構成の複数の選択情報が含まれます
SelectSingle 構成の単一の選択情報が含まれます
SetCredentialsResponse setCredentials()スクリプトプロジェクトの応答を作成するビルダー
TextArea 構成のテキスト領域情報が含まれます
TextInput 構成のテキスト入力情報が含まれます
UserError コネクタのユーザーに表示されるエラー

AggregationType

プロパティ

物件 タイプ 説明
AVG Enum 平均
COUNT Enum カウント
COUNT_DISTINCT Enum 明確なカウント
MAX Enum 最大
MIN Enum 最小
SUM Enum
AUTO Enum 自動

AuthType

プロパティ

物件 タイプ 説明
NONE Enum 承認は必要ありません
OAUTh3 Enum OAuth3認証が必要です
USER_PASS Enum ユーザー名とパスワードの資格情報が必要です
KEY Enum APIキーまたはトークンが必要です
USER_TOKEN Enum ユーザー名とトークンが必要です

BigQueryConfig

メソッド

メソッド 戻りタイプ 簡単な説明
addQueryParameter(name, type, value) BigQueryConfig これにクエリパラメータを追加しますBigQueryConfig
build() Object このオブジェクトを検証し、Data Studioで必要な形式で返します
printJson() String このオブジェクトのJSON表現を出力します
setAccessToken(accessToken) BigQueryConfig thisのアクセストークンを設定しますBigQueryConfig
setBillingProjectId(billingProjectId) BigQueryConfig このの請求プロジェクトIDを設定しBigQueryConfigます
setQuery(query) BigQueryConfig こののSQLクエリを設定しますBigQueryConfig
setUseStandardSql(useStandardSql) BigQueryConfig クエリが標準またはレガシーSQLとして解釈されるかどうかを決定します

BigQueryParameterType

プロパティ

物件 タイプ 説明
STRING Enum ストリング
INT64 Enum 64ビット整数
BOOL Enum ブール
FLOAT64 Enum 64ビットの浮動小数点数

Checkbox

メソッド

メソッド 戻りタイプ 簡単な説明
setAllowOverride(allowOverride) Checkbox この構成エントリのオーバーライドを有効にします
setHelpText(helpText) Checkbox この構成エントリのヘルプテキストを設定します
setId(id) Checkbox この構成エントリの一意のIDを設定します
setIsDynamic(isDynamic) Checkbox この構成エントリの動的ステータスを設定します
setName(name) Checkbox この構成エントリの表示名を設定します

CommunityConnector

プロパティ

物件 タイプ 説明
AggregationType AggregationType AggregationType列挙
AuthType AuthType AuthType列挙
BigQueryParameterType BigQueryParameterType BigQueryParameterType列挙
FieldType FieldType FieldType列挙

メソッド

メソッド 戻りタイプ 簡単な説明
getConfig() Config Configオブジェクトを返します
getFields() Fields Fieldsオブジェクトを返します
newAuthTypeResponse() GetAuthTypeResponse 新しいGetAuthTypeResponseオブジェクトを返します
newBigQueryConfig() BigQueryConfig 新しいBigQueryConfigオブジェクトを返します
newDebugError() DebugError 新しいDebugErrorオブジェクトを返します
newGetDataResponse() GetDataResponse 新しいGetDataResponseオブジェクトを返します
newGetSchemaResponse() GetSchemaResponse 新しいGetSchemaResponseオブジェクトを返します
newSetCredentialsResponse() SetCredentialsResponse 新しいSetCredentialsResponseオブジェクトを返します
newUserError() UserError 新しいUserErrorオブジェクトを返します

Config

メソッド

メソッド 戻りタイプ 簡単な説明
build() Object このオブジェクトを検証し、Data Studioで必要な形式で返します
newCheckbox() Checkbox 新しいチェックボックス構成エントリを返します
newInfo() Info 新しい情報設定エントリを返します
newOptionBuilder() OptionBuilder 新しいオプションビルダーを返します
newSelectMultiple() SelectMultiple 新しい複数選択構成エントリを返します
newSelectSingle() SelectSingle 新しい選択単一構成エントリを返します
newTextArea() TextArea 新しいテキスト領域構成エントリを返します
newTextInput() TextInput 新しいテキスト入力構成エントリを返します
printJson() String このオブジェクトのJSON表現を出力します
setDateRangeRequired(dateRangeRequired) Config の場合true、getData()リクエストに日付範囲が提供されます
setIsSteppedConfig(isSteppedConfig) Config の場合true、getConfig()現在のユーザー設定で再度呼び出されます

DataStudioApp

メソッド

メソッド 戻りタイプ 簡単な説明
createCommunityConnector() CommunityConnector 新しいコミュニティコネクタを作成します

DebugError

メソッド

メソッド 戻りタイプ 簡単な説明
printJson() String このオブジェクトのJSON表現を出力します
setText(text) DebugError デバッグエラーのテキストを設定しますこれは管理者にのみ表示されます
throwException() void スローされるこの例外をトリガーします

Field

メソッド

メソッド 戻りタイプ 簡単な説明
getAggregation() AggregationType 戻り値Field
getDescription() String thisの説明を返しますField
getFormula() String このの式を返しますField
getGroup() String thisのグループを返しますField
getId() String thisのIDを返しますField
getIsReaggregatable() Boolean trueこのフィールドを再集計できるかどうか、falseそうでない場合に返します
getName() String thisの名前を返しますField
getType() FieldType 戻り値Field
isDefault() Boolean trueこれFieldがデフォルトの指標またはディメンションであるかどうかを返します
isDimension() Boolean trueこのフィールドがディメンションかどうかを返します
isHidden() Boolean trueこれFieldが非表示かどうかを返します
isMetric() Boolean trueこのフィールドがメトリックかどうかを返します
setAggregation(aggregation) Field thisの集約タイプを設定しFieldます
setDescription(description) Field thisの説明を設定しますField
setFormula(formula) Field このの式を設定しFieldます
setGroup(group) Field thisのグループを設定しFieldます
setId(id) Field こののIDを設定しますField
setIsHidden(isHidden) Field thisの非表示ステータスを設定しますField
setIsReaggregatable(isReaggregatable) Field の再集約許可ステータスを設定しFieldます
setName(name) Field このの名前を設定しFieldます
setType(type) Field 設定しField

FieldType

プロパティ

物件 タイプ 説明
YEAR Enum 2017などのYYYY形式の年
YEAR_QUARTER Enum 20171などのYYYYQ形式の年と四半期
YEAR_MONTH Enum 201703などのYYYYMM形式の年と月
YEAR_WEEK Enum 201707などのYYYYww形式の年と週
YEAR_MONTH_DAY Enum 20170317などのYYYYMMDD形式の年、月、日
YEAR_MONTH_DAY_HOUR Enum 2017031703などのYYYYMMDDHH形式の年、月、日、および時間
YEAR_MONTH_DAY_SECOND Enum 201703170330などのYYYYMMDDHHss形式の年、月、日、時間、および秒
QUARTER Enum 1、2、3、または4の形式の四半期
MONTH Enum 03などのMM形式の月
WEEK Enum 07などのww形式の週
MONTH_DAY Enum 0317などのMMDD形式の月と日
DAY_OF_WEEK Enum [0,6]の範囲の数値で、0は日曜日を表します
DAY Enum 17などのDD形式の日
HOUR Enum 13などのHH形式の時間
MINUTE Enum 12などのmm形式の分
DURATION Enum 秒単位の期間
COUNTRY Enum 米国などの国
COUNTRY_CODE Enum 米国などの国コード
CONTINENT Enum アメリカ大陸などの大陸
CONTINENT_CODE Enum 019などの大陸コード
SUB_CONTINENT Enum 北米などの亜大陸
SUB_CONTINENT_CODE Enum 003などの亜大陸コード
REGION Enum カリフォルニアなどの地域
REGION_CODE Enum CAなどの地域コード
CITY Enum マウンテンビューなどの都市
CITY_CODE Enum 1014044などの都市コード
METRO Enum サンフランシスコ-オークランド-サンノゼCAなどの大都市圏
METRO_CODE Enum 200807などの大都市圏コード
LATITUDE_LONGITUDE Enum 51.5074、-0.1278などの緯度経度ペア
NUMBER Enum 10進数
PERCENT Enum 10進数のパーセンテージ(1.0を超える場合があります)
TEXT Enum 自由形式のテキスト
BOOLEAN Enum A trueまたはfalseブール値
URL Enum https://google.comなどのテキストとしてのURL
HYPERLINK Enum ハイパーリンク
IMAGE Enum 画像
IMAGE_LINK Enum 画像リンク
CURRENCY_AED Enum AEDからの通貨
CURRENCY_ALL Enum すべてからの通貨
CURRENCY_ARS Enum ARSからの通貨
CURRENCY_AUD Enum AUDからの通貨
CURRENCY_BDT Enum BDTからの通貨
CURRENCY_BGN Enum BGNからの通貨
CURRENCY_BOB Enum BOBからの通貨
CURRENCY_BRL Enum BRLからの通貨
CURRENCY_CAD Enum CADからの通貨
CURRENCY_CDF Enum CDFからの通貨
CURRENCY_CHF Enum CHFからの通貨
CURRENCY_CLP Enum CLPからの通貨
CURRENCY_CNY Enum CNYからの通貨
CURRENCY_COP Enum COPからの通貨
CURRENCY_CRC Enum CRCからの通貨
CURRENCY_CZK Enum CZKからの通貨
CURRENCY_DKK Enum DKKからの通貨
CURRENCY_DOP Enum DOPからの通貨
CURRENCY_EGP Enum EGPからの通貨
CURRENCY_ETB Enum ETBからの通貨
CURRENCY_EUR Enum ユーロからの通貨
CURRENCY_GBP Enum GBPからの通貨
CURRENCY_HKD Enum HKDからの通貨
CURRENCY_HRK Enum HRKからの通貨
CURRENCY_HUF Enum HUFからの通貨
CURRENCY_IDR Enum IDRからの通貨
CURRENCY_ILS Enum ILSからの通貨
CURRENCY_INR Enum INRからの通貨
CURRENCY_IRR Enum IRRからの通貨
CURRENCY_ISK Enum ISKからの通貨
CURRENCY_JMD Enum JMDからの通貨
CURRENCY_JPY Enum JPYからの通貨
CURRENCY_KRW Enum KRWからの通貨
CURRENCY_LKR Enum LKRからの通貨
CURRENCY_LTL Enum LTLからの通貨
CURRENCY_MNT Enum MNTからの通貨
CURRENCY_MVR Enum MVRからの通貨
CURRENCY_MXN Enum MXNからの通貨
CURRENCY_MYR Enum MYRからの通貨
CURRENCY_NOK Enum NOKからの通貨
CURRENCY_NZD Enum NZDからの通貨
CURRENCY_PAB Enum PABからの通貨
CURRENCY_PEN Enum PENからの通貨
CURRENCY_PHP Enum PHPからの通貨
CURRENCY_PKR Enum PKRからの通貨
CURRENCY_PLN Enum PLNからの通貨
CURRENCY_RON Enum RONからの通貨
CURRENCY_RSD Enum RSDからの通貨
CURRENCY_RUB Enum RUBからの通貨
CURRENCY_SAR Enum SARからの通貨
CURRENCY_SEK Enum SEKからの通貨
CURRENCY_SGD Enum SGDからの通貨
CURRENCY_THB Enum THBからの通貨
CURRENCY_TRY Enum TRYからの通貨
CURRENCY_TWD Enum TWDからの通貨
CURRENCY_TZS Enum TZSからの通貨
CURRENCY_UAH Enum UAHからの通貨
CURRENCY_USD Enum 通貨は米ドルから
CURRENCY_UYU Enum UYUからの通貨
CURRENCY_VEF Enum VEFからの通貨
CURRENCY_VND Enum VNDからの通貨
CURRENCY_YER Enum YERからの通貨
CURRENCY_ZAR Enum ZARからの通貨

Fields

メソッド

メソッド 戻りタイプ 簡単な説明
asArray() Field[] このオブジェクトのビューを配列として返します
build() Object[] このオブジェクトを検証し、Data Studioで必要な形式で返します
forIds(ids) Fields IDがのsにFieldids
getDefaultDimension() Field フィールドのセットに使用されるデフォルトの次元を返します
getDefaultMetric() Field フィールドのセットに使用されるデフォルトのメトリックを返します
getFieldById(fieldId) Field 指定されたIDを持つフィールドを返しますnullこのIDを持つフィールドがこのFieldsオブジェクトにない場合
newDimension() Field 新しい次元を返しますField
newMetric() Field 新しいメトリックを返しますField
setDefaultDimension(fieldId) void フィールドのセットに使用されるデフォルトの寸法を設定します
setDefaultMetric(fieldId) void フィールドのセットに使用されるデフォルトのメトリックを設定します

GetAuthTypeResponse

メソッド

メソッド 戻りタイプ 簡単な説明
build() Object このオブジェクトを検証し、Data Studioで必要な形式で返します
printJson() String このオブジェクトのJSON表現を出力します
setAuthType(authType) GetAuthTypeResponse AuthTypeビルダーを設定します
setHelpUrl(helpUrl) GetAuthTypeResponse ビルダーのヘルプURLを設定します

GetDataResponse

メソッド

メソッド 戻りタイプ 簡単な説明
addAllRows(rows) GetDataResponse これに複数行のデータを追加しますGetDataResponse
addRow(row) GetDataResponse これにデータの行を追加しますGetDataResponse
build() Object このオブジェクトを検証し、Data Studioで必要な形式で返します
setFields(fields) GetDataResponse Fieldsビルダーを設定します
setFiltersApplied(filtersApplied) GetDataResponse このビルダーのフィルター適用状況を設定します

GetSchemaResponse

メソッド

メソッド 戻りタイプ 簡単な説明
build() Object このオブジェクトを検証し、Data Studioで必要な形式で返します
printJson() String このオブジェクトのJSON表現を出力します
setFields(fields) GetSchemaResponse Fieldsビルダーを設定します

Info

メソッド

メソッド 戻りタイプ 簡単な説明
setId(id) Info この構成エントリの一意のIDを設定します
setText(text) Info この構成エントリのテキストを設定します

OptionBuilder

メソッド

メソッド 戻りタイプ 簡単な説明
setLabel(label) OptionBuilder このオプションビルダーのラベルを設定します
setValue(value) OptionBuilder このオプションビルダーの値を設定します

SelectMultiple

メソッド

メソッド 戻りタイプ 簡単な説明
addOption(optionBuilder) SelectMultiple 新しい選択オプションを追加します
setAllowOverride(allowOverride) SelectMultiple この構成エントリのオーバーライドを有効にします
setHelpText(helpText) SelectMultiple この構成エントリのヘルプテキストを設定します
setId(id) SelectMultiple この構成エントリの一意のIDを設定します
setIsDynamic(isDynamic) SelectMultiple この構成エントリの動的ステータスを設定します
setName(name) SelectMultiple この構成エントリの表示名を設定します

SelectSingle

メソッド

メソッド 戻りタイプ 簡単な説明
addOption(optionBuilder) SelectSingle 新しい選択オプションを追加します
setAllowOverride(allowOverride) SelectSingle この構成エントリのオーバーライドを有効にします
setHelpText(helpText) SelectSingle この構成エントリのヘルプテキストを設定します
setId(id) SelectSingle この構成エントリの一意のIDを設定します
setIsDynamic(isDynamic) SelectSingle この構成エントリの動的ステータスを設定します
setName(name) SelectSingle この構成エントリの表示名を設定します

SetCredentialsResponse

メソッド

メソッド 戻りタイプ 簡単な説明
build() Object このオブジェクトを検証し、Data Studioで必要な形式で返します
printJson() String このオブジェクトのJSON表現を出力します
setIsValid(isValid) SetCredentialsResponse thisの有効なステータスを設定しますSetCredentialsResponse

TextArea

メソッド

メソッド 戻りタイプ 簡単な説明
setAllowOverride(allowOverride) TextArea この構成エントリのオーバーライドを有効にします
setHelpText(helpText) TextArea この構成エントリのヘルプテキストを設定します
setId(id) TextArea この構成エントリの一意のIDを設定します
setIsDynamic(isDynamic) TextArea この構成エントリの動的ステータスを設定します
setName(name) TextArea この構成エントリの表示名を設定します
setPlaceholder(placeholder) TextArea この構成エントリのプレースホルダーテキストを設定します

TextInput

メソッド

メソッド 戻りタイプ 簡単な説明
setAllowOverride(allowOverride) TextInput この構成エントリのオーバーライドを有効にします
setHelpText(helpText) TextInput この構成エントリのヘルプテキストを設定します
setId(id) TextInput この構成エントリの一意のIDを設定します
setIsDynamic(isDynamic) TextInput この構成エントリの動的ステータスを設定します
setName(name) TextInput この構成エントリの表示名を設定します
setPlaceholder(placeholder) TextInput この構成エントリのプレースホルダーテキストを設定します

UserError

メソッド

メソッド 戻りタイプ 簡単な説明
printJson() String このオブジェクトのJSON表現を出力します
setDebugText(text) UserError デバッグエラーのテキストを設定しますこれは管理者にのみ表示されます
setText(text) UserError ユーザーエラーのテキストを設定します
throwException() void スローされるこの例外をトリガーします

文書サービス

このサービスを使用すると、スクリプトでGoogleドキュメントファイルを作成、アクセス、変更できます

クラス

名前 簡単な説明
Attribute 要素の属性の列挙
Body ドキュメントの本文を表す要素
Bookmark ブックマークを表すオブジェクト
ContainerElement 他の要素を含む可能性のある一般的な要素
Document リッチテキストと、テーブルやリストなどの要素を含むドキュメント
DocumentApp ドキュメントサービスが作成され、Documents編集可能なファイルが開きます
Element 汎用要素
ElementType すべての要素タイプの列挙
Equation 数式を表す要素
EquationFunction 数学的なの関数を表す要素Equation
EquationFunctionArgumentSeparator 数学的なの関数セパレーターを表す要素Equation
EquationSymbol 数学的な記号を表す要素Equation
FontFamily> サポートされているフォントの列挙
FooterSection フッターセクションを表す要素
Footnote 脚注を表す要素
FootnoteSection 脚注セクションを表す要素
GlyphType サポートされているグリフタイプの列挙
HeaderSection ヘッダーセクションを表す要素
HorizontalAlignment サポートされている水平方向の配置タイプの列挙
HorizontalRule 水平線を表す要素
InlineDrawing 埋め込み図面を表す要素
InlineImage 埋め込み画像を表す要素
ListItem リスト項目を表す要素
NamedRange A Range後で検索できるように名前とIDを持っています
PageBreak 改ページを表す要素
Paragraph 段落を表す要素
ParagraphHeading 標準の段落見出しの列挙
Position 特定の要素に関連する、ドキュメント内の場所への参照
PositionedImage に固定された位置画像を修正しましたParagraph
PositionedLayout PositionedImage周囲のテキストに関連してをレイアウトするメソッドを指定する列挙体
Range ドキュメント内のさまざまな要素
RangeBuilder Rangeドキュメント要素からオブジェクトを構築するために使用されるビルダー
RangeElement Element可能な開始および終了オフセットを持つの周りのラッパー
Table テーブルを表す要素
TableCell 表のセルを表す要素
TableOfContents 目次を含む要素
TableRow テーブル行を表す要素
Text リッチテキスト領域を表す要素
TextAlignment テキストの配置のタイプの列挙
UnsupportedElement ページ番号など、不明な、またはスクリプトの影響を受けない領域を表す要素
VerticalAlignment サポートされている垂直方向の配置タイプの列挙

Attribute

プロパティ

物件 タイプ 説明
BACKGROUND_COLOR Enum 要素(段落、表など)またはドキュメントの背景色
BOLD Enum リッチテキストのフォントの太さの設定
BORDER_COLOR Enum テーブル要素の境界線の色
BORDER_WIDTH Enum テーブル要素の境界線の幅(ポイント単位)
CODE Enum 方程式要素のコード内容
FONT_FAMILY Enum リッチテキスト用のフォントファミリ設定
FONT_SIZE Enum リッチテキストのフォントサイズ設定(ポイント単位)
FOREGROUND_COLOR Enum リッチテキストの前景色の設定
HEADING Enum 段落要素の見出しタイプ(例:)DocumentApp.ParagraphHeading.HEADING1
HEIGHT Enum 画像要素の高さ設定
HORIZONTAL_ALIGNMENT Enum 段落要素の水平方向の配置(たとえば、)DocumentApp.HorizontalAlignment.CENTER
INDENT_END Enum 段落要素のポイント単位のインデントの終了設定
INDENT_FIRST_LINE Enum 段落要素の最初の行のインデント設定(ポイント単位)
INDENT_START Enum 段落要素のポイント単位のインデント開始設定
ITALIC Enum リッチテキストのフォントスタイル設定
GLYPH_TYPE Enum リスト項目要素のグリフタイプ
LEFT_TO_RIGHT Enum リッチテキストのテキスト方向設定
LINE_SPACING Enum 段落要素の乗数としての行間隔設定
LINK_URL Enum リッチテキストのリンクURL
LIST_ID Enum リストアイテム要素の包含リストのID
MARGIN_BOTTOM Enum 段落要素の下部マージン設定(ポイント単位)
MARGIN_LEFT Enum 段落要素の左マージン設定(ポイント単位)
MARGIN_RIGHT Enum 段落要素の右マージン設定(ポイント単位)
MARGIN_TOP Enum 段落要素の上部マージン設定(ポイント単位)
NESTING_LEVEL Enum リストアイテム要素のアイテムネストレベル
MINIMUM_HEIGHT Enum テーブル行要素のポイント単位の最小高さ設定
PADDING_BOTTOM Enum テーブルセル要素の下部のパディング設定(ポイント単位)
PADDING_LEFT Enum テーブルセル要素の左詰め設定(ポイント単位)
PADDING_RIGHT Enum テーブルセル要素のポイント単位の正しいパディング設定
PADDING_TOP Enum テーブルセル要素の上部のパディング設定(ポイント単位)
PAGE_HEIGHT Enum ドキュメントのページの高さ設定(ポイント単位)
PAGE_WIDTH Enum ドキュメントのページ幅設定(ポイント単位)
SPACING_AFTER Enum 段落要素の下部の間隔設定(ポイント単位)
SPACING_BEFORE Enum 段落要素の上部の間隔設定(ポイント単位)
STRIKETHROUGH Enum リッチテキスト用の取り消し線設定
UNDERLINE Enum リッチテキスト用の下線設定
VERTICAL_ALIGNMENT Enum テーブルセル要素の垂直方向の配置設定
WIDTH Enum 表のセルおよび画像要素の幅設定

Body

メソッド

メソッド 戻りタイプ 簡単な説明
appendHorizontalRule() HorizontalRule 新しいを作成して追加しますHorizontalRule
appendImage(image) InlineImage InlineImage指定された画像ブロブから新規を作成して追加します
appendImage(image) InlineImage 指定されたを追加しますInlineImage
appendListItem(listItem) ListItem 指定されたを追加しますListItem
appendListItem(text) ListItem ListItem指定されたテキストコンテンツを含む新規を作成して追加します
appendPageBreak() PageBreak 新しいを作成して追加しますPageBreak
appendPageBreak(pageBreak) PageBreak 指定されたを追加しますPageBreak
appendParagraph(paragraph) Paragraph 指定されたを追加しますParagraph
appendParagraph(text) Paragraph Paragraph指定されたテキストコンテンツを含む新規を作成して追加します
appendTable() Table 新しいを作成して追加しますTable
appendTable(cells) Table 指定された文字列値ごとにTableCellます
appendTable(table) Table 指定されたを追加しますTable
clear() Body 要素の内容をクリアします
copy() Body 現在の要素の分離されたディープコピーを返します
editAsText() Text Text編集のために、現在の要素のバージョンを取得します
findElement(elementType) RangeElement 指定されたタイプの子孫の要素のコンテンツを検索します
findElement(elementType, from) RangeElement 指定されRangeElementたから開始して、指定されたタイプの子孫の要素のコンテンツを検索します
findText(searchPattern) RangeElement 正規表現を使用して、指定されたテキストパターンの要素のコンテンツを検索します
findText(searchPattern, from) RangeElement 特定の検索結果から開始して、指定されたテキストパターンの要素のコンテンツを検索します
getAttributes() Object 要素の属性を取得します
getChild(childIndex) Element 指定された子インデックスの子要素を取得します
getChildIndex(child) Integer 指定された子要素の子インデックスを取得します
getHeadingAttributes(paragraphHeading) Object 指定されたの属性セットを取得しますParagraphHeading
getImages() InlineImage[] InlineImagesセクションに含まれるすべてを取得します
getListItems() ListItem[] ListItemsセクションに含まれるすべてを取得します
getMarginBottom() Number 下マージンをポイント単位で取得します
getMarginLeft() Number 左マージンをポイント単位で取得します
getMarginRight() Number 右マージンを取得します
getMarginTop() Number 上余白を取得します
getNumChildren() Integer 子の数を取得します
getPageHeight() Number ページの高さをポイント単位で取得します
getPageWidth() Number ページ幅をポイント単位で取得します
getParagraphs() Paragraph[] ListItems)を取得します
getParent() ContainerElement 要素の親要素を取得します
getTables() Table[] Tablesセクションに含まれるすべてを取得します
getText() String 要素の内容をテキスト文字列として取得します
getTextAlignment() TextAlignment テキストの配置を取得します
getType() ElementType 要素のを取得しますElementType
insertHorizontalRule(childIndex) HorizontalRule HorizontalRule指定されたインデックスに新規を作成して挿入します
insertImage(childIndex, image) InlineImage InlineImage指定されたインデックスで、指定されたイメージBLOBからを作成して挿入します
insertImage(childIndex, image) InlineImage InlineImage指定されたインデックスに指定されたものを挿入します
insertListItem(childIndex, listItem) ListItem ListItem指定されたインデックスに指定されたものを挿入します
insertListItem(childIndex, text) ListItem ListItem指定されたテキストコンテンツを含む、指定されたインデックスに新しいを作成して挿入します
insertPageBreak(childIndex) PageBreak PageBreak指定されたインデックスに新規を作成して挿入します
insertPageBreak(childIndex, pageBreak) PageBreak PageBreak指定されたインデックスに指定されたものを挿入します
insertParagraph(childIndex, paragraph) Paragraph Paragraph指定されたインデックスに指定されたものを挿入します
insertParagraph(childIndex, text) Paragraph Paragraph指定されたテキストコンテンツを含む、指定されたインデックスに新しいを作成して挿入します
insertTable(childIndex) Table Table指定されたインデックスに新規を作成して挿入します
insertTable(childIndex, cells) Table Table指定されたインデックスで、指定されたセルを含む新規を作成して挿入します
insertTable(childIndex, table) Table Table指定されたインデックスに指定されたものを挿入します
removeChild(child) Body 指定された子要素を削除します
replaceText(searchPattern, replacement) Element 正規表現を使用して、特定のテキストパターンのすべての出現を特定の置換文字列に置き換えます
setAttributes(attributes) Body 要素の属性を設定します
setHeadingAttributes(paragraphHeading, attributes) Body 指定されたの属性を設定しますParagraphHeading
setMarginBottom(marginBottom) Body 下マージンをポイント単位で設定します
setMarginLeft(marginLeft) Body 左マージンをポイント単位で設定します
setMarginRight(marginRight) Body 右マージンをポイント単位で設定します
setMarginTop(marginTop) Body 上余白を設定します
setPageHeight(pageHeight) Body ページの高さをポイント単位で設定します
setPageWidth(pageWidth) Body ページ幅をポイント単位で設定します
setText(text) Body 内容をプレーンテキストとして設定します
setTextAlignment(textAlignment) Body テキストの配置を設定します

Bookmark

メソッド

メソッド 戻りタイプ 簡単な説明
getId() String のIDを取得しますBookmark
getPosition() Position 取得Document
remove() void を削除しBookmarkます

ContainerElement

メソッド

メソッド 戻りタイプ 簡単な説明
asBody() Body 現在の要素をとして返しますBody
asEquation() Equation 現在の要素をとして返しますEquation
asFooterSection() FooterSection 現在の要素をとして返しますFooterSection
asFootnoteSection() FootnoteSection 現在の要素をとして返しますFootnoteSection
asHeaderSection() HeaderSection 現在の要素をとして返しますHeaderSection
asListItem() ListItem 現在の要素をとして返しますListItem
asParagraph() Paragraph 現在の要素をとして返しますParagraph
asTable() Table 現在の要素をとして返しますTable
asTableCell() TableCell 現在の要素をとして返しますTableCell
asTableOfContents() TableOfContents 現在の要素をとして返しますTableOfContents
asTableRow() TableRow 現在の要素をとして返しますTableRow
clear() ContainerElement 要素の内容をクリアします
copy() ContainerElement 現在の要素の分離されたディープコピーを返します
editAsText() Text Text編集のために、現在の要素のバージョンを取得します
findElement(elementType) RangeElement 指定されたタイプの子孫の要素のコンテンツを検索します
findElement(elementType, from) RangeElement 指定されRangeElementたから開始して、指定されたタイプの子孫の要素のコンテンツを検索します
findText(searchPattern) RangeElement 正規表現を使用して、指定されたテキストパターンの要素のコンテンツを検索します
findText(searchPattern, from) RangeElement 特定の検索結果から開始して、指定されたテキストパターンの要素のコンテンツを検索します
getAttributes() Object 要素の属性を取得します
getChild(childIndex) Element 指定された子インデックスの子要素を取得します
getChildIndex(child) Integer 指定された子要素の子インデックスを取得します
getLinkUrl() String リンクURLを取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getNumChildren() Integer 子の数を取得します
getParent() ContainerElement 要素の親要素を取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getText() String 要素の内容をテキスト文字列として取得します
getTextAlignment() TextAlignment テキストの配置を取得します
getType() ElementType 要素のを取得しますElementType
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
merge() ContainerElement 要素を同じタイプの先行する兄弟とマージします
removeFromParent() ContainerElement 親から要素を削除します
replaceText(searchPattern, replacement) Element 正規表現を使用して、特定のテキストパターンのすべての出現を特定の置換文字列に置き換えます
setAttributes(attributes) ContainerElement 要素の属性を設定します
setLinkUrl(url) ContainerElement リンクURLを設定します
setTextAlignment(textAlignment) ContainerElement テキストの配置を設定します

Document

メソッド

メソッド 戻りタイプ 簡単な説明
addBookmark(position) Bookmark 追加Position
addEditor(emailAddress) Document 指定されたユーザーをのエディターのリストに追加しますDocument
addEditor(user) Document 指定されたユーザーをのエディターのリストに追加しますDocument
addEditors(emailAddresses) Document 指定されたユーザーの配列をのエディターのリストに追加しDocumentます
addFooter() FooterSection 存在しない場合、ドキュメントのフッターセクションを追加します
addHeader() HeaderSection 存在しない場合、ドキュメントヘッダーセクションを追加します
addNamedRange(name, range) NamedRange 新しいを追加しますRange後で取得できるように名前とIDを持っています
addViewer(emailAddress) Document 指定されたユーザーをの視聴者リストに追加しますDocument
addViewer(user) Document 指定されたユーザーをの視聴者リストに追加しますDocument
addViewers(emailAddresses) Document 指定されたユーザーの配列をの視聴者のリストに追加しDocumentます
getAs(contentType) Blob 現在のDocumentコンテンツを指定されたタイプのblobとして取得します
getBlob() Blob 現在のDocumentコンテンツをblobとして取得します
getBody() Body アクティブなドキュメントのを取得しますBody
getBookmark(id) Bookmark Bookmark指定されたIDを取得します
getBookmarks() Bookmark[] Bookmarkドキュメント内のすべてのオブジェクトを取得します
getCursor() Position アクティブなドキュメント内のユーザーのカーソルを取得します
getEditors() User[] こののエディターのリストを取得しますDocument
getFooter() FooterSection ドキュメントのフッターセクションがあれば、それを取得します
getFootnotes() Footnote[] Footnoteドキュメント本文内のすべての要素を取得します
getHeader() HeaderSection ドキュメントのヘッダーセクションがあれば、それを取得します
getId() String ドキュメントの一意の識別子を取得します
getLanguage() String ドキュメントの言語コードを取得します
getName() String ドキュメントのタイトルを取得します
getNamedRangeById(id) NamedRange NamedRange指定されたIDを取得します
getNamedRanges() NamedRange[] NamedRangeドキュメント内のすべてのオブジェクトを取得します
getNamedRanges(name) NamedRange[] NamedRange指定された名前を持つドキュメント内のすべてのオブジェクトを取得します
getSelection() Range アクティブなドキュメント内のユーザーの選択を取得します
getSupportedLanguageCodes() String[] Googleドキュメントファイルでサポートされているすべての言語コードを取得します
getUrl() String 現在のドキュメントにアクセスするためのURLを取得します
getViewers() User[] このの閲覧者とコメント投稿者のリストを取得しますDocument
newPosition(element, offset) Position 新しいを作成しますPositionこれは、特定の要素に関連する、ドキュメント内の場所への参照です
newRange() RangeBuilder Rangeドキュメント要素からオブジェクトを構築するために使用されるビルダーを作成します
removeEditor(emailAddress) Document のエディターのリストから指定されたユーザーを削除しますDocument
removeEditor(user) Document のエディターのリストから指定されたユーザーを削除しますDocument
removeViewer(emailAddress) Document の閲覧者とコメント投稿者のリストから指定されたユーザーを削除しますDocument
removeViewer(user) Document の閲覧者とコメント投稿者のリストから指定されたユーザーを削除しますDocument
saveAndClose() void 現在のを保存しDocumentます
setCursor(position) Document を指定して、アクティブドキュメントにユーザーのカーソルを設定しますPosition
setLanguage(languageCode) Document ドキュメントの言語コードを設定します
setName(name) Document ドキュメントのタイトルを設定します
setSelection(range) Document を指定して、アクティブドキュメントでユーザーの選択を設定しますRange

DocumentApp

プロパティ

物件 タイプ 説明
Attribute Attribute Attribute列挙
ElementType ElementType ElementType列挙
FontFamily FontFamily> FontFamily>列挙
GlyphType GlyphType GlyphType列挙
HorizontalAlignment HorizontalAlignment HorizontalAlignment列挙
ParagraphHeading ParagraphHeading ParagraphHeading列挙
PositionedLayout PositionedLayout PositionedLayout列挙
TextAlignment TextAlignment TextAlignment列挙
VerticalAlignment VerticalAlignment VerticalAlignment列挙

メソッド

メソッド 戻りタイプ 簡単な説明
create(name) Document 新しいドキュメントを作成して返します
getActiveDocument() Document スクリプトがコンテナにバインドされているドキュメントを返します
getUi() Ui スクリプトがメニュー、ダイアログ、サイドバーなどの機能を追加できるようにするドキュメントのユーザーインターフェイス環境のインスタンスを返します
openById(id) Document 指定されたIDのドキュメントを返します
openByUrl(url) Document 指定したURLのドキュメントを開いて返します

Element

メソッド

メソッド 戻りタイプ 簡単な説明
asBody() Body 現在の要素をとして返しますBody
asEquation() Equation 現在の要素をとして返しますEquation
asEquationFunction() EquationFunction 現在の要素をとして返しますEquationFunction
asEquationFunctionArgumentSeparator() EquationFunctionArgumentSeparator 現在の要素をとして返しますEquationFunctionArgumentSeparator
asEquationSymbol() EquationSymbol 現在の要素をとして返しますEquationSymbol
asFooterSection() FooterSection 現在の要素をとして返しますFooterSection
asFootnote() Footnote 現在の要素をとして返しますFootnote
asFootnoteSection() FootnoteSection 現在の要素をとして返しますFootnoteSection
asHeaderSection() HeaderSection 現在の要素をとして返しますHeaderSection
asHorizontalRule() HorizontalRule 現在の要素をとして返しますHorizontalRule
asInlineDrawing() InlineDrawing 現在の要素をとして返しますInlineDrawing
asInlineImage() InlineImage 現在の要素をとして返しますInlineImage
asListItem() ListItem 現在の要素をとして返しますListItem
asPageBreak() PageBreak 現在の要素をとして返しますPageBreak
asParagraph() Paragraph 現在の要素をとして返しますParagraph
asTable() Table 現在の要素をとして返しますTable
asTableCell() TableCell 現在の要素をとして返しますTableCell
asTableOfContents() TableOfContents 現在の要素をとして返しますTableOfContents
asTableRow() TableRow 現在の要素をとして返しますTableRow
asText() Text 現在の要素をとして返しますText
copy() Element 現在の要素の分離されたディープコピーを返します
getAttributes() Object 要素の属性を取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getParent() ContainerElement 要素の親要素を取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getType() ElementType 要素のを取得しますElementType
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
merge() Element 要素を同じタイプの先行する兄弟とマージします
removeFromParent() Element 親から要素を削除します
setAttributes(attributes) Element 要素の属性を設定します

ElementType

プロパティ

物件 タイプ 説明
BODY_SECTION Enum Body要素に対応するタイプ
COMMENT_SECTION Enum CommentS要素に対応するタイプ
DOCUMENT Enum ドキュメントのルートに対応するタイプ
EQUATION Enum Equation要素に対応するタイプ
EQUATION_FUNCTION Enum EquationFunction要素に対応するタイプ
EQUATION_FUNCTION_ARGUMENT_SEPARATOR Enum EquationFunctionArgumentSeparator 要素に対応するタイプ
EQUATION_SYMBOL Enum EquationSymbol要素に対応するタイプ
FOOTER_SECTION Enum FooterSection要素に対応するタイプ
FOOTNOTE Enum Footnote要素に対応するタイプ
FOOTNOTE_SECTION Enum FootnoteSection要素に対応するタイプ
HEADER_SECTION Enum HeaderSection要素に対応するタイプ
HORIZONTAL_RULE Enum HorizontalRule要素に対応するタイプ
INLINE_DRAWING Enum InlineDrawing要素に対応するタイプ
INLINE_IMAGE Enum InlineImage要素に対応するタイプ
LIST_ITEM Enum ListItem要素に対応するタイプ
PAGE_BREAK Enum PageBreak要素に対応するタイプ
PARAGRAPH Enum Paragraph要素に対応するタイプ
TABLE Enum Table要素に対応するタイプ
TABLE_CELL Enum TableCell要素に対応するタイプ
TABLE_OF_CONTENTS Enum TableOfContents要素に対応するタイプ
TABLE_ROW Enum TableRow要素に対応するタイプ
TEXT Enum Text 要素に対応するタイプ
UNSUPPORTED Enum に対応するタイプUnsupportedElement

Equation

メソッド

メソッド 戻りタイプ 簡単な説明
clear() Equation 要素の内容をクリアします
copy() Equation 現在の要素の分離されたディープコピーを返します
editAsText() Text Text編集のために、現在の要素のバージョンを取得します
findElement(elementType) RangeElement 指定されたタイプの子孫の要素のコンテンツを検索します
findElement(elementType, from) RangeElement 指定されRangeElementたから開始して、指定されたタイプの子孫の要素のコンテンツを検索します
findText(searchPattern) RangeElement 正規表現を使用して、指定されたテキストパターンの要素のコンテンツを検索します
findText(searchPattern, from) RangeElement 特定の検索結果から開始して、指定されたテキストパターンの要素のコンテンツを検索します
getAttributes() Object 要素の属性を取得します
getChild(childIndex) Element 指定された子インデックスの子要素を取得します
getChildIndex(child) Integer 指定された子要素の子インデックスを取得します
getLinkUrl() String リンクURLを取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getNumChildren() Integer 子の数を取得します
getParent() ContainerElement 要素の親要素を取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getText() String 要素の内容をテキスト文字列として取得します
getTextAlignment() TextAlignment テキストの配置を取得します
getType() ElementType 要素のを取得しますElementType
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
merge() Equation 要素を同じタイプの先行する兄弟とマージします
removeFromParent() Equation 親から要素を削除します
replaceText(searchPattern, replacement) Element 正規表現を使用して、特定のテキストパターンのすべての出現を特定の置換文字列に置き換えます
setAttributes(attributes) Equation 要素の属性を設定します
setLinkUrl(url) Equation リンクURLを設定します
setTextAlignment(textAlignment) Equation テキストの配置を設定します

EquationFunction

メソッド

メソッド 戻りタイプ 簡単な説明
clear() EquationFunction 要素の内容をクリアします
copy() EquationFunction 現在の要素の分離されたディープコピーを返します
editAsText() Text Text編集のために、現在の要素のバージョンを取得します
findElement(elementType) RangeElement 指定されたタイプの子孫の要素のコンテンツを検索します
findElement(elementType, from) RangeElement 指定されRangeElementたから開始して、指定されたタイプの子孫の要素のコンテンツを検索します
findText(searchPattern) RangeElement 正規表現を使用して、指定されたテキストパターンの要素のコンテンツを検索します
findText(searchPattern, from) RangeElement 特定の検索結果から開始して、指定されたテキストパターンの要素のコンテンツを検索します
getAttributes() Object 要素の属性を取得します
getChild(childIndex) Element 指定された子インデックスの子要素を取得します
getChildIndex(child) Integer 指定された子要素の子インデックスを取得します
getCode() String 方程式関数に対応するコードを取得します
getLinkUrl() String リンクURLを取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getNumChildren() Integer 子の数を取得します
getParent() ContainerElement 要素の親要素を取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getText() String 要素の内容をテキスト文字列として取得します
getTextAlignment() TextAlignment テキストの配置を取得します
getType() ElementType 要素のを取得しますElementType
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
merge() EquationFunction 要素を同じタイプの先行する兄弟とマージします
removeFromParent() EquationFunction 親から要素を削除します
replaceText(searchPattern, replacement) Element 正規表現を使用して、特定のテキストパターンのすべての出現を特定の置換文字列に置き換えます
setAttributes(attributes) EquationFunction 要素の属性を設定します
setLinkUrl(url) EquationFunction リンクURLを設定します
setTextAlignment(textAlignment) EquationFunction テキストの配置を設定します

EquationFunctionArgumentSeparator

メソッド

メソッド 戻りタイプ 簡単な説明
copy() EquationFunctionArgumentSeparator 現在の要素の分離されたディープコピーを返します
getAttributes() Object 要素の属性を取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getParent() ContainerElement 要素の親要素を取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getType() ElementType 要素のを取得しますElementType
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
merge() EquationFunctionArgumentSeparator 要素を同じタイプの先行する兄弟とマージします
removeFromParent() EquationFunctionArgumentSeparator 親から要素を削除します
setAttributes(attributes) EquationFunctionArgumentSeparator 要素の属性を設定します

EquationSymbol

メソッド

メソッド 戻りタイプ 簡単な説明
copy() EquationSymbol 現在の要素の分離されたディープコピーを返します
getAttributes() Object 要素の属性を取得します
getCode() String 方程式記号に対応するコードを取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getParent() ContainerElement 要素の親要素を取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getType() ElementType 要素のを取得しますElementType
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
merge() EquationSymbol 要素を同じタイプの先行する兄弟とマージします
removeFromParent() EquationSymbol 親から要素を削除します
setAttributes(attributes) EquationSymbol 要素の属性を設定します

FontFamily>

FooterSection

メソッド

メソッド 戻りタイプ 簡単な説明
appendHorizontalRule() HorizontalRule 新しいを作成して追加しますHorizontalRule
appendImage(image) InlineImage InlineImage指定された画像ブロブから新規を作成して追加します
appendImage(image) InlineImage 指定されたを追加しますInlineImage
appendListItem(listItem) ListItem 指定されたを追加しますListItem
appendListItem(text) ListItem ListItem指定されたテキストコンテンツを含む新規を作成して追加します
appendParagraph(paragraph) Paragraph 指定されたを追加しますParagraph
appendParagraph(text) Paragraph Paragraph指定されたテキストコンテンツを含む新規を作成して追加します
appendTable() Table 新しいを作成して追加しますTable
appendTable(cells) Table 指定された文字列値ごとにTableCellます
appendTable(table) Table 指定されたを追加しますTable
clear() FooterSection 要素の内容をクリアします
copy() FooterSection 現在の要素の分離されたディープコピーを返します
editAsText() Text Text編集のために、現在の要素のバージョンを取得します
findElement(elementType) RangeElement 指定されたタイプの子孫の要素のコンテンツを検索します
findElement(elementType, from) RangeElement 指定されRangeElementたから開始して、指定されたタイプの子孫の要素のコンテンツを検索します
findText(searchPattern) RangeElement 正規表現を使用して、指定されたテキストパターンの要素のコンテンツを検索します
findText(searchPattern, from) RangeElement 特定の検索結果から開始して、指定されたテキストパターンの要素のコンテンツを検索します
getAttributes() Object 要素の属性を取得します
getChild(childIndex) Element 指定された子インデックスの子要素を取得します
getChildIndex(child) Integer 指定された子要素の子インデックスを取得します
getImages() InlineImage[] InlineImagesセクションに含まれるすべてを取得します
getListItems() ListItem[] ListItemsセクションに含まれるすべてを取得します
getNumChildren() Integer 子の数を取得します
getParagraphs() Paragraph[] ListItems)を取得します
getParent() ContainerElement 要素の親要素を取得します
getTables() Table[] Tablesセクションに含まれるすべてを取得します
getText() String 要素の内容をテキスト文字列として取得します
getTextAlignment() TextAlignment テキストの配置を取得します
getType() ElementType 要素のを取得しますElementType
insertHorizontalRule(childIndex) HorizontalRule HorizontalRule指定されたインデックスに新規を作成して挿入します
insertImage(childIndex, image) InlineImage InlineImage指定されたインデックスで、指定されたイメージBLOBからを作成して挿入します
insertImage(childIndex, image) InlineImage InlineImage指定されたインデックスに指定されたものを挿入します
insertListItem(childIndex, listItem) ListItem ListItem指定されたインデックスに指定されたものを挿入します
insertListItem(childIndex, text) ListItem ListItem指定されたテキストコンテンツを含む、指定されたインデックスに新しいを作成して挿入します
insertParagraph(childIndex, paragraph) Paragraph Paragraph指定されたインデックスに指定されたものを挿入します
insertParagraph(childIndex, text) Paragraph Paragraph指定されたテキストコンテンツを含む、指定されたインデックスに新しいを作成して挿入します
insertTable(childIndex) Table Table指定されたインデックスに新規を作成して挿入します
insertTable(childIndex, cells) Table Table指定されたインデックスで、指定されたセルを含む新規を作成して挿入します
insertTable(childIndex, table) Table Table指定されたインデックスに指定されたものを挿入します
removeChild(child) FooterSection 指定された子要素を削除します
removeFromParent() FooterSection 親から要素を削除します
replaceText(searchPattern, replacement) Element 正規表現を使用して、特定のテキストパターンのすべての出現を特定の置換文字列に置き換えます
setAttributes(attributes) FooterSection 要素の属性を設定します
setText(text) FooterSection 内容をプレーンテキストとして設定します
setTextAlignment(textAlignment) FooterSection テキストの配置を設定します

Footnote

メソッド

メソッド 戻りタイプ 簡単な説明
copy() Footnote 現在の要素の分離されたディープコピーを返します
getAttributes() Object 要素の属性を取得します
getFootnoteContents() FootnoteSection 脚注要素の内容を取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getParent() ContainerElement 要素の親要素を取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getType() ElementType 要素のを取得しますElementType
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
removeFromParent() Footnote 親から要素を削除します
setAttributes(attributes) Footnote 要素の属性を設定します

FootnoteSection

メソッド

メソッド 戻りタイプ 簡単な説明
appendParagraph(paragraph) Paragraph 指定されたを追加しますParagraph
appendParagraph(text) Paragraph Paragraph指定されたテキストコンテンツを含む新規を作成して追加します
clear() FootnoteSection 要素の内容をクリアします
copy() FootnoteSection 現在の要素の分離されたディープコピーを返します
editAsText() Text Text編集のために、現在の要素のバージョンを取得します
findElement(elementType) RangeElement 指定されたタイプの子孫の要素のコンテンツを検索します
findElement(elementType, from) RangeElement 指定されRangeElementたから開始して、指定されたタイプの子孫の要素のコンテンツを検索します
findText(searchPattern) RangeElement 正規表現を使用して、指定されたテキストパターンの要素のコンテンツを検索します
findText(searchPattern, from) RangeElement 特定の検索結果から開始して、指定されたテキストパターンの要素のコンテンツを検索します
getAttributes() Object 要素の属性を取得します
getChild(childIndex) Element 指定された子インデックスの子要素を取得します
getChildIndex(child) Integer 指定された子要素の子インデックスを取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getNumChildren() Integer 子の数を取得します
getParagraphs() Paragraph[] ListItems)を取得します
getParent() ContainerElement 要素の親要素を取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getText() String 要素の内容をテキスト文字列として取得します
getTextAlignment() TextAlignment テキストの配置を取得します
getType() ElementType 要素のを取得しますElementType
insertParagraph(childIndex, paragraph) Paragraph Paragraph指定されたインデックスに指定されたものを挿入します
insertParagraph(childIndex, text) Paragraph Paragraph指定されたテキストコンテンツを含む、指定されたインデックスに新しいを作成して挿入します
removeChild(child) FootnoteSection 指定された子要素を削除します
removeFromParent() FootnoteSection 親から要素を削除します
replaceText(searchPattern, replacement) Element 正規表現を使用して、特定のテキストパターンのすべての出現を特定の置換文字列に置き換えます
setAttributes(attributes) FootnoteSection 要素の属性を設定します
setText(text) FootnoteSection 内容をプレーンテキストとして設定します
setTextAlignment(textAlignment) FootnoteSection テキストの配置を設定します

GlyphType

プロパティ

物件 タイプ 説明
BULLET Enum デフォルトの箇条書き、円形、塗りつぶし
HOLLOW_BULLET Enum 中空の弾丸
SQUARE_BULLET Enum 四角い弾丸
NUMBER Enum 番号ベースの弾丸
LATIN_UPPER Enum ラテン、大文字の弾丸
LATIN_LOWER Enum ラテン、小文字の弾丸
ROMAN_UPPER Enum ローマ数字、大文字の箇条書き
ROMAN_LOWER Enum ローマ数字、小文字の箇条書き

HeaderSection

メソッド

メソッド 戻りタイプ 簡単な説明
appendHorizontalRule() HorizontalRule 新しいを作成して追加しますHorizontalRule
appendImage(image) InlineImage InlineImage指定された画像ブロブから新規を作成して追加します
appendImage(image) InlineImage 指定されたを追加しますInlineImage
appendListItem(listItem) ListItem 指定されたを追加しますListItem
appendListItem(text) ListItem ListItem指定されたテキストコンテンツを含む新規を作成して追加します
appendParagraph(paragraph) Paragraph 指定されたを追加しますParagraph
appendParagraph(text) Paragraph Paragraph指定されたテキストコンテンツを含む新規を作成して追加します
appendTable() Table 新しいを作成して追加しますTable
appendTable(cells) Table 指定された文字列値ごとにTableCellます
appendTable(table) Table 指定されたを追加しますTable
clear() HeaderSection 要素の内容をクリアします
copy() HeaderSection 現在の要素の分離されたディープコピーを返します
editAsText() Text Text編集のために、現在の要素のバージョンを取得します
findElement(elementType) RangeElement 指定されたタイプの子孫の要素のコンテンツを検索します
findElement(elementType, from) RangeElement 指定されRangeElementたから開始して、指定されたタイプの子孫の要素のコンテンツを検索します
findText(searchPattern) RangeElement 正規表現を使用して、指定されたテキストパターンの要素のコンテンツを検索します
findText(searchPattern, from) RangeElement 特定の検索結果から開始して、指定されたテキストパターンの要素のコンテンツを検索します
getAttributes() Object 要素の属性を取得します
getChild(childIndex) Element 指定された子インデックスの子要素を取得します
getChildIndex(child) Integer 指定された子要素の子インデックスを取得します
getImages() InlineImage[] InlineImagesセクションに含まれるすべてを取得します
getListItems() ListItem[] ListItemsセクションに含まれるすべてを取得します
getNumChildren() Integer 子の数を取得します
getParagraphs() Paragraph[] ListItems)を取得します
getParent() ContainerElement 要素の親要素を取得します
getTables() Table[] Tablesセクションに含まれるすべてを取得します
getText() String 要素の内容をテキスト文字列として取得します
getTextAlignment() TextAlignment テキストの配置を取得します
getType() ElementType 要素のを取得しますElementType
insertHorizontalRule(childIndex) HorizontalRule HorizontalRule指定されたインデックスに新規を作成して挿入します
insertImage(childIndex, image) InlineImage InlineImage指定されたインデックスで、指定されたイメージBLOBからを作成して挿入します
insertImage(childIndex, image) InlineImage InlineImage指定されたインデックスに指定されたものを挿入します
insertListItem(childIndex, listItem) ListItem ListItem指定されたインデックスに指定されたものを挿入します
insertListItem(childIndex, text) ListItem ListItem指定されたテキストコンテンツを含む、指定されたインデックスに新しいを作成して挿入します
insertParagraph(childIndex, paragraph) Paragraph Paragraph指定されたインデックスに指定されたものを挿入します
insertParagraph(childIndex, text) Paragraph Paragraph指定されたテキストコンテンツを含む、指定されたインデックスに新しいを作成して挿入します
insertTable(childIndex) Table Table指定されたインデックスに新規を作成して挿入します
insertTable(childIndex, cells) Table Table指定されたインデックスで、指定されたセルを含む新規を作成して挿入します
insertTable(childIndex, table) Table Table指定されたインデックスに指定されたものを挿入します
removeChild(child) HeaderSection 指定された子要素を削除します
removeFromParent() HeaderSection 親から要素を削除します
replaceText(searchPattern, replacement) Element 正規表現を使用して、特定のテキストパターンのすべての出現を特定の置換文字列に置き換えます
setAttributes(attributes) HeaderSection 要素の属性を設定します
setText(text) HeaderSection 内容をプレーンテキストとして設定します
setTextAlignment(textAlignment) HeaderSection テキストの配置を設定します

HorizontalAlignment

プロパティ

物件 タイプ 説明
LEFT Enum 左揃えオプション
CENTER Enum 中央揃えオプション
RIGHT Enum 右揃えオプション
JUSTIFY Enum 位置揃えオプション

HorizontalRule

メソッド

メソッド 戻りタイプ 簡単な説明
copy() HorizontalRule 現在の要素の分離されたディープコピーを返します
getAttributes() Object 要素の属性を取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getParent() ContainerElement 要素の親要素を取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getType() ElementType 要素のを取得しますElementType
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
removeFromParent() HorizontalRule 親から要素を削除します
setAttributes(attributes) HorizontalRule 要素の属性を設定します

InlineDrawing

メソッド

メソッド 戻りタイプ 簡単な説明
copy() InlineDrawing 現在の要素の分離されたディープコピーを返します
getAltDescription() String 図面の代替説明を返します
getAltTitle() String 図面の代替タイトルを返します
getAttributes() Object 要素の属性を取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getParent() ContainerElement 要素の親要素を取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getType() ElementType 要素のを取得しますElementType
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
merge() InlineDrawing 要素を同じタイプの先行する兄弟とマージします
removeFromParent() InlineDrawing 親から要素を削除します
setAltDescription(description) InlineDrawing 図面の代替説明を設定します
setAltTitle(title) InlineDrawing 図面の代替タイトルを設定します
setAttributes(attributes) InlineDrawing 要素の属性を設定します

InlineImage

メソッド

メソッド 戻りタイプ 簡単な説明
copy() InlineImage 現在の要素の分離されたディープコピーを返します
getAltDescription() String 画像の代替説明を返します
getAltTitle() String 画像の代替タイトルを返します
getAs(contentType) Blob このオブジェクト内のデータを、指定されたコンテンツタイプに変換されたblobとして返します
getAttributes() Object 要素の属性を取得します
getBlob() Blob このオブジェクト内のデータをblobとして返します
getHeight() Integer 画像の高さをピクセル単位で取得します
getLinkUrl() String リンクURLを取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getParent() ContainerElement 要素の親要素を取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getType() ElementType 要素のを取得しますElementType
getWidth() Integer 画像の幅をピクセル単位で取得します
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
merge() InlineImage 要素を同じタイプの先行する兄弟とマージします
removeFromParent() InlineImage 親から要素を削除します
setAltDescription(description) InlineImage 画像の代替説明を設定します
setAltTitle(title) InlineImage 画像の代替タイトルを設定します
setAttributes(attributes) InlineImage 要素の属性を設定します
setHeight(height) InlineImage 画像の高さをピクセル単位で設定します
setLinkUrl(url) InlineImage リンクURLを設定します
setWidth(width) InlineImage 画像の幅をピクセル単位で設定します

ListItem

メソッド

メソッド 戻りタイプ 簡単な説明
addPositionedImage(image) PositionedImage PositionedImage指定された画像ブロブから新しいものを作成して挿入します
appendHorizontalRule() HorizontalRule 新しいを作成して追加しますHorizontalRule
appendInlineImage(image) InlineImage InlineImage指定された画像ブロブから新規を作成して追加します
appendInlineImage(image) InlineImage 指定されたを追加しますInlineImage
appendPageBreak() PageBreak 新しいを作成して追加しますPageBreak
appendPageBreak(pageBreak) PageBreak 指定されたを追加しますPageBreak
appendText(text) Text Text指定されたコンテンツを持つ新しい要素を作成して追加します
appendText(text) Text 指定されたText要素を追加します
clear() ListItem 要素の内容をクリアします
copy() ListItem 現在の要素の分離されたディープコピーを返します
editAsText() Text Text編集のために、現在の要素のバージョンを取得します
findElement(elementType) RangeElement 指定されたタイプの子孫の要素のコンテンツを検索します
findElement(elementType, from) RangeElement 指定されRangeElementたから開始して、指定されたタイプの子孫の要素のコンテンツを検索します
findText(searchPattern) RangeElement 正規表現を使用して、指定されたテキストパターンの要素のコンテンツを検索します
findText(searchPattern, from) RangeElement 特定の検索結果から開始して、指定されたテキストパターンの要素のコンテンツを検索します
getAlignment() HorizontalAlignment を取得しHorizontalAlignmentます
getAttributes() Object 要素の属性を取得します
getChild(childIndex) Element 指定された子インデックスの子要素を取得します
getChildIndex(child) Integer 指定された子要素の子インデックスを取得します
getGlyphType() GlyphType リストアイテムのを取得しますGlyphType
getHeading() ParagraphHeading を取得しParagraphHeadingます
getIndentEnd() Number 終了インデントをポイント単位で取得します
getIndentFirstLine() Number 最初の行のインデントをポイント単位で取得します
getIndentStart() Number 開始インデントを取得します
getLineSpacing() Number 行間隔をポイントで取得します
getLinkUrl() String リンクURLを取得します
getListId() String リストIDを取得します
getNestingLevel() Integer リストアイテムのネストレベルを取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getNumChildren() Integer 子の数を取得します
getParent() ContainerElement 要素の親要素を取得します
getPositionedImage(id) PositionedImage PositionedImage画像のIDを取得します
getPositionedImages() PositionedImage[] PositionedImage段落に固定されているすべてのオブジェクトを取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getSpacingAfter() Number 要素の後の間隔をポイントで取得します
getSpacingBefore() Number 要素の前の間隔をポイントで取得します
getText() String 要素の内容をテキスト文字列として取得します
getTextAlignment() TextAlignment テキストの配置を取得します
getType() ElementType 要素のを取得しますElementType
insertHorizontalRule(childIndex) HorizontalRule HorizontalRule指定されたインデックスにを作成して挿入します
insertInlineImage(childIndex, image) InlineImage InlineImage指定されたインデックスで、指定されたイメージBLOBから新規を作成して挿入します
insertInlineImage(childIndex, image) InlineImage InlineImage指定されたインデックスに指定されたものを挿入します
insertPageBreak(childIndex) PageBreak PageBreak指定されたインデックスに新規を作成して挿入します
insertPageBreak(childIndex, pageBreak) PageBreak PageBreak指定されたインデックスに指定されたものを挿入します
insertText(childIndex, text) Text 指定したインデックスに新しいテキスト要素を作成して挿入します
insertText(childIndex, text) Text Text指定されたテキストコンテンツで、指定されたインデックスに指定された要素を挿入します
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
isLeftToRight() Boolean 左から右の設定を取得します
merge() ListItem 要素を同じタイプの先行する兄弟とマージします
removeChild(child) ListItem 指定された子要素を削除します
removeFromParent() ListItem 親から要素を削除します
removePositionedImage(id) Boolean をPositionedImage画像のIDで削除します
replaceText(searchPattern, replacement) Element 正規表現を使用して、特定のテキストパターンのすべての出現を特定の置換文字列に置き換えます
setAlignment(alignment) ListItem を設定しHorizontalAlignmentます
setAttributes(attributes) ListItem 要素の属性を設定します
setGlyphType(glyphType) ListItem リストアイテムのを設定しますGlyphType
setHeading(heading) ListItem を設定しParagraphHeadingます
setIndentEnd(indentEnd) ListItem 終了インデントをポイント単位で設定します
setIndentFirstLine(indentFirstLine) ListItem 最初の行のインデントをポイント単位で設定します
setIndentStart(indentStart) ListItem 開始インデントをポイント単位で設定します
setLeftToRight(leftToRight) ListItem 左から右への設定を設定します
setLineSpacing(multiplier) ListItem 間隔に使用する行数を示す数量として、行間隔を設定します
setLinkUrl(url) ListItem リンクURLを設定します
setListId(listItem) ListItem リストIDを設定します
setNestingLevel(nestingLevel) ListItem リストアイテムのネストレベルを設定します
setSpacingAfter(spacingAfter) ListItem 要素の後の間隔をポイント単位で設定します
setSpacingBefore(spacingBefore) ListItem 要素の前の間隔をポイント単位で設定します
setText(text) void リスト項目の内容をテキストとして設定します
setTextAlignment(textAlignment) ListItem テキストの配置を設定します

NamedRange

メソッド

メソッド 戻りタイプ 簡単な説明
getId() String こののIDを取得しますNamedRange
getName() String このの名前を取得しますNamedRange
getRange() Range thisに関連付けられている要素の範囲を取得しますNamedRange
remove() void これNamedRangeを文書から削除します

PageBreak

メソッド

メソッド 戻りタイプ 簡単な説明
copy() PageBreak 現在の要素の分離されたディープコピーを返します
getAttributes() Object 要素の属性を取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getParent() ContainerElement 要素の親要素を取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getType() ElementType 要素のを取得しますElementType
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
removeFromParent() PageBreak 親から要素を削除します
setAttributes(attributes) PageBreak 要素の属性を設定します

Paragraph

メソッド

メソッド 戻りタイプ 簡単な説明
addPositionedImage(image) PositionedImage PositionedImage指定された画像ブロブから新しいものを作成して挿入します
appendHorizontalRule() HorizontalRule 新しいを作成して追加しますHorizontalRule
appendInlineImage(image) InlineImage InlineImage指定された画像ブロブから新規を作成して追加します
appendInlineImage(image) InlineImage 指定されたを追加しますInlineImage
appendPageBreak() PageBreak 新しいを作成して追加しますPageBreak
appendPageBreak(pageBreak) PageBreak 指定されたを追加しますPageBreak
appendText(text) Text Text指定されたコンテンツを持つ新しい要素を作成して追加します
appendText(text) Text 指定されたText要素を追加します
clear() Paragraph 要素の内容をクリアします
copy() Paragraph 現在の要素の分離されたディープコピーを返します
editAsText() Text Text編集のために、現在の要素のバージョンを取得します
findElement(elementType) RangeElement 指定されたタイプの子孫の要素のコンテンツを検索します
findElement(elementType, from) RangeElement 指定されRangeElementたから開始して、指定されたタイプの子孫の要素のコンテンツを検索します
findText(searchPattern) RangeElement 正規表現を使用して、指定されたテキストパターンの要素のコンテンツを検索します
findText(searchPattern, from) RangeElement 特定の検索結果から開始して、指定されたテキストパターンの要素のコンテンツを検索します
getAlignment() HorizontalAlignment を取得しHorizontalAlignmentます
getAttributes() Object 要素の属性を取得します
getChild(childIndex) Element 指定された子インデックスの子要素を取得します
getChildIndex(child) Integer 指定された子要素の子インデックスを取得します
getHeading() ParagraphHeading を取得しParagraphHeadingます
getIndentEnd() Number 終了インデントをポイント単位で取得します
getIndentFirstLine() Number 最初の行のインデントをポイント単位で取得します
getIndentStart() Number 開始インデントを取得します
getLineSpacing() Number 行間隔をポイントで取得します
getLinkUrl() String リンクURLを取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getNumChildren() Integer 子の数を取得します
getParent() ContainerElement 要素の親要素を取得します
getPositionedImage(id) PositionedImage PositionedImage画像のIDを取得します
getPositionedImages() PositionedImage[] PositionedImage段落に固定されているすべてのオブジェクトを取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getSpacingAfter() Number 要素の後の間隔をポイントで取得します
getSpacingBefore() Number 要素の前の間隔をポイントで取得します
getText() String 要素の内容をテキスト文字列として取得します
getTextAlignment() TextAlignment テキストの配置を取得します
getType() ElementType 要素のを取得しますElementType
insertHorizontalRule(childIndex) HorizontalRule HorizontalRule指定されたインデックスにを作成して挿入します
insertInlineImage(childIndex, image) InlineImage InlineImage指定されたインデックスで、指定されたイメージBLOBから新規を作成して挿入します
insertInlineImage(childIndex, image) InlineImage InlineImage指定されたインデックスに指定されたものを挿入します
insertPageBreak(childIndex) PageBreak PageBreak指定されたインデックスに新規を作成して挿入します
insertPageBreak(childIndex, pageBreak) PageBreak PageBreak指定されたインデックスに指定されたものを挿入します
insertText(childIndex, text) Text 指定したインデックスに新しいテキスト要素を作成して挿入します
insertText(childIndex, text) Text Text指定されたテキストコンテンツで、指定されたインデックスに指定された要素を挿入します
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
isLeftToRight() Boolean 左から右の設定を取得します
merge() Paragraph 要素を同じタイプの先行する兄弟とマージします
removeChild(child) Paragraph 指定された子要素を削除します
removeFromParent() Paragraph 親から要素を削除します
removePositionedImage(id) Boolean をPositionedImage画像のIDで削除します
replaceText(searchPattern, replacement) Element 正規表現を使用して、特定のテキストパターンのすべての出現を特定の置換文字列に置き換えます
setAlignment(alignment) Paragraph を設定しHorizontalAlignmentます
setAttributes(attributes) Paragraph 要素の属性を設定します
setHeading(heading) Paragraph を設定しParagraphHeadingます
setIndentEnd(indentEnd) Paragraph 終了インデントをポイント単位で設定します
setIndentFirstLine(indentFirstLine) Paragraph 最初の行のインデントをポイント単位で設定します
setIndentStart(indentStart) Paragraph 開始インデントをポイント単位で設定します
setLeftToRight(leftToRight) Paragraph 左から右への設定を設定します
setLineSpacing(multiplier) Paragraph 間隔に使用する行数を示す数量として、行間隔を設定します
setLinkUrl(url) Paragraph リンクURLを設定します
setSpacingAfter(spacingAfter) Paragraph 要素の後の間隔をポイント単位で設定します
setSpacingBefore(spacingBefore) Paragraph 要素の前の間隔をポイント単位で設定します
setText(text) void 段落の内容をテキストとして設定します
setTextAlignment(textAlignment) Paragraph テキストの配置を設定します

ParagraphHeading

プロパティ

物件 タイプ 説明
NORMAL Enum 通常のテキストの見出しオプション
HEADING1 Enum 最高の見出しオプション
HEADING2 Enum 2番目の見出しオプション
HEADING3 Enum 3番目の見出しオプション
HEADING4 Enum 4番目の見出しオプション
HEADING5 Enum 5番目の見出しオプション
HEADING6 Enum 最も低い見出しオプション
TITLE Enum タイトル見出しオプション
SUBTITLE Enum 字幕の見出しオプション

Position

メソッド

メソッド 戻りタイプ 簡単な説明
getElement() Element thisを含む要素を取得しますPosition
getOffset() Integer これPositionを含む要素内の相対位置を取得します
getSurroundingText() Text ListItemを含む人工要素を Position、直接または子要素のチェーンを介して作成します
getSurroundingTextOffset() Integer によって返される要素Position内のthisのオフセットを取得しますgetSurroundingText()
insertBookmark() Bookmark Bookmarkこれで新しいを作成して挿入しますPosition
insertInlineImage(image) InlineImage 指定されたイメージBLOBから、InlineImageこれに新しいを作成して挿入しますPosition
insertText(text) Text このに指定されたテキストを挿入しますPosition

PositionedImage

メソッド

メソッド 戻りタイプ 簡単な説明
getAs(contentType) Blob このオブジェクト内のデータを、指定されたコンテンツタイプに変換されたblobとして返します
getBlob() Blob このオブジェクト内のデータをblobとして返します
getHeight() Integer 画像の高さをピクセル単位で取得します
getId() String 画像のIDを取得します
getLayout() PositionedLayout 画像のレイアウトメソッドを表す列挙値を取得します
getLeftOffset() Number 段落の左からの画像のオフセットをポイント単位で取得します
getParagraph() Paragraph Paragraph画像が固定されていることを取得します
getTopOffset() Number 段落の上部から画像のオフセットをポイント単位で取得します
getWidth() Integer 画像の幅をピクセル単位で取得します
setHeight(height) PositionedImage 画像の高さをピクセル単位で設定します
setLayout(layout) PositionedImage 画像のレイアウトメソッドの定義を設定します
setLeftOffset(offset) PositionedImage 段落の左からの画像のオフセットをポイント単位で設定します
setTopOffset(offset) PositionedImage 段落の上部からの画像のオフセットをポイント単位で設定します
setWidth(width) PositionedImage 画像の幅をピクセル単位で設定します

PositionedLayout

プロパティ

物件 タイプ 説明
ABOVE_TEXT Enum 画像はテキストの上に配置されます
BREAK_BOTH Enum 画像は左右のテキストを分割します
BREAK_LEFT Enum 画像は左側のテキストを分割します
BREAK_RIGHT Enum 画像は右側のテキストを分割します
WRAP_TEXT Enum 画像はテキストでラップされます

Range

メソッド

メソッド 戻りタイプ 簡単な説明
getRangeElements() RangeElement[] Range部分的なText要素を含むthisのすべての要素を取得します(たとえば、Text要素の一部のみを含む選択の場合)

RangeBuilder

メソッド

メソッド 戻りタイプ 簡単な説明
addElement(element) RangeBuilder Elementこれに全体を追加しますRangeBuilder
addElement(textElement, startOffset, endOffsetInclusive) RangeBuilder Textこれに部分的な要素を追加しますRangeBuilder
addElementsBetween(startElement, endElementInclusive) RangeBuilder 2つの要素全体と、それらの間のすべての要素をthisに追加しますRangeBuilder
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) RangeBuilder に2つの部分Text要素とそれらの間のすべての要素を追加しRangeBuilderます
addRange(range) RangeBuilder 別のコンテンツRangeをthisに追加しますRangeBuilder
build() Range Rangeビルダーに適用された設定からを構築します
getRangeElements() RangeElement[] Range部分的なText要素を含むthisのすべての要素を取得します(たとえば、Text要素の一部のみを含む選択の場合)

RangeElement

メソッド

メソッド 戻りタイプ 簡単な説明
getElement() Element Elementこれに対応するを取得しますRangeElement
getEndOffsetInclusive() Integer 範囲要素内の部分範囲の終了位置を取得します
getStartOffset() Integer 範囲要素内の部分的な範囲の開始位置を取得します
isPartial() Boolean この範囲要素が要素全体をカバーするか、要素の文字の一部をカバーするかを決定します

Table

メソッド

メソッド 戻りタイプ 簡単な説明
appendTableRow() TableRow 新しいを作成して追加しますTableRow
appendTableRow(tableRow) TableRow 指定されたを追加しますTableRow
clear() Table 要素の内容をクリアします
copy() Table 現在の要素の分離されたディープコピーを返します
editAsText() Text Text編集のために、現在の要素のバージョンを取得します
findElement(elementType) RangeElement 指定されたタイプの子孫の要素のコンテンツを検索します
findElement(elementType, from) RangeElement 指定されRangeElementたから開始して、指定されたタイプの子孫の要素のコンテンツを検索します
findText(searchPattern) RangeElement 正規表現を使用して、指定されたテキストパターンの要素のコンテンツを検索します
findText(searchPattern, from) RangeElement 特定の検索結果から開始して、指定されたテキストパターンの要素のコンテンツを検索します
getAttributes() Object 要素の属性を取得します
getBorderColor() String 境界線の色を取得します
getBorderWidth() Number 境界線の幅をポイント単位で取得します
getCell(rowIndex, cellIndex) TableCell TableCell指定された行とセルのインデックスを取得します
getChild(childIndex) Element 指定された子インデックスの子要素を取得します
getChildIndex(child) Integer 指定された子要素の子インデックスを取得します
getColumnWidth(columnIndex) Number 指定したテーブル列の幅をポイント単位で取得します
getLinkUrl() String リンクURLを取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getNumChildren() Integer 子の数を取得します
getNumRows() Integer の数を取得しTableRowsます
getParent() ContainerElement 要素の親要素を取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getRow(rowIndex) TableRow TableRow指定された行のインデックスを取得します
getText() String 要素の内容をテキスト文字列として取得します
getTextAlignment() TextAlignment テキストの配置を取得します
getType() ElementType 要素のを取得しますElementType
insertTableRow(childIndex) TableRow TableRow指定されたインデックスに新規を作成して挿入します
insertTableRow(childIndex, tableRow) TableRow TableRow指定されたインデックスに指定されたものを挿入します
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
removeChild(child) Table 指定された子要素を削除します
removeFromParent() Table 親から要素を削除します
removeRow(rowIndex) TableRow TableRow指定した行のインデックスを削除します
replaceText(searchPattern, replacement) Element 正規表現を使用して、特定のテキストパターンのすべての出現を特定の置換文字列に置き換えます
setAttributes(attributes) Table 要素の属性を設定します
setBorderColor(color) Table 境界線の色を設定します
setBorderWidth(width) Table 境界線の幅をポイント単位で設定します
setColumnWidth(columnIndex, width) Table 指定した列の幅をポイント単位で設定します
setLinkUrl(url) Table リンクURLを設定します
setTextAlignment(textAlignment) Table テキストの配置を設定します

TableCell

メソッド

メソッド 戻りタイプ 簡単な説明
appendHorizontalRule() HorizontalRule 新しいを作成して追加しますHorizontalRule
appendImage(image) InlineImage InlineImage指定された画像ブロブから新規を作成して追加します
appendImage(image) InlineImage 指定されたを追加しますInlineImage
appendListItem(listItem) ListItem 指定されたを追加しますListItem
appendListItem(text) ListItem 新しいを作成して追加しますListItem
appendParagraph(paragraph) Paragraph 指定されたを追加しますParagraph
appendParagraph(text) Paragraph 新しいを作成して追加しますParagraph
appendTable() Table 新しいを作成して追加しますTable
appendTable(cells) Table 指定Tableされたセルを含む新規を追加します
appendTable(table) Table 指定されたを追加しますTable
clear() TableCell 要素の内容をクリアします
copy() TableCell 現在の要素の分離されたディープコピーを返します
editAsText() Text Text編集のために、現在の要素のバージョンを取得します
findElement(elementType) RangeElement 指定されたタイプの子孫の要素のコンテンツを検索します
findElement(elementType, from) RangeElement 指定されRangeElementたから開始して、指定されたタイプの子孫の要素のコンテンツを検索します
findText(searchPattern) RangeElement 正規表現を使用して、指定されたテキストパターンの要素のコンテンツを検索します
findText(searchPattern, from) RangeElement 特定の検索結果から開始して、指定されたテキストパターンの要素のコンテンツを検索します
getAttributes() Object 要素の属性を取得します
getBackgroundColor() String 背景色を取得します
getChild(childIndex) Element 指定された子インデックスの子要素を取得します
getChildIndex(child) Integer 指定された子要素の子インデックスを取得します
getColSpan() Integer 列スパンを取得しますこれは、このセルがまたがるテーブルセルの列数です
getLinkUrl() String リンクURLを取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getNumChildren() Integer 子の数を取得します
getPaddingBottom() Number 下部のパディングをポイント単位で取得します
getPaddingLeft() Number 左パディングをポイント単位で取得します
getPaddingRight() Number ポイント単位で正しいパディングを取得します
getPaddingTop() Number 上のパディングをポイント単位で取得します
getParent() ContainerElement 要素の親要素を取得します
getParentRow() TableRow TableCellます
getParentTable() Table TableCellます
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getRowSpan() Integer 行のスパンを取得しますこれは、このセルがまたがるテーブルセルの行数です
getText() String 要素の内容をテキスト文字列として取得します
getTextAlignment() TextAlignment テキストの配置を取得します
getType() ElementType 要素のを取得しますElementType
getVerticalAlignment() VerticalAlignment を取得しVerticalAlignmentます
getWidth() Number セルを含む列の幅をポイント単位で取得します
insertHorizontalRule(childIndex) HorizontalRule HorizontalRule指定されたインデックスに新規を作成して挿入します
insertImage(childIndex, image) InlineImage InlineImage指定されたインデックスで、指定されたイメージBLOBからを作成して挿入します
insertImage(childIndex, image) InlineImage InlineImage指定されたインデックスに指定されたものを挿入します
insertListItem(childIndex, listItem) ListItem ListItem指定されたインデックスに指定されたものを挿入します
insertListItem(childIndex, text) ListItem ListItem指定されたインデックスに新規を作成して挿入します
insertParagraph(childIndex, paragraph) Paragraph Paragraph指定されたインデックスに指定されたものを挿入します
insertParagraph(childIndex, text) Paragraph Paragraph指定されたインデックスに新規を作成して挿入します
insertTable(childIndex) Table Table指定されたインデックスに新規を作成して挿入します
insertTable(childIndex, cells) Table Table指定されたインデックスで、指定されたセルを含む新規を作成して挿入します
insertTable(childIndex, table) Table Table指定されたインデックスに指定されたものを挿入します
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
merge() TableCell 要素を同じタイプの先行する兄弟とマージします
removeChild(child) TableCell 指定された子要素を削除します
removeFromParent() TableCell 親から要素を削除します
replaceText(searchPattern, replacement) Element 正規表現を使用して、特定のテキストパターンのすべての出現を特定の置換文字列に置き換えます
setAttributes(attributes) TableCell 要素の属性を設定します
setBackgroundColor(color) TableCell 背景色を設定します
setLinkUrl(url) TableCell リンクURLを設定します
setPaddingBottom(paddingBottom) TableCell 下部のパディングをポイント単位で設定します
setPaddingLeft(paddingLeft) TableCell 左パディングをポイント単位で設定します
setPaddingRight(paddingTop) TableCell 右のパディングをポイント単位で設定します
setPaddingTop(paddingTop) TableCell 上部のパディングをポイント単位で設定します
setText(text) TableCell 内容をプレーンテキストとして設定します
setTextAlignment(textAlignment) TableCell テキストの配置を設定します
setVerticalAlignment(alignment) TableCell 垂直方向の配置を設定します
setWidth(width) TableCell 現在のセルを含む列の幅をポイント単位で設定します

TableOfContents

メソッド

メソッド 戻りタイプ 簡単な説明
clear() TableOfContents 要素の内容をクリアします
copy() TableOfContents 現在の要素の分離されたディープコピーを返します
editAsText() Text Text編集のために、現在の要素のバージョンを取得します
findElement(elementType) RangeElement 指定されたタイプの子孫の要素のコンテンツを検索します
findElement(elementType, from) RangeElement 指定されRangeElementたから開始して、指定されたタイプの子孫の要素のコンテンツを検索します
findText(searchPattern) RangeElement 正規表現を使用して、指定されたテキストパターンの要素のコンテンツを検索します
findText(searchPattern, from) RangeElement 特定の検索結果から開始して、指定されたテキストパターンの要素のコンテンツを検索します
getAttributes() Object 要素の属性を取得します
getChild(childIndex) Element 指定された子インデックスの子要素を取得します
getChildIndex(child) Integer 指定された子要素の子インデックスを取得します
getLinkUrl() String リンクURLを取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getNumChildren() Integer 子の数を取得します
getParent() ContainerElement 要素の親要素を取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getText() String 要素の内容をテキスト文字列として取得します
getTextAlignment() TextAlignment テキストの配置を取得します
getType() ElementType 要素のを取得しますElementType
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
removeFromParent() TableOfContents 親から要素を削除します
replaceText(searchPattern, replacement) Element 正規表現を使用して、特定のテキストパターンのすべての出現を特定の置換文字列に置き換えます
setAttributes(attributes) TableOfContents 要素の属性を設定します
setLinkUrl(url) TableOfContents リンクURLを設定します
setTextAlignment(textAlignment) TableOfContents テキストの配置を設定します

TableRow

メソッド

メソッド 戻りタイプ 簡単な説明
appendTableCell() TableCell 新しいを作成して追加しますTableCell
appendTableCell(textContents) TableCell 指定したTableCellテキストを含む指定したものを追加します
appendTableCell(tableCell) TableCell 指定されたを追加しますTableCell
clear() TableRow 要素の内容をクリアします
copy() TableRow 現在の要素の分離されたディープコピーを返します
editAsText() Text Text編集のために、現在の要素のバージョンを取得します
findElement(elementType) RangeElement 指定されたタイプの子孫の要素のコンテンツを検索します
findElement(elementType, from) RangeElement 指定されRangeElementたから開始して、指定されたタイプの子孫の要素のコンテンツを検索します
findText(searchPattern) RangeElement 正規表現を使用して、指定されたテキストパターンの要素のコンテンツを検索します
findText(searchPattern, from) RangeElement 特定の検索結果から開始して、指定されたテキストパターンの要素のコンテンツを検索します
getAttributes() Object 要素の属性を取得します
getCell(cellIndex) TableCell TableCell指定したセルのインデックスを取得します
getChild(childIndex) Element 指定された子インデックスの子要素を取得します
getChildIndex(child) Integer 指定された子要素の子インデックスを取得します
getLinkUrl() String リンクURLを取得します
getMinimumHeight() Number 最小の高さをポイント単位で取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getNumCells() Integer 行内のセルの数を取得します
getNumChildren() Integer 子の数を取得します
getParent() ContainerElement 要素の親要素を取得します
getParentTable() Table Table現在の行を含むを取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getText() String 要素の内容をテキスト文字列として取得します
getTextAlignment() TextAlignment テキストの配置を取得します
getType() ElementType 要素のを取得しますElementType
insertTableCell(childIndex) TableCell TableCell指定されたインデックスに新規を作成して挿入します
insertTableCell(childIndex, textContents) TableCell TableCell指定されたテキストを含む、指定されたインデックスに指定されたものを挿入します
insertTableCell(childIndex, tableCell) TableCell TableCell指定されたインデックスに指定されたものを挿入します
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
merge() TableRow 要素を同じタイプの先行する兄弟とマージします
removeCell(cellIndex) TableCell TableCell指定したセルのインデックスを削除します
removeChild(child) TableRow 指定された子要素を削除します
removeFromParent() TableRow 親から要素を削除します
replaceText(searchPattern, replacement) Element 正規表現を使用して、特定のテキストパターンのすべての出現を特定の置換文字列に置き換えます
setAttributes(attributes) TableRow 要素の属性を設定します
setLinkUrl(url) TableRow リンクURLを設定します
setMinimumHeight(minHeight) TableRow 最小の高さをポイント単位で設定します
setTextAlignment(textAlignment) TableRow テキストの配置を設定します

Text

メソッド

メソッド 戻りタイプ 簡単な説明
appendText(text) Text 指定したテキストをこのテキスト領域の最後に追加します
copy() Text 現在の要素の分離されたディープコピーを返します
deleteText(startOffset, endOffsetInclusive) Text テキストの範囲を削除します
editAsText() Text Text編集のために、現在の要素のバージョンを取得します
findText(searchPattern) RangeElement 正規表現を使用して、指定されたテキストパターンの要素のコンテンツを検索します
findText(searchPattern, from) RangeElement 特定の検索結果から開始して、指定されたテキストパターンの要素のコンテンツを検索します
getAttributes() Object 要素の属性を取得します
getAttributes(offset) Object 指定された文字オフセットで属性を取得します
getBackgroundColor() String 背景色の設定を取得します
getBackgroundColor(offset) String 指定された文字オフセットで背景色を取得します
getFontFamily() String フォントファミリ設定を取得します
getFontFamily(offset) String 指定された文字オフセットでフォントファミリを取得します
getFontSize() Number フォントサイズの設定を取得します
getFontSize(offset) Number 指定された文字オフセットでフォントサイズを取得します
getForegroundColor() String 前景色の設定を取得します
getForegroundColor(offset) String 指定された文字オフセットで前景色を取得します
getLinkUrl() String リンクURLを取得します
getLinkUrl(offset) String 指定された文字オフセットでリンクURLを取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getParent() ContainerElement 要素の親要素を取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getText() String 要素の内容をテキスト文字列として取得します
getTextAlignment() TextAlignment テキストの配置を取得します
getTextAlignment(offset) TextAlignment 単一の文字のテキスト配置を取得します
getTextAttributeIndices() Integer[] 個別のテキストフォーマット実行の開始に対応するテキストインデックスのセットを取得します
getType() ElementType 要素のを取得しますElementType
insertText(offset, text) Text 指定された文字オフセットで指定されたテキストを挿入します
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
isBold() Boolean 太字の設定を取得します
isBold(offset) Boolean 指定した文字オフセットで太字の設定を取得します
isItalic() Boolean 斜体の設定を取得します
isItalic(offset) Boolean 指定された文字オフセットでイタリック設定を取得します
isStrikethrough() Boolean 取り消し線設定を取得します
isStrikethrough(offset) Boolean 指定された文字オフセットで取り消し線設定を取得します
isUnderline() Boolean 下線設定を取得します
isUnderline(offset) Boolean 指定された文字オフセットで下線設定を取得します
merge() Text 要素を同じタイプの先行する兄弟とマージします
removeFromParent() Text 親から要素を削除します
replaceText(searchPattern, replacement) Element 正規表現を使用して、特定のテキストパターンのすべての出現を特定の置換文字列に置き換えます
setAttributes(startOffset, endOffsetInclusive, attributes) Text 指定された属性を指定された文字範囲に適用します
setAttributes(attributes) Text 要素の属性を設定します
setBackgroundColor(startOffset, endOffsetInclusive, color) Text 指定された文字範囲の背景色を設定します
setBackgroundColor(color) Text 背景色を設定します
setBold(bold) Text ボールド設定を設定します
setBold(startOffset, endOffsetInclusive, bold) Text 指定した文字範囲の太字設定を設定します
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName) Text 指定された文字範囲のフォントファミリを設定します
setFontFamily(fontFamilyName) Text フォントファミリーを設定します
setFontSize(startOffset, endOffsetInclusive, size) Text 指定した文字範囲のフォントサイズを設定します
setFontSize(size) Text フォントサイズを設定します
setForegroundColor(startOffset, endOffsetInclusive, color) Text 指定した文字範囲の前景色を設定します
setForegroundColor(color) Text 前景色を設定します
setItalic(italic) Text イタリック設定を設定します
setItalic(startOffset, endOffsetInclusive, italic) Text 指定された文字範囲の斜体設定を設定します
setLinkUrl(startOffset, endOffsetInclusive, url) Text 指定した文字範囲のリンクURLを設定します
setLinkUrl(url) Text リンクURLを設定します
setStrikethrough(strikethrough) Text 取り消し線設定を設定します
setStrikethrough(startOffset, endOffsetInclusive, strikethrough) Text 指定した文字範囲の取り消し線設定を設定します
setText(text) Text テキストの内容を設定します
setTextAlignment(startOffset, endOffsetInclusive, textAlignment) Text 指定された文字範囲のテキストの配置を設定します
setTextAlignment(textAlignment) Text テキストの配置を設定します
setUnderline(underline) Text 下線設定を設定します
setUnderline(startOffset, endOffsetInclusive, underline) Text 指定された文字範囲に下線設定を設定します

TextAlignment

プロパティ

物件 タイプ 説明
NORMAL Enum 通常のテキスト配置
SUPERSCRIPT Enum 上付きテキストの配置
SUBSCRIPT Enum 下付き文字のテキストの配置

UnsupportedElement

メソッド

メソッド 戻りタイプ 簡単な説明
copy() UnsupportedElement 現在の要素の分離されたディープコピーを返します
getAttributes() Object 要素の属性を取得します
getNextSibling() Element 要素の次の兄弟要素を取得します
getParent() ContainerElement 要素の親要素を取得します
getPreviousSibling() Element 要素の前の兄弟要素を取得します
getType() ElementType 要素のを取得しますElementType
isAtDocumentEnd() Boolean 要素がの末尾にあるかどうかを判別しDocumentます
merge() UnsupportedElement 要素を同じタイプの先行する兄弟とマージします
removeFromParent() UnsupportedElement 親から要素を削除します
setAttributes(attributes) UnsupportedElement 要素の属性を設定します

VerticalAlignment

プロパティ

物件 タイプ 説明
BOTTOM Enum 下揃えオプション
CENTER Enum 中央揃えオプション
TOP Enum 上揃えオプション

ドライブサービス

このサービスを使用すると、スクリプトでGoogleドライブのファイルとフォルダーを作成、検索、および変更できます

クラス

名前 簡単な説明
Access 明示的にアクセス権が付与された個々のユーザーに加えて、ファイルまたはフォルダーにアクセスできるユーザーのクラスを表す列挙体
DriveApp スクリプトがGoogleドライブのファイルとフォルダーを作成、検索、および変更できるようにします
File Googleドライブ内のファイル
FileIterator スクリプトが潜在的に大規模なファイルのコレクションを反復処理できるようにするイテレータ
Folder Googleドライブ内のフォルダー
FolderIterator 潜在的に大きなフォルダーのコレクションをスクリプトで反復処理できるようにするオブジェクト
Permission 明示的にアクセスを許可された個々のユーザーに加えて、ファイルまたはフォルダーにアクセスできるユーザーに付与されたアクセス許可を表す列挙体
User Googleドライブ内のファイルに関連付けられているユーザー

Access

プロパティ

物件 タイプ 説明
ANYONE Enum インターネット上の誰でも検索してアクセスできます
ANYONE_WITH_LINK Enum リンクを知っている人なら誰でもアクセスできます
DOMAIN Enum ドメイン内のユーザーが検索してアクセスできます
DOMAIN_WITH_LINK Enum リンクを知っているドメイン内のユーザーがアクセスできます
PRIVATE Enum 明示的に許可を与えられた人だけがアクセスできます

DriveApp

プロパティ

物件 タイプ 説明
Access Access 明示的にアクセス権が付与された個々のユーザーに加えて、ファイルまたはフォルダーにアクセスできるユーザーのクラスを表す列挙体
Permission Permission 明示的にアクセスを許可された個々のユーザーに加えて、ファイルまたはフォルダーにアクセスできるユーザーに付与されたアクセス許可を表す列挙体

メソッド

メソッド 戻りタイプ 簡単な説明
addFile(child) Folder 指定されたファイルをユーザーのドライブのルートに追加します
addFolder(child) Folder 指定したフォルダーをユーザーのドライブのルートに追加します
continueFileIterator(continuationToken) FileIterator 前の反復子からの継続トークンを使用して、ファイルの反復を再開します
continueFolderIterator(continuationToken) FolderIterator 前の反復子からの継続トークンを使用して、フォルダーの反復を再開します
createFile(blob) File Blob任意の任意のデータからユーザーのドライブのルートにファイルを作成します
createFile(name, content) File 指定された名前と内容で、ユーザーのドライブのルートにテキストファイルを作成します
createFile(name, content, mimeType) File 指定された名前、コンテンツ、MIMEタイプを使用して、ユーザーのドライブのルートにファイルを作成します
createFolder(name) Folder 指定した名前でユーザーのドライブのルートにフォルダーを作成します
getFileById(id) File 指定されたIDのファイルを取得します
getFiles() FileIterator ユーザーのドライブ内のすべてのファイルのコレクションを取得します
getFilesByName(name) FileIterator 指定された名前を持つユーザーのドライブ内のすべてのファイルのコレクションを取得します
getFilesByType(mimeType) FileIterator 指定されたMIMEタイプを持つユーザーのドライブ内のすべてのファイルのコレクションを取得します
getFolderById(id) Folder 指定されたIDのフォルダーを取得します
getFolders() FolderIterator ユーザーのドライブ内のすべてのフォルダーのコレクションを取得します
getFoldersByName(name) FolderIterator 指定された名前を持つユーザーのドライブ内のすべてのフォルダーのコレクションを取得します
getRootFolder() Folder ユーザーのドライブのルートにあるフォルダーを取得します
getStorageLimit() Integer ユーザーがドライブに保存できるバイト数を取得します
getStorageUsed() Integer ユーザーが現在ドライブに保存しているバイト数を取得します
getTrashedFiles() FileIterator ユーザーのドライブのゴミ箱にあるすべてのファイルのコレクションを取得します
getTrashedFolders() FolderIterator ユーザーのドライブのゴミ箱にあるすべてのフォルダーのコレクションを取得します
removeFile(child) Folder ユーザーのドライブのルートから指定されたファイルを削除します
removeFolder(child) Folder ユーザーのドライブのルートから指定されたフォルダーを削除します
searchFiles(params) FileIterator 指定された検索条件に一致するユーザーのドライブ内のすべてのファイルのコレクションを取得します
searchFolders(params) FolderIterator 指定した検索条件に一致するユーザーのドライブ内のすべてのフォルダーのコレクションを取得します

File

メソッド

メソッド 戻りタイプ 簡単な説明
addCommenter(emailAddress) File 指定したユーザーをのコメント投稿者のリストに追加しますFile
addCommenter(user) File 指定したユーザーをのコメント投稿者のリストに追加しますFile
addCommenters(emailAddresses) File 指定されたユーザーの配列をのコメント投稿者のリストに追加しFileます
addEditor(emailAddress) File 指定されたユーザーをのエディターのリストに追加しますFile
addEditor(user) File 指定されたユーザーをのエディターのリストに追加しますFile
addEditors(emailAddresses) File 指定されたユーザーの配列をのエディターのリストに追加しFileます
addViewer(emailAddress) File 指定されたユーザーをの視聴者リストに追加しますFile
addViewer(user) File 指定されたユーザーをの視聴者リストに追加しますFile
addViewers(emailAddresses) File 指定されたユーザーの配列をの視聴者のリストに追加しFileます
getAccess(email) Permission 指定されたユーザーに付与された許可を取得します
getAccess(user) Permission 指定されたユーザーに付与された許可を取得します
getAs(contentType) Blob このオブジェクト内のデータを、指定されたコンテンツタイプに変換されたblobとして返します
getBlob() Blob このオブジェクト内のデータをblobとして返します
getDateCreated() Date File作成日を取得します
getDescription() String の説明を取得しますFile
getDownloadUrl() String ファイルのダウンロードに使用できるURLを取得します
getEditors() User[] こののエディターのリストを取得しますFile
getId() String のIDを取得しますFile
getLastUpdated() Date Fileが最後に更新された日付を取得します
getMimeType() String ファイルのMIMEタイプを取得します
getName() String の名前を取得しますFile
getOwner() User の所有者を取得しますFile
getParents() FolderIterator の直接の親であるフォルダーのコレクションを取得しますFile
getSharingAccess() Access File明示的にアクセスを許可された個々のユーザーに加えて、にアクセスできるユーザーのクラスを取得します
getSharingPermission() Permission File明示的にアクセスを許可された個々のユーザーに加えて、にアクセスできるユーザーに付与された許可を取得します
getSize() Integer Fileドライブに保存するために使用されるバイト数を取得します
getThumbnail() Blob ファイルのサムネイル画像を取得するnullか、サムネイルが存在しない場合
getUrl() String FileドライブやドキュメントなどのGoogleアプリでを開くために使用できるURLを取得します
getViewers() User[] このの閲覧者とコメント投稿者のリストを取得しますFile
isShareableByEditors() Boolean 編集権限をFile持つユーザーが他のユーザーと共有したり、権限を変更したりできるかどうかを決定します
isStarred() Boolean Fileがユーザーのドライブでスター付きかどうかを判断します
isTrashed() Boolean Fileがユーザーのドライブのゴミ箱にあるかどうかを判断します
makeCopy() File ファイルのコピーを作成します
makeCopy(destination) File 宛先ディレクトリにファイルのコピーを作成します
makeCopy(name) File ファイルのコピーを作成し、指定された名前で名前を付けます
makeCopy(name, destination) File 宛先ディレクトリにファイルのコピーを作成し、指定された名前で名前を付けます
removeCommenter(emailAddress) File のコメント投稿者のリストから指定されたユーザーを削除しますFile
removeCommenter(user) File のコメント投稿者のリストから指定されたユーザーを削除しますFile
removeEditor(emailAddress) File のエディターのリストから指定されたユーザーを削除しますFile
removeEditor(user) File のエディターのリストから指定されたユーザーを削除しますFile
removeViewer(emailAddress) File の閲覧者とコメント投稿者のリストから指定されたユーザーを削除しますFile
removeViewer(user) File の閲覧者とコメント投稿者のリストから指定されたユーザーを削除しますFile
revokePermissions(user) File File指定されたユーザーに付与されたアクセスを取り消します
revokePermissions(user) File File指定されたユーザーに付与されたアクセスを取り消します
setContent(content) File 指定された置換でファイルの内容を上書きします
setDescription(description) File の説明を設定しますFile
setName(name) File の名前を設定しFileます
setOwner(emailAddress) File の所有者を変更しFileます
setOwner(user) File の所有者を変更しFileます
setShareableByEditors(shareable) File 編集権限をFile持つユーザーが他のユーザーと共有できるようにするか、権限を変更できるようにするかを設定します
setSharing(accessType, permissionType) File File明示的にアクセスを許可された個々のユーザーに加えて、どのクラスのユーザーがアクセスできるか、およびそれらのユーザーに付与される許可を設定します
setStarred(starred) File Fileがユーザーのドライブにスターを付けるかどうかを設定します
setTrashed(trashed) File Fileがユーザーのドライブのゴミ箱にあるかどうかを設定します

FileIterator

メソッド

メソッド 戻りタイプ 簡単な説明
getContinuationToken() String 後でこの反復を再開するために使用できるトークンを取得します
hasNext() Boolean 呼び出しnext()がアイテムを返すかどうかを決定します
next() File ファイルまたはフォルダーのコレクション内の次のアイテムを取得します

Folder

メソッド

メソッド 戻りタイプ 簡単な説明
addEditor(emailAddress) Folder 指定されたユーザーをのエディターのリストに追加しますFolder
addEditor(user) Folder 指定されたユーザーをのエディターのリストに追加しますFolder
addEditors(emailAddresses) Folder 指定されたユーザーの配列をのエディターのリストに追加しFolderます
addFile(child) Folder 指定されたファイルを現在のフォルダーに追加します
addFolder(child) Folder 指定したフォルダーを現在のフォルダーに追加します
addViewer(emailAddress) Folder 指定されたユーザーをの視聴者リストに追加しますFolder
addViewer(user) Folder 指定されたユーザーをの視聴者リストに追加しますFolder
addViewers(emailAddresses) Folder 指定されたユーザーの配列をの視聴者のリストに追加しFolderます
createFile(blob) File 与えられたBlob任意のデータから現在のフォルダーにファイルを作成します
createFile(name, content) File 指定した名前と内容で現在のフォルダーにテキストファイルを作成します
createFile(name, content, mimeType) File 指定された名前、コンテンツ、MIMEタイプで現在のフォルダーにファイルを作成します
createFolder(name) Folder 指定した名前で現在のフォルダーにフォルダーを作成します
getAccess(email) Permission 指定されたユーザーに付与された許可を取得します
getAccess(user) Permission 指定されたユーザーに付与された許可を取得します
getDateCreated() Date Folder作成日を取得します
getDescription() String の説明を取得しますFolder
getEditors() User[] こののエディターのリストを取得しますFolder
getFiles() FileIterator 現在のフォルダーの子であるすべてのファイルのコレクションを取得します
getFilesByName(name) FileIterator 現在のフォルダーの子であり、指定された名前を持つすべてのファイルのコレクションを取得します
getFilesByType(mimeType) FileIterator 現在のフォルダーの子であり、指定されたMIMEタイプを持つすべてのファイルのコレクションを取得します
getFolders() FolderIterator 現在のフォルダーの子であるすべてのフォルダーのコレクションを取得します
getFoldersByName(name) FolderIterator 現在のフォルダーの子であり、指定された名前を持つすべてのフォルダーのコレクションを取得します
getId() String のIDを取得しますFolder
getLastUpdated() Date Folderが最後に更新された日付を取得します
getName() String の名前を取得しますFolder
getOwner() User の所有者を取得しますFolder
getParents() FolderIterator の直接の親であるフォルダーのコレクションを取得しますFolder
getSharingAccess() Access Folder明示的にアクセスを許可された個々のユーザーに加えて、にアクセスできるユーザーのクラスを取得します
getSharingPermission() Permission Folder明示的にアクセスを許可された個々のユーザーに加えて、にアクセスできるユーザーに付与された許可を取得します
getSize() Integer Folderドライブに保存するために使用されるバイト数を取得します
getUrl() String FolderドライブやドキュメントなどのGoogleアプリでを開くために使用できるURLを取得します
getViewers() User[] このの閲覧者とコメント投稿者のリストを取得しますFolder
isShareableByEditors() Boolean 編集権限をFolder持つユーザーが他のユーザーと共有したり、権限を変更したりできるかどうかを決定します
isStarred() Boolean Folderがユーザーのドライブでスター付きかどうかを判断します
isTrashed() Boolean Folderがユーザーのドライブのゴミ箱にあるかどうかを判断します
removeEditor(emailAddress) Folder のエディターのリストから指定されたユーザーを削除しますFolder
removeEditor(user) Folder のエディターのリストから指定されたユーザーを削除しますFolder
removeFile(child) Folder 指定されたファイルを現在のフォルダーから削除します
removeFolder(child) Folder 現在のフォルダーから指定したフォルダーを削除します
removeViewer(emailAddress) Folder の閲覧者とコメント投稿者のリストから指定されたユーザーを削除しますFolder
removeViewer(user) Folder の閲覧者とコメント投稿者のリストから指定されたユーザーを削除しますFolder
revokePermissions(user) Folder Folder指定されたユーザーに付与されたアクセスを取り消します
revokePermissions(user) Folder Folder指定されたユーザーに付与されたアクセスを取り消します
searchFiles(params) FileIterator 現在のフォルダーの子であり、指定された検索条件に一致するすべてのファイルのコレクションを取得します
searchFolders(params) FolderIterator 現在のフォルダーの子であり、指定された検索条件に一致するすべてのフォルダーのコレクションを取得します
setDescription(description) Folder の説明を設定しますFolder
setName(name) Folder の名前を設定しFolderます
setOwner(emailAddress) Folder の所有者を変更しFolderます
setOwner(user) Folder の所有者を変更しFolderます
setShareableByEditors(shareable) Folder 編集権限をFolder持つユーザーが他のユーザーと共有できるようにするか、権限を変更できるようにするかを設定します
setSharing(accessType, permissionType) Folder Folder明示的にアクセスを許可された個々のユーザーに加えて、どのクラスのユーザーがアクセスできるか、およびそれらのユーザーに付与される許可を設定します
setStarred(starred) Folder Folderがユーザーのドライブにスターを付けるかどうかを設定します
setTrashed(trashed) Folder Folderがユーザーのドライブのゴミ箱にあるかどうかを設定します

FolderIterator

メソッド

メソッド 戻りタイプ 簡単な説明
getContinuationToken() String 後でこの反復を再開するために使用できるトークンを取得します
hasNext() Boolean 呼び出しnext()がアイテムを返すかどうかを決定します
next() Folder ファイルまたはフォルダーのコレクション内の次のアイテムを取得します

Permission

プロパティ

物件 タイプ 説明
VIEW Enum ファイルまたはフォルダーにアクセスできるユーザーは、表示またはコピーのみが可能です
EDIT Enum ファイルまたはフォルダーにアクセスできるユーザーは、編集できます
COMMENT Enum ファイルまたはフォルダーにアクセスできるユーザーは、表示、コピー、またはコメントのみが可能です
OWNER Enum ユーザーはファイルまたはフォルダーを所有します
ORGANIZER Enum 共有ドライブ内でファイルとフォルダーを整理できるユーザー
NONE Enum ユーザーには、ファイルまたはフォルダーに対するアクセス許可がありません

User

メソッド

メソッド 戻りタイプ 簡単な説明
getDomain() String ユーザーのアカウントに関連付けられたドメイン名を取得します
getEmail() String ユーザーのメールアドレスを取得します
getName() String ユーザーの名前を取得します
getPhotoUrl() String ユーザーの写真のURLを取得します

フォームサービス

このサービスを使用すると、スクリプトでGoogleフォームを作成、アクセス、変更できます

クラス

名前 簡単な説明
Alignment サポートされている画像配置のタイプを表す列挙体
CheckboxGridItem 質問項目列と行のグリッドとして表示され、回答者が一連のチェックボックスから行ごとに複数の選択肢を選択できるようにします
CheckboxGridValidation のDataValidation CheckboxGridItem
CheckboxGridValidationBuilder 以下のためのDataValidationBuilder CheckboxGridValidation
CheckboxItem 回答者が1つ以上のチェックボックスとオプションの「その他」フィールドを選択できるようにする質問項目
CheckboxValidation のDataValidation CheckboxItem
CheckboxValidationBuilder 以下のためのDataValidationBuilder CheckboxValidation
Choice 種類に関連付けられた単一の選択肢MultipleChoiceItem
DateItem 回答者が日付を示すことができる質問項目
DateTimeItem 回答者が日付と時刻を示すことができる質問項目
DestinationType サポートされているフォーム応答宛先のタイプを表す列挙体
DurationItem 回答者が時間の長さを示すことができる質問項目
FeedbackType サポートされているフィードバックのタイプを表す列挙体
Form 全体的なプロパティとアイテムを含むフォーム
FormApp スクリプトで既存のFormファイルを開くか、新しいスクリプトを作成できます
FormResponse フォーム全体に対する応答
GridItem 質問項目列と行のグリッドとして表示され、回答者がラジオボタンのシーケンスから行ごとに1つの選択肢を選択できるようにします
GridValidation のDataValidation GridItem
GridValidationBuilder 以下のためのDataValidationBuilder GridValidation
ImageItem 画像を表示するレイアウト項目
Item タイトルやヘルプテキストなど、すべてのアイテムに共通のプロパティを含む汎用フォームアイテム
ItemResponse フォーム内の1つの質問項目への応答
ItemType サポートされているフォーム項目のタイプを表す列挙体
ListItem 回答者がドロップダウンリストから1つの選択肢を選択できるようにする質問項目
MultipleChoiceItem 回答者がラジオボタンのリストまたはオプションの「その他」フィールドから1つの選択肢を選択できるようにする質問項目
PageBreakItem ページの開始をマークするレイアウト項目
PageNavigationType サポートされているページナビゲーションのタイプを表す列挙体
ParagraphTextItem 回答者がテキストブロックを入力できるようにする質問項目
ParagraphTextValidation のDataValidation ParagraphTextItem
ParagraphTextValidationBuilder 以下のためのDataValidationBuilder ParagraphTextValidation
QuizFeedback 表示テキストやリンクなど、すべてのフィードバックに共通のプロパティを含むフィードバックのBean実装
QuizFeedbackBuilder 表示テキストなど、すべてのフィードバックに共通のプロパティのセッターを含むベースFeedbackBuilder
ScaleItem 回答者が番号付きの一連のラジオボタンから1つのオプションを選択できるようにする質問項目
SectionHeaderItem セクションの開始を視覚的に示すレイアウト項目
TextItem 回答者が1行のテキストを入力できるようにする質問項目
TextValidation のDataValidation TextItem
TextValidationBuilder 以下のためのDataValidationBuilder TextValidation
TimeItem 回答者が時刻を示すことができる質問項目
VideoItem ビデオを表示するレイアウト項目

Alignment

プロパティ

物件 タイプ 説明
LEFT Enum 画像をフォームの左側に揃えます
CENTER Enum 画像をフォームの中央に揃えます
RIGHT Enum 画像をフォームの右側に揃えます

CheckboxGridItem

メソッド

メソッド 戻りタイプ 簡単な説明
clearValidation() CheckboxGridItem このグリッド項目のデータ検証を削除します
createResponse(responses) ItemResponse ItemResponseこのチェックボックスグリッドアイテムの新規を作成します
duplicate() CheckboxGridItem このアイテムのコピーを作成し、フォームの最後に追加します
getColumns() String[] グリッド内のすべての列の値を取得します
getHelpText() String (のようなレイアウトの項目にとも呼ばれる説明テキスト項目のヘルプテキストを取得しSectionHeaderItems)
getId() Integer アイテムの一意の識別子を取得します
getIndex() Integer フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します
getRows() String[] グリッド内のすべての行の値を取得します
getTitle() String アイテムのタイトルを取得します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
getType() ItemType として表されるアイテムのタイプを取得しますItemType
isRequired() Boolean 回答者が質問に回答する必要があるかどうかを決定します
setColumns(columns) CheckboxGridItem 値の配列に基づいてグリッドの列を設定します
setHelpText(text) CheckboxGridItem 設定した項目のヘルプテキスト(時々のようなレイアウト項目の説明テキストと呼ばれるSectionHeaderItems)
setRequired(enabled) CheckboxGridItem 回答者が質問に回答する必要があるかどうかを設定します
setRows(rows) CheckboxGridItem 値の配列に基づいてグリッドの行を設定します
setTitle(title) CheckboxGridItem アイテムのタイトルを設定します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
setValidation(validation) CheckboxGridItem このチェックボックスグリッド項目のデータ検証を設定します

CheckboxGridValidation

CheckboxGridValidationBuilder

メソッド

メソッド 戻りタイプ 簡単な説明
requireLimitOneResponsePerColumn() CheckboxGridValidationBuilder グリッドアイテムの列ごとに1つの応答の制限が必要です

CheckboxItem

メソッド

メソッド 戻りタイプ 簡単な説明
clearValidation() CheckboxItem このチェックボックス項目のデータ検証を削除します
createChoice(value) Choice 新しい選択肢を作成します
createChoice(value, isCorrect) Choice 新しい選択肢を作成します
createResponse(responses) ItemResponse ItemResponseこのチェックボックス項目の新しいを作成します
duplicate() CheckboxItem このアイテムのコピーを作成し、フォームの最後に追加します
getChoices() Choice[] アイテムのすべての選択肢を取得します
getFeedbackForCorrect() QuizFeedback 回答者が質問に正しく回答したときに表示されるフィードバックを返します
getFeedbackForIncorrect() QuizFeedback 回答者が質問に誤って応答したときに表示されるフィードバックを返します
getHelpText() String (のようなレイアウトの項目にとも呼ばれる説明テキスト項目のヘルプテキストを取得しSectionHeaderItems)
getId() Integer アイテムの一意の識別子を取得します
getIndex() Integer フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します
getPoints() Integer 採点可能なアイテムのポイント値を返します
getTitle() String アイテムのタイトルを取得します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
getType() ItemType として表されるアイテムのタイプを取得しますItemType
hasOtherOption() Boolean アイテムに「その他」オプションがあるかどうかを決定します
isRequired() Boolean 回答者が質問に回答する必要があるかどうかを決定します
setChoiceValues(values) CheckboxItem 文字列の配列から項目の選択肢を設定します
setChoices(choices) CheckboxItem アイテムの選択肢の配列を設定します
setFeedbackForCorrect(feedback) CheckboxItem 回答者が質問に正しく回答したときに回答者に表示されるフィードバックを設定します
setFeedbackForIncorrect(feedback) CheckboxItem 回答者が質問に誤って回答したときに表示されるフィードバックを設定します
setHelpText(text) CheckboxItem 設定した項目のヘルプテキスト(時々のようなレイアウト項目の説明テキストと呼ばれるSectionHeaderItems)
setPoints(points) CheckboxItem 採点可能なアイテムが価値があるポイントの数を設定します
setRequired(enabled) CheckboxItem 回答者が質問に回答する必要があるかどうかを設定します
setTitle(title) CheckboxItem アイテムのタイトルを設定します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
setValidation(validation) CheckboxItem このチェックボックス項目のデータ検証を設定します
showOtherOption(enabled) CheckboxItem アイテムに「その他」オプションがあるかどうかを設定します

CheckboxValidation

CheckboxValidationBuilder

メソッド

メソッド 戻りタイプ 簡単な説明
requireSelectAtLeast(number) CheckboxValidationBuilder 少なくともこの数の選択肢を選択する必要があります
requireSelectAtMost(number) CheckboxValidationBuilder 最大でこの数の選択肢を選択する必要があります
requireSelectExactly(number) CheckboxValidationBuilder まさにこれだけの選択肢を選択する必要があります

Choice

メソッド

メソッド 戻りタイプ 簡単な説明
getGotoPage() PageBreakItem レスポンダがこの選択を選択し、現在のページを完了する場合、宛先GO_TO_PAGEます
getPageNavigationType() PageNavigationType PageNavigationTypeレスポンダーがこの選択を選択し、現在のページを完了する場合に発生するを取得します
getValue() String フォームの表示時に回答者がラベルとして表示する選択肢の値を取得します
isCorrectAnswer() Boolean 選択が質問に対する正しい答えであるかどうかを取得します

DateItem

メソッド

メソッド 戻りタイプ 簡単な説明
createResponse(response) ItemResponse ItemResponseこの日付アイテムの新規を作成します
duplicate() DateItem このアイテムのコピーを作成し、フォームの最後に追加します
getGeneralFeedback() QuizFeedback 採点可能な質問に回答したときに回答者に表示されるフィードバックを返します
getHelpText() String (のようなレイアウトの項目にとも呼ばれる説明テキスト項目のヘルプテキストを取得しSectionHeaderItems)
getId() Integer アイテムの一意の識別子を取得します
getIndex() Integer フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します
getPoints() Integer 採点可能なアイテムのポイント値を返します
getTitle() String アイテムのタイトルを取得します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
getType() ItemType として表されるアイテムのタイプを取得しますItemType
includesYear() Boolean 日付項目に年オプションが含まれるかどうかを決定します
isRequired() Boolean 回答者が質問に回答する必要があるかどうかを決定します
setGeneralFeedback(feedback) DateItem 正解または不正解のない採点可能な質問(手動採点が必要な質問)に回答者が回答したときに表示されるフィードバックを設定します
setHelpText(text) DateItem 設定した項目のヘルプテキスト(時々のようなレイアウト項目の説明テキストと呼ばれるSectionHeaderItems)
setIncludesYear(enableYear) DateItem 日付項目に年設定が含まれるかどうかを設定します
setPoints(points) DateItem 採点可能なアイテムが価値があるポイントの数を設定します
setRequired(enabled) DateItem 回答者が質問に回答する必要があるかどうかを設定します
setTitle(title) DateItem アイテムのタイトルを設定します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)

DateTimeItem

メソッド

メソッド 戻りタイプ 簡単な説明
createResponse(response) ItemResponse ItemResponseこの日時アイテムに新しいを作成します
duplicate() DateTimeItem このアイテムのコピーを作成し、フォームの最後に追加します
getGeneralFeedback() QuizFeedback 採点可能な質問に回答したときに回答者に表示されるフィードバックを返します
getHelpText() String (のようなレイアウトの項目にとも呼ばれる説明テキスト項目のヘルプテキストを取得しSectionHeaderItems)
getId() Integer アイテムの一意の識別子を取得します
getIndex() Integer フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します
getPoints() Integer 採点可能なアイテムのポイント値を返します
getTitle() String アイテムのタイトルを取得します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
getType() ItemType として表されるアイテムのタイプを取得しますItemType
includesYear() Boolean 日付項目に年オプションが含まれるかどうかを決定します
isRequired() Boolean 回答者が質問に回答する必要があるかどうかを決定します
setGeneralFeedback(feedback) DateTimeItem 正解または不正解のない採点可能な質問(手動採点が必要な質問)に回答者が回答したときに表示されるフィードバックを設定します
setHelpText(text) DateTimeItem 設定した項目のヘルプテキスト(時々のようなレイアウト項目の説明テキストと呼ばれるSectionHeaderItems)
setIncludesYear(enableYear) DateTimeItem 日付項目に年設定が含まれるかどうかを設定します
setPoints(points) DateTimeItem 採点可能なアイテムが価値があるポイントの数を設定します
setRequired(enabled) DateTimeItem 回答者が質問に回答する必要があるかどうかを設定します
setTitle(title) DateTimeItem アイテムのタイトルを設定します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)

DestinationType

プロパティ

物件 タイプ 説明
SPREADSHEET Enum フォームの回答先としてのGoogleスプレッドシートスプレッドシート

DurationItem

メソッド

メソッド 戻りタイプ 簡単な説明
createResponse(hours, minutes, seconds) ItemResponse ItemResponseこの日付アイテムの新規を作成します
duplicate() DurationItem このアイテムのコピーを作成し、フォームの最後に追加します
getGeneralFeedback() QuizFeedback 採点可能な質問に回答したときに回答者に表示されるフィードバックを返します
getHelpText() String (のようなレイアウトの項目にとも呼ばれる説明テキスト項目のヘルプテキストを取得しSectionHeaderItems)
getId() Integer アイテムの一意の識別子を取得します
getIndex() Integer フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します
getPoints() Integer 採点可能なアイテムのポイント値を返します
getTitle() String アイテムのタイトルを取得します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
getType() ItemType として表されるアイテムのタイプを取得しますItemType
isRequired() Boolean 回答者が質問に回答する必要があるかどうかを決定します
setGeneralFeedback(feedback) DurationItem 正解または不正解のない採点可能な質問(手動採点が必要な質問)に回答者が回答したときに表示されるフィードバックを設定します
setHelpText(text) DurationItem 設定した項目のヘルプテキスト(時々のようなレイアウト項目の説明テキストと呼ばれるSectionHeaderItems)
setPoints(points) DurationItem 採点可能なアイテムが価値があるポイントの数を設定します
setRequired(enabled) DurationItem 回答者が質問に回答する必要があるかどうかを設定します
setTitle(title) DurationItem アイテムのタイトルを設定します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)

FeedbackType

プロパティ

物件 タイプ 説明
CORRECT Enum 質問に対する回答者に自動的に表示されるフィードバックは、正しく回答されました
INCORRECT Enum 誤って回答された質問に対する回答者に自動的に表示されるフィードバック
GENERAL Enum 回答者が回答を送信するときに自動的に表示されるフィードバック

Form

メソッド

メソッド 戻りタイプ 簡単な説明
addCheckboxGridItem() CheckboxGridItem 列と行のグリッドとして表示される新しい質問項目を追加しますこれにより、回答者は一連のチェックボックスから行ごとに複数の選択肢を選択できます
addCheckboxItem() CheckboxItem 回答者が1つ以上のチェックボックスとオプションの「その他」フィールドを選択できるようにする新しい質問項目を追加します
addDateItem() DateItem 回答者が日付を指定できるようにする新しい質問項目を追加します
addDateTimeItem() DateTimeItem 回答者が日付と時刻を示すことができる新しい質問項目を追加します
addDurationItem() DurationItem 回答者が時間の長さを示すことができる新しい質問項目を追加します
addEditor(emailAddress) Form 指定されたユーザーをのエディターのリストに追加しますForm
addEditor(user) Form 指定されたユーザーをのエディターのリストに追加しますForm
addEditors(emailAddresses) Form 指定されたユーザーの配列をのエディターのリストに追加しFormます
addGridItem() GridItem 列と行のグリッドとして表示される新しい質問項目を追加しますこれにより、回答者は一連のラジオボタンから行ごとに1つの選択肢を選択できます
addImageItem() ImageItem 画像を表示する新しいレイアウト項目を追加します
addListItem() ListItem 回答者がドロップダウンリストから1つの選択肢を選択できるようにする新しい質問項目を追加します
addMultipleChoiceItem() MultipleChoiceItem 回答者がラジオボタンのリストまたはオプションの「その他」フィールドから1つの選択肢を選択できるようにする新しい質問項目を追加します
addPageBreakItem() PageBreakItem ページの開始をマークする新しいレイアウトアイテムを追加します
addParagraphTextItem() ParagraphTextItem 回答者がテキストブロックを入力できるようにする新しい質問項目を追加します
addScaleItem() ScaleItem 回答者が番号付きの一連のラジオボタンから1つのオプションを選択できるようにする新しい質問項目を追加します
addSectionHeaderItem() SectionHeaderItem セクションの開始を視覚的に示す新しいレイアウトアイテムを追加します
addTextItem() TextItem 回答者が1行のテキストを入力できるようにする新しい質問項目を追加します
addTimeItem() TimeItem 回答者が時刻を指定できるようにする新しい質問項目を追加します
addVideoItem() VideoItem ビデオを表示する新しいレイアウトアイテムを追加します
canEditResponse() Boolean フォームに、送信後に応答を編集するためのリンクを表示するかどうかを決定します
collectsEmail() Boolean フォームが回答者の電子メールアドレスを収集するかどうかを決定します
createResponse() FormResponse フォームへの新しい応答を作成します
deleteAllResponses() Form 送信されたすべての応答をフォームの応答ストアから削除します
deleteItem(index) void フォーム内のすべてのアイテムから指定されたインデックスのアイテムを削除します
deleteItem(item) void 指定されたアイテムを削除します
deleteResponse(responseId) Form フォームの応答ストアから単一の応答を削除します
getConfirmationMessage() String フォームの確認メッセージを取得します
getCustomClosedFormMessage() String フォームが応答を受け入れない場合に表示されるカスタムメッセージを取得しますカスタムメッセージが設定されていない場合は空の文字列を取得します
getDescription() String フォームの説明を取得します
getDestinationId() String フォームの応答宛先のIDを取得します
getDestinationType() DestinationType フォームの応答宛先のタイプを取得します
getEditUrl() String フォームの編集モードにアクセスするために使用できるURLを取得します
getEditors() User[] こののエディターのリストを取得しますForm
getId() String フォームのIDを取得します
getItemById(id) Item 指定されたIDのアイテムを取得します
getItems() Item[] フォーム内のすべてのアイテムの配列を取得します
getItems(itemType) Item[] 指定されたタイプのすべてのアイテムの配列を取得します
getPublishedUrl() String フォームへの応答に使用できるURLを取得します
getResponse(responseId) FormResponse 応答IDに基づいて単一のフォーム応答を取得します
getResponses() FormResponse[] フォームのすべての応答の配列を取得します
getResponses(timestamp) FormResponse[] 指定された日時以降のフォームのすべての応答の配列を取得します
getShuffleQuestions() Boolean フォームの各ページの質問の順序をランダム化するかどうかを決定します
getSummaryUrl() String フォームの応答の概要を表示するために使用できるURLを取得します
getTitle() String フォームのタイトルを取得します
hasLimitOneResponsePerUser() Boolean フォームが回答者ごとに1つの応答のみを許可するかどうかを決定します
hasProgressBar() Boolean フォームに進行状況バーを表示するかどうかを決定します
hasRespondAgainLink() Boolean 回答者がフォームに記入した後に、フォームが別の応答を送信するためのリンクを表示するかどうかを決定します
isAcceptingResponses() Boolean フォームが現在応答を受け入れているかどうかを判別します
isPublishingSummary() Boolean 回答者がフォームに記入した後、フォームに回答の要約を表示するリンクを表示するかどうかを決定します
isQuiz() Boolean フォームがクイズかどうかを決定します
moveItem(from, to) Item フォーム内のすべてのアイテムの中で特定のインデックスにあるアイテムを別の特定のインデックスに移動します
moveItem(item, toIndex) Item フォーム内のすべてのアイテムのうち、指定されたアイテムを指定されたインデックスに移動します
removeDestination() Form 現在の応答宛先からフォームのリンクを解除します
removeEditor(emailAddress) Form のエディターのリストから指定されたユーザーを削除しますForm
removeEditor(user) Form のエディターのリストから指定されたユーザーを削除しますForm
requiresLogin() Boolean 回答者が回答する前に、回答者が同じドメインまたはサブドメインのアカウントにログインする必要があるかどうかを決定します
setAcceptingResponses(enabled) Form フォームが現在応答を受け入れているかどうかを設定します
setAllowResponseEdits(enabled) Form フォームに、送信後に応答を編集するためのリンクを表示するかどうかを設定します
setCollectEmail(collect) Form フォームが回答者の電子メールアドレスを収集するかどうかを設定します
setConfirmationMessage(message) Form フォームの確認メッセージを設定します
setCustomClosedFormMessage(message) Form フォームが応答を受け入れない場合に表示するメッセージを設定します
setDescription(description) Form フォームの説明を設定します
setDestination(type, id) Form フォームの回答が保存される宛先を設定します
setIsQuiz(enabled) Form フォームがクイズかどうかを設定します
setLimitOneResponsePerUser(enabled) Form フォームが回答者ごとに1つの応答のみを許可するかどうかを設定します
setProgressBar(enabled) Form フォームにプログレスバーがあるかどうかを設定します
setPublishingSummary(enabled) Form 回答者がフォームを送信した後、フォームに回答の要約を表示するリンクを表示するかどうかを設定します
setRequireLogin(requireLogin) Form 回答者が回答する前に、回答者が同じドメインまたはサブドメインのアカウントにログインする必要があるかどうかを設定します
setShowLinkToRespondAgain(enabled) Form 回答者がフォームに入力した後、フォームに別の応答を送信するリンクを表示するかどうかを設定します
setShuffleQuestions(shuffle) Form フォームの各ページの質問の順序をランダム化するかどうかを設定します
setTitle(title) Form フォームのタイトルを設定します
shortenFormUrl(url) String フォームの長いURLを短いURLに変換します
submitGrades(responses) Form 指定されたFormResponsesの成績を送信します

FormApp

プロパティ

物件 タイプ 説明
Alignment Alignment 画像配置のタイプの列挙
DestinationType DestinationType フォームの応答を保存できる宛先のタイプの列挙
FeedbackType FeedbackType フォームのタイプの列挙Feedbacks
ItemType ItemType フォームのタイプの列挙Items
PageNavigationType PageNavigationType ページをナビゲートするための可能な動作の列挙

メソッド

メソッド 戻りタイプ 簡単な説明
create(title) Form 新しいを作成して返しますForm
createCheckboxGridValidation() CheckboxGridValidationBuilder に検証を設定するために使用できるCheckboxGridValidationBuilderのインスタンスを返します CheckboxGridItem
createCheckboxValidation() CheckboxValidationBuilder に検証を設定するために使用できるCheckboxValidationBuilderのインスタンスを返します CheckboxItem
createFeedback() QuizFeedbackBuilder gradeableにフィードバックを設定するために使用できるQuizFeedbackBuilderのインスタンスを返します Item
createGridValidation() GridValidationBuilder に検証を設定するために使用できるGridValidationBuilderのインスタンスを返しますGridItem
createParagraphTextValidation() ParagraphTextValidationBuilder で検証を設定するために使用できるParagraphTextValidationBuilderのインスタンスを返しますParagraphTextItem
createTextValidation() TextValidationBuilder に検証を設定するために使用できるTextValidationBuilderのインスタンスを返しますTextItem
getActiveForm() Form スクリプトがコンテナにバインドされているフォームを返します
getUi() Ui スクリプトがメニュー、ダイアログ、サイドバーなどの機能を追加できるようにするフォームエディターのユーザーインターフェイス環境のインスタンスを返します
openById(id) Form Form指定されたIDでを返します
openByUrl(url) Form Form指定されたURLでを返します

FormResponse

メソッド

メソッド 戻りタイプ 簡単な説明
getEditResponseUrl() String すでに送信された応答の編集に使用できるURLを生成します
getGradableItemResponses() ItemResponse[] フォームレスポンスに含まれるすべてのアイテムレスポンスを、アイテムがフォームに表示されるのと同じ順序で取得します
getGradableResponseForItem(item) ItemResponse 特定のアイテムのフォームレスポンスに含まれるアイテムレスポンスを取得します
getId() String フォーム応答のIDを取得します
getItemResponses() ItemResponse[] フォームレスポンスに含まれるすべてのアイテムレスポンスを、アイテムがフォームに表示されるのと同じ順序で取得します
getRespondentEmail() String 設定が有効になっている場合、応答を送信した人の電子メールアドレスを取得しますForm.setCollectEmail(collect)
getResponseForItem(item) ItemResponse 特定のアイテムのこのフォームレスポンスに含まれるアイテムレスポンスを取得します
getTimestamp() Date フォーム応答送信のタイムスタンプを取得します
submit() FormResponse 応答を送信します
toPrefilledUrl() String このフォームレスポンスの回答に基づいて回答が事前に入力されているフォームのURLを生成します
withItemGrade(gradedResponse) FormResponse 指定された項目の回答の評点をフォームの回答に追加します
withItemResponse(response) FormResponse 指定されたアイテム応答をフォーム応答に追加します

GridItem

メソッド

メソッド 戻りタイプ 簡単な説明
clearValidation() GridItem このグリッド項目のデータ検証を削除します
createResponse(responses) ItemResponse ItemResponseこのグリッドアイテムの新規を作成します
duplicate() GridItem このアイテムのコピーを作成し、フォームの最後に追加します
getColumns() String[] グリッド内のすべての列の値を取得します
getHelpText() String (のようなレイアウトの項目にとも呼ばれる説明テキスト項目のヘルプテキストを取得しSectionHeaderItems)
getId() Integer アイテムの一意の識別子を取得します
getIndex() Integer フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します
getRows() String[] グリッド内のすべての行の値を取得します
getTitle() String アイテムのタイトルを取得します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
getType() ItemType として表されるアイテムのタイプを取得しますItemType
isRequired() Boolean 回答者が質問に回答する必要があるかどうかを決定します
setColumns(columns) GridItem 値の配列に基づいてグリッドの列を設定します
setHelpText(text) GridItem 設定した項目のヘルプテキスト(時々のようなレイアウト項目の説明テキストと呼ばれるSectionHeaderItems)
setRequired(enabled) GridItem 回答者が質問に回答する必要があるかどうかを設定します
setRows(rows) GridItem 値の配列に基づいてグリッドの行を設定します
setTitle(title) GridItem アイテムのタイトルを設定します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
setValidation(validation) GridItem このグリッド項目のデータ検証を設定します

GridValidation

GridValidationBuilder

メソッド

メソッド 戻りタイプ 簡単な説明
requireLimitOneResponsePerColumn() GridValidationBuilder グリッドアイテムの列ごとに1つの応答の制限が必要です

ImageItem

メソッド

メソッド 戻りタイプ 簡単な説明
duplicate() ImageItem このアイテムのコピーを作成し、フォームの最後に追加します
getAlignment() Alignment 画像の水平方向の配置を取得します
getHelpText() String (のようなレイアウトの項目にとも呼ばれる説明テキスト項目のヘルプテキストを取得しSectionHeaderItems)
getId() Integer アイテムの一意の識別子を取得します
getImage() Blob 現在アイテムに割り当てられている画像を取得します
getIndex() Integer フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します
getTitle() String アイテムのタイトルを取得します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
getType() ItemType として表されるアイテムのタイプを取得しますItemType
getWidth() Integer 画像の幅をピクセル単位で取得します
setAlignment(alignment) ImageItem 画像の水平方向の配置を設定します
setHelpText(text) ImageItem 設定した項目のヘルプテキスト(時々のようなレイアウト項目の説明テキストと呼ばれるSectionHeaderItems)
setImage(image) ImageItem 画像自体を設定します
setTitle(title) ImageItem アイテムのタイトルを設定します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
setWidth(width) ImageItem 画像の幅をピクセル単位で設定します

Item

メソッド

メソッド 戻りタイプ 簡単な説明
asCheckboxGridItem() CheckboxGridItem アイテムをチェックボックスグリッドアイテムとして返します
asCheckboxItem() CheckboxItem アイテムをチェックボックスアイテムとして返します
asDateItem() DateItem アイテムを日付アイテムとして返します
asDateTimeItem() DateTimeItem アイテムを日時アイテムとして返します
asDurationItem() DurationItem アイテムを期間アイテムとして返します
asGridItem() GridItem アイテムをグリッドアイテムとして返します
asImageItem() ImageItem アイテムを画像アイテムとして返します
asListItem() ListItem アイテムをリストアイテムとして返します
asMultipleChoiceItem() MultipleChoiceItem アイテムを複数選択アイテムとして返します
asPageBreakItem() PageBreakItem アイテムを改ページアイテムとして返します
asParagraphTextItem() ParagraphTextItem アイテムを段落テキストアイテムとして返します
asScaleItem() ScaleItem アイテムをスケールアイテムとして返します
asSectionHeaderItem() SectionHeaderItem アイテムをセクションヘッダーアイテムとして返します
asTextItem() TextItem アイテムをテキストアイテムとして返します
asTimeItem() TimeItem アイテムを時間アイテムとして返します
asVideoItem() VideoItem アイテムをビデオアイテムとして返します
duplicate() Item このアイテムのコピーを作成し、フォームの最後に追加します
getHelpText() String (のようなレイアウトの項目にとも呼ばれる説明テキスト項目のヘルプテキストを取得しSectionHeaderItems)
getId() Integer アイテムの一意の識別子を取得します
getIndex() Integer フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します
getTitle() String アイテムのタイトルを取得します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
getType() ItemType として表されるアイテムのタイプを取得しますItemType
setHelpText(text) Item 設定した項目のヘルプテキスト(時々のようなレイアウト項目の説明テキストと呼ばれるSectionHeaderItems)
setTitle(title) Item アイテムのタイトルを設定します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)

ItemResponse

メソッド

メソッド 戻りタイプ 簡単な説明
getFeedback() Object 回答者の提出された回答に対して与えられたフィードバックを取得します
getItem() Item この応答が回答する質問項目を取得します
getResponse() Object 回答者が送信した回答を取得します
getScore() Object 回答者が送信した回答のスコアを取得します
setFeedback(feedback) ItemResponse 回答者が送信した回答に対して表示するフィードバックを設定します
setScore(score) ItemResponse 回答者が送信した回答のスコアを設定します

ItemType

プロパティ

物件 タイプ 説明
CHECKBOX Enum 回答者が1つ以上のチェックボックスとオプションの「その他」フィールドを選択できるようにする質問項目
CHECKBOX_GRID Enum 質問項目列と行のグリッドとして表示され、回答者が一連のチェックボックスから行ごとに複数の選択肢を選択できるようにします
DATE Enum 回答者が日付を示すことができる質問項目
DATETIME Enum 回答者が日付と時刻を示すことができる質問項目
DURATION Enum 回答者が時間の長さを示すことができる質問項目
GRID Enum 質問項目列と行のグリッドとして表示され、回答者がラジオボタンのシーケンスから行ごとに1つの選択肢を選択できるようにします
IMAGE Enum 画像を表示するレイアウト項目
LIST Enum 回答者がドロップダウンリストから1つの選択肢を選択できるようにする質問項目
MULTIPLE_CHOICE Enum 回答者がラジオボタンのリストまたはオプションの「その他」フィールドから1つの選択肢を選択できるようにする質問項目
PAGE_BREAK Enum ページの開始をマークするレイアウト項目
PARAGRAPH_TEXT Enum 回答者がテキストブロックを入力できるようにする質問項目
SCALE Enum 回答者が番号付きの一連のラジオボタンから1つのオプションを選択できるようにする質問項目
SECTION_HEADER Enum セクションの開始を視覚的に示すレイアウト項目
TEXT Enum 回答者が1行のテキストを入力できるようにする質問項目
TIME Enum 回答者が時刻を示すことができる質問項目
VIDEO Enum YouTubeビデオを表示するレイアウトアイテム

ListItem

メソッド

メソッド 戻りタイプ 簡単な説明
createChoice(value) Choice 新しい選択肢を作成します
createChoice(value, isCorrect) Choice 新しい選択肢を作成します
createChoice(value, navigationItem) Choice 特定の改ページアイテムにジャンプするページナビゲーションオプションを使用して、新しい選択肢を作成します
createChoice(value, navigationType) Choice ページナビゲーションオプションで新しい選択肢を作成します
createResponse(response) ItemResponse ItemResponseこのリストアイテムの新しいを作成します
duplicate() ListItem このアイテムのコピーを作成し、フォームの最後に追加します
getChoices() Choice[] アイテムのすべての選択肢を取得します
getFeedbackForCorrect() QuizFeedback 回答者が質問に正しく回答したときに表示されるフィードバックを返します
getFeedbackForIncorrect() QuizFeedback 回答者が質問に誤って応答したときに表示されるフィードバックを返します
getHelpText() String (のようなレイアウトの項目にとも呼ばれる説明テキスト項目のヘルプテキストを取得しSectionHeaderItems)
getId() Integer アイテムの一意の識別子を取得します
getIndex() Integer フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します
getPoints() Integer 採点可能なアイテムのポイント値を返します
getTitle() String アイテムのタイトルを取得します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
getType() ItemType として表されるアイテムのタイプを取得しますItemType
isRequired() Boolean 回答者が質問に回答する必要があるかどうかを決定します
setChoiceValues(values) ListItem 文字列の配列から項目の選択肢を設定します
setChoices(choices) ListItem アイテムの選択肢の配列を設定します
setFeedbackForCorrect(feedback) ListItem 回答者が質問に正しく回答したときに回答者に表示されるフィードバックを設定します
setFeedbackForIncorrect(feedback) ListItem 回答者が質問に誤って回答したときに表示されるフィードバックを設定します
setHelpText(text) ListItem 設定した項目のヘルプテキスト(時々のようなレイアウト項目の説明テキストと呼ばれるSectionHeaderItems)
setPoints(points) ListItem 採点可能なアイテムが価値があるポイントの数を設定します
setRequired(enabled) ListItem 回答者が質問に回答する必要があるかどうかを設定します
setTitle(title) ListItem アイテムのタイトルを設定します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)

MultipleChoiceItem

メソッド

メソッド 戻りタイプ 簡単な説明
createChoice(value) Choice 新しい選択肢を作成します
createChoice(value, isCorrect) Choice 新しい選択肢を作成します
createChoice(value, navigationItem) Choice 特定の改ページアイテムにジャンプするページナビゲーションオプションを使用して、新しい選択肢を作成します
createChoice(value, navigationType) Choice ページナビゲーションオプションで新しい選択肢を作成します
createResponse(response) ItemResponse ItemResponseこの複数選択項目の新しいを作成します
duplicate() MultipleChoiceItem このアイテムのコピーを作成し、フォームの最後に追加します
getChoices() Choice[] アイテムのすべての選択肢を取得します
getFeedbackForCorrect() QuizFeedback 回答者が質問に正しく回答したときに表示されるフィードバックを返します
getFeedbackForIncorrect() QuizFeedback 回答者が質問に誤って応答したときに表示されるフィードバックを返します
getHelpText() String (のようなレイアウトの項目にとも呼ばれる説明テキスト項目のヘルプテキストを取得しSectionHeaderItems)
getId() Integer アイテムの一意の識別子を取得します
getIndex() Integer フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します
getPoints() Integer 採点可能なアイテムのポイント値を返します
getTitle() String アイテムのタイトルを取得します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
getType() ItemType として表されるアイテムのタイプを取得しますItemType
hasOtherOption() Boolean アイテムに「その他」オプションがあるかどうかを決定します
isRequired() Boolean 回答者が質問に回答する必要があるかどうかを決定します
setChoiceValues(values) MultipleChoiceItem 文字列の配列から項目の選択肢を設定します
setChoices(choices) MultipleChoiceItem アイテムの選択肢の配列を設定します
setFeedbackForCorrect(feedback) MultipleChoiceItem 回答者が質問に正しく回答したときに回答者に表示されるフィードバックを設定します
setFeedbackForIncorrect(feedback) MultipleChoiceItem 回答者が質問に誤って回答したときに表示されるフィードバックを設定します
setHelpText(text) MultipleChoiceItem 設定した項目のヘルプテキスト(時々のようなレイアウト項目の説明テキストと呼ばれるSectionHeaderItems)
setPoints(points) MultipleChoiceItem 採点可能なアイテムが価値があるポイントの数を設定します
setRequired(enabled) MultipleChoiceItem 回答者が質問に回答する必要があるかどうかを設定します
setTitle(title) MultipleChoiceItem アイテムのタイトルを設定します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
showOtherOption(enabled) MultipleChoiceItem アイテムに「その他」オプションがあるかどうかを設定します

PageBreakItem

メソッド

メソッド 戻りタイプ 簡単な説明
duplicate() PageBreakItem このアイテムのコピーを作成し、フォームの最後に追加します
getGoToPage() PageBreakItem PageBreakItemこの改ページの前にページを完了した後(つまり、フォームの通常の線形進行によってこの改ページに到達したとき)にフォームがジャンプすることを取得します
getHelpText() String (のようなレイアウトの項目にとも呼ばれる説明テキスト項目のヘルプテキストを取得しSectionHeaderItems)
getId() Integer アイテムの一意の識別子を取得します
getIndex() Integer フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します
getPageNavigationType() PageNavigationType この改ページの前にページを完了した後に発生するページナビゲーションの種類を取得します(つまり、フォームの通常の線形進行によってこの改ページに到達したとき)
getTitle() String アイテムのタイトルを取得します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
getType() ItemType として表されるアイテムのタイプを取得しますItemType
setGoToPage(goToPageItem) PageBreakItem この改ページの前にページを完了した後(つまり、フォームを通常の線形進行でこの改ページに到達したとき)にジャンプするページを設定します
setGoToPage(navigationType) PageBreakItem この改ページの前にページを完了した後に発生するページナビゲーションの種類を設定します(つまり、フォームの通常の線形進行によってこの改ページに到達したとき)
setHelpText(text) PageBreakItem 設定した項目のヘルプテキスト(時々のようなレイアウト項目の説明テキストと呼ばれるSectionHeaderItems)
setTitle(title) PageBreakItem アイテムのタイトルを設定します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)

PageNavigationType

プロパティ

物件 タイプ 説明
CONTINUE Enum 現在のページに入力したら、フォームの次のページに進みます
GO_TO_PAGE Enum 現在のページに入力した後、フォームの指定されたページにジャンプします
RESTART Enum 現在のページを完了した後、これまでに入力した回答をクリアせずに、フォームを最初から再起動します
SUBMIT Enum 現在のページを完了した後、フォームの回答を送信します

ParagraphTextItem

メソッド

メソッド 戻りタイプ 簡単な説明
clearValidation() ParagraphTextItem この段落テキスト項目のデータ検証を削除します
createResponse(response) ItemResponse ItemResponseこの段落テキストアイテムの新規を作成します
duplicate() ParagraphTextItem このアイテムのコピーを作成し、フォームの最後に追加します
getGeneralFeedback() QuizFeedback 採点可能な質問に回答したときに回答者に表示されるフィードバックを返します
getHelpText() String (のようなレイアウトの項目にとも呼ばれる説明テキスト項目のヘルプテキストを取得しSectionHeaderItems)
getId() Integer アイテムの一意の識別子を取得します
getIndex() Integer フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します
getPoints() Integer 採点可能なアイテムのポイント値を返します
getTitle() String アイテムのタイトルを取得します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
getType() ItemType として表されるアイテムのタイプを取得しますItemType
isRequired() Boolean 回答者が質問に回答する必要があるかどうかを決定します
setGeneralFeedback(feedback) ParagraphTextItem 正解または不正解のない採点可能な質問(手動採点が必要な質問)に回答者が回答したときに表示されるフィードバックを設定します
setHelpText(text) ParagraphTextItem 設定した項目のヘルプテキスト(時々のようなレイアウト項目の説明テキストと呼ばれるSectionHeaderItems)
setPoints(points) ParagraphTextItem 採点可能なアイテムが価値があるポイントの数を設定します
setRequired(enabled) ParagraphTextItem 回答者が質問に回答する必要があるかどうかを設定します
setTitle(title) ParagraphTextItem アイテムのタイトルを設定します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
setValidation(validation) ParagraphTextItem この段落テキスト項目のデータ検証を設定します

ParagraphTextValidation

ParagraphTextValidationBuilder

メソッド

メソッド 戻りタイプ 簡単な説明
requireTextContainsPattern(pattern) ParagraphTextValidationBuilder パターンを含む応答が必要です
requireTextDoesNotContainPattern(pattern) ParagraphTextValidationBuilder パターンを含まないように応答する必要があります
requireTextDoesNotMatchPattern(pattern) ParagraphTextValidationBuilder パターンに一致しない応答が必要です
requireTextLengthGreaterThanOrEqualTo(number) ParagraphTextValidationBuilder 応答の長さがvalue以上である必要があります
requireTextLengthLessThanOrEqualTo(number) ParagraphTextValidationBuilder 応答の長さが値より小さいことが必要です
requireTextMatchesPattern(pattern) ParagraphTextValidationBuilder パターンに一致する応答が必要です

QuizFeedback

メソッド

メソッド 戻りタイプ 簡単な説明
getLinkUrls() String[] フィードバックに関連付けられたURLのリストを取得します
getText() String フィードバックの表示テキストを取得します

QuizFeedbackBuilder

メソッド

メソッド 戻りタイプ 簡単な説明
addLink(url) QuizFeedbackBuilder フィードバックの補足資料へのリンクを追加します
addLink(url, displayText) QuizFeedbackBuilder フィードバックの補足資料へのリンクを追加します
build() QuizFeedback このビルダーに対応するタイプのフィードバックを作成します
copy() QuizFeedbackBuilder このビルダーのコピーを返します
setText(text) QuizFeedbackBuilder フィードバックテキストを設定します

ScaleItem

メソッド

メソッド 戻りタイプ 簡単な説明
createResponse(response) ItemResponse ItemResponseこのスケールアイテムの新しいを作成します
duplicate() ScaleItem このアイテムのコピーを作成し、フォームの最後に追加します
getGeneralFeedback() QuizFeedback 採点可能な質問に回答したときに回答者に表示されるフィードバックを返します
getHelpText() String (のようなレイアウトの項目にとも呼ばれる説明テキスト項目のヘルプテキストを取得しSectionHeaderItems)
getId() Integer アイテムの一意の識別子を取得します
getIndex() Integer フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します
getLeftLabel() String スケールの下限のラベルを取得します(ある場合)
getLowerBound() Integer スケールの下限を取得します
getPoints() Integer 採点可能なアイテムのポイント値を返します
getRightLabel() String スケールの上限のラベルを取得します(存在する場合)
getTitle() String アイテムのタイトルを取得します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
getType() ItemType として表されるアイテムのタイプを取得しますItemType
getUpperBound() Integer スケールの上限を取得します
isRequired() Boolean 回答者が質問に回答する必要があるかどうかを決定します
setBounds(lower, upper) ScaleItem スケールの下限と上限を設定します
setGeneralFeedback(feedback) ScaleItem 正解または不正解のない採点可能な質問(手動採点が必要な質問)に回答者が回答したときに表示されるフィードバックを設定します
setHelpText(text) ScaleItem 設定した項目のヘルプテキスト(時々のようなレイアウト項目の説明テキストと呼ばれるSectionHeaderItems)
setLabels(lower, upper) ScaleItem スケールの下限と上限のラベルを設定します
setPoints(points) ScaleItem 採点可能なアイテムが価値があるポイントの数を設定します
setRequired(enabled) ScaleItem 回答者が質問に回答する必要があるかどうかを設定します
setTitle(title) ScaleItem アイテムのタイトルを設定します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)

SectionHeaderItem

メソッド

メソッド 戻りタイプ 簡単な説明
duplicate() SectionHeaderItem このアイテムのコピーを作成し、フォームの最後に追加します
getHelpText() String (のようなレイアウトの項目にとも呼ばれる説明テキスト項目のヘルプテキストを取得しSectionHeaderItems)
getId() Integer アイテムの一意の識別子を取得します
getIndex() Integer フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します
getTitle() String アイテムのタイトルを取得します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
getType() ItemType として表されるアイテムのタイプを取得しますItemType
setHelpText(text) SectionHeaderItem 設定した項目のヘルプテキスト(時々のようなレイアウト項目の説明テキストと呼ばれるSectionHeaderItems)
setTitle(title) SectionHeaderItem アイテムのタイトルを設定します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)

TextItem

メソッド

メソッド 戻りタイプ 簡単な説明
clearValidation() TextItem このテキスト項目のデータ検証を削除します
createResponse(response) ItemResponse ItemResponseこのテキストアイテムの新規を作成します
duplicate() TextItem このアイテムのコピーを作成し、フォームの最後に追加します
getGeneralFeedback() QuizFeedback 採点可能な質問に回答したときに回答者に表示されるフィードバックを返します
getHelpText() String (のようなレイアウトの項目にとも呼ばれる説明テキスト項目のヘルプテキストを取得しSectionHeaderItems)
getId() Integer アイテムの一意の識別子を取得します
getIndex() Integer フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します
getPoints() Integer 採点可能なアイテムのポイント値を返します
getTitle() String アイテムのタイトルを取得します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
getType() ItemType として表されるアイテムのタイプを取得しますItemType
isRequired() Boolean 回答者が質問に回答する必要があるかどうかを決定します
setGeneralFeedback(feedback) TextItem 正解または不正解のない採点可能な質問(手動採点が必要な質問)に回答者が回答したときに表示されるフィードバックを設定します
setHelpText(text) TextItem 設定した項目のヘルプテキスト(時々のようなレイアウト項目の説明テキストと呼ばれるSectionHeaderItems)
setPoints(points) TextItem 採点可能なアイテムが価値があるポイントの数を設定します
setRequired(enabled) TextItem 回答者が質問に回答する必要があるかどうかを設定します
setTitle(title) TextItem アイテムのタイトルを設定します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
setValidation(validation) TextItem このテキスト項目のデータ検証を設定します

TextValidation

TextValidationBuilder

メソッド

メソッド 戻りタイプ 簡単な説明
requireNumber() TextValidationBuilder テキストアイテムには数字が必要です
requireNumberBetween(start, end) TextValidationBuilder テキストアイテムは、開始から終了までの数値である必要があります
requireNumberEqualTo(number) TextValidationBuilder テキスト項目は、指定された値と等しい数値である必要があります
requireNumberGreaterThan(number) TextValidationBuilder テキスト項目は、指定された値より大きい数値である必要があります
requireNumberGreaterThanOrEqualTo(number) TextValidationBuilder テキストアイテムには、指定した値以上の数値が必要です
requireNumberLessThan(number) TextValidationBuilder テキスト項目は、指定された値よりも小さい数値である必要があります
requireNumberLessThanOrEqualTo(number) TextValidationBuilder テキスト項目は、指定された値以下の数値である必要があります
requireNumberNotBetween(start, end) TextValidationBuilder テキストアイテムは、開始と終了の間にない数値である必要があります
requireNumberNotEqualTo(number) TextValidationBuilder テキスト項目は、指定された値と等しくない数値である必要があります
requireTextContainsPattern(pattern) TextValidationBuilder パターンを含む応答が必要です
requireTextDoesNotContainPattern(pattern) TextValidationBuilder パターンを含まないように応答する必要があります
requireTextDoesNotMatchPattern(pattern) TextValidationBuilder パターンに一致しない応答が必要です
requireTextIsEmail() TextValidationBuilder テキストアイテムにはメールアドレスが必要です
requireTextIsUrl() TextValidationBuilder テキストアイテムはURLである必要があります
requireTextLengthGreaterThanOrEqualTo(number) TextValidationBuilder 応答の長さがvalue以上である必要があります
requireTextLengthLessThanOrEqualTo(number) TextValidationBuilder 応答の長さが値より小さいことが必要です
requireTextMatchesPattern(pattern) TextValidationBuilder パターンに一致する応答が必要です
requireWholeNumber() TextValidationBuilder テキストアイテムは整数である必要があります

TimeItem

メソッド

メソッド 戻りタイプ 簡単な説明
createResponse(hour, minute) ItemResponse ItemResponseこの時間アイテムの新規を作成します
duplicate() TimeItem このアイテムのコピーを作成し、フォームの最後に追加します
getGeneralFeedback() QuizFeedback 採点可能な質問に回答したときに回答者に表示されるフィードバックを返します
getHelpText() String (のようなレイアウトの項目にとも呼ばれる説明テキスト項目のヘルプテキストを取得しSectionHeaderItems)
getId() Integer アイテムの一意の識別子を取得します
getIndex() Integer フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します
getPoints() Integer 採点可能なアイテムのポイント値を返します
getTitle() String アイテムのタイトルを取得します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
getType() ItemType として表されるアイテムのタイプを取得しますItemType
isRequired() Boolean 回答者が質問に回答する必要があるかどうかを決定します
setGeneralFeedback(feedback) TimeItem 正解または不正解のない採点可能な質問(手動採点が必要な質問)に回答者が回答したときに表示されるフィードバックを設定します
setHelpText(text) TimeItem 設定した項目のヘルプテキスト(時々のようなレイアウト項目の説明テキストと呼ばれるSectionHeaderItems)
setPoints(points) TimeItem 採点可能なアイテムが価値があるポイントの数を設定します
setRequired(enabled) TimeItem 回答者が質問に回答する必要があるかどうかを設定します
setTitle(title) TimeItem アイテムのタイトルを設定します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)

VideoItem

メソッド

メソッド 戻りタイプ 簡単な説明
duplicate() VideoItem このアイテムのコピーを作成し、フォームの最後に追加します
getAlignment() Alignment ビデオの水平方向の配置を取得します
getHelpText() String (のようなレイアウトの項目にとも呼ばれる説明テキスト項目のヘルプテキストを取得しSectionHeaderItems)
getId() Integer アイテムの一意の識別子を取得します
getIndex() Integer フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します
getTitle() String アイテムのタイトルを取得します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
getType() ItemType として表されるアイテムのタイプを取得しますItemType
getWidth() Integer ビデオの幅をピクセル単位で取得します
setAlignment(alignment) VideoItem ビデオの水平方向の配置を設定します
setHelpText(text) VideoItem 設定した項目のヘルプテキスト(時々のようなレイアウト項目の説明テキストと呼ばれるSectionHeaderItems)
setTitle(title) VideoItem アイテムのタイトルを設定します(の場合、ヘッダーテキストとも呼ばれますSectionHeaderItem)
setVideoUrl(youtubeUrl) VideoItem 指定されたYouTube URLまたはYouTubeビデオIDからビデオ自体を設定します
setWidth(width) VideoItem ビデオの幅をピクセル単位で設定します

Gmailサービス

このサービスを使用すると、メールの送信、下書きの作成、ラベルの管理、メッセージとスレッドのマーク付け、その他のさまざまなGmailアカウント管理タスクを実行できますMail Serviceも参照してくださいこれは、電子メールの送信のみを許可するより単純なサービスです

クラス

名前 簡単な説明
GmailApp Gmailのスレッド、メッセージ、ラベルへのアクセスを提供します
GmailAttachment Gmailからの添付ファイル
GmailDraft ユーザーのGmailアカウントにユーザーが作成した下書きメッセージ
GmailLabel ユーザーのGmailアカウントにユーザーが作成したラベル
GmailMessage ユーザーのGmailアカウントのメッセージ
GmailThread ユーザーのGmailアカウントのスレッド

GmailApp

メソッド

メソッド 戻りタイプ 簡単な説明
createDraft(recipient, subject, body) GmailDraft ドラフトメールメッセージを作成します
createDraft(recipient, subject, body, options) GmailDraft オプションの引数を使用してドラフトメールメッセージを作成します
createLabel(name) GmailLabel 指定された名前の新しいユーザーラベルを作成します
deleteLabel(label) GmailApp 指定されたラベルを削除します
getAliases() String[] Gmailでこのアカウントのエイリアスとして設定されているメールのリストを取得します
getChatThreads() GmailThread[] ラベルに関係なく、すべてのチャットスレッドを取得します
getChatThreads(start, max) GmailThread[] ラベルに関係なく、さまざまなチャットスレッドを取得します
getDraft(draftId) GmailDraft IDでメールメッセージの下書きを取得します
getDraftMessages() GmailMessage[] すべての下書きメッセージを取得します
getDrafts() GmailDraft[] すべてのGmailドラフトメッセージを取得します
getInboxThreads() GmailThread[] ラベルに関係なく、すべての受信トレイスレッドを取得します
getInboxThreads(start, max) GmailThread[] ラベルに関係なく、Inboxスレッドの範囲を取得します
getInboxUnreadCount() Integer 受信トレイ内の未読スレッドの数を取得します
getMessageById(id) GmailMessage IDでメッセージを取得します
getMessagesForThread(thread) GmailMessage[] 指定されたスレッド内のすべてのメッセージを取得します
getMessagesForThreads(threads) GmailMessage[][] 指定されたスレッド内のすべてのメッセージを取得します
getPriorityInboxThreads() GmailThread[] ラベルに関係なく、すべての優先トレイスレッドを取得します
getPriorityInboxThreads(start, max) GmailThread[] ラベルに関係なく、優先受信トレイスレッドの範囲を取得します
getPriorityInboxUnreadCount() Integer 優先トレイの未読スレッドの数を取得します
getSpamThreads() GmailThread[] ラベルに関係なく、すべてのスパムスレッドを取得します
getSpamThreads(start, max) GmailThread[] ラベルに関係なく、さまざまなスパムスレッドを取得します
getSpamUnreadCount() Integer スパムである未読スレッドの数を取得します
getStarredThreads() GmailThread[] ラベルに関係なく、すべてのスター付きスレッドを取得します
getStarredThreads(start, max) GmailThread[] ラベルに関係なく、スター付きスレッドの範囲を取得します
getStarredUnreadCount() Integer スター付きの未読スレッドの数を取得します
getThreadById(id) GmailThread IDでスレッドを取得します
getTrashThreads() GmailThread[] ラベルに関係なく、すべてのゴミスレッドを取得します
getTrashThreads(start, max) GmailThread[] ラベルに関係なく、ごみのスレッドの範囲を取得します
getUserLabelByName(name) GmailLabel ラベル名を指定してラベルを取得します
getUserLabels() GmailLabel[] ユーザーが作成したラベルのリストを取得します
markMessageRead(message) GmailApp このメッセージに既読のマークを付け、メッセージを強制的に更新します
markMessageUnread(message) GmailApp このメッセージを未読としてマークし、メッセージを強制的に更新します
markMessagesRead(messages) GmailApp これらのメッセージに既読のマークを付け、メッセージを強制的に更新します
markMessagesUnread(messages) GmailApp これらのメッセージを未読としてマークし、メッセージを強制的に更新します
markThreadImportant(thread) GmailApp このスレッドを重要としてマークし、スレッドを強制的に更新します
markThreadRead(thread) GmailApp このスレッドを既読としてマークし、スレッドを強制的に更新します
markThreadUnimportant(thread) GmailApp このスレッドを重要でないものとしてマークし、スレッドを強制的に更新します
markThreadUnread(thread) GmailApp このスレッドを未読としてマークし、スレッドを強制的に更新します
markThreadsImportant(threads) GmailApp これらのスレッドを重要としてマークし、スレッドを強制的に更新します
markThreadsRead(threads) GmailApp これらのスレッドを既読としてマークし、スレッドを強制的に更新します
markThreadsUnimportant(threads) GmailApp これらのスレッドを重要でないものとしてマークし、スレッドを強制的に更新します
markThreadsUnread(threads) GmailApp これらのスレッドを未読としてマークし、スレッドを強制的に更新します
moveMessageToTrash(message) GmailApp メッセージをゴミ箱に移動し、メッセージを強制的に更新します
moveMessagesToTrash(messages) GmailApp 指定されたメッセージをゴミ箱に移動し、メッセージを強制的に更新します
moveThreadToArchive(thread) GmailApp このスレッドをアーカイブに移動し、スレッドを強制的に更新します
moveThreadToInbox(thread) GmailApp このスレッドを受信ボックスに移動し、スレッドを強制的に更新します
moveThreadToSpam(thread) GmailApp このスレッドをスパムに移動し、スレッドを強制的に更新します
moveThreadToTrash(thread) GmailApp このスレッドをゴミ箱に移動し、スレッドを強制的に更新します
moveThreadsToArchive(threads) GmailApp これらのスレッドをアーカイブに移動し、スレッドを強制的に更新します
moveThreadsToInbox(threads) GmailApp これらのスレッドを受信ボックスに移動し、スレッドを強制的に更新します
moveThreadsToSpam(threads) GmailApp これらのスレッドをスパムに移動し、スレッドを強制的に更新します
moveThreadsToTrash(threads) GmailApp これらのスレッドをゴミ箱に移動し、スレッドを強制的に更新します
refreshMessage(message) GmailApp メッセージと関連する状態をGmailから再読み込みします(ラベル、読み取り状態などが変更された場合に便利です)
refreshMessages(messages) GmailApp Gmailからメッセージと関連する状態を再読み込みします(ラベル、読み取り状態などが変更された場合に便利です)
refreshThread(thread) GmailApp スレッドと関連する状態をGmailからリロードします(ラベル、読み取り状態などが変更された場合に便利です)
refreshThreads(threads) GmailApp スレッドと関連する状態をGmailからリロードします(ラベル、読み取り状態などが変更された場合に便利です)
search(query) GmailThread[] 指定されたクエリでGmailを検索します
search(query, start, max) GmailThread[] 指定されたクエリでGmailを検索します
sendEmail(recipient, subject, body) GmailApp 電子メールメッセージを送信します
sendEmail(recipient, subject, body, options) GmailApp オプションの引数を使用して電子メールメッセージを送信します
setCurrentMessageAccessToken(accessToken) void スクリプトが現在のプロパティにアクセスできるようにするGmailMessageます
starMessage(message) GmailApp このメッセージにスターを追加して、メッセージを強制的に更新します
starMessages(messages) GmailApp これらのメッセージに星を追加し、メッセージを強制的に更新します
unstarMessage(message) GmailApp このメッセージからスターを削除し、メッセージを強制的に更新します
unstarMessages(messages) GmailApp これらのメッセージから星を削除し、メッセージを強制的に更新します

GmailAttachment

メソッド

メソッド 戻りタイプ 簡単な説明
copyBlob() Blob このblobのコピーを返します
getAs(contentType) Blob このオブジェクト内のデータを、指定されたコンテンツタイプに変換されたblobとして返します
getBytes() Byte[] このblobに保存されているデータを取得します
getContentType() String このblobのバイトのコンテンツタイプを取得します
getDataAsString() String このblobのデータをUTF-8エンコーディングの文字列として取得します
getDataAsString(charset) String このblobのデータを、指定されたエンコーディングの文字列として取得します
getHash() String この添付ファイルのSHA1コンテンツハッシュを取得します
getName() String このblobの名前を取得します
getSize() Integer この添付ファイルのサイズを取得します
isGoogleType() Boolean このblobがG Suiteファイル(シート、ドキュメントなど)かどうかを返します
setBytes(data) Blob このblobに保存されているデータを設定します
setContentType(contentType) Blob このblobのバイトのコンテンツタイプを設定します
setContentTypeFromExtension() Blob ファイル拡張子に基づいて、このblobのバイトのコンテンツタイプを設定します
setDataFromString(string) Blob UTF-8エンコーディングで文字列からこのblobのデータを設定します
setDataFromString(string, charset) Blob 指定されたエンコーディングで文字列からこのblobのデータを設定します
setName(name) Blob このblobの名前を設定します

GmailDraft

メソッド

メソッド 戻りタイプ 簡単な説明
deleteDraft() void このドラフトメッセージを削除します
getId() String このドラフトメッセージのIDを取得します
getMessage() GmailMessage このドラフトを表すGmailMessageを返します
getMessageId() String GmailMessageこのドラフトを表すのIDを返します
send() GmailMessage このドラフトメールメッセージを送信します
update(recipient, subject, body) GmailDraft このドラフトメッセージの内容を置き換えます
update(recipient, subject, body, options) GmailDraft オプションの引数を使用して、このドラフトメッセージの内容を置き換えます

GmailLabel

メソッド

メソッド 戻りタイプ 簡単な説明
addToThread(thread) GmailLabel このラベルを特定のスレッドに追加し、スレッドを強制的に更新します()GmailThread.refresh()
addToThreads(threads) GmailLabel このラベルを特定のスレッドに追加し、スレッドを強制的に更新します
deleteLabel() void このラベルを削除します
getName() String このラベルの名前を取得します
getThreads() GmailThread[] このラベルでマークされたスレッドを取得します
getThreads(start, max) GmailThread[] このラベルでマークされたスレッドの範囲を取得します
getUnreadCount() Integer このラベルでタグ付けされた未読スレッドの数を取得します
removeFromThread(thread) GmailLabel 指定されたスレッドからこのラベルを削除し、スレッドを強制的に更新します
removeFromThreads(threads) GmailLabel 指定されたスレッドからこのラベルを削除し、スレッドを強制的に更新します

GmailMessage

メソッド

メソッド 戻りタイプ 簡単な説明
createDraftReply(body) GmailDraft 返信先アドレスを使用して、このメッセージの送信者に返信する下書きメッセージを作成します
createDraftReply(body, options) GmailDraft 返信先アドレスとオプションの引数を使用して、このメッセージの送信者に返信する下書きメッセージを作成します
createDraftReplyAll(body) GmailDraft 返信先アドレスとこのメッセージのすべての受信者を使用して、送信者に返信する下書きメッセージを作成します
createDraftReplyAll(body, options) GmailDraft 返信先アドレスとすべての受信者をオプションの引数とともに使用して、このメッセージの送信者に返信するドラフトメッセージを作成します
forward(recipient) GmailMessage このメッセージを新しい受信者に転送します
forward(recipient, options) GmailMessage オプションの引数を使用して、このメッセージを新しい受信者に転送します
getAttachments() GmailAttachment[] このメッセージのすべての添付ファイルを取得します
getAttachments(options) GmailAttachment[] このメッセージのすべての添付ファイルを取得します
getBcc() String このメッセージでbccされたコンマ区切りの受信者を取得します
getBody() String このメッセージの本文のHTMLコンテンツを取得します
getCc() String このメッセージでcc'dされたコンマ区切りの受信者を取得します
getDate() Date このメッセージの日付と時刻を取得します
getFrom() String このメッセージの送信者を取得します
getHeader(name) String 指定されたヘッダー名のRFC 2822ヘッダーの値を取得します
getId() String このメッセージのIDを取得します
getPlainBody() String HTMLフォーマットなしでこのメッセージの本文のコンテンツを取得します
getRawContent() String このメッセージの生のコンテンツを取得します
getReplyTo() String このメッセージの返信先アドレス(通常は送信者)を取得します
getSubject() String このメッセージの件名を取得します
getThread() GmailThread このメッセージを含むスレッドを取得します
getTo() String このメッセージのカンマ区切りの受信者を取得します
isDraft() Boolean このメッセージがドラフトかどうかを取得します
isInChats() Boolean このメッセージがチャットかどうかを取得します
isInInbox() Boolean このメッセージが受信トレイにあるかどうかを取得します
isInPriorityInbox() Boolean trueこのメッセージが優先トレイにあるかどうかを返しますfalseそれ以外の場合に戻ります
isInTrash() Boolean このメッセージがゴミ箱にあるかどうかを取得します
isStarred() Boolean このメッセージにスターを付けるかどうかを取得します
isUnread() Boolean このメッセージが未読かどうかを取得します
markRead() GmailMessage メッセージを既読としてマークします
markUnread() GmailMessage メッセージを未読としてマークします
moveToTrash() GmailMessage メッセージをゴミ箱に移動します
refresh() GmailMessage このメッセージと関連する状態をGmailから再読み込みします(ラベル、読み取り状態などが変更された場合に便利です)
reply(body) GmailMessage 返信先アドレスを使用して、このメッセージの送信者に返信します
reply(body, options) GmailMessage 返信先アドレスとオプションの引数を使用して、このメッセージの送信者に返信します
replyAll(body) GmailMessage このメッセージの返信先アドレスとすべての受信者を使用して、送信者に返信します
replyAll(body, options) GmailMessage 返信先アドレスとすべての受信者をオプションの引数とともに使用して、このメッセージの送信者に返信します
star() GmailMessage メッセージにスターを付けます
unstar() GmailMessage メッセージのスターを外します

GmailThread

メソッド

メソッド 戻りタイプ 簡単な説明
addLabel(label) GmailThread このラベルをスレッドに追加します
createDraftReply(body) GmailDraft 返信先アドレスを使用して、このスレッドの最後のメッセージの送信者に返信する下書きメッセージを作成します
createDraftReply(body, options) GmailDraft 返信先アドレスとオプションの引数を使用して、このスレッドの最後のメッセージの送信者に返信する下書きメッセージを作成します
createDraftReplyAll(body) GmailDraft 返信先アドレスとこのメッセージのすべての受信者を使用して、このスレッドの最後のメッセージの送信者に返信する下書きメッセージを作成します
createDraftReplyAll(body, options) GmailDraft 返信先アドレスとすべての受信者をオプションの引数とともに使用して、このスレッドの最後のメッセージの送信者に返信するドラフトメッセージを作成します
getFirstMessageSubject() String スレッド内の最初のメッセージの件名を取得します
getId() String このスレッドのIDを取得します
getLabels() GmailLabel[] このスレッドでユーザーが作成したラベルを返します
getLastMessageDate() Date このスレッドの最新のメッセージの日付を取得します
getMessageCount() Integer スレッド内のメッセージの数を返します
getMessages() GmailMessage[] このスレッドのメッセージを取得します
getPermalink() String このスレッドのパーマリンクを取得します
hasStarredMessages() Boolean スレッドにスター付きメッセージがあるかどうかを返します
isImportant() Boolean スレッドが重要とマークされているかどうかを返します
isInChats() Boolean スレッドにチャットのラベルが付いているかどうかを返します
isInInbox() Boolean スレッドが受信ボックスにあるかどうかを返します
isInPriorityInbox() Boolean このスレッドが優先トレイにある場合、trueを返しますそうでない場合はfalseを返します
isInSpam() Boolean スレッドがスパムとしてマークされているかどうかを返します
isInTrash() Boolean スレッドがゴミ箱にあるかどうかを返します
isUnread() Boolean スレッドに未読メッセージがあるかどうかを返します
markImportant() GmailThread このスレッドを重要としてマークします
markRead() GmailThread このスレッドを既読としてマークします
markUnimportant() GmailThread このスレッドを重要でないものとしてマークします
markUnread() GmailThread このスレッドを未読としてマークします
moveToArchive() GmailThread このスレッドをアーカイブに移動します
moveToInbox() GmailThread このスレッドを受信ボックスに移動します
moveToSpam() GmailThread このスレッドをスパムに移動します
moveToTrash() GmailThread このスレッドをゴミ箱に移動します
refresh() GmailThread このスレッドと関連する状態をGmailから再読み込みします(ラベル、読み取り状態などが変更された場合に便利です)
removeLabel(label) GmailThread スレッドからこのラベルを削除します
reply(body) GmailThread replyToアドレスを使用して、このスレッドの最後のメッセージの送信者に返信します
reply(body, options) GmailThread replyToアドレスとオプションの引数を使用して、このスレッドの最後のメッセージの送信者に返信します
replyAll(body) GmailThread 送信者(replyToアドレスを使用)、およびこのスレッドの最後のメッセージのすべての受信者に返信します
replyAll(body, options) GmailThread replyToオプションの引数を使用して、送信者(アドレスを使用)、およびこのスレッドの最後のメッセージのすべての受信者に返信します

グループサービス

このサービスにより、スクリプトはGoogleグループにアクセスできますグループの電子メールアドレスなどの情報、またはユーザーが直接のメンバーであるグループのリストを照会するために使用できます現在のユーザーがメンバーになっているグループの数を示す例を次に示します

クラス

名前 簡単な説明
Group グループ内のメンバーとそれらのメンバーのロールを照会できるグループオブジェクト
GroupsApp このクラスは、Googleグループ情報へのアクセスを提供します
Role 所有者や普通のメンバーなど、グループ内のユーザーの可能なロール

Group

メソッド

メソッド 戻りタイプ 簡単な説明
getEmail() String このグループのメールアドレスを取得します
getGroups() Group[] グループの直接の子グループを取得します
getRole(email) Role グループのコンテキストでユーザーのロールを取得します
getRole(user) Role グループのコンテキストでユーザーのロールを取得します
getRoles(users) Role[] グループのコンテキストでユーザーのロールを取得します
getUsers() User[] 対応する既知のGoogleアカウントを持つグループの直接メンバーを取得します
hasGroup(group) Boolean グループがこのグループの直接のメンバーであるかどうかをテストします
hasGroup(email) Boolean グループがこのグループの直接のメンバーであるかどうかをテストします
hasUser(email) Boolean ユーザーがグループの直接のメンバーかどうかをテストします
hasUser(user) Boolean ユーザーがグループの直接のメンバーかどうかをテストします

GroupsApp

プロパティ

物件 タイプ 説明
Role Role

メソッド

メソッド 戻りタイプ 簡単な説明
getGroupByEmail(email) Group 指定されたメールアドレスを持つグループを取得します
getGroups() Group[] 自分が直接のメンバー(または保留中のメンバー)であるすべてのグループを取得します

Role

プロパティ

物件 タイプ 説明
OWNER Enum グループの所有者
MANAGER Enum グループのマネージャー
MEMBER Enum このグループのメンバーであるが、所有者でも管理者でもないユーザー
INVITED Enum グループの所有者またはマネージャーによってグループへの参加を招待されているが、招待をまだ受け入れていないユーザー
PENDING Enum グループへの参加をリクエストしたが、所有者またはマネージャーによってまだ承認されていないユーザー

言語サービス

このサービスにより、スクリプトはテキストを自動的に翻訳できます

クラス

名前 簡単な説明
LanguageApp 言語サービスは、テキストの自動翻訳を計算するメソッドをスクリプトに提供します

LanguageApp

メソッド

メソッド 戻りタイプ 簡単な説明
translate(text, sourceLanguage, targetLanguage) String 一部のテキストをソース言語から宛先言語に自動的に翻訳します
translate(text, sourceLanguage, targetLanguage, advancedArgs) String 一部のテキストをソース言語から宛先言語に自動的に翻訳します

マップサービス

このサービスにより、スクリプトは静的マップを生成し、方向を見つけ、住所をジオコード座標に変換し、標高をサンプリングできます

クラス

名前 簡単な説明
Avoid ルートを検索するときに回避する制限の種類を表す列挙体
Color マップ画像で使用できる名前付きの色を表す列挙体
DirectionFinder ロケーション間のルートを取得できます
DirectionFinderEnums で使用される列挙型のコレクションDirectionFinder
ElevationSampler 特定の場所で標高のサンプリングを許可します
Format マップ画像の形式を表す列挙体
Geocoder 住所と地理座標の間の変換を許可します
Maps 方向探知、ジオコーディング、標高サンプリング、静的マップ画像の作成が可能です
MarkerSize マップに追加されたマーカーのサイズを表す列挙体
Mode ルートを検索するときに使用する移動モードを表す列挙体
StaticMap 静的なマップ画像の作成と装飾を許可します
StaticMapEnums で使用される列挙型のコレクションStaticMap
Type レンダリングするマップのタイプを表す列挙体

Avoid

プロパティ

物件 タイプ 説明
TOLLS Enum 通行料を避けます
HIGHWAYS Enum 高速道路を避ける

Color

プロパティ

物件 タイプ 説明
BLACK Enum
BROWN Enum
GREEN Enum
PURPLE Enum
YELLOW Enum
BLUE Enum
GRAY Enum
ORANGE Enum
RED Enum
WHITE Enum

DirectionFinder

メソッド

メソッド 戻りタイプ 簡単な説明
addWaypoint(latitude, longitude) DirectionFinder ポイント(lat / lng)を使用して、ルートが通過するウェイポイントを追加します
addWaypoint(address) DirectionFinder アドレスを使用して、ルートが通過するウェイポイントを追加します
clearWaypoints() DirectionFinder 現在のウェイポイントのセットをクリアします
getDirections() Object 設定された出発地、目的地、およびその他のオプションを使用してルートを取得します
setAlternatives(useAlternatives) DirectionFinder 最高ランクのルートだけでなく、代替ルートを返すかどうかを設定します(デフォルトはfalse)
setArrive(time) DirectionFinder 必要な到着時刻を設定します(該当する場合)
setAvoid(avoid) DirectionFinder 特定の種類の制限を回避するかどうかを設定します
setDepart(time) DirectionFinder 目的の出発時刻を設定します(該当する場合)
setDestination(latitude, longitude) DirectionFinder ポイント(緯度/経度)を使用して、方向を計算する終了位置を設定します
setDestination(address) DirectionFinder 住所を使用して、ルートを計算する終了位置を設定します
setLanguage(language) DirectionFinder ルートに使用する言語を設定します
setMode(mode) DirectionFinder 旅行モードを設定します(デフォルトは運転モード)
setOptimizeWaypoints(optimizeOrder) DirectionFinder ウェイポイントをより効率的な順序に再配置することにより、提供されたルートを最適化するかどうかを設定します(デフォルトはfalse)
setOrigin(latitude, longitude) DirectionFinder ポイント(緯度/経度)を使用して、ルートを計算する開始位置を設定します
setOrigin(address) DirectionFinder 住所を使用して、ルートを計算する開始位置を設定します
setRegion(region) DirectionFinder ロケーション名を解釈するときに使用するリージョンを設定します

DirectionFinderEnums

プロパティ

物件 タイプ 説明
Avoid Avoid
Mode Mode

ElevationSampler

メソッド

メソッド 戻りタイプ 簡単な説明
sampleLocation(latitude, longitude) Object 単一ポイント(緯度/経度)の標高データを返します
sampleLocations(points) Object 一連のポイントの標高データ(緯度/経度)を返します
sampleLocations(encodedPolyline) Object エンコードされたポリラインのポイントの標高データを返します
samplePath(points, numSamples) Object 一連のポイントを使用して定義された、ラインに沿った多数のサンプルの標高データを返します
samplePath(encodedPolyline, numSamples) Object エンコードされたポリラインを使用して定義された、ラインに沿った多数のサンプルの標高データを返します

Format

プロパティ

物件 タイプ 説明
PNG Enum 8ビットPNG形式
PNG8 Enum 8ビットPNG形式
PNG32 Enum 32ビットPNG形式
GIF Enum GIF形式
JPG Enum JPEG形式
JPG_BASELINE Enum 非プログレッシブJPEG形式

Geocoder

メソッド

メソッド 戻りタイプ 簡単な説明
geocode(address) Object 指定された住所のおおよその地理的ポイントを取得します
reverseGeocode(latitude, longitude) Object 特定の地理的ポイントのおおよその住所を取得します
reverseGeocode(swLatitude, swLongitude, neLatitude, neLongitude) Object 特定のエリアのおおよその住所を取得します
setBounds(swLatitude, swLongitude, neLatitude, neLongitude) Geocoder 結果に追加の優先度を与える必要がある領域の境界を設定します
setLanguage(language) Geocoder 結果で使用される言語を設定します
setRegion(region) Geocoder ロケーション名を解釈するときに使用するリージョンを設定します

Maps

プロパティ

物件 タイプ 説明
DirectionFinder DirectionFinderEnums
StaticMap StaticMapEnums

メソッド

メソッド 戻りタイプ 簡単な説明
decodePolyline(polyline) Number[] エンコードされたポリライン文字列をデコードしてポイントの配列に戻します
encodePolyline(points) String ポイントの配列を文字列にエンコードします
newDirectionFinder() DirectionFinder 新しいDirectionFinderオブジェクトを作成します
newElevationSampler() ElevationSampler ElevationSamplerオブジェクトを作成します
newGeocoder() Geocoder 新しいジオコーダーオブジェクトを作成します
newStaticMap() StaticMap 新しいStaticMapオブジェクトを作成します
setAuthentication(clientId, signingKey) void 外部で設定された割り当て量を活用できます

MarkerSize

プロパティ

物件 タイプ 説明
TINY Enum 小さなサイズの市場(利用可能な最小のもの)
MID Enum 中サイズのマーカー(利用可能な最大のもの)
SMALL Enum 小型のマーカー

Mode

プロパティ

物件 タイプ 説明
DRIVING Enum 道路経由の道順
WALKING Enum 歩行者用の小道と歩道(利用可能な場合)を介した徒歩ルート
BICYCLING Enum 自転車道と優先道路(利用可能な場合)を介した自転車の道順
TRANSIT Enum 公共交通機関経由の乗換案内(利用可能な場合)

StaticMap

メソッド

メソッド 戻りタイプ 簡単な説明
addAddress(address) StaticMap 現在のパス定義に新しいアドレスを追加します
addMarker(latitude, longitude) StaticMap ポイント(lat / lng)を使用してマーカーをマップに追加します
addMarker(address) StaticMap 住所を使用してマーカーを地図に追加します
addPath(points) StaticMap ポイントの配列を使用して、マップにパスを追加します
addPath(polyline) StaticMap エンコードされたポリラインを使用して、マップにパスを追加します
addPoint(latitude, longitude) StaticMap 現在のパス定義に新しいポイント(lat / lng)を追加します
addVisible(latitude, longitude) StaticMap マップに表示する必要があるポイント(緯度/経度)の場所を追加します
addVisible(address) StaticMap マップに表示する必要がある住所の場所を追加します
beginPath() StaticMap 新しいパス定義を開始します
clearMarkers() StaticMap 現在のマーカーのセットをクリアします
clearPaths() StaticMap 現在のパスのセットをクリアします
clearVisibles() StaticMap 現在の表示位置のセットをクリアします
endPath() StaticMap beginPath()で開始されたパス定義を完了します
getAs(contentType) Blob このオブジェクト内のデータを、指定されたコンテンツタイプに変換されたblobとして返します
getBlob() Blob 画像データをとして取得しますBlob
getMapImage() Byte[] 生の画像データをバイト配列として取得します
getMapUrl() String マップ画像のURLを取得します
setCenter(latitude, longitude) StaticMap ポイント(lat / lng)を使用してマップの中心を設定します
setCenter(address) StaticMap アドレスを使用してマップの中心を設定します
setCustomMarkerStyle(imageUrl, useShadow) StaticMap 新しいマーカーを作成するときに使用するカスタムマーカー画像を設定します
setFormat(format) StaticMap マップ画像の形式を設定します
setLanguage(language) StaticMap マップ上のテキストに使用する言語を設定します(avaialbeの場合)
setMapType(mapType) StaticMap 表示するマップのタイプを設定します
setMarkerStyle(size, color, label) StaticMap 新しいマーカーを作成するときに使用するマーカースタイルを設定します
setMobile(useMobileTiles) StaticMap モバイルデバイスに特殊なタイルセットを使用するかどうかを設定します
setPathStyle(weight, color, fillColor) StaticMap 新しいパスを作成するときに使用するパススタイルを設定します
setSize(width, height) StaticMap マップ画像の幅と高さをピクセル単位で設定します
setZoom(zoom) StaticMap マップに使用されるズーム率、または拡大レベルを設定します

StaticMapEnums

プロパティ

物件 タイプ 説明
Color Color
Format Format
MarkerSize MarkerSize
Type Type

Type

プロパティ

物件 タイプ 説明
ROADMAP Enum 通常、GoogleマップのWebサイトに表示される標準ロードマップ
SATELLITE Enum 衛星地図
TERRAIN Enum 地形と植生を示す物理的なレリーフマップ
HYBRID Enum 衛星地図と道路地図のハイブリッド衛星地図上に主要な道路と地名の透明なレイヤーを表示します

サイトサービス

このサービスは、Googleサイト(クラシック)へのアクセスを提供します

クラス

名前 簡単な説明
Attachment ページに添付されたファイルなどのサイト添付ファイル
AttachmentType サイト添付タイプのタイプセーフ列挙
Column サイト列-サイトリストページの列
Comment [サイト]ページに添付されたコメント
ListItem Sites ListItem-Sites Listページのリスト要素
Page Googleサイトのページ
PageType サイトページタイプの型保証された列挙
Site Googleサイトを表すオブジェクト
SitesApp Googleサイトを作成してアクセスします

Attachment

メソッド

メソッド 戻りタイプ 簡単な説明
deleteAttachment() void この添付ファイルを削除します
getAs(contentType) Blob このオブジェクト内のデータを、指定されたコンテンツタイプに変換されたblobとして返します
getAttachmentType() AttachmentType この添付ファイルのタイプ(HOSTEDまたはWEB)を返します
getBlob() Blob このオブジェクト内のデータをblobとして返します
getContentType() String この添付ファイルのMIMEタイプを返します
getDatePublished() Date この添付ファイルが最初に公開された日付を返します
getDescription() String この添付ファイルの説明を返します
getLastUpdated() Date この添付ファイルが最後に更新された日付を返します
getParent() Page この添付ファイルの親ページを取得します
getTitle() String この添付ファイルのタイトルを返します
getUrl() String この添付ファイルのダウンロードURLを返します
setContentType(contentType) Attachment この添付ファイルのMIMEタイプを設定します
setDescription(description) Attachment この添付ファイルの説明を設定します
setFrom(blob) Attachment この添付ファイルの実際のデータを設定します
setParent(parent) Attachment この添付ファイルの親ページを設定します
setTitle(title) Attachment この添付ファイルのタイトルを設定します
setUrl(url) Attachment この添付ファイルのダウンロードURLを設定します

AttachmentType

プロパティ

物件 タイプ 説明
WEB Enum
HOSTED Enum

Column

メソッド

メソッド 戻りタイプ 簡単な説明
deleteColumn() void この列を削除します
getName() String この列の名前を取得します
getParent() Page この列が属するリストページを返します
setName(name) Column この列の名前を設定します

Comment

メソッド

メソッド 戻りタイプ 簡単な説明
deleteComment() void このコメントを削除します
getAuthorEmail() String このコメントの作成者のメールアドレスを取得します
getAuthorName() String このコメントの著者の名前を取得します
getContent() String このコメントの内容を文字列として返します
getDatePublished() Date このコメントが最初に公開された日付を返します
getLastUpdated() Date このコメントが最後に更新された日付を返します
getParent() Page このコメントの親ページを取得します
setContent(content) Comment このコメントの内容を設定します
setParent(parent) Comment このコメントの親ページを設定します

ListItem

メソッド

メソッド 戻りタイプ 簡単な説明
deleteListItem() void このリスト項目を削除します
getDatePublished() Date このリスト項目が最初に公開された日付を返します
getLastUpdated() Date このコメントが最後に更新された日付を返します
getParent() Page このリストアイテムの親ページを取得します
getValueByIndex(index) String 番号付き列のこのListItemの値を取得します
getValueByName(name) String 名前付き列のこのListItemの値を取得します
setParent(parent) ListItem このリストアイテムの親ページを設定します
setValueByIndex(index, value) ListItem 番号付き列のこのListItemの値を設定します
setValueByName(name, value) ListItem 番号付き列のこのListItemの値を設定します

Page

メソッド

メソッド 戻りタイプ 簡単な説明
addColumn(name) Column リストに新しい列を追加します
addHostedAttachment(blob) Attachment ページに添付ファイルを追加します
addHostedAttachment(blob, description) Attachment ページに添付ファイルを追加します
addListItem(values) ListItem リストにリストアイテムを追加します
addWebAttachment(title, description, url) Attachment Web添付ファイルをページに追加します
createAnnouncement(title, html) Page このページのお知らせを作成します
createAnnouncement(title, html, asDraft) Page このページのお知らせを作成します
createAnnouncementsPage(title, name, html) Page 新しいお知らせページを作成します
createFileCabinetPage(title, name, html) Page 新しいファイルキャビネットページを作成します
createListPage(title, name, html, columnNames) Page 新しいリストページを作成します
createPageFromTemplate(title, name, template) Page テンプレートから新しいページを作成します
createWebPage(title, name, html) Page 新しいWebページを作成します
deletePage() void このページを削除します
getAllDescendants() Page[] 最大200ページの子孫ページ(直接および間接)の配列を取得します
getAllDescendants(options) Page[] オプションの高度な引数を使用して、子孫ページの配列を取得します
getAnnouncements() Page[] このページのお知らせを入手してください
getAnnouncements(optOptions) Page[] このページのお知らせを入手してください
getAttachments() Attachment[] このページの添付ファイルを取得します
getAttachments(optOptions) Attachment[] このページの添付ファイルを取得します
getAuthors() String[] ページの作者のメールを取得する
getChildByName(name) Page 特定の子ページを取得します
getChildren() Page[] 200ページの制限までの子ページの配列を取得します
getChildren(options) Page[] オプションの高度な引数を使用して、子ページの配列を取得します
getColumns() Column[] リストの列を取得します
getDatePublished() Date このページが最初に公開された日付を返します
getHtmlContent() String ページのHTMLコンテンツを取得します
getIsDraft() Boolean ページが下書きモードかどうかを返します
getLastEdited() Date コンテンツの編集のみを含む最終編集日を返します
getLastUpdated() Date 移動などのコンテンツ以外の変更を含む最終更新日を返します
getListItems() ListItem[] リストのリストアイテムを取得します
getListItems(optOptions) ListItem[] リストのリストアイテムを取得します
getName() String ページの名前を返します
getPageType() PageType このページのタイプをSitesApp.PageType列挙として返します
getParent() Page このページの親を返します
getTextContent() String プレーンテキストページのコンテンツを返します
getTitle() String ページのタイトルを返します
getUrl() String ページのURLを取得します
isDeleted() Boolean ページが削除されたかどうかを返します
isTemplate() Boolean このページがコピー可能なテンプレートかどうかを返します
publishAsTemplate(name) Page このページをコピー可能なテンプレートとして公開します
search(query) Page[] 最大200ページの制限まで、検索クエリに一致する子孫ページの配列を取得します
search(query, options) Page[] オプションの高度な引数を使用して、検索クエリに一致する子孫ページの配列を取得します
setHtmlContent(html) Page ページのHTMLコンテンツを設定します
setIsDraft(draft) Page ページが下書きモードかどうかを設定します
setName(name) Page このページの名前を設定します
setParent(parent) Page このページの親を設定します
setTitle(title) Page ページのタイトルを設定します

PageType

プロパティ

物件 タイプ 説明
WEB_PAGE Enum
LIST_PAGE Enum
ANNOUNCEMENT Enum
ANNOUNCEMENTS_PAGE Enum
FILE_CABINET_PAGE Enum

Site

メソッド

メソッド 戻りタイプ 簡単な説明
addEditor(emailAddress) Site 指定されたユーザーをのエディターのリストに追加しますSite
addEditor(user) Site 指定されたユーザーをのエディターのリストに追加しますSite
addEditors(emailAddresses) Site 指定されたユーザーの配列をのエディターのリストに追加しSiteます
addOwner(email) Site Webサイトに新しい所有者を追加する
addOwner(user) Site Webサイトに新しい所有者を追加する
addViewer(emailAddress) Site 指定されたユーザーをの視聴者リストに追加しますSite
addViewer(user) Site 指定されたユーザーをの視聴者リストに追加しますSite
addViewers(emailAddresses) Site 指定されたユーザーの配列をの視聴者のリストに追加しSiteます
createAnnouncementsPage(title, name, html) Page 新しいお知らせページを作成します
createFileCabinetPage(title, name, html) Page 新しいファイルキャビネットページを作成します
createListPage(title, name, html, columnNames) Page 新しいリストページを作成します
createPageFromTemplate(title, name, template) Page テンプレートから新しいページを作成します
createWebPage(title, name, html) Page 新しいWebページを作成します
getAllDescendants() Page[] 最大200ページの子孫ページ(直接および間接)の配列を取得します
getAllDescendants(options) Page[] オプションの高度な引数を使用して、子孫ページの配列を取得します
getChildByName(name) Page 特定の子ページを取得します
getChildren() Page[] 200ページの制限までの子ページの配列を取得します
getChildren(options) Page[] オプションの高度な引数を使用して、子ページの配列を取得します
getEditors() User[] こののエディターのリストを取得しますSite
getName() String サイトの名前を返します
getOwners() User[] サイトの所有者のリストを取得します
getSummary() String Webサイトの概要を返す
getTemplates() Page[] すべてのテンプレートページを返します
getTheme() String サイトのテーマを取得します
getTitle() String サイトのタイトルを返します
getUrl() String このサイトのURLを取得します
getViewers() User[] このの閲覧者とコメント投稿者のリストを取得しますSite
removeEditor(emailAddress) Site のエディターのリストから指定されたユーザーを削除しますSite
removeEditor(user) Site のエディターのリストから指定されたユーザーを削除しますSite
removeOwner(email) Site ユーザーのメールでサイトから所有者を削除します
removeOwner(user) Site サイトから所有者を削除します
removeViewer(emailAddress) Site の閲覧者とコメント投稿者のリストから指定されたユーザーを削除しますSite
removeViewer(user) Site の閲覧者とコメント投稿者のリストから指定されたユーザーを削除しますSite
search(query) Page[] 最大200ページの制限まで、検索クエリに一致する子孫ページの配列を取得します
search(query, options) Page[] オプションの高度な引数を使用して、検索クエリに一致する子孫ページの配列を取得します
setSummary(summary) Site Webサイトの概要を設定する
setTheme(theme) Site サイトのテーマを設定します
setTitle(title) Site サイトのタイトルを設定します

SitesApp

プロパティ

物件 タイプ 説明
AttachmentType AttachmentType
PageType PageType

メソッド

メソッド 戻りタイプ 簡単な説明
copySite(domain, name, title, summary, site) Site 既存のサイトをコピーして新しいサイトを作成します
createSite(domain, name, title, summary) Site 新しいサイトを作成します
getActivePage() Page スクリプトがコンテナでホストされている場合はアクティブページを返し、そうでない場合はnullを返します
getActiveSite() Site スクリプトがコンテナでホストされている場合はアクティブなコンテナを返し、そうでない場合はnullを返します
getAllSites(domain) Site[] このドメインに属する最初の200サイトを取得します
getAllSites(domain, start, max) Site[] このドメインに属するすべてのサイトを取得します
getPageByUrl(url) Page URLでページを取得します
getSite(name) Site ユーザーがホストドメインを持たない消費者である場合、指定されたGoogleサイトのサイトを取得します
getSite(domain, name) Site 指定されたGoogleサイトのサイトを取得します
getSiteByUrl(url) Site URLでサイトを取得します
getSites() Site[] ユーザーがホストドメインを持たない消費者である場合、ユーザーのサイトの最初のページを取得します
getSites(start, max) Site[] ユーザーがホストされたドメインを持たない消費者である場合、指定された範囲内のユーザーのサイトを取得します
getSites(domain) Site[] このドメインのこのユーザーに属するサイトの最初のページを取得します
getSites(domain, start, max) Site[] 指定された範囲で、このドメインのこのユーザーに属するすべてのサイトを取得します

スライドサービス

このサービスを使用すると、スクリプトでGoogleスライドファイルを作成、アクセス、および変更できます スライドサービスの基本機能の詳細については、Googleスライドのドキュメントもご覧ください

クラス

名前 簡単な説明
AffineTransform 行列の乗算に従ってソース座標(x1、y1)を宛先座標(x2、y2)に変換するために使用される3x3行列:
AffineTransformBuilder AffineTransformオブジェクトのビルダー
AlignmentPosition 適用する配置位置
ArrowStyle 線形ジオメトリをレンダリングできる開始フォームと終了フォームの種類
AutoText スライド番号など、時間とともに変化する可能性のあるコンテンツで動的に置き換えられるテキストの要素
AutoTextType 自動テキストのタイプ
Border 要素の周囲の境界線を記述します
CellMergeState テーブルセルのマージ状態
Color 不透明な色
ColorScheme カラースキームは、のメンバーThemeColorTypeからレンダリングに使用される実際の色へのマッピングを定義します
ConnectionSite に接続PageElementできるの接続サイトconnector
ContentAlignment TableCell
DashStyle 線形ジオメトリをレンダリングできるダッシュの種類
Fill ページ要素の背景を説明します
FillType 塗りつぶしの種類
Group PageElement単一のユニットとして結合されたのコレクション
Image PageElement画像を表します
Layout プレゼンテーションのレイアウト
Line A PageElementラインを表します
LineCategory ラインカテゴリ
LineFill 線またはアウトラインの塗りつぶしを記述します
LineFillType 線の種類
LineType 線のタイプ
Link ハイパーテキストリンク
LinkType のタイプLink
List テキスト内のリスト
ListPreset テキストのリストのグリフのプリセットパターン
ListStyle テキストの範囲のリストスタイル
Master プレゼンテーションのマスター
NotesMaster プレゼンテーションのノートマスター
NotesPage プレゼンテーションのメモページ
Page プレゼンテーションのページ
PageBackground ページの背景を説明します
PageBackgroundType ページの背景の種類
PageElement ページに表示される視覚要素
PageElementRange 1つ以上のPageElementインスタンスのコレクション
PageElementType ページ要素のタイプ
PageRange 1つ以上のPageインスタンスのコレクション
PageType ページの種類
Paragraph 改行文字で終了するテキストのセグメント
ParagraphAlignment 段落のテキスト配置のタイプ
ParagraphStyle 段落全体に適用されるテキストのスタイル
PictureFill コンテナのサイズに合わせて拡大された画像をレンダリングする塗りつぶし
PlaceholderType プレースホルダータイプ
Point 場所を表すポイント
PredefinedLayout 事前定義されたレイアウト
Presentation プレゼン
Selection アクティブなプレゼンテーションでのユーザーの選択
SelectionType のタイプSelection
Shape PageElementより具体的な分類を持たない一般的な形状を表します
ShapeType 形状のタイプ
SheetsChart PageElementGoogleシートから埋め込まれたリンクチャートを表します
SheetsChartEmbedType Sheetsチャートの埋め込みタイプ
Slide プレゼンテーションのスライド
SlideLinkingMode スライド間のリンクのモード
SlidePosition の相対位置Slide
SlidesApp Presentations編集可能な作成して開きます
SolidFill 単色の塗りつぶし
SpacingMode 段落間隔のさまざまなモード
Table A PageElementテーブルを表します
TableCell テーブル内のセル
TableCellRange 1つ以上のTableCellインスタンスのコレクション
TableColumn テーブルの列
TableRow テーブルの行
TextBaselineOffset 通常の位置からのテキストの垂直オフセット
TextDirection ルートのテキストが流れ込むことができます
TextRange TableCell
TextStyle テキストのスタイル
ThemeColor ページのエントリを参照する色ColorScheme
ThemeColorType ページの配色のエントリの名前
Video A PageElement映像を表現します
VideoSourceType ビデオソースのタイプ
WordArt A PageElementワードアートを表します

AffineTransform

メソッド

メソッド 戻りタイプ 簡単な説明
getScaleX() Number X座標スケーリング要素を取得します
getScaleY() Number Y座標スケーリング要素を取得します
getShearX() Number X座標のせん断要素を取得します
getShearY() Number Y座標のせん断要素を取得します
getTranslateX() Number X座標変換要素をポイント単位で取得します
getTranslateY() Number Y座標変換要素をポイント単位で取得します
toBuilder() AffineTransformBuilder AffineTransformBuilderこの変換に基づいて新しいを返します

AffineTransformBuilder

メソッド

メソッド 戻りタイプ 簡単な説明
build() AffineTransform AffineTransformビルダーで設定された要素で初期化されたオブジェクトを作成します
setScaleX(scaleX) AffineTransformBuilder X座標スケーリング要素を設定し、ビルダーを返します
setScaleY(scaleY) AffineTransformBuilder Y座標スケーリング要素を設定し、ビルダーを返します
setShearX(shearX) AffineTransformBuilder X座標のせん断要素を設定し、ビルダーを返します
setShearY(shearY) AffineTransformBuilder Y座標シャーリング要素を設定し、ビルダーを返します
setTranslateX(translateX) AffineTransformBuilder X座標変換要素をポイント単位で設定し、ビルダーを返します
setTranslateY(translateY) AffineTransformBuilder Y座標変換要素をポイント単位で設定し、ビルダーを返します

AlignmentPosition

プロパティ

物件 タイプ 説明
CENTER Enum 中央に揃えます
HORIZONTAL_CENTER Enum 水平方向の中央に揃えます
VERTICAL_CENTER Enum 垂直方向の中央に揃えます

ArrowStyle

プロパティ

物件 タイプ 説明
UNSUPPORTED Enum サポートされていない矢印スタイル
NONE Enum 矢印なし
STEALTH_ARROW Enum ノッチ付きの矢印
FILL_ARROW Enum 塗りつぶされた矢印
FILL_CIRCLE Enum 塗りつぶされた円
FILL_SQUARE Enum 塗りつぶされた正方形
FILL_DIAMOND Enum 塗りつぶされたダイヤモンド
OPEN_ARROW Enum 中空の矢印
OPEN_CIRCLE Enum 中空円
OPEN_SQUARE Enum 中空の正方形
OPEN_DIAMOND Enum 中空ダイヤモンド

AutoText

メソッド

メソッド 戻りタイプ 簡単な説明
getAutoTextType() AutoTextType 自動テキストのタイプを返します
getIndex() Integer 自動テキストのインデックスを返します
getRange() TextRange TextRange自動テキストにまたがる値を返します

AutoTextType

プロパティ

物件 タイプ 説明
UNSUPPORTED Enum サポートされていない自動テキストタイプ
SLIDE_NUMBER Enum スライド番号

Border

メソッド

メソッド 戻りタイプ 簡単な説明
getDashStyle() DashStyle DashStyle境界線を取得します
getLineFill() LineFill LineFill境界線を取得します
getWeight() Number 境界線の太さをポイント単位で取得します
isVisible() Boolean 境界線が表示されるかどうかを取得します
setDashStyle(style) Border DashStyle境界線を設定します
setTransparent() Border 境界線を透明に設定します
setWeight(points) Border 境界線の太さをポイント単位で設定します

CellMergeState

プロパティ

物件 タイプ 説明
NORMAL Enum セルは結合されません
HEAD Enum セルがマージされ、それがヘッド(つまり、
MERGED Enum セルはマージされますが、先頭ではありません(つまり、

Color

メソッド

メソッド 戻りタイプ 簡単な説明
asRgbColor() RgbColor この色をに変換しRgbColorます
asThemeColor() ThemeColor この色をに変換しThemeColorます
getColorType() ColorType この色のタイプを取得します

ColorScheme

メソッド

メソッド 戻りタイプ 簡単な説明
getConcreteColor(theme) Color この配色でにThemeColorType
getThemeColors() ThemeColorType[] カラースキーム内の可能なすべてのテーマカラータイプのリストを返します
setConcreteColor(type, color) ColorScheme ThemeColorTypeこの配色のに関連付けられた具象色を指定された色に設定します
setConcreteColor(type, red, green, blue) ColorScheme ThemeColorTypeこの配色のに関連付けられた具象色を、RGB形式の指定された色に設定します
setConcreteColor(type, hexColor) ColorScheme ThemeColorTypeこの配色のに関連付けられている具象色を、HEX形式の指定された色に設定します

ConnectionSite

メソッド

メソッド 戻りタイプ 簡単な説明
getIndex() Integer 接続サイトのインデックスを返します
getPageElement() PageElement PageElement接続サイトが存在することを返します

ContentAlignment

プロパティ

物件 タイプ 説明
UNSUPPORTED Enum サポートされていないコンテンツの配置
TOP Enum コンテンツをコンテンツホルダーの上部に揃えます
MIDDLE Enum コンテンツをコンテンツホルダーの中央に揃えます
BOTTOM Enum コンテンツをコンテンツホルダーの下部に揃えます

DashStyle

プロパティ

物件 タイプ 説明
UNSUPPORTED Enum サポートされていないダッシュスタイル
SOLID Enum 実線
DOT Enum 点線
DASH Enum 破線
DASH_DOT Enum ダッシュとドットを交互に
LONG_DASH Enum 大きなダッシュのある線
LONG_DASH_DOT Enum 大きなダッシュとドットを交互に

Fill

メソッド

メソッド 戻りタイプ 簡単な説明
getSolidFill() SolidFill この背景の塗りつぶしを取得しますnull塗りつぶしタイプがでない場合FillType.SOLID
getType() FillType この塗りつぶしのタイプを取得します
isVisible() Boolean 背景が見えるかどうか
setSolidFill(color) void 塗りつぶしを指定されたに設定しColorます
setSolidFill(color, alpha) void 塗りつぶしを指定されたアルファとに設定しColorます
setSolidFill(red, green, blue) void 塗りつぶしを指定されたRGB値に設定します
setSolidFill(red, green, blue, alpha) void 指定されたアルファ値とRGB値に塗りつぶしを設定します
setSolidFill(hexString) void 塗りつぶしを指定された16進数の色文字列に設定します
setSolidFill(hexString, alpha) void 塗りつぶしを、指定されたアルファおよびヘキサの色文字列に設定します
setSolidFill(color) void 塗りつぶしを指定されたに設定しThemeColorTypeます
setSolidFill(color, alpha) void 塗りつぶしを指定されたアルファとに設定しThemeColorTypeます
setTransparent() void 背景を透明に設定します

FillType

プロパティ

物件 タイプ 説明
UNSUPPORTED Enum サポートされていない塗りつぶしタイプ
NONE Enum 塗りつぶしがないため、背景は透明です
SOLID Enum 単色の塗りつぶし

Group

メソッド

メソッド 戻りタイプ 簡単な説明
alignOnPage(alignmentPosition) Group 要素をページ上の指定された配置位置に配置します
bringForward() Group ページ要素を1要素ずつページ上で前方に移動します
bringToFront() Group ページ要素をページの前面に移動します
duplicate() PageElement ページ要素を複製します
getChildren() PageElement[] グループ内のページ要素のコレクションを取得します
getConnectionSites() ConnectionSite[] ConnectionSiteページ要素ののリストを返しますページ要素に接続サイトがない場合は空のリストを返します
getDescription() String ページ要素の説明を返します
getHeight() Number 要素の高さをポイント単位で取得しますこれは、要素に回転がない場合の要素の境界ボックスの高さです
getInherentHeight() Number 要素の固有の高さをポイント単位で返します
getInherentWidth() Number 要素の固有の幅をポイント単位で返します
getLeft() Number 要素に回転がない場合に、ページの左上隅から測定した要素の水平位置をポイント単位で返します
getObjectId() String このオブジェクトの一意のIDを返します
getPageElementType() PageElementType PageElementType列挙として表されるページ要素のタイプを返します
getParentGroup() Group このページ要素が属するグループを返しますnull要素がグループに含まれていない場合
getParentPage() Page このページ要素があるページを返します
getRotation() Number 要素の中心を中心とした時計回りの回転角度を度単位で返します0度は回転しないことを意味します
getTitle() String ページ要素のタイトルを返します
getTop() Number 要素に回転がない場合に、ページの左上隅から測定された、要素の垂直位置をポイント単位で取得します
getTransform() AffineTransform ページ要素の変換を取得します
getWidth() Number 要素の幅をポイント単位で返しますこれは、要素に回転がない場合の要素の境界ボックスの幅です
preconcatenateTransform(transform) Group 指定された変換をページ要素の既存の変換に事前連結します
remove() void ページ要素を削除します
scaleHeight(ratio) Group 指定した比率で要素の高さを拡大縮小します
scaleWidth(ratio) Group 指定された比率で要素の幅を拡大縮小します
select() void PageElementアクティブなプレゼンテーションのみを選択し、以前の選択を削除します
select(replace) void PageElementアクティブなプレゼンテーションでを選択します
sendBackward() Group ページ要素を1要素ずつページ上で後方に送ります
sendToBack() Group ページ要素をページの後ろに送ります
setDescription(description) Group ページ要素の代替テキストの説明を設定します
setHeight(height) Group 要素の高さをポイント単位で設定しますこれは、要素に回転がない場合の要素の境界ボックスの高さです
setLeft(left) Group 要素に回転がない場合に、ページの左上隅から測定して、要素の水平位置をポイントで設定します
setRotation(angle) Group 要素の中心を中心とした時計回りの回転角度を度単位で設定します
setTitle(title) Group ページ要素の代替テキストのタイトルを設定します
setTop(top) Group 要素に回転がない場合に、ページの左上隅から測定して、要素の垂直位置をポイント単位で設定します
setTransform(transform) Group 指定された変換を使用してページ要素の変換を設定します
setWidth(width) Group 要素の幅をポイント単位で設定しますこれは、要素に回転がない場合の要素の境界ボックスの幅です
ungroup() void グループの要素をグループ解除します

Image

メソッド

メソッド 戻りタイプ 簡単な説明
alignOnPage(alignmentPosition) Image 要素をページ上の指定された配置位置に配置します
bringForward() Image ページ要素を1要素ずつページ上で前方に移動します
bringToFront() Image ページ要素をページの前面に移動します
duplicate() PageElement ページ要素を複製します
getAs(contentType) Blob このオブジェクト内のデータを、指定されたコンテンツタイプに変換されたblobとして返します
getBlob() Blob この画像内のデータをblobとして返します
getBorder() Border Border画像のを返します
getConnectionSites() ConnectionSite[] ConnectionSiteページ要素ののリストを返しますページ要素に接続サイトがない場合は空のリストを返します
getContentUrl() String 画像へのURLを取得します
getDescription() String ページ要素の説明を返します
getHeight() Number 要素の高さをポイント単位で取得しますこれは、要素に回転がない場合の要素の境界ボックスの高さです
getInherentHeight() Number 要素の固有の高さをポイント単位で返します
getInherentWidth() Number 要素の固有の幅をポイント単位で返します
getLeft() Number 要素に回転がない場合に、ページの左上隅から測定した要素の水平位置をポイント単位で返します
getLink() Link Linkまたはnullリンクがない場合を返します
getObjectId() String このオブジェクトの一意のIDを返します
getPageElementType() PageElementType PageElementType列挙として表されるページ要素のタイプを返します
getParentGroup() Group このページ要素が属するグループを返しますnull要素がグループに含まれていない場合
getParentPage() Page このページ要素があるページを返します
getRotation() Number 要素の中心を中心とした時計回りの回転角度を度単位で返します0度は回転しないことを意味します
getSourceUrl() String 可能な場合、画像のソースURLを取得します
getTitle() String ページ要素のタイトルを返します
getTop() Number 要素に回転がない場合に、ページの左上隅から測定された、要素の垂直位置をポイント単位で取得します
getTransform() AffineTransform ページ要素の変換を返します
getWidth() Number 要素の幅をポイント単位で返しますこれは、要素に回転がない場合の要素の境界ボックスの幅です
preconcatenateTransform(transform) Image 指定された変換をページ要素の既存の変換に事前連結します
remove() void ページ要素を削除します
removeLink() void を削除しますLink
replace(blobSource) Image この画像をBlobSourceオブジェクトで記述された画像に置き換えます
replace(blobSource, crop) Image この画像をImageオブジェクトで記述された画像に置き換え、オプションで画像をトリミングして合わせます
replace(imageUrl) Image この画像を、指定されたURLからダウンロードした別の画像に置き換えます
replace(imageUrl, crop) Image この画像を、指定されたURLからダウンロードした別の画像に置き換え、オプションで画像を切り取ります
scaleHeight(ratio) Image 指定した比率で要素の高さを拡大縮小します
scaleWidth(ratio) Image 指定された比率で要素の幅を拡大縮小します
select() void PageElementアクティブなプレゼンテーションのみを選択し、以前の選択を削除します
select(replace) void PageElementアクティブなプレゼンテーションでを選択します
sendBackward() Image ページ要素を1要素ずつページ上で後方に送ります
sendToBack() Image ページ要素をページの後ろに送ります
setDescription(description) Image ページ要素の代替テキストの説明を設定します
setHeight(height) Image 要素の高さをポイント単位で設定しますこれは、要素に回転がない場合の要素の境界ボックスの高さです
setLeft(left) Image 要素に回転がない場合に、ページの左上隅から測定して、要素の水平位置をポイントで設定します
setLinkSlide(slideIndex) Link スライドのゼロから始まるインデックスを使用Slideます
setLinkSlide(slide) Link a Slideされたに設定し、リンクは指定されたスライドIDによって設定されます
setLinkSlide(slidePosition) Link スライドの相対位置を使用Slideます
setLinkUrl(url) Link Link指定された空でないURL文字列にa を設定します
setRotation(angle) Image 要素の中心を中心とした時計回りの回転角度を度単位で設定します
setTitle(title) Image ページ要素の代替テキストのタイトルを設定します
setTop(top) Image 要素に回転がない場合に、ページの左上隅から測定して、要素の垂直位置をポイント単位で設定します
setTransform(transform) Image 指定された変換を使用してページ要素の変換を設定します
setWidth(width) Image 要素の幅をポイント単位で設定しますこれは、要素に回転がない場合の要素の境界ボックスの幅です

Layout

メソッド

メソッド 戻りタイプ 簡単な説明
getBackground() PageBackground ページの背景を取得します
getColorScheme() ColorScheme ColorSchemeページに関連付けられたを取得します
getGroups() Group[] Groupページ上のオブジェクトのリストを返します
getImages() Image[] Imageページ上のオブジェクトのリストを返します
getLayoutName() String レイアウトの名前を取得します
getLines() Line[] Lineページ上のオブジェクトのリストを返します
getMaster() Master レイアウトのベースとなるマスターを取得します
getObjectId() String ページの一意のIDを取得します
getPageElementById(id) PageElement PageElement指定されたIDのページにを返しますnull存在しない場合は返します
getPageElements() PageElement[] PageElementページにレンダリングされたオブジェクトのリストを返します
getPageType() PageType ページのタイプを取得します
getPlaceholder(placeholderType) PageElement PlaceholderTypeまたは null一致するプレースホルダーが存在しない場合、プレースホルダーオブジェクトを返します
getPlaceholder(placeholderType, placeholderIndex) PageElement PlaceholderTypeたプレースホルダーインデックスのプレースホルダーオブジェクトを返しますnullプレースホルダーが存在しない場合
getPlaceholders() PageElement[] PageElementページ内のプレースホルダーオブジェクトのリストを返します
getShapes() Shape[] Shapeページ上のオブジェクトのリストを返します
getSheetsCharts() SheetsChart[] SheetsChartページ上のオブジェクトのリストを返します
getTables() Table[] Tableページ上のオブジェクトのリストを返します
getVideos() Video[] Videoページ上のオブジェクトのリストを返します
getWordArts() WordArt[] WordArtページ上のオブジェクトのリストを返します
group(pageElements) Group 指定されたすべてのページ要素をグループ化します
insertGroup(group) Group Groupページに提供されたのコピーを挿入します
insertImage(blobSource) Image 指定された画像ブロブのデフォルトサイズで画像をページの左上隅に挿入します
insertImage(blobSource, left, top, width, height) Image 指定された画像ブロブから提供された位置とサイズで画像をページに挿入します
insertImage(image) Image Imageページに提供されたのコピーを挿入します
insertImage(imageUrl) Image 指定されたURLのデフォルトサイズの画像をページの左上隅に挿入します
insertImage(imageUrl, left, top, width, height) Image 指定されたURLから指定された位置とサイズでページに画像を挿入します
insertLine(line) Line Lineページに提供されたのコピーを挿入します
insertLine(lineCategory, startConnectionSite, endConnectionSite) Line 2つを接続するページに行を挿入しますconnection sites
insertLine(lineCategory, startLeft, startTop, endLeft, endTop) Line ページに行を挿入します
insertPageElement(pageElement) PageElement PageElementページに提供されたのコピーを挿入します
insertShape(shape) Shape Shapeページに提供されたのコピーを挿入します
insertShape(shapeType) Shape ページに図形を挿入します
insertShape(shapeType, left, top, width, height) Shape ページに図形を挿入します
insertSheetsChart(sourceChart) SheetsChart Googleスプレッドシートのグラフをページに挿入します
insertSheetsChart(sourceChart, left, top, width, height) SheetsChart 指定された位置とサイズでGoogleスプレッドシートのグラフをページに挿入します
insertSheetsChart(sheetsChart) SheetsChart SheetsChartページに提供されたのコピーを挿入します
insertSheetsChartAsImage(sourceChart) Image ImageページにとしてGoogleスプレッドシートグラフを挿入します
insertSheetsChartAsImage(sourceChart, left, top, width, height) Image 指定Imageされた位置とサイズでGoogleスプレッドシートグラフをページ上にとして挿入します
insertTable(numRows, numColumns) Table ページに表を挿入します
insertTable(numRows, numColumns, left, top, width, height) Table 指定された位置とサイズでテーブルをページに挿入します
insertTable(table) Table Tableページに提供されたのコピーを挿入します
insertTextBox(text) Shape 指定Shapeされた文字列を含むテキストボックスをページに挿入します
insertTextBox(text, left, top, width, height) Shape 指定Shapeされた文字列を含むテキストボックスをページに挿入します
insertVideo(videoUrl) Video デフォルトのサイズでビデオをページの左上隅に挿入します
insertVideo(videoUrl, left, top, width, height) Video 指定した位置とサイズでビデオをページに挿入します
insertVideo(video) Video Videoページに提供されたのコピーを挿入します
insertWordArt(wordArt) WordArt WordArtページに提供されたのコピーを挿入します
remove() void ページを削除します
replaceAllText(findText, replaceText) Integer 検索テキストに一致するテキストのすべてのインスタンスを置換テキストに置き換えます
replaceAllText(findText, replaceText, matchCase) Integer 検索テキストに一致するテキストのすべてのインスタンスを置換テキストに置き換えます
selectAsCurrentPage() void current page selection以前の選択を削除します

Line

メソッド

メソッド 戻りタイプ 簡単な説明
alignOnPage(alignmentPosition) Line 要素をページ上の指定された配置位置に配置します
bringForward() Line ページ要素を1要素ずつページ上で前方に移動します
bringToFront() Line ページ要素をページの前面に移動します
duplicate() PageElement ページ要素を複製します
getConnectionSites() ConnectionSite[] ConnectionSiteページ要素ののリストを返しますページ要素に接続サイトがない場合は空のリストを返します
getDashStyle() DashStyle 行のを取得しますDashStyle
getDescription() String ページ要素の説明を返します
getEnd() Point ページの左上隅から測定した線の終点を返します
getEndArrow() ArrowStyle ArrowStyle行の最後の矢印を取得します
getEndConnection() ConnectionSite 行の最後の接続を返しますnull接続がない場合
getHeight() Number 要素の高さをポイント単位で取得しますこれは、要素に回転がない場合の要素の境界ボックスの高さです
getInherentHeight() Number 要素の固有の高さをポイント単位で返します
getInherentWidth() Number 要素の固有の幅をポイント単位で返します
getLeft() Number 要素に回転がない場合に、ページの左上隅から測定した要素の水平位置をポイント単位で返します
getLineCategory() LineCategory 行のを取得しますLineCategory
getLineFill() LineFill 行のを取得しますLineFill
getLineType() LineType 行のを取得しますLineType
getLink() Link Linkまたはnullリンクがない場合を返します
getObjectId() String このオブジェクトの一意のIDを返します
getPageElementType() PageElementType PageElementType列挙として表されるページ要素のタイプを返します
getParentGroup() Group このページ要素が属するグループを返しますnull要素がグループに含まれていない場合
getParentPage() Page このページ要素があるページを返します
getRotation() Number 要素の中心を中心とした時計回りの回転角度を度単位で返します0度は回転しないことを意味します
getStart() Point ページの左上隅から測定した、線の始点を返します
getStartArrow() ArrowStyle ArrowStyle行の先頭にある矢印を取得します
getStartConnection() ConnectionSite 行の先頭の接続を返しますnull接続がない場合
getTitle() String ページ要素のタイトルを返します
getTop() Number 要素に回転がない場合に、ページの左上隅から測定された、要素の垂直位置をポイント単位で取得します
getTransform() AffineTransform ページ要素の変換を返します
getWeight() Number 線の太さをポイント単位で返します
getWidth() Number 要素の幅をポイント単位で返しますこれは、要素に回転がない場合の要素の境界ボックスの幅です
isConnector() Boolean true回線がコネクタであるかfalseどうかを返します
preconcatenateTransform(transform) Line 指定された変換をページ要素の既存の変換に事前連結します
remove() void ページ要素を削除します
removeLink() void を削除しますLink
reroute() Line 行の開始と終了を、接続されたページ要素の最も近い2つの接続サイトに再ルーティングします
scaleHeight(ratio) Line Scales the element's height by the specified ratio.
scaleWidth(ratio) Line Scales the element's width by the specified ratio.
select() void Selects only the PageElement in the active presentation and removes any previous selection.
select(replace) void Selects the PageElement in the active presentation.
sendBackward() Line Sends the page element backward on the page by one element.
sendToBack() Line Sends the page element to the back of the page.
setDashStyle(style) Line Sets the DashStyle of the line.
setDescription(description) Line Sets the page element's alt text description.
setEnd(left, top) Line Sets the position of the end point of the line.
setEnd(point) Line Sets the position of the end point of the line.
setEndArrow(style) Line Sets the ArrowStyle of the arrow at the end of the line.
setEndConnection(connectionSite) Line Sets the connection at the end of the line.
setHeight(height) Line Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
setLeft(left) Line Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation.
setLineCategory(lineCategory) Line Sets the LineCategory of the line.
setLinkSlide(slideIndex) Link Sets a Slide using the zero-based index of the slide.
setLinkSlide(slide) Link Sets a Slide, the link is set by the given slide ID.
setLinkSlide(slidePosition) Link Sets a Slide using the relative position of the slide.
setLinkUrl(url) Link Sets a Link to the given non-empty URL string.
setRotation(angle) Line Sets the element's clockwise rotation angle around its center in degrees.
setStart(left, top) Line Sets the position of the start point of the line.
setStart(point) Line Sets the position of the start point of the line.
setStartArrow(style) Line Sets the ArrowStyle of the arrow at the beginning of the line.
setStartConnection(connectionSite) Line Sets the connection at the beginning of the line.
setTitle(title) Line Sets the page element's alt text title.
setTop(top) Line Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation.
setTransform(transform) Line Sets the transform of the page element with the provided transform.
setWeight(points) Line 線の太さをポイント単位で設定します
setWidth(width) Line 要素の幅をポイント単位で設定しますこれは、要素に回転がない場合の要素の境界ボックスの幅です

LineCategory

プロパティ

物件 タイプ 説明
UNSUPPORTED Enum サポートされていない回線カテゴリ
STRAIGHT Enum ストレートコネクタ(ストレートコネクタを含む)1
BENT Enum 曲がったコネクタ2〜5を含む曲がったコネクタ
CURVED Enum 曲線コネクタ2〜5を含む、曲線コネクタ

LineFill

メソッド

メソッド 戻りタイプ 簡単な説明
getFillType() LineFillType 線の塗りつぶしのタイプを取得します
getSolidFill() SolidFill 線の塗りつぶしを取得しますnull塗りつぶしタイプがでない場合LineFillType.SOLID
setSolidFill(color) void 塗りつぶしを指定されたに設定しColorます
setSolidFill(color, alpha) void 塗りつぶしを指定されたアルファとに設定しColorます
setSolidFill(red, green, blue) void 塗りつぶしを指定されたRGB値に設定します
setSolidFill(red, green, blue, alpha) void 指定されたアルファ値とRGB値に塗りつぶしを設定します
setSolidFill(hexString) void 塗りつぶしを指定された16進数の色文字列に設定します
setSolidFill(hexString, alpha) void 塗りつぶしを、指定されたアルファおよびヘキサの色文字列に設定します
setSolidFill(color) void 塗りつぶしを指定されたに設定しThemeColorTypeます
setSolidFill(color, alpha) void 塗りつぶしを指定されたアルファとに設定しThemeColorTypeます

LineFillType

プロパティ

物件 タイプ 説明
UNSUPPORTED Enum サポートされていないライン塗りつぶしタイプ
NONE Enum 塗りつぶしがないため、線またはアウトラインは透明です
SOLID Enum 単色の塗りつぶし

LineType

プロパティ

物件 タイプ 説明
UNSUPPORTED Enum サポートされていない回線タイプ
STRAIGHT_CONNECTOR_1 Enum ストレートコネクタ1フォーム
BENT_CONNECTOR_2 Enum 曲がったコネクタ2フォーム
BENT_CONNECTOR_3 Enum 曲がったコネクタ3フォーム
BENT_CONNECTOR_4 Enum 曲がったコネクタ4フォーム
BENT_CONNECTOR_5 Enum 曲がったコネクタ5形式
CURVED_CONNECTOR_2 Enum 湾曲したコネクタ2フォーム
CURVED_CONNECTOR_3 Enum 湾曲したコネクタ3形式
CURVED_CONNECTOR_4 Enum 湾曲したコネクタ4フォーム
CURVED_CONNECTOR_5 Enum 湾曲したコネクタ5形式
STRAIGHT_LINE Enum 直線

Link

メソッド

メソッド 戻りタイプ 簡単な説明
getLinkType() LinkType を返しますLinkType
getLinkedSlide() Slide Slide存在する場合、非URLリンクタイプのリンクを返します
getSlideId() String リンクされているLinkType.SLIDE_ID
getSlideIndex() Integer リンクされているLinkType.SLIDE_INDEX
getSlidePosition() SlidePosition 返しLinkType.SLIDE_POSITION
getUrl() String 外部WebページへのURLを返しますそうでないnull場合LinkType.URL

LinkType

プロパティ

物件 タイプ 説明
UNSUPPORTED Enum サポートされていないリンクタイプ
URL Enum 外部Webページへのリンク
SLIDE_POSITION Enum このプレゼンテーション内の特定のスライドへのリンクその位置によってアドレス指定されます
SLIDE_ID Enum このプレゼンテーションの特定のスライドへのリンクIDで指定されています
SLIDE_INDEX Enum このプレゼンテーションの特定のスライドへのリンクゼロベースのインデックスでアドレス指定されています

List

メソッド

メソッド 戻りタイプ 簡単な説明
getListId() String リストのIDを返します
getListParagraphs() Paragraph[] Paragraphsリスト内のすべてを返します

ListPreset

プロパティ

物件 タイプ 説明
DISC_CIRCLE_SQUARE Enum 最初の3つのリストのネストレベルの「DISC」、「CIRCLE」、「SQUARE」グリフを含むリスト
DIAMONDX_ARROW3D_SQUARE Enum 最初の3つのリストのネストレベルの「DIAMONDX」、「ARROW3D」、「SQUARE」グリフを含むリスト
CHECKBOX Enum すべてのリストのネストレベルの「CHECKBOX」グリフを含むリスト
ARROW_DIAMOND_DISC Enum 最初の3つのリストのネストレベルの「矢印」、「ダイヤモンド」、「ディスク」のグリフを含むリスト
STAR_CIRCLE_SQUARE Enum 最初の3つのリストのネストレベルの「STAR」、「CIRCLE」、「SQUARE」グリフを含むリスト
ARROW3D_CIRCLE_SQUARE Enum 最初の3つのリストのネストレベルの「ARROW3D」、「CIRCLE」、「SQUARE」グリフを含むリスト
LEFTTRIANGLE_DIAMOND_DISC Enum 最初の3つのリストのネストレベルの「LEFTTRIANGLE」、「DIAMOND」、「DISC」グリフを含むリスト
DIAMONDX_HOLLOWDIAMOND_SQUARE Enum 最初の3つのリストのネストレベルの「DIAMONDX」、「HOLLOWDIAMOND」、および「SQUARE」グリフを含むリスト
DIAMOND_CIRCLE_SQUARE Enum 最初の3つのリストのネストレベルの「DIAMOND」、「CIRCLE」、「SQUARE」グリフを含むリスト
DIGIT_ALPHA_ROMAN Enum 最初の3つのリストのネストレベルの「DIGIT」、「ALPHA」、および「ROMAN」のグリフを含むリスト、その後にピリオドが続きます
DIGIT_ALPHA_ROMAN_PARENS Enum 最初の3つのリストのネストレベルの「DIGIT」、「ALPHA」、および「ROMAN」のグリフを含むリストとその後に続く括弧
DIGIT_NESTED Enum ピリオドで区切られた「DIGIT」グリフを含むリスト各ネストレベルは前のネストレベルのグリフをプレフィックスとして使用します
UPPERALPHA_ALPHA_ROMAN Enum 最初の3つのリストのネストレベルの「UPPERALPHA」、「ALPHA」、および「ROMAN」のグリフを含むリストとそれに続くピリオド
UPPERROMAN_UPPERALPHA_DIGIT Enum 最初の3つのリストのネストレベルの「UPPERROMAN」、「UPPERALPHA」、および「DIGIT」グリフを含むリスト、その後にピリオドが続きます
ZERODIGIT_ALPHA_ROMAN Enum 最初の3つのリストのネストレベルの「ZERODIGIT」、「ALPHA」、および「ROMAN」のグリフとそれに続くピリオドのリスト

ListStyle

メソッド

メソッド 戻りタイプ 簡単な説明
applyListPreset(listPreset) ListStyle ListPresetテキストと重複するすべての段落に指定されたものを適用します
getGlyph() String テキストのレンダリングされたグリフを返します
getList() List 戻り値Listテキストがである、またはnullテキストのいずれがリストにない場合、またはテキストの一部がリストにある、またはテキストが複数のリストです
getNestingLevel() Integer テキストの0から始まるネストレベルを返します
isInList() Boolean trueテキストが1つのリストにあるfalse場合null、テキストがリストにない場合、テキストの一部のみがリストにある場合、またはテキストが複数のリストにある場合に返します
removeFromList() ListStyle リストからテキストと重複する段落を削除します

Master

メソッド

メソッド 戻りタイプ 簡単な説明
getBackground() PageBackground ページの背景を取得します
getColorScheme() ColorScheme ColorSchemeページに関連付けられたを取得します
getGroups() Group[] Groupページ上のオブジェクトのリストを返します
getImages() Image[] Imageページ上のオブジェクトのリストを返します
getLayouts() Layout[] このマスターのレイアウトを取得します
getLines() Line[] Lineページ上のオブジェクトのリストを返します
getObjectId() String ページの一意のIDを取得します
getPageElementById(id) PageElement PageElement指定されたIDのページにを返しますnull存在しない場合は返します
getPageElements() PageElement[] PageElementページにレンダリングされたオブジェクトのリストを返します
getPageType() PageType ページのタイプを取得します
getPlaceholder(placeholderType) PageElement PlaceholderTypeまたは null一致するプレースホルダーが存在しない場合、プレースホルダーオブジェクトを返します
getPlaceholder(placeholderType, placeholderIndex) PageElement PlaceholderTypeたプレースホルダーインデックスのプレースホルダーオブジェクトを返しますnullプレースホルダーが存在しない場合
getPlaceholders() PageElement[] PageElementページ内のプレースホルダーオブジェクトのリストを返します
getShapes() Shape[] Shapeページ上のオブジェクトのリストを返します
getSheetsCharts() SheetsChart[] SheetsChartページ上のオブジェクトのリストを返します
getTables() Table[] Tableページ上のオブジェクトのリストを返します
getVideos() Video[] Videoページ上のオブジェクトのリストを返します
getWordArts() WordArt[] WordArtページ上のオブジェクトのリストを返します
group(pageElements) Group 指定されたすべてのページ要素をグループ化します
insertGroup(group) Group Groupページに提供されたのコピーを挿入します
insertImage(blobSource) Image 指定された画像ブロブのデフォルトサイズで画像をページの左上隅に挿入します
insertImage(blobSource, left, top, width, height) Image 指定された画像ブロブから提供された位置とサイズで画像をページに挿入します
insertImage(image) Image Imageページに提供されたのコピーを挿入します
insertImage(imageUrl) Image 指定されたURLのデフォルトサイズの画像をページの左上隅に挿入します
insertImage(imageUrl, left, top, width, height) Image 指定されたURLから指定された位置とサイズでページに画像を挿入します
insertLine(line) Line Lineページに提供されたのコピーを挿入します
insertLine(lineCategory, startConnectionSite, endConnectionSite) Line 2つを接続するページに行を挿入しますconnection sites
insertLine(lineCategory, startLeft, startTop, endLeft, endTop) Line ページに行を挿入します
insertPageElement(pageElement) PageElement PageElementページに提供されたのコピーを挿入します
insertShape(shape) Shape Shapeページに提供されたのコピーを挿入します
insertShape(shapeType) Shape ページに図形を挿入します
insertShape(shapeType, left, top, width, height) Shape ページに図形を挿入します
insertSheetsChart(sourceChart) SheetsChart Googleスプレッドシートのグラフをページに挿入します
insertSheetsChart(sourceChart, left, top, width, height) SheetsChart 指定された位置とサイズでGoogleスプレッドシートのグラフをページに挿入します
insertSheetsChart(sheetsChart) SheetsChart SheetsChartページに提供されたのコピーを挿入します
insertSheetsChartAsImage(sourceChart) Image ImageページにとしてGoogleスプレッドシートグラフを挿入します
insertSheetsChartAsImage(sourceChart, left, top, width, height) Image Inserts a Google Sheets chart as an Image on the page with the provided position and size.
insertTable(numRows, numColumns) Table Inserts a table on the page.
insertTable(numRows, numColumns, left, top, width, height) Table Inserts a table on the page with the provided position and size.
insertTable(table) Table Inserts a copy of the provided Table on the page.
insertTextBox(text) Shape Inserts a text box Shape containing the provided string on the page.
insertTextBox(text, left, top, width, height) Shape Inserts a text box Shape containing the provided string on the page.
insertVideo(videoUrl) Video Inserts a video at the top left corner of the page with a default size.
insertVideo(videoUrl, left, top, width, height) Video Inserts a video on the page with the provided position and size.
insertVideo(video) Video Inserts a copy of the provided Video on the page.
insertWordArt(wordArt) WordArt Inserts a copy of the provided WordArt on the page.
remove() void Removes the page.
replaceAllText(findText, replaceText) Integer Replaces all instances of text matching find text with replace text.
replaceAllText(findText, replaceText, matchCase) Integer Replaces all instances of text matching find text with replace text.
selectAsCurrentPage() void Selects the current page selection and removes any previous selection.

NotesMaster

メソッド

Method Return type Brief description
getGroups() Group[] Returns the list of Group objects on the page.
getImages() Image[] Returns the list of Image objects on the page.
getLines() Line[] Returns the list of Line objects on the page.
getObjectId() String Gets the unique ID for the page.
getPageElementById(id) PageElement PageElement指定されたIDのページにを返しますnull存在しない場合は返します
getPageElements() PageElement[] PageElementページにレンダリングされたオブジェクトのリストを返します
getPlaceholder(placeholderType) PageElement PlaceholderTypeまたは null一致するプレースホルダーが存在しない場合、プレースホルダーオブジェクトを返します
getPlaceholder(placeholderType, placeholderIndex) PageElement PlaceholderTypeたプレースホルダーインデックスのプレースホルダーオブジェクトを返しますnullプレースホルダーが存在しない場合
getPlaceholders() PageElement[] PageElementページ内のプレースホルダーオブジェクトのリストを返します
getShapes() Shape[] Shapeページ上のオブジェクトのリストを返します
getSheetsCharts() SheetsChart[] SheetsChartページ上のオブジェクトのリストを返します
getTables() Table[] Tableページ上のオブジェクトのリストを返します
getVideos() Video[] Videoページ上のオブジェクトのリストを返します
getWordArts() WordArt[] WordArtページ上のオブジェクトのリストを返します

NotesPage

メソッド

メソッド 戻りタイプ 簡単な説明
getGroups() Group[] Groupページ上のオブジェクトのリストを返します
getImages() Image[] Imageページ上のオブジェクトのリストを返します
getLines() Line[] Lineページ上のオブジェクトのリストを返します
getObjectId() String ページの一意のIDを取得します
getPageElementById(id) PageElement PageElement指定されたIDのページにを返しますnull存在しない場合は返します
getPageElements() PageElement[] PageElementページにレンダリングされたオブジェクトのリストを返します
getPlaceholder(placeholderType) PageElement PlaceholderTypeまたは null一致するプレースホルダーが存在しない場合、プレースホルダーオブジェクトを返します
getPlaceholder(placeholderType, placeholderIndex) PageElement PlaceholderTypeたプレースホルダーインデックスのプレースホルダーオブジェクトを返しますnullプレースホルダーが存在しない場合
getPlaceholders() PageElement[] PageElementページ内のプレースホルダーオブジェクトのリストを返します
getShapes() Shape[] Shapeページ上のオブジェクトのリストを返します
getSheetsCharts() SheetsChart[] SheetsChartページ上のオブジェクトのリストを返します
getSpeakerNotesShape() Shape ページ上のスピーカーノートを含む図形を取得します
getTables() Table[] Tableページ上のオブジェクトのリストを返します
getVideos() Video[] Videoページ上のオブジェクトのリストを返します
getWordArts() WordArt[] WordArtページ上のオブジェクトのリストを返します
replaceAllText(findText, replaceText) Integer 検索テキストに一致するテキストのすべてのインスタンスを置換テキストに置き換えます
replaceAllText(findText, replaceText, matchCase) Integer 検索テキストに一致するテキストのすべてのインスタンスを置換テキストに置き換えます

Page

メソッド

メソッド 戻りタイプ 簡単な説明
asLayout() Layout ページをレイアウトとして返します
asMaster() Master ページをマスターとして返します
asSlide() Slide ページをスライドとして返します
getBackground() PageBackground ページの背景を取得します
getColorScheme() ColorScheme ColorSchemeページに関連付けられたを取得します
getGroups() Group[] Groupページ上のオブジェクトのリストを返します
getImages() Image[] Imageページ上のオブジェクトのリストを返します
getLines() Line[] Lineページ上のオブジェクトのリストを返します
getObjectId() String ページの一意のIDを取得します
getPageElementById(id) PageElement PageElement指定されたIDのページにを返しますnull存在しない場合は返します
getPageElements() PageElement[] PageElementページにレンダリングされたオブジェクトのリストを返します
getPageType() PageType ページのタイプを取得します
getPlaceholder(placeholderType) PageElement PlaceholderTypeまたは null一致するプレースホルダーが存在しない場合、プレースホルダーオブジェクトを返します
getPlaceholder(placeholderType, placeholderIndex) PageElement PlaceholderTypeたプレースホルダーインデックスのプレースホルダーオブジェクトを返しますnullプレースホルダーが存在しない場合
getPlaceholders() PageElement[] PageElementページ内のプレースホルダーオブジェクトのリストを返します
getShapes() Shape[] Shapeページ上のオブジェクトのリストを返します
getSheetsCharts() SheetsChart[] SheetsChartページ上のオブジェクトのリストを返します
getTables() Table[] Tableページ上のオブジェクトのリストを返します
getVideos() Video[] Videoページ上のオブジェクトのリストを返します
getWordArts() WordArt[] WordArtページ上のオブジェクトのリストを返します
group(pageElements) Group 指定されたすべてのページ要素をグループ化します
insertGroup(group) Group Groupページに提供されたのコピーを挿入します
insertImage(blobSource) Image Inserts an image at the top left corner of the page with a default size from the specified image blob.
insertImage(blobSource, left, top, width, height) Image Inserts an image on the page with the provided position and size from the specified image blob.
insertImage(image) Image Inserts a copy of the provided Image on the page.
insertImage(imageUrl) Image Inserts an image at the top left corner of the page with a default size from the provided URL.
insertImage(imageUrl, left, top, width, height) Image Inserts an image on the page with the provided position and size from the provided URL.
insertLine(line) Line Inserts a copy of the provided Line on the page.
insertLine(lineCategory, startConnectionSite, endConnectionSite) Line Inserts a line on the page connecting two connection sites.
insertLine(lineCategory, startLeft, startTop, endLeft, endTop) Line Inserts a line on the page.
insertPageElement(pageElement) PageElement Inserts a copy of the provided PageElement on the page.
insertShape(shape) Shape Inserts a copy of the provided Shape on the page.
insertShape(shapeType) Shape Inserts a shape on the page.
insertShape(shapeType, left, top, width, height) Shape Inserts a shape on the page.
insertSheetsChart(sourceChart) SheetsChart Inserts a Google Sheets chart on the page.
insertSheetsChart(sourceChart, left, top, width, height) SheetsChart Inserts a Google Sheets chart on the page with the provided position and size.
insertSheetsChart(sheetsChart) SheetsChart Inserts a copy of the provided SheetsChart on the page.
insertSheetsChartAsImage(sourceChart) Image Inserts a Google Sheets chart as an Image on the page.
insertSheetsChartAsImage(sourceChart, left, top, width, height) Image 指定Imageされた位置とサイズでGoogleスプレッドシートグラフをページ上にとして挿入します
insertTable(numRows, numColumns) Table ページに表を挿入します
insertTable(numRows, numColumns, left, top, width, height) Table 指定された位置とサイズでテーブルをページに挿入します
insertTable(table) Table Tableページに提供されたのコピーを挿入します
insertTextBox(text) Shape 指定Shapeされた文字列を含むテキストボックスをページに挿入します
insertTextBox(text, left, top, width, height) Shape 指定Shapeされた文字列を含むテキストボックスをページに挿入します
insertVideo(videoUrl) Video デフォルトのサイズでビデオをページの左上隅に挿入します
insertVideo(videoUrl, left, top, width, height) Video 指定した位置とサイズでビデオをページに挿入します
insertVideo(video) Video Videoページに提供されたのコピーを挿入します
insertWordArt(wordArt) WordArt WordArtページに提供されたのコピーを挿入します
remove() void ページを削除します
replaceAllText(findText, replaceText) Integer 検索テキストに一致するテキストのすべてのインスタンスを置換テキストに置き換えます
replaceAllText(findText, replaceText, matchCase) Integer 検索テキストに一致するテキストのすべてのインスタンスを置換テキストに置き換えます
selectAsCurrentPage() void current page selection以前の選択を削除します

PageBackground

メソッド

メソッド 戻りタイプ 簡単な説明
getPictureFill() PictureFill この背景の引き伸ばされた画像の塗りつぶしを取得するnullか、背景の塗りつぶしのタイプがでない場合PageBackgroundType.PICTURE
getSolidFill() SolidFill この背景の塗りつぶしを取得するnullか、背景の塗りつぶしタイプがでない場合 PageBackgroundType.SOLID
getType() PageBackgroundType このページ背景のタイプを取得します
isVisible() Boolean 背景が見えるかどうか
setPictureFill(blobSource) void 指定された画像ブロブから画像をページの背景として設定します
setPictureFill(imageUrl) void 指定されたURLの画像をページの背景として設定します
setSolidFill(color) void 塗りつぶしを指定されたに設定しColorます
setSolidFill(color, alpha) void 塗りつぶしを指定されたアルファとに設定しColorます
setSolidFill(red, green, blue) void 塗りつぶしを指定されたRGB値に設定します
setSolidFill(red, green, blue, alpha) void 指定されたアルファ値とRGB値に塗りつぶしを設定します
setSolidFill(hexString) void 塗りつぶしを指定された16進数の色文字列に設定します
setSolidFill(hexString, alpha) void 塗りつぶしを、指定されたアルファおよびヘキサの色文字列に設定します
setSolidFill(color) void 塗りつぶしを指定されたに設定しThemeColorTypeます
setSolidFill(color, alpha) void 塗りつぶしを指定されたアルファとに設定しThemeColorTypeます
setTransparent() void 背景を透明に設定します

PageBackgroundType

プロパティ

物件 タイプ 説明
UNSUPPORTED Enum サポートされていないページ背景タイプ
NONE Enum 塗りつぶしがないため、背景は白にレンダリングされます
SOLID Enum 単色の塗りつぶし
PICTURE Enum ページいっぱいに拡大される画像

PageElement

メソッド

メソッド 戻りタイプ 簡単な説明
alignOnPage(alignmentPosition) PageElement Aligns the element to the specified alignment position on the page.
asGroup() Group Returns the page element as a group.
asImage() Image Returns the page element as an image.
asLine() Line Returns the page element as a line.
asShape() Shape Returns the page element as a shape.
asSheetsChart() SheetsChart Returns the page element as a linked chart embedded from Google Sheets.
asTable() Table Returns the page element as a table.
asVideo() Video Returns the page element as a video.
asWordArt() WordArt Returns the page element as word art.
bringForward() PageElement Brings the page element forward on the page by one element.
bringToFront() PageElement Brings the page element to the front of the page.
duplicate() PageElement Duplicates the page element.
getConnectionSites() ConnectionSite[] Returns the list of ConnectionSites on the page element, or an empty list if the page element does not have any connection sites.
getDescription() String Returns the page element's description.
getHeight() Number Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
getInherentHeight() Number Returns the element's inherent height in points.
getInherentWidth() Number Returns the element's inherent width in points.
getLeft() Number Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation.
getObjectId() String Returns the unique ID for this object.
getPageElementType() PageElementType Returns the page element's type, represented as a PageElementType enum.
getParentGroup() Group Returns the group this page element belongs to, or null if the element is not in a group.
getParentPage() Page Returns the page this page element is on.
getRotation() Number Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation.
getTitle() String Returns the page element's title.
getTop() Number Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation.
getTransform() AffineTransform Returns the page element's transform.
getWidth() Number Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation.
preconcatenateTransform(transform) PageElement Preconcatenates the provided transform to the existing transform of the page element.
remove() void Removes the page element.
scaleHeight(ratio) PageElement Scales the element's height by the specified ratio.
scaleWidth(ratio) PageElement Scales the element's width by the specified ratio.
select() void Selects only the PageElement in the active presentation and removes any previous selection.
select(replace) void Selects the PageElement in the active presentation.
sendBackward() PageElement Sends the page element backward on the page by one element.
sendToBack() PageElement Sends the page element to the back of the page.
setDescription(description) PageElement Sets the page element's alt text description.
setHeight(height) PageElement Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
setLeft(left) PageElement Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation.
setRotation(angle) PageElement Sets the element's clockwise rotation angle around its center in degrees.
setTitle(title) PageElement Sets the page element's alt text title.
setTop(top) PageElement Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation.
setTransform(transform) PageElement Sets the transform of the page element with the provided transform.
setWidth(width) PageElement Sets the element's width in points, which is the width of the element's bounding box when the element has no rotation.

PageElementRange

メソッド

Method Return type Brief description
getPageElements() PageElement[] Returns the list of PageElement instances.

PageElementType

プロパティ

Property Type Description
UNSUPPORTED Enum Represents a page element that is not supported and cannot be further classified.
SHAPE Enum Represents a generic shape that does not have a more specific classification.
IMAGE Enum Represents an image.
VIDEO Enum Represents a video.
TABLE Enum Represents a table.
GROUP Enum Represents a collection of page elements joined as a single unit.
LINE Enum Represents a line.
WORD_ART Enum Represents word art.
SHEETS_CHART Enum Represents a linked chart embedded from Google Sheets.

PageRange

メソッド

Method Return type Brief description
getPages() Page[] Returns the list of Page instances.

PageType

プロパティ

Property Type Description
UNSUPPORTED Enum A page type that is not supported.
SLIDE Enum A slide page.
LAYOUT Enum A layout page.
MASTER Enum A master page.

Paragraph

メソッド

Method Return type Brief description
getIndex() Integer Returns the index of the paragraph's newline.
getRange() TextRange Returns a TextRange spanning the text in the paragraph ended by this object's newline character.

ParagraphAlignment

プロパティ

Property Type Description
UNSUPPORTED Enum A paragraph alignment that is not supported.
START Enum The paragraph is aligned to the start of the line.
CENTER Enum The paragraph is centered.
END Enum The paragraph is aligned to the end of the line.
JUSTIFIED Enum The paragraph is justified.

ParagraphStyle

メソッド

Method Return type Brief description
getIndentEnd() Number Returns the text end indentation for paragraphs in the TextRange in points, or null if there are multiple paragraph styles on the given text.
getIndentFirstLine() Number Returns the indentation for the first line of paragraphs in the TextRange in points, or null if there are multiple paragraph styles on the given text.
getIndentStart() Number Returns the text start indentation for paragraphs in the TextRange in points, or null if there are multiple paragraph styles on the given text.
getLineSpacing() Number Returns the line spacing, or null if there are multiple paragraph styles on the given text.
getParagraphAlignment() ParagraphAlignment Returns the TextRange, or null if there are multiple paragraph styles on the given text.
getSpaceAbove() Number Returns the extra space above paragraphs in the TextRange in points, or null if there are multiple paragraph styles on the given text.
getSpaceBelow() Number Returns the extra space below paragraphs in the TextRange in points, or null if there are multiple paragraph styles on the given text.
getSpacingMode() SpacingMode Returns the TextRange, or null if there are multiple paragraph styles on the given text.
getTextDirection() TextDirection Returns the TextRange, or null if there are multiple paragraph styles on the given text.
setIndentEnd(indent) ParagraphStyle Sets the text end indentation for paragraphs in the TextRange in points.
setIndentFirstLine(indent) ParagraphStyle TextRangeinポイントの段落の最初の行のインデントを設定します
setIndentStart(indent) ParagraphStyle TextRangeinポイントの段落のテキスト開始インデントを設定します
setLineSpacing(spacing) ParagraphStyle 行間隔を設定します
setParagraphAlignment(alignment) ParagraphStyle TextRangeます
setSpaceAbove(space) ParagraphStyle TextRangeinポイントの段落の上に余分なスペースを設定します
setSpaceBelow(space) ParagraphStyle TextRangeinポイントの段落の下に余分なスペースを設定します
setSpacingMode(mode) ParagraphStyle のTextRangeます
setTextDirection(direction) ParagraphStyle のTextRangeます

PictureFill

メソッド

メソッド 戻りタイプ 簡単な説明
getAs(contentType) Blob このオブジェクト内のデータを、指定されたコンテンツタイプに変換されたblobとして返します
getBlob() Blob このオブジェクト内のデータをblobとして返します
getContentUrl() String 画像へのURLを取得します
getSourceUrl() String 可能な場合、画像のソースURLを取得します

PlaceholderType

プロパティ

物件 タイプ 説明
UNSUPPORTED Enum サポートされていないプレースホルダータイプ
NONE Enum プレースホルダーではありません
BODY Enum 本文
CHART Enum チャートまたはグラフ
CLIP_ART Enum クリップアート画像
CENTERED_TITLE Enum タイトルが中央揃え
DIAGRAM Enum
DATE_AND_TIME Enum 日時
FOOTER Enum フッターテキスト
HEADER Enum ヘッダーテキスト
MEDIA Enum マルチメディア
OBJECT Enum 任意のコンテンツタイプ
PICTURE Enum 画像
SLIDE_NUMBER Enum スライドの番号
SUBTITLE Enum 字幕
TABLE Enum テーブル
TITLE Enum スライドのタイトル
SLIDE_IMAGE Enum スライド画像

Point

メソッド

メソッド 戻りタイプ 簡単な説明
getX() Number ポイント単位で測定された水平座標を取得します
getY() Number ポイント単位で測定された垂直座標を取得します

PredefinedLayout

プロパティ

物件 タイプ 説明
UNSUPPORTED Enum サポートされていないレイアウト
BLANK Enum プレースホルダーのない空白のレイアウト
CAPTION_ONLY Enum 下部にキャプションがあるレイアウト
TITLE Enum タイトルとサブタイトルのあるレイアウト
TITLE_AND_BODY Enum タイトルと本文を含むレイアウト
TITLE_AND_TWO_COLUMNS Enum タイトルと2列のレイアウト
TITLE_ONLY Enum タイトルのみのレイアウト
SECTION_HEADER Enum セクションタイトル付きのレイアウト
SECTION_TITLE_AND_DESCRIPTION Enum 一方にタイトルとサブタイトル、もう一方に説明があるレイアウト
ONE_COLUMN_TEXT Enum 単一の列に配置された、1つのタイトルと1つの本文のレイアウト
MAIN_POINT Enum 要点のあるレイアウト
BIG_NUMBER Enum 大きな番号の見出しを持つレイアウト

Presentation

メソッド

メソッド 戻りタイプ 簡単な説明
addEditor(emailAddress) Presentation 指定されたユーザーをのエディターのリストに追加しますPresentation
addEditor(user) Presentation 指定されたユーザーをのエディターのリストに追加しますPresentation
addEditors(emailAddresses) Presentation 指定されたユーザーの配列をのエディターのリストに追加しPresentationます
addViewer(emailAddress) Presentation 指定されたユーザーをの視聴者リストに追加しますPresentation
addViewer(user) Presentation 指定されたユーザーをの視聴者リストに追加しますPresentation
addViewers(emailAddresses) Presentation 指定されたユーザーの配列をの視聴者のリストに追加しPresentationます
appendSlide() Slide 現在のマスターに基づいて事前定義されたレイアウトを使用して、プレゼンテーションの最後にスライドを追加しますPredefinedLayout.BLANK
appendSlide(layout) Slide 現在のマスターに基づいて指定されたレイアウトを使用して、プレゼンテーションの最後にスライドを追加します
appendSlide(predefinedLayout) Slide Appends a slide to the end of the presentation using the specified predefined layout based on the current master.
appendSlide(slide) Slide Appends a copy of the provided Slide to the end of the presentation.
appendSlide(slide, linkingMode) Slide Appends a copy of the provided SlideLinkingMode.
getEditors() User[] Gets the list of editors for this Presentation.
getId() String Gets the presentation's unique identifier.
getLayouts() Layout[] Gets the layouts in the presentation.
getMasters() Master[] Gets the masters in the presentation.
getName() String Gets the name or title of the presentation.
getNotesMaster() NotesMaster Gets the notes master of the presentation.
getNotesPageHeight() Number Gets the page height of the notes master and notes pages in the presentation in points.
getNotesPageWidth() Number Gets the page width of the notes master and notes pages in the presentation in points.
getPageElementById(id) PageElement Returns the PageElement with the given ID, or null if none exists.
getPageHeight() Number プレゼンテーション内のスライド、レイアウト、およびマスターのページの高さをポイント単位で取得します
getPageWidth() Number プレゼンテーション内のスライド、レイアウト、およびマスターのページ幅をポイント単位で取得します
getSelection() Selection アクティブなプレゼンテーションでのユーザーの選択を取得します
getSlideById(id) Slide Slide指定されたIDで、またはnull存在しない場合にを返します
getSlides() Slide[] プレゼンテーションのスライドを取得します
getUrl() String このプレゼンテーションにアクセスするためのURLを取得します
getViewers() User[] このの閲覧者とコメント投稿者のリストを取得しますPresentation
insertSlide(insertionIndex) Slide 現在のマスターに基づいて事前定義されたレイアウトを使用して、プレゼンテーションの指定されたインデックスにスライドを挿入しますPredefinedLayout.BLANK
insertSlide(insertionIndex, layout) Slide 現在のマスターに基づいて指定されたレイアウトを使用して、プレゼンテーションの指定されたインデックスにスライドを挿入します
insertSlide(insertionIndex, predefinedLayout) Slide 現在のマスターに基づいて指定された事前定義済みレイアウトを使用して、プレゼンテーション内の指定されたインデックスにスライドを挿入します
insertSlide(insertionIndex, slide) Slide 提供さSlideれたのコピーをプレゼンテーションの指定されたインデックスに挿入します
insertSlide(insertionIndex, slide, linkingMode) Slide SlideLinkingMode
removeEditor(emailAddress) Presentation のエディターのリストから指定されたユーザーを削除しますPresentation
removeEditor(user) Presentation のエディターのリストから指定されたユーザーを削除しますPresentation
removeViewer(emailAddress) Presentation の閲覧者とコメント投稿者のリストから指定されたユーザーを削除しますPresentation
removeViewer(user) Presentation の閲覧者とコメント投稿者のリストから指定されたユーザーを削除しますPresentation
replaceAllText(findText, replaceText) Integer 検索テキストに一致するテキストのすべてのインスタンスを置換テキストに置き換えます
replaceAllText(findText, replaceText, matchCase) Integer 検索テキストに一致するテキストのすべてのインスタンスを置換テキストに置き換えます
saveAndClose() void 現在のを保存しPresentationます
setName(name) void プレゼンテーションの名前またはタイトルを設定します

Selection

メソッド

メソッド 戻りタイプ 簡単な説明
getCurrentPage() Page 現在アクティブなページ、Pageまたはnullアクティブなページがない場合を返します
getPageElementRange() PageElementRange 選択されているインスタンスのPageElement
getPageRange() PageRange 選択されているflimstrip内SelectionType.PAGE
getSelectionType() SelectionType を返しますSelectionType
getTableCellRange() TableCellRange 選択されているインスタンスのTableCell
getTextRange() TextRange SelectionType.TEXT

SelectionType

プロパティ

物件 タイプ 説明
UNSUPPORTED Enum サポートされていない選択タイプ
NONE Enum 選択なし
TEXT Enum テキスト選択
TABLE_CELL Enum テーブルセルの選択
PAGE Enum サムネイルフリムストリップのページ選択
PAGE_ELEMENT Enum ページ要素の選択
CURRENT_PAGE Enum 現在のページ選択

Shape

メソッド

メソッド 戻りタイプ 簡単な説明
alignOnPage(alignmentPosition) Shape 要素をページ上の指定された配置位置に配置します
bringForward() Shape ページ要素を1要素ずつページ上で前方に移動します
bringToFront() Shape ページ要素をページの前面に移動します
duplicate() PageElement ページ要素を複製します
getBorder() Border Border図形のを返します
getConnectionSites() ConnectionSite[] ConnectionSiteページ要素ののリストを返しますページ要素に接続サイトがない場合は空のリストを返します
getContentAlignment() ContentAlignment Returns the ContentAlignment of the text in the shape.
getDescription() String Returns the page element's description.
getFill() Fill Returns the Fill of the shape.
getHeight() Number Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
getInherentHeight() Number Returns the element's inherent height in points.
getInherentWidth() Number Returns the element's inherent width in points.
getLeft() Number Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation.
getLink() Link Returns the Link or null if there is no link.
getObjectId() String Returns the unique ID for this object.
getPageElementType() PageElementType Returns the page element's type, represented as a PageElementType enum.
getParentGroup() Group Returns the group this page element belongs to, or null if the element is not in a group.
getParentPage() Page Returns the page this page element is on.
getParentPlaceholder() PageElement Returns the parent page element of the placeholder.
getPlaceholderIndex() Integer Returns the placeholder index of the shape.
getPlaceholderType() PlaceholderType Returns the placeholder type of the shape, or PlaceholderType.NONE if the shape is not a placeholder.
getRotation() Number Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation.
getShapeType() ShapeType Returns the type of the shape.
getText() TextRange Returns the text content of the shape.
getTitle() String Returns the page element's title.
getTop() Number Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation.
getTransform() AffineTransform Returns the page element's transform.
getWidth() Number Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation.
preconcatenateTransform(transform) Shape Preconcatenates the provided transform to the existing transform of the page element.
remove() void Removes the page element.
removeLink() void Removes a Link.
replaceWithImage(blobSource) Image Replaces this shape with an image provided by a BlobSource.
replaceWithImage(blobSource, crop) Image Replaces this shape with an image provided by a BlobSource.
replaceWithImage(imageUrl) Image Replaces this shape with an image.
replaceWithImage(imageUrl, crop) Image Replaces this shape with an image.
replaceWithSheetsChart(sourceChart) SheetsChart Replaces this shape with an Google Sheets chart.
replaceWithSheetsChartAsImage(sourceChart) Image Replaces this shape with an image of a Google Sheets chart.
scaleHeight(ratio) Shape Scales the element's height by the specified ratio.
scaleWidth(ratio) Shape Scales the element's width by the specified ratio.
select() void Selects only the PageElement in the active presentation and removes any previous selection.
select(replace) void Selects the PageElement in the active presentation.
sendBackward() Shape Sends the page element backward on the page by one element.
sendToBack() Shape Sends the page element to the back of the page.
setContentAlignment(contentAlignment) Shape Sets the ContentAlignment of the text in the shape.
setDescription(description) Shape Sets the page element's alt text description.
setHeight(height) Shape Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
setLeft(left) Shape 要素に回転がない場合に、ページの左上隅から測定して、要素の水平位置をポイントで設定します
setLinkSlide(slideIndex) Link スライドのゼロから始まるインデックスを使用Slideます
setLinkSlide(slide) Link a Slideされたに設定し、リンクは指定されたスライドIDによって設定されます
setLinkSlide(slidePosition) Link スライドの相対位置を使用Slideます
setLinkUrl(url) Link Link指定された空でないURL文字列にa を設定します
setRotation(angle) Shape 要素の中心を中心とした時計回りの回転角度を度単位で設定します
setTitle(title) Shape ページ要素の代替テキストのタイトルを設定します
setTop(top) Shape 要素に回転がない場合に、ページの左上隅から測定して、要素の垂直位置をポイント単位で設定します
setTransform(transform) Shape 指定された変換を使用してページ要素の変換を設定します
setWidth(width) Shape 要素の幅をポイント単位で設定しますこれは、要素に回転がない場合の要素の境界ボックスの幅です

ShapeType

プロパティ

物件 タイプ 説明
UNSUPPORTED Enum サポートされていない形状タイプ
TEXT_BOX Enum テキストボックスの形状
RECTANGLE Enum 長方形の形状
ROUND_RECTANGLE Enum 角丸長方形
ELLIPSE Enum 楕円形
ARC Enum 湾曲した円弧形状
BENT_ARROW Enum 曲がった矢印の形
BENT_UP_ARROW Enum 矢印の形を曲げた
BEVEL Enum ベベル形状
BLOCK_ARC Enum ブロック円弧形状
BRACE_PAIR Enum ブレースペアの形状
BRACKET_PAIR Enum ブラケットペアの形状
CAN Enum 形作ることができます
CHEVRON Enum シェブロン形
CHORD Enum コードシェイプ
CLOUD Enum 雲の形
CORNER Enum 角の形
CUBE Enum キューブ形状
CURVED_DOWN_ARROW Enum 湾曲した下向き矢印
CURVED_LEFT_ARROW Enum 湾曲した左矢印の形状
CURVED_RIGHT_ARROW Enum 湾曲した右矢印の形状
CURVED_UP_ARROW Enum 上向きの矢印の形状
DECAGON Enum 十角形
DIAGONAL_STRIPE Enum 斜めのストライプ形状
DIAMOND Enum ダイヤモンドの形
DODECAGON Enum 十二角形
DONUT Enum ドーナツ形
DOUBLE_WAVE Enum ダブルウェーブシェイプ
DOWN_ARROW Enum 下矢印の形状
DOWN_ARROW_CALLOUT Enum 吹き出しの下向き矢印の形状
FOLDED_CORNER Enum 折り畳まれた角の形
FRAME Enum フレーム形状
HALF_FRAME Enum ハーフフレーム形状
HEART Enum ハート形
HEPTAGON Enum 七角形
HEXAGON Enum 六角形
HOME_PLATE Enum ホームプレートの形状
HORIZONTAL_SCROLL Enum 水平スクロール形状
IRREGULAR_SEAL_1 Enum 不規則なシール1の形状
IRREGULAR_SEAL_2 Enum 不規則なシール2の形状
LEFT_ARROW Enum 左矢印の形
LEFT_ARROW_CALLOUT Enum 吹き出しの左矢印の形状
LEFT_BRACE Enum 左中括弧の形状
LEFT_BRACKET Enum 左ブラケットの形状
LEFT_RIGHT_ARROW Enum 左右矢印の形状
LEFT_RIGHT_ARROW_CALLOUT Enum 吹き出しの左右矢印の形状
LEFT_RIGHT_UP_ARROW Enum 左右の矢印の形状
LEFT_UP_ARROW Enum 左上矢印の形状
LIGHTNING_BOLT Enum 稲妻の形
MATH_DIVIDE Enum 数学形状を分割します
MATH_EQUAL Enum 等しい数学形状
MATH_MINUS Enum マイナス数学形状
MATH_MULTIPLY Enum 数学図形を乗算します
MATH_NOT_EQUAL Enum 等しくない数学形状
MATH_PLUS Enum プラス数学形状
MOON Enum 月の形
NO_SMOKING Enum 喫煙形状はありません
NOTCHED_RIGHT_ARROW Enum ノッチ付きの右矢印の形状
OCTAGON Enum 八角形
PARALLELOGRAM Enum 平行四辺形です
PENTAGON Enum 五角形
PIE Enum パイの形
PLAQUE Enum プラーク形
PLUS Enum プラス形状
QUAD_ARROW Enum 四角形の矢印
QUAD_ARROW_CALLOUT Enum 吹き出しの四角矢印の形
RIBBON Enum リボンの形
RIBBON_2 Enum リボン2の形状
RIGHT_ARROW Enum 右矢印の形
RIGHT_ARROW_CALLOUT Enum 吹き出しの右矢印の形状
RIGHT_BRACE Enum 右ブレースの形状
RIGHT_BRACKET Enum 右ブラケット形状
ROUND_1_RECTANGLE Enum 1つの角丸長方形
ROUND_2_DIAGONAL_RECTANGLE Enum 2つの斜めの角丸長方形
ROUND_2_SAME_RECTANGLE Enum 2つの同じ側の角丸長方形
RIGHT_TRIANGLE Enum 直角三角形
SMILEY_FACE Enum スマイリーの顔の形
SNIP_1_RECTANGLE Enum 1つの切り取りコーナーの長方形
SNIP_2_DIAGONAL_RECTANGLE Enum 2つの斜めの切り取りコーナーの長方形
SNIP_2_SAME_RECTANGLE Enum 2つの同じ側の切り取りコーナーの長方形
SNIP_ROUND_RECTANGLE Enum 1つの角を切り取る1つの角丸長方形
STAR_10 Enum 10の尖った星の形
STAR_12 Enum 12の尖った星の形
STAR_16 Enum 16の尖った星の形
STAR_24 Enum 24の尖った星の形
STAR_32 Enum 32個の尖った星の形
STAR_4 Enum 四角の星形
STAR_5 Enum 5つの尖った星の形
STAR_6 Enum 六つ星の形
STAR_7 Enum 7つの尖った星の形
STAR_8 Enum 8つの尖った星の形
STRIPED_RIGHT_ARROW Enum ストライプの右矢印の形
SUN Enum 太陽の形
TRAPEZOID Enum 台形形状
TRIANGLE Enum 三角形の形
UP_ARROW Enum 上矢印の形状
UP_ARROW_CALLOUT Enum 上矢印の形をした吹き出し
UP_DOWN_ARROW Enum 上下矢印の形状
UTURN_ARROW Enum Uターン矢印の形状
VERTICAL_SCROLL Enum 垂直スクロール形状
WAVE Enum 波形
WEDGE_ELLIPSE_CALLOUT Enum 吹き出しくさび楕円形
WEDGE_RECTANGLE_CALLOUT Enum コールアウトウェッジ長方形
WEDGE_ROUND_RECTANGLE_CALLOUT Enum コールアウトウェッジの丸い長方形
FLOW_CHART_ALTERNATE_PROCESS Enum 代替プロセスフローの形状
FLOW_CHART_COLLATE Enum 照合フロー形状
FLOW_CHART_CONNECTOR Enum コネクタフロー形状
FLOW_CHART_DECISION Enum 決定フローの形状
FLOW_CHART_DELAY Enum 遅延フロー形状
FLOW_CHART_DISPLAY Enum フロー形状を表示します
FLOW_CHART_DOCUMENT Enum ドキュメントフローの形状
FLOW_CHART_EXTRACT Enum フロー形状を抽出します
FLOW_CHART_INPUT_OUTPUT Enum 入力出力フロー形状
FLOW_CHART_INTERNAL_STORAGE Enum 内部ストレージフローの形状
FLOW_CHART_MAGNETIC_DISK Enum 磁気ディスクの流れの形状
FLOW_CHART_MAGNETIC_DRUM Enum 磁気ドラムフロー形状
FLOW_CHART_MAGNETIC_TAPE Enum 磁気テープフロー形状
FLOW_CHART_MANUAL_INPUT Enum 手動入力フロー形状
FLOW_CHART_MANUAL_OPERATION Enum 手動操作のフロー形状
FLOW_CHART_MERGE Enum フロー形状をマージします
FLOW_CHART_MULTIDOCUMENT Enum マルチドキュメントフローシェイプ
FLOW_CHART_OFFLINE_STORAGE Enum オフラインストレージフローの形状
FLOW_CHART_OFFPAGE_CONNECTOR Enum オフページコネクタフロー形状
FLOW_CHART_ONLINE_STORAGE Enum オンラインストレージフローの形状
FLOW_CHART_OR Enum または流れの形
FLOW_CHART_PREDEFINED_PROCESS Enum 定義済みのプロセスフローの形状
FLOW_CHART_PREPARATION Enum 準備フローの形状
FLOW_CHART_PROCESS Enum プロセスフローの形状
FLOW_CHART_PUNCHED_CARD Enum パンチカードフロー形状
FLOW_CHART_PUNCHED_TAPE Enum パンチテープフロー形状
FLOW_CHART_SORT Enum フロー形状をソートします
FLOW_CHART_SUMMING_JUNCTION Enum 加算接合部の流れの形状
FLOW_CHART_TERMINATOR Enum ターミネーターフローの形状
ARROW_EAST Enum East arrow shape.
ARROW_NORTH_EAST Enum Northeast arrow shape.
ARROW_NORTH Enum North arrow shape.
SPEECH Enum Speech shape.
STARBURST Enum Star burst shape.
TEARDROP Enum Teardrop shape.
ELLIPSE_RIBBON Enum Ellipse ribbon shape.
ELLIPSE_RIBBON_2 Enum Ellipse ribbon 2 shape.
CLOUD_CALLOUT Enum Callout cloud shape.
CUSTOM Enum Custom shape.

SheetsChart

メソッド

Method Return type Brief description
alignOnPage(alignmentPosition) SheetsChart Aligns the element to the specified alignment position on the page.
asImage() Image Returns the chart as an image or null if the chart is not an embedded image.
bringForward() SheetsChart Brings the page element forward on the page by one element.
bringToFront() SheetsChart Brings the page element to the front of the page.
duplicate() PageElement Duplicates the page element.
getChartId() Integer Gets the ID of the specific chart in the Google Sheets spreadsheet that is embedded.
getConnectionSites() ConnectionSite[] Returns the list of ConnectionSites on the page element, or an empty list if the page element does not have any connection sites.
getDescription() String Returns the page element's description.
getEmbedType() SheetsChartEmbedType Returns the embed type of the Sheets chart.
getHeight() Number Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
getInherentHeight() Number Returns the element's inherent height in points.
getInherentWidth() Number Returns the element's inherent width in points.
getLeft() Number Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation.
getLink() Link Returns the Link or null if there is no link.
getObjectId() String Returns the unique ID for this object.
getPageElementType() PageElementType Returns the page element's type, represented as a PageElementType enum.
getParentGroup() Group Returns the group this page element belongs to, or null if the element is not in a group.
getParentPage() Page Returns the page this page element is on.
getRotation() Number Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation.
getSpreadsheetId() String Gets the ID of the Google Sheets spreadsheet that contains the source chart.
getTitle() String Returns the page element's title.
getTop() Number Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation.
getTransform() AffineTransform Returns the page element's transform.
getWidth() Number Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation.
preconcatenateTransform(transform) SheetsChart Preconcatenates the provided transform to the existing transform of the page element.
refresh() void Refreshes the chart by replacing it with the latest version of the chart from Google Sheets.
remove() void Removes the page element.
removeLink() void Removes a Link.
scaleHeight(ratio) SheetsChart Scales the element's height by the specified ratio.
scaleWidth(ratio) SheetsChart Scales the element's width by the specified ratio.
select() void Selects only the PageElement in the active presentation and removes any previous selection.
select(replace) void Selects the PageElement in the active presentation.
sendBackward() SheetsChart Sends the page element backward on the page by one element.
sendToBack() SheetsChart Sends the page element to the back of the page.
setDescription(description) SheetsChart Sets the page element's alt text description.
setHeight(height) SheetsChart Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
setLeft(left) SheetsChart Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation.
setLinkSlide(slideIndex) Link Sets a Slide using the zero-based index of the slide.
setLinkSlide(slide) Link Sets a Slide, the link is set by the given slide ID.
setLinkSlide(slidePosition) Link スライドの相対位置を使用Slideます
setLinkUrl(url) Link Link指定された空でないURL文字列にa を設定します
setRotation(angle) SheetsChart 要素の中心を中心とした時計回りの回転角度を度単位で設定します
setTitle(title) SheetsChart ページ要素の代替テキストのタイトルを設定します
setTop(top) SheetsChart 要素に回転がない場合に、ページの左上隅から測定して、要素の垂直位置をポイント単位で設定します
setTransform(transform) SheetsChart 指定された変換を使用してページ要素の変換を設定します
setWidth(width) SheetsChart 要素の幅をポイント単位で設定しますこれは、要素に回転がない場合の要素の境界ボックスの幅です

SheetsChartEmbedType

プロパティ

物件 タイプ 説明
UNSUPPORTED Enum サポートされておらず、さらに分類できないチャートを表します
IMAGE Enum チャートが画像として埋め込まれていることを示します

Slide

メソッド

メソッド 戻りタイプ 簡単な説明
duplicate() Slide スライドを複製します
getBackground() PageBackground ページの背景を取得します
getColorScheme() ColorScheme ColorSchemeページに関連付けられたを取得します
getGroups() Group[] Groupページ上のオブジェクトのリストを返します
getImages() Image[] Imageページ上のオブジェクトのリストを返します
getLayout() Layout スライドが基づくレイアウト、またはnullスライドがレイアウトに基づいていない場合のレイアウトを取得します
getLines() Line[] Lineページ上のオブジェクトのリストを返します
getNotesPage() NotesPage スライドに関連付けられているメモページを返します
getObjectId() String ページの一意のIDを取得します
getPageElementById(id) PageElement PageElement指定されたIDのページにを返しますnull存在しない場合は返します
getPageElements() PageElement[] PageElementページにレンダリングされたオブジェクトのリストを返します
getPageType() PageType ページのタイプを取得します
getPlaceholder(placeholderType) PageElement PlaceholderTypeまたは null一致するプレースホルダーが存在しない場合、プレースホルダーオブジェクトを返します
getPlaceholder(placeholderType, placeholderIndex) PageElement PlaceholderTypeたプレースホルダーインデックスのプレースホルダーオブジェクトを返しますnullプレースホルダーが存在しない場合
getPlaceholders() PageElement[] PageElementページ内のプレースホルダーオブジェクトのリストを返します
getShapes() Shape[] Shapeページ上のオブジェクトのリストを返します
getSheetsCharts() SheetsChart[] SheetsChartページ上のオブジェクトのリストを返します
getSlideLinkingMode() SlideLinkingMode SlideLinkingModeスライドが別のスライドにリンクされているかどうかを示すを返します
getSourcePresentationId() String ソースPresentationIDを返すnullか、スライドがリンクされていない場合
getSourceSlideObjectId() String ソーススライドIDを返すnullか、スライドがリンクされていない場合
getTables() Table[] Tableページ上のオブジェクトのリストを返します
getVideos() Video[] Videoページ上のオブジェクトのリストを返します
getWordArts() WordArt[] WordArtページ上のオブジェクトのリストを返します
group(pageElements) Group 指定されたすべてのページ要素をグループ化します
insertGroup(group) Group Inserts a copy of the provided Group on the page.
insertImage(blobSource) Image Inserts an image at the top left corner of the page with a default size from the specified image blob.
insertImage(blobSource, left, top, width, height) Image Inserts an image on the page with the provided position and size from the specified image blob.
insertImage(image) Image Inserts a copy of the provided Image on the page.
insertImage(imageUrl) Image Inserts an image at the top left corner of the page with a default size from the provided URL.
insertImage(imageUrl, left, top, width, height) Image Inserts an image on the page with the provided position and size from the provided URL.
insertLine(line) Line Inserts a copy of the provided Line on the page.
insertLine(lineCategory, startConnectionSite, endConnectionSite) Line Inserts a line on the page connecting two connection sites.
insertLine(lineCategory, startLeft, startTop, endLeft, endTop) Line Inserts a line on the page.
insertPageElement(pageElement) PageElement Inserts a copy of the provided PageElement on the page.
insertShape(shape) Shape Inserts a copy of the provided Shape on the page.
insertShape(shapeType) Shape Inserts a shape on the page.
insertShape(shapeType, left, top, width, height) Shape Inserts a shape on the page.
insertSheetsChart(sourceChart) SheetsChart Inserts a Google Sheets chart on the page.
insertSheetsChart(sourceChart, left, top, width, height) SheetsChart Inserts a Google Sheets chart on the page with the provided position and size.
insertSheetsChart(sheetsChart) SheetsChart Inserts a copy of the provided SheetsChart on the page.
insertSheetsChartAsImage(sourceChart) Image Inserts a Google Sheets chart as an Image on the page.
insertSheetsChartAsImage(sourceChart, left, top, width, height) Image Inserts a Google Sheets chart as an Image on the page with the provided position and size.
insertTable(numRows, numColumns) Table Inserts a table on the page.
insertTable(numRows, numColumns, left, top, width, height) Table Inserts a table on the page with the provided position and size.
insertTable(table) Table Inserts a copy of the provided Table on the page.
insertTextBox(text) Shape Inserts a text box Shape containing the provided string on the page.
insertTextBox(text, left, top, width, height) Shape Inserts a text box Shape containing the provided string on the page.
insertVideo(videoUrl) Video Inserts a video at the top left corner of the page with a default size.
insertVideo(videoUrl, left, top, width, height) Video Inserts a video on the page with the provided position and size.
insertVideo(video) Video Inserts a copy of the provided Video on the page.
insertWordArt(wordArt) WordArt Inserts a copy of the provided WordArt on the page.
move(index) void Move the slide to the specified index.
refreshSlide() void Refreshes the slide to reflect any changes made to the linked source slide.
remove() void Removes the page.
replaceAllText(findText, replaceText) Integer Replaces all instances of text matching find text with replace text.
replaceAllText(findText, replaceText, matchCase) Integer Replaces all instances of text matching find text with replace text.
selectAsCurrentPage() void Selects the current page selection and removes any previous selection.
unlink() void Unlinks the current Slide from its source slide.

SlideLinkingMode

プロパティ

Property Type Description
UNSUPPORTED Enum A slide linking mode that isn't supported.
LINKED Enum Indicates that slides are linked.
NOT_LINKED Enum Indicates that slides aren't linked.

SlidePosition

プロパティ

Property Type Description
NEXT_SLIDE Enum The next slide.
PREVIOUS_SLIDE Enum The previous slide.
FIRST_SLIDE Enum The first slide in the presentation.
LAST_SLIDE Enum The last slide in the presentation.

SlidesApp

プロパティ

Property Type Description
AlignmentPosition AlignmentPosition An enumeration of the types of alignment positions.
ArrowStyle ArrowStyle An enumeration of the different arrow styles that a Line can have.
AutoTextType AutoTextType An enumeration of the types of auto text.
CellMergeState CellMergeState An enumeration of the different merge states of a table cell.
ColorType ColorType An enumeration of color types.
ContentAlignment ContentAlignment An enumeration of values used to specify content alignment.
DashStyle DashStyle An enumeration of the different dash styles that a Line can have.
FillType FillType An enumeration of fill types.
LineCategory LineCategory An enumeration of the categories of Line.
LineFillType LineFillType An enumeration of the types of LineFill.
LineType LineType An enumeration of the types of Line.
LinkType LinkType リンクのタイプの列挙
ListPreset ListPreset リストプリセットのタイプの列挙
PageBackgroundType PageBackgroundType ページ背景のタイプの列挙
PageElementType PageElementType ページ要素のタイプの列挙
PageType PageType ページのタイプの列挙
ParagraphAlignment ParagraphAlignment 段落の配置の種類の列挙
PlaceholderType PlaceholderType プレースホルダーのタイプの列挙
PredefinedLayout PredefinedLayout 事前定義されたレイアウトの列挙
SelectionType SelectionType 選択のタイプの列挙
ShapeType ShapeType 形状のタイプの列挙
SheetsChartEmbedType SheetsChartEmbedType Sheetsチャートの埋め込みタイプの列挙
SlideLinkingMode SlideLinkingMode スライドのリンクメソッドの列挙
SlidePosition SlidePosition スライド位置のタイプの列挙
SpacingMode SpacingMode 間隔モードのタイプの列挙
TextBaselineOffset TextBaselineOffset テキストベースラインオフセットのタイプの列挙
TextDirection TextDirection テキスト方向のタイプの列挙
ThemeColorType ThemeColorType テーマの色の列挙
VideoSourceType VideoSourceType ビデオソースのタイプの列挙

メソッド

メソッド 戻りタイプ 簡単な説明
create(name) Presentation 新しいを作成して開きますPresentation
getActivePresentation() Presentation スクリプトがされている現在アクティブなプレゼンテーションを返しコンテナ結合、またはnullアクティブなプレゼンテーションが存在しない場合は
getUi() Ui スクリプトがメニュー、ダイアログ、サイドバーなどの機能を追加できるようにするプレゼンテーションのユーザーインターフェイス環境のインスタンスを返します
newAffineTransformBuilder() AffineTransformBuilder AffineTransform
openById(id) Presentation Presentation指定されたIDでを開きます
openByUrl(url) Presentation Presentation指定されたURLでを開きます

SolidFill

メソッド

メソッド 戻りタイプ 簡単な説明
getAlpha() Number [0、1.0]の間隔で色の不透明度を取得します1.0は完全に不透明であることを意味します
getColor() Color 塗りつぶしの色を取得します

SpacingMode

プロパティ

物件 タイプ 説明
UNSUPPORTED Enum サポートされていない間隔モード
NEVER_COLLAPSE Enum 段落間隔は常にレンダリングされます
COLLAPSE_LISTS Enum リスト要素間の段落間隔はスキップされます

Table

メソッド

メソッド 戻りタイプ 簡単な説明
alignOnPage(alignmentPosition) Table 要素をページ上の指定された配置位置に配置します
appendColumn() TableColumn テーブルの最後の列の右側に新しい列を追加します
appendRow() TableRow Appends a new row below the last row of the table.
bringForward() Table Brings the page element forward on the page by one element.
bringToFront() Table Brings the page element to the front of the page.
duplicate() PageElement Duplicates the page element.
getCell(rowIndex, columnIndex) TableCell Returns the specified cell in the table.
getColumn(columnIndex) TableColumn Returns the specified column in the table.
getConnectionSites() ConnectionSite[] Returns the list of ConnectionSites on the page element, or an empty list if the page element does not have any connection sites.
getDescription() String Returns the page element's description.
getHeight() Number Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
getInherentHeight() Number Returns the element's inherent height in points.
getInherentWidth() Number Returns the element's inherent width in points.
getLeft() Number Returns the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation.
getNumColumns() Integer Returns the number of columns in the table.
getNumRows() Integer Returns the number of rows in the table.
getObjectId() String Returns the unique ID for this object.
getPageElementType() PageElementType Returns the page element's type, represented as a PageElementType enum.
getParentGroup() Group Returns the group this page element belongs to, or null if the element is not in a group.
getParentPage() Page Returns the page this page element is on.
getRotation() Number Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation.
getRow(rowIndex) TableRow Returns the specified row in the table.
getTitle() String Returns the page element's title.
getTop() Number Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation.
getTransform() AffineTransform Returns the page element's transform.
getWidth() Number Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation.
insertColumn(index) TableColumn Inserts a new column at the specified index of the table.
insertRow(index) TableRow Inserts a new row at the specified index of the table.
preconcatenateTransform(transform) Table Preconcatenates the provided transform to the existing transform of the page element.
remove() void Removes the page element.
scaleHeight(ratio) Table Scales the element's height by the specified ratio.
scaleWidth(ratio) Table Scales the element's width by the specified ratio.
select() void Selects only the PageElement in the active presentation and removes any previous selection.
select(replace) void Selects the PageElement in the active presentation.
sendBackward() Table Sends the page element backward on the page by one element.
sendToBack() Table Sends the page element to the back of the page.
setDescription(description) Table Sets the page element's alt text description.
setHeight(height) Table Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
setLeft(left) Table Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation.
setRotation(angle) Table Sets the element's clockwise rotation angle around its center in degrees.
setTitle(title) Table Sets the page element's alt text title.
setTop(top) Table Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation.
setTransform(transform) Table Sets the transform of the page element with the provided transform.
setWidth(width) Table Sets the element's width in points, which is the width of the element's bounding box when the element has no rotation.

TableCell

メソッド

Method Return type Brief description
getColumnIndex() Integer Returns the 0-based column index of the table cell.
getColumnSpan() Integer Returns the column span of the table cell.
getContentAlignment() ContentAlignment Returns the ContentAlignment of the text in the table cell.
getFill() Fill Returns the fill of the table cell.
getHeadCell() TableCell Returns the head cell of this table cell.
getMergeState() CellMergeState Returns the merge state of the table cell.
getParentColumn() TableColumn Returns the table column containing the current cell.
getParentRow() TableRow Returns the table row containing the current cell.
getParentTable() Table Returns the table containing the current cell.
getRowIndex() Integer Returns the 0-based row index of the table cell.
getRowSpan() Integer Returns the row span of the table cell.
getText() TextRange Returns the text content of the table cell.
setContentAlignment(contentAlignment) TableCell Sets the ContentAlignment of the text in the table cell.

TableCellRange

メソッド

Method Return type Brief description
getTableCells() TableCell[] Returns the list of TableCell instances.

TableColumn

メソッド

Method Return type Brief description
getCell(cellIndex) TableCell Returns the cell at the specified index.
getIndex() Integer Returns the 0-based index of the column.
getNumCells() Integer Returns the number of cells in this column.
getParentTable() Table Returns the table containing the current column.
getWidth() Number Returns the width of the column in points.
remove() void Removes the table column.

TableRow

メソッド

Method Return type Brief description
getCell(cellIndex) TableCell Returns the cell at the specified index.
getIndex() Integer Returns the 0-based index of the row.
getMinimumHeight() Number Returns the minimum height of the row in points.
getNumCells() Integer Returns the number of cells in this row.
getParentTable() Table Returns the table containing the current row.
remove() void Removes the table row.

TextBaselineOffset

プロパティ

Property Type Description
UNSUPPORTED Enum An text baseline offset that is not supported.
NONE Enum The text is not vertically offset.
SUPERSCRIPT Enum The text is vertically offset upwards.
SUBSCRIPT Enum The text is vertically offset downwards.

TextDirection

プロパティ

Property Type Description
UNSUPPORTED Enum A text direction that is not supported.
LEFT_TO_RIGHT Enum The text goes from left to right.
RIGHT_TO_LEFT Enum The text goes from right to left.

TextRange

メソッド

Method Return type Brief description
appendParagraph(text) Paragraph Appends a paragraph at the end of the text range.
appendRange(textRange) TextRange 指定されたテキスト範囲のコピーを現在のテキスト範囲の末尾に追加します
appendRange(textRange, matchSourceFormatting) TextRange 指定されたテキスト範囲のコピーを現在のテキスト範囲の末尾に追加します
appendText(text) TextRange テキスト範囲の最後にテキストを追加します
asRenderedString() String 関連付けられたシェイプまたはテーブルセルのこの範囲で区切られたレンダリングテキストを、エンドユーザーに表示するのに適した形式で返します
asString() String 関連するシェイプまたはテーブルセルのこの範囲で区切られた生のテキストを返します
clear() void この範囲で区切られたテキストをクリアします
clear(startOffset, endOffset) void 範囲内の開始オフセットと終了オフセットで区切られたテキストをクリアします
find(pattern) TextRange[] 現在のテキスト範囲内の検索パターンに一致するすべての範囲を返します
find(pattern, startOffset) TextRange[] 開始オフセットから始まる現在のテキスト範囲の検索パターンに一致するすべての範囲を返します
getAutoTexts() AutoText[] 現在のテキスト範囲内のオートテキストを返します
getEndIndex() Integer この範囲内の最後の文字の0から始まる排他的なインデックスを返します
getLength() Integer この範囲の文字数を返します
getLinks() TextRange[] Link現在のテキスト範囲内または現在のテキスト範囲と重複するすべてのに対応するテキスト範囲のコレクションを返します
getListParagraphs() Paragraph[] 現在のテキスト範囲と重複するリスト内の段落を返します
getListStyle() ListStyle ListStyle現在のテキスト範囲のを返します
getParagraphStyle() ParagraphStyle ParagraphStyle現在のテキスト範囲のを返します
getParagraphs() Paragraph[] 現在のテキスト範囲に重なる段落を返します
getRange(startOffset, endOffset) TextRange TextRange派生元の範囲の新しいカバー部分を返します
getRuns() TextRange[] 現在のテキスト範囲に重なるテキストランを返します
getStartIndex() Integer この範囲の最初の文字の包括的な0から始まるインデックスを返します
getTextStyle() TextStyle 範囲のテキストスタイルを返しますnull範囲が空の場合
insertParagraph(startOffset, text) Paragraph 開始オフセットに段落を挿入します
insertRange(startOffset, textRange) TextRange 指定されたテキスト範囲のコピーを開始オフセットに挿入します
insertRange(startOffset, textRange, matchSourceFormatting) TextRange 指定されたテキスト範囲のコピーを開始オフセットに挿入します
insertText(startOffset, text) TextRange 開始オフセットにテキストを挿入します
isEmpty() Boolean 戻り値trueこの範囲の文字がない場合、戻りfalse そう
replaceAllText(findText, replaceText) Integer 検索テキストに一致するテキストのすべてのインスタンスを置換テキストに置き換えます
replaceAllText(findText, replaceText, matchCase) Integer 検索テキストに一致するテキストのすべてのインスタンスを置換テキストに置き換えます
select() void TextRangeアクティブなプレゼンテーションのみを選択し、以前の選択を削除します
setText(newText) TextRange 関連するシェイプまたはテーブルセルのこの範囲で区切られたテキストを設定します

TextStyle

メソッド

メソッド 戻りタイプ 簡単な説明
getBackgroundColor() Color テキストの背景色、またはテキストにnull複数のスタイルがある場合に返します
getBaselineOffset() TextBaselineOffset 通常の位置からのテキストの垂直オフセット、またはnullテキストに複数のスタイルがある場合に返します
getFontFamily() String テキストのフォントファミリを返しnullますテキストに複数のスタイルがある場合
getFontSize() Number テキストのフォントサイズをポイント単位で、またはテキストにnull複数のスタイルがある場合に返します
getFontWeight() Integer テキストのフォントの太さ、またはテキストにnull複数のスタイルがある場合に返します
getForegroundColor() Color テキストの前景色、またはテキストにnull複数のスタイルがある場合に返します
getLink() Link Linkテキスト上のを返しますnullリンクがない場合、リンクがテキストの一部にある場合、または複数のリンクがある場合
hasLink() Boolean trueテキストにリンクがある場合、falseない場合、またはnullリンクがテキストの一部にある場合、または複数のリンクがある場合に返します
isBackgroundTransparent() Boolean trueテキストの背景が透明falseかどうか、そうでない場合、またはnullテキストに複数のスタイルがあるか どうかを返します
isBold() Boolean trueテキストが太字で表示されているfalseか、そうでない場合、またはnullテキストに複数のスタイルがあるかを返します
isItalic() Boolean trueテキストが斜体falseかどうか、そうでない場合、またはnullテキストに複数のスタイルがあるかどうかを返します
isSmallCaps() Boolean trueテキストが小さい大文字であるfalse場合、そうでない場合、またはnullテキストに複数のスタイルがある場合に返します
isStrikethrough() Boolean trueテキストに取り消し線が引かれているか、戻されてfalseいないか、またはnullテキストに複数のスタイルがある場合に返します
isUnderline() Boolean trueテキストに下線が付いているfalseかどうか、そうでない場合、またはnullテキストに複数のスタイルがあるかどうかを返します
removeLink() TextStyle を削除しますLink
setBackgroundColor(color) TextStyle テキストの背景色を設定します
setBackgroundColor(red, green, blue) TextStyle テキストの背景色を0〜255の指定されたRGB値に設定します
setBackgroundColor(hexColor) TextStyle テキストの背景色を指定された16進数の色文字列に設定します
setBackgroundColor(color) TextStyle テキストの背景色を指定されたに設定しますThemeColorType
setBackgroundColorTransparent() TextStyle Sets the background color of the text to transparent.
setBaselineOffset(offset) TextStyle Sets the vertical offset of the text relative to its normal position.
setBold(bold) TextStyle Sets whether the text should be rendered as bold.
setFontFamily(fontFamily) TextStyle Sets the font family of the text .
setFontFamilyAndWeight(fontFamily, fontWeight) TextStyle Sets the font family and weight of the text.
setFontSize(fontSize) TextStyle Sets the font size of the text, in points.
setForegroundColor(foregroundColor) TextStyle Sets the foreground color of the text.
setForegroundColor(red, green, blue) TextStyle Sets the foreground color of the text to the given RGB values from 0 to 255.
setForegroundColor(hexColor) TextStyle Sets the foreground color of the text to the given hex color string.
setForegroundColor(color) TextStyle Sets the foreground color of the text to the given ThemeColorType.
setItalic(italic) TextStyle Sets the whether the text is italicized.
setLinkSlide(slideIndex) TextStyle Sets a Slide using the zero-based index of the slide.
setLinkSlide(slide) TextStyle Sets a Slide, the link is set by the given slide ID.
setLinkSlide(slidePosition) TextStyle スライドの相対位置を使用Slideます
setLinkUrl(url) TextStyle Link指定された空でないURL文字列にa を設定します
setSmallCaps(smallCaps) TextStyle テキストを小文字でレンダリングするかどうかを設定します
setStrikethrough(strikethrough) TextStyle テキストを打ち消すかどうかを設定します
setUnderline(underline) TextStyle テキストに下線を付けるかどうかを設定します

ThemeColor

メソッド

メソッド 戻りタイプ 簡単な説明
getColorType() ColorType この色のタイプを取得します
getThemeColorType() ThemeColorType この色のテーマカラータイプを取得します

ThemeColorType

プロパティ

物件 タイプ 説明
UNSUPPORTED Enum サポートされていないテーマの色を表します
DARK1 Enum 最初の暗い色を表します
LIGHT1 Enum 最初の明るい色を表します
DARK2 Enum 2番目の暗い色を表します
LIGHT2 Enum 2番目の明るい色を表します
ACCENT1 Enum 最初のアクセント色を表します
ACCENT2 Enum 2番目のアクセントカラーを表します
ACCENT3 Enum 3番目のアクセントカラーを表します
ACCENT4 Enum 4番目のアクセントカラーを表します
ACCENT5 Enum 5番目のアクセントカラーを表します
ACCENT6 Enum 6番目のアクセントカラーを表します
HYPERLINK Enum ハイパーリンクに使用する色を表します
FOLLOWED_HYPERLINK Enum 訪問したハイパーリンクに使用する色を表します

Video

メソッド

メソッド 戻りタイプ 簡単な説明
alignOnPage(alignmentPosition) Video 要素をページ上の指定された配置位置に配置します
bringForward() Video ページ要素を1要素ずつページ上で前方に移動します
bringToFront() Video ページ要素をページの前面に移動します
duplicate() PageElement ページ要素を複製します
getBorder() Border Borderビデオのを返します
getConnectionSites() ConnectionSite[] ConnectionSiteページ要素ののリストを返しますページ要素に接続サイトがない場合は空のリストを返します
getDescription() String ページ要素の説明を返します
getHeight() Number 要素の高さをポイント単位で取得しますこれは、要素に回転がない場合の要素の境界ボックスの高さです
getInherentHeight() Number 要素の固有の高さをポイント単位で返します
getInherentWidth() Number 要素の固有の幅をポイント単位で返します
getLeft() Number 要素に回転がない場合に、ページの左上隅から測定した要素の水平位置をポイント単位で返します
getObjectId() String このオブジェクトの一意のIDを返します
getPageElementType() PageElementType Returns the page element's type, represented as a PageElementType enum.
getParentGroup() Group Returns the group this page element belongs to, or null if the element is not in a group.
getParentPage() Page Returns the page this page element is on.
getRotation() Number Returns the element's clockwise rotation angle around its center in degrees, where zero degrees means no rotation.
getSource() VideoSourceType Gets the video source.
getThumbnailUrl() String Gets an URL to the video thumbnail.
getTitle() String Returns the page element's title.
getTop() Number Gets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation.
getTransform() AffineTransform Returns the page element's transform.
getUrl() String Gets an URL to the video.
getVideoId() String Gets the video source's unique identifier for this video.
getWidth() Number Returns the element's width in points, which is the width of the element's bounding box when the element has no rotation.
preconcatenateTransform(transform) Video Preconcatenates the provided transform to the existing transform of the page element.
remove() void Removes the page element.
scaleHeight(ratio) Video Scales the element's height by the specified ratio.
scaleWidth(ratio) Video Scales the element's width by the specified ratio.
select() void Selects only the PageElement in the active presentation and removes any previous selection.
select(replace) void Selects the PageElement in the active presentation.
sendBackward() Video Sends the page element backward on the page by one element.
sendToBack() Video Sends the page element to the back of the page.
setDescription(description) Video Sets the page element's alt text description.
setHeight(height) Video Sets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
setLeft(left) Video Sets the element's horizontal position in points, measured from the upper-left corner of the page when the element has no rotation.
setRotation(angle) Video Sets the element's clockwise rotation angle around its center in degrees.
setTitle(title) Video Sets the page element's alt text title.
setTop(top) Video Sets the element's vertical position in points, measured from the upper-left corner of the page when the element has no rotation.
setTransform(transform) Video Sets the transform of the page element with the provided transform.
setWidth(width) Video Sets the element's width in points, which is the width of the element's bounding box when the element has no rotation.

VideoSourceType

プロパティ

Property Type Description
UNSUPPORTED Enum A video source type that is not supported.
YOUTUBE Enum YouTube video.

WordArt

メソッド

Method Return type Brief description
alignOnPage(alignmentPosition) WordArt Aligns the element to the specified alignment position on the page.
bringForward() WordArt Brings the page element forward on the page by one element.
bringToFront() WordArt Brings the page element to the front of the page.
duplicate() PageElement Duplicates the page element.
getConnectionSites() ConnectionSite[] Returns the list of ConnectionSites on the page element, or an empty list if the page element does not have any connection sites.
getDescription() String Returns the page element's description.
getHeight() Number Gets the element's height in points, which is the height of the element's bounding box when the element has no rotation.
getInherentHeight() Number Returns the element's inherent height in points.
getInherentWidth() Number Returns the element's inherent width in points.
getLeft() Number 要素に回転がない場合に、ページの左上隅から測定した要素の水平位置をポイント単位で返します
getLink() Link Linkまたはnullリンクがない場合を返します
getObjectId() String このオブジェクトの一意のIDを返します
getPageElementType() PageElementType PageElementType列挙として表されるページ要素のタイプを返します
getParentGroup() Group このページ要素が属するグループを返しますnull要素がグループに含まれていない場合
getParentPage() Page このページ要素があるページを返します
getRenderedText() String ワードアートとしてレンダリングされるテキストを取得します
getRotation() Number 要素の中心を中心とした時計回りの回転角度を度単位で返します0度は回転しないことを意味します
getTitle() String ページ要素のタイトルを返します
getTop() Number 要素に回転がない場合に、ページの左上隅から測定された、要素の垂直位置をポイント単位で取得します
getTransform() AffineTransform ページ要素の変換を返します
getWidth() Number 要素の幅をポイント単位で返しますこれは、要素に回転がない場合の要素の境界ボックスの幅です
preconcatenateTransform(transform) WordArt 指定された変換をページ要素の既存の変換に事前連結します
remove() void ページ要素を削除します
removeLink() void を削除しますLink
scaleHeight(ratio) WordArt 指定した比率で要素の高さを拡大縮小します
scaleWidth(ratio) WordArt 指定された比率で要素の幅を拡大縮小します
select() void PageElementアクティブなプレゼンテーションのみを選択し、以前の選択を削除します
select(replace) void PageElementアクティブなプレゼンテーションでを選択します
sendBackward() WordArt ページ要素を1要素ずつページ上で後方に送ります
sendToBack() WordArt ページ要素をページの後ろに送ります
setDescription(description) WordArt ページ要素の代替テキストの説明を設定します
setHeight(height) WordArt 要素の高さをポイント単位で設定しますこれは、要素に回転がない場合の要素の境界ボックスの高さです
setLeft(left) WordArt 要素に回転がない場合に、ページの左上隅から測定して、要素の水平位置をポイントで設定します
setLinkSlide(slideIndex) Link スライドのゼロから始まるインデックスを使用Slideます
setLinkSlide(slide) Link a Slideされたに設定し、リンクは指定されたスライドIDによって設定されます
setLinkSlide(slidePosition) Link スライドの相対位置を使用Slideます
setLinkUrl(url) Link Link指定された空でないURL文字列にa を設定します
setRotation(angle) WordArt 要素の中心を中心とした時計回りの回転角度を度単位で設定します
setTitle(title) WordArt ページ要素の代替テキストのタイトルを設定します
setTop(top) WordArt 要素に回転がない場合に、ページの左上隅から測定して、要素の垂直位置をポイント単位で設定します
setTransform(transform) WordArt 指定された変換を使用してページ要素の変換を設定します
setWidth(width) WordArt 要素の幅をポイント単位で設定しますこれは、要素に回転がない場合の要素の境界ボックスの幅です

Google Apps Scriptのリファレンスは以上になります。

最後まで読んでくれてありがとうございました。

では、また。

  • この記事を書いた人

mono

26歳♂首都圏住みの副業会社員/ギークでズボラないい暮らし/ADHD・HSP傾向/将来はサイドFIREでのんびり暮らしたい/楽天経済圏/リベ大生/インデックス・高配当株投資300万/お仕事の依頼はこちら

スキルを磨く Google Apps Script

© 2021 monoblog