Sheets

シート

スプレッドシート内のシート。

JSON 表現 
{
  "properties": {
    object (SheetProperties)
  },
  "data": [
    {
      object (GridData)
    }
  ],
  "merges": [
    {
      object (GridRange)
    }
  ],
  "conditionalFormats": [
    {
      object (ConditionalFormatRule)
    }
  ],
  "filterViews": [
    {
      object (FilterView)
    }
  ],
  "protectedRanges": [
    {
      object (ProtectedRange)
    }
  ],
  "basicFilter": {
    object (BasicFilter)
  },
  "charts": [
    {
      object (EmbeddedChart)
    }
  ],
  "bandedRanges": [
    {
      object (BandedRange)
    }
  ],
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "rowGroups": [
    {
      object (DimensionGroup)
    }
  ],
  "columnGroups": [
    {
      object (DimensionGroup)
    }
  ],
  "slicers": [
    {
      object (Slicer)
    }
  ]
}
フィールド
properties

object (SheetProperties)

シートのプロパティ。

data[]

object (GridData)

グリッド内のデータ（グリッドシートの場合）。

返される GridData オブジェクトの数は、このシートでリクエストされた範囲の数によって異なります。たとえば、これが Sheet1 を表し、スプレッドシートが範囲 Sheet1!A1:C10 と Sheet1!D15:E20 でリクエストされた場合、最初の GridData の startRow / startColumn は 0 になりますが、2 番目の GridData の startRow 14（ゼロベースの行 15）と startColumn 3（ゼロベースの列 D）になります。

DATA_SOURCE シートでは、特定の範囲をリクエストすることはできません。GridData にはすべての値が含まれます。
merges[]

object (GridRange)

結合される範囲。
conditionalFormats[]

object (ConditionalFormatRule)

このシートの条件付き書式ルール。

filterViews[]

object (FilterView)

このシートのフィルタ表示。

protectedRanges[]

object (ProtectedRange)

このシート内の保護されている範囲。

basicFilter

object (BasicFilter)

このシートのフィルタ（存在する場合）。

charts[]

object (EmbeddedChart)

このシート上のすべてのグラフの仕様。

bandedRanges[]

object (BandedRange)

このシートの帯状（交互の色）の範囲。

developerMetadata[]

object (DeveloperMetadata)

シートに関連付けられたデベロッパーのメタデータ。
rowGroups[]

object (DimensionGroup)

このシート上のすべての行グループ。範囲の開始インデックスの昇順、グループの深さの昇順で並べ替えられています。

columnGroups[]

object (DimensionGroup)

このシート上のすべての列グループ。範囲の開始インデックスの昇順、グループの深さの昇順で並べ替えられます。

slicers[]

object (Slicer)

このシートのスライサー。

SheetProperties

シートのプロパティ。

JSON 表現 
{
  "sheetId": integer,
  "title": string,
  "index": integer,
  "sheetType": enum (SheetType),
  "gridProperties": {
    object (GridProperties)
  },
  "hidden": boolean,
  "tabColor": {
    object (Color)
  },
  "tabColorStyle": {
    object (ColorStyle)
  },
  "rightToLeft": boolean,
  "dataSourceSheetProperties": {
    object (DataSourceSheetProperties)
  }
}
フィールド
sheetId

integer

シートの ID。負の値は使用できません。このフィールドは、一度設定すると変更できません。
title

string

シートの名前。
index

integer

スプレッドシート内のシートのインデックス。シートのプロパティを追加または更新する際、このフィールドが除外されている場合、シートはシートリストの最後に追加または移動されます。シート番号を更新する場合やシートを挿入する場合、移動は「移動前」の番号で考慮されます。たとえば、3 つのシート（S1、S2、S3）がある場合、S1 を S2 の前に移動するには、インデックスを 2 に設定する必要があります。リクエストされたインデックスがシートの現在のインデックスと一致する場合、またはリクエストされた新しいインデックスが現在のシート インデックス + 1 の場合、シート インデックスの更新リクエストは無視されます。

