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)

The properties of the sheet.

object (GridData)

Data in the grid, if this is a grid sheet.

The number of GridData objects returned is dependent on the number of ranges requested on this sheet. For example, if this is representing Sheet1, and the spreadsheet was requested with ranges Sheet1!A1:C10 and Sheet1!D15:E20, then the first GridData will have a startRow / startColumn of 0, while the second one will have startRow 14 (zero-based row 15), and startColumn 3 (zero-based column D).

For a DATA_SOURCE sheet, you can not request a specific range, the GridData contains all the values.

object (GridRange)

The ranges that are merged together.

object (ConditionalFormatRule)

The conditional format rules in this sheet.

object (FilterView)

The filter views in this sheet.

object (ProtectedRange)

The protected ranges in this sheet.

object (BasicFilter)

The filter on this sheet, if any.

object (EmbeddedChart)

The specifications of every chart on this sheet.

object (BandedRange)

The banded (alternating colors) ranges on this sheet.

object (DeveloperMetadata)

The developer metadata associated with a sheet.

object (DimensionGroup)

All row groups on this sheet, ordered by increasing range start index, then by group depth.

object (DimensionGroup)

All column groups on this sheet, ordered by increasing range start index, then by group depth.

object (Slicer)

The slicers on this sheet.

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

The ID of the sheet. Must be non-negative. This field cannot be changed once set.

string

The name of the sheet.

integer

The index of the sheet within the spreadsheet. When adding or updating sheet properties, if this field is excluded then the sheet is added or moved to the end of the sheet list. When updating sheet indices or inserting sheets, movement is considered in "before the move" indexes. For example, if there were three sheets (S1, S2, S3) in order to move S1 ahead of S2 the index would have to be set to 2. A sheet index update request is ignored if the requested index is identical to the sheets current index or if the requested new index is equal to the current sheet index + 1.

enum (SheetType)

The type of sheet. Defaults to GRID. This field cannot be changed once set.

object (GridProperties)

Additional properties of the sheet if this sheet is a grid. (If the sheet is an object sheet, containing a chart or image, then this field will be absent.) When writing it is an error to set any grid properties on non-grid sheets.

If this sheet is a DATA_SOURCE sheet, this field is output only but contains the properties that reflect how a data source sheet is rendered in the UI, e.g. rowCount.

boolean

True if the sheet is hidden in the UI, false if it's visible.

object (Color)

The color of the tab in the UI. Deprecated: Use tabColorStyle.

object (ColorStyle)

The color of the tab in the UI. If tabColor is also set, this field takes precedence.

boolean

True if the sheet is an RTL sheet instead of an LTR sheet.

object (DataSourceSheetProperties)

Output only. If present, the field contains DATA_SOURCE sheet specific properties.

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

integer

The number of rows in the grid.

integer

The number of columns in the grid.

integer

The number of rows that are frozen in the grid.

integer

The number of columns that are frozen in the grid.

boolean

True if the grid isn't showing gridlines in the UI.

boolean

True if the row grouping control toggle is shown after the group.

boolean

True if the column grouping control toggle is shown after the group.

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

string

ID of the DataSource the sheet is connected to.

object (DataSourceColumn)

The columns displayed on the sheet, corresponding to the values in RowData.

object (DataExecutionStatus)

The data execution status.

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

integer

The first row this GridData refers to, zero-based.

integer

The first column this GridData refers to, zero-based.

object (RowData)

The data in the grid, one entry per row, starting with the row in startRow. The values in RowData will correspond to columns starting at startColumn.

object (DimensionProperties)

Metadata about the requested rows in the grid, starting with the row in startRow.

object (DimensionProperties)

Metadata about the requested columns in the grid, starting with the column in startColumn.

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

object (CellData)

The values in the row, one per column.

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

boolean

True if this dimension is being filtered. This field is read-only.

boolean

True if this dimension is explicitly hidden.

integer

The height (if a row) or width (if a column) of the dimension in pixels.

object (DeveloperMetadata)

The developer metadata associated with a single row or column.

object (DataSourceColumnReference)

Output only. If set, this is a column in a data source sheet.

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

The ranges that are formatted if the condition is true. All the ranges must be on the same grid.

object (BooleanRule)

The formatting is either "on" or "off" according to the rule.

object (GradientRule)

The formatting will vary based on the gradients in the rule.

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

object (BooleanCondition)

The condition of the rule. If the condition evaluates to true, the format is applied.

object (CellFormat)

The format to apply. Conditional formatting can only apply a subset of formatting: bold, italic, strikethrough, foreground color and, background color.

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

object (InterpolationPoint)

The starting interpolation point.

object (InterpolationPoint)

An optional midway interpolation point.

object (InterpolationPoint)

The final interpolation point.

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

object (Color)

The color this interpolation point should use. Deprecated: Use colorStyle.

object (ColorStyle)

The color this interpolation point should use. If color is also set, this field takes precedence.

enum (InterpolationPointType)

How the value should be interpreted.

string

The value this interpolation point uses. May be a formula. Unused if type is MIN or MAX.

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

integer

The ID of the filter view.

string

The name of the filter view.

object (GridRange)

