API Reference

Spreadsheets

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.

Spreadsheet

Properties

NameTypeDescriptionRestrictions
createdActionWhen the action was performed, and details about the user who did itread-only
idstringThe unique identifier of the spreadsheetread-only
modifiedActionWhen the action was performed, and details about the user who did itread-only
namestringThe name of the spreadsheetread-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
templatebooleanWhether the spreadsheet is a templateread-only

Example

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

SpreadsheetExport

Properties

NameTypeDescriptionRestrictions
csvOptionsSpreadsheetToCsvOptions¦nullOptional options to export the spreadsheet as a comma-separated values (.CSV) file. If no options are provided, exportAsFormulas defaults to False.
formatstringThe file format to export the spreadsheet as.
pdfOptionsSpreadsheetToPdfOptions¦nullOptional 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.
xlsxOptionsSpreadsheetToXlsxOptions¦nullOptional 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

PropertyValue
formatpdf
formatxlsx
formatcsv

Example

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

SpreadsheetToPdfOptions

Properties

NameTypeDescriptionRestrictions
includeCommentsbooleanWhether to include comments when exporting to .PDF False by default.
includeDraftWatermarkbooleanWhether to include draft watermark when exporting to .PDF. False by default.
includeHyperlinksbooleanWhether to include hyperlinks when exporting to .PDF. False by default.
includeLeaderDotsbooleanWhether to include leader dots when exporting to .PDF. False by default.
includeTrackChangesbooleanWhether to include track changes when exporting to .PDF. False by default.
onlyExportPrintAreasbooleanWhether to only export print areas when exporting to .PDF. False by default.
pageHeightnumber(double)The height of the exported .PDF, in inches. 11 by default.
pageOrientationstringThe orientation of the exported .PDF, such as "portrait" or "landscape". "portrait" by default.
pageScalestringThe scale of the exported .PDF. "actualSize" by default.
pageWidthnumber(double)The width of the exported .PDF, in inches. 8.5 by default.
showCellFillsbooleanWhether to show cell fills when exporting to .PDF. False by default.
showGridlinesbooleanWhether to show gridlines when exporting to .PDF. False by default.
useCmykColorspacebooleanWhether to use CMYK colorspace when exporting to .PDF. False by default.

Enumerated Values

PropertyValue
pageOrientationportrait
pageOrientationlandscape
pageScaleactualSize
pageScalefitToWidth

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
}

SpreadsheetToXlsxOptions

Properties

NameTypeDescriptionRestrictions
exportAsFormulasbooleanWhether to export cells that contain formulas as the formula or its result when exporting to .XLSX. False by default.
exportPrecisionstringHow to export values in the sheet when exporting to .XLSX "fullPrecision" by default.

Enumerated Values

PropertyValue
exportPrecisionfullPrecision
exportPrecisionrounded
exportPrecisiondisplayed

Example

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

SpreadsheetToCsvOptions

Properties

NameTypeDescriptionRestrictions
exportAsFormulasbooleanWhether to export cells containing formulas as the formula or the formula result. False by default.

Example

{
  "exportAsFormulas": true
}

Sheet

Properties

NameTypeDescriptionRestrictions
children[Sheet]An array of partial information about any child sheetsread-only
datasetDataset¦nullThe range of the dataset on this sheet, if one exists.
* To modify a dataset, either update or delete it.
read-only
idstringThe unique identifier of the sheetread-only
indexintegerThe 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.
namestringThe name of the sheet
parentSheet¦nullThe 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

Properties

NameTypeDescriptionRestrictions
sheetIndexintegerThe 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.
sheetNamestring¦nullThe name of the new sheet, if different than the source sheet.
sheetParentstring¦nullThe 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.
spreadsheetstringThe unique identifier of the spreadsheet to copy a sheet into

Example

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

Dataset

Properties

NameTypeDescriptionRestrictions
rangestringA1 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
sheetstringThe 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

Properties

NameTypeDescriptionRestrictions
[Dataset]An array of Datasets to submit at once

Example

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

RangeValues

Properties

NameTypeDescriptionRestrictions
rangestringThe 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,
      ""
    ]
  ]
}

SheetData

Properties

NameTypeDescriptionRestrictions
cells[array]Cell data in row-major order
columnMetadata[ColumnMetadata]Metadata about the columns in the request range
merges[Range]Merged ranges that intersect with the request range
rangeRangeA 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": null,
        "effectiveFormats": {
          "cellFormat": {
            "backgroundColor": "#4bdf58",
            "borders": {
              "bottom": {
                "color": "#4bdf58",
                "style": "SINGLE",
                "weight": 1
              },
              "left": {
                "color": "#4bdf58",
                "style": "SINGLE",
                "weight": 1
              },
              "right": {
                "color": "#4bdf58",
                "style": "SINGLE",
                "weight": 1
              },
              "top": {
                "color": "#4bdf58",
                "style": "SINGLE",
                "weight": 1
              }
            },
            "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": "BASIS POINTS",
            "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": "BASIS POINTS",
            "suffix": "string",
            "symbolAlign": "LEFT",
            "useParensForNegatives": true,
            "valueFormatType": "AUTOMATIC"
          }
        },
        "formats": {
          "cellFormat": {
            "backgroundColor": "#4bdf58",
            "borders": {
              "bottom": {
                "color": "#4bdf58",
                "style": "SINGLE",
                "weight": 1
              },
              "left": {
                "color": "#4bdf58",
                "style": "SINGLE",
                "weight": 1
              },
              "right": {
                "color": "#4bdf58",
                "style": "SINGLE",
                "weight": 1
              },
              "top": {
                "color": "#4bdf58",
                "style": "SINGLE",
                "weight": 1
              }
            },
            "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": "BASIS POINTS",
            "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": "BASIS POINTS",
            "suffix": "string",
            "symbolAlign": "LEFT",
            "useParensForNegatives": true,
            "valueFormatType": "AUTOMATIC"
          }
        },
        "value": null
      }
    ]
  ],
  "columnMetadata": [
    {
      "hidden": true,
      "size": 0
    }
  ],
  "merges": [
    {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": 0,
      "stopRow": 0
    }
  ],
  "range": {
    "startColumn": 0,
    "startRow": 0,
    "stopColumn": 0,
    "stopRow": 0
  },
  "rowMetadata": [
    {
      "filtered": true,
      "hidden": true,
      "size": 0
    }
  ]
}