sheetType

enum (SheetType)

シートの種類。デフォルトは GRID です。このフィールドは一度設定すると変更できません。

gridProperties

object (GridProperties)

このシートがグリッドの場合、シートの追加プロパティ。（シートがグラフや画像を含むオブジェクト シートの場合、このフィールドはありません）。作成時に、グリッド以外のシートにグリッド プロパティを設定するとエラーになります。

このシートが DATA_SOURCE シートの場合、このフィールドは出力専用ですが、データソース シートが UI でレンダリングされる方法を反映するプロパティ（rowCount など）が含まれます。
hidden

boolean

シートが UI で非表示になっている場合は true、表示されている場合は false。

tabColor
(deprecated)

object (Color)

UI のタブの色。非推奨: tabColorStyle を使用してください。
tabColorStyle

object (ColorStyle)

UI のタブの色。tabColor も設定されている場合、このフィールドが優先されます。
rightToLeft

boolean

シートが LTR シートではなく RTL シートの場合、true です。
dataSourceSheetProperties

object (DataSourceSheetProperties)

出力専用。存在する場合、フィールドには DATA_SOURCE シート固有のプロパティが含まれます。

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

integer

グリッド内の行数。
columnCount

integer

グリッド内の列数。
frozenRowCount

integer

グリッドで固定される行数。
frozenColumnCount

integer

グリッド内で固定する列の数。
hideGridlines

boolean

グリッドの UI にグリッド線が表示されていない場合は true。

rowGroupControlAfter

boolean

行グループ化コントロールの切り替えがグループの後に表示される場合は true。
columnGroupControlAfter

boolean

グループの後に列グループ化コントロールの切り替えボタンが表示される場合は true に設定します。

DataSourceSheetProperties

DATA_SOURCE シートの追加プロパティ。

