シート
スプレッドシートのシート
JSON 表現 |
---|
{ "properties": { object ( |
フィールド | |
---|---|
properties
|
シートのプロパティ。 |
data[]
|
グリッド内のデータ(グリッドシートの場合):
返される GridData オブジェクトの数は、このシートでリクエストされる範囲の数によって決まります。たとえば、
|
merges[]
|
結合される範囲を指定します。 |
conditionalFormats[]
|
このシートの条件付き書式ルール。 |
filterViews[]
|
このシートのフィルタ表示。 |
protectedRanges[]
|
このシート内の保護されている範囲。 |
basicFilter
|
このシートのフィルタ(ある場合)。 |
charts[]
|
このシート上のすべてのグラフの仕様。 |
bandedRanges[]
|
このシート上の帯状(代替色)の範囲。 |
developerMetadata[]
|
シートに関連付けられているデベロッパー メタデータ。 |
rowGroups[]
|
このシートのすべての行グループ。範囲開始インデックスの昇順、グループ深度の順に並べられます。 |
columnGroups[]
|
このシートのすべての列グループを、範囲開始インデックスの昇順、グループ深度の順に並べます。 |
slicers[]
|
このシートのスライサー。 |
SheetProperties
シートのプロパティ。
JSON 表現 |
---|
{ "sheetId": integer, "title": string, "index": integer, "sheetType": enum ( |
フィールド | |
---|---|
sheetId
|
シートの ID。負でない値を指定してください。このフィールドは一度設定すると変更できません。 |
title
|
シートの名前。 |
index
|
スプレッドシート内のシートのインデックス。シートのプロパティを追加または更新するときに、このフィールドが除外されている場合、シートはシートリストの最後に追加または移動されます。シート インデックスの更新やシートの挿入を行う場合、「移動前」インデックスでの移動が考慮されます。たとえば、S1 を S2 の前に移動するには、3 枚(S1、S2、S3)の場合、インデックスを 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 が参照する最初の行は 0 です。 |
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
|
形式は、ルールの勾配によって異なります。 |
ブール値ルール
条件に応じて一致するルールと一致しないルール。
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
|
このフィルタ表示の背後にサポートされている名前付き範囲です(存在する場合)。
書き込み時には、 |
sortSpecs[]
|
列ごとの並べ替え順序。以前の仕様と値が等しい場合、後の仕様が使用されます。 |
criteria
|
列ごとに値を表示/非表示するための基準。マップのキーは列インデックスで、値はその列の条件です。
このフィールドは非推奨になりました。 |
filterSpecs[]
|
列ごとの値を表示または非表示にするフィルタ条件。
|
ProtectedRange
保護されている範囲。
JSON 表現 |
---|
{ "protectedRangeId": integer, "range": { object ( |
フィールド | |
---|---|
protectedRangeId
|
保護されている範囲の ID。このフィールドは読み取り専用です。 |
range
|
保護されている範囲。範囲には制限なしを指定できます。その場合、これは保護されたシートと見なされます。
書き込み時には、 |
namedRangeId
|
この保護されている範囲の背後にある名前付き範囲です(存在する場合)。
書き込み時には、 |
description
|
この保護されている範囲の説明。 |
warningOnly
|
この保護された範囲が編集時に警告を表示する場合は true。警告ベースの保護では、すべてのユーザーが、保護されている範囲内でデータを編集できることを意味します。ただし、編集した場合は、ユーザーに確認を求める警告が表示されます。
書き込み時にこのフィールドが true の場合、 |
requestingUserCanEdit
|
この保護されている範囲をリクエストしているユーザーが保護対象領域を編集できる場合は true。このフィールドは読み取り専用です。 |
unprotectedRanges[]
|
保護されているシート内の保護されていない範囲のリスト。保護されていない範囲は、保護されているシートでのみサポートされます。 |
editors
|
保護されている範囲への編集権限があるユーザーとグループです。この項目は、保護された範囲とドキュメントの編集権限を持つユーザーにのみ表示されます。 |
編集者
保護されている範囲の編集者。
JSON 表現 |
---|
{ "users": [ string ], "groups": [ string ], "domainUsersCanEdit": boolean } |
フィールド | |
---|---|
users[]
|
保護されている範囲に対する編集権限があるユーザーのメールアドレス。 |
groups[]
|
保護されている範囲への編集権限があるグループのメールアドレス。 |
domainUsersCanEdit
|
ドキュメントのドメイン内の誰もが保護された範囲への編集権限を持っている場合は true。ドメイン保護は、ドメイン内のドキュメントでのみサポートされます。 |
BasicFilter
シートに関連付けられているデフォルトのフィルタ。
JSON 表現 |
---|
{ "range": { object ( |
フィールド | |
---|---|
range
|
フィルタがカバーする範囲。 |
sortSpecs[]
|
列ごとの並べ替え順序。以前の仕様と値が等しい場合、後の仕様が使用されます。 |
criteria
|
列ごとに値を表示/非表示するための基準。マップのキーは列インデックスで、値はその列の条件です。
このフィールドは非推奨になりました。 |
filterSpecs[]
|
列ごとのフィルタ条件。
|
BandedRange
シートに帯状(代替色)の範囲。
JSON 表現 |
---|
{ "bandedRangeId": integer, "range": { object ( |
フィールド | |
---|---|
bandedRangeId
|
帯域の範囲の ID。 |
range
|
これらのプロパティが適用される範囲。 |
rowProperties
|
行バンドのプロパティ。これらのプロパティは、範囲内のすべての行にわたって行単位で適用されます。 |
columnProperties
|
列の帯域のプロパティ。これらのプロパティは、範囲内のすべての列にわたって、列ごとに適用されます。 |
BandingProperties
単一ディメンション(行または列)を参照するプロパティ。BandedRange.row_properties
と BandedRange.column_properties
の両方が設定されている場合、塗りつぶしの色は以下のルールに従ってセルに適用されます。
-
headerColor
とfooterColor
は、バンドの色よりも優先されます。 -
firstBandColor
はsecondBandColor
よりも優先されます。 -
rowProperties
はcolumnProperties
よりも優先されます。
最初の行の色は最初の列の色よりも優先されますが、最初の列の色は 2 番目の行の色よりも優先されます。同様に、行ヘッダーは左上のセルの列見出しよりも優先されますが、行ヘッダーが設定されていない場合は最初の行の色よりも優先されます。
JSON 表現 |
---|
{ "headerColor": { object ( |
フィールド | |
---|---|
headerColor
|
最初の行または列の色。このフィールドが設定されている場合、最初の行または列はこの色で塗りつぶされ、2 番目の行または列から始まる |
headerColorStyle
|
最初の行または列の色。このフィールドが設定されている場合、最初の行または列はこの色で塗りつぶされ、2 番目の行または列から始まる |
firstBandColor
|
交互になる最初の色です。(必須)非推奨: |
firstBandColorStyle
|
交互になる最初の色です。(必須) |
secondBandColor
|
交互になる 2 つ目の色です。(必須)非推奨: |
secondBandColorStyle
|
交互になる 2 つ目の色です。(必須) |
footerColor
|
最後の行または列の色。このフィールドが設定されていない場合、前の行または列の色に応じて、最後の行または列には |
footerColorStyle
|
最後の行または列の色。このフィールドが設定されていない場合、前の行または列の色に応じて、最後の行または列には |
ディメンション グループ
シート上の行または列の間隔に基づいたグループ。他のグループに含めることも、他のグループ内に含めることもできます。グループは、シート上で 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
|
フィルタが適用されるデータテーブルの 0 から始まる列インデックス。 |
applyToPivotTables
|
フィルタをピボット テーブルに適用する場合は true。指定しなかった場合のデフォルトは |
title
|
スライサーのタイトル。 |
textFormat
|
スライサー内のタイトルのテキスト形式。リンク フィールドはサポートされていません。 |
backgroundColor
|
スライサーの背景色。非推奨: |
backgroundColorStyle
|
スライサーの背景色。 |
horizontalAlignment
|
スライサー内のタイトルの水平方向の配置。指定しない場合のデフォルトは |