PlatformSpreadsheets

Spreadsheets enable you to work with large, complex data in a familiar, collaborative, and controlled environment. Use these endpoints to manage spreadsheets and their sheets in the Workiva platform.

ApplyBorders

Apply borders to ranges

Properties

Name	Type	Description	Restrictions
bottom	Border	The type of border that should be applied
innerHorizontal	Border	The type of border that should be applied
innerVertical	Border	The type of border that should be applied
left	Border	The type of border that should be applied
ranges	[Range]	The ranges to apply borders	required
right	Border	The type of border that should be applied
top	Border	The type of border that should be applied

Example

{
  "bottom": {
    "color": "#000000",
    "style": "SINGLE",
    "weight": 2
  },
  "innerHorizontal": {
    "color": "#808080",
    "style": "DASHED1",
    "weight": 1
  },
  "innerVertical": {
    "color": "#808080",
    "style": "DASHED1",
    "weight": 1
  },
  "left": {
    "color": "#000000",
    "style": "SINGLE",
    "weight": 2
  },
  "ranges": [
    {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": 3,
      "stopRow": 3
    }
  ],
  "right": {
    "color": "#000000",
    "style": "SINGLE",
    "weight": 2
  },
  "top": {
    "color": "#000000",
    "style": "SINGLE",
    "weight": 2
  }
}

ApplyFormats

Apply formats to a list of ranges

Properties

Name	Type	Description	Restrictions
cellFormat	CellFormat	Cell Formats. Fields that are omitted will be ignored.
ranges	[Range]	The ranges to format	required
textFormat	TextFormat	Text formats. Fields that are omitted will be ignored.
valueFormat	ValueFormat	Value Formats. Fields that are omitted will be ignored.

Example

{
  "cellFormat": {
    "backgroundColor": "#d0e0f0"
  },
  "clearValueFormatStyles": true,
  "ranges": [
    {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": null,
      "stopRow": 0
    }
  ],
  "textFormat": {
    "bold": true
  },
  "valueFormat": {
    "valueFormatType": "TEXT"
  }
}

Border

The type of border that should be applied

Properties

Name	Type	Description	Restrictions
color	HexColor	A hex color code
style	string	The type of border to apply	required
weight	number¦null	The thickness of the border, in points. Rounded to the nearest hundredth.	Maximum: 10, Minimum: 0.25

Enumerated Values

Property	Value
style	SINGLE
style	DOUBLE
style	DASHED1
style	DASHED2
style	DASHED3
style	DASHED4
style	DASHED5

Example

{
  "color": "#000000",
  "style": "SINGLE",
  "weight": 2
}

CellData

Data in a cell

Properties

Name	Type	Description	Restrictions
calculatedValue	any	String, numeric, or boolean value result value of the cell. If the cell is a formula, this value will be the calculated result.
effectiveFormats	EffectiveFormats	Formats that could be directly applied or applied through inheritance.
formats	Formats	Formats on a cell
value	any	String, numeric, or boolean value of the cell. If the cell is a formula, this value will be the formula string.

Example

{
  "calculatedValue": 2,
  "effectiveFormats": {
    "cellFormat": {
      "backgroundColor": "#d0e8ff",
      "borders": {
        "bottom": {
          "color": "#000",
          "style": "SINGLE",
          "weight": 1
        },
        "left": {
          "color": "#000",
          "style": "SINGLE",
          "weight": 1
        },
        "right": null,
        "top": {
          "color": "#000",
          "style": "SINGLE",
          "weight": 1
        }
      },
      "horizontalAlign": "RIGHT",
      "indent": {
        "unit": "INCHES",
        "value": 0
      },
      "leaderDots": null,
      "textRotation": null,
      "verticalAlign": "BOTTOM"
    },
    "textFormat": {
      "bold": true,
      "fontColor": "#000000",
      "fontFamily": "Arial",
      "fontSize": 10,
      "italic": false,
      "strikethrough": false,
      "underline": false
    },
    "valueFormat": {
      "currencySymbol": {
        "currency": {
          "code": "EUR",
          "display": "SYMBOL"
        },
        "generic": null
      },
      "dateAbbreviateMonth": null,
      "dateFormatString": null,
      "dateUppercaseAll": null,
      "displayZeroAs": "ZERO",
      "enteredIn": "ONES",
      "numbersAsWordsOptions": {
        "capitalizeFirstWord": false,
        "displayZeroAs": null
      },
      "percentSymbol": null,
      "periodFormat": null,
      "precision": {
        "auto": false,
        "value": 2
      },
      "prefix": "",
      "showCurrencySymbol": true,
      "showLeadingZero": true,
      "showNumbersAsWords": false,
      "showPositiveSign": false,
      "showSignRoundedZero": false,
      "showThousandsSeparator": true,
      "shownIn": "ONES",
      "suffix": "",
      "symbolAlign": "SYMBOL DEFAULT",
      "useParensForNegatives": false,
      "valueFormatType": "CURRENCY"
    }
  },
  "formats": {
    "cellFormat": {
      "backgroundColor": "#d0e8ff",
      "borders": {
        "bottom": {
          "color": "#000",
          "style": "SINGLE",
          "weight": 1
        },
        "left": {
          "color": "#000",
          "style": "SINGLE",
          "weight": 1
        },
        "right": null,
        "top": {
          "color": "#000",
          "style": "SINGLE",
          "weight": 1
        }
      },
      "horizontalAlign": null,
      "indent": null,
      "leaderDots": null,
      "textRotation": null,
      "verticalAlign": null
    },
    "textFormat": {
      "bold": true,
      "fontColor": null,
      "fontFamily": null,
      "fontSize": null,
      "italic": null,
      "strikethrough": null,
      "underline": null
    },
    "valueFormat": {
      "currencySymbol": {
        "currency": {
          "code": "EUR",
          "display": "SYMBOL"
        },
        "generic": null
      },
      "dateAbbreviateMonth": null,
      "dateFormatString": null,
      "dateUppercaseAll": null,
      "displayZeroAs": "ZERO",
      "enteredIn": "ONES",
      "numbersAsWordsOptions": {
        "capitalizeFirstWord": false,
        "displayZeroAs": null
      },
      "percentSymbol": null,
      "periodFormat": null,
      "precision": {
        "auto": false,
        "value": 2
      },
      "prefix": "",
      "showCurrencySymbol": true,
      "showLeadingZero": true,
      "showNumbersAsWords": false,
      "showPositiveSign": null,
      "showSignRoundedZero": false,
      "showThousandsSeparator": true,
      "shownIn": "ONES",
      "suffix": "",
      "symbolAlign": null,
      "useParensForNegatives": false,
      "valueFormatType": "CURRENCY"
    }
  },
  "value": "=1+1"
}

CellEdit

A single cell edit

Properties

Name	Type	Description	Restrictions
column	integer	The column of the cell to edit	required, Minimum: 0
row	integer	The row of the cell to edit	required, Minimum: 0
value	any	String, numeric, or boolean value	required

Example

{
  "column": 0,
  "row": 0,
  "value": "Alpha One"
}

CellFormat

Cell Formats. Fields that are omitted will be ignored.

Properties

Name	Type	Description	Restrictions
backgroundColor	HexColor	A hex color code
borders	object¦null	The borders applied to a cell. Borders may be set by setting applyBorders	read-only
borders.bottom	Border	The type of border that should be applied
borders.left	Border	The type of border that should be applied
borders.right	Border	The type of border that should be applied
borders.top	Border	The type of border that should be applied
horizontalAlign	string¦null	The horizontal alignment of the content in the cell
indent	object¦null	Indentation of content in the cell
indent.unit	string	The unit of the size	required
indent.value	number	The size of the indent	required, Minimum: 0
leaderDots	string¦null	The leader dot pattern to show on the cell
textRotation	string¦null	The text orientation
verticalAlign	string¦null	The vertical alignment of the content in the cell

Enumerated Values

Property	Value
horizontalAlign	LEFT
horizontalAlign	RIGHT
horizontalAlign	CENTER
horizontalAlign	JUSTIFIED
unit	INCHES
unit	CENTIMETERS
leaderDots	NARROW
leaderDots	WIDE
textRotation	HORIZONTAL
textRotation	ASCENDING
textRotation	DESCENDING
verticalAlign	TOP
verticalAlign	MIDDLE
verticalAlign	BOTTOM

Example

{
  "backgroundColor": "#4bdf58",
  "borders": {
    "bottom": {
      "color": "#000000",
      "style": "SINGLE",
      "weight": 2
    },
    "left": {
      "color": "#000000",
      "style": "SINGLE",
      "weight": 2
    },
    "right": {
      "color": "#000000",
      "style": "SINGLE",
      "weight": 2
    },
    "top": {
      "color": "#000000",
      "style": "SINGLE",
      "weight": 2
    }
  },
  "horizontalAlign": "LEFT",
  "indent": {
    "unit": "INCHES",
    "value": 0
  },
  "leaderDots": "NARROW",
  "textRotation": "HORIZONTAL",
  "verticalAlign": "TOP"
}