JSON 表現 
{
  "dataSourceId": string,
  "columns": [
    {
      object (DataSourceColumn)
    }
  ],
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
フィールド
dataSourceId

string

シートが接続されている DataSource の ID。

columns[]

object (DataSourceColumn)

シートに表示される列。RowData の値に対応しています。
dataExecutionStatus

object (DataExecutionStatus)

データの実行ステータス。

GridData

グリッド内のデータと、ディメンションに関するメタデータ。

JSON 表現 
{
  "startRow": integer,
  "startColumn": integer,
  "rowData": [
    {
      object (RowData)
    }
  ],
  "rowMetadata": [
    {
      object (DimensionProperties)
    }
  ],
  "columnMetadata": [
    {
      object (DimensionProperties)
    }
  ]
}
フィールド
startRow

integer

この GridData が参照する最初の行（ゼロベース）。
startColumn

integer

この GridData が参照する最初の列（ゼロベース）。
rowData[]

object (RowData)

グリッド内のデータ（行あたり 1 エントリ）。startRow 内の行から始まります。RowData の値は、startColumn で始まる列に対応します。
rowMetadata[]

object (DimensionProperties)

グリッドでリクエストされた行に関するメタデータ（startRow の行から始まる）。
columnMetadata[]

object (DimensionProperties)

グリッドでリクエストされた列に関するメタデータ（startColumn の列から始まる）。

RowData

行内の各セルに関するデータ。

JSON 表現 
{
  "values": [
    {
      object (CellData)
    }
  ]
}
フィールド
values[]

object (CellData)

行の値（1 列に 1 つずつ）。

DimensionProperties

ディメンションに関するプロパティ。

JSON 表現 
{
  "hiddenByFilter": boolean,
  "hiddenByUser": boolean,
  "pixelSize": integer,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
}
フィールド
hiddenByFilter

boolean

このディメンションがフィルタされている場合は true です。このフィールドは読み取り専用です。
hiddenByUser

boolean

このディメンションが明示的に非表示の場合は true。
pixelSize

integer

ディメンションの高さ（行の場合）または幅（列の場合）（ピクセル単位）。
developerMetadata[]

object (DeveloperMetadata)

単一の行または列に関連付けられたデベロッパー メタデータ。
dataSourceColumnReference

object (DataSourceColumnReference)

出力専用。設定されている場合は、データソース シート内の列です。

ConditionalFormatRule

条件付き書式を記述するルール。

JSON 表現 
{
  "ranges": [
    {
      object (GridRange)
    }
  ],

  // Union field rule can be only one of the following:
  "booleanRule": {
    object (BooleanRule)
  },
  "gradientRule": {
    object (GradientRule)
  }
  // End of list of possible types for union field rule.
}
フィールド
ranges[]

object (GridRange)

条件が true の場合に書式設定される範囲。すべての範囲が同じグリッド上にある必要があります。

共用体フィールド rule。この条件付き書式を制御するルールは、1 つだけ設定する必要があります。rule は次のいずれかになります。
booleanRule

object (BooleanRule)

ルールは、ルールに従って「on」または「off」のいずれかになります。
gradientRule

object (GradientRule)

書式は、ルールのグラデーションによって異なります。

BooleanRule

条件に応じて一致する場合と一致しない場合があります。

JSON 表現 
{
  "condition": {
    object (BooleanCondition)
  },
  "format": {
    object (CellFormat)
  }
}
フィールド
condition

object (BooleanCondition)

ルールの条件。条件が true と評価されると、形式が適用されます。
format

object (CellFormat)

適用する形式。条件付き書式設定では、書式のサブセット（bold、italic、strikethrough、foreground color、background color）のみを適用できます。

GradientRule

指定された補間ポイントに基づいて、グラデーション カラースケール書式を適用するルール。セルの形式は、補間ポイントの値と比較したセルの内容によって異なります。

JSON 表現 
{
  "minpoint": {
    object (InterpolationPoint)
  },
  "midpoint": {
    object (InterpolationPoint)
  },
  "maxpoint": {
    object (InterpolationPoint)
  }
}
フィールド
minpoint

object (InterpolationPoint)

開始補間ポイント。
midpoint

object (InterpolationPoint)

中間補間ポイント（省略可）。
maxpoint

object (InterpolationPoint)

最後の補間ポイント。

InterpolationPoint

グラデーションの条件付き書式の単一補間ポイント。選択した色、タイプ、値に応じて、グラデーション カラースケールが固定されます。

JSON 表現 
{
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  },
  "type": enum (InterpolationPointType),
  "value": string
}
フィールド
color
(deprecated)

object (Color)

この補間ポイントで使用する色。非推奨: colorStyle を使用してください。
colorStyle

object (ColorStyle)

この補間ポイントで使用する色。color も設定されている場合、このフィールドが優先されます。
type

enum (InterpolationPointType)

値をどのように解釈すべきかを指定します。
value

string

この補間ポイントで使用する値。数式の場合もあります。type が MIN または MAX の場合、使用されません。

InterpolationPointType

補間ポイントの種類。

列挙型
INTERPOLATION_POINT_TYPE_UNSPECIFIED デフォルト値。使用しないでください。
MIN 補間ポイントでは、条件付き書式の範囲内のセルの最小値が使用されます。
MAX 補間ポイントでは、条件付き書式の範囲内のセルの最大値が使用されます。
NUMBER 補間ポイントは、InterpolationPoint.value の値を正確に使用します。
PERCENT

補間ポイントは、条件付き書式の範囲内のすべてのセルに対する指定された割合です。これは、値が =(MAX(FLATTEN(range)) * (value / 100)) + (MIN(FLATTEN(range)) * (1 - (value / 100))) の場合の NUMBER と同等です（フラット化時に範囲内のエラーは無視されます）。
PERCENTILE 補間ポイントは、条件付き書式の範囲内のすべてのセルに対する指定のパーセンタイルです。これは、値が =PERCENTILE(FLATTEN(range), value / 100) の場合の NUMBER と同等です（フラット化時に範囲内のエラーは無視されます）。