SheetUpdate

Properties

NameTypeDescriptionRestrictions
applyBordersSheetUpdateApplyBordersApply list of border format requests to the sheet
applyFormatsSheetUpdateApplyFormatsApply list of format requests to the sheet
clearBordersSheetUpdateClearBordersClears borders in ranges
clearFormatsSheetUpdateClearFormatsClear formats from ranges
deleteColumnsSheetUpdateDeleteColumnsDelete columns from the sheet
deleteRowsSheetUpdateDeleteRowsDelete rows from the sheet
editCellsSheetUpdateEditCellsEdit a list of cells
editRangeSheetUpdateEditRangeEdit all of the cells in a contiguous range
hideColumnsSheetUpdateHideColumnsHide columns in the sheet
hideRowsSheetUpdateHideRowsHide rows in the sheet
insertColumnsSheetUpdateInsertColumnsInsert columns into the sheet
insertRowsSheetUpdateInsertRowsInsert rows into the sheet
mergeRangesSheetUpdateMergeRangesMerge ranges
resizeColumnsSheetUpdateResizeColumnsResize columns to the specified size
resizeColumnsToFitSheetUpdateResizeColumnsToFitAuto-size columns to fit content
resizeRowsSheetUpdateResizeRowsResize rows to the specified size
resizeRowsToFitSheetUpdateResizeRowsToFitAuto-size rows to fit content
unhideColumnsSheetUpdateUnhideColumnsUnhide columns in the sheet
unhideRowsSheetUpdateUnhideRowsUnhide rows in the sheet
unmergeRangesSheetUpdateUnmergeRangesUnmerge merges that intersect the provided ranges

Example

{
  "applyBorders": {
    "borders": [
      {
        "bottom": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        },
        "innerHorizontal": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        },
        "innerVertical": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        },
        "left": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        },
        "ranges": [
          {
            "startColumn": 0,
            "startRow": 0,
            "stopColumn": 0,
            "stopRow": 0
          }
        ],
        "right": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        },
        "top": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        }
      }
    ]
  },
  "applyFormats": {
    "formats": [
      {
        "cellFormat": {
          "backgroundColor": "#4bdf58",
          "borders": {
            "bottom": {
              "color": "#4bdf58",
              "style": "SINGLE",
              "weight": 1
            },
            "left": {
              "color": "#4bdf58",
              "style": "SINGLE",
              "weight": 1
            },
            "right": {
              "color": "#4bdf58",
              "style": "SINGLE",
              "weight": 1
            },
            "top": {
              "color": "#4bdf58",
              "style": "SINGLE",
              "weight": 1
            }
          },
          "horizontalAlign": "LEFT",
          "indent": {
            "unit": "INCHES",
            "value": 0
          },
          "leaderDots": "NARROW",
          "textRotation": "HORIZONTAL",
          "verticalAlign": "TOP"
        },
        "ranges": [
          {
            "startColumn": 0,
            "startRow": 0,
            "stopColumn": 0,
            "stopRow": 0
          }
        ],
        "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": "BASIS POINTS",
          "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": "BASIS POINTS",
          "suffix": "string",
          "symbolAlign": "LEFT",
          "useParensForNegatives": true,
          "valueFormatType": "AUTOMATIC"
        }
      }
    ]
  },
  "clearBorders": {
    "ranges": [
      {
        "startColumn": 0,
        "startRow": 0,
        "stopColumn": 0,
        "stopRow": 0
      }
    ]
  },
  "clearFormats": {
    "cellFormatFields": [
      "indent",
      "backgroundColor",
      "leaderDots"
    ],
    "ranges": [
      {
        "startColumn": 0,
        "startRow": 0,
        "stopColumn": 0,
        "stopRow": 0
      }
    ],
    "textFormatFields": [
      "bold",
      "italic",
      "underline"
    ],
    "valueFormatFields": [
      "shownIn",
      "precision",
      "currencySymbol"
    ]
  },
  "deleteColumns": {
    "force": true,
    "intervals": [
      {
        "end": 0,
        "start": 0
      }
    ]
  },
  "deleteRows": {
    "force": true,
    "intervals": [
      {
        "end": 0,
        "start": 0
      }
    ]
  },
  "editCells": {
    "cells": [
      {
        "column": 0,
        "row": 0,
        "value": null
      }
    ]
  },
  "editRange": {
    "range": {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": 0,
      "stopRow": 0
    },
    "values": [
      [
        null
      ]
    ]
  },
  "hideColumns": {
    "force": true,
    "intervals": [
      {
        "end": 0,
        "start": 0
      }
    ]
  },
  "hideRows": {
    "force": true,
    "intervals": [
      {
        "end": 0,
        "start": 0
      }
    ]
  },
  "insertColumns": {
    "inheritFrom": "NONE",
    "insertions": [
      {
        "count": 1,
        "index": 0
      }
    ]
  },
  "insertRows": {
    "inheritFrom": "NONE",
    "insertions": [
      {
        "count": 1,
        "index": 0
      }
    ]
  },
  "mergeRanges": {
    "force": true,
    "mergeType": "ALL",
    "ranges": [
      {
        "startColumn": 0,
        "startRow": 0,
        "stopColumn": 0,
        "stopRow": 0
      }
    ]
  },
  "resizeColumns": {
    "resizeIntervals": [
      {
        "intervals": [
          {
            "end": 0,
            "start": 0
          }
        ],
        "size": 3
      }
    ]
  },
  "resizeColumnsToFit": {
    "intervals": [
      {
        "end": 0,
        "start": 0
      }
    ]
  },
  "resizeRows": {
    "resizeIntervals": [
      {
        "intervals": [
          {
            "end": 0,
            "start": 0
          }
        ],
        "size": 3
      }
    ]
  },
  "resizeRowsToFit": {
    "intervals": [
      {
        "end": 0,
        "start": 0
      }
    ]
  },
  "unhideColumns": {
    "intervals": [
      {
        "end": 0,
        "start": 0
      }
    ]
  },
  "unhideRows": {
    "intervals": [
      {
        "end": 0,
        "start": 0
      }
    ]
  },
  "unmergeRanges": {
    "ranges": [
      {
        "startColumn": 0,
        "startRow": 0,
        "stopColumn": 0,
        "stopRow": 0
      }
    ]
  }
}