ColumnMetadata

Metadata about a column

Properties

Name	Type	Description	Restrictions
hidden	boolean¦null	Whether the column is hidden
size	integer¦null	The width of the column, in points

Example

{
  "hidden": false,
  "size": 75
}

CSV

Properties

Name	Type	Description	Restrictions
anonymous	string

Example

"string"

Dataset

Details about the dataset.

Properties

Name	Type	Description	Restrictions
range	string	A1 style notation describing the range. Datasets are always located in the top left-hand corner of the sheet, so there is no need to specify range when creating a dataset.	read-only
sheet	string	The unique identifier of the sheet to which this dataset belongs.
values	[array]	A row-major ordered multidimensional array of cell values.

Example

{
  "range": "A1:B2",
  "sheet": "27f1b61c04ae4b0991bc73c631914e1d",
  "values": [
    [
      1,
      4
    ],
    [
      2,
      ""
    ]
  ]
}

Datasets

An array of Datasets to submit at once

Properties

Name	Type	Description	Restrictions
anonymous	[Dataset]	An array of Datasets to submit at once

Example

[
  {
    "range": "A1:B2",
    "sheet": "27f1b61c04ae4b0991bc73c631914e1d",
    "values": [
      [
        1,
        4
      ],
      [
        2,
        ""
      ]
    ]
  }
]

DatasetsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of partial Dataset objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[Dataset]		required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "range": "A1:B2",
      "sheet": "27f1b61c04ae4b0991bc73c631914e1d"
    }
  ]
}

DataValue

String, numeric, or boolean value

Properties

Name	Type	Description	Restrictions
anonymous	string
anonymous	integer
anonymous	boolean
anonymous	number

Example

"string"

EffectiveFormats

Formats that could be directly applied or applied through inheritance.

Properties

Name	Type	Description	Restrictions
cellFormat	CellFormat	Cell Formats. Fields that are omitted will be ignored.
textFormat	TextFormat	Text formats. Fields that are omitted will be ignored.
valueFormat	ValueFormat	Value Formats. Fields that are omitted will be ignored.

Example

{
  "cellFormat": {
    "backgroundColor": "#4bdf58",
    "borders": {
      "bottom": {
        "color": "#000000",
        "style": "SINGLE",
        "weight": 2
      },
      "left": {
        "color": "#000000",
        "style": "SINGLE",
        "weight": 2
      },
      "right": {
        "color": "#000000",
        "style": "SINGLE",
        "weight": 2
      },
      "top": {
        "color": "#000000",
        "style": "SINGLE",
        "weight": 2
      }
    },
    "horizontalAlign": "LEFT",
    "indent": {
      "unit": "INCHES",
      "value": 0
    },
    "leaderDots": "NARROW",
    "textRotation": "HORIZONTAL",
    "verticalAlign": "TOP"
  },
  "textFormat": {
    "bold": true,
    "fontColor": "#4bdf58",
    "fontFamily": "Times New Roman",
    "fontSize": 12,
    "italic": true,
    "strikethrough": true,
    "underline": true
  },
  "valueFormat": {
    "currencySymbol": {
      "currency": {
        "code": "AUD",
        "display": "SYMBOL"
      },
      "generic": "DOLLAR"
    },
    "dateAbbreviateMonth": true,
    "dateFormatString": "d/m/yyyy",
    "dateUppercaseAll": true,
    "displayZeroAs": "ZERO",
    "enteredIn": "MILLIONTHS",
    "numbersAsWordsOptions": {
      "capitalizeFirstWord": false,
      "displayZeroAs": "ZERO"
    },
    "percentSymbol": "NONE",
    "periodFormat": {
      "capitalizeFirstWord": false,
      "display": "RAW",
      "precision": null,
      "separator": "NONE",
      "showLabels": true,
      "showNumbersAsWords": false
    },
    "precision": {
      "auto": false,
      "value": -15
    },
    "prefix": "string",
    "showCurrencySymbol": true,
    "showLeadingZero": true,
    "showNumbersAsWords": true,
    "showPositiveSign": true,
    "showSignRoundedZero": true,
    "showThousandsSeparator": true,
    "shownIn": "MILLIONTHS",
    "suffix": "string",
    "symbolAlign": "SYMBOL DEFAULT",
    "useParensForNegatives": true,
    "valueFormatType": "AUTOMATIC"
  }
}

Formats

Formats on a cell

Properties

Name	Type	Description	Restrictions
cellFormat	CellFormat	Cell Formats. Fields that are omitted will be ignored.
textFormat	TextFormat	Text formats. Fields that are omitted will be ignored.
valueFormat	ValueFormat	Value Formats. Fields that are omitted will be ignored.

Example

{
  "cellFormat": {
    "backgroundColor": "#4bdf58",
    "borders": {
      "bottom": {
        "color": "#000000",
        "style": "SINGLE",
        "weight": 2
      },
      "left": {
        "color": "#000000",
        "style": "SINGLE",
        "weight": 2
      },
      "right": {
        "color": "#000000",
        "style": "SINGLE",
        "weight": 2
      },
      "top": {
        "color": "#000000",
        "style": "SINGLE",
        "weight": 2
      }
    },
    "horizontalAlign": "LEFT",
    "indent": {
      "unit": "INCHES",
      "value": 0
    },
    "leaderDots": "NARROW",
    "textRotation": "HORIZONTAL",
    "verticalAlign": "TOP"
  },
  "textFormat": {
    "bold": true,
    "fontColor": "#4bdf58",
    "fontFamily": "Times New Roman",
    "fontSize": 12,
    "italic": true,
    "strikethrough": true,
    "underline": true
  },
  "valueFormat": {
    "currencySymbol": {
      "currency": {
        "code": "AUD",
        "display": "SYMBOL"
      },
      "generic": "DOLLAR"
    },
    "dateAbbreviateMonth": true,
    "dateFormatString": "d/m/yyyy",
    "dateUppercaseAll": true,
    "displayZeroAs": "ZERO",
    "enteredIn": "MILLIONTHS",
    "numbersAsWordsOptions": {
      "capitalizeFirstWord": false,
      "displayZeroAs": "ZERO"
    },
    "percentSymbol": "NONE",
    "periodFormat": {
      "capitalizeFirstWord": false,
      "display": "RAW",
      "precision": null,
      "separator": "NONE",
      "showLabels": true,
      "showNumbersAsWords": false
    },
    "precision": {
      "auto": false,
      "value": -15
    },
    "prefix": "string",
    "showCurrencySymbol": true,
    "showLeadingZero": true,
    "showNumbersAsWords": true,
    "showPositiveSign": true,
    "showSignRoundedZero": true,
    "showThousandsSeparator": true,
    "shownIn": "MILLIONTHS",
    "suffix": "string",
    "symbolAlign": "SYMBOL DEFAULT",
    "useParensForNegatives": true,
    "valueFormatType": "AUTOMATIC"
  }
}

HexColor

A hex color code

Properties

Name	Type	Description	Restrictions
anonymous	string¦null	A hex color code

Example

"#4bdf58"

InheritFrom

Where to inherit formats from when performing an insertion

Properties

Name	Type	Description	Restrictions
anonymous	string	Where to inherit formats from when performing an insertion

Enumerated Values

Property	Value
anonymous	NONE
anonymous	BEFORE
anonymous	AFTER

Example

"NONE"

Insertion

Insertion instruction. Describes how to insert a block of rows or columns.

Properties

Name	Type	Description	Restrictions
count	integer	The number of rows or columns to insert	required, Minimum: 1
index	integer	The index to insert at	required, Minimum: 0

Example

{
  "count": 1,
  "index": 0
}

Interval

An interval of rows or columns. If either the start or end is null or omitted, the interval is unbounded in that direction.

Properties

Name	Type	Description	Restrictions
end	integer¦null	The last index of the interval, inclusive	Minimum: 0
start	integer¦null	The first index of the interval, inclusive	Minimum: 0

Example

{
  "end": 0,
  "start": 0
}

PlatformSpreadsheet

Details about the spreadsheet, including its ID, name, and milestone dates.

Properties

Name	Type	Description	Restrictions
created	Action	When the action was performed, and details about the user who did it	read-only
id	string	The unique identifier of the spreadsheet	read-only
modified	Action	When the action was performed, and details about the user who did it	read-only
name	string	The name of the spreadsheet	read-only
sheets	[Sheet]	An array of partial information about the sheets in this spreadsheet. Optionally included in the response when the $expand query parameter is provided.	read-only
template	boolean	Whether the spreadsheet is a template	read-only

