シート
スプレッドシートのシート。
| 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[]
|
グリッド内のデータ。行ごとに 1 つのエントリ。startRow の行から始まります。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
|
1 行目または 1 列目の色。このフィールドが設定されている場合、最初の行または列はこの色で塗りつぶされ、2 番目の行または列から |
headerColorStyle
|
1 行目または 1 列目の色。このフィールドが設定されている場合、最初の行または列はこの色で塗りつぶされ、2 番目の行または列から |
firstBandColor
|
交互に表示される最初の色。(必須)非推奨: |
firstBandColorStyle
|
交互に表示される最初の色。(必須) |
secondBandColor
|
交互になっている 2 つ目の色。(必須)非推奨: |
secondBandColorStyle
|
交互になっている 2 つ目の色。(必須) |
footerColor
|
最後の行または列の色。このフィールドが設定されていない場合、最後の行または列は、前の行または列の色に応じて |
footerColorStyle
|
最後の行または列の色。このフィールドが設定されていない場合、最後の行または列は、前の行または列の色に応じて |
DimensionGroup
シートの行または列の範囲のグループ。他のグループを含めることも、他のグループに含まれることもできます。シート上でグループを単位として折りたたんだり展開したりできます。
| 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
|
フィルタが適用されるデータテーブルの 0 から始まる列インデックス。 |
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 の場合にのみ有効です。 |