SheetUpdateApplyFormats

Properties

NameTypeDescriptionRestrictions
formats[ApplyFormats]The list of formats to apply to the sheet

Example

{
  "formats": [
    {
      "cellFormat": {
        "backgroundColor": "#4bdf58",
        "borders": {
          "bottom": {
            "color": "#4bdf58",
            "style": "SINGLE",
            "weight": 1
          },
          "left": {
            "color": "#4bdf58",
            "style": "SINGLE",
            "weight": 1
          },
          "right": {
            "color": "#4bdf58",
            "style": "SINGLE",
            "weight": 1
          },
          "top": {
            "color": "#4bdf58",
            "style": "SINGLE",
            "weight": 1
          }
        },
        "horizontalAlign": "LEFT",
        "indent": {
          "unit": "INCHES",
          "value": 0
        },
        "leaderDots": "NARROW",
        "textRotation": "HORIZONTAL",
        "verticalAlign": "TOP"
      },
      "ranges": [
        {
          "startColumn": 0,
          "startRow": 0,
          "stopColumn": 0,
          "stopRow": 0
        }
      ],
      "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": "BASIS POINTS",
        "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": "BASIS POINTS",
        "suffix": "string",
        "symbolAlign": "LEFT",
        "useParensForNegatives": true,
        "valueFormatType": "AUTOMATIC"
      }
    }
  ]
}

SheetUpdateClearBorders

Properties

NameTypeDescriptionRestrictions
ranges[Range]The ranges to clear borders

Example

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

SheetUpdateClearFormats

Properties

NameTypeDescriptionRestrictions
cellFormatFields[string]List of CellFormat fields to clear. Use "*" to clear all fields.
ranges[Range]The ranges to clear formats
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": [
    "indent",
    "backgroundColor",
    "leaderDots"
  ],
  "ranges": [
    {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": 0,
      "stopRow": 0
    }
  ],
  "textFormatFields": [
    "bold",
    "italic",
    "underline"
  ],
  "valueFormatFields": [
    "shownIn",
    "precision",
    "currencySymbol"
  ]
}

SheetUpdateDeleteColumns

Properties

NameTypeDescriptionRestrictions
forcebooleanForce the deletion of links, xbrl, footnotes, 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.]

Example

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

SheetUpdateApplyBorders

Properties

NameTypeDescriptionRestrictions
borders[ApplyBorders]The list of border formats to apply to the sheet

Example

{
  "borders": [
    {
      "bottom": {
        "color": "#4bdf58",
        "style": "SINGLE",
        "weight": 1
      },
      "innerHorizontal": {
        "color": "#4bdf58",
        "style": "SINGLE",
        "weight": 1
      },
      "innerVertical": {
        "color": "#4bdf58",
        "style": "SINGLE",
        "weight": 1
      },
      "left": {
        "color": "#4bdf58",
        "style": "SINGLE",
        "weight": 1
      },
      "ranges": [
        {
          "startColumn": 0,
          "startRow": 0,
          "stopColumn": 0,
          "stopRow": 0
        }
      ],
      "right": {
        "color": "#4bdf58",
        "style": "SINGLE",
        "weight": 1
      },
      "top": {
        "color": "#4bdf58",
        "style": "SINGLE",
        "weight": 1
      }
    }
  ]
}

SheetUpdateDeleteRows

Properties