Example

{
  "created": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "id": "124efa2a142f472ba1ceab34ed18915f",
  "modified": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "name": "Year-end review",
  "sheets": [
    {
      "id": "27f1b61c04ae4b0991bc73c631914e1d",
      "name": "Q1"
    }
  ],
  "template": false
}

PlatformSpreadsheetExport

Details about a spreadsheet export.

Properties

Name	Type	Description	Restrictions
csvOptions	PlatformSpreadsheetToCsvOptions¦null	Optional options to export the spreadsheet as a comma-separated values (.CSV) file. If no options are provided, exportAsFormulas defaults to False.
format	string	The file format to export the spreadsheet as.	required
pdfOptions	PlatformSpreadsheetToPdfOptions¦null	Optional options to export the spreadsheet as a portable document file (.PDF). If no options are provided, all options default to False except: - pageHeight, which defaults to 11 - pageWidth, which defaults to 8.5 - pageOrientation, which defaults to “portrait” - pageScale, which defaults to “actualSize”
sheets	[string]	The IDs of the sheets within the spreadsheet to export. Omit to export the entire spreadsheet. Note: When exporting to .CSV, you can export only the entire spreadsheet or a single sheet. When exporting the entire spreadsheet, the resulting file is a .ZIP of .CSV files, with one .CSV file per sheet.
xlsxOptions	PlatformSpreadsheetToXlsxOptions¦null	Optional options to export the spreadsheet as a Microsoft Excel (.XLSX) file. If no options are provided, exportAsFormulas defaults to False, and exportPrecision defaults to fullPrecision.

Enumerated Values

Property	Value
format	pdf
format	xlsx
format	csv

Example

{
  "format": "xlsx",
  "sheets": [
    "7c8d8c4a46784455bg68t36f9d8232d8",
    "54bgd83b471e5902f1a8e8c9a299c9fb"
  ],
  "xlsxOptions": {
    "exportAsFormulas": true,
    "exportPrecision": "displayed"
  }
}

PlatformSpreadsheetsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of PlatformSpreadsheet objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[PlatformSpreadsheet]	Details about the spreadsheet, including its ID, name, and milestone dates.	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "created": {
        "dateTime": "2019-10-30T15:03:27Z",
        "user": {
          "displayName": "John Doe",
          "email": "string",
          "firstName": "John",
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
          "lastName": "Doe",
          "userName": "string"
        }
      },
      "id": "124efa2a142f472ba1ceab34ed18915f",
      "modified": {
        "dateTime": "2019-10-30T15:03:27Z",
        "user": {
          "displayName": "John Doe",
          "email": "string",
          "firstName": "John",
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
          "lastName": "Doe",
          "userName": "string"
        }
      },
      "name": "Year-end review",
      "sheets": [
        {
          "children": [
            null
          ],
          "dataset": {
            "range": "A1:B2",
            "sheet": "27f1b61c04ae4b0991bc73c631914e1d",
            "values": [
              [
                1,
                4
              ],
              [
                2,
                ""
              ]
            ]
          },
          "id": "27f1b61c04ae4b0991bc73c631914e1d",
          "index": 1,
          "name": "Q1",
          "parent": null
        }
      ],
      "template": false
    }
  ]
}

PlatformSpreadsheetToCsvOptions

Optional options to export the spreadsheet as a comma-separated values (.CSV) file. If no options are provided, exportAsFormulas defaults to False.

Properties

Name	Type	Description	Restrictions
exportAsFormulas	boolean	Whether to export cells containing formulas as the formula or the formula result. False by default.

Example

{
  "exportAsFormulas": true
}

PlatformSpreadsheetToPdfOptions

Optional options to export the spreadsheet as a portable document file (.PDF). If no options are provided, all options default to False except:

• pageHeight, which defaults to 11

• pageWidth, which defaults to 8.5

• pageOrientation, which defaults to “portrait”

• pageScale, which defaults to “actualSize”

Properties

Name	Type	Description	Restrictions
includeComments	boolean	Whether to include comments when exporting to .PDF False by default.
includeDraftWatermark	boolean	Whether to include draft watermark when exporting to .PDF. False by default.
includeHyperlinks	boolean	Whether to include hyperlinks when exporting to .PDF. False by default.
includeLeaderDots	boolean	Whether to include leader dots when exporting to .PDF. False by default.
includeTrackChanges	boolean	Whether to include track changes when exporting to .PDF. False by default.
onlyExportPrintAreas	boolean	Whether to only export print areas when exporting to .PDF. False by default.
pageHeight	number(double)	The height of the exported .PDF, in inches. 11 by default.	Maximum: 100, Minimum: 3
pageOrientation	string	The orientation of the exported .PDF, such as “portrait” or “landscape”. “portrait” by default.
pageScale	string	The scale of the exported .PDF. “actualSize” by default.
pageWidth	number(double)	The width of the exported .PDF, in inches. 8.5 by default.	Maximum: 100, Minimum: 3
showCellFills	boolean	Whether to show cell fills when exporting to .PDF. False by default.
showGridlines	boolean	Whether to show gridlines when exporting to .PDF. False by default.
useCmykColorspace	boolean	Whether to use CMYK colorspace when exporting to .PDF. False by default.

Enumerated Values

Property	Value
pageOrientation	portrait
pageOrientation	landscape
pageScale	actualSize
pageScale	fitToWidth

Example

{
  "includeComments": true,
  "includeDraftWatermark": true,
  "includeHyperlinks": true,
  "includeLeaderDots": true,
  "includeTrackChanges": true,
  "onlyExportPrintAreas": true,
  "pageHeight": 14,
  "pageOrientation": "landscape",
  "pageScale": "fitToWidth",
  "pageWidth": 11,
  "showCellFills": true,
  "showGridlines": true,
  "useCmykColorspace": true
}

PlatformSpreadsheetToXlsxOptions

Optional options to export the spreadsheet as a Microsoft Excel (.XLSX) file. If no options are provided, exportAsFormulas defaults to False, and exportPrecision defaults to fullPrecision.

Properties

Name	Type	Description	Restrictions
exportAsFormulas	boolean	Whether to export cells that contain formulas as the formula or its result when exporting to .XLSX. False by default.
exportPrecision	string	How to export values in the sheet when exporting to .XLSX “fullPrecision” by default.

Enumerated Values

Property	Value
exportPrecision	fullPrecision
exportPrecision	rounded
exportPrecision	displayed

Example

{
  "exportAsFormulas": true,
  "exportPrecision": "displayed"
}

Range

A range in a sheet. If any field is omitted or null, the range is unbounded in that direction.

Properties

Name	Type	Description	Restrictions
startColumn	integer¦null	The index of the first column of the range, inclusive	Minimum: 0
startRow	integer¦null	The index of the first row of the range, inclusive	Minimum: 0
stopColumn	integer¦null	The index of the last column of the range, inclusive	Minimum: 0
stopRow	integer¦null	The index of the last row of the range, inclusive	Minimum: 0

Example

{
  "startColumn": 0,
  "startRow": 0,
  "stopColumn": 0,
  "stopRow": 0
}

RangeEditValues

Row-major ordered two-dimensional array of cell values

Properties

None

Example

[
  [
    "Alpha One",
    "Bravo One"
  ],
  [
    "Alpha Two",
    "Bravo Two"
  ]
]

RangeValues

Properties

Name	Type	Description	Restrictions
range	string	The range of values, in A1-style notation.
values	[array]	A row-major ordered multidimensional array of cell values.

Example

{
  "range": "A1:B2",
  "values": [
    [
      1,
      4
    ],
    [
      2,
      ""
    ]
  ]
}

RangeValuesListResult

Returns a JSON object with data and @nextLink properties. data contains a single RangeValues object, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[RangeValues]		required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "range": "A1:B2",
      "values": [
        [
          1,
          4
        ],
        [
          2,
          ""
        ]
      ]
    }
  ]
}

ResizeColumnIntervals

Resize a list of column intervals to a specified size

Properties

Name	Type	Description	Restrictions
intervals	[Interval]	The intervals of columns to resize	required
size	integer	The new size for the columns, in points	required, Maximum: 10000, Minimum: 3

Example

{
  "intervals": [
    {
      "end": 3,
      "start": 0
    }
  ],
  "size": 96
}

ResizeRowIntervals

Resize a list of row intervals to a specified size

Properties

Name	Type	Description	Restrictions
intervals	[Interval]	The intervals of rows to resize	required
size	integer	The new size for the rows, in points	required, Maximum: 10000, Minimum: 3

Example