FilterView

フィルタ表示。

JSON 表現 
{
  "filterViewId": integer,
  "title": string,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}
フィールド
filterViewId

integer

フィルタビューの ID。
title

string

フィルタビューの名前。
range

object (GridRange)

このフィルタ表示がカバーする範囲。

書き込み時は、range または namedRangeId のいずれか 1 つのみを設定できます。

namedRangeId

string

このフィルタビューでサポートされる名前付き範囲（存在する場合）。

書き込み時は、range または namedRangeId のいずれか 1 つのみを設定できます。

sortSpecs[]

object (SortSpec)

列ごとの並べ替え順序。以前の仕様で値が同じ場合は、後の仕様が使用されます。
criteria
(deprecated)

map (key: integer, value: object ( FilterCriteria))

列ごとの値の表示/非表示の条件。マップのキーは列番号で、値はその列の条件です。

このフィールドのサポートは終了し、filterSpecs に置き換えられました。

filterSpecs[]

object (FilterSpec)

列ごとに値を表示または非表示にするフィルタ条件。

レスポンスには criteria と filterSpecs の両方が入力されます。更新リクエストで両方のフィールドが指定されている場合、このフィールドが優先されます。

ProtectedRange

保護されている範囲。

JSON 表現 
{
  "protectedRangeId": integer,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "description": string,
  "warningOnly": boolean,
  "requestingUserCanEdit": boolean,
  "unprotectedRanges": [
    {
      object (GridRange)
    }
  ],
  "editors": {
    object (Editors)
  }
}
フィールド
protectedRangeId

integer

保護されている範囲の ID。このフィールドは読み取り専用です。
range

object (GridRange)

保護されている範囲。範囲に完全に制限がない場合、保護されているシートと見なされます。

書き込み時に設定できるのは、range または namedRangeId のいずれか 1 つだけです。
namedRangeId

string

この保護された範囲が基づいている名前付き範囲（存在する場合）。

書き込み時は、range または namedRangeId のいずれか 1 つのみを設定できます。

description

string

この保護された範囲の説明。
warningOnly

boolean

この保護されている範囲を編集時に警告を表示する場合は true に設定します。警告ベースの保護では、保護された範囲内のデータをすべてのユーザーが編集できますが、編集する際に編集の確認を求める警告が表示されます。

記述時: このフィールドが true の場合、editors は無視されます。また、このフィールドが true から false に変更され、editors フィールドが設定されていない（またはフィールドマスクに含まれていない）場合、エディタはドキュメント内のすべてのエディタに設定されます。
requestingUserCanEdit

boolean

この保護された範囲をリクエストしたユーザーが保護された領域を編集できる場合は true です。このフィールドは読み取り専用です。
unprotectedRanges[]

object (GridRange)

保護されたシート内の保護されていない範囲のリスト。保護されていない範囲は、保護されたシートでのみサポートされます。
editors

object (Editors)

保護された範囲への編集アクセス権を持つユーザーとグループ。このフィールドは、保護された範囲とドキュメントへの編集権限を持つユーザーにのみ表示されます。エディタは、warningOnly 保護ではサポートされていません。

編集者

保護されている範囲の編集者。

JSON 表現 
{
  "users": [
    string
  ],
  "groups": [
    string
  ],
  "domainUsersCanEdit": boolean
}
フィールド
users[]

string

保護された範囲への編集アクセス権を持つユーザーのメールアドレス。
groups[]

string

保護された範囲への編集アクセス権を持つグループのメールアドレス。
domainUsersCanEdit

boolean

