シート
スプレッドシート内のシート。
| JSON 表現 | 
|---|
| { "properties": { object ( | 
| フィールド | |
|---|---|
| properties | 
        シートのプロパティ。 | 
| data[] | 
        グリッド内のデータ(グリッドシートの場合)。 
       返される GridData オブジェクトの数は、このシートでリクエストされた範囲の数によって異なります。たとえば、これが  
        | 
| merges[] | 
        結合される範囲。 | 
| conditionalFormats[] | 
        このシートの条件付き書式ルール。 | 
| filterViews[] | 
        このシートのフィルタ表示。 | 
| protectedRanges[] | 
        このシート内の保護されている範囲。 | 
| basicFilter | 
        このシートのフィルタ(存在する場合)。 | 
| charts[] | 
        このシート上のすべてのグラフの仕様。 | 
| bandedRanges[] | 
        このシートの帯状(交互の色)の範囲。 | 
| developerMetadata[] | 
        シートに関連付けられたデベロッパー メタデータ。 | 
| rowGroups[] | 
        このシート上のすべての行グループ。範囲の開始インデックスの昇順、グループの深さの昇順で並べ替えられます。 | 
| columnGroups[] | 
        このシート上のすべての列グループ。範囲の開始インデックスの昇順、グループの深さの昇順で並べ替えられます。 | 
| slicers[] | 
        このシートのスライサー。 | 
| tables[] | 
        このシートの表。 | 
SheetProperties
シートのプロパティ。
| JSON 表現 | 
|---|
| { "sheetId": integer, "title": string, "index": integer, "sheetType": enum ( | 
| フィールド | |
|---|---|
| sheetId | 
        シートの ID。負の値は使用できません。このフィールドは、一度設定すると変更できません。 | 
| title | 
        シートの名前。 | 
| index | 
        スプレッドシート内のシートのインデックス。シートのプロパティを追加または更新するときに、このフィールドを除外すると、シートはシートリストの末尾に追加または移動されます。シート番号を更新する場合やシートを挿入する場合、移動は「移動前」の番号で考慮されます。たとえば、3 つのシート(S1、S2、S3)がある場合、S1 を S2 の前に移動するには、インデックスを 2 に設定する必要があります。リクエストされたインデックスがシートの現在のインデックスと一致する場合、またはリクエストされた新しいインデックスが現在のシート インデックス + 1 の場合、シート インデックスの更新リクエストは無視されます。 | 
| sheetType | 
        
       シートの種類。デフォルトは  | 
| gridProperties | 
        このシートがグリッドの場合のシートに関する追加プロパティ。(シートがグラフや画像を含むオブジェクト シートの場合は、このフィールドはありません)。作成時に、グリッド以外のシートにグリッド プロパティを設定するとエラーになります。 
       このシートが  | 
| tabColor
        | 
        
       UI のタブの色。非推奨:  | 
| tabColorStyle | 
        
       UI のタブの色。 | 
| rightToLeft | 
        シートが LTR シートではなく RTL シートの場合、true です。 | 
| dataSourceSheetProperties | 
        
       出力専用。存在する場合、このフィールドにはシート固有の  | 
SheetType
シートの種類。
| 列挙型 | |
|---|---|
| SHEET_TYPE_UNSPECIFIED | デフォルト値。使用しないでください。 | 
| GRID | シートはグリッドです。 | 
| OBJECT | シートにグリッドはなく、代わりにグラフや画像などのオブジェクトがあります。 | 
| DATA_SOURCE | シートは外部 DataSourceに接続し、データのプレビューを表示します。 | 
GridProperties
グリッドのプロパティ。
| JSON 表現 | 
|---|
| { "rowCount": integer, "columnCount": integer, "frozenRowCount": integer, "frozenColumnCount": integer, "hideGridlines": boolean, "rowGroupControlAfter": boolean, "columnGroupControlAfter": boolean } | 
| フィールド | |
|---|---|
| rowCount | 
        グリッド内の行数。 | 
| columnCount | 
        グリッド内の列数。 | 
| frozenRowCount | 
        グリッドで固定される行数。 | 
| frozenColumnCount | 
        グリッドで固定される列の数。 | 
| hideGridlines | 
        グリッドの UI にグリッド線が表示されていない場合は true。 | 
| rowGroupControlAfter | 
        行グループ化コントロールの切り替えボタンがグループの後に表示される場合は true です。 | 
| columnGroupControlAfter | 
        列グループ化コントロールの切り替えボタンがグループの後に表示される場合は true に設定します。 | 
DataSourceSheetProperties
   DATA_SOURCE シートの追加プロパティ。
| JSON 表現 | 
|---|
| { "dataSourceId": string, "columns": [ { object ( | 
| フィールド | |
|---|---|
| dataSourceId | 
        
       シートが接続されている  | 
| columns[] | 
        
       シートに表示される列。 | 
| dataExecutionStatus | 
        データの実行ステータス。 | 
GridData
グリッド内のデータと、ディメンションに関するメタデータ。
| JSON 表現 | 
|---|
| { "startRow": integer, "startColumn": integer, "rowData": [ { object ( | 
| フィールド | |
|---|---|
| startRow | 
        この GridData が参照する最初の行(ゼロベース)。 | 
| startColumn | 
        この GridData が参照する最初の列(ゼロベース)。 | 
| rowData[] | 
        
       グリッド内のデータ(startRow の行から始まり、行ごとに 1 つのエントリ)。RowData の値は、 | 
| rowMetadata[] | 
        
       グリッドでリクエストされた行に関するメタデータ( | 
| columnMetadata[] | 
        
       グリッドでリクエストされた列に関するメタデータ( | 
RowData
行内の各セルに関するデータ。
| JSON 表現 | 
|---|
| {
  "values": [
    {
      object ( | 
| フィールド | |
|---|---|
| values[] | 
        行内の値(列ごとに 1 つ)。 | 
DimensionProperties
ディメンションに関するプロパティ。
| JSON 表現 | 
|---|
| { "hiddenByFilter": boolean, "hiddenByUser": boolean, "pixelSize": integer, "developerMetadata": [ { object ( | 
| フィールド | |
|---|---|
| pixelSize | 
        ディメンションの高さ(行の場合)または幅(列の場合)(ピクセル単位)。 | 
| developerMetadata[] | 
        単一の行または列に関連付けられたデベロッパー メタデータ。 | 
| dataSourceColumnReference | 
        出力専用。設定されている場合は、データソース シートの列です。 | 
ConditionalFormatRule
条件付き書式を記述するルール。
| JSON 表現 | 
|---|
| { "ranges": [ { object ( | 
| フィールド | |
|---|---|
| ranges[] | 
        条件が true の場合に書式設定される範囲。すべての範囲が同じグリッド上にある必要があります。 | 
| 共用体フィールド rule。この条件付き書式を制御するルールは、必ず 1 つ設定する必要があります。ruleは次のいずれかになります。 | |
| booleanRule | 
        フォーマットは、ルールに応じて「オン」または「オフ」になります。 | 
| gradientRule | 
        書式は、ルールのグラデーションによって異なります。 | 
BooleanRule
条件に応じて一致する場合と一致しない場合があります。
| JSON 表現 | 
|---|
| { "condition": { object ( | 
| フィールド | |
|---|---|
| condition | 
        ルールの条件。条件が true と評価された場合、書式が適用されます。 | 
| format | 
        
       適用する形式。条件付き書式設定では、書式の一部( | 
GradientRule
指定された補間ポイントに基づいて、グラデーション カラースケール書式を適用するルール。セルの形式は、補間ポイントの値と比較してその内容によって異なります。
| JSON 表現 | 
|---|
| { "minpoint": { object ( | 
| フィールド | |
|---|---|
| minpoint | 
        補間の開始ポイント。 | 
| midpoint | 
        中間補間ポイント(省略可)。 | 
| maxpoint | 
        最後の補間ポイント。 | 
InterpolationPoint
グラデーションの条件付き書式の単一補間ポイント。選択した色、タイプ、値に応じて、グラデーション カラースケールが固定されます。
| JSON 表現 | 
|---|
| { "color": { object ( | 
| フィールド | |
|---|---|
| color
        | 
        
       この補間ポイントで使用する色。非推奨:  | 
| colorStyle | 
        
       この補間ポイントで使用する色。 | 
| type | 
        値をどのように解釈すべきかを指定します。 | 
| value | 
        | 
InterpolationPointType
補間ポイントの種類。
| 列挙型 | |
|---|---|
| INTERPOLATION_POINT_TYPE_UNSPECIFIED | デフォルト値。使用しないでください。 | 
| MIN | 補間ポイントでは、条件付き書式の範囲内のセルの最小値が使用されます。 | 
| MAX | 補間ポイントでは、条件付き書式の範囲内のセルの最大値が使用されます。 | 
| NUMBER | 補間ポイントは、 InterpolationPoint.valueの値を正確に使用します。 | 
| PERCENT | 
       補間ポイントは、条件付き書式の範囲内のすべてのセルに対する指定された割合です。これは、値が  | 
| PERCENTILE | 補間ポイントは、条件付き書式の範囲内のすべてのセルの指定されたパーセンタイルです。これは、値が =PERCENTILE(FLATTEN(range), value / 100)の場合のNUMBERと同等です(フラット化時に範囲内のエラーは無視されます)。 | 
FilterView
フィルタ表示。
| JSON 表現 | 
|---|
| { "filterViewId": integer, "title": string, "range": { object ( | 
| フィールド | |
|---|---|
| filterViewId | 
        フィルタビューの ID。 | 
| title | 
        フィルタビューの名前。 | 
| range | 
        このフィルタ表示がカバーする範囲。 
       書き込み時に設定できるのは、 | 
| namedRangeId | 
        このフィルタ表示の基になる名前付き範囲(存在する場合)。 
       書き込み時に設定できるのは、 | 
| tableId | 
        このフィルタ表示が基づいているテーブル(存在する場合)。 
       書き込み時に設定できるのは、 | 
| sortSpecs[] | 
        列ごとの並べ替え順序。前の仕様で値が同じ場合は、後の仕様が使用されます。 | 
| criteria
        | 
        列ごとに値を表示または非表示にする条件。マップのキーは列番号で、値はその列の条件です。 
       このフィールドは非推奨になりました。代わりに  | 
| filterSpecs[] | 
        列ごとに値を表示または非表示にするフィルタ条件。 
       レスポンスには  | 
ProtectedRange
保護されている範囲。
| JSON 表現 | 
|---|
| { "protectedRangeId": integer, "range": { object ( | 
| フィールド | |
|---|---|
| protectedRangeId | 
        保護されている範囲の ID。このフィールドは読み取り専用です。 | 
| range | 
        保護されている範囲。範囲が完全に制限されていない場合、そのシートは保護されたシートと見なされます。 
       書き込み時に設定できるのは、 | 
| namedRangeId | 
        この保護された範囲が基づいている名前付き範囲(存在する場合)。 
       書き込み時に設定できるのは、 | 
| tableId | 
        この保護された範囲が基づいているテーブル(存在する場合)。 
       書き込み時に設定できるのは、 | 
| description | 
        この保護された範囲の説明。 | 
| warningOnly | 
        この保護された範囲を編集するときに警告が表示される場合は true です。警告ベースの保護では、保護された範囲内のデータをすべてのユーザーが編集できますが、編集する際に編集の確認を求める警告が表示されます。 
       記述時: このフィールドが true の場合、 | 
| requestingUserCanEdit | 
        この保護された範囲をリクエストしたユーザーが保護された領域を編集できる場合は true です。このフィールドは読み取り専用です。 | 
| unprotectedRanges[] | 
        保護されたシート内の保護されていない範囲のリスト。保護されていない範囲は、保護されたシートでのみサポートされます。 | 
| editors | 
        
       保護された範囲への編集アクセス権を持つユーザーとグループ。このフィールドは、保護された範囲とドキュメントへの編集権限を持つユーザーにのみ表示されます。エディタは  | 
編集者
保護されている範囲の編集者。
| JSON 表現 | 
|---|
| { "users": [ string ], "groups": [ string ], "domainUsersCanEdit": boolean } | 
| フィールド | |
|---|---|
| users[] | 
        保護された範囲への編集アクセス権を持つユーザーのメールアドレス。 | 
| groups[] | 
        保護された範囲への編集アクセス権を持つグループのメールアドレス。 | 
| domainUsersCanEdit | 
        ドキュメントのドメイン内の全員が保護された範囲の編集権限を持っている場合、true です。ドメイン保護は、ドメイン内のドキュメントでのみサポートされます。 | 
BasicFilter
シートに関連付けられているデフォルトのフィルタ。
| JSON 表現 | 
|---|
| { "range": { object ( | 
| フィールド | |
|---|---|
| range | 
        フィルタが適用される範囲。 | 
| tableId | 
        
       このフィルタが基づいているテーブル(存在する場合)。書き込み時に設定できるのは、 | 
| sortSpecs[] | 
        列ごとの並べ替え順序。前の仕様で値が同じ場合は、後の仕様が使用されます。 | 
| criteria
        | 
        列ごとに値を表示または非表示にする条件。マップのキーは列番号で、値はその列の条件です。 
       このフィールドは非推奨になりました。代わりに  | 
| filterSpecs[] | 
        列ごとのフィルタ条件。 
       レスポンスには  | 
BandedRange
シート内の色分けされた(交互の色の)範囲。
| JSON 表現 | 
|---|
| { "bandedRangeId": integer, "bandedRangeReference": string, "range": { object ( | 
| フィールド | |
|---|---|
| bandedRangeId | 
        
       バンド範囲の ID。設定されていない場合は、 | 
| bandedRangeReference | 
        
       出力専用。バンド範囲の参照。 | 
| range | 
        これらのプロパティが適用される範囲。 | 
| rowProperties | 
        
       行バンドのプロパティ。これらのプロパティは、範囲内のすべての行に 1 行ずつ適用されます。 | 
| columnProperties | 
        
       列バンドのプロパティ。これらのプロパティは、範囲内のすべての列に列ごとに適用されます。 | 
BandingProperties
   単一のディメンション(行または列)を参照するプロパティ。BandedRange.row_properties と BandedRange.column_properties の両方が設定されている場合、塗りつぶし色は次のルールに従ってセルに適用されます。
- 
    headerColorとfooterColorは、バンドの色よりも優先されます。
- 
    firstBandColorはsecondBandColorよりも優先されます。
- 
    rowPropertiesはcolumnPropertiesよりも優先されます。
たとえば、1 行目の色は 1 列目の色よりも優先されますが、1 列目の色は 2 行目の色よりも優先されます。同様に、行ヘッダーは左上のセルの列ヘッダーよりも優先されますが、行ヘッダーが設定されていない場合は、列ヘッダーが最初の行の色よりも優先されます。
| JSON 表現 | 
|---|
| { "headerColor": { object ( | 
| フィールド | |
|---|---|
| headerColor
        | 
        
       最初の行または列の色。このフィールドが設定されている場合、最初の行または列はこの色で塗りつぶされ、2 番目の行または列から  | 
| headerColorStyle | 
        
       最初の行または列の色。このフィールドが設定されている場合、最初の行または列はこの色で塗りつぶされ、2 番目の行または列から  | 
| firstBandColor
        | 
        
       交互に表示される最初の色。(必須)非推奨:  | 
| firstBandColorStyle | 
        
       交互に表示される最初の色。(必須) | 
| secondBandColor
        | 
        
       交互に表示される 2 つ目の色。(必須)非推奨:  | 
| secondBandColorStyle | 
        
       交互に表示される 2 つ目の色。(必須) | 
| footerColor
        | 
        
       最後の行または列の色。このフィールドが設定されていない場合、最後の行または列は、前の行または列の色に応じて  | 
| footerColorStyle | 
        
       最後の行または列の色。このフィールドが設定されていない場合、最後の行または列は、前の行または列の色に応じて  | 
DimensionGroup
シート上の行または列の範囲にわたるグループ。他のグループを含めたり、他のグループに含めたりできます。グループは、シート上で 1 つのユニットとして折りたたんだり展開したりできます。
| JSON 表現 | 
|---|
| {
  "range": {
    object ( | 
| フィールド | |
|---|---|
| range | 
        このグループが存在する範囲。 | 
| depth | 
        グループの深さ。このグループの範囲を完全に含む範囲を持つグループの数を表します。 | 
| collapsed | 
        このグループが閉じられている場合、このフィールドは true になります。折りたたまれているグループは、重複するグループが浅い深度で展開されても、折りたたまれたままになります。 true 値が設定されている場合でも、グループ内のすべてのディメンションが非表示になるわけではありません。ディメンションの公開設定は、このグループ プロパティとは別に変更できます。ただし、このプロパティが更新されると、このフィールドが true の場合はその中のすべてのディメンションが非表示に設定され、false の場合は表示に設定されます。 | 
スライサー
シート内のスライサー。
| JSON 表現 | 
|---|
| { "slicerId": integer, "spec": { object ( | 
| フィールド | |
|---|---|
| slicerId | 
        スライサーの ID。 | 
| spec | 
        スライサーの仕様。 | 
| position | 
        スライサーの位置。スライサーは既存のシートにのみ配置できます。また、スライサーの幅と高さは、許容範囲内に収まるように自動的に調整できます。 | 
SlicerSpec
スライサーの仕様。
| JSON 表現 | 
|---|
| { "dataRange": { object ( | 
| フィールド | |
|---|---|
| dataRange | 
        スライサーのデータ範囲。 | 
| filterCriteria | 
        スライサーのフィルタ条件。 | 
| columnIndex | 
        フィルタが適用されるデータテーブル内のゼロベースの列番号。 | 
| applyToPivotTables | 
        
       フィルタをピボット テーブルに適用する場合は true にします。設定しない場合、デフォルトで  | 
| title | 
        スライサーのタイトル。 | 
| textFormat | 
        スライサーのタイトルのテキスト形式。リンク フィールドはサポートされていません。 | 
| backgroundColor
        | 
        
       スライサーの背景色。非推奨:  | 
| backgroundColorStyle | 
        
       スライサーの背景色。 | 
| horizontalAlignment | 
        
       スライサー内のタイトルの水平方向の配置。指定しない場合、デフォルトで  | 
テーブル
テーブル。
| JSON 表現 | 
|---|
| { "tableId": string, "name": string, "range": { object ( | 
| フィールド | |
|---|---|
| tableId | 
        テーブルの ID。 | 
| name | 
        テーブル名。これは、同じスプレッドシート内のすべてのテーブルで固有のものです。 | 
| range | 
        テーブル範囲。 | 
| rowsProperties | 
        テーブル行のプロパティ。 | 
| columnProperties[] | 
        テーブルの列のプロパティ。 | 
TableRowsProperties
テーブルの行のプロパティ。
| JSON 表現 | 
|---|
| { "headerColorStyle": { object ( | 
| フィールド | |
|---|---|
| headerColorStyle | 
        ヘッダー行の色。このフィールドが設定されている場合、ヘッダー行は指定された色で塗りつぶされます。それ以外の場合、ヘッダー行はデフォルトの色で塗りつぶされます。 | 
| firstBandColorStyle | 
        交互に表示される最初の色。このフィールドを設定すると、最初のバンド行が指定された色で塗りつぶされます。それ以外の場合、最初のバンド行はデフォルトの色で塗りつぶされます。 | 
| secondBandColorStyle | 
        交互に表示される 2 つ目の色。このフィールドが設定されている場合、2 番目のバンド行は指定された色で塗りつぶされます。それ以外の場合、2 番目のバンド行はデフォルトの色で塗りつぶされます。 | 
| footerColorStyle | 
        
       最後の行の色。このフィールドが設定されていない場合、フッターは追加されず、最後の行は前の行の色に応じて  | 
TableColumnProperties
テーブルの列。
| JSON 表現 | 
|---|
| { "columnIndex": integer, "columnName": string, "columnType": enum ( | 
| フィールド | |
|---|---|
| columnIndex | 
        0 ベースの列インデックス。このインデックスはテーブル内の位置を基準としており、シート内の列番号と必ずしも一致しません。 | 
| columnName | 
        列の名前。 | 
| columnType | 
        列の型。 | 
| dataValidationRule | 
        列のデータの入力規則。プルダウン列タイプにのみ設定します。 | 
ColumnType
テーブル内の特定の列の列タイプ。
| 列挙型 | |
|---|---|
| COLUMN_TYPE_UNSPECIFIED | 列の型が指定されていない。 | 
| DOUBLE | 数値列の型。 | 
| CURRENCY | 通貨列の型。 | 
| PERCENT | パーセントの列タイプ。 | 
| DATE | 日付列の型。 | 
| TIME | 時間列の型。 | 
| DATE_TIME | 日時列の型。 | 
| TEXT | テキスト列の型。 | 
| BOOLEAN | ブール値の列型。 | 
| DROPDOWN | プルダウン列の型。 | 
| FILES_CHIP | ファイルチップの列タイプ | 
| PEOPLE_CHIP | ユーザーチップの列タイプ | 
| FINANCE_CHIP | ファイナンス チップの列タイプ | 
| PLACE_CHIP | 場所チップの列タイプ | 
| RATINGS_CHIP | 評価チップの列タイプ | 
TableColumnDataValidationRule
テーブル内の列のデータ入力規則。
| JSON 表現 | 
|---|
| {
  "condition": {
    object ( | 
| フィールド | |
|---|---|
| condition | 
        セル内のデータが一致する必要がある条件。[BooleanCondition.type] が ONE_OF_LIST の場合にのみ有効です。 |