{
  "intervals": [
    {
      "end": 3,
      "start": 0
    }
  ],
  "size": 24
}

RowMetadata

Metadata about a row

Properties

Name	Type	Description	Restrictions
filtered	boolean¦null	Whether the row is filtered
hidden	boolean¦null	Whether the row is hidden
size	integer¦null	The height of the row, in points

Example

{
  "filtered": false,
  "hidden": false,
  "size": 16
}

Sheet

Details about the sheet, including its ID and name.

Properties

Name	Type	Description	Restrictions
children	[Sheet]	An array of partial information about any child sheets	read-only
dataset	Dataset¦null	The range of the dataset on this sheet, if one exists. * To modify a dataset, either update or delete it.	read-only
id	string	The unique identifier of the sheet
index	integer	The integer index of the sheet relative to its parent sheet or to the spreadsheet, if no parent sheet. To position a sheet at the end of its siblings, use the special value -1.
name	string	The name of the sheet
parent	Sheet¦null	The sheet’s ID and name

Example

{
  "children": [
    {
      "id": "27f1b61c04ae4b0991bc73c631914e1d",
      "name": "Q1"
    }
  ],
  "dataset": {
    "range": "A1:B2"
  },
  "id": "27f1b61c04ae4b0991bc73c631914e1d",
  "index": 1,
  "name": "Q1",
  "parent": {
    "id": "27f1b61c04ae4b0991bc73c631914e1d",
    "name": "Q1"
  }
}

SheetCopy

Details about the destination spreadsheet and, optionally, the destination sheet.

Properties

Name	Type	Description	Restrictions
sheetIndex	integer	The integer index of where within the siblings to place the new sheet; 0 by default. To place the sheet at the end of its siblings, use the special value -1.
sheetName	string¦null	The name of the new sheet, if different than the source sheet.
sheetParent	string¦null	The ID of the parent sheet to copy the sheet into. To place the sheet at the top level of the spreadsheet, use the default null.
spreadsheet	string	The unique identifier of the spreadsheet to copy a sheet into	required

Example

{
  "sheetIndex": 2,
  "sheetName": "Q1",
  "sheetParent": "5bbf8aa3cea54465762af96e3ca411c7",
  "spreadsheet": "c65d9572a7464037a383d6235633cf74"
}

SheetData

Details about the section, including its ID and name.

Properties

Name	Type	Description	Restrictions
cells	[array]¦null	Cell data in row-major order
columnMetadata	[ColumnMetadata]	Metadata about the columns in the request range
merges	[Range]¦null	Merged ranges that intersect with the request range
range	Range	A range in a sheet. If any field is omitted or null, the range is unbounded in that direction.
rowMetadata	[RowMetadata]	Metadata about the rows in the request range

Example

{
  "cells": [
    [
      {
        "calculatedValue": 2,
        "effectiveFormats": {
          "cellFormat": {
            "backgroundColor": "#d0e8ff",
            "borders": {
              "bottom": {
                "color": "#000",
                "style": "SINGLE",
                "weight": 1
              },
              "left": {
                "color": "#000",
                "style": "SINGLE",
                "weight": 1
              },
              "right": null,
              "top": {
                "color": "#000",
                "style": "SINGLE",
                "weight": 1
              }
            },
            "horizontalAlign": "RIGHT",
            "indent": {
              "unit": "INCHES",
              "value": 0
            },
            "leaderDots": null,
            "textRotation": null,
            "verticalAlign": "BOTTOM"
          },
          "textFormat": {
            "bold": true,
            "fontColor": "#000000",
            "fontFamily": "Arial",
            "fontSize": 10,
            "italic": false,
            "strikethrough": false,
            "underline": false
          },
          "valueFormat": {
            "currencySymbol": {
              "currency": {
                "code": "EUR",
                "display": "SYMBOL"
              },
              "generic": null
            },
            "dateAbbreviateMonth": null,
            "dateFormatString": null,
            "dateUppercaseAll": null,
            "displayZeroAs": "ZERO",
            "enteredIn": "ONES",
            "numbersAsWordsOptions": {
              "capitalizeFirstWord": false,
              "displayZeroAs": null
            },
            "percentSymbol": null,
            "periodFormat": null,
            "precision": {
              "auto": false,
              "value": 2
            },
            "prefix": "",
            "showCurrencySymbol": true,
            "showLeadingZero": true,
            "showNumbersAsWords": false,
            "showPositiveSign": false,
            "showSignRoundedZero": false,
            "showThousandsSeparator": true,
            "shownIn": "ONES",
            "suffix": "",
            "symbolAlign": "SYMBOL DEFAULT",
            "useParensForNegatives": false,
            "valueFormatType": "CURRENCY"
          }
        },
        "formats": {
          "cellFormat": {
            "backgroundColor": "#d0e8ff",
            "borders": {
              "bottom": {
                "color": "#000",
                "style": "SINGLE",
                "weight": 1
              },
              "left": {
                "color": "#000",
                "style": "SINGLE",
                "weight": 1
              },
              "right": null,
              "top": {
                "color": "#000",
                "style": "SINGLE",
                "weight": 1
              }
            },
            "horizontalAlign": null,
            "indent": null,
            "leaderDots": null,
            "textRotation": null,
            "verticalAlign": null
          },
          "textFormat": {
            "bold": true,
            "fontColor": null,
            "fontFamily": null,
            "fontSize": null,
            "italic": null,
            "strikethrough": null,
            "underline": null
          },
          "valueFormat": {
            "currencySymbol": {
              "currency": {
                "code": "EUR",
                "display": "SYMBOL"
              },
              "generic": null
            },
            "dateAbbreviateMonth": null,
            "dateFormatString": null,
            "dateUppercaseAll": null,
            "displayZeroAs": "ZERO",
            "enteredIn": "ONES",
            "numbersAsWordsOptions": {
              "capitalizeFirstWord": false,
              "displayZeroAs": null
            },
            "percentSymbol": null,
            "periodFormat": null,
            "precision": {
              "auto": false,
              "value": 2
            },
            "prefix": "",
            "showCurrencySymbol": true,
            "showLeadingZero": true,
            "showNumbersAsWords": false,
            "showPositiveSign": null,
            "showSignRoundedZero": false,
            "showThousandsSeparator": true,
            "shownIn": "ONES",
            "suffix": "",
            "symbolAlign": null,
            "useParensForNegatives": false,
            "valueFormatType": "CURRENCY"
          }
        },
        "value": "=1+1"
      }
    ]
  ],
  "columnMetadata": [
    {
      "hidden": false,
      "size": 75
    }
  ],
  "merges": [
    {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": 1,
      "stopRow": 0
    }
  ],
  "range": {
    "startColumn": 0,
    "startRow": 0,
    "stopColumn": 0,
    "stopRow": 0
  },
  "rowMetadata": [
    {
      "filtered": false,
      "hidden": false,
      "size": 16
    }
  ]
}

SheetDataResult

