Sheets

{
  "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)
    }
  ]
}

object (SheetProperties)

シートのプロパティ。

object (GridData)

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

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

1 つの DATA_SOURCE 特定の範囲をリクエストすることはできません。GridData にはすべての値が含まれます。

object (GridRange)

結合される範囲。

object (ConditionalFormatRule)

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

object (FilterView)

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

object (ProtectedRange)

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

object (BasicFilter)

このシートのフィルタ（ある場合）。

object (EmbeddedChart)

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

object (BandedRange)

このシートの縞模様（交互の背景色）の範囲。

object (DeveloperMetadata)

シートに関連付けられているデベロッパー メタデータ。

object (DimensionGroup)

このシート上のすべての行グループを、範囲開始インデックスの大きい順に並べて、次にグループの深さの順に並べます。

object (DimensionGroup)

このシート上のすべての列グループを、範囲開始インデックスの大きい順に並べて、次にグループの深さの順に並べます。

object (Slicer)

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

{
  "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)
  }
}

integer

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

string

シートの名前。

integer

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

enum (SheetType)

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

object (GridProperties)

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

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

boolean

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

object (Color)

UI のタブの色。非推奨: 使用 tabColorStyle。

object (ColorStyle)

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

boolean

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

object (DataSourceSheetProperties)

出力専用。存在する場合、フィールドには以下が含まれます。 DATA_SOURCE スプレッドシート固有のプロパティを指定します。

{
  "rowCount": integer,
  "columnCount": integer,
  "frozenRowCount": integer,
  "frozenColumnCount": integer,
  "hideGridlines": boolean,
  "rowGroupControlAfter": boolean,
  "columnGroupControlAfter": boolean
}

integer

グリッド内の行数。

integer

グリッド内の列の数。

integer

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

integer

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

boolean

UI でグリッドにグリッド線を表示していない場合は true に設定します。

boolean

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

boolean

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

{
  "dataSourceId": string,
  "columns": [
    {
      object (DataSourceColumn)
    }
  ],
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}

string

アプリケーションの ID DataSource スプレッドシートが接続されています。

object (DataSourceColumn)

スプレッドシートに表示される列（ RowData。

object (DataExecutionStatus)

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

{
  "startRow": integer,
  "startColumn": integer,
  "rowData": [
    {
      object (RowData)
    }
  ],
  "rowMetadata": [
    {
      object (DimensionProperties)
    }
  ],
  "columnMetadata": [
    {
      object (DimensionProperties)
    }
  ]
}

integer

この GridData が参照する最初の行は、ゼロベースです。

integer

この GridData が参照する最初の列は、ゼロベースです。

object (RowData)

グリッド内のデータで、行あたり 1 エントリ（startRow の行から開始）。RowData の値は、 startColumn。

object (DimensionProperties)

グリッド内のリクエストされた行に関するメタデータ（ startRow。

object (DimensionProperties)

グリッド内のリクエストされた列に関するメタデータ（ startColumn。

{
  "values": [
    {
      object (CellData)
    }
  ]
}

object (CellData)

行の値（列ごとに 1 つ）。

{
  "hiddenByFilter": boolean,
  "hiddenByUser": boolean,
  "pixelSize": integer,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
}

boolean

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

boolean

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

integer

ピクセル単位のサイズの高さ（行の場合）または幅（列の場合）。

object (DeveloperMetadata)

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

object (DataSourceColumnReference)

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

{
  "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.
}

object (GridRange)

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

object (BooleanRule)

形式は「オン」か「オフ」ルールに従って作成されます。

object (GradientRule)

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

{
  "condition": {
    object (BooleanCondition)
  },
  "format": {
    object (CellFormat)
  }
}

object (BooleanCondition)

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

object (CellFormat)

適用する形式。条件付き書式では、書式のサブセットのみを適用できます。 bold, italic, strikethrough, foreground color および background color。

{
  "minpoint": {
    object (InterpolationPoint)
  },
  "midpoint": {
    object (InterpolationPoint)
  },
  "maxpoint": {
    object (InterpolationPoint)
  }
}

object (InterpolationPoint)

補間の開始点。

object (InterpolationPoint)

オプションの中間補間点。

object (InterpolationPoint)

最後の補間点。

{
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  },
  "type": enum (InterpolationPointType),
  "value": string
}

object (Color)

この補間ポイントで使用する色。非推奨: 使用 colorStyle。

object (ColorStyle)

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

enum (InterpolationPointType)

値の解釈方法。

string

この補間ポイントで使用される値。数式を指定できます。次の場合は使用されない type MIN または MAX。

{
  "filterViewId": integer,
  "title": string,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}

integer

フィルタビューの ID。

string

フィルタ表示の名前。

object (GridRange)

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

記述するときは、次のいずれか 1 つだけを range または namedRangeId 設定できます。

string

このフィルタビューの基盤となる名前付き範囲（存在する場合）。

記述するときは、次のいずれか 1 つだけを range または namedRangeId 設定できます。

object (SortSpec)

列ごとの並べ替え順。前の仕様と値が等しい場合は、後の仕様が使用されます。

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

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

このフィールドのサポートは終了し、 filterSpecs。

object (FilterSpec)

