[Google Sheets API] Javaでスプレットシートの情報を取得する

Google Sheets API v4（Java）を使用して、スプレットシートの情報を取得する方法
についてご紹介します。

セルの値を含め、スプレットシートが持つさまざまな情報を取得する方法について
説明したいと思います。

スプレットシートの情報を取得する際には、取得したい情報を指定します。
この指定がない場合、必要でない情報(例えば全セルのサイズ等)も取得してしまうため、
レスポンスが膨大なデータになってしまいます。
そのため、リクエストに対する応答も遅くなってしまいます。

スプレットシートから特定の情報を取得したいけど、
　**どのような情報があるかわからない**　とか
　**ドキュメントは探してみたけど英語しかない**　とか
　**取得したい情報の指定がわからない**　など
の方が参考できるようにこの記事を書きました。
プログラムの実装方法を参考にするというよりは、
辞書としての意味合いで記事を参照していただけたら幸いです。

:::note info
スプレットシートのメニューから利用するGoogle Sheets APIを探したい場合は`
下記の記事を参照ください。
[⧉[Google Sheets API] JavaでスプレットシートのメニューとAPIを関連づけてみた](https://qiita.com/doran/items/2f6f8932b994fbd1a170)
:::

|No||目次|取得できる情報|
|---|---|---|---|
|0||[プログラムの実行](#0-プログラムの実行)||
||1|[実行プログラム](#01-実行プログラム)||
||2|[取得できる情報](#02-取得できる情報)||
||3|[取得一覧](#03-取得一覧)||
|1||[SpreadsheetProperties](#1-spreadsheetproperties)|スプレットシートのプロパティデータ|
||1|[IterativeCalculationSettings](#11-iterativecalculationsettings)|計算-反復計算で設定できる内容|
||2|[SpreadsheetTheme](#12-spreadsheettheme)|スプレットシートのテーマ|
|2||[DeveloperMetadata](#2-developermetadata)|開発者メタデータ|
||1|[DeveloperMetadataLocation](#21-developermetadatalocation)|メタデータの行、列の情報|
|3||[NamedRange](#3-namedrange)|名前付き範囲|
|4||[Sheet](#4-sheet)|シートのデータ|
||1|[BandedRange](#41-bandedrange)|交互の背景色|
||2|[BasicFilter](#42-basicfilter)|Basicフィルター|
||3|[FilterView](#43-filterview)|フィルター|
||4|[EmbeddedChart](#44-embeddedchart)|グラフの仕様|
||5|[ConditionalFormatRule](#45-conditionalformatrule)|条件付き書式|
||6|[SortSpec](#46-sortspec)|並び順の仕様|
||7|[FilterCriteria](#47-filtercriteria)|フィルタリングの仕様|
||8|[BooleanCondition](#48-booleancondition)|入力規則|
||9|[EmbeddedObjectPosition](#49-embeddedobjectposition)|グラフのサイズ、配置位置|
||10|[GridData](#410-griddata)|グリッドデータ|
||11|[SheetProperties](#411-sheetproperties)|プロパティ|
||12|[ProtectedRange](#412-protectedrange)|保護範囲|
|5||[グラフのデータ](#5-グラフのデータ)||
||1|[BasicChartSpec](#51-basicchartspec)|基本的なチャートの情報|
||2|[BubbleChartSpec](#52-bubblechartspec)|バブルチャートの情報|
||3|[CandlestickChartSpec](#53-candlestickchartspec)|ローソク足チャートの情報|
||4|[HistogramChartSpec](#54-histogramchartspec)|ヒストグラムチャートの情報|
||5|[OrgChartSpec](#55-orgchartspec)|組織図の情報|
||6|[PieChartSpec](#56-piechartspec)|円グラフの情報|
||7|[ScorecardChartSpec](#57-scorecardchartspec)|スコアカード チャートの情報|
||8|[TreemapChartSpec](#58-treemapchartspec)|ツリーマップ チャートの情報|
||9|[WaterfallChartSpec](#59-waterfallchartspec)|ウォーターフォールチャートの情報|
|6||[共通](#6-共通)||
||1|[CellFormat](#61-cellformat)|セルのフォーマット|
||2|[DimensionRange](#62-dimensionrange)|範囲|
||3|[GridRange](#63-gridrange)|グリッド範囲|
||4|[DimensionGroup](#64-dimensiongroup)|範囲グループ|
||5|[Color](#65-color)|色情報|
||6|[ColorStyle](#66-colorstyle)|色情報、テーマカラー|
||7|[TextFormat](#67-textformat)|テキストの形式|
||8|[TextPosition](#68-textposition)|テキストの水平方向位置|
||9|[ExtendedValue](#69-extendedvalue)|セルの値|
||10|[Borders](#610-borders)|セル枠線の情報|
||11|[NumberFormat](#611-numberformat)|テキストの書式|
||12|[Padding](#612-padding)|セルの余白|
||13|[TextRotation](#613-textrotation)|テキストの回転情報|
||14|[ErrorValue](#614-errorvalue)|エラー情報|
||15|[ChartData](#615-chartdata)|グラフのデータ|
||16|[LineStyle](#616-linestyle)|線のスタイル|


## 0. プログラムの実行

コードを実行する際は、
[⧉[Google Sheets API] Google Sheets API v4をJavaで操作する](https://qiita.com/doran/items/3d43f776188b2281044c)
を合わせて参照ください。

### 0.1. 実行プログラム
プログラムの実行です。

取得する対象のスプレットシートID、シート名と範囲、取得したいFiled(情報)
を指定してexecute()を実行するだけです。

**サンプル コード**
```java
public static void main(String[] args) throws Exception {
    String fileId = "取得するスプレットシートのID";

    Spreadsheets sheets = getSpreadsheets();

    com.google.api.services.sheets.v4.model.Spreadsheet info
 	 = sheets
	    .get(fileId)				//取得するスプレットシートID
	    .setRanges(getRange())		//取得するシート名とシート範囲
	    .setFields(getFileds())		//取得するField
	    .execute();				//実行する
     
    System.out.println(info);
}
```

#### 0.1.1. 取得する範囲
取得したいシート名と範囲を指定します。
リストでの指定なので複数指定することも可能です。

**サンプル コード**
```java
public static List<String> getRange(){
    List<String> ranges = new ArrayList<>();
    
    ranges.add("テスト!A1:A2");
    ranges.add("テスト!B1:B2");

    return ranges;
}
```
#### 0.1.2.  取得するField
取得したいフィールドを文字列で指定します。
書き方の詳細は、[取得できる情報](#02-取得できる情報)を参照してください。

**サンプル コード**
```java
public static String getFileds() {
		return "spreadsheetId,sheets.properties(sheetId,title),sheets.data(startColumn,startRow),sheets.data.rowData.values(userEnteredValue,effectiveValue,formattedValue)";
}
```
### 0.2. 取得できる情報

例えば、セルの内の
・ユーザーが入力した値（関数であれば、入力した式）
・評価された値(関数であれば、関数の実行結果)
を取得したい場合、

[下記の表](#03-取得一覧)から取得できる階層まで潜っていきます。
その際、Fieldをドットで繋げていきます。

・取得できる情報　シートのデータ(sheets)　→　4. Sheet

・4. Sheet　グリッドデータ(data) →　4.10. GridData

・4.10. GridData　行データ(rowData)　→ 4.10.2. RowData

・4.10.2. RowData　セルの値(values)　→ 4.10.3. CellData

・4.10.3. CellData　セルの値(userEnteredValue)、評価された値(effectiveValue)

繋げるとこうなります。
```java
sheets.data.rowData.values(userEnteredValue,effectiveValue)
```
最後のFiled2つは「values」の下にあるので、括弧をつけてカンマで繋げます。
もし、userEnteredValueのみが欲しい場合は、
```java
sheets.data.rowData.values.userEnteredValue
```
と指定します。
また、階層を跨った情報が欲しい場合、
（例えば、シートのデータの交互の背景色とセル結合が欲しい場合）
```java
sheets.bandedRanges,sheets.merges
```
のようにカンマで繋げます。
### 0.3. 取得一覧
リストのo,xは返ってきた結果が配列(List)かどうかを示しています。
リストが空の場合は、結果が数値やBoolean、stringなどの場合を示しています。
|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|スプレットシートID|spreadsheetId||
|スプレットシートのURL|spreadsheetUrl||
|プロパティデータ|properties|[1. SpreadsheetProperties](#1-spreadsheetproperties)|x|
|開発者メタデータ|developerMetadata|[2. DeveloperMetadata](#2-developermetadata)|o|
|名前付き範囲|namedRanges|[3. NamedRange](#3-namedrange)|o|
|シートのデータ|sheets|[4. Sheet](#4-sheet)|o|

## 1. SpreadsheetProperties
スプレットシートのプロパティデータを取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|タイトル|title|||
|タイムゾーン|timeZone|||
|ロケール|locale|||
|計算-再計算|autoRecalc|ON_CHANGE：変更時<br>MINUTE：変更時と毎分<br>HOUR：変更時と毎時||
|計算-反復計算|iterativeCalculationSettings|[1.1. IterativeCalculationSettings](#11-iterativecalculationsettings)|x|
|デフォルトのセル形式|defaultFormat|[6.1. CellFormat](#61-cellformat)|x|
|適用されるテーマ|spreadsheetTheme|[1.2. SpreadsheetTheme](#12-spreadsheettheme)|x|

### 1.1. IterativeCalculationSettings
計算-反復計算で設定できる内容を取得します。

|取得できる情報|Field|
|---|---|
|最大反復回数|maxIterations|
|しきい値|convergenceThreshold|

### 1.2. SpreadsheetTheme
スプレットシートのテーマを取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|プライマリフォントファミリー名|primaryFontFamily|||
|テーマカラー|themeColors|[1.2.1. ThemeColorPair](#121-themecolorpair)|x|

### 1.2.1. ThemeColorPair
スプレットシートのテーマカラーを取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|テーマカラー|color|[6.5. Color](#65-color)|x|
|テーマカラー|colorStyle|[6.6. ColorStyle](#66-colorstyle)|x|

## 2. DeveloperMetadata
開発者メタデータを取得します。
開発者メタデータとはシートやセルに紐付けた開発者用のメモみたいなやつです。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|メタデータの行、列|location|[2.1. DeveloperMetadataLocation](#21-developermetadatalocation)|x|
|メタデータID|metadataId||
|メタデータキー|metadataKey||
|メタデータの値|metadataValue||
|メタデータのアクセス可能者|visibility|DOCUMENT：開発者<br>PROJECT：メタデータ作成者||

## 2.1. DeveloperMetadataLocation
メタデータの行、列の情報を取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|メタデータの行、列の範囲|dimensionRange|[6.2. DimensionRange](#62-dimensionrange)|x|
|メタデータの関連付けされた場所|locationType|SPREADSHEET：スプレッドシート<br>SHEET：シート<br>ROW：行<br>COLUMN：列||
|メタデータがシートに<br>関連付けられている場合のシートID|sheetId|||
|メタデータがスプレッドシートに<br>関連付けられているか？|spreadsheet|||

## 3. NamedRange
名前付き範囲を取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|名前|name||
|名前付き範囲ID|namedRangeId||
|範囲|range|[6.3. GridRange](#63-gridrange)|x|

## 4. Sheet
シートのデータを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|交互の背景色|bandedRanges|[4.1. BandedRange](#41-bandedrange)|o|
|Basicフィルター|basicFilter|[4.2. BasicFilter](#42-basicfilter)|x|
|フィルター|filterViews|[4.3. FilterView](#43-filterview)|o|
|グラフの仕様|charts|[4.4. EmbeddedChart](#44-embeddedchart)|o|
|列グループ|columnGroups|[6.4. DimensionGroup](#64-dimensiongroup)|o|
|行グループ|rowGroups|[6.4. DimensionGroup](#64-dimensiongroup)|o|
|条件付き書式|conditionalFormats|[4.5. ConditionalFormatRule](#45-conditionalformatrule)|o|
|グリッドデータ|data|[4.10. GridData](#410-griddata)|o|
|開発者メタデータ|developerMetadata|[2. DeveloperMetadata](#2-developermetadata)|o|
|セル結合|merges|[6.3. GridRange](#63-gridrange)|o|
|プロパティ|properties|[4.11. SheetProperties](#411-sheetproperties)|x|
|保護範囲|protectedRanges|[4.12. ProtectedRange](#412-protectedrange)|o|
|スライサー|slicers|[4.13. Slicer](#413-slicer)|o|

## 4.1. BandedRange
交互の背景色を取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
交互の背景色のID|bandedRangeId|||
|行のプロパティ	|rowProperties|[4.1.1. BandingProperties](#411-bandingproperties)|x|
|列のプロパティ	|columnProperties|[4.1.1. BandingProperties](#411-bandingproperties)|x|
|範囲|range|[6.3. GridRange](#63-gridrange)|x|

### 4.1.1. BandingProperties
行または列のプロパティを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|最後の色|footerColor|[6.5. Color](#65-color)|x|
|最後の色|footerColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|最初の色|headerColor|[6.5. Color](#65-color)|x|
|最初の色|headerColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|交互に現れる最初の色|firstBandColor|[6.5. Color](#65-color)|x|
|交互に現れる最初の色|firstBandColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|交互に現れる2番目の色|secondBandColor|[6.5. Color](#65-color)|x|
|交互に現れる2番目の色|secondBandColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|

## 4.2. BasicFilter
Basicフィルターを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|並び順の仕様|sortSpecs|[4.6. SortSpec](#46-sortspec)|o|
|フィルタリング仕様|criteria|[4.7. FilterCriteria](#47-filtercriteria)|Map|
|適用範囲|range|[6.3. GridRange](#63-gridrange)|x|

## 4.3. FilterView
フィルターを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|フィルタID|filterViewId|||
|フィルタの基になる名前付き範囲のID|namedRangeId|||
|名前|title|||
|並び順の使用|sortSpecs|[4.6. SortSpec](#46-sortspec)|o|
|フィルタリグ仕様|criteria|[4.7. FilterCriteria](#47-filtercriteria)|Map|
|適用範囲|range|[6.3. GridRange](#63-gridrange)|x|

## 4.4. EmbeddedChart
グラフの仕様を取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|グラフID|chartId|||
|グラフのサイズ、配置位置|position|[4.9. EmbeddedObjectPosition](#49-embeddedobjectposition)|x|
|グラフの仕様|spec|[4.4.1. ChartSpec](#441-chartspec)|x|

## 4.4.1. ChartSpec
グラフの仕様を取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|基本的なチャート|basicChart|[5.1. BasicChartSpec](#51-basicchartspec)|x|
|バブルチャート|bubbleChart|[5.2. BubbleChartSpec](#52-bubblechartspec)|x|
|ローソク足チャート|candlestickChart|[5.3. CandlestickChartSpec](#53-candlestickchartspec)|x|
|ヒストグラムチャート|histogramChart|[5.4. HistogramChartSpec](#54-histogramchartspec)|x|
|組織図|orgChart|[5.5. OrgChartSpec](#55-orgchartspec)|x|
|円グラフ|pieChart|[5.6. PieChartSpec](#56-piechartspec)|x|
|スコアカード チャート|scorecardChart|[5.7. ScorecardChartSpec](#57-scorecardchartspec)|x|
|ツリーマップ チャート|treemapChart|[5.8. TreemapChartSpec](#58-treemapchartspec)|x|
|ウォーターフォールチャート|waterfallChart|[5.9. WaterfallChartSpec](#59-waterfallchartspec)|x|
|タイトル テキスト|title||x|
|タイトルのテキスト形式|titleTextFormat|[6.7. TextFormat](#67-textformat)|x|
|タイトルのテキストの<br>水平方向の配置位置|titleTextPosition|[6.9. TextPosition](#69-textposition)|x|
|サブタイトル テキスト|subtitle	
|サブタイトルのテキスト形式|subtitleTextFormat|[6.7. TextFormat](#67-textformat)|x|
|サブタイトルのテキストの<br>水平方向の配置位置|subtitleTextPosition|[6.8. TextPosition](#68-textposition)|x|
|説明文|altText||
|グラフ全体の背景色|backgroundColor|[6.5. Color](#65-color)|x|
|グラフ全体の背景色|backgroundColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|デフォルトで使用するフォントの名前|fontName|||
|非表示の行、列の表示方法|hiddenDimensionStrategy|SKIP_HIDDEN_ROWS_AND_COLUMNS：非表示の行と列は使用しない<br>SKIP_HIDDEN_ROWS：非表示の行だけを使用しない<br>SKIP_HIDDEN_COLUMNS：非表示の列だけを使用しない<br>SHOW_ALL：どちらも使用する||
|最大化しているか？|maximized||

## 4.5. ConditionalFormatRule
条件付き書式を取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|ルールの条件|booleanRule|[4.5.1. BooleanRule](#451-booleanrule)|x|
|書式設定のルール|gradientRule|[4.5.2. GradientRule](#452-bradientrule)|x|
|範囲|ranges|[6.3. GridRange](#63-gridrange)|o|

## 4.5.1. BooleanRule
入力規則のルールを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|入力規則|condition|[4.8. BooleanCondition](#48-booleancondition)|x|
|テキスト形式|format|[6.7. TextFormat](#67-textformat)|x|

## 4.5.2. GradientRule
書式設定のルールを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|補間終了点|maxpoint|[4.5.3. InterpolationPoint](#453-interpolationpoint)|x|
|中間補間点|midpoint|[4.5.3. InterpolationPoint](#453-interpolationpoint)|x|
|補間開始点|minpoint|[4.5.3. InterpolationPoint](#453-interpolationpoint)|x|

## 4.5.3. InterpolationPoint
補間ポイントの仕様を取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|補間ポイントが使用する色|color|[6.5. Color](#65-color)|x|
|補間ポイントが使用する色|colorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|補間点が使用する値|value|||
|補間点のチェックタイプ|type|MIN：最小値（最小点）<br>MAX：最大値（最大点）<br>NUMBER：値（最小点,中央,最大点）<br>PERCENT：パーセント（最小点,中央,最大点）<br>PERCENTILE：パーセンタイル（最小点,中央,最大点）||

## 4.6. SortSpec
並び順の仕様を取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|並び順|sortOrder|ASCENDING：昇順<br>DESCENDING：降順||
|前景色|foregroundColor|[6.5. Color](#65-color)|x|
|前景色|foregroundColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|背景色|backgroundColor|[6.5. Color](#65-color)|x|
|背景色|backgroundColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|インデックス|dimensionIndex|||

## 4.7. FilterCriteria
フィルタリングの仕様を取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|入力規則|condition|[4.8. BooleanCondition](#48-booleancondition)|x|
|フィルタリングする前景色|visibleForegroundColor|[6.5. Color](#65-color)|x|
|フィルタリングする前景色|visibleForegroundColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|フィルタリングする背景色|visibleBackgroundColor|[6.5. Color](#65-color)|x|
|フィルタリングする背景色|visibleBackgroundColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|非表示にする値リスト|hiddenValues|String|o|

## 4.8. BooleanCondition
入力規則を取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|入力規則の内容|values|[4.8.1. ConditionValue](#481-conditionvalue)|o|
|入力規則の種類|type|NUMBER_GREATER：条件の値より大きい<br>NUMBER_GREATER_THAN_EQ：条件の値以上<br>NUMBER_LESS：条件の値より小さい<br>NUMBER_LESS_THAN_EQ：条件の値以下<br>NUMBER_EQ：条件の値と等しい<br>NUMBER_NOT_EQ：条件の値と等しい<br>NUMBER_BETWEEN：2つの条件値の間<br>NUMBER_NOT_BETWEEN：2つの条件値の間ではない<br>TEXT_CONTAINS：条件の値が含まれている<br>TEXT_NOT_CONTAINS：条件の値を含まない<br>TEXT_STARTS_WITH：条件の値で始まる<br>TEXT_ENDS_WITH：条件の値で終わる<br>TEXT_EQ：条件の値と正確に一致する<br>TEXT_IS_EMAIL：有効な電子メールアドレス<br>TEXT_IS_URL：有効な URL である<br>DATE_EQ：条件の値と同じ日付である<br>DATE_BEFORE：条件の値の日付より前<br>DATE_AFTER：条件の値の日付より後<br>DATE_ON_OR_BEFORE：条件の値の日付以前<br>DATE_ON_OR_AFTER：条件の値の日付以降<br>DATE_BETWEEN：2つの条件値の日付の間<br>DATE_NOT_BETWEEN：2つの条件値の日付の範囲外<br>DATE_IS_VALID：日付<br>ONE_OF_RANGE：条件値の範囲内のグリッドにリストされている<br>ONE_OF_LIST：条件値のリストに含まれている<br>BLANK：空<br>NOT_BLANK：空ではない<br>CUSTOM_FORMULA：条件の式は true と評価される<br>BOOLEAN：TRUE/FALSEか、条件値のリストに含まれている<br>TEXT_NOT_EQ：条件の値とまったく同じではない<br>DATE_NOT_EQ：条件の値とまったく同じであってはない<br>FILTER_EXPRESSION：指定されたパターンに従う|x|

## 4.8.1. ConditionValue
入力規則の内容を取得します。

|取得できる情報|Field|定数値(文字列)|
|---|---|---|
|相対日付|relativeDate||
|入力規則の基礎となる値|userEnteredValue|TODAY：本日<br>TOMORROW：明日<br>YESTERDAY：昨日<br>PAST_WEEK：過去1週間以内<br>PAST_MONTH：過去1ヶ月以内<br>PAST_YEAR：過去1年以内|

## 4.9. EmbeddedObjectPosition
グラフのサイズ、配置位置を取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|配置しているシートID|sheetId|||	
|配置位値|overlayPosition|[4.9.1. OverlayPosition](#491-overlayposition)|x|

## 4.9.1. OverlayPosition
配置位値を取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|起点となるセルの位置|anchorCell|[4.9.2. GridCoordinate](#492-gridcoordinate)|x|
|X座標|offgetXPixels||
|Y座標|offgetYPixels||
|幅|heightPixels||
|高さ|widthPixels||

## 4.9.2. GridCoordinate
セルの位置(インデックス)を取得します。

|取得できる情報|Field|
|---|---|
|シートID|sheetId|
|行インデックス|rowIndex|
|列インデックス	|columnIndex|

## 4.10. GridData
グリッドデータを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|列メタデータ|columnMetadata|[4.10.1. DimensionProperties](#4101-dimensionproperties)|o|
|行データ|rowData|[4.10.2. RowData](#4102-rowdata)|o|
|行メタデータ|rowMetadata|[4.10.1. DimensionProperties](#4101-dimensionproperties)|o|
|開始列|startColumn|||
|開始行|startRow||

## 4.10.1. DimensionProperties
行または列のプロパティを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|開発者メタデータ|developerMetadata|[2. DeveloperMetadata](#2-developermetadata)|o|
|フィルタリングされているか？|hiddenByFilter|||
|非表示か？|hiddenByUser|||
|高さ または 幅|pixelSize|||

## 4.10.2. RowData
行単位のデータを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|セルの値|values|[4.10.3. CellData](#4103-celldata)|o|

## 4.10.3. CellData
セルのデータを取得します。

セル内の値は下記３つで表現されます。
userEnteredValue：ユーザーが入力した値
effectiveValue：評価された値(関数の実行結果)
formattedValue：整形された値

整形された値とは、
例えば「1000」が書式フォーマットにより「¥1,000」と表示されている場合、
"¥1,000"という文字列が取得できます。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|データ検証ルール|dataValidation|[4.10.4. DataValidationRule](#4104-datavalidationrule)|x|
|ハイパーリンク|hyperlink|||
|メモ|note|||
|ピボットテーブルの情報|pivotTable|[4.10.5. PivotTable](#4105-pivottable)|x|
|リッチテキストの情報|textFormatRuns|[4.10.6. TextFormatRun](#4106-textformatrun)|o|
|セルの書式|userEnteredFormat|[6.1. CellFormat](#61-cellformat)|x|
|設定が適用されたセルの書式|effectiveFormat|[6.1. CellFormat](#61-cellformat)|x|
|セルの値|userEnteredValue|[6.9. ExtendedValue](#69-extendedvalue)|x|
|評価された値|effectiveValue|[6.9. ExtendedValue](#69-extendedvalue)|x|
|整形された値|formattedValue|||

## 4.10.4. DataValidationRule
データ検証ルールを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|入力規則|condition|[4.8. BooleanCondition](#48-booleancondition)|x|
|データ追加時のメッセージ|inputMessage|||
|カスタマイズUIを表示するか？|showCustomUi|||
|データが無効な場合は入力拒否するか？|strict|||

## 4.10.5. PivotTable
ピボットテーブルの情報を取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|各列のグループ情報|columns|[4.10.5.1. PivotGroup](#41051-pivotgroup)|o|
|各列のグループ情報|rows|[4.10.5.1. PivotGroup](#41051-pivotgroup)|o|
|各列のフィルターオプション|criteria|[4.10.5.10. PivotFilterCriteria](#410510-pivotfiltercriteria)|Map|
|データ範囲|source|[6.3. GridRange](#63-gridrange)|x|
|値をリスト化するか？|valueLayout|||
|値のリスト|values|[4.10.5.11. PivotValue](#410511-pivotvalue)|o|

### 4.10.5.1. PivotGroup
ピボットのグループ情報を取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|行/列グループに適用するグループ ルール|groupRule|[4.10.5.2. PivotGroupRule](#41052-pivotgrouprule)|x|
|カスタマイズ可能な行/列グループに使用するラベル|label|||
|グループの見出しを繰り返す必要があるか？|repeatHeadings|||
|グループの合計を含める必要があるか？|showTotals|||
|グループ内の値を並べ替える順序|sortOrder|ASCENDING：昇順<br>DESCENDING：降順||
|グループ化の基になるソース範囲の列オフセット|sourceColumnOffset|||
|並べ替えの基準となる反対側のピボット グループのバケット|valueBucket|[4.10.5.3. PivotGroupSortValueBucket](#41053-pivotgroupsortvaluebucket)|x|
|グループ化内の値に関するメタデータ|valueMetadata|[4.10.5.4. PivotGroupValueMetadata](#41054-pivotgroupvalueMmetadata)|o|

## 4.10.5.2. PivotGroupRule
行/列グループに適用するグループ ルールを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|DateTimeルール|dateTimeRule|[4.10.5.6. DateTimeRule](#41056-datetimerule)|x|
|ヒストグラムルール|histogramRule|[4.10.5.7. HistogramRule](#41057-histogramrule)|x|
|マニュアルルール|manualRule|[4.10.5.8. ManualRule](#41058-manualrule)|x|

## 4.10.5.3. PivotGroupSortValueBucket
並べ替えの基準となる反対側のピボット グループのバケットを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|値をソートするために選択するバケット|buckets|[6.9. ExtendedValue](#69-extendedvalue)|o|
|グループ内の値の並べ替えに使用する値のオフセット値|valuesIndex|||

## 4.10.5.4. PivotGroupValueMetadata
グループ化内の値に関するメタデータを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|値に対応するデータが折りたたまれている場合か？|collapsed|||
|メタデータが対応する計算値|value|[6.9. ExtendedValue](#69-extendedvalue)|x|

## 4.10.5.6. DateTimeRule
DateTimeルールを取得します。

|取得できる情報|Field|定数値(文字列)|
|---|---|---|
|グループ化のタイプ|type|SECOND：日付を0〜59までの秒単位<br>MINUTE：日付を0〜59までの分ごと<br>HOUR：24時間制を使用し0〜23までの時間ごとに日付<br>HOUR_MINUTE：24時間制を使用し日付を時間と分<br>HOUR_MINUTE_AMPM：12時間制を使用し日付を時間と分<br>DAY_OF_WEEK：日付を曜日ごと<br>DAY_OF_YEAR：日付を1〜366 までの日付ごと<br>DAY_OF_MONTH：日付を1〜31 までの日付ごと<br>DAY_MONTH：日付を日と月ごと<br>MONTH：日付を月ごと<br>QUARTER：日付を四半期ごと<br>YEAR：日付を年ごと<br>YEAR_MONTH：日付を年と月ごと<br>YEAR_QUARTER：日付を年と四半期ごと<br>YEAR_MONTH_DAY：日付を年、月、日ごと|

## 4.10.5.7. HistogramRule
ヒストグラムルールを取得します。

|取得できる情報|Field|
|---|---|
|アイテムを一定サイズのバケットに入れる最大値|end|
|作成されるバケットのサイズ|interval|
|アイテムを一定サイズのバケットに入れる最小値|start|

## 4.10.5.8. ManualRule
マニュアルルールを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|グループ名と、各グループ名にマップされるソース データの対応する項目のリスト|groups|[4.10.5.9. ManualRuleGroup](#41059-manualrulegroup)|o|

## 4.10.5.9. ManualRuleGroup
マニュアルルールを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|グループ名|groupName|[6.9. ExtendedValue](#69-extendedvalue)|x|
|このグループに配置する必要があるソース データ内の項目|items|[6.9. ExtendedValue](#69-extendedvalue)|o|

## 4.10.5.10. PivotFilterCriteria
ピボットのフィルターオプションを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|含める必要なある値|visibleValues|string|o|

## 4.10.5.11. PivotValue
ピボットテーブルの値を取得します。

|取得できる情報|Field|定数値(文字列)|
|---|---|---|
|計算結果の表示方法|calculatedDisplayType|PERCENT_OF_ROW_TOTAL：ピボット値を行の合計値の%として表示<br>PERCENT_OF_COLUMN_TOTAL：ピボット値を列の合計値の%として表示<br>PERCENT_OF_GRAND_TOTAL：ピボット値を総計値の%として表示|
|値を計算するためのカスタム式|formula|
|値に使用する名前|name|
|値の読み取り元となるソース範囲の列オフセット|sourceColumnOffset|
|値を集計する関数|summarizeFunction|SUM、COUNTA、COUNT、COUNTUNIQUE、AVERAGE、MAX、MIN、MEDIAN、PRODUCT、STDEV、STDEVP、VAR、VARP、CUSTOM|

## 4.10.6. TextFormatRun
リッチテキストの情報を取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|テキストの形式|format|[6.7. TextFormat](#67-textformat)|x|
|適用する文字列インデックス|startIndex|||

## 4.11. SheetProperties
プロパティを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|シートID|sheetId|||
|シート名|title|||
|シートインデックス(並び順)|index|||
|グリッドプロパティ|gridProperties|[4.11.1. GridProperties](#4111-gridproperties)|x|
|非表示か？|hidden|||
|テキストの方向|rightToLeft|||
|シートの種類|sheetType|GRID：GRID<br>OBJECT：オブジェクト(画像やグラフなど)<br>DATA_SOURCE：データソース||
|タブの色|color|[6.5. Color](#65-color)|x|
|タブの色|colorStyle|[6.6. ColorStyle](#66-colorstyle)|x|

## 4.11.1. GridProperties
グリッドプロパティを取得します。

|取得できる情報|Field|
|---|---|
|列の数|columnCount|
|列グループ化コントロールの切り替えがグループの後に表示されるか？|columnGroupControlAfter|
|行の数|rowCount|
|行グループ化コントロールの切り替えがグループの後に表示されるか？|rowGroupControlAfter|
|固定されている列の数|frozenColumnCount|
|固定されている行の数|frozenRowCount|
|UI にグリッド線を表示しないか？|hideGridlines|

## 4.12. ProtectedRange
保護範囲を取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|説明|description|||
|アクセス権|editors|[4.12.1. Editors](#4121-editors)|x|
|名前付き範囲ID|namedRangeId|||
|保護範囲ID|protectedRangeId|||
|範囲|range|[6.3. GridRange](#63-gridrange)|x|
|リクエストしたユーザーが<br>保護範囲を編集できるか？|requestingUserCanEdit|||
|保護されていない範囲|unprotectedRanges|[6.3. GridRange](#63-gridrange)|o|
|警告を表示するか？|warningOnly|||

## 4.12.1. Editors
アクセス権を取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|ドメイン内でアクセス権を持っているか？|domainUsersCanEdit|||
|グループ単位アクセス権のメルアド|groups|string|o|
|ユーザー単位アクセス権のメルアド|users|string|o|

## 4.13. Slicer
スライサーを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|位置|position|[4.9. EmbeddedObjectPosition](#49-embeddedobjectposition)|x|
|スライサーID|slicerId|||
|スライサーの仕様|spec|[4.13.1. SlicerSpec](#4131-slicerspec)|x|

### 4.13.1. SlicerSpec
スライサーの仕様を取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|フィルターをピボット テーブルに適用するか？|applyToPivotTables|||
|スライサーの背景色|backgroundColor|[6.5. Color](#65-color)|x|
|スライサーの背景色|backgroundColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|適用する列インデックス|columnIndex|||
|データ範囲|dataRange|[6.3. GridRange](#63-gridrange)|x|
|フィルタリング基準|filterCriteria|[4.7. FilterCriteria](#47-filtercriteria)
|水平方向の配置|horizontalAlignment|LEFT：左揃<br>CENTER：中央揃え<br>RIGHT：右揃え||
|テキスト形式|format|[6.7. TextFormat](#67-textformat)|x|
|スタイサーのタイトル|title|||

## 5. グラフのデータ
## 5.1. BasicChartSpec
基本的なチャートの情報を取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|チャート上の軸|axis|[5.1.1. BasicChartAxis](#511-basicchartaxis)|o|
|チャートのタイプ|chartType|BAR：棒グラフ<br>LINE：折れ線グラフ<br>AREA：面グラフ<br>COLUMN：縦 棒グラフ<br>SCATTER：散布図<br>COMBO：コンボチャート<br>STEPPED_AREA：階段状の面グラフ||
|ツールヒントの動作|compareMode|DATUM：フォーカスされたデータ要素のみが強調表示され、ツールチップに表示されます<br>CATEGORY：同じカテゴリ (ドメイン値など) を持つすべてのデータ要素が強調表示され、ツールチップに表示されます|
|データのドメイン|domains|[5.1.2. BasicChartDomain](#512-basicchartdomain)|o|
|ヘッダーの行、列の数|headerCount|||
|系列内の一部の値が欠落によるグラフのギャップの表示解消するか？|interpolateNulls|||
|凡例の表示位置|legendPosition|BOTTOM_LEGEND：グラフの下部に表示<br>LEFT_LEGEND：グラフの左側に表示<br>RIGHT_LEGEND：グラフの右側に表示<br>TOP_LEGEND：グラフの上部に表示<br>NO_LEGEND：表示しない||
|デフォルトですべての線を直線でレンダリングするか？|lineSmoothing|||
|グラフが視覚化しているデータ|series|[5.1.3. BasicChartSeries](#513-basicchartseries)|o|
|垂直方向のチャートの積み上げタイプ|stackedType|NOT_STACKED：積み重ねられない<br>STACKED：系列値は積み重ねられ、各値はその下の値の上から垂直方向にレンダリング<br>PERCENT_STACKED：垂直スタックはグラフの上部に達するまで引き伸ばされ、値が互いのパーセンテージとしてレイアウト||
|グラフを3Dにするか？|threeDimensional|||

## 5.1.1. BasicChartAxis
チャート上の軸を取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|タイトルの形式|format|[6.7. TextFormat](#67-textformat)|x|
|軸の位置|position|BOTTOM_AXIS：グラフの下部に表示される軸<br>LEFT_AXIS：チャートの左側に表示される軸<br>RIGHT_AXIS：チャートの右側に表示される軸||
|軸のタイトル|title|||
|軸のタイトルのテキスト位置|titleTextPosition|[6.8. TextPosition](#68-textposition)|x|
|軸のビュー ウィンドウ オプション|viewWindowOptions|[5.1.1.1. ChartAxisViewWindowOptions](#5111-chartaxisviewwindowoptions)|x|

## 5.1.1.1. ChartAxisViewWindowOptions
軸のビュー ウィンドウ オプションを取得します。

|取得できる情報|Field|定数値(文字列)|
|---|---|---|
|ウィンドウに表示される最大数値|viewWindowMax||
|ウィンドウに表示される最小の数値|viewWindowMin||
|モード|viewWindowMode|DEFAULT_VIEW_WINDOW_MODE：このグラフ タイプのシート エディターで使用されるデフォルトのビュー ウィンドウ モード<br>EXPLICIT：最小値と最大値に正確に従う<br>PRETTY：グラフの見栄えを良くする最小値と最大値を選択する||

## 5.1.2. BasicChartDomain
データのドメインを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|ドメインのデータ|domain|[6.15. ChartData](#615-chartdata)|x|
|ドメイン値 (横軸)の順序を逆にするか？|reversed|||

## 5.1.3. BasicChartSeries
グラフが視覚化しているデータを取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|関連付けられた要素 (棒、線、点など) の色|color|[6.5. Color](#65-color)|x|
|関連付けられた要素 (棒、線、点など) の色|colorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|線のスタイル|lineStyle|[6.16. LineStyle](#616-linestyle)|x|
|視覚化されているデータ|series|[6.15. ChartData](#615-chartdata)|x|
|この系列の値の範囲を指定する短軸|targetAxis|BOTTOM_AXIS：グラフの下部に表示される軸<br>LEFT_AXIS：チャートの左側に表示される軸<br>RIGHT_AXIS：チャートの右側に表示される軸||
|タイプ|type|LINE：折れ線グラフ<br>AREA：面グラフ<br>COLUMN：縦 棒グラフ||

## 5.2. BubbleChartSpec
バブルチャートの情報を取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|チャートの凡例を描画する場所|legendPosition|BOTTOM_LEGEND：グラフの下部に表示<br>LEFT_LEGEND：グラフの左側に表示<br>RIGHT_LEGEND：グラフの右側に表示<br>TOP_LEGEND：グラフの上部に表示<br>NO_LEGEND：表示しない||
|バブルの境界線の色|bubbleBorderColor|[6.5. Color](#65-color)|x|
|バブルの境界線の色|bubbleBorderColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|バブルラベルを含むデータ|bubbleLabels|[6.15. ChartData](#615-chartdata)|x|
|バブルの最大半径サイズ|bubbleMaxRadiusSize|||
|バブルの最小半径サイズ|bubbleMinRadiusSize|||
|不透明度|bubbleOpacity|||
|バブル内のテキストの形式|bubbleTextStyle|[6.7. TextFormat](#67-textformat)|x|
|バブルのX値を含むデータ|domain|[6.15. ChartData](#615-chartdata)|x|
|バブルのY値を含むデータ|series|[6.15. ChartData](#615-chartdata)|x|
|バブルのサイズを含むデータ|bubbleSizes|[6.15. ChartData](#615-chartdata)|x|
|バブル グループ ID を含むデータ|groupIds|[6.15. ChartData](#615-chartdata)|x|

## 5.3. CandlestickChartSpec
ローソク足チャートの情報を取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|ローソク足チャートのデータ|data|[5.3.1. CandlestickData](#531-candlesticddata)|o|
|ローソク足チャートのドメインデータ (横軸)|domain|[5.3.2. CandlestickDomain](#532-candlestickdomain)|x|

### 5.3.1. CandlestickData
ローソク足チャートのデータを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|各ローソク足の終値/最終値の範囲データ (縦軸)|closeSeries|[5.3.3. CandlestickSeries](#533-candlestickseries)|x|
|各ローソク足の始値/初期値の範囲データ (縦軸)|openSeries|[5.3.3. CandlestickSeries](#533-candlestickseries)|x|
|各ローソク足の高値/最大値の範囲データ (縦軸)|highSeries|[5.3.3. CandlestickSeries](#533-candlestickseries)|x|
|各ローソク足の最低値/最低値の範囲データ (縦軸)|lowSeries|[5.3.3. CandlestickSeries](#533-candlestickseries)|x|

### 5.3.2. CandlestickDomain
ローソク足チャートのドメインデータ (横軸)を取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|データ|data|[6.15. ChartData](#615-chartdata)|x|
|ドメイン値 (横軸)の順序を逆にするか？|reversed|||

# 5.3.3. CandlestickSeries
ローソク足のデータを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|ローソク足のデータ|data|[6.15. ChartData](#615-chartdata)|x|

## 5.4. HistogramChartSpec
ヒストグラムチャートの情報を取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|バケットサイズ|bucketSize|||
|チャートの凡例の位置|legendPosition|BOTTOM_LEGEND：グラフの下部に表示<br>LEFT_LEGEND：グラフの左側に表示<br>RIGHT_LEGEND：グラフの右側に表示<br>TOP_LEGEND：グラフの上部に表示<br>NO_LEGEND：表示しない||
|外れ値パーセンタイル|outlierPercentile|||
|ヒストグラム シリーズのデータ|series|[5.4.1. HistogramSeries](#541-histogramseries)|o|
|各列の項目間に水平の区切り線を表示するか？|showItemDividers|||

## 5.4.1. HistogramSeries
ヒストグラム シリーズのデータを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|各バケット内のこのシリーズを表す列の色|barColor|[6.5. Color](#65-color)|x|
|各バケット内のこのシリーズを表す列の色|barColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|データ​​|data|[6.15. ChartData](#615-chartdata)|x|

## 5.5. OrgChartSpec
組織図の情報を取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|チャート内のすべてのノードのラベルを含むデータ|labels|[6.15. ChartData](#615-chartdata)|x|
|組織図のノードの色|nodeColor|[6.5. Color](#65-color)|x|
|組織図のノードの色|nodeColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|選択した組織図ノードの色|selectedNodeColor|[6.5. Color](#65-color)|x|
|選択した組織図ノードの色|selectedNodeColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|組織図のノードのサイズ|nodeSize|SMALL：小さい組織図のノード サイズ<br>MEDIUM：中程度の組織図のノード サイズ<br>LARGE：組織図のノード サイズが大きい||
|対応するノードの親のラベルを含むデータ|parentLabels|[6.15. ChartData](#615-chartdata)|x|
|対応するノードのツールチップを含むデータ|tooltips|[6.15. ChartData](#615-chartdata)|x|

## 5.6. PieChartSpec
円グラフの情報を取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|円グラフの領域をカバーするデータ|domain|[6.15. ChartData](#615-chartdata)|x|
|円グラフの唯一のシリーズを網羅したデータ|series|[6.15. ChartData](#615-chartdata)|x|
|凡例の表示する位置|legendPosition|BOTTOM_LEGEND：グラフの下部に表示<br>LEFT_LEGEND：グラフの左側に表示<br>RIGHT_LEGEND：グラフの右側に表示<br>TOP_LEGEND：グラフの上部に表示<br>NO_LEGEND：表示しない<br>LABELED_LEGEND：各パイのスライスにはラベルが付いている||
|円グラフの穴のサイズ|pieHole|||
|円が3次元か？|threeDimensional|||

## 5.7. ScorecardChartSpec
スコアカード チャートの情報を取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|データの集計タイプ|aggregateType|AVERAGE：平均集計関数<br>COUNT：カウント集計関数<br>MAX：最大の集計関数<br>MEDIAN：中央値集計関数<br>MIN：最小の集計関数<br>SUM：合計集計関数||
|スコアカード キーとベースライン値をスケールする値|scaleFactor||
|スコアカードのベースライン値のデータ|baselineValueData|[6.15. ChartData](#615-chartdata)|x|
|ベースライン値の書式設定オプション|baselineValueFormat|[5.7.1. BaselineValueFormat](#571-baselinevalueformat)|x|
|キー値の書式設定オプション|keyValueFormat|[5.7.2. KeyValueFormat](#572-keyvalueformat)|x|
|スコアカードのキー値のデータ|keyValueData|[6.15. ChartData](#615-chartdata)|x|
|スコアカード グラフで使用される数値形式のソース|numberFormatSource|FROM_DATA：データから数値の書式設定を継承<br>CUSTOM：カスタム書式設定を適用||
|スコアカード グラフの数値キー/ベースライン値のカスタム書式設定オプション|customFormatOptions|[5.7.3. ChartCustomNumberFormatOptions](#573-chartcustomnumberformatOoptions)|x|

## 5.7.1. BaselineValueFormat
ベースライン値の書式設定オプションを取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|キー値とベースライン値の比較タイプ|comparisonType|ABSOLUTE_DIFFERENCE：キーとベースライン値の間の絶対差を使用<br>PERCENTAGE_DIFFERENCE：キーとベースライン値の間のパーセンテージの差を使用||
|ベースライン値の後に追加される説明|description|||
|ベースライン値がキー値の負の変化を表す場合に使用される色|negativeColor|[6.5. Color](#65-color)|x|
|ベースライン値がキー値の負の変化を表す場合に使用される色|negativeColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|ベースライン値の水平方向のテキストの位置|position|[6.8. TextPosition](#68-textposition)|x|
|ベースライン値がキー値の正の変化を表す場合に使用される色|positiveColor|[6.5. Color](#65-color)|x|
|ベースライン値がキー値の正の変化を表す場合に使用される色|positiveColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|ベースライン値のテキスト書式設定オプション|textFormat|[6.7. TextFormat](#67-textformat)|x|

## 5.7.2. KeyValueFormat
キー値の書式設定オプションを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|キー値の水平方向のテキストの位置|position|[6.8. TextPosition](#68-textposition)|x|
|キー値のテキスト書式設定オプション|textFormat|[6.7. TextFormat](#67-textformat)|x|

## 5.7.3. ChartCustomNumberFormatOptions
カスタム書式設定オプションを取得します。

|取得できる情報|Field|
|---|---|
|チャート属性の先頭に追加されるカスタム接頭辞|prefix|
|チャート属性に追加されるカスタム接尾辞|suffix|

## 5.8. TreemapChartSpec
ツリーマップ チャートの情報を取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|各ツリーマップ データ セルの背景色を決定するデータ|colorData|[6.15. ChartData](#615-chartdata)|x|
|ツリーマップ チャートのデータ セルのカラー スケール|colorScale|[5.8.1. TreemapChartColorScale](#581-treemapchartcolorscale)|x|
|ヘッダーセルの背景色|headerColor|[6.5. Color](#65-color)|x|
|ヘッダーセルの背景色|headerColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|ツールチップを非表示か？|hideTooltips|||
|ラベル付きレベルを超える追加のデータレベルの数|hintedLevels|||
|ツリーマップのセルのラベルを含むデータ|labels|[6.15. ChartData](#615-chartdata)|x|
|チャートに表示するデータ レベルの数|levels|||
|可能な最大データ値|maxValue|||
|可能な最小のデータ値|minValue|||
|ツリーマップ セルの親ラベル|parentLabels|[6.15. ChartData](#615-chartdata)|x|
|各ツリーマップ データ セルのサイズを決定するデータ|sizeData|[6.15. ChartData](#615-chartdata)|x|
|チャート上のすべてのラベルのテキスト形式|textFormat|[6.7. TextFormat](#67-textformat)|x|

## 5.8.1. TreemapChartColorScale
グラフのカラースケール情報を取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|maxValue 以上の色の値を持つセルの背景色|maxValueColor|[6.5. Color](#65-color)|x|
|maxValue 以上の色の値を持つセルの背景色|maxValueColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|minValue と maxValue の間の中間の色の値を持つセルの背景色|midValueColor|[6.5. Color](#65-color)|x|
|minValue と maxValue の間の中間の色の値を持つセルの背景色|midValueColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|minValue 以下の色の値を持つセルの背景色|minValueColor|[6.5. Color](#65-color)|x|
|minValue 以下の色の値を持つセルの背景色|minValueColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|色データが関連付けられていないセルの背景色|noDataColor|[6.5. Color](#65-color)|x|
|色データが関連付けられていないセルの背景色|noDataColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|

## 5.9. WaterfallChartSpec
ウォーターフォールチャートの情報を取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|積み上げ方法|stackedType|STACKED：同じドメイン (横軸) の値に対応する値が縦に積み上げ<br>SEQUENTIAL：シリーズは横軸に沿って広がる||
|列間の接続線を表示するか？|hideConnectorLines|||
|最初の値を合計とするか？|firstValueIsTotal|||
|コネクタ線のスタイル|connectorLineStyle|[6.16. LineStyle](#616-linestyle)|x|
|ウォーターフォール チャートのドメイン データ (横軸)|domain|[5.9.1. WaterfallChartDomain](#591-waterfallchartdomain)|x|
|ウォーターフォール チャートが視覚化しているデータ|series|[5.9.2. WaterfallChartSeries](#592-waterfallchartseries)|o|

## 5.9.1. WaterfallChartDomain
ウォーターフォール チャートのドメイン データを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|グラフデータ|data|[6.15. ChartData](#615-chartdata)|x|
|縦ラベルの順序を逆にする|reversed|||

## 5.9.2. WaterfallChartSeries
ウォーターフォール チャートが視覚化しているデータを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|カスタム小計列|customSubtotals|[5.9.2.1. WaterfallChartCustomSubtotal](#5921-waterfallchartcustomsubtotal)|o|
|視覚化されるデータ|data|[6.15. ChartData](#615-chartdata)|x|
|シリーズの最後から小計列を非表示にするか？|hideTrailingSubtotal|||
|負の値を含むこの系列のすべての列のスタイル|negativeColumnsStyle|[5.9.2.2. WaterfallChartColumnStyle](#5922-waterfallchartcolumnstyle)|x|
|すべての列の正の値のスタイル|positiveColumnsStyle|[5.9.2.2. WaterfallChartColumnStyle](#5922-waterfallchartcolumnstyle)|x|
|すべての小計列のスタイル|subtotalColumnsStyle|[5.9.2.2. WaterfallChartColumnStyle](#5922-waterfallchartcolumnstyle)|x|

## 5.9.2.1. WaterfallChartCustomSubtotal
カスタム小計列を取得します。

|取得できる情報|Field|
|---|---|
|シリーズ内のデータ インデックス|subtotalIndex|
|setSubtotalIndexが小計か？|dataIsSubtotal|
|小計列のラベル|label|

## 5.9.2.2. WaterfallChartColumnStyle
ウォーターフォールチャートのスタイルを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|列の色|color|[6.5. Color](#65-color)|x|
|列の色|colorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|列の凡例のラベル|label|||

## 6. 共通
いろいろなところで使用されているクラスをまとめています。

## 6.1. CellFormat
セルのフォーマットを取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|背景色|backgroundColor|[6.5. Color](#65-color)|x|
|背景色|backgroundColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|境界線|borders|[6.10. Borders](#610-borders)|x|
|水平方向の配置|horizontalAlignment|LEFT：左揃<br>CENTER：中央揃え<br>RIGHT：右揃え||
|ハイパーリンクの表示タイプ|hyperlinkDisplayType|LINKE：表示する<br>PLAIN_TEXT：表示しない||
|数字の書式|numberFormat|[6.11. NumberFormat](#611-numberformat)|x|
|余白|padding|[6.12. Padding](#612-padding)|x|
|テキストの方向|textDirection|LEFT_TO_RIGHT：左から右<br>RIGHT_TO_LEFT：右から左||
|テキストの書式|textFormat|[6.7. TextFormat](#67-textformat)|x|
|テキストの回転|textRotation|[6.13. TextRotation](#613-textrotation)|x|
|垂直方向の配置|verticalAlignment|TOP：上部<br>MIDDLE：中央<br>BOTTOM：下部||
|セル内のテキスト折り返し方法|wrapStrategy|OVERFLOW_CELL：折り返さない<br>CLIP：セル範囲内のみ表示<br>WRAP：文字レベルで折り返し||

## 6.2. DimensionRange
範囲を取得します。

|取得できる情報|Field|定数値(文字列)|
|---|---|---|
|行か列の指定|dimension|ROWS：行<br>COLUMNS：列|
|シートID|sheetId||
|開始インデックス|startIndex||
|終了インデックス|endIndex||

## 6.3. GridRange
グリッド範囲を取得します。

|取得できる情報|Field|
|---|---|
|シートID|sheetId|
|開始列インデックス|startColumnIndex|
|終了列インデックス|endColumnIndex|
|開始行インデックス|startRowIndex|
|終了行インデックス|endRowIndex|

## 6.4. DimensionGroup
範囲グループを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|折りたたまれているか？|collapsed|
|グループの深さ|depth|
|範囲|range|[6.2. DimensionRange](#62-dimensionrange)|x|

## 6.5. Color
色情報を取得します。
0.0〜1.0で取得できます。

|取得できる情報|Field|
|---|---|
|赤色|red|
|緑色|green|
|青色|blue|
|透過値|alpha|

## 6.6. ColorStyle
色情報、テーマカラーを取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|RGBA|rgbColor|[6.5. Color](#65-color)|x|
|テーマカラー|themeColor|TEXT,BACKGROUND,ACCENT1,ACCENT2,ACCENT3,ACCENT4,ACCENT5,ACCENT6,LINK||

## 6.7. TextFormat
テキストの形式が取得できます。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|太字か？|bold||
|斜体か？|italic||
|フォントファミリー名|fontFamily||
|フォントサイズ|fontSize||
|取り消し線か？|strikethrough||
|下線か？|underline||
|文字色|foregroundColor|[6.5. Color](#65-color)|x|
|文字色|foregroundColorStyle|[6.6. ColorStyle](#66-colorstyle)|x|

## 6.8. TextPosition
テキストの水平方向位置を取得できます。

|取得できる情報|Field|定数値(文字列)|
|---|---|---|
|水平方向位置|horizontalAlignment|LEFT：左揃<br>CENTER：中央揃え<br>RIGHT：右揃え|

## 6.9. ExtendedValue
セルの値を取得できます。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|真偽値|boolValue|||
|関数|formulaValue||
|数値|numberValue||
|文字列|stringValue||
|エラー情報|errorValue|[6.14. ErrorValue](#614-errorvalue)|x|

## 6.10. Borders
セル枠線の情報を取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|セル上部|top|[6.10.1. Border](#6101-border)|x|
|セル下部|bottom|[6.10.1. Border](#6101-border)|x|
|セル左部|left|[6.10.1. Border](#6101-border)|x|
|セル右部|right|[6.10.1. Border](#6101-border)|x|

## 6.10.1. Border
線の情報を取得します。

|取得できる情報|Field|階層または定数値(文字列)|リスト|
|---|---|---|:-:|
|線の色|color|[6.5. Color](#65-color)|x|
|線の色|colorStyle|[6.6. ColorStyle](#66-colorstyle)|x|
|線の幅|width|||
|線のスタイル|style|DOTTED：点線<br>DASHED：破線SOLID：細い実線<br>SOLID_MEDIUM：中位の実線<br>SOLID_THICK：太い実線<br>DOUBLE：2本の実線||

## 6.11. NumberFormat
テキストの書式を取得します。

|取得できる情報|Field|定数値(文字列)|
|---|---|---|
|書式パターン|pattern||
|書式タイプ|type|TEXT：テキスト<br>NUMBER：数値<br>PERCENT：パーセント<br>CURRENCY：通貨<br>DATE：日付<br>TIME：時刻<br>DATE_TIME：日付+時刻<br>SCIENTIFIC：科学的|

## 6.12. Padding
セルの余白を取得します。

|取得できる情報|Field|
|---|---|
|下の余白|bottom|
|左の余白|left|
|右の余白|right|
|上の余白|top|

## 6.13. TextRotation
テキストの回転情報を取得します。

|取得できる情報|Field|
|---|---|
|テキストの角度|angle|
|縦書きか？|vertical|

## 6.14. ErrorValue
エラー情報を取得します。

|取得できる情報|Field|定数値(文字列)|
|---|---|---|
|エラ〜メッセージ|message||
|エラーの種類|type|ERROR,NULL_VALUE,DIVIDE_BY_ZERO,VALUE,REF,NAME,NUM,N_A,LOADING|

## 6.15. ChartData
グラフのデータを取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|セルのデータ範囲|sourceRange|[6.15.1. ChartSourceRange](#6151-chartsourcerange)|x|

## 6.15.1. ChartSourceRange
グラフの範囲を取得します。

|取得できる情報|Field|階層|リスト|
|---|---|---|:-:|
|範囲|sources|[6.3. GridRange](#63-gridrange)|o|

## 6.16. LineStyle
線のスタイルを取得します。

|取得できる情報|Field|定数値(文字列)|
|---|---|---|
|線の種類|type|INVISIBLE：線を表示しない<br>SOLID：実践<br>DOTTED：点線<br>MEDIUM_DASHED：破線<br>MEDIUM_DASHED_DOTTED：一点鎖線<br>LONG_DASHED：長い破線<br>LONG_DASHED_DOTTED：長い一点鎖線|
|線の太さ (ピクセル単位)|width||

<br>
おしまい。。