NameTypeDescriptionRestrictions
forcebooleanForce the deletion of links, xbrl, footnotes, 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.]

Example

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

SheetUpdateEditCells

Properties

NameTypeDescriptionRestrictions
cells[CellEdit]The cells to edit

Example

{
  "cells": [
    {
      "column": 0,
      "row": 0,
      "value": null
    }
  ]
}

SheetUpdateEditRange

Properties

NameTypeDescriptionRestrictions
rangeRangeA range in a sheet. If any field is omitted or null, the range is unbounded in that direction.
valuesRangeEditValuesRow-major ordered two-dimensional array of cell values

Example

{
  "range": {
    "startColumn": 0,
    "startRow": 0,
    "stopColumn": 0,
    "stopRow": 0
  },
  "values": [
    [
      null
    ]
  ]
}

SheetUpdateHideColumns

Properties

NameTypeDescriptionRestrictions
forcebooleanForce the hiding of footnotes
intervals[Interval]The intervals of columns to hide

Example

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

SheetUpdateHideRows

Properties

NameTypeDescriptionRestrictions
forcebooleanForce the hiding of footnotes
intervals[Interval]The intervals of rows to hide

Example

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

SheetUpdateInsertRows

Properties

NameTypeDescriptionRestrictions
inheritFromInheritFromWhere to inherit formats from when performing an insertion
insertions[Insertion]List of row insertions

Example

{
  "inheritFrom": "NONE",
  "insertions": [
    {
      "count": 1,
      "index": 0
    }
  ]
}

SheetUpdateInsertColumns

Properties

NameTypeDescriptionRestrictions
inheritFromInheritFromWhere to inherit formats from when performing an insertion
insertions[Insertion]List of column insertions

Example

{
  "inheritFrom": "NONE",
  "insertions": [
    {
      "count": 1,
      "index": 0
    }
  ]
}

SheetUpdateMergeRanges

Properties

NameTypeDescriptionRestrictions
forcebooleanForce the merge through links, xbrl, footnotes, etc
mergeTypestringHow cells should be merged
ranges[Range]The ranges to merge

Enumerated Values

PropertyValue
mergeTypeALL
mergeTypeHORIZONTAL
mergeTypeVERTICAL

Example

{
  "force": true,
  "mergeType": "ALL",
  "ranges": [
    {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": 0,
      "stopRow": 0
    }
  ]
}

SheetUpdateResizeColumns

Properties

NameTypeDescriptionRestrictions
resizeIntervalsarray

Example

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

SheetUpdateResizeColumnsToFit

Properties

NameTypeDescriptionRestrictions
intervals[Interval]The intervals of columns to resize

Example

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

SheetUpdateResizeRows

Properties

NameTypeDescriptionRestrictions
resizeIntervalsarray

Example

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

SheetUpdateResizeRowsToFit

Properties

NameTypeDescriptionRestrictions
intervals[Interval]The intervals of rows to resize

Example

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

SheetUpdateUnhideRows

Properties

NameTypeDescriptionRestrictions
intervals[Interval]The intervals of rows to unhide

Example

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

SheetUpdateUnhideColumns

Properties

NameTypeDescriptionRestrictions
intervals[Interval]The intervals of columns to unhide

Example

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

SheetUpdateUnmergeRanges

Properties

NameTypeDescriptionRestrictions
ranges[Range]The ranges to unmerge

Example

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

ApplyBorders

Properties

NameTypeDescriptionRestrictions
bottomBorderThe type of border that should be applied
innerHorizontalBorderThe type of border that should be applied
innerVerticalBorderThe type of border that should be applied
leftBorderThe type of border that should be applied
ranges[Range]The ranges to apply borders
rightBorderThe type of border that should be applied
topBorderThe type of border that should be applied

Example

{
  "bottom": {
    "color": "#4bdf58",
    "style": "SINGLE",
    "weight": 1
  },
  "innerHorizontal": {
    "color": "#4bdf58",
    "style": "SINGLE",
    "weight": 1
  },
  "innerVertical": {
    "color": "#4bdf58",
    "style": "SINGLE",
    "weight": 1
  },
  "left": {
    "color": "#4bdf58",
    "style": "SINGLE",
    "weight": 1
  },
  "ranges": [
    {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": 0,
      "stopRow": 0
    }
  ],
  "right": {
    "color": "#4bdf58",
    "style": "SINGLE",
    "weight": 1
  },
  "top": {
    "color": "#4bdf58",
    "style": "SINGLE",
    "weight": 1
  }
}

ApplyFormats

Properties

NameTypeDescriptionRestrictions
cellFormatCellFormatCell Formats. Fields that are omitted will be ignored.
ranges[Range]The ranges to format
textFormatTextFormatText formats. Fields that are omitted will be ignored.
valueFormatValueFormatValue Formats. Fields that are omitted will be ignored.

Example

{
  "cellFormat": {
    "backgroundColor": "#4bdf58",
    "borders": {
      "bottom": {
        "color": "#4bdf58",
        "style": "SINGLE",
        "weight": 1
      },
      "left": {
        "color": "#4bdf58",
        "style": "SINGLE",
        "weight": 1
      },
      "right": {
        "color": "#4bdf58",
        "style": "SINGLE",
        "weight": 1
      },
      "top": {
        "color": "#4bdf58",
        "style": "SINGLE",
        "weight": 1
      }
    },
    "horizontalAlign": "LEFT",
    "indent": {
      "unit": "INCHES",
      "value": 0
    },
    "leaderDots": "NARROW",
    "textRotation": "HORIZONTAL",
    "verticalAlign": "TOP"
  },
  "ranges": [
    {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": 0,
      "stopRow": 0
    }
  ],
  "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": "BASIS POINTS",
    "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": "BASIS POINTS",
    "suffix": "string",
    "symbolAlign": "LEFT",
    "useParensForNegatives": true,
    "valueFormatType": "AUTOMATIC"
  }
}