列の値を表示/非表示にするためのフィルタ条件。

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

{
  "protectedRangeId": integer,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "description": string,
  "warningOnly": boolean,
  "requestingUserCanEdit": boolean,
  "unprotectedRanges": [
    {
      object (GridRange)
    }
  ],
  "editors": {
    object (Editors)
  }
}

integer

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

object (GridRange)

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

記述するときは、次のいずれか 1 つだけを range または namedRangeId 設定できます。

string

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

記述するときは、次のいずれか 1 つだけを range または namedRangeId 設定できます。

string

この保護されている範囲の説明。

boolean

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

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

boolean

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

object (GridRange)

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

object (Editors)

保護されている範囲に対する編集権限を持つユーザーとグループ。このフィールドは、保護されている範囲とドキュメントに対する編集権限を持つユーザーにのみ表示されます。エディタは warningOnly 保護を強化します。

{
  "users": [
    string
  ],
  "groups": [
    string
  ],
  "domainUsersCanEdit": boolean
}

string

保護されている範囲に対する編集権限を持つユーザーのメールアドレス。

string

保護されている範囲に対する編集権限を持つグループのメールアドレス。

boolean

ドキュメントのドメイン内のすべてのユーザーに、保護された範囲に対する編集権限がある場合は true。ドメイン保護は、ドメイン内のドキュメントでのみサポートされます。

{
  "range": {
    object (GridRange)
  },
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}

object (GridRange)

フィルタの対象となる範囲。

object (SortSpec)

列ごとの並べ替え順。前の仕様と値が等しい場合は、後の仕様が使用されます。

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

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

このフィールドのサポートは終了し、 filterSpecs。

object (FilterSpec)

列あたりのフィルタ条件。

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

{
  "bandedRangeId": integer,
  "range": {
    object (GridRange)
  },
  "rowProperties": {
    object (BandingProperties)
  },
  "columnProperties": {
    object (BandingProperties)
  }
}

integer

バンド付き範囲の ID。

object (GridRange)

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

object (BandingProperties)

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

object (BandingProperties)

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

{
  "headerColor": {
    object (Color)
  },
  "headerColorStyle": {
    object (ColorStyle)
  },
  "firstBandColor": {
    object (Color)
  },
  "firstBandColorStyle": {
    object (ColorStyle)
  },
  "secondBandColor": {
    object (Color)
  },
  "secondBandColorStyle": {
    object (ColorStyle)
  },
  "footerColor": {
    object (Color)
  },
  "footerColorStyle": {
    object (ColorStyle)
  }
}

object (Color)

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

object (ColorStyle)

最初の行または列の色。このフィールドが設定されている場合、最初の行または列はこの色で塗りつぶされ、色が交互に表示されます。 firstBandColor および secondBandColor 最初の行または列から値を抽出できますそれ以外の場合は、最初の行または列に firstBandColor 色は通常どおり交互に変化します条件 headerColor 設定されている場合は、このフィールドが優先されます。

object (Color)

交互になる 1 つ目の色です。（必須）非推奨: 使用 firstBandColorStyle。

object (ColorStyle)

交互になる 1 つ目の色です。（必須）次の場合 firstBandColor 設定されている場合は、このフィールドが優先されます。

object (Color)

交互の 2 つ目の色です。（必須）非推奨: 使用 secondBandColorStyle。

object (ColorStyle)

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

object (Color)

最後の行または列の色。このフィールドが設定されていない場合、最後の行または列にはいずれかの文字列が入力されます。 firstBandColor または secondBandColor（前の行または列の色に応じて異なります）。非推奨: 使用 footerColorStyle。

object (ColorStyle)

最後の行または列の色。このフィールドが設定されていない場合、最後の行または列には次のいずれかが入力されます。 firstBandColor または secondBandColor（前の行または列の色に応じて異なります）。条件 footerColor 設定されている場合は、このフィールドが優先されます。

{
  "range": {
    object (DimensionRange)
  },
  "depth": integer,
  "collapsed": boolean
}

object (DimensionRange)

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

integer

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

boolean

このフィールドは、このグループが折りたたまれている場合に true になります。浅い階層で重複するグループを展開すると、閉じたグループは閉じたままになります。

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

{
  "slicerId": integer,
  "spec": {
    object (SlicerSpec)
  },
  "position": {
    object (EmbeddedObjectPosition)
  }
}

integer

スライサーの ID。

object (SlicerSpec)

スライサーの仕様。

object (EmbeddedObjectPosition)

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

{
  "dataRange": {
    object (GridRange)
  },
  "filterCriteria": {
    object (FilterCriteria)
  },
  "columnIndex": integer,
  "applyToPivotTables": boolean,
  "title": string,
  "textFormat": {
    object (TextFormat)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "horizontalAlignment": enum (HorizontalAlign)
}

object (GridRange)

スライサーのデータ範囲です。

object (FilterCriteria)

スライサーのフィルタ条件。

integer

フィルタが適用されるデータテーブルの 0 ベースの列インデックス。

boolean

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

string

スライサーのタイトル。

object (TextFormat)

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

object (Color)

スライサーの背景色。非推奨: 使用 backgroundColorStyle。

object (ColorStyle)

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

enum (HorizontalAlign)

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