Returns a JSON object with data and @nextLink properties. data contains a SheetData object, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	SheetData	Details about the section, including its ID and name.	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": {
    "cells": [
      [
        {
          "calculatedValue": 2,
          "effectiveFormats": {
            "cellFormat": {
              "backgroundColor": "#d0e8ff",
              "borders": {
                "bottom": {
                  "color": "#000",
                  "style": "SINGLE",
                  "weight": 1
                },
                "left": {
                  "color": "#000",
                  "style": "SINGLE",
                  "weight": 1
                },
                "right": null,
                "top": {
                  "color": "#000",
                  "style": "SINGLE",
                  "weight": 1
                }
              },
              "horizontalAlign": "RIGHT",
              "indent": {
                "unit": "INCHES",
                "value": 0
              },
              "leaderDots": null,
              "textRotation": null,
              "verticalAlign": "BOTTOM"
            },
            "textFormat": {
              "bold": true,
              "fontColor": "#000000",
              "fontFamily": "Arial",
              "fontSize": 10,
              "italic": false,
              "strikethrough": false,
              "underline": false
            },
            "valueFormat": {
              "currencySymbol": {
                "currency": {
                  "code": "EUR",
                  "display": "SYMBOL"
                },
                "generic": null
              },
              "dateAbbreviateMonth": null,
              "dateFormatString": null,
              "dateUppercaseAll": null,
              "displayZeroAs": "ZERO",
              "enteredIn": "ONES",
              "numbersAsWordsOptions": {
                "capitalizeFirstWord": false,
                "displayZeroAs": null
              },
              "percentSymbol": null,
              "periodFormat": null,
              "precision": {
                "auto": false,
                "value": 2
              },
              "prefix": "",
              "showCurrencySymbol": true,
              "showLeadingZero": true,
              "showNumbersAsWords": false,
              "showPositiveSign": false,
              "showSignRoundedZero": false,
              "showThousandsSeparator": true,
              "shownIn": "ONES",
              "suffix": "",
              "symbolAlign": "SYMBOL DEFAULT",
              "useParensForNegatives": false,
              "valueFormatType": "CURRENCY"
            }
          },
          "formats": {
            "cellFormat": {
              "backgroundColor": "#d0e8ff",
              "borders": {
                "bottom": {
                  "color": "#000",
                  "style": "SINGLE",
                  "weight": 1
                },
                "left": {
                  "color": "#000",
                  "style": "SINGLE",
                  "weight": 1
                },
                "right": null,
                "top": {
                  "color": "#000",
                  "style": "SINGLE",
                  "weight": 1
                }
              },
              "horizontalAlign": null,
              "indent": null,
              "leaderDots": null,
              "textRotation": null,
              "verticalAlign": null
            },
            "textFormat": {
              "bold": true,
              "fontColor": null,
              "fontFamily": null,
              "fontSize": null,
              "italic": null,
              "strikethrough": null,
              "underline": null
            },
            "valueFormat": {
              "currencySymbol": {
                "currency": {
                  "code": "EUR",
                  "display": "SYMBOL"
                },
                "generic": null
              },
              "dateAbbreviateMonth": null,
              "dateFormatString": null,
              "dateUppercaseAll": null,
              "displayZeroAs": "ZERO",
              "enteredIn": "ONES",
              "numbersAsWordsOptions": {
                "capitalizeFirstWord": false,
                "displayZeroAs": null
              },
              "percentSymbol": null,
              "periodFormat": null,
              "precision": {
                "auto": false,
                "value": 2
              },
              "prefix": "",
              "showCurrencySymbol": true,
              "showLeadingZero": true,
              "showNumbersAsWords": false,
              "showPositiveSign": null,
              "showSignRoundedZero": false,
              "showThousandsSeparator": true,
              "shownIn": "ONES",
              "suffix": "",
              "symbolAlign": null,
              "useParensForNegatives": false,
              "valueFormatType": "CURRENCY"
            }
          },
          "value": "=1+1"
        }
      ]
    ],
    "columnMetadata": [
      {
        "hidden": false,
        "size": 75
      }
    ],
    "merges": [
      {
        "startColumn": 0,
        "startRow": 0,
        "stopColumn": 1,
        "stopRow": 0
      }
    ],
    "range": {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": 0,
      "stopRow": 0
    },
    "rowMetadata": [
      {
        "filtered": false,
        "hidden": false,
        "size": 16
      }
    ]
  }
}

SheetUpdate

An update to a sheet. Only a single field on the SheetUpdate may be set per request.

Properties

Name	Type	Description	Restrictions
applyBorders	SheetUpdateApplyBorders	Apply list of border format requests to the sheet
applyFormats	SheetUpdateApplyFormats	Apply list of format requests to the sheet
clearBorders	SheetUpdateClearBorders	Clears borders in ranges
clearFormats	SheetUpdateClearFormats	Clear formats from ranges
deleteColumns	SheetUpdateDeleteColumns	Delete columns from the sheet
deleteRows	SheetUpdateDeleteRows	Delete rows from the sheet
editCells	SheetUpdateEditCells	Edit a list of cells
editRange	SheetUpdateEditRange	Edit all of the cells in a contiguous range
hideColumns	SheetUpdateHideColumns	Hide columns in the sheet
hideRows	SheetUpdateHideRows	Hide rows in the sheet
insertColumns	SheetUpdateInsertColumns	Insert columns into the sheet
insertRows	SheetUpdateInsertRows	Insert rows into the sheet
mergeRanges	SheetUpdateMergeRanges	Merge ranges
resizeColumns	SheetUpdateResizeColumns	Resize columns to the specified size
resizeColumnsToFit	SheetUpdateResizeColumnsToFit	Auto-size columns to fit content
resizeRows	SheetUpdateResizeRows	Resize rows to the specified size
resizeRowsToFit	SheetUpdateResizeRowsToFit	Auto-size rows to fit content
unhideColumns	SheetUpdateUnhideColumns	Unhide columns in the sheet
unhideRows	SheetUpdateUnhideRows	Unhide rows in the sheet
unmergeRanges	SheetUpdateUnmergeRanges	Unmerge merges that intersect the provided ranges

Example

{
  "applyBorders": {
    "borders": [
      {
        "bottom": {
          "color": "#000000",
          "style": "SINGLE",
          "weight": 2
        },
        "innerHorizontal": {
          "color": "#808080",
          "style": "DASHED1",
          "weight": 1
        },
        "innerVertical": {
          "color": "#808080",
          "style": "DASHED1",
          "weight": 1
        },
        "left": {
          "color": "#000000",
          "style": "SINGLE",
          "weight": 2
        },
        "ranges": [
          {
            "startColumn": 0,
            "startRow": 0,
            "stopColumn": 3,
            "stopRow": 3
          }
        ],
        "right": {
          "color": "#000000",
          "style": "SINGLE",
          "weight": 2
        },
        "top": {
          "color": "#000000",
          "style": "SINGLE",
          "weight": 2
        }
      }
    ]
  },
  "applyFormats": {
    "formats": [
      {
        "cellFormat": {
          "backgroundColor": "#d0e0f0"
        },
        "ranges": [
          {
            "startColumn": 0,
            "startRow": 0,
            "stopColumn": null,
            "stopRow": 0
          }
        ],
        "textFormat": {
          "bold": true
        },
        "valueFormat": {
          "valueFormatType": "TEXT"
        }
      }
    ]
  },
  "clearBorders": {
    "ranges": [
      {
        "startColumn": 0,
        "startRow": 0,
        "stopColumn": 3,
        "stopRow": 3
      }
    ]
  },
  "clearFormats": {
    "cellFormatFields": [
      "*"
    ],
    "ranges": [
      {
        "startColumn": 0,
        "startRow": 0,
        "stopColumn": null,
        "stopRow": 0
      }
    ],
    "textFormatFields": [
      "*"
    ],
    "valueFormatFields": [
      "*"
    ]
  },
  "deleteColumns": {
    "force": true,
    "intervals": [
      {
        "end": 3,
        "start": 2
      }
    ]
  },
  "deleteRows": {
    "force": true,
    "intervals": [
      {
        "end": 7,
        "start": 5
      }
    ]
  },
  "editCells": {
    "cells": [
      {
        "column": 0,
        "row": 0,
        "value": "Alpha One"
      },
      {
        "column": 1,
        "row": 0,
        "value": "Bravo One"
      },
      {
        "column": 0,
        "row": 1,
        "value": "Alpha Two"
      },
      {
        "column": 1,
        "row": 1,
        "value": "Bravo Two"
      }
    ]
  },
  "editRange": {
    "range": {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": 1,
      "stopRow": 1
    },
    "values": [
      [
        "Alpha One",
        "Bravo One"
      ],
      [
        "Alpha Two",
        "Bravo Two"
      ]
    ]
  },
  "hideColumns": {
    "force": true,
    "intervals": [
      {
        "end": 5,
        "start": 4
      }
    ]
  },
  "hideRows": {
    "force": true,
    "intervals": [
      {
        "end": 9,
        "start": 7
      }
    ]
  },
  "insertColumns": {
    "inheritFrom": "BEFORE",
    "insertions": [
      {
        "count": 1,
        "index": 3
      }
    ]
  },
  "insertRows": {
    "inheritFrom": "BEFORE",
    "insertions": [
      {
        "count": 2,
        "index": 6
      }
    ]
  },
  "mergeRanges": {
    "force": true,
    "mergeType": "HORIZONTAL",
    "ranges": [
      {
        "startColumn": 0,
        "startRow": 4,
        "stopColumn": 1,
        "stopRow": 7
      }
    ]
  },
  "resizeColumns": {
    "resizeIntervals": [
      {
        "intervals": [
          {
            "end": 3,
            "start": 0
          }
        ],
        "size": 96
      }
    ]
  },
  "resizeColumnsToFit": {
    "intervals": [
      {
        "end": 3,
        "start": 0
      }
    ]
  },
  "resizeRows": {
    "resizeIntervals": [
      {
        "intervals": [
          {
            "end": 3,
            "start": 0
          }
        ],
        "size": 24
      }
    ]
  },
  "resizeRowsToFit": {
    "intervals": [
      {
        "end": 3,
        "start": 0
      }
    ]
  },
  "unhideColumns": {
    "intervals": [
      {
        "end": 5,
        "start": 4
      }
    ]
  },
  "unhideRows": {
    "intervals": [
      {
        "end": 9,
        "start": 7
      }
    ]
  },
  "unmergeRanges": {
    "ranges": [
      {
        "startColumn": 0,
        "startRow": 4,
        "stopColumn": 1,
        "stopRow": 7
      }
    ]
  }
}