ドキュメントのドメイン内の全員が保護された範囲の編集権限を持っている場合、true になります。ドメイン保護は、ドメイン内のドキュメントでのみサポートされます。

BasicFilter

シートに関連付けられているデフォルトのフィルタ。

JSON 表現 
{
  "range": {
    object (GridRange)
  },
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}
フィールド
range

object (GridRange)

フィルタがカバーする範囲。
sortSpecs[]

object (SortSpec)

列ごとの並べ替え順。以前の仕様で値が同じ場合は、後の仕様が使用されます。
criteria
(deprecated)

map (key: integer, value: object ( FilterCriteria))

列ごとの値の表示/非表示の条件。マップのキーは列のインデックスで、値はその列の条件です。

このフィールドは非推奨になりました。代わりに filterSpecs を使用してください。
filterSpecs[]

object (FilterSpec)

列ごとのフィルタ条件。

レスポンスには criteria と filterSpecs の両方が入力されます。更新リクエストで両方のフィールドが指定されている場合、このフィールドが優先されます。

BandedRange

シート内の帯状（交互の色）の範囲。

JSON 表現 
{
  "bandedRangeId": integer,
  "range": {
    object (GridRange)
  },
  "rowProperties": {
    object (BandingProperties)
  },
  "columnProperties": {
    object (BandingProperties)
  }
}
フィールド
bandedRangeId

integer

バンド範囲の ID。
range

object (GridRange)

これらのプロパティが適用される範囲。
rowProperties

object (BandingProperties)

行バンドのプロパティ。これらのプロパティは、範囲内のすべての行に 1 行ずつ適用されます。rowProperties または columnProperties の少なくとも 1 つを指定する必要があります。
columnProperties

object (BandingProperties)

列バンドのプロパティ。これらのプロパティは、範囲内のすべての列に列ごとに適用されます。rowProperties または columnProperties の少なくとも 1 つを指定する必要があります。

BandingProperties

単一のディメンション（行または列）を参照するプロパティ。BandedRange.row_properties と BandedRange.column_properties の両方を設定した場合、以下のルールに沿って塗りつぶしの色がセルに適用されます。

たとえば、1 行目の色は 1 列目の色よりも優先されますが、1 列目の色は 2 行目の色よりも優先されます。同様に、行ヘッダーは左上のセルの列ヘッダーよりも優先されますが、行ヘッダーが設定されていない場合は、列ヘッダーが最初の行の色よりも優先されます。

JSON 表現 
{
  "headerColor": {
    object (Color)
  },
  "headerColorStyle": {
    object (ColorStyle)
  },
  "firstBandColor": {
    object (Color)
  },
  "firstBandColorStyle": {
    object (ColorStyle)
  },
  "secondBandColor": {
    object (Color)
  },
  "secondBandColorStyle": {
    object (ColorStyle)
  },
  "footerColor": {
    object (Color)
  },
  "footerColorStyle": {
    object (ColorStyle)
  }
}
フィールド
headerColor
(deprecated)

object (Color)

最初の行または列の色。このフィールドが設定されている場合、最初の行または列はこの色で塗りつぶされ、2 番目の行または列から firstBandColor と secondBandColor が交互に使用されます。それ以外の場合、最初の行または列は firstBandColor で塗りつぶされ、色は通常どおり交互に表示されます。非推奨: headerColorStyle を使用してください。
headerColorStyle

object (ColorStyle)

最初の行または列の色。このフィールドが設定されている場合、最初の行または列はこの色で塗りつぶされ、2 番目の行または列から firstBandColor と secondBandColor が交互に使用されます。それ以外の場合、最初の行または列は firstBandColor で塗りつぶされ、色は通常どおり交互に表示されます。headerColor も設定されている場合、このフィールドが優先されます。
firstBandColor
(deprecated)

object (Color)

交互に表示される最初の色。（必須）非推奨: firstBandColorStyle を使用してください。
firstBandColorStyle