Border

Properties

NameTypeDescriptionRestrictions
colorHexColorA hex color code
stylestringThe type of border to apply
weightnumberThe thickness of the border, in points. Rounded to the nearest hundredth.

Enumerated Values

PropertyValue
styleSINGLE
styleDOUBLE
styleDASHED1
styleDASHED2
styleDASHED3
styleDASHED4
styleDASHED5

Example

{
  "color": "#4bdf58",
  "style": "SINGLE",
  "weight": 1
}

CellData

Properties

NameTypeDescriptionRestrictions
calculatedValueanyString, numeric, or boolean value result value of the cell. If the cell is a formula, this value will be the calculated result.
effectiveFormatsEffectiveFormatsFormats that could be directly applied or applied through inheritance.
formatsFormatsFormats on a cell
valueanyString, numeric, or boolean value of the cell. If the cell is a formula, this value will be the formula string.

Example

{
  "calculatedValue": null,
  "effectiveFormats": {
    "cellFormat": {
      "backgroundColor": "#4bdf58",
      "borders": {
        "bottom": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        },
        "left": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        },
        "right": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        },
        "top": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        }
      },
      "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": "BASIS POINTS",
      "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": "BASIS POINTS",
      "suffix": "string",
      "symbolAlign": "LEFT",
      "useParensForNegatives": true,
      "valueFormatType": "AUTOMATIC"
    }
  },
  "formats": {
    "cellFormat": {
      "backgroundColor": "#4bdf58",
      "borders": {
        "bottom": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        },
        "left": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        },
        "right": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        },
        "top": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        }
      },
      "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": "BASIS POINTS",
      "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": "BASIS POINTS",
      "suffix": "string",
      "symbolAlign": "LEFT",
      "useParensForNegatives": true,
      "valueFormatType": "AUTOMATIC"
    }
  },
  "value": null
}

CellEdit

Properties

NameTypeDescriptionRestrictions
columnintegerThe column of the cell to edit
rowintegerThe row of the cell to edit
valueanyString, numeric, or boolean value

Example

{
  "column": 0,
  "row": 0,
  "value": null
}

CellFormat

Properties

NameTypeDescriptionRestrictions
backgroundColorHexColorA hex color code
bordersobjectThe borders applied to a cell. Borders may be set by setting applyBordersread-only
borders.bottomBorderThe type of border that should be applied
borders.leftBorderThe type of border that should be applied
borders.rightBorderThe type of border that should be applied
borders.topBorderThe type of border that should be applied
horizontalAlignstringThe horizontal alignment of the content in the cell
indentobjectIndentation of content in the cell
indent.unitstringThe unit of the size
indent.valuenumberThe size of the indent
leaderDotsstringThe leader dot pattern to show on the cell
textRotationstringThe text orientation
verticalAlignstringThe vertical alignment of the content in the cell

Enumerated Values

PropertyValue
horizontalAlignLEFT
horizontalAlignRIGHT
horizontalAlignCENTER
horizontalAlignJUSTIFIED
unitINCHES
unitCENTIMETERS
leaderDotsNARROW
leaderDotsWIDE
textRotationHORIZONTAL
textRotationASCENDING
textRotationDESCENDING
verticalAlignTOP
verticalAlignMIDDLE
verticalAlignBOTTOM

Example

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

ColumnMetadata

Properties

NameTypeDescriptionRestrictions
hiddenbooleanWhether the column is hidden
sizeintegerThe width of the column, in points

Example

{
  "hidden": true,
  "size": 0
}

EffectiveFormats

Properties

NameTypeDescriptionRestrictions
cellFormatCellFormatCell Formats. Fields that are omitted will be ignored.
textFormatTextFormatText formats. Fields that are omitted will be ignored.
valueFormatValueFormatValue Formats. Fields that are omitted will be ignored.

Example

{
  "cellFormat": {
    "backgroundColor": "#4bdf58",
    "borders": {
      "bottom": {
        "color": "#4bdf58",
        "style": "SINGLE",
        "weight": 1
      },
      "left": {
        "color": "#4bdf58",
        "style": "SINGLE",
        "weight": 1
      },
      "right": {
        "color": "#4bdf58",
        "style": "SINGLE",
        "weight": 1
      },
      "top": {
        "color": "#4bdf58",
        "style": "SINGLE",
        "weight": 1
      }
    },
    "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": "BASIS POINTS",
    "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": "BASIS POINTS",
    "suffix": "string",
    "symbolAlign": "LEFT",
    "useParensForNegatives": true,
    "valueFormatType": "AUTOMATIC"
  }
}

Formats

Properties

NameTypeDescriptionRestrictions
cellFormatCellFormatCell Formats. Fields that are omitted will be ignored.
textFormatTextFormatText formats. Fields that are omitted will be ignored.
valueFormatValueFormatValue Formats. Fields that are omitted will be ignored.

