Google Sheets API Schemas

This directory contains JSON schema definitions for various objects used in the Google Sheets API.

(Last generated: 2025-04-07)

Schema Files

File	Description
BigQueryDataSourceSpec.json	The specification of a BigQuery data source that's connected to a sheet.
BigQueryQuerySpec.json	Specifies a custom BigQuery query.
BigQueryTableSpec.json	Specifies a BigQuery table definition. Only native tables are allowed.
BooleanCondition.json	A condition that can evaluate to true or false. Used by conditional formatting, data validation, and filters.
BooleanRule.json	A rule that may or may not match, depending on the condition.
Border.json	A border along a cell.
Borders.json	The borders of the cell.
CellData.json	Data about a specific cell.
CellFormat.json	The format of a cell.
Color.json	Represents a color in the RGBA color space. Assumes sRGB color space by default. Fields can be trivially provided to constructors in various languages (e.g., java.awt.Color, UIColor).
ColorStyle.json	A color value, which can be either an RGB color or a theme color.
ConditionType.json	The type of condition.
ConditionValue.json	The value of the condition.
ConditionalFormatRule.json	A rule describing a conditional format.
DataSource.json	Information about an external data source in the spreadsheet.
DataSourceParameter.json	A parameter in a data source's query. Allows passing values from the spreadsheet into a query.
DataSourceRefreshDailySchedule.json	A schedule for data to refresh every day in a given time interval.
DataSourceRefreshMonthlySchedule.json	A monthly schedule for data to refresh on specific days in the month in a given time interval.
DataSourceRefreshSchedule.json	Schedule for refreshing the data source.
DataSourceRefreshScope.json	The data source refresh scopes.
DataSourceRefreshWeeklySchedule.json	A weekly schedule for data to refresh on specific days in a given time interval.
DataSourceSpec.json	Specifies the details of the data source.
DataValidationRule.json	A data validation rule.
DayOfWeek.json	Represents a day of the week.
DeveloperMetadata.json	Developer metadata associated with a location or object in a spreadsheet.
DeveloperMetadataLocation.json	A location where metadata may be associated in a spreadsheet.
DeveloperMetadataLocationType.json	An enumeration of the types of locations on which developer metadata may be associated.
DeveloperMetadataVisibility.json	An enumeration of possible metadata visibilities.
DimensionProperties.json	Properties about a dimension (row or column).
DimensionRange.json	A range along a single dimension on a sheet. All indexes are zero-based. Indexes are half open: the start index is inclusive and the end index is exclusive. Missing indexes indicate the range is unbounded on that side.
ErrorType.json	The type of error.
ErrorValue.json	An error in a cell.
ExtendedValue.json	The kinds of value that a cell in a spreadsheet can have.
GradientRule.json	A rule that applies a gradient color scale format, based on the interpolation points listed. The format of a cell will vary based on its contents as compared to the values of the interpolation points.
GridData.json	Data in the grid, as well as metadata about the dimensions.
GridProperties.json	Properties of a grid.
GridRange.json	A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive -- [startIndex, endIndex). Missing indexes indicate the range is unbounded on that side.
HorizontalAlign.json	The horizontal alignment of text in a cell.
HyperlinkDisplayType.json	Whether to explicitly render a hyperlink. If not specified, the hyperlink is linked.
InterpolationPoint.json	A single interpolation point on a gradient conditional format. These pin the gradient color scale according to the color, type and value chosen.
InterpolationPointType.json	The kind of interpolation point.
Interval.json	Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).
IterativeCalculationSettings.json	Settings to control how circular dependencies are resolved with iterative calculation.
Link.json	An external or local reference.
LookerDataSourceSpec.json	The specification of a Looker data source.
NamedRange.json	A named range.
NumberFormat.json	The number format of a cell.
NumberFormatType.json	The type of number format. Actual rendering depends on the spreadsheet's locale (assumed en_US in documentation).
Padding.json	The amount of padding around the cell, in pixels. When updating padding, every field must be specified.
RecalculationInterval.json	An enumeration of the possible recalculation interval options.
RelativeDate.json	Controls how a date condition is evaluated based on the current date.
RowData.json	Data about each cell in a row.
Sheet.json	A sheet in a spreadsheet.
SheetProperties.json	Properties of a sheet.
SheetType.json	The kind of sheet.
Spreadsheet.json	Resource that represents a spreadsheet.
SpreadsheetProperties.json	Properties of a spreadsheet.
SpreadsheetTheme.json	Represents spreadsheet theme.
Style.json	The style of a border.
TextDirection.json	The direction of text in a cell.
TextFormat.json	The format of a run of text in a cell. Absent values indicate that the field isn't specified.
TextFormatRun.json	A run of a text format. The format of this run continues until the start index of the next run. When updating, all fields must be set.
TextRotation.json	The rotation applied to text in a cell.
ThemeColorPair.json	A pair mapping a spreadsheet theme color type to the concrete color it represents.
ThemeColorType.json	The type of theme color.
TimeOfDay.json	Represents a time of day. The date and time zone are either not significant or are specified elsewhere.
VerticalAlign.json	The vertical alignment of text in a cell.
WrapStrategy.json	How to wrap text in a cell.

