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 は 0 の startRow / startColumn を持ち、2 番目の GridData は（0 から始まる行 15）startRow 14 と、0 から始まる列 D の startColumn 3 になります。

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

スプレッドシート内のシートのインデックス。シートのプロパティを追加または更新するときに、このフィールドが除外されている場合、シートはシートリストの最後に追加または移動されます。シート インデックスの更新やシートの挿入を行う場合、「移動前」インデックスでの移動が考慮されます。たとえば、S1 を S2 の前に移動するには、3 枚（S1、S2、S3）の場合、インデックスを 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 が参照する最初の行は 0 です。
startColumn

integer

この GridData の最初の列はゼロベースです。

rowData[]

object (RowData)

startRow の行を起点として、行ごとに 1 エントリを出力するグリッドデータ。RowData の値は、startColumn で始まる列に対応します。

rowMetadata[]

object (DimensionProperties)

グリッド内のリクエストされた行に関するメタデータ。startRow の行を起点とします。

columnMetadata[]

object (DimensionProperties)

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

RowData

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

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

object (CellData)

行内の値（列ごとに 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)

書式は、ルールに応じて「オン」または「オフ」のいずれかになります。

gradientRule

object (GradientRule)

形式は、ルールの勾配によって異なります。

ブール値ルール

条件に応じて一致するルールと一致しないルール。

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)

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

object (BandingProperties)

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

BandingProperties

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

最初の行の色は最初の列の色よりも優先されますが、最初の列の色は 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 も設定されている場合、このフィールドが優先されます。

ディメンション グループ

シート上の行または列の間隔に基づいたグループ。他のグループに含めることも、他のグループ内に含めることもできます。グループは、シート上で 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

フィルタが適用されるデータテーブルの 0 から始まる列インデックス。
applyToPivotTables

boolean

フィルタをピボット テーブルに適用する場合は true。指定しなかった場合のデフォルトは True です。

title

string

スライサーのタイトル。

textFormat

object (TextFormat)

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

object (Color)

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

object (ColorStyle)

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

horizontalAlignment

enum (HorizontalAlign)

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