Cells

{
  "userEnteredValue": {
    object (ExtendedValue)
  },
  "effectiveValue": {
    object (ExtendedValue)
  },
  "formattedValue": string,
  "userEnteredFormat": {
    object (CellFormat)
  },
  "effectiveFormat": {
    object (CellFormat)
  },
  "hyperlink": string,
  "note": string,
  "textFormatRuns": [
    {
      object (TextFormatRun)
    }
  ],
  "dataValidation": {
    object (DataValidationRule)
  },
  "pivotTable": {
    object (PivotTable)
  },
  "dataSourceTable": {
    object (DataSourceTable)
  },
  "dataSourceFormula": {
    object (DataSourceFormula)
  }
}

object (ExtendedValue)

The value the user entered in the cell. e.g., 1234, 'Hello', or =NOW() Note: Dates, Times and DateTimes are represented as doubles in serial number format.

object (ExtendedValue)

The effective value of the cell. For cells with formulas, this is the calculated value. For cells with literals, this is the same as the userEnteredValue. This field is read-only.

string

The formatted value of the cell. This is the value as it's shown to the user. This field is read-only.

object (CellFormat)

The format the user entered for the cell.

When writing, the new format will be merged with the existing format.

object (CellFormat)

The effective format being used by the cell. This includes the results of applying any conditional formatting and, if the cell contains a formula, the computed number format. If the effective format is the default format, effective format will not be written. This field is read-only.

string

A hyperlink this cell points to, if any. If the cell contains multiple hyperlinks, this field will be empty. This field is read-only. To set it, use a =HYPERLINK formula in the userEnteredValue.formulaValue field. A cell-level link can also be set from the userEnteredFormat.textFormat field. Alternatively, set a hyperlink in the textFormatRun.format.link field that spans the entire cell.

string

Any note on the cell.

object (TextFormatRun)

Runs of rich text applied to subsections of the cell. Runs are only valid on user entered strings, not formulas, bools, or numbers. Properties of a run start at a specific index in the text and continue until the next run. Runs will inherit the properties of the cell unless explicitly changed.

When writing, the new runs will overwrite any prior runs. When writing a new userEnteredValue, previous runs are erased.

object (DataValidationRule)

A data validation rule on the cell, if any.

When writing, the new data validation rule will overwrite any prior rule.

object (PivotTable)

A pivot table anchored at this cell. The size of pivot table itself is computed dynamically based on its data, grouping, filters, values, etc. Only the top-left cell of the pivot table contains the pivot table definition. The other cells will contain the calculated values of the results of the pivot in their effectiveValue fields.

object (DataSourceTable)

A data source table anchored at this cell. The size of data source table itself is computed dynamically based on its configuration. Only the first cell of the data source table contains the data source table definition. The other cells will contain the display values of the data source table result in their effectiveValue fields.

object (DataSourceFormula)

Output only. Information about a data source formula on the cell. The field is set if userEnteredValue is a formula referencing some DATA_SOURCE sheet, e.g. =SUM(DataSheet!Column).