Example

{
  "cellFormat": {
    "backgroundColor": "#4bdf58",
    "borders": {
      "bottom": {
        "color": "#4bdf58",
        "style": "SINGLE",
        "weight": 1
      },
      "left": {
        "color": "#4bdf58",
        "style": "SINGLE",
        "weight": 1
      },
      "right": {
        "color": "#4bdf58",
        "style": "SINGLE",
        "weight": 1
      },
      "top": {
        "color": "#4bdf58",
        "style": "SINGLE",
        "weight": 1
      }
    },
    "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": "BASIS POINTS",
    "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": "BASIS POINTS",
    "suffix": "string",
    "symbolAlign": "LEFT",
    "useParensForNegatives": true,
    "valueFormatType": "AUTOMATIC"
  }
}

HexColor

Properties

NameTypeDescriptionRestrictions
stringA hex color code

Example

"#4bdf58"

InheritFrom

Properties

NameTypeDescriptionRestrictions
stringWhere to inherit formats from when performing an insertion

Enumerated Values

PropertyValue
anonymousNONE
anonymousBEFORE
anonymousAFTER

Example

"NONE"

Insertion

Properties

NameTypeDescriptionRestrictions
countintegerThe number of rows or columns to insert
indexintegerThe index to insert at

Example

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

Interval

Properties

NameTypeDescriptionRestrictions
endinteger¦nullThe last index of the interval, inclusive
startinteger¦nullThe first index of the interval, inclusive

Example

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

Range

Properties

NameTypeDescriptionRestrictions
startColumninteger¦nullThe index of the first column of the range, inclusive
startRowinteger¦nullThe index of the first row of the range, inclusive
stopColumninteger¦nullThe index of the last column of the range, inclusive
stopRowinteger¦nullThe index of the last row of the range, inclusive

Example

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

RangeEditValues

Properties

None

Example

[
  [
    null
  ]
]

ResizeRowIntervals

Properties

NameTypeDescriptionRestrictions
intervals[Interval]The intervals of rows to resize
sizeintegerThe new size for the rows, in points

Example

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

ResizeColumnIntervals

Properties

NameTypeDescriptionRestrictions
intervals[Interval]The intervals of columns to resize
sizeintegerThe new size for the columns, in points

Example

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

RowMetadata

Properties

NameTypeDescriptionRestrictions
filteredbooleanWhether the row is filtered
hiddenbooleanWhether the row is hidden
sizeintegerThe height of the row, in points

Example

{
  "filtered": true,
  "hidden": true,
  "size": 0
}

SheetUpdate

Properties

NameTypeDescriptionRestrictions
applyBordersSheetUpdateApplyBordersApply list of border format requests to the sheet
applyFormatsSheetUpdateApplyFormatsApply list of format requests to the sheet
clearBordersSheetUpdateClearBordersClears borders in ranges
clearFormatsSheetUpdateClearFormatsClear formats from ranges
deleteColumnsSheetUpdateDeleteColumnsDelete columns from the sheet
deleteRowsSheetUpdateDeleteRowsDelete rows from the sheet
editCellsSheetUpdateEditCellsEdit a list of cells
editRangeSheetUpdateEditRangeEdit all of the cells in a contiguous range
hideColumnsSheetUpdateHideColumnsHide columns in the sheet
hideRowsSheetUpdateHideRowsHide rows in the sheet
insertColumnsSheetUpdateInsertColumnsInsert columns into the sheet
insertRowsSheetUpdateInsertRowsInsert rows into the sheet
mergeRangesSheetUpdateMergeRangesMerge ranges
resizeColumnsSheetUpdateResizeColumnsResize columns to the specified size
resizeColumnsToFitSheetUpdateResizeColumnsToFitAuto-size columns to fit content
resizeRowsSheetUpdateResizeRowsResize rows to the specified size
resizeRowsToFitSheetUpdateResizeRowsToFitAuto-size rows to fit content
unhideColumnsSheetUpdateUnhideColumnsUnhide columns in the sheet
unhideRowsSheetUpdateUnhideRowsUnhide rows in the sheet
unmergeRangesSheetUpdateUnmergeRangesUnmerge merges that intersect the provided ranges

Example