Relationships

This diagram shows how the different schema objects reference each other.

graph TD
    classDef core fill:#f9f,stroke:#333,stroke-width:2px,color:#000,font-weight:bold;
    classDef format fill:#ccf,stroke:#333,stroke-width:1px,color:#000,font-weight:bold;
    classDef rule fill:#fcc,stroke:#333,stroke-width:1px,color:#000,font-weight:bold;
    classDef datasource fill:#cfc,stroke:#333,stroke-width:1px,color:#000,font-weight:bold;
    classDef metadata fill:#ffc,stroke:#333,stroke-width:1px,color:#000,font-weight:bold;
    classDef range fill:#cff,stroke:#333,stroke-width:1px,color:#000,font-weight:bold;
    classDef enum fill:#eee,stroke:#666,stroke-width:1px,color:#000,font-weight:bold;
    classDef default fill:#fff,stroke:#333,stroke-width:1px,color:#000,font-weight:bold;

    BigQueryDataSourceSpec --> BigQueryQuerySpec;
    class BigQueryQuerySpec datasource;
    BigQueryDataSourceSpec --> BigQueryTableSpec;
    class BigQueryTableSpec datasource;
    class BigQueryDataSourceSpec datasource;
    BooleanCondition --> ConditionType;
    class ConditionType rule;
    BooleanCondition --> ConditionValue;
    class ConditionValue rule;
    class BooleanCondition rule;
    BooleanRule --> BooleanCondition;
    class BooleanCondition rule;
    BooleanRule --> CellFormat;
    class CellFormat format;
    class BooleanRule rule;
    Border --> Style;
    class Style format;
    Border --> Color;
    class Color format;
    Border --> ColorStyle;
    class ColorStyle format;
    class Border format;
    Borders --> Border;
    class Border format;
    class Borders format;
    CellData --> ExtendedValue;
    class ExtendedValue core;
    CellData --> CellFormat;
    class CellFormat format;
    CellData --> TextFormatRun;
    class TextFormatRun format;
    CellData --> DataValidationRule;
    class DataValidationRule rule;
    class CellData core;
    CellFormat --> NumberFormat;
    class NumberFormat format;
    CellFormat --> Color;
    class Color format;
    CellFormat --> ColorStyle;
    class ColorStyle format;
    CellFormat --> Borders;
    class Borders format;
    CellFormat --> Padding;
    class Padding format;
    CellFormat --> HorizontalAlign;
    class HorizontalAlign enum;
    CellFormat --> VerticalAlign;
    class VerticalAlign enum;
    CellFormat --> WrapStrategy;
    class WrapStrategy enum;
    CellFormat --> TextDirection;
    class TextDirection enum;
    CellFormat --> TextFormat;
    class TextFormat format;
    CellFormat --> HyperlinkDisplayType;
    class HyperlinkDisplayType enum;
    CellFormat --> TextRotation;
    class TextRotation format;
    class CellFormat format;
    ColorStyle --> Color;
    class Color format;
    ColorStyle --> ThemeColorType;
    class ThemeColorType format;
    class ColorStyle format;
    ConditionValue --> RelativeDate;
    class RelativeDate enum;
    class ConditionValue rule;
    ConditionalFormatRule --> GridRange;
    class GridRange range;
    ConditionalFormatRule --> BooleanRule;
    class BooleanRule rule;
    ConditionalFormatRule --> GradientRule;
    class GradientRule rule;
    class ConditionalFormatRule format;
    DataSource --> DataSourceSpec;
    class DataSourceSpec datasource;
    class DataSource datasource;
    DataSourceParameter --> GridRange;
    class GridRange range;
    class DataSourceParameter datasource;
    DataSourceRefreshDailySchedule --> TimeOfDay;
    class TimeOfDay enum;
    class DataSourceRefreshDailySchedule datasource;
    DataSourceRefreshMonthlySchedule --> TimeOfDay;
    class TimeOfDay enum;
    class DataSourceRefreshMonthlySchedule datasource;
    DataSourceRefreshSchedule --> DataSourceRefreshScope;
    class DataSourceRefreshScope datasource;
    DataSourceRefreshSchedule --> Interval;
    class Interval enum;
    DataSourceRefreshSchedule --> DataSourceRefreshDailySchedule;
    class DataSourceRefreshDailySchedule datasource;
    DataSourceRefreshSchedule --> DataSourceRefreshWeeklySchedule;
    class DataSourceRefreshWeeklySchedule datasource;
    DataSourceRefreshSchedule --> DataSourceRefreshMonthlySchedule;
    class DataSourceRefreshMonthlySchedule datasource;
    class DataSourceRefreshSchedule datasource;
    DataSourceRefreshWeeklySchedule --> TimeOfDay;
    class TimeOfDay enum;
    DataSourceRefreshWeeklySchedule --> DayOfWeek;
    class DayOfWeek default;
    class DataSourceRefreshWeeklySchedule datasource;
    DataSourceSpec --> DataSourceParameter;
    class DataSourceParameter datasource;
    DataSourceSpec --> BigQueryDataSourceSpec;
    class BigQueryDataSourceSpec datasource;
    DataSourceSpec --> LookerDataSourceSpec;
    class LookerDataSourceSpec datasource;
    class DataSourceSpec datasource;
    DataValidationRule --> BooleanCondition;
    class BooleanCondition rule;
    class DataValidationRule rule;
    DeveloperMetadata --> DeveloperMetadataLocation;
    class DeveloperMetadataLocation metadata;
    DeveloperMetadata --> DeveloperMetadataVisibility;
    class DeveloperMetadataVisibility metadata;
    class DeveloperMetadata metadata;
    DeveloperMetadataLocation --> DeveloperMetadataLocationType;
    class DeveloperMetadataLocationType metadata;
    DeveloperMetadataLocation --> DimensionRange;
    class DimensionRange range;
    class DeveloperMetadataLocation metadata;
    ErrorValue --> ErrorType;
    class ErrorType enum;
    class ErrorValue default;
    ExtendedValue --> ErrorValue;
    class ErrorValue default;
    class ExtendedValue core;
    GradientRule --> InterpolationPoint;
    class InterpolationPoint default;
    class GradientRule rule;
    GridData --> RowData;
    class RowData core;
    GridData --> DimensionProperties;
    class DimensionProperties default;
    class GridData core;
    InterpolationPoint --> Color;
    class Color format;
    InterpolationPoint --> ColorStyle;
    class ColorStyle format;
    InterpolationPoint --> InterpolationPointType;
    class InterpolationPointType enum;
    class InterpolationPoint default;
    NamedRange --> GridRange;
    class GridRange range;
    class NamedRange range;
    NumberFormat --> NumberFormatType;
    class NumberFormatType format;
    class NumberFormat format;
    RowData --> CellData;
    class CellData core;
    class RowData core;
    Sheet --> SheetProperties;
    class SheetProperties default;
    Sheet --> GridData;
    class GridData core;
    Sheet --> GridRange;
    class GridRange range;
    Sheet --> ConditionalFormatRule;
    class ConditionalFormatRule format;
    class Sheet core;
    SheetProperties --> SheetType;
    class SheetType enum;
    SheetProperties --> GridProperties;
    class GridProperties default;
    SheetProperties --> Color;
    class Color format;
    SheetProperties --> ColorStyle;
    class ColorStyle format;
    class SheetProperties default;
    Spreadsheet --> SpreadsheetProperties;
    class SpreadsheetProperties default;
    Spreadsheet --> Sheet;
    class Sheet core;
    class Spreadsheet core;
    SpreadsheetProperties --> RecalculationInterval;
    class RecalculationInterval enum;
    SpreadsheetProperties --> CellFormat;
    class CellFormat format;
    SpreadsheetProperties --> IterativeCalculationSettings;
    class IterativeCalculationSettings default;
    SpreadsheetProperties --> SpreadsheetTheme;
    class SpreadsheetTheme format;
    class SpreadsheetProperties default;
    SpreadsheetTheme --> ThemeColorPair;
    class ThemeColorPair format;
    class SpreadsheetTheme format;
    TextFormat --> Color;
    class Color format;
    TextFormat --> ColorStyle;
    class ColorStyle format;
    TextFormat --> Link;
    class Link default;
    class TextFormat format;
    TextFormatRun --> TextFormat;
    class TextFormat format;
    class TextFormatRun format;
    ThemeColorPair --> ThemeColorType;
    class ThemeColorType format;
    ThemeColorPair --> ColorStyle;
    class ColorStyle format;
    class ThemeColorPair format;

Loading