object (ColorStyle)

交互に表示される最初の色。（必須）firstBandColor も設定されている場合、このフィールドが優先されます。
secondBandColor
(deprecated)

object (Color)

交互の 2 つ目の色です。（必須）非推奨: secondBandColorStyle を使用してください。
secondBandColorStyle

object (ColorStyle)

交互に表示される 2 つ目の色。（必須）secondBandColor も設定されている場合、このフィールドが優先されます。

footerColor
(deprecated)

object (Color)

最後の行または列の色。このフィールドが設定されていない場合、最後の行または列は、前の行または列の色に応じて firstBandColor または secondBandColor で塗りつぶされます。非推奨: footerColorStyle を使用してください。
footerColorStyle

object (ColorStyle)

最後の行または列の色。このフィールドが設定されていない場合、最後の行または列は、前の行または列の色に応じて firstBandColor または secondBandColor で塗りつぶされます。footerColor も設定されている場合、このフィールドが優先されます。

DimensionGroup

シート上の行または列の範囲にわたるグループ。他のグループを含めたり、他のグループに含めたりできます。グループは、シート上で 1 つのユニットとして折りたたんだり展開したりできます。

JSON 表現 
{
  "range": {
    object (DimensionRange)
  },
  "depth": integer,
  "collapsed": boolean
}
フィールド
range

object (DimensionRange)

このグループが存在する範囲。
depth

integer

グループの深さ。このグループの範囲を完全に含む範囲を持つグループの数を表します。

collapsed

boolean

このフィールドは、このグループが折りたたまれている場合に true になります。折りたたまれたグループは、重複するグループが浅い深度で展開されても、折りたたまれたままになります。

値が true の場合でも、グループ内のすべてのディメンションが非表示になるわけではありません。ディメンションの表示設定は、このグループ プロパティとは別に変更できます。ただし、このプロパティが更新されると、このフィールドが true の場合、その中のすべてのディメンションは非表示に設定され、このフィールドが false の場合、表示に設定されます。

スライサー

シート内のスライサー。

JSON 表現 
{
  "slicerId": integer,
  "spec": {
    object (SlicerSpec)
  },
  "position": {
    object (EmbeddedObjectPosition)
  }
}
フィールド
slicerId

integer

スライサーの ID。

spec

object (SlicerSpec)

スライサーの仕様。
position

object (EmbeddedObjectPosition)

スライサーの位置。スライサーは既存のシートにのみ配置できます。また、スライサーの幅と高さは、許容範囲内に収まるように自動的に調整できます。

SlicerSpec

スライサーの仕様。

JSON 表現 
{
  "dataRange": {
    object (GridRange)
  },
  "filterCriteria": {
    object (FilterCriteria)
  },
  "columnIndex": integer,
  "applyToPivotTables": boolean,
  "title": string,
  "textFormat": {
    object (TextFormat)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "horizontalAlignment": enum (HorizontalAlign)
}
フィールド
dataRange

object (GridRange)

スライサーのデータ範囲。
filterCriteria

object (FilterCriteria)

スライサーのフィルタリング条件。
columnIndex

integer

フィルタが適用されるデータテーブル内のゼロベースの列番号。
applyToPivotTables

boolean

フィルタをピボット テーブルに適用する場合は true にします。設定しない場合、デフォルトで True になります。
title

string

スライサーのタイトル。
textFormat

object (TextFormat)

スライサー内のタイトルのテキスト形式。リンク フィールドはサポートされていません。
backgroundColor
(deprecated)

object (Color)

スライサーの背景色。非推奨: backgroundColorStyle を使用してください。
backgroundColorStyle

object (ColorStyle)

スライサーの背景色。backgroundColor も設定されている場合、このフィールドが優先されます。
horizontalAlignment

enum (HorizontalAlign)

スライサー内のタイトルの水平方向の配置。指定しない場合のデフォルトは LEFT です。