{
  "applyBorders": {
    "borders": [
      {
        "bottom": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        },
        "innerHorizontal": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        },
        "innerVertical": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        },
        "left": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        },
        "ranges": [
          {
            "startColumn": 0,
            "startRow": 0,
            "stopColumn": 0,
            "stopRow": 0
          }
        ],
        "right": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        },
        "top": {
          "color": "#4bdf58",
          "style": "SINGLE",
          "weight": 1
        }
      }
    ]
  },
  "applyFormats": {
    "formats": [
      {
        "cellFormat": {
          "backgroundColor": "#4bdf58",
          "borders": {
            "bottom": {
              "color": "#4bdf58",
              "style": "SINGLE",
              "weight": 1
            },
            "left": {
              "color": "#4bdf58",
              "style": "SINGLE",
              "weight": 1
            },
            "right": {
              "color": "#4bdf58",
              "style": "SINGLE",
              "weight": 1
            },
            "top": {
              "color": "#4bdf58",
              "style": "SINGLE",
              "weight": 1
            }
          },
          "horizontalAlign": "LEFT",
          "indent": {
            "unit": "INCHES",
            "value": 0
          },
          "leaderDots": "NARROW",
          "textRotation": "HORIZONTAL",
          "verticalAlign": "TOP"
        },
        "ranges": [
          {
            "startColumn": 0,
            "startRow": 0,
            "stopColumn": 0,
            "stopRow": 0
          }
        ],
        "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": "BASIS POINTS",
          "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": "BASIS POINTS",
          "suffix": "string",
          "symbolAlign": "LEFT",
          "useParensForNegatives": true,
          "valueFormatType": "AUTOMATIC"
        }
      }
    ]
  },
  "clearBorders": {
    "ranges": [
      {
        "startColumn": 0,
        "startRow": 0,
        "stopColumn": 0,
        "stopRow": 0
      }
    ]
  },
  "clearFormats": {
    "cellFormatFields": [
      "indent",
      "backgroundColor",
      "leaderDots"
    ],
    "ranges": [
      {
        "startColumn": 0,
        "startRow": 0,
        "stopColumn": 0,
        "stopRow": 0
      }
    ],
    "textFormatFields": [
      "bold",
      "italic",
      "underline"
    ],
    "valueFormatFields": [
      "shownIn",
      "precision",
      "currencySymbol"
    ]
  },
  "deleteColumns": {
    "force": true,
    "intervals": [
      {
        "end": 0,
        "start": 0
      }
    ]
  },
  "deleteRows": {
    "force": true,
    "intervals": [
      {
        "end": 0,
        "start": 0
      }
    ]
  },
  "editCells": {
    "cells": [
      {
        "column": 0,
        "row": 0,
        "value": null
      }
    ]
  },
  "editRange": {
    "range": {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": 0,
      "stopRow": 0
    },
    "values": [
      [
        null
      ]
    ]
  },
  "hideColumns": {
    "force": true,
    "intervals": [
      {
        "end": 0,
        "start": 0
      }
    ]
  },
  "hideRows": {
    "force": true,
    "intervals": [
      {
        "end": 0,
        "start": 0
      }
    ]
  },
  "insertColumns": {
    "inheritFrom": "NONE",
    "insertions": [
      {
        "count": 1,
        "index": 0
      }
    ]
  },
  "insertRows": {
    "inheritFrom": "NONE",
    "insertions": [
      {
        "count": 1,
        "index": 0
      }
    ]
  },
  "mergeRanges": {
    "force": true,
    "mergeType": "ALL",
    "ranges": [
      {
        "startColumn": 0,
        "startRow": 0,
        "stopColumn": 0,
        "stopRow": 0
      }
    ]
  },
  "resizeColumns": {
    "resizeIntervals": [
      {
        "intervals": [
          {
            "end": 0,
            "start": 0
          }
        ],
        "size": 3
      }
    ]
  },
  "resizeColumnsToFit": {
    "intervals": [
      {
        "end": 0,
        "start": 0
      }
    ]
  },
  "resizeRows": {
    "resizeIntervals": [
      {
        "intervals": [
          {
            "end": 0,
            "start": 0
          }
        ],
        "size": 3
      }
    ]
  },
  "resizeRowsToFit": {
    "intervals": [
      {
        "end": 0,
        "start": 0
      }
    ]
  },
  "unhideColumns": {
    "intervals": [
      {
        "end": 0,
        "start": 0
      }
    ]
  },
  "unhideRows": {
    "intervals": [
      {
        "end": 0,
        "start": 0
      }
    ]
  },
  "unmergeRanges": {
    "ranges": [
      {
        "startColumn": 0,
        "startRow": 0,
        "stopColumn": 0,
        "stopRow": 0
      }
    ]
  }
}

TextFormat

Properties

NameTypeDescriptionRestrictions
boldbooleanText bold format
fontColorHexColorA hex color code
fontFamilystringText font format
fontSizenumberText font size, in points
italicbooleanText italic format
strikethroughbooleanText strikethrough format
underlinebooleanText underline format

Example

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

ValueFormat

Properties

