API Reference

CreateSheetBody

Properties

NameTypeDescriptionRestrictions
indexinteger(int32)Zero-based index specifying the position of this sheet in relation to sibling sheets. The special value -1 may be used to position a sheet at the end of its siblings list in the outline without knowing how many sheets are in the list.
namestringDisplay name for the sheet
parent_idstringUnique identifier for the parent sheet of the sheet. The empty string value may be used to position the sheet at the top level of the spreadsheet outline.

Example

{
  "index": 0,
  "name": "Data Sheet",
  "parent_id": "d10a604b74564afa86b5ba96755845652"
}

PublishBody

Properties

NameTypeDescriptionRestrictions
allbooleanWhether to publish all links in the spreadsheet (available only as its owner), or only one's own links. By default, false.

Example

{
  "all": false
}

RangeDataBody

Properties

NameTypeDescriptionRestrictions
values[[string, integer, boolean, or number]]Row-major ordered multidimensional array of cell values

Example

{
  "values": [
    [
      "Row1-Column1 Data",
      "Row1-Column2 Data"
    ],
    [
      "Row2-Column1 Data",
      "Row2-Column2 Data"
    ]
  ]
}

SpreadsheetBody

Properties

NameTypeDescriptionRestrictions
namestringDisplay name for the spreadsheet

Example

{
  "name": "Test Spreadsheet"
}

UpdateSheetBody

Properties

NameTypeDescriptionRestrictions
indexinteger(int32)Zero-based index specifying the position of this sheet in relation to sibling sheets. The special value -1 may be used to position a sheet at the end of its siblings list in the outline without knowing how many sheets are in the list.
namestringDisplay name for the sheet
parent_idstringUnique identifier for the parent sheet of the sheet. The empty string value may be used to position the sheet at the top level of the spreadsheet outline.

Example

{
  "index": 0,
  "name": "Data Sheet",
  "parent_id": "d10a604b74564afa86b5ba96755845652"
}