SheetUpdate

An update to a sheet. Only a single field on the SheetUpdate may be set per request.

Properties

Name	Type	Description	Restrictions
applyBorders	SheetUpdateApplyBorders	Apply list of border format requests to the sheet
applyFormats	SheetUpdateApplyFormats	Apply list of format requests to the sheet
clearBorders	SheetUpdateClearBorders	Clears borders in ranges
clearFormats	SheetUpdateClearFormats	Clear formats from ranges
deleteColumns	SheetUpdateDeleteColumns	Delete columns from the sheet
deleteRows	SheetUpdateDeleteRows	Delete rows from the sheet
editCells	SheetUpdateEditCells	Edit a list of cells
editRange	SheetUpdateEditRange	Edit all of the cells in a contiguous range
hideColumns	SheetUpdateHideColumns	Hide columns in the sheet
hideRows	SheetUpdateHideRows	Hide rows in the sheet
insertColumns	SheetUpdateInsertColumns	Insert columns into the sheet
insertRows	SheetUpdateInsertRows	Insert rows into the sheet
mergeRanges	SheetUpdateMergeRanges	Merge ranges
resizeColumns	SheetUpdateResizeColumns	Resize columns to the specified size
resizeColumnsToFit	SheetUpdateResizeColumnsToFit	Auto-size columns to fit content
resizeRows	SheetUpdateResizeRows	Resize rows to the specified size
resizeRowsToFit	SheetUpdateResizeRowsToFit	Auto-size rows to fit content
unhideColumns	SheetUpdateUnhideColumns	Unhide columns in the sheet
unhideRows	SheetUpdateUnhideRows	Unhide rows in the sheet
unmergeRanges	SheetUpdateUnmergeRanges	Unmerge merges that intersect the provided ranges

Example

{
  "applyBorders": {
    "borders": [
      {
        "bottom": {
          "color": "#000000",
          "style": "SINGLE",
          "weight": 2
        },
        "innerHorizontal": {
          "color": "#808080",
          "style": "DASHED1",
          "weight": 1
        },
        "innerVertical": {
          "color": "#808080",
          "style": "DASHED1",
          "weight": 1
        },
        "left": {
          "color": "#000000",
          "style": "SINGLE",
          "weight": 2
        },
        "ranges": [
          {
            "startColumn": 0,
            "startRow": 0,
            "stopColumn": 3,
            "stopRow": 3
          }
        ],
        "right": {
          "color": "#000000",
          "style": "SINGLE",
          "weight": 2
        },
        "top": {
          "color": "#000000",
          "style": "SINGLE",
          "weight": 2
        }
      }
    ]
  },
  "applyFormats": {
    "formats": [
      {
        "cellFormat": {
          "backgroundColor": "#d0e0f0"
        },
        "ranges": [
          {
            "startColumn": 0,
            "startRow": 0,
            "stopColumn": null,
            "stopRow": 0
          }
        ],
        "textFormat": {
          "bold": true
        },
        "valueFormat": {
          "valueFormatType": "TEXT"
        }
      }
    ]
  },
  "clearBorders": {
    "ranges": [
      {
        "startColumn": 0,
        "startRow": 0,
        "stopColumn": 3,
        "stopRow": 3
      }
    ]
  },
  "clearFormats": {
    "cellFormatFields": [
      "*"
    ],
    "ranges": [
      {
        "startColumn": 0,
        "startRow": 0,
        "stopColumn": null,
        "stopRow": 0
      }
    ],
    "textFormatFields": [
      "*"
    ],
    "valueFormatFields": [
      "*"
    ]
  },
  "deleteColumns": {
    "force": true,
    "intervals": [
      {
        "end": 3,
        "start": 2
      }
    ]
  },
  "deleteRows": {
    "force": true,
    "intervals": [
      {
        "end": 7,
        "start": 5
      }
    ]
  },
  "editCells": {
    "cells": [
      {
        "column": 0,
        "row": 0,
        "value": "Alpha One"
      },
      {
        "column": 1,
        "row": 0,
        "value": "Bravo One"
      },
      {
        "column": 0,
        "row": 1,
        "value": "Alpha Two"
      },
      {
        "column": 1,
        "row": 1,
        "value": "Bravo Two"
      }
    ]
  },
  "editRange": {
    "range": {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": 1,
      "stopRow": 1
    },
    "values": [
      [
        "Alpha One",
        "Bravo One"
      ],
      [
        "Alpha Two",
        "Bravo Two"
      ]
    ]
  },
  "hideColumns": {
    "force": true,
    "intervals": [
      {
        "end": 5,
        "start": 4
      }
    ]
  },
  "hideRows": {
    "force": true,
    "intervals": [
      {
        "end": 9,
        "start": 7
      }
    ]
  },
  "insertColumns": {
    "inheritFrom": "BEFORE",
    "insertions": [
      {
        "count": 1,
        "index": 3
      }
    ]
  },
  "insertRows": {
    "inheritFrom": "BEFORE",
    "insertions": [
      {
        "count": 2,
        "index": 6
      }
    ]
  },
  "mergeRanges": {
    "force": true,
    "mergeType": "HORIZONTAL",
    "ranges": [
      {
        "startColumn": 0,
        "startRow": 4,
        "stopColumn": 1,
        "stopRow": 7
      }
    ]
  },
  "resizeColumns": {
    "resizeIntervals": [
      {
        "intervals": [
          {
            "end": 3,
            "start": 0
          }
        ],
        "size": 96
      }
    ]
  },
  "resizeColumnsToFit": {
    "intervals": [
      {
        "end": 3,
        "start": 0
      }
    ]
  },
  "resizeRows": {
    "resizeIntervals": [
      {
        "intervals": [
          {
            "end": 3,
            "start": 0
          }
        ],
        "size": 24
      }
    ]
  },
  "resizeRowsToFit": {
    "intervals": [
      {
        "end": 3,
        "start": 0
      }
    ]
  },
  "unhideColumns": {
    "intervals": [
      {
        "end": 5,
        "start": 4
      }
    ]
  },
  "unhideRows": {
    "intervals": [
      {
        "end": 9,
        "start": 7
      }
    ]
  },
  "unmergeRanges": {
    "ranges": [
      {
        "startColumn": 0,
        "startRow": 4,
        "stopColumn": 1,
        "stopRow": 7
      }
    ]
  }
}

SheetUpdateApplyBorders

Apply list of border format requests to the sheet

Properties

Name	Type	Description	Restrictions
borders	[ApplyBorders]	The list of border formats to apply to the sheet	required

Example

{
  "borders": [
    {
      "bottom": {
        "color": "#000000",
        "style": "SINGLE",
        "weight": 2
      },
      "innerHorizontal": {
        "color": "#808080",
        "style": "DASHED1",
        "weight": 1
      },
      "innerVertical": {
        "color": "#808080",
        "style": "DASHED1",
        "weight": 1
      },
      "left": {
        "color": "#000000",
        "style": "SINGLE",
        "weight": 2
      },
      "ranges": [
        {
          "startColumn": 0,
          "startRow": 0,
          "stopColumn": 3,
          "stopRow": 3
        }
      ],
      "right": {
        "color": "#000000",
        "style": "SINGLE",
        "weight": 2
      },
      "top": {
        "color": "#000000",
        "style": "SINGLE",
        "weight": 2
      }
    }
  ]
}

SheetUpdateApplyFormats

Apply list of format requests to the sheet

Properties

Name	Type	Description	Restrictions
formats	[ApplyFormats]	The list of formats to apply to the sheet	required

Example

{
  "formats": [
    {
      "cellFormat": {
        "backgroundColor": "#d0e0f0"
      },
      "ranges": [
        {
          "startColumn": 0,
          "startRow": 0,
          "stopColumn": null,
          "stopRow": 0
        }
      ],
      "textFormat": {
        "bold": true
      },
      "valueFormat": {
        "valueFormatType": "TEXT"
      }
    }
  ]
}

SheetUpdateClearBorders

Clears borders in ranges

Properties

Name	Type	Description	Restrictions
ranges	[Range]	The ranges to clear borders	required

Example

{
  "ranges": [
    {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": 3,
      "stopRow": 3
    }
  ]
}

SheetUpdateClearFormats

Clear formats from ranges

Properties

Name	Type	Description	Restrictions
cellFormatFields	[string]	List of CellFormat fields to clear. Use “*” to clear all fields.
ranges	[Range]	The ranges to clear formats	required
textFormatFields	[string]	List of TextFormat fields to clear. Use “*” to clear all fields.
valueFormatFields	[string]	List of ValueFormat fields to clear. Use “*” to clear all fields.

