シート
スプレッドシート内のシート。
JSON 表現 |
---|
{ "properties": { object ( |
フィールド | |
---|---|
properties
|
シートのプロパティ。 |
data[]
|
グリッド内のデータ(グリッドシートの場合)。
返される GridData オブジェクトの数は、このシートでリクエストされた範囲の数によって異なります。たとえば、このログが
1 つの
|
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
|
スプレッドシート内のシートのインデックス。シートのプロパティを追加または更新する際、このフィールドが除外されている場合、シートはシートリストの最後に追加または移動されます。シート インデックスの更新やシートの挿入を行う際、「移動前」で移動が考慮される作成します。たとえば、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
|
アプリケーションの ID
|
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
は次のいずれか 1 つのみを指定できます。
|
|
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
|
補間ポイントは、条件付き書式の範囲内のすべてのセルに対する指定のパーセンタイルです。これは次と同等です。
NUMBER
値が次に該当するかどうかを確認します。
=PERCENTILE(FLATTEN(range), value / 100)
(フラット化する際に範囲内のエラーが無視される)。
|
FilterView
フィルタ表示。
JSON 表現 |
---|
{ "filterViewId": integer, "title": string, "range": { object ( |
フィールド | |
---|---|
filterViewId
|
フィルタビューの ID。 |
title
|
フィルタ表示の名前。 |
range
|
このフィルタ表示がカバーする範囲です。
記述するときは、次のいずれか 1 つだけを
|
namedRangeId
|
このフィルタビューの基盤となる名前付き範囲(存在する場合)。
記述するときは、次のいずれか 1 つだけを
|
sortSpecs[]
|
列ごとの並べ替え順。前の仕様と値が等しい場合は、後の仕様が使用されます。 |
criteria
|
列ごとの値の表示/非表示の条件。マップのキーは列のインデックスで、値はその列の条件です。
このフィールドのサポートは終了し、
|
filterSpecs[]
|
列の値を表示/非表示にするためのフィルタ条件。
両方
|
ProtectedRange
保護されている範囲。
JSON 表現 |
---|
{ "protectedRangeId": integer, "range": { object ( |
フィールド | |
---|---|
protectedRangeId
|
保護されている範囲の ID。このフィールドは読み取り専用です。 |
range
|
保護されている範囲。範囲に完全に制限がない場合、保護されているシートと見なされます。
記述するときは、次のいずれか 1 つだけを
|
namedRangeId
|
この保護されている範囲の基になる名前付き範囲(存在する場合)。
記述するときは、次のいずれか 1 つだけを
|
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
|
行バンドのプロパティ。これらのプロパティは、範囲内のすべての行にわたって、行単位で適用されます。少なくとも 1 つ
|
columnProperties
|
列バンドのプロパティ。これらのプロパティは、範囲内のすべての列に対して、列ごとに適用されます。少なくとも 1 つ
|
BandingProperties
単一のディメンション(行または列)を参照するプロパティ。両方が
BandedRange.row_properties
および
BandedRange.column_properties
が設定されている場合、以下のルールに従って塗りつぶしの色がセルに適用されます。
-
headerColor
およびfooterColor
バンドの色よりも優先されます。 -
firstBandColor
より優先度が高いsecondBandColor
。 -
rowProperties
より優先度が高いcolumnProperties
。
たとえば、1 行目の色は 1 列目の色よりも優先されますが、1 列目の色は 2 行目の色よりも優先されます。同様に、左上のセルの列ヘッダーよりも行ヘッダーが優先されます。行ヘッダーが設定されていない場合、列ヘッダーは最初の行の色よりも優先されます。
JSON 表現 |
---|
{ "headerColor": { object ( |
フィールド | |
---|---|
headerColor
|
最初の行または列の色。このフィールドが設定されている場合、最初の行または列はこの色で塗りつぶされ、色が交互に表示されます
|
headerColorStyle
|
最初の行または列の色。このフィールドが設定されている場合、最初の行または列はこの色で塗りつぶされ、色が交互に表示されます。
|
firstBandColor
|
交互になる 1 つ目の色です。(必須)非推奨: 使用
|
firstBandColorStyle
|
交互になる 1 つ目の色です。(必須)次の場合
|
secondBandColor
|
交互の 2 つ目の色です。(必須)非推奨: 使用
|
secondBandColorStyle
|
交互になる 2 つ目の色です。(必須)次の場合
|
footerColor
|
最後の行または列の色。このフィールドが設定されていない場合、最後の行または列にはいずれかの文字列が入力されます。
|
footerColorStyle
|
最後の行または列の色。このフィールドが設定されていない場合、最後の行または列には次のいずれかが入力されます。
|
DimensionGroup
シート上の行または列の間隔を区切るグループ。他のグループに含めることも、他のグループに含めることもできます。グループは、シート上で 1 つのユニットとして折りたたんだり展開したりできます。
JSON 表現 |
---|
{
"range": {
object (
|
フィールド | |
---|---|
range
|
このグループが存在する範囲。 |
depth
|
グループの深度。このグループの範囲全体を含む範囲を持つグループの数を表します。 |
collapsed
|
このフィールドは、このグループが折りたたまれている場合に true になります。浅い階層で重複するグループを展開すると、閉じたグループは閉じたままになります。 ディメンションの公開設定は、このグループ プロパティとは独立して変更される可能性があるため、true 値がグループ内のすべてのディメンションが非表示になるわけではありません。ただし、このプロパティを更新すると、このフィールドが true の場合は、その中のすべてのディメンションが非表示に設定されます。このフィールドが false の場合は、visible に設定されます。 |
スライサー
シート内のスライサー。
JSON 表現 |
---|
{ "slicerId": integer, "spec": { object ( |
フィールド | |
---|---|
slicerId
|
スライサーの ID。 |
spec
|
スライサーの仕様。 |
position
|
スライサーの位置。スライサーは既存のシートにのみ配置できます。また、スライサーの幅と高さを上限内に収まるように自動的に調整できます。 |
SlicerSpec
スライサーの仕様。
JSON 表現 |
---|
{ "dataRange": { object ( |
フィールド | |
---|---|
dataRange
|
スライサーのデータ範囲です。 |
filterCriteria
|
スライサーのフィルタ条件。 |
columnIndex
|
フィルタが適用されるデータテーブルの 0 ベースの列インデックス。 |
applyToPivotTables
|
フィルタをピボット テーブルに適用する場合は true。設定しない場合のデフォルト
|
title
|
スライサーのタイトル。 |
textFormat
|
スライサー内のタイトルのテキスト形式。このリンク フィールドはサポートされていません。 |
backgroundColor
|
スライサーの背景色。非推奨: 使用
|
backgroundColorStyle
|
スライサーの背景色。条件
|
horizontalAlignment
|
スライサー内のタイトルの水平方向の配置。指定しない場合のデフォルト
|