NameTypeDescriptionRestrictions
currencySymbolobjectThe currency symbol to display. Valid for ACCOUNTING and CURRENCY. Either generic or currency should be set, but not both.
currencySymbol.currencyobjectAn ISO currency format
currencySymbol.currency.codestringThe ISO currency identifier
currencySymbol.currency.displaystringHow 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.genericstringGeneric currency options
dateAbbreviateMonthbooleanUse month abbreviations instead of full month names. Valid for DATE.
dateFormatStringstringFormat to use when rendering the date. Valid for DATE.
dateUppercaseAllbooleanUppercase all characters in the date string. Valid for DATE.
displayZeroAsstringThe 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.
enteredInstringThe scale cell values are entered in. Valid for AUTOMATIC, ACCOUNTING, CURRENCY, and NUMBER.
numbersAsWordsOptionsobjectOptions 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.capitalizeFirstWordbooleanCapitalize the first word. Valid for ACCOUNTING, CURRENCY, NUMBER, and PERCENT.
numbersAsWordsOptions.displayZeroAsstringThe word to use for zero. Valid for ACCOUNTING, CURRENCY, NUMBER, and PERCENT.
percentSymbolstringRender numbers with a percent symbol. Valid for PERCENT.
periodFormatobjectOptions for formatting a duration string. Valid for PERIOD
periodFormat.capitalizeFirstWordbooleanCapitalize the first word
periodFormat.displaystringMethod of displaying the period value
periodFormat.precisioninteger¦nullPrecision to use when rounding decimal numbers for display. Renders with automatic precision if null.
periodFormat.separatorstringThe separator to use between denominations if multiple are displayed
periodFormat.showLabelsbooleanRender a label after each denomination
periodFormat.showNumbersAsWordsbooleanRender the numbers as words instead of digits
precisionobjectPrecision to use when rounding numbers for display. Valid for AUTOMATIC, ACCOUNTING, CURRENCY, NUMBER, and PERCENT.
precision.autobooleanRender with automatic precision based on the value in the cell
precision.valueintegerExplicit precision value to use. Required unless auto is true.
prefixstringCustom prefix value to render in the cell. Valid for ACCOUNTING, CURRENCY, NUMBER, PERCENT, and DATE.
showCurrencySymbolbooleanRender numbers with a currency symbol. Valid for ACCOUNTING and CURRENCY.
showLeadingZerobooleanInclude a leading zero for decimal numbers with no whole number part. Valid for ACCOUNTING, CURRENCY, NUMBER, and PERCENT.
showNumbersAsWordsbooleanRender the number as words instead of digits. Valid for ACCOUNTING, CURRENCY, NUMBER, and PERCENT.
showPositiveSignbooleanRender the positive sign on numbers greater than zero. Valid for ACCOUNTING, CURRENCY, NUMBER, and PERCENT.
showSignRoundedZerobooleanRender the sign on values rounded to zero. Valid for ACCOUNTING, CURRENCY, NUMBER, and PERCENT.
showThousandsSeparatorbooleanRender the thousands separator. Valid for ACCOUNTING, CURRENCY, NUMBER, and PERCENT.
shownInstringThe scale cell values are displayed in. Valid for AUTOMATIC, ACCOUNTING, CURRENCY, and NUMBER.
suffixstringCustom suffix value to render in the cell. Valid for ACCOUNTING, CURRENCY, NUMBER, PERCENT, and DATE.
symbolAlignstringWhere 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.
useParensForNegativesbooleanRender parentheses around the number instead of a negative symbol. Valid for ACCOUNTING, CURRENCY, NUMBER, and PERCENT.
valueFormatTypestringThe 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

PropertyValue
codeAUD
codeBGN
codeBRL
codeCAD
codeCHF
codeCNH
codeCNY
codeCZK
codeDKK
codeEUR
codeGBP
codeHKD
codeHRK
codeHUF
codeINR
codeISK
codeIDR
codeJPY
codeKRW
codeMXN
codeMYR
codeNOK
codePHP
codePLN
codeRON
codeRSD
codeRUB
codeSEK
codeSGD
codeTHB
codeTRY
codeTWD
codeUAH
codeUSD
codeZAR
codeVND
displaySYMBOL
displaySYMBOL2
displayCODE
genericDOLLAR
genericCENT
displayZeroAsZERO
displayZeroAsEM DASH
enteredInBASIS POINTS
enteredInHUNDREDTHS
enteredInONES
enteredInTHOUSANDS
enteredInTEN THOUSANDS
enteredInMILLIONS
enteredInHUNDRED MILLIONS
enteredInBILLIONS
enteredInTRILLIONS
displayZeroAsZERO
displayZeroAsNO
displayZeroAsNONE
displayZeroAsNOTHING
displayZeroAsNIL
displayZeroAsNOT
displayZeroAsNOMINAL
displayZeroAsIMMATERIAL
percentSymbolNONE
percentSymbolSYMBOL
percentSymbolWORD
displayRAW
displayLARGEST
displayYEARS
displayALL
separatorNONE
separatorCOMMA
shownInBASIS POINTS
shownInHUNDREDTHS
shownInONES
shownInTHOUSANDS
shownInTEN THOUSANDS
shownInMILLIONS
shownInHUNDRED MILLIONS
shownInBILLIONS
shownInTRILLIONS
symbolAlignLEFT
symbolAlignLEFT INSIDE
symbolAlignRIGHT
symbolAlignRIGHT INSIDE
symbolAlignRIGHT SPACED INSIDE
symbolAlignRIGHT SPACED
valueFormatTypeAUTOMATIC
valueFormatTypeAUTOMATIC ACCOUNTING
valueFormatTypeAUTOMATIC CURRENCY
valueFormatTypeAUTOMATIC NUMBER
valueFormatTypeAUTOMATIC PERCENT
valueFormatTypeAUTOMATIC DATE
valueFormatTypeAUTOMATIC PERIOD
valueFormatTypeAUTOMATIC TEXT
valueFormatTypeACCOUNTING
valueFormatTypeCURRENCY
valueFormatTypeNUMBER
valueFormatTypePERCENT
valueFormatTypeDATE
valueFormatTypePERIOD
valueFormatTypeTEXT

Example

{
  "currencySymbol": {
    "currency": {
      "code": "AUD",
      "display": "SYMBOL"
    },
    "generic": "DOLLAR"
  },
  "dateAbbreviateMonth": true,
  "dateFormatString": "d/m/yyyy",
  "dateUppercaseAll": true,
  "displayZeroAs": "ZERO",
  "enteredIn": "BASIS POINTS",
  "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": "BASIS POINTS",
  "suffix": "string",
  "symbolAlign": "LEFT",
  "useParensForNegatives": true,
  "valueFormatType": "AUTOMATIC"
}