Example

{
  "cellFormatFields": [
    "*"
  ],
  "ranges": [
    {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": null,
      "stopRow": 0
    }
  ],
  "textFormatFields": [
    "*"
  ],
  "valueFormatFields": [
    "*"
  ]
}

SheetUpdateDeleteColumns

Delete columns from the sheet

Properties

Name	Type	Description	Restrictions
force	boolean	Force the deletion of source links, xbrl facts, connections, etc
intervals	[Interval]	An interval of rows or columns. If either the start or end is null or omitted, the interval is unbounded in that direction.	required

Example

{
  "force": true,
  "intervals": [
    {
      "end": 3,
      "start": 2
    }
  ]
}

SheetUpdateDeleteRows

Delete rows from the sheet

Properties

Name	Type	Description	Restrictions
force	boolean	Force the deletion of source links, xbrl facts, connections, etc
intervals	[Interval]	An interval of rows or columns. If either the start or end is null or omitted, the interval is unbounded in that direction.	required

Example

{
  "force": true,
  "intervals": [
    {
      "end": 7,
      "start": 5
    }
  ]
}

SheetUpdateEditCells

Edit a list of cells

Properties

Name	Type	Description	Restrictions
cells	[CellEdit]	The cells to edit	required
options	object¦null	Edit cells options
options.applyEnteredInScaling	boolean	Whether or not to apply enteredIn scaling
options.skipEditMergeChildren	boolean	Whether or not to skip edits to merge child cells

Example

{
  "cells": [
    {
      "column": 0,
      "row": 0,
      "value": "Alpha One"
    },
    {
      "column": 1,
      "row": 0,
      "value": "Bravo One"
    },
    {
      "column": 0,
      "row": 1,
      "value": "Alpha Two"
    },
    {
      "column": 1,
      "row": 1,
      "value": "Bravo Two"
    }
  ]
}

SheetUpdateEditRange

Edit all of the cells in a contiguous range

Properties

Name	Type	Description	Restrictions
options	object¦null	Edit range options
options.applyEnteredInScaling	boolean	Whether or not to apply enteredIn scaling
options.skipEditMergeChildren	boolean	Whether or not to skip edits to merge child cells
range	Range	A range in a sheet. If any field is omitted or null, the range is unbounded in that direction.	required
values	RangeEditValues	Row-major ordered two-dimensional array of cell values	required

Example

{
  "range": {
    "startColumn": 0,
    "startRow": 0,
    "stopColumn": 1,
    "stopRow": 1
  },
  "values": [
    [
      "Alpha One",
      "Bravo One"
    ],
    [
      "Alpha Two",
      "Bravo Two"
    ]
  ]
}

SheetUpdateHideColumns

Hide columns in the sheet

Properties

Name	Type	Description	Restrictions
force	boolean	Force the hiding of footnotes
intervals	[Interval]	The intervals of columns to hide	required

Example

{
  "force": true,
  "intervals": [
    {
      "end": 5,
      "start": 4
    }
  ]
}

SheetUpdateHideRows

Hide rows in the sheet

Properties

Name	Type	Description	Restrictions
force	boolean	Force the hiding of footnotes
intervals	[Interval]	The intervals of rows to hide	required

Example

{
  "force": true,
  "intervals": [
    {
      "end": 9,
      "start": 7
    }
  ]
}

SheetUpdateInsertColumns

Insert columns into the sheet

Properties

Name	Type	Description	Restrictions
inheritFrom	InheritFrom	Where to inherit formats from when performing an insertion	required
insertions	[Insertion]	List of column insertions	required

Example

{
  "inheritFrom": "BEFORE",
  "insertions": [
    {
      "count": 1,
      "index": 3
    }
  ]
}

SheetUpdateInsertRows

Insert rows into the sheet

Properties

Name	Type	Description	Restrictions
inheritFrom	InheritFrom	Where to inherit formats from when performing an insertion	required
insertions	[Insertion]	List of row insertions	required

Example

{
  "inheritFrom": "BEFORE",
  "insertions": [
    {
      "count": 2,
      "index": 6
    }
  ]
}

SheetUpdateMergeRanges

Merge ranges

Properties

Name	Type	Description	Restrictions
force	boolean	Force the merge through source links, xbrl facts, connections, etc
mergeType	string	How cells should be merged
ranges	[Range]	The ranges to merge	required

Enumerated Values

Property	Value
mergeType	ALL
mergeType	HORIZONTAL
mergeType	VERTICAL

Example

{
  "force": true,
  "mergeType": "HORIZONTAL",
  "ranges": [
    {
      "startColumn": 0,
      "startRow": 4,
      "stopColumn": 1,
      "stopRow": 7
    }
  ]
}

SheetUpdateResizeColumns

Resize columns to the specified size

Properties

Name	Type	Description	Restrictions
resizeIntervals	array		required

Example

{
  "resizeIntervals": [
    {
      "intervals": [
        {
          "end": 3,
          "start": 0
        }
      ],
      "size": 96
    }
  ]
}

SheetUpdateResizeColumnsToFit

Auto-size columns to fit content

Properties

Name	Type	Description	Restrictions
intervals	[Interval]	The intervals of columns to resize	required

Example

{
  "intervals": [
    {
      "end": 3,
      "start": 0
    }
  ]
}

SheetUpdateResizeRows

Resize rows to the specified size

Properties

Name	Type	Description	Restrictions
resizeIntervals	array		required

Example

{
  "resizeIntervals": [
    {
      "intervals": [
        {
          "end": 3,
          "start": 0
        }
      ],
      "size": 24
    }
  ]
}

SheetUpdateResizeRowsToFit

Auto-size rows to fit content

Properties

Name	Type	Description	Restrictions
intervals	[Interval]	The intervals of rows to resize	required

Example

{
  "intervals": [
    {
      "end": 3,
      "start": 0
    }
  ]
}

SheetUpdateUnhideColumns

Unhide columns in the sheet

Properties

Name	Type	Description	Restrictions
intervals	[Interval]	The intervals of columns to unhide	required

Example

{
  "intervals": [
    {
      "end": 5,
      "start": 4
    }
  ]
}

SheetUpdateUnhideRows

Unhide rows in the sheet

Properties

Name	Type	Description	Restrictions
intervals	[Interval]	The intervals of rows to unhide	required

Example

{
  "intervals": [
    {
      "end": 9,
      "start": 7
    }
  ]
}

SheetUpdateUnmergeRanges

Unmerge merges that intersect the provided ranges

Properties

Name	Type	Description	Restrictions
ranges	[Range]	The ranges to unmerge	required

Example

{
  "ranges": [
    {
      "startColumn": 0,
      "startRow": 4,
      "stopColumn": 1,
      "stopRow": 7
    }
  ]
}

Spreadsheet

Details about the spreadsheet, including its ID, name, and milestone dates.

Properties

Name	Type	Description	Restrictions
created	Action	When the action was performed, and details about the user who did it	read-only
id	string	The unique identifier of the spreadsheet	read-only
modified	Action	When the action was performed, and details about the user who did it	read-only
name	string	The name of the spreadsheet	read-only
sheets	[Sheet]	An array of partial information about the sheets in this spreadsheet. Optionally included in the response when the $expand query parameter is provided.	read-only
template	boolean	Whether the spreadsheet is a template	read-only

Example

{
  "created": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "id": "124efa2a142f472ba1ceab34ed18915f",
  "modified": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "name": "Year-end review",
  "sheets": [
    {
      "id": "27f1b61c04ae4b0991bc73c631914e1d",
      "name": "Q1"
    }
  ],
  "template": false
}

TextFormat

Text formats. Fields that are omitted will be ignored.

Properties

Name	Type	Description	Restrictions
bold	boolean¦null	Text bold format
fontColor	HexColor	A hex color code
fontFamily	string¦null	Text font format
fontSize	number¦null	Text font size, in points	Maximum: 720, Minimum: 1
italic	boolean¦null	Text italic format
strikethrough	boolean¦null	Text strikethrough format
underline	boolean¦null	Text underline format

Example

{
  "bold": true,
  "fontColor": "#4bdf58",
  "fontFamily": "Times New Roman",
  "fontSize": 12,
  "italic": true,
  "strikethrough": true,
  "underline": true
}

ValueFormat

Value Formats. Fields that are omitted will be ignored.

Properties