The range this filter view covers.

When writing, only one of range or namedRangeId may be set.

string

The named range this filter view is backed by, if any.

When writing, only one of range or namedRangeId may be set.

object (SortSpec)

The sort order per column. Later specifications are used when values are equal in the earlier specifications.

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

The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column.

This field is deprecated in favor of filterSpecs.

object (FilterSpec)

The filter criteria for showing/hiding values per column.

Both criteria and filterSpecs are populated in responses. If both fields are specified in an update request, this field takes precedence.

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

integer

The ID of the protected range. This field is read-only.

object (GridRange)

The range that is being protected. The range may be fully unbounded, in which case this is considered a protected sheet.

When writing, only one of range or namedRangeId may be set.

string

The named range this protected range is backed by, if any.

When writing, only one of range or namedRangeId may be set.

string

The description of this protected range.

boolean

True if this protected range will show a warning when editing. Warning-based protection means that every user can edit data in the protected range, except editing will prompt a warning asking the user to confirm the edit.

When writing: if this field is true, then editors are ignored. Additionally, if this field is changed from true to false and the editors field is not set (nor included in the field mask), then the editors will be set to all the editors in the document.

boolean

True if the user who requested this protected range can edit the protected area. This field is read-only.

object (GridRange)

The list of unprotected ranges within a protected sheet. Unprotected ranges are only supported on protected sheets.

object (Editors)

The users and groups with edit access to the protected range. This field is only visible to users with edit access to the protected range and the document. Editors are not supported with warningOnly protection.

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

string

The email addresses of users with edit access to the protected range.

string

The email addresses of groups with edit access to the protected range.

boolean

True if anyone in the document's domain has edit access to the protected range. Domain protection is only supported on documents within a domain.

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

object (GridRange)

The range the filter covers.

object (SortSpec)

The sort order per column. Later specifications are used when values are equal in the earlier specifications.

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

The criteria for showing/hiding values per column. The map's key is the column index, and the value is the criteria for that column.

This field is deprecated in favor of filterSpecs.

object (FilterSpec)

The filter criteria per column.

Both criteria and filterSpecs are populated in responses. If both fields are specified in an update request, this field takes precedence.

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

integer

The ID of the banded range.

object (GridRange)

The range over which these properties are applied.

object (BandingProperties)

Properties for row bands. These properties are applied on a row-by-row basis throughout all the rows in the range. At least one of rowProperties or columnProperties must be specified.

object (BandingProperties)

Properties for column bands. These properties are applied on a column- by-column basis throughout all the columns in the range. At least one of rowProperties or columnProperties must be specified.

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

The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between firstBandColor and secondBandColor starting from the second row or column. Otherwise, the first row or column is filled with firstBandColor and the colors proceed to alternate as they normally would. Deprecated: Use headerColorStyle.

object (ColorStyle)

The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between firstBandColor and secondBandColor starting from the second row or column. Otherwise, the first row or column is filled with firstBandColor and the colors proceed to alternate as they normally would. If headerColor is also set, this field takes precedence.

object (Color)

The first color that is alternating. (Required) Deprecated: Use firstBandColorStyle.

object (ColorStyle)

The first color that is alternating. (Required) If firstBandColor is also set, this field takes precedence.

object (Color)

The second color that is alternating. (Required) Deprecated: Use secondBandColorStyle.

object (ColorStyle)

The second color that is alternating. (Required) If secondBandColor is also set, this field takes precedence.

object (Color)

The color of the last row or column. If this field is not set, the last row or column is filled with either firstBandColor or secondBandColor, depending on the color of the previous row or column. Deprecated: Use footerColorStyle.

object (ColorStyle)

The color of the last row or column. If this field is not set, the last row or column is filled with either firstBandColor or secondBandColor, depending on the color of the previous row or column. If footerColor is also set, this field takes precedence.

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

object (DimensionRange)

The range over which this group exists.

integer

The depth of the group, representing how many groups have a range that wholly contains the range of this group.

boolean

This field is true if this group is collapsed. A collapsed group remains collapsed if an overlapping group at a shallower depth is expanded.

A true value does not imply that all dimensions within the group are hidden, since a dimension's visibility can change independently from this group property. However, when this property is updated, all dimensions within it are set to hidden if this field is true, or set to visible if this field is false.

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

integer

The ID of the slicer.

object (SlicerSpec)

The specification of the slicer.

object (EmbeddedObjectPosition)

The position of the slicer. Note that slicer can be positioned only on existing sheet. Also, width and height of slicer can be automatically adjusted to keep it within permitted limits.

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

The data range of the slicer.

object (FilterCriteria)

The filtering criteria of the slicer.

integer

The zero-based column index in the data table on which the filter is applied to.

boolean

True if the filter should apply to pivot tables. If not set, default to True.

string

The title of the slicer.

object (TextFormat)

The text format of title in the slicer. The link field is not supported.

object (Color)

The background color of the slicer. Deprecated: Use backgroundColorStyle.

object (ColorStyle)

The background color of the slicer. If backgroundColor is also set, this field takes precedence.

enum (HorizontalAlign)

The horizontal alignment of title in the slicer. If unspecified, defaults to LEFT