{
  "numberFormat": {
    object (NumberFormat)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "borders": {
    object (Borders)
  },
  "padding": {
    object (Padding)
  },
  "horizontalAlignment": enum (HorizontalAlign),
  "verticalAlignment": enum (VerticalAlign),
  "wrapStrategy": enum (WrapStrategy),
  "textDirection": enum (TextDirection),
  "textFormat": {
    object (TextFormat)
  },
  "hyperlinkDisplayType": enum (HyperlinkDisplayType),
  "textRotation": {
    object (TextRotation)
  }
}

object (NumberFormat)

A format describing how number values should be represented to the user.

object (Color)

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

object (ColorStyle)

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

object (Borders)

The borders of the cell.

object (Padding)

The padding of the cell.

enum (HorizontalAlign)

The horizontal alignment of the value in the cell.

enum (VerticalAlign)

The vertical alignment of the value in the cell.

enum (WrapStrategy)

The wrap strategy for the value in the cell.

enum (TextDirection)

The direction of the text in the cell.

object (TextFormat)

The format of the text in the cell (unless overridden by a format run). Setting a cell-level link here clears the cell's existing links. Setting the link field in a TextFormatRun takes precedence over the cell-level link.

enum (HyperlinkDisplayType)

If one exists, how a hyperlink should be displayed in the cell.

object (TextRotation)

The rotation applied to text in the cell.

{
  "type": enum (NumberFormatType),
  "pattern": string
}

enum (NumberFormatType)

The type of the number format. When writing, this field must be set.

string

Pattern string used for formatting. If not set, a default pattern based on the user's locale will be used if necessary for the given type. See the Date and Number Formats guide for more information about the supported patterns.

{
  "top": {
    object (Border)
  },
  "bottom": {
    object (Border)
  },
  "left": {
    object (Border)
  },
  "right": {
    object (Border)
  }
}

object (Border)

The top border of the cell.

object (Border)

The bottom border of the cell.

object (Border)

The left border of the cell.

object (Border)

The right border of the cell.

{
  "style": enum (Style),
  "width": integer,
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  }
}

enum (Style)

The style of the border.

integer

The width of the border, in pixels. Deprecated; the width is determined by the "style" field.

object (Color)

The color of the border. Deprecated: Use colorStyle.

object (ColorStyle)

The color of the border. If color is also set, this field takes precedence.

{
  "top": integer,
  "right": integer,
  "bottom": integer,
  "left": integer
}

integer

The top padding of the cell.

integer

The right padding of the cell.

integer

The bottom padding of the cell.

integer

The left padding of the cell.

{

  // Union field type can be only one of the following:
  "angle": integer,
  "vertical": boolean
  // End of list of possible types for union field type.
}

integer

The angle between the standard orientation and the desired orientation. Measured in degrees. Valid values are between -90 and 90. Positive angles are angled upwards, negative are angled downwards.

Note: For LTR text direction positive angles are in the counterclockwise direction, whereas for RTL they are in the clockwise direction

boolean

If true, text reads top to bottom, but the orientation of individual characters is unchanged. For example:

| V |
| e |
| r |
| t |
| i |
| c |
| a |
| l |

{
  "startIndex": integer,
  "format": {
    object (TextFormat)
  }
}

integer

The zero-based character index where this run starts, in UTF-16 code units.

object (TextFormat)

The format of this run. Absent values inherit the cell's format.

{
  "condition": {
    object (BooleanCondition)
  },
  "inputMessage": string,
  "strict": boolean,
  "showCustomUi": boolean
}

object (BooleanCondition)

The condition that data in the cell must match.

string

A message to show the user when adding data to the cell.

boolean

True if invalid data should be rejected.

boolean

True if the UI should be customized based on the kind of condition. If true, "List" conditions will show a dropdown.

{
  "dataSourceId": string,
  "columnSelectionType": enum (DataSourceTableColumnSelectionType),
  "columns": [
    {
      object (DataSourceColumnReference)
    }
  ],
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ],
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "rowLimit": integer,
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}

string

The ID of the data source the data source table is associated with.

enum (DataSourceTableColumnSelectionType)

The type to select columns for the data source table. Defaults to SELECTED.

object (DataSourceColumnReference)

Columns selected for the data source table. The columnSelectionType must be SELECTED.

object (FilterSpec)

Filter specifications in the data source table.

object (SortSpec)

Sort specifications in the data source table. The result of the data source table is sorted based on the sort specifications in order.

integer

The limit of rows to return. If not set, a default limit is applied. Please refer to the Sheets editor for the default and max limit.

object (DataExecutionStatus)

Output only. The data execution status.

{
  "dataSourceId": string,
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}

string

The ID of the data source the formula is associated with.

object (DataExecutionStatus)

Output only. The data execution status.