Name	Type	Description	Restrictions
currencySymbol	object¦null	The currency symbol to display. Valid for ACCOUNTING and CURRENCY. Either generic or currency should be set, but not both.
currencySymbol.currency	object¦null	An ISO currency format
currencySymbol.currency.code	string¦null	The ISO currency identifier	required
currencySymbol.currency.display	string¦null	How to display the currency. CODE simply displays the ISO currency code while SYMBOL displays the corresponding currency symbol. For codes where we support two different symbols, SYMBOL and SYMBOL2 display as follows:	code
currencySymbol.generic	string¦null	Generic currency options
dateAbbreviateMonth	boolean¦null	Use month abbreviations instead of full month names. Valid for DATE.
dateFormatString	string¦null	Format to use when rendering the date. Valid for DATE.	Maximum length: 100
dateUppercaseAll	boolean¦null	Uppercase all characters in the date string. Valid for DATE.
displayZeroAs	string¦null	The symbol to use for zero. Valid for ACCOUNTING, CURRENCY, NUMBER, and PERCENT. This field controls the symbol to use for zero when not using showNumbersAsWords.
enteredIn	string¦null	The scale cell values are entered in. Valid for AUTOMATIC, ACCOUNTING, CURRENCY, and NUMBER.
numbersAsWordsOptions	object¦null	Options relevant when showing numbers as words. Valid for ACCOUNTING, CURRENCY, NUMBER, and PERCENT. In order for these options to take effect showNumbersAsWords must be set to true.
numbersAsWordsOptions.capitalizeFirstWord	boolean¦null	Capitalize the first word. Valid for ACCOUNTING, CURRENCY, NUMBER, and PERCENT.
numbersAsWordsOptions.displayZeroAs	string¦null	The word to use for zero. Valid for ACCOUNTING, CURRENCY, NUMBER, and PERCENT.
percentSymbol	string¦null	Render numbers with a percent symbol. Valid for PERCENT.
periodFormat	object¦null	Options for formatting a duration string. Valid for PERIOD
periodFormat.capitalizeFirstWord	boolean¦null	Capitalize the first word
periodFormat.display	string¦null	Method of displaying the period value	required
periodFormat.precision	integer¦null	Precision to use when rounding decimal numbers for display. Renders with automatic precision if null.	Maximum: 15, Minimum: 0
periodFormat.separator	string¦null	The separator to use between denominations if multiple are displayed
periodFormat.showLabels	boolean¦null	Render a label after each denomination
periodFormat.showNumbersAsWords	boolean¦null	Render the numbers as words instead of digits
precision	object¦null	Precision to use when rounding numbers for display. Valid for AUTOMATIC, ACCOUNTING, CURRENCY, NUMBER, and PERCENT.
precision.auto	boolean¦null	Render with automatic precision based on the value in the cell
precision.value	integer¦null	Explicit precision value to use. Required unless auto is true.	Maximum: 15, Minimum: -15
prefix	string¦null	Custom prefix value to render in the cell. Valid for ACCOUNTING, CURRENCY, NUMBER, PERCENT, and DATE.	Maximum length: 100
showCurrencySymbol	boolean¦null	Render numbers with a currency symbol. Valid for ACCOUNTING and CURRENCY.
showLeadingZero	boolean¦null	Include a leading zero for decimal numbers with no whole number part. Valid for ACCOUNTING, CURRENCY, NUMBER, and PERCENT.
showNumbersAsWords	boolean¦null	Render the number as words instead of digits. Valid for ACCOUNTING, CURRENCY, NUMBER, and PERCENT.
showPositiveSign	boolean¦null	Render the positive sign on numbers greater than zero. Valid for ACCOUNTING, CURRENCY, NUMBER, and PERCENT.
showSignRoundedZero	boolean¦null	Render the sign on values rounded to zero. Valid for ACCOUNTING, CURRENCY, NUMBER, and PERCENT.
showThousandsSeparator	boolean¦null	Render the thousands separator. Valid for ACCOUNTING, CURRENCY, NUMBER, and PERCENT.
shownIn	string¦null	The scale cell values are displayed in. Valid for AUTOMATIC, ACCOUNTING, CURRENCY, and NUMBER.
suffix	string¦null	Custom suffix value to render in the cell. Valid for ACCOUNTING, CURRENCY, NUMBER, PERCENT, and DATE.	Maximum length: 100
symbolAlign	string¦null	Where to render the symbol relative to the value. All values valid for ACCOUNTING and CURRENCY. Left values valid for NUMBER. Right values valid for PERCENT.
useParensForNegatives	boolean¦null	Render parentheses around the number instead of a negative symbol. Valid for ACCOUNTING, CURRENCY, NUMBER, and PERCENT.
valueFormatType	string¦null	The value format type of the content. Setting this property will clear any other ValueFormat properties that are not valid for the new value format type.

Enumerated Values

Property	Value
code	AUD
code	BGN
code	BRL
code	CAD
code	CHF
code	CNH
code	CNY
code	CZK
code	DKK
code	EUR
code	GBP
code	HKD
code	HRK
code	HUF
code	INR
code	ISK
code	IDR
code	JPY
code	KRW
code	MXN
code	MYR
code	NOK
code	PHP
code	PLN
code	RON
code	RSD
code	RUB
code	SEK
code	SGD
code	THB
code	TRY
code	TWD
code	UAH
code	USD
code	ZAR
code	VND
display	SYMBOL
display	SYMBOL2
display	CODE
generic	DOLLAR
generic	CENT
displayZeroAs	ZERO
displayZeroAs	EM DASH
displayZeroAs	EN DASH
displayZeroAs	HYPHEN
displayZeroAs	BLANK
enteredIn	MILLIONTHS
enteredIn	BASIS POINTS
enteredIn	THOUSANDTHS
enteredIn	HUNDREDTHS
enteredIn	ONES
enteredIn	THOUSANDS
enteredIn	TEN THOUSANDS
enteredIn	MILLIONS
enteredIn	HUNDRED MILLIONS
enteredIn	BILLIONS
enteredIn	TRILLIONS
displayZeroAs	ZERO
displayZeroAs	NO
displayZeroAs	NONE
displayZeroAs	NOTHING
displayZeroAs	NIL
displayZeroAs	NOT
displayZeroAs	NOMINAL
displayZeroAs	IMMATERIAL
percentSymbol	NONE
percentSymbol	SYMBOL
percentSymbol	WORD
display	RAW
display	LARGEST
display	YEARS
display	ALL
separator	NONE
separator	COMMA
shownIn	MILLIONTHS
shownIn	BASIS POINTS
shownIn	THOUSANDTHS
shownIn	HUNDREDTHS
shownIn	ONES
shownIn	THOUSANDS
shownIn	TEN THOUSANDS
shownIn	MILLIONS
shownIn	HUNDRED MILLIONS
shownIn	BILLIONS
shownIn	TRILLIONS
symbolAlign	SYMBOL DEFAULT
symbolAlign	LEFT
symbolAlign	LEFT INSIDE
symbolAlign	RIGHT
symbolAlign	RIGHT INSIDE
symbolAlign	RIGHT SPACED INSIDE
symbolAlign	RIGHT SPACED
valueFormatType	AUTOMATIC
valueFormatType	AUTOMATIC ACCOUNTING
valueFormatType	AUTOMATIC CURRENCY
valueFormatType	AUTOMATIC NUMBER
valueFormatType	AUTOMATIC PERCENT
valueFormatType	AUTOMATIC DATE
valueFormatType	AUTOMATIC PERIOD
valueFormatType	AUTOMATIC TEXT
valueFormatType	ACCOUNTING
valueFormatType	CURRENCY
valueFormatType	NUMBER
valueFormatType	PERCENT
valueFormatType	DATE
valueFormatType	PERIOD
valueFormatType	TEXT

Example

{
  "currencySymbol": {
    "currency": {
      "code": "AUD",
      "display": "SYMBOL"
    },
    "generic": "DOLLAR"
  },
  "dateAbbreviateMonth": true,
  "dateFormatString": "d/m/yyyy",
  "dateUppercaseAll": true,
  "displayZeroAs": "ZERO",
  "enteredIn": "MILLIONTHS",
  "numbersAsWordsOptions": {
    "capitalizeFirstWord": false,
    "displayZeroAs": "ZERO"
  },
  "percentSymbol": "NONE",
  "periodFormat": {
    "capitalizeFirstWord": false,
    "display": "RAW",
    "precision": null,
    "separator": "NONE",
    "showLabels": true,
    "showNumbersAsWords": false
  },
  "precision": {
    "auto": false,
    "value": -15
  },
  "prefix": "string",
  "showCurrencySymbol": true,
  "showLeadingZero": true,
  "showNumbersAsWords": true,
  "showPositiveSign": true,
  "showSignRoundedZero": true,
  "showThousandsSeparator": true,
  "shownIn": "MILLIONTHS",
  "suffix": "string",
  "symbolAlign": "SYMBOL DEFAULT",
  "useParensForNegatives": true,
  "valueFormatType": "AUTOMATIC"
}