Content

Endpoints for reading and writing Workiva content. See Introduction to Content Endpoints for more information.

Anchor

An anchor is a reference to a specific location within a piece of content.

Properties

Name	Type	Description	Restrictions
attachmentPoint	AnchorAttachmentPoint	An attachment point for an anchor.
content	ContentRef	A reference to a specific content item.
extensionTypes	[ExtensionType]	Indicates the type of the anchor extension.
id	string	The unique identifier for the anchor.
revision	string	Identifies a unique revision of content.

Example

{
  "attachmentPoint": {
    "richTextSelection": {
      "selection": {
        "start": {
          "offset": 0,
          "paragraphIndex": 0
        },
        "stop": {
          "offset": 10,
          "paragraphIndex": 0
        }
      },
      "type": "sourceLink"
    },
    "type": "richTextSelection"
  },
  "content": {
    "location": "<opaque_url>",
    "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag",
    "type": "richText"
  },
  "extensionTypes": [
    "comment"
  ],
  "id": "WAxsaHxoYvTB4D0twUm6YtiF99TNO0gBkSOhgYBed9AMB99EUxqELDQychBaGR9SkZucm5sK",
  "revision": "24601abc"
}

AnchorAttachmentPoint

An attachment point for an anchor.

Properties

Name	Type	Description	Restrictions
drawingRichTextSelection	DrawingRichTextSelectionAnchorAttachmentPoint¦null	An attachment point to a selection in a drawing’s rich text content.
drawingSelection	DrawingElementAnchorAttachmentPoint¦null	An attachment point to a selection of drawing elements in a drawing.
richTextSelection	RichTextSelectionAnchorAttachmentPoint¦null	An attachment point to a selection in rich text content.
tableRange	TableRangeAnchorAttachmentPoint¦null	A table range anchor attachment point.
type	string	The type of attachment point.

Enumerated Values

Property	Value
type	richTextSelection
type	tableRange
type	drawingSelection
type	drawingRichTextSelection

Example

{
  "richTextSelection": {
    "selection": {
      "start": {
        "offset": 0,
        "paragraphIndex": 0
      },
      "stop": {
        "offset": 10,
        "paragraphIndex": 0
      }
    },
    "type": "sourceLink"
  },
  "type": "richTextSelection"
}

AnchorExtension

Information about how an anchor is used. When an anchor is first created it will not be associated with any extensions. Once an anchor is used, its extension type will be set.

Properties

Name	Type	Description	Restrictions
id	string	The unique identifier of the extension. This can be used to lookup the associated resource. This ID will be null if the resource doesn’t have an ID. For example, comment extensions don’t have an id because they’re looked up by their respective anchor IDs instead.
type	ExtensionType	Indicates the type of the anchor extension.

Example

{
  "id": "2c64382b45553de1",
  "type": "comment"
}

AnchorExtensionsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of AnchorExtension 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¦null	Pagination link for next set of results
data	[AnchorExtension]	Information about how an anchor is used. When an anchor is first created it will not be associated with any extensions. Once an anchor is used, its extension type will be set.	read-only
revision	Revision	Identifies a unique revision of content. The same revision can be used for any content request within a file because revisions are allocated at the file-level. When querying for content, this can be used to get a consistent version of the content. When editing content, this can be used to make the change to the content at a known state. In either case, omitting the revision (when allowed) will always default to the latest revision of the file.

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "id": "2c64382b45553de1",
      "type": "comment"
    }
  ],
  "revision": "2c6438ab4541de6d"
}

AnchorRef

A reference to an anchor

Properties

Name	Type	Description	Restrictions
anchor	string	The unique identifier for the anchor.	required
content	ContentRef	A reference to a specific content item.	required
location	string¦null	❗️ Deprecated: A URL that a GET request can be made against to retrieve this anchor
revision	string	The revision of the anchor being referred to	required

Example

{
  "anchor": "WA46Pio9ANITRWdzvNwY4F50bj3yHRZoyHrY2N1L7rNyQywqAva9B4dgqzIvIqHAg4ODg6e",
  "content": {
    "richText": "WA9ATl59AXnS148HVGnq9ARvjSyJtUu7DObtx9AfnvtSBXU5YqMpFAZR36Mai1g",
    "type": "richText"
  },
  "location": "<opaque_url>",
  "revision": "2c6438ab4541de6f"
}

AnchorsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of Anchor 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¦null	Pagination link for next set of results
data	[Anchor]	An anchor is a reference to a specific location within a piece of content.	read-only
revision	Revision	Identifies a unique revision of content. The same revision can be used for any content request within a file because revisions are allocated at the file-level. When querying for content, this can be used to get a consistent version of the content. When editing content, this can be used to make the change to the content at a known state. In either case, omitting the revision (when allowed) will always default to the latest revision of the file.

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "attachmentPoint": {
        "richTextSelection": {
          "selection": {
            "start": {
              "offset": 0,
              "paragraphIndex": 0
            },
            "stop": {
              "offset": 10,
              "paragraphIndex": 0
            }
          },
          "type": "sourceLink"
        },
        "type": "richTextSelection"
      },
      "content": {
        "location": "<opaque_url>",
        "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag",
        "type": "richText"
      },
      "extensionTypes": [
        "comment"
      ],
      "id": "WAxsaHxoYvTB4D0twUm6YtiF99TNO0gBkSOhgYBed9AMB99EUxqELDQychBaGR9SkZucm5sK",
      "revision": "24601abc"
    }
  ],
  "revision": "2c6438ab4541de6d"
}

ApplicableTextFormat

Formatting options to be applied to rich text elements

Properties

Name	Type	Description	Restrictions
backgroundColor	Color¦null	Represents a color.
baselineShift	RichTextBaselineShift	Indicates the offset from the baseline of the characters. The baseline is the imaginary bottom line for a line of text which the bottom of the characters are placed, not including any descender such as g, j, p, and y have. superscript shifts the baseline up and reduces the rendered font size to 65% of the specified font size. subscript works the same as superscript except it moves the baseline down. baseline uses the default size and baseline for regular text. type: string
bold	boolean¦null	Whether or not the text is bold
characterSpacing	integer¦null	The amount of space between characters in thousanths of an em	Maximum: 1000, Minimum: -1000
font	string¦null	The name of the font
italic	boolean¦null	Whether or not the text is italicized
size	number¦null	The font size of the characters in points	Maximum: 720, Minimum: 1
strikethrough	boolean¦null	Whether or not the text is struck through
textColor	Color¦null	Represents a color.
underline	boolean¦null	Whether or not to underline the text

Example

{
  "backgroundColor": {
    "blue": 255,
    "green": 255,
    "red": 255
  },
  "baselineShift": "superscript",
  "bold": true,
  "characterSpacing": 100,
  "font": "Times New Roman",
  "italic": true,
  "size": 14,
  "strikethrough": true,
  "textColor": {
    "blue": 0,
    "green": 0,
    "red": 0
  },
  "underline": true
}

BaseDrawingElement

A foundational element for all drawing models.

Properties

Name	Type	Description	Restrictions
dimensions	Dimensions	A dimension of a rectangle for properties of objects such as a shape, text box, table, chart, image, or page.	required
fill	Fill	A shape or box fill settings for things like shapes. Use a null to indicate no fill.
id	DrawingElementId	Identifier of the drawing element	required
margins	Margins	The margins of a rectangle for properties of objects such as a shape, text box, or page.	required
position	DrawingRelativePosition	The relative position of a drawing element.	required
stroke	Stroke	Line stroke setting for things like shape edges. Use a null to indicate no stroke line.
wrapStyle	WrapStyleType	The relative position type	required

Example

{
  "dimensions": {
    "height": 240,
    "width": 320
  },
  "fill": {
    "color": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "opacity": 0.5
  },
  "id": "WW91IGZvdW5kIG1lIQ",
  "margins": {
    "bottom": 10,
    "left": 10,
    "right": 10,
    "top": 10
  },
  "position": {
    "paragraphRelative": {
      "paragraphIndex": 3,
      "x": 0,
      "y": 0
    },
    "type": "paragraphRelative"
  },
  "stroke": {
    "color": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "pattern": "solid",
    "width": 2
  },
  "wrapStyle": "inFrontOfText"
}

BaseTextElement

A base text element is the common requirement for all text element models.

Properties

Name	Type	Description	Restrictions
format	RichTextFormat	The formatting options applied to rich text elements.
length	integer	The number of characters (32-bit unicode code point) for a text element or range of text in a selection. Most elements will have a length of 1, even if it is dynamic content which will be replaced by possibly multiple characters. The lengths are used when editing with offsets from an element. The sum of the lengths up to a specific element from another is the offset between those text elements.	required, Minimum: 1
offset	integer	The number of items to skip over in a collection before the items which will be returned or worked on. The items may be shapes, sections, elements, characters, slides, etc depending on which object or path the offset is being used on.	required, Minimum: 0
style	StyleRef	A reference to a style.

Example

{
  "format": {
    "backgroundColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "baselineShift": "superscript",
    "bold": true,
    "characterSpacing": -25,
    "font": "Times New Roman",
    "italic": true,
    "size": 14,
    "strikethrough": true,
    "textColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "underline": true
  },
  "length": 1,
  "offset": 10,
  "style": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "style": "c3R5bGUta2V5Ol90Ymw",
    "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
  }
}

Caret

A caret (as in Caret Navigation) is a location between two characters in a paragraph.

Properties

Name	Type	Description	Restrictions
offset	integer	The number of characters to skip over in a paragraph to where the Caret is located.	required
paragraphIndex	integer	The zero-based index of a paragraph.	required

Example

{
  "offset": 10,
  "paragraphIndex": 1
}

Cell

A cell indicates a single cell in a table. All indexes are zero based.

Properties

Name	Type	Description	Restrictions
column	integer	The zero-based index of a column in a table.	required, Minimum: 0
row	integer	The zero-based index of a row in a table.	required, Minimum: 0

Example

{
  "column": 9,
  "row": 5
}

CellBorder

The border of a rectangle for properties of objects such as a table cell.

Properties

Name	Type	Description	Restrictions
color	Color	Represents a color.	required
style	string	The style of the border to apply.	required
weight	number	The thickness of the border, in points. Rounded to the nearest hundredth.	required

Enumerated Values

Property	Value
style	single
style	double
style	dashed1
style	dashed2
style	dashed3
style	dashed4
style	dashed5

Example

{
  "color": {
    "blue": 255,
    "green": 136,
    "red": 155
  },
  "style": "single",
  "weight": 1.5
}

CellBorders

The borders of the table cell.

Properties

Name	Type	Description	Restrictions
bottom	CellBorder¦null	The border of a rectangle for properties of objects such as a table cell.
left	CellBorder¦null	The border of a rectangle for properties of objects such as a table cell.
right	CellBorder¦null	The border of a rectangle for properties of objects such as a table cell.
top	CellBorder¦null	The border of a rectangle for properties of objects such as a table cell.

Example

{
  "bottom": {
    "color": {
      "blue": 255,
      "green": 136,
      "red": 155
    },
    "style": "single",
    "weight": 1
  },
  "left": {
    "color": {
      "blue": 255,
      "green": 136,
      "red": 155
    },
    "style": "single",
    "weight": 1
  },
  "right": {
    "color": {
      "blue": 255,
      "green": 136,
      "red": 155
    },
    "style": "single",
    "weight": 1
  },
  "top": {
    "color": {
      "blue": 255,
      "green": 136,
      "red": 155
    },
    "style": "single",
    "weight": 1
  }
}

CellDestinationLinkValue

A cell-level destination link. The content of cell destination links cannot be edited with rich cell edits, but other cell edits are supported.

Properties

Name	Type	Description	Restrictions
destinationLink	DestinationLinkRef	A reference to a destination link.	required
paragraphs	[SourceParagraph]	Paragraphs contained in this cell.	required

Example

{
  "destinationLink": {
    "destinationLink": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
    "revision": "24601abc"
  },
  "paragraphs": [
    {
      "elements": [
        {
          "textSpan": {
            "format": {
              "font": "Times New Roman",
              "italic": true,
              "size": 12
            },
            "length": 11,
            "offset": 0,
            "style": {
              "revision": "1A2B3C4D",
              "style": "WW91IGZvdW5kIG1lIQ",
              "styleGuide": "WW91IGZvdW5kIG1lIQ"
            },
            "text": "Hello World"
          },
          "type": "textSpan"
        }
      ],
      "format": {
        "bold": true
      },
      "list": {
        "level": 2,
        "prefix": "[",
        "startAt": 1,
        "style": {
          "style": "WW91IGZvdW5kIG1lIQ",
          "styleGuide": "WW91IGZvdW5kIG1lIQ"
        },
        "suffix": "]"
      },
      "properties": {},
      "style": {
        "style": "X3R4dDozZDUyMDg4ODBlNDk0YmYxYWVjYTIzM2VlYmY3ODM4Mg",
        "styleGuide": "3d5208880e494bf1aeca233eebf78382"
      }
    }
  ]
}

CellFormulaValue

The content of a formula cell. These cells cannot be edited with rich cell edits, but other cell edits are supported.

Properties

Name	Type	Description	Restrictions
calculatedValue	string	The computed value of the formula without any value formatting applied The formula itself is in the “rawValue” property of the cell.	required
effectiveValue	string	The computed value of the formula with value formatting applied, exactly as it is displayed in the app. The formula itself is in the cell’s “rawValue” property.	required
format	RichTextFormat¦null	The formatting options applied to rich text elements.	required
style	StyleRef	A reference to a style.	required

Example

{
  "calculatedValue": "24",
  "effectiveValue": "25",
  "format": {
    "bold": true,
    "font": "Arial",
    "size": 24
  },
  "style": {
    "revision": "1A2B3C4D",
    "style": "WW91IGZvdW5kIG1lIQ",
    "styleGuide": "WW91IGZvdW5kIG1lIQ"
  }
}

CellHorizontalAlignment

The horizontal alignment of the content in the cell.

Properties

Name	Type	Description	Restrictions
anonymous	string¦null	The horizontal alignment of the content in the cell.

Enumerated Values

Property	Value
anonymous	left
anonymous	center
anonymous	right
anonymous	justified

Example

"center"

CellPlainTextValue

The content of a plain text cell. These cells contain a non-text value formatted value (such as a number or a date) and thus cannot be edited with rich cell edits, but other cell edits are supported. To perform rich edits on this cell you first need to either change the value format to “Text” or assign the cell’s value to something that cannot be value formatted.

Properties

Name	Type	Description	Restrictions
effectiveValue	string	The value after it has been value formatted, exactly as it is displayed in the app. The original value is in the cell’s “rawValue” property.	required
format	RichTextFormat¦null	The formatting options applied to rich text elements.	required
style	StyleRef	A reference to a style.	required

Example

{
  "effectiveValue": "25",
  "format": {
    "bold": true,
    "font": "Arial",
    "size": 24
  },
  "style": {
    "revision": "1A2B3C4D",
    "style": "WW91IGZvdW5kIG1lIQ",
    "styleGuide": "WW91IGZvdW5kIG1lIQ"
  }
}

CellRange

A range of cells in a table. If any field is omitted or null, the range is unbounded in that direction. All indexes are zero based.

Properties

Name	Type	Description	Restrictions
startColumn	integer¦null	The index of the first column (inclusive) of the range.
startRow	integer¦null	The index of the first row (inclusive) of the range.
stopColumn	integer¦null	The index of the last column (inclusive) of the range.
stopRow	integer¦null	The index of the last row (inclusive) of the range.

Example

{
  "startColumn": 0,
  "startRow": 5,
  "stopColumn": 3,
  "stopRow": 9
}

CellRanges

A collection of cell ranges in a table.

Properties

Name	Type	Description	Restrictions
anonymous	[CellRange]	A collection of cell ranges in a table.	Minimum items: 1

Example

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

CellRichTextValue

The content of a rich text cell. This is the default type for cells before any content is set on them.

Properties

Name	Type	Description	Restrictions
paragraphs	[Paragraph]	Paragraphs contained in this cell.	required

Example

{
  "paragraphs": [
    {
      "elements": [
        {
          "chart": {
            "dimensions": {
              "height": 240,
              "width": 240
            },
            "length": 10,
            "offset": 10,
            "style": {
              "location": "<opaque_url>",
              "revision": "2B3C4D5E",
              "style": "c3R5bGUta2V5Ol90Ymw",
              "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
            },
            "table": {
              "revision": "24601abc",
              "table": "WA66srK9AtGU3PvTjs4dMCR9B34EoH6LqyloPIRNdxS5Bgs3p199MQzPsA"
            }
          },
          "type": "chart"
        }
      ],
      "format": {
        "bold": true,
        "font": "Arial",
        "size": 24
      },
      "index": 3,
      "properties": {}
    }
  ]
}

CellValue

The content of a cell.

Properties

Name	Type	Description	Restrictions
destinationLink	CellDestinationLinkValue¦null	A cell-level destination link. The content of cell destination links cannot be edited with rich cell edits, but other cell edits are supported.
formula	CellFormulaValue¦null	The content of a formula cell. These cells cannot be edited with rich cell edits, but other cell edits are supported.
plainText	CellPlainTextValue¦null	The content of a plain text cell. These cells contain a non-text value formatted value (such as a number or a date) and thus cannot be edited with rich cell edits, but other cell edits are supported. To perform rich edits on this cell you first need to either change the value format to “Text” or assign the cell’s value to something that cannot be value formatted.
richText	CellRichTextValue¦null	The content of a rich text cell. This is the default type for cells before any content is set on them.
type	string	The type of content in a cell.	required

Enumerated Values

Property	Value
type	destinationLink
type	formula
type	plainText
type	richText

Example

{
  "destinationLink": {
    "destinationLink": {
      "destinationLink": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
      "revision": "24601abc"
    },
    "paragraphs": [
      {
        "elements": [
          {
            "textSpan": {
              "format": {
                "font": "Times New Roman",
                "italic": true,
                "size": 12
              },
              "length": 11,
              "offset": 0,
              "style": {
                "revision": "1A2B3C4D",
                "style": "WW91IGZvdW5kIG1lIQ",
                "styleGuide": "WW91IGZvdW5kIG1lIQ"
              },
              "text": "Hello World"
            },
            "type": "textSpan"
          }
        ],
        "format": {
          "bold": true
        },
        "list": {
          "level": 2,
          "prefix": "[",
          "startAt": 1,
          "style": {
            "style": "WW91IGZvdW5kIG1lIQ",
            "styleGuide": "WW91IGZvdW5kIG1lIQ"
          },
          "suffix": "]"
        },
        "properties": {},
        "style": {
          "style": "X3R4dDozZDUyMDg4ODBlNDk0YmYxYWVjYTIzM2VlYmY3ODM4Mg",
          "styleGuide": "3d5208880e494bf1aeca233eebf78382"
        }
      }
    ]
  },
  "type": "destinationLink"
}

CellVerticalAlignment

The vertical alignment of the content in the cell.

Properties

Name	Type	Description	Restrictions
anonymous	string¦null	The vertical alignment of the content in the cell.

Enumerated Values

Property	Value
anonymous	top
anonymous	middle
anonymous	bottom

Example

"middle"

ChangeSourceRange

Changes a source links range

Properties

Name	Type	Description	Restrictions
range	CellRange	A range of cells in a table. If any field is omitted or null, the range is unbounded in that direction. All indexes are zero based.	required
rangeLink	RangeLinkId	The unique identifier of a range link.	required

Example

{
  "range": {
    "startColumn": 0,
    "startRow": 5,
    "stopColumn": 3,
    "stopRow": 9
  },
  "rangeLink": "WAxsaHxoYvTB4D0twUm6YtiF99TNO0gBkSOhgYBed9AMB99EUxqELDQychBaGR9SkZucm5sK"
}

ChartDrawingElement

A drawing element for a chart.

Properties

Name	Type	Description	Restrictions
dimensions	Dimensions	A dimension of a rectangle for properties of objects such as a shape, text box, table, chart, image, or page.
fill	Fill	A shape or box fill settings for things like shapes. Use a null to indicate no fill.
id	DrawingElementId	Identifier of the drawing element
margins	Margins	The margins of a rectangle for properties of objects such as a shape, text box, or page.
position	DrawingRelativePosition	The relative position of a drawing element.
stroke	Stroke	Line stroke setting for things like shape edges. Use a null to indicate no stroke line.
table	TableRef	A reference to table content in a document, spreadsheet, or presentation
wrapStyle	WrapStyleType	The relative position type

Example

{
  "dimensions": {
    "height": 240,
    "width": 320
  },
  "fill": {
    "color": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "opacity": 0.5
  },
  "id": "WW91IGZvdW5kIG1lIQ",
  "margins": {
    "bottom": 10,
    "left": 10,
    "right": 10,
    "top": 10
  },
  "position": {
    "paragraphRelative": {
      "paragraphIndex": 3,
      "x": 0,
      "y": 0
    },
    "type": "paragraphRelative"
  },
  "stroke": {
    "color": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "pattern": "solid",
    "width": 2
  },
  "table": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "table": "WA7i5vbm7lNaEn6XT97lNaEn6XT9AtcW5vb22BJjMrqxmrujMrqxmru"
  },
  "wrapStyle": "inFrontOfText"
}

ChartTextElement

An embedded content text element for a chart.

Properties

Name	Type	Description	Restrictions
dimensions	Dimensions	A dimension of a rectangle for properties of objects such as a shape, text box, table, chart, image, or page.
format	RichTextFormat	The formatting options applied to rich text elements.
length	integer	The number of characters (32-bit unicode code point) for a text element or range of text in a selection. Most elements will have a length of 1, even if it is dynamic content which will be replaced by possibly multiple characters. The lengths are used when editing with offsets from an element. The sum of the lengths up to a specific element from another is the offset between those text elements.	Minimum: 1
offset	integer	The number of items to skip over in a collection before the items which will be returned or worked on. The items may be shapes, sections, elements, characters, slides, etc depending on which object or path the offset is being used on.	Minimum: 0
style	StyleRef	A reference to a style.
table	TableRef	A reference to table content in a document, spreadsheet, or presentation

Example

{
  "dimensions": {
    "height": 240,
    "width": 320
  },
  "format": {
    "backgroundColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "baselineShift": "superscript",
    "bold": true,
    "characterSpacing": -25,
    "font": "Times New Roman",
    "italic": true,
    "size": 14,
    "strikethrough": true,
    "textColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "underline": true
  },
  "length": 1,
  "offset": 10,
  "style": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "style": "c3R5bGUta2V5Ol90Ymw",
    "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
  },
  "table": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "table": "WA7i5vbm7lNaEn6XT97lNaEn6XT9AtcW5vb22BJjMrqxmrujMrqxmru"
  }
}

ClearCellsBorders

Clears the cell borders from all the cells in the given ranges of a table.

Properties

Name	Type	Description	Restrictions
clearAll	boolean	Whether to clear all cell borders.
ranges	CellRanges	A collection of cell ranges in a table.	required

Example

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

ClearCellsFormat

Clears the text formatting from all the cells in the given ranges of a table. This will not clear out styles nor hyperlinks.

Properties

Name	Type	Description	Restrictions
clearAll	boolean	Whether or not to clear all cell formats. This is the same as setting every other option to true. When new text formats are added those will also be cleared. When true, all other clear option values are ignored.
clearBackgroundColor	boolean	Whether or not clear the background color.
clearBold	boolean	Whether or not clear the bold format.
clearCharacterSpacing	boolean	Whether or not clear the character spacing.
clearFont	boolean	Whether or not to clear the font.
clearItalic	boolean	Whether or not clear the italic format.
clearSize	boolean	Whether or not clear the font size.
clearStrikeThrough	boolean	Whether or not clear the strikethrough.
clearTextColor	boolean	Whether or not clear the text color.
clearUnderline	boolean	Whether or not clear the underline.
ranges	CellRanges	A collection of cell ranges in a table.	required

Example

{
  "clearAll": false,
  "clearBackgroundColor": true,
  "clearBold": false,
  "clearCharacterSpacing": true,
  "clearFont": true,
  "clearItalic": true,
  "clearSize": false,
  "clearStrikeThrough": true,
  "clearTextColor": true,
  "clearUnderline": true,
  "ranges": [
    {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": 2,
      "stopRow": 2
    }
  ]
}

ClearCellsProperties

Clears the cell properties from all the cells in the given ranges of a table. This will not clear out styles, formats, or hyperlinks.

Properties

Name	Type	Description	Restrictions
clearAll	boolean	Whether to clear all cell properties. This is the same as setting every other option to true. When new cell properties are added those will also be cleared. When true, all other clear option values are ignored.
clearFillColor	boolean	Whether to clear the fill color.
clearHorizontalAlignment	boolean	Whether to clear the horizontal alignment.
clearIndent	boolean	Whether to clear the indent.
clearVerticalAlignment	boolean	Whether to clear the vertical alignment.
ranges	CellRanges	A collection of cell ranges in a table.	required

Example

{
  "clearAll": false,
  "clearFillColor": true,
  "clearHorizontalAlignment": false,
  "clearIndent": false,
  "clearVerticalAlignment": false,
  "ranges": [
    {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": 2,
      "stopRow": 2
    }
  ]
}

ClearCellsText

Deletes the text from all the cells in the ranges of a table. This will not remove the text formatting applied to the cells. The cells locations will remain, although empty, even if a complete row or column is specified by the range.

Properties

Name	Type	Description	Restrictions
ranges	CellRanges	A collection of cell ranges in a table.	required

Example

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

ClearListFormat

An edit to clear list formatting from a range of paragraphs in rich text. Not supported when the parent batch has isolated edits turned on.

Properties

Name	Type	Description	Restrictions
clearAll	boolean	Whether to clear all list formats. This is the same as setting every other option to true. When new list formats are added to the api those will also be cleared. When true, all other clear option values are ignored.
clearPrefix	boolean	Whether to clear the list prefix.
clearStartAt	boolean	Whether to clear the start number of the list.
clearStyle	boolean	Whether to clear the list style.
clearSuffix	boolean	Whether to clear the list suffix.
selection	ParagraphSelection	A selection of one or more paragraphs, starting from the start paragraph and ending with the stop paragraph. Both start and stop paragraph indexes are inclusive.	required

Example

{
  "clearAll": false,
  "clearPrefix": true,
  "clearStartAt": true,
  "clearStyle": true,
  "clearSuffix": true,
  "selection": {
    "start": 1,
    "stop": 3
  }
}

ClearParagraphProperties

An edit to clear paragraph properties from a range of paragraphs in rich text.

Properties

Name	Type	Description	Restrictions
clearAlignment	boolean	Whether to clear the alignment.
clearAll	boolean	Whether to clear all paragraph properties. This is the same as setting every other option to true. When new paragraph properties are added those will also be cleared. When true, all other clear option values are ignored.
clearEndIndent	boolean	Whether to clear the end indent.
clearFirstLineIndent	boolean	Whether to clear the first line indent.
clearLineSpacing	boolean	Whether to clear the line spacing.
clearPageBreakBefore	boolean	Whether to clear page break before.
clearSpaceAfterParagraph	boolean	Whether to clear the space after paragraph.
clearSpaceBeforeParagraph	boolean	Whether to clear the space before paragraph.
clearStartIndent	boolean	Whether to clear the start indent.
selection	ParagraphSelection	A selection of one or more paragraphs, starting from the start paragraph and ending with the stop paragraph. Both start and stop paragraph indexes are inclusive.	required

Example

{
  "clearAlignment": true,
  "clearAll": false,
  "clearEndIndent": true,
  "clearFirstLineIndent": true,
  "clearLineSpacing": true,
  "clearPageBreakBefore": true,
  "clearSpaceAfterParagraph": true,
  "clearSpaceBeforeParagraph": true,
  "clearStartIndent": true,
  "selection": {
    "start": 1,
    "stop": 3
  }
}

ClearSectionLockEdit

Clears the selected section’s lock value

Properties

Name	Type	Description	Restrictions
selection	SectionSelection	A selection of one or more sections	required

Example

{
  "selection": [
    "e34730f79a144b1b8977aa8884c208ee_321",
    "e34730f79a144b1b8977aa8884c208ee_123"
  ]
}

ClearTextFormat

An edit to clear formatting from a range of rich text. This will not clear out styles nor hyperlinks.

Properties

Name	Type	Description	Restrictions
clearAll	boolean	Whether to clear all text formats. This is the same as setting every other option to true. When new text formats are added those will also be cleared. When true, all other clear option values are ignored.
clearBackgroundColor	boolean	Whether to clear the background color.
clearBaselineShift	boolean	Whether to clear the baseline shift.
clearBold	boolean	Whether to clear bold.
clearCharacterSpacing	boolean	Whether to clear the character spacing.
clearFont	boolean	Whether to clear the font.
clearItalic	boolean	Whether to clear italic.
clearSize	boolean	Whether to clear the font size.
clearStrikethrough	boolean	Whether to clear strikethrough.
clearTextColor	boolean	Whether to clear the text color.
clearUnderline	boolean	Whether to clear underline.
selection	RichTextSelection	Describes a selection within piece of rich text	required

Example

{
  "clearAll": false,
  "clearBackgroundColor": true,
  "clearBaselineShift": true,
  "clearBold": true,
  "clearCharacterSpacing": true,
  "clearFont": true,
  "clearItalic": true,
  "clearSize": true,
  "clearStrikethrough": true,
  "clearTextColor": true,
  "clearUnderline": true,
  "selection": {
    "start": {
      "offset": 0,
      "paragraphIndex": 0
    },
    "stop": {
      "offset": 10,
      "paragraphIndex": 2
    }
  }
}

Color

Represents a color.

Properties

Name	Type	Description	Restrictions
blue	integer	The blue component of the color.	required, Maximum: 255, Minimum: 0
green	integer	The green component of the color.	required, Maximum: 255, Minimum: 0
red	integer	The red component of the color.	required, Maximum: 255, Minimum: 0

Example

{
  "blue": 128,
  "green": 128,
  "red": 128
}

ColumnPropertiesListResult

Data model for column properties list

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	[TableColumnProperties]	The current page of column properties
revision	Revision	Identifies a unique revision of content. The same revision can be used for any content request within a file because revisions are allocated at the file-level. When querying for content, this can be used to get a consistent version of the content. When editing content, this can be used to make the change to the content at a known state. In either case, omitting the revision (when allowed) will always default to the latest revision of the file.

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "hidden": false,
      "width": 60
    }
  ],
  "revision": "2c6438ab4541de6d"
}

ColumnRange

Describes a column range

Properties

Name	Type	Description	Restrictions
startColumn	integer	The zero based index of the start of the range (inclusive).	Minimum: 0
stopColumn	integer	The zero based index of the end of the range (inclusive).	Minimum: 0

Example

{
  "startColumn": 5,
  "stopColumn": 5
}

ContentRef

A reference to a specific content item.

Properties

Name	Type	Description	Restrictions
drawing	string¦null	Identifier of a drawing or null if the content isn’t a drawing.
location	string¦null	❗️ Deprecated: A URL that a GET request can be made against to retrieve this content.	read-only
richText	string¦null	Identifier of a rich text or null if the content isn’t a rich text.
table	TableId¦null	Identifier of a table or null if the content isn’t a table.
type	string	The type of content.

Enumerated Values

Property	Value
type	richText
type	table
type	drawing

Example

{
  "location": "<opaque_url>",
  "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag",
  "type": "richText"
}

CreateDestinationRangeLink

Creates a range destination link on the provided range

Properties

Name	Type	Description	Restrictions
applyColumnWidth	boolean	Whether to inherit column widths from the source.
applyFormatting	boolean	Whether to inherit formatting from the source.
sourceRangeLink	RangeLinkId	The unique identifier of a range link.	required
sourceTable	string	The unique identifier for the source table.	required

Example

{
  "applyColumnWidth": true,
  "applyFormatting": true,
  "sourceRangeLink": "WAxsaHxoYvTB4D0twUm6YtiF99TNO0gBkSOhgYBed9AMB99EUxqELDQychBaGR9SkZucm5sK",
  "sourceTable": "WAxsaHxoYvTB4D0twUm6YtiF99TNO0gBkSOhgYBed9AMB99EUxqELDQychBaGR9SkZucm5sK"
}

CreateSourceRangeLink

Creates a range source link on the provided range

Properties

Name	Type	Description	Restrictions
range	CellRange	A range of cells in a table. If any field is omitted or null, the range is unbounded in that direction. All indexes are zero based.	required

Example

{
  "range": {
    "startColumn": 0,
    "startRow": 5,
    "stopColumn": 3,
    "stopRow": 9
  }
}

DeleteColumns

Delete one or more columns from the table

Properties

Name	Type	Description	Restrictions
columns	ColumnRange	Describes a column range

Example

{
  "columns": {
    "startColumn": 5,
    "stopColumn": 5
  }
}

DeleteRows

Delete one or more rows from the table

Properties

Name	Type	Description	Restrictions
rows	RowRange	Describes a row range

Example

{
  "rows": {
    "startRow": 5,
    "stopRow": 5
  }
}

DeleteText

An edit to delete text from a range of rich text. Note that all content, such as tables, images, charts, or footnotes, will also be deleted. Links must be removed from the selection using a RemoveLinks links edit before deleting a selection containing links.

Properties

Name	Type	Description	Restrictions
selection	RichTextSelection	Describes a selection within piece of rich text	required

Example

{
  "selection": {
    "start": {
      "offset": 0,
      "paragraphIndex": 0
    },
    "stop": {
      "offset": 10,
      "paragraphIndex": 2
    }
  }
}

DesignPageRelative

Represents the position of a drawing relative to the top-left corner of the section.

Properties

Name	Type	Description	Restrictions
x	number	The horizontal offset in points typically from the left edge.
y	number	The vertical offset in points typically from the top edge where larger numbers are further down/

Example

{
  "x": 0,
  "y": 0
}

DestinationLink

Content containing a destination link.

Properties

Name	Type	Description	Restrictions
content	ContentRef	A reference to a specific content item.	required
id	string	The unique identifier for the destination link.	required
revision	string	Identifies a unique revision of content.	required
source	DestinationLinkSource	The source of destination link content.	required
status	DestinationLinkStatus	Destination link status	required

Example

{
  "content": {
    "richText": "WA9ATl59AXnS148HVGnq9ARvjSyJtUu7DObtx9AfnvtSBXU5YqMpFAZR36Mai1g",
    "type": "richText"
  },
  "id": "WA5SVkJWXOy5MbSHX25Qf9BVz5xTvLfJadt5eXzqTxLT4o2Lo1ceQHmLbSppCdBhQUFBSE",
  "revision": "2c6438ab4541de6d",
  "source": {
    "anchor": {
      "anchor": "WA46Pio9ANITRWdzvNwY4F50bj3yHRZoyHrY2N1L7rNyQywqAva9B4dgqzIvIqHAg4ODg6e",
      "content": {
        "richText": "WA9ATl59AXnS148HVGnq9ARvjSyJtUu7DObtx9AfnvtSBXU5YqMpFAZR36Mai1g",
        "type": "richText"
      },
      "location": "<opaque_url>",
      "revision": "2c6438ab4541de6f"
    },
    "type": "anchor"
  },
  "status": "connected"
}

DestinationLinkRef

A reference to a destination link.

Properties

Name	Type	Description	Restrictions
destinationLink	string	The unique identifier of a destination link.	required
revision	string	The version of the destination link.	required

Example

{
  "destinationLink": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
  "revision": "24601abc"
}

DestinationLinkSource

The source of destination link content.

Properties

Name	Type	Description	Restrictions
anchor	AnchorRef¦null	Reference to the source anchor if the type is anchor.
type	DestinationLinkSourceType	The type of the source for a destination link. Will be unidentified if the type of the source isn’t currently supported.	required
unidentified	object¦null	Reference to an unidentified source if the type is unidentified.

Example

{
  "anchor": {
    "anchor": "WA46Pio9ANITRWdzvNwY4F50bj3yHRZoyHrY2N1L7rNyQywqAva9B4dgqzIvIqHAg4ODg6e",
    "content": {
      "richText": "WA9ATl59AXnS148HVGnq9ARvjSyJtUu7DObtx9AfnvtSBXU5YqMpFAZR36Mai1g",
      "type": "richText"
    },
    "location": "<opaque_url>",
    "revision": "2c6438ab4541de6f"
  },
  "type": "anchor"
}

DestinationLinkSourceConversionResult

A result of a destination link source conversion operation.

Properties

Name	Type	Description	Restrictions
anchor	string¦null	The unique identifier for the anchor.
destinationLink	string¦null	The unique identifier for the destination link.
type	DestinationLinkSourceConversionResultType	The type of the destination link source conversion result.	required

Example

{
  "anchor": "WA5SVkJWXOy5MbSHX25Qf9BVz5xTvLfJadt5eXzqTxLT4o2Lo1ceQHmLbSppCdBhQUFBSE",
  "type": "anchor"
}

DestinationLinkSourceConversionResultType

The type of the destination link source conversion result.

Properties

Name	Type	Description	Restrictions
anonymous	string	The type of the destination link source conversion result.

Enumerated Values

Property	Value
anonymous	anchor
anonymous	destinationLink

Example

"anchor"

DestinationLinkSourceType

The type of the source for a destination link. Will be unidentified if the type of the source isn’t currently supported.

Properties

Name	Type	Description	Restrictions
anonymous	string	The type of the source for a destination link. Will be unidentified if the type of the source isn’t currently supported.

Enumerated Values

Property	Value
anonymous	unidentified
anonymous	anchor

Example

"anchor"

DestinationLinkStatus

Destination link status

Properties

Name	Type	Description	Restrictions
anonymous	string	Destination link status

Enumerated Values

Property	Value
anonymous	connected
anonymous	disconnected

Example

"connected"

DestinationLinkTextElement

A destination link is an element which is replaced with content from a source link.

Properties

Name	Type	Description	Restrictions
destinationLink	DestinationLinkRef	A reference to a destination link.
format	RichTextFormat	The formatting options applied to rich text elements.
length	integer	The number of characters (32-bit unicode code point) for a text element or range of text in a selection. Most elements will have a length of 1, even if it is dynamic content which will be replaced by possibly multiple characters. The lengths are used when editing with offsets from an element. The sum of the lengths up to a specific element from another is the offset between those text elements.	Minimum: 1
offset	integer	The number of items to skip over in a collection before the items which will be returned or worked on. The items may be shapes, sections, elements, characters, slides, etc depending on which object or path the offset is being used on.	Minimum: 0
paragraphs	[SourceParagraph]	Paragraphs contained in this destination link.
style	StyleRef	A reference to a style.

Example

{
  "destinationLink": {
    "destinationLink": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
    "revision": "24601abc"
  },
  "format": {
    "backgroundColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "baselineShift": "superscript",
    "bold": true,
    "characterSpacing": -25,
    "font": "Times New Roman",
    "italic": true,
    "size": 14,
    "strikethrough": true,
    "textColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "underline": true
  },
  "length": 1,
  "offset": 10,
  "paragraphs": [
    {
      "elements": [
        {
          "textSpan": {
            "format": {
              "font": "Times New Roman",
              "italic": true,
              "size": 12
            },
            "length": 11,
            "offset": 0,
            "style": {
              "revision": "1A2B3C4D",
              "style": "WW91IGZvdW5kIG1lIQ",
              "styleGuide": "WW91IGZvdW5kIG1lIQ"
            },
            "text": "Hello World"
          },
          "type": "textSpan"
        }
      ],
      "format": {
        "bold": true
      },
      "list": {
        "level": 2,
        "prefix": "[",
        "startAt": 1,
        "style": {
          "style": "WW91IGZvdW5kIG1lIQ",
          "styleGuide": "WW91IGZvdW5kIG1lIQ"
        },
        "suffix": "]"
      },
      "properties": {},
      "style": {
        "style": "X3R4dDozZDUyMDg4ODBlNDk0YmYxYWVjYTIzM2VlYmY3ODM4Mg",
        "styleGuide": "3d5208880e494bf1aeca233eebf78382"
      }
    }
  ],
  "style": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "style": "c3R5bGUta2V5Ol90Ymw",
    "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
  }
}

Dimensions

A dimension of a rectangle for properties of objects such as a shape, text box, table, chart, image, or page.

Properties

Name	Type	Description	Restrictions
height	number	The vertical measurement in points.	required, Minimum: 1
width	number	The horizontal measurement in points.	required, Minimum: 1

Example

{
  "height": 240,
  "width": 320
}

DrawingElement

A drawing elements represents a text box, shapes, lines, and any other component of a drawing.

Properties

Name	Type	Description	Restrictions
chart	ChartDrawingElement	A drawing element for a chart.
image	ImageDrawingElement	A drawing element for an image.
line	Line	A drawing element for lines, arrows, connectors, etc. All of these elements have two points: a head and tail.
shape	Shape	A drawing element for a shape such as a rectangle, ellipse, polygon, etc. This also includes arrows, left bracket, right bracket, and flow chart shapes. Shapes can have zero to two modifiers or an auxiliary point depending on the shape type.
table	TableDrawingElement	A drawing element for a table.
type	DrawingElementType	The type of the drawing element in a drawing	required
unspecified	UnspecifiedDrawingElement	An unspecified drawing element to use as a placeholder for elements that have not been explicitly defined in API models. The unspecified element makes it possible to add new features to the editor without requiring the API models to be updated in tandem. Not only does this element give some information about where the unspecified element is drawn, it gives the element’’s identifier.

Example

{
  "image": {
    "dimensions": {
      "height": 240,
      "width": 320
    },
    "fill": {
      "color": {
        "blue": 128,
        "green": 128,
        "red": 128
      },
      "opacity": 0.5
    },
    "id": "WW91IGZvdW5kIG1lIQ",
    "image": {
      "image": "8610c7b132e944cb9e5c11daf08b1b1c",
      "location": "<opaque_url>"
    },
    "margins": {
      "bottom": 10,
      "left": 10,
      "right": 10,
      "top": 10
    },
    "paddings": {
      "bottom": 10,
      "left": 10,
      "right": 10,
      "top": 10
    },
    "position": {
      "paragraphRelative": {
        "paragraphIndex": 3,
        "x": 0,
        "y": 0
      },
      "type": "paragraphRelative"
    },
    "rotation": 90,
    "stroke": {
      "color": {
        "blue": 128,
        "green": 128,
        "red": 128
      },
      "pattern": "solid",
      "width": 2
    },
    "wrapStyle": "inFrontOfText"
  },
  "type": "image"
}

DrawingElementAnchorAttachmentPoint

An attachment point to a selection of drawing elements in a drawing.

Properties

Name	Type	Description	Restrictions
selection	[DrawingElementId]	A selection of one or more drawing elements	required
type	DrawingElementAnchorAttachmentPointType	The type of attachment point.	required

Example

{
  "selection": [
    "WW91IGZvdW5kIG1lIQ"
  ],
  "type": "comment"
}

DrawingElementAnchorAttachmentPointType

The type of attachment point.

Properties

Name	Type	Description	Restrictions
anonymous	string	The type of attachment point.

Enumerated Values

Property	Value
anonymous	comment

Example

"comment"

DrawingElementId

Identifier of the drawing element

Properties

Name	Type	Description	Restrictions
anonymous	string	Identifier of the drawing element	Minimum length: 1

Example

"WW91IGZvdW5kIG1lIQ"

DrawingElementListResult

A collection of elements in a drawing. This contains the shapes, text boxes, and lines for drawing content including slides, layout slides, and drawings in documents. When there are no additional elements before the current collection, the previous property will be null. When there are no additional elements after the current collection, the next property will be null.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	[DrawingElement]	Elements contained by this drawing.	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "image": {
        "dimensions": {
          "height": 240,
          "width": 320
        },
        "fill": {
          "color": {
            "blue": 128,
            "green": 128,
            "red": 128
          },
          "opacity": 0.5
        },
        "id": "WW91IGZvdW5kIG1lIQ",
        "image": {
          "image": "8610c7b132e944cb9e5c11daf08b1b1c",
          "location": "<opaque_url>"
        },
        "margins": {
          "bottom": 10,
          "left": 10,
          "right": 10,
          "top": 10
        },
        "paddings": {
          "bottom": 10,
          "left": 10,
          "right": 10,
          "top": 10
        },
        "position": {
          "paragraphRelative": {
            "paragraphIndex": 3,
            "x": 0,
            "y": 0
          },
          "type": "paragraphRelative"
        },
        "rotation": 90,
        "stroke": {
          "color": {
            "blue": 128,
            "green": 128,
            "red": 128
          },
          "pattern": "solid",
          "width": 2
        },
        "wrapStyle": "inFrontOfText"
      },
      "type": "image"
    }
  ]
}

DrawingElementType

The type of the drawing element in a drawing

Properties

Name	Type	Description	Restrictions
anonymous	string	The type of the drawing element in a drawing

Enumerated Values

Property	Value
anonymous	shape
anonymous	line
anonymous	chart
anonymous	image
anonymous	table
anonymous	unspecified

Example

"shape"

DrawingRef

A reference to drawing content in a document, spreadsheet, or presentation

Properties

Name	Type	Description	Restrictions
drawing	string	The unique identifier of the drawing being referred to	read-only
location	string¦null	❗️ Deprecated: A URL that a GET request can be made against to retrieve this drawing	read-only
revision	string	Identifies a unique revision of content.	read-only

Example

{
  "drawing": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag",
  "location": "string",
  "revision": "2c6438ab4541de6d"
}

DrawingRelativePosition

The relative position of a drawing element.

Properties

Name	Type	Description	Restrictions
designPageRelative	DesignPageRelative	Represents the position of a drawing relative to the top-left corner of the section.
paragraphRelative	ParagraphRelative	Represents a position relative to the start of the paragraph corresponding to the paragraph index.
slideRelative	SlideRelative	Represents the position of a drawing relative to the top-left corner a slide.
type	DrawingRelativeType	The relative position type used for a drawing element.	required

Example

{
  "paragraphRelative": {
    "paragraphIndex": 3,
    "x": 0,
    "y": 0
  },
  "type": "paragraphRelative"
}

DrawingRelativeType

The relative position type used for a drawing element.

Properties

Name	Type	Description	Restrictions
anonymous	string	The relative position type used for a drawing element.

Enumerated Values

Property	Value
anonymous	designPageRelative
anonymous	paragraphRelative
anonymous	slideRelative

Example

"paragraphRelative"

DrawingRichTextSelection

Describes a selection within a drawing element’s text

Properties

Name	Type	Description	Restrictions
drawingElement	DrawingElementId	Identifier of the drawing element	required
start	Caret	A caret (as in Caret Navigation) is a location between two characters in a paragraph.	required
stop	Caret	A caret (as in Caret Navigation) is a location between two characters in a paragraph.	required

Example

{
  "drawingElement": "2c64382b45553de1",
  "start": {
    "offset": 0,
    "paragraphIndex": 0
  },
  "stop": {
    "offset": 10,
    "paragraphIndex": 0
  }
}

DrawingRichTextSelectionAnchorAttachmentPoint

An attachment point to a selection in a drawing’s rich text content.

Properties

Name	Type	Description	Restrictions
selection	DrawingRichTextSelection	Describes a selection within a drawing element’s text	required
type	DrawingRichTextSelectionAnchorAttachmentPointType	The type of attachment point.	required

Example

{
  "selection": {
    "drawingElement": "2c64382b45553de1",
    "start": {
      "offset": 0,
      "paragraphIndex": 0
    },
    "stop": {
      "offset": 10,
      "paragraphIndex": 0
    }
  },
  "type": "comment"
}

DrawingRichTextSelectionAnchorAttachmentPointType

The type of attachment point.

Properties

Name	Type	Description	Restrictions
anonymous	string	The type of attachment point.

Enumerated Values

Property	Value
anonymous	comment
anonymous	sourceLink

Example

"comment"

DuplicateTable

An edit to duplicate a table in rich text.

Properties

Name	Type	Description	Restrictions
insertAt	Caret	A caret (as in Caret Navigation) is a location between two characters in a paragraph.	required
sourceTable	TableId	The unique identifier for the source table.	required

Example

{
  "insertAt": {
    "offset": 0,
    "paragraphIndex": 2
  },
  "sourceTable": "WAxsaHxoYvTB4D0twUm6YtiF99TNO0gBkSOhgYBed9AMB99EUxqELDQychBaGR9SkZucm5sK"
}

ExtensionType

Indicates the type of the anchor extension.

Properties

Name	Type	Description	Restrictions
anonymous	string	Indicates the type of the anchor extension.

Enumerated Values

Property	Value
anonymous	comment
anonymous	destinationLink

Example

"comment"

Fill

A shape or box fill settings for things like shapes. Use a null to indicate no fill.

Properties

Name	Type	Description	Restrictions
color	Color	Represents a color.	required
opacity	Opacity	The opacity of a color where 1.0 is completely opaque and 0.0 is completely transparent.

Example

{
  "color": {
    "blue": 128,
    "green": 128,
    "red": 128
  },
  "opacity": 0.5
}

FootnoteAnnotation

A dynamic content text element which will be replaced with a footnote number for the footnote content which this element is within. This may only be added to footnotes.

Properties

Name	Type	Description	Restrictions
format	RichTextFormat	The formatting options applied to rich text elements.
length	integer	The number of characters (32-bit unicode code point) for a text element or range of text in a selection. Most elements will have a length of 1, even if it is dynamic content which will be replaced by possibly multiple characters. The lengths are used when editing with offsets from an element. The sum of the lengths up to a specific element from another is the offset between those text elements.	Minimum: 1
offset	integer	The number of items to skip over in a collection before the items which will be returned or worked on. The items may be shapes, sections, elements, characters, slides, etc depending on which object or path the offset is being used on.	Minimum: 0
style	StyleRef	A reference to a style.

Example

{
  "format": {
    "backgroundColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "baselineShift": "superscript",
    "bold": true,
    "characterSpacing": -25,
    "font": "Times New Roman",
    "italic": true,
    "size": 14,
    "strikethrough": true,
    "textColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "underline": true
  },
  "length": 1,
  "offset": 10,
  "style": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "style": "c3R5bGUta2V5Ol90Ymw",
    "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
  }
}

FootnoteIndicator

A dynamic content text element which will be replaced with a footnote number within rich text content to indicate that there is a footnote and works as an anchor to help determine which page of the document the footnote will be added to.

Properties

Name	Type	Description	Restrictions
footnote	RichTextRef	A reference to rich text content in a document, spreadsheet, or presentation
format	RichTextFormat	The formatting options applied to rich text elements.
length	integer	The number of characters (32-bit unicode code point) for a text element or range of text in a selection. Most elements will have a length of 1, even if it is dynamic content which will be replaced by possibly multiple characters. The lengths are used when editing with offsets from an element. The sum of the lengths up to a specific element from another is the offset between those text elements.	Minimum: 1
offset	integer	The number of items to skip over in a collection before the items which will be returned or worked on. The items may be shapes, sections, elements, characters, slides, etc depending on which object or path the offset is being used on.	Minimum: 0
style	StyleRef	A reference to a style.

Example

{
  "footnote": {
    "location": "string",
    "revision": "2B3C4D5E",
    "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
  },
  "format": {
    "backgroundColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "baselineShift": "superscript",
    "bold": true,
    "characterSpacing": -25,
    "font": "Times New Roman",
    "italic": true,
    "size": 14,
    "strikethrough": true,
    "textColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "underline": true
  },
  "length": 1,
  "offset": 10,
  "style": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "style": "c3R5bGUta2V5Ol90Ymw",
    "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
  }
}

FormatCells

Applies formatting to cells in the given ranges of a table. Null properties are ignored.

Properties

Name	Type	Description	Restrictions
backgroundColor	string¦null	color to apply to the background represented as a hex-code
baselineShift	string¦null	baseline shift apply to the text
bold	boolean¦null	whether or not to bold the text
characterSpacing	integer¦null	space between characters	Maximum: 1000, Minimum: -1000
font	string¦null	name of the font
italic	boolean¦null	whether or not to italicise the text
ranges	CellRanges	A collection of cell ranges in a table.	required
size	number¦null	font size in points	Maximum: 720, Minimum: 1
strikethrough	boolean¦null	whether or not to apply strikethrough to the text
textColor	Color	Represents a color.
underline	boolean¦null	whether or not to underline the text

Enumerated Values

Property	Value
baselineShift	baseline
baselineShift	superscript
baselineShift	subscript

Example

{
  "backgroundColor": "#808080",
  "baselineShift": "baseline",
  "bold": true,
  "characterSpacing": 50,
  "font": "Arial",
  "italic": true,
  "ranges": [
    {
      "startColumn": 2,
      "startRow": 2,
      "stopColumn": 2,
      "stopRow": 2
    }
  ],
  "size": 12,
  "strikethrough": true,
  "textColor": {
    "blue": 128,
    "green": 128,
    "red": 128
  },
  "underline": true
}

FormatText

An edit to format a range of rich text.

Properties

Name	Type	Description	Restrictions
backgroundColor	Color¦null	Represents a color.
baselineShift	RichTextBaselineShift	Indicates the offset from the baseline of the characters. The baseline is the imaginary bottom line for a line of text which the bottom of the characters are placed, not including any descender such as g, j, p, and y have. superscript shifts the baseline up and reduces the rendered font size to 65% of the specified font size. subscript works the same as superscript except it moves the baseline down. baseline uses the default size and baseline for regular text. type: string
bold	boolean¦null	Whether or not the text is bold
characterSpacing	integer¦null	The amount of space between characters in thousanths of an em.	Maximum: 1000, Minimum: -1000
font	string¦null	The name of the font
italic	boolean¦null	Whether or not the text is italicized
selection	RichTextSelection	Describes a selection within piece of rich text	required
size	number¦null	The font size of the characters in points	Maximum: 720, Minimum: 1
strikethrough	boolean¦null	Whether or not the text is struck through
textColor	Color¦null	Represents a color.
underline	boolean¦null	Whether or not the text is underlined

Example

{
  "backgroundColor": {
    "blue": 255,
    "green": 255,
    "red": 255
  },
  "baselineShift": "baseline",
  "bold": true,
  "characterSpacing": 100,
  "font": "Times New Roman",
  "italic": true,
  "selection": {
    "start": {
      "offset": 0,
      "paragraphIndex": 0
    },
    "stop": {
      "offset": 10,
      "paragraphIndex": 2
    }
  },
  "size": 14,
  "strikethrough": true,
  "textColor": {
    "blue": 0,
    "green": 0,
    "red": 0
  },
  "underline": true
}

Hyperlink

Represents a hyperlink to another location. The type property will determine which of the other properties is set.

Properties

Name	Type	Description	Restrictions
document	DocumentRef¦null	The reference to the linked document for document type hyperlinks
presentation	PresentationRef¦null	The reference to the linked presentation for presentation type hyperlinks
section	SectionRef¦null	The reference to the linked section for section type hyperlinks
sheet	SheetRef¦null	The reference to the linked sheet for sheet type hyperlinks
slide	SlideRef¦null	The reference to the linked slide for slide type hyperlinks
spreadsheet	SpreadsheetRef¦null	The reference to the linked spreadsheet for spreadsheet type hyperlinks
type	HyperlinkType	The type of the hyperlink	required
url	string¦null	The raw URL for url type hyperlinks.	Minimum length: 1

Example

{
  "document": {
    "document": "16b1f641613847469b7aa1ca29af40b1",
    "location": "<opaque_url>",
    "revision": "2B3C4D5E"
  },
  "presentation": {
    "location": "<opaque_url>",
    "presentation": "16b1f641613847469b7aa1ca29af40b1",
    "revision": "2B3C4D5E"
  },
  "section": {
    "document": "16b1f641613847469b7aa1ca29af40b1",
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "section": "16b1f641613847469b7aa1ca29af40b1_650855815308"
  },
  "sheet": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "sheet": "16b1f641613847469b7aa1ca29af40b1_650855815308",
    "spreadsheet": "16b1f641613847469b7aa1ca29af40b1"
  },
  "slide": {
    "location": "<opaque_url>",
    "presentation": "16b1f641613847469b7aa1ca29af40b1",
    "revision": "2B3C4D5E",
    "slide": "16b1f641613847469b7aa1ca29af40b1_650855815308"
  },
  "spreadsheet": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "spreadsheet": "16b1f641613847469b7aa1ca29af40b1"
  },
  "type": "document",
  "url": "https://example.com"
}

HyperlinkTextElement

A text element for a hyperlink.

Properties

Name	Type	Description	Restrictions
format	RichTextFormat	The formatting options applied to rich text elements.
hyperlink	Hyperlink	Represents a hyperlink to another location. The type property will determine which of the other properties is set.
length	integer	The number of characters (32-bit unicode code point) for a text element or range of text in a selection. Most elements will have a length of 1, even if it is dynamic content which will be replaced by possibly multiple characters. The lengths are used when editing with offsets from an element. The sum of the lengths up to a specific element from another is the offset between those text elements.	Minimum: 1
offset	integer	The number of items to skip over in a collection before the items which will be returned or worked on. The items may be shapes, sections, elements, characters, slides, etc depending on which object or path the offset is being used on.	Minimum: 0
style	StyleRef	A reference to a style.
text	string	The string of characters (32-bit unicode code point)

Example

{
  "format": {
    "backgroundColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "baselineShift": "superscript",
    "bold": true,
    "characterSpacing": -25,
    "font": "Times New Roman",
    "italic": true,
    "size": 14,
    "strikethrough": true,
    "textColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "underline": true
  },
  "hyperlink": {
    "document": {
      "document": "16b1f641613847469b7aa1ca29af40b1",
      "location": "<opaque_url>",
      "revision": "2B3C4D5E"
    },
    "presentation": {
      "location": "<opaque_url>",
      "presentation": "16b1f641613847469b7aa1ca29af40b1",
      "revision": "2B3C4D5E"
    },
    "section": {
      "document": "16b1f641613847469b7aa1ca29af40b1",
      "location": "<opaque_url>",
      "revision": "2B3C4D5E",
      "section": "16b1f641613847469b7aa1ca29af40b1_650855815308"
    },
    "sheet": {
      "location": "<opaque_url>",
      "revision": "2B3C4D5E",
      "sheet": "16b1f641613847469b7aa1ca29af40b1_650855815308",
      "spreadsheet": "16b1f641613847469b7aa1ca29af40b1"
    },
    "slide": {
      "location": "<opaque_url>",
      "presentation": "16b1f641613847469b7aa1ca29af40b1",
      "revision": "2B3C4D5E",
      "slide": "16b1f641613847469b7aa1ca29af40b1_650855815308"
    },
    "spreadsheet": {
      "location": "<opaque_url>",
      "revision": "2B3C4D5E",
      "spreadsheet": "16b1f641613847469b7aa1ca29af40b1"
    },
    "type": "document",
    "url": "https://example.com"
  },
  "length": 1,
  "offset": 10,
  "style": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "style": "c3R5bGUta2V5Ol90Ymw",
    "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
  },
  "text": "Thank you"
}

HyperlinkType

The type of the hyperlink

Properties

Name	Type	Description	Restrictions
HyperlinkType	string	The type of the hyperlink

Enumerated Values

Property	Value
HyperlinkType	document
HyperlinkType	section
HyperlinkType	presentation
HyperlinkType	slide
HyperlinkType	spreadsheet
HyperlinkType	sheet
HyperlinkType	url
HyperlinkType	unspecified

Example

"document"

Image

Content containing an image.

Properties

Name	Type	Description	Restrictions
downloadUrl	string	The URL to download an image. Send an authorized GET request to this URL to get the image bytes.	required
fileName	string	The name of the image.	required
id	string	The unique identifier for the image.	required
mimeType	string	The mime type of the image.	required

Example

{
  "downloadUrl": "<opaque_url>",
  "fileName": "example.png",
  "id": "WW91IGZvdW5kIG1lIQ",
  "mimeType": "image/png"
}

ImageDrawingElement

A drawing element for an image.

Properties

Name	Type	Description	Restrictions
dimensions	Dimensions	A dimension of a rectangle for properties of objects such as a shape, text box, table, chart, image, or page.
fill	Fill	A shape or box fill settings for things like shapes. Use a null to indicate no fill.
id	DrawingElementId	Identifier of the drawing element
image	ImageRef	A reference to image content in a document, spreadsheet, or presentation
margins	Margins	The margins of a rectangle for properties of objects such as a shape, text box, or page.
position	DrawingRelativePosition	The relative position of a drawing element.
rotation	Rotation	The rotation in degrees of a shape around the center point of the shape. The rotation is applied after the shape is positioned and sized meaning the position and dimensions are for the shape without any rotation.
stroke	Stroke	Line stroke setting for things like shape edges. Use a null to indicate no stroke line.
wrapStyle	WrapStyleType	The relative position type

Example

{
  "dimensions": {
    "height": 240,
    "width": 320
  },
  "fill": {
    "color": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "opacity": 0.5
  },
  "id": "WW91IGZvdW5kIG1lIQ",
  "image": {
    "image": "8610c7b132e944cb9e5c11daf08b1b1c",
    "location": "<opaque_url>"
  },
  "margins": {
    "bottom": 10,
    "left": 10,
    "right": 10,
    "top": 10
  },
  "position": {
    "paragraphRelative": {
      "paragraphIndex": 3,
      "x": 0,
      "y": 0
    },
    "type": "paragraphRelative"
  },
  "rotation": 90,
  "stroke": {
    "color": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "pattern": "solid",
    "width": 2
  },
  "wrapStyle": "inFrontOfText"
}

ImageRef

A reference to image content in a document, spreadsheet, or presentation

Properties

Name	Type	Description	Restrictions
image	string	The unique identifier of the image being referred to
location	string¦null	❗️ Deprecated: A URL that a GET request can be made against to retrieve this image

Example

{
  "image": "8610c7b132e944cb9e5c11daf08b1b1c",
  "location": "<opaque_url>"
}

ImageTextElement

A text element for image embedded content.

Properties

Name	Type	Description	Restrictions
dimensions	Dimensions	A dimension of a rectangle for properties of objects such as a shape, text box, table, chart, image, or page.
format	RichTextFormat	The formatting options applied to rich text elements.
image	ImageRef	A reference to image content in a document, spreadsheet, or presentation
length	integer	The number of characters (32-bit unicode code point) for a text element or range of text in a selection. Most elements will have a length of 1, even if it is dynamic content which will be replaced by possibly multiple characters. The lengths are used when editing with offsets from an element. The sum of the lengths up to a specific element from another is the offset between those text elements.	Minimum: 1
offset	integer	The number of items to skip over in a collection before the items which will be returned or worked on. The items may be shapes, sections, elements, characters, slides, etc depending on which object or path the offset is being used on.	Minimum: 0
style	StyleRef	A reference to a style.

Example

{
  "dimensions": {
    "height": 240,
    "width": 320
  },
  "format": {
    "backgroundColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "baselineShift": "superscript",
    "bold": true,
    "characterSpacing": -25,
    "font": "Times New Roman",
    "italic": true,
    "size": 14,
    "strikethrough": true,
    "textColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "underline": true
  },
  "image": {
    "image": "8610c7b132e944cb9e5c11daf08b1b1c",
    "location": "<opaque_url>"
  },
  "length": 1,
  "offset": 10,
  "style": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "style": "c3R5bGUta2V5Ol90Ymw",
    "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
  }
}

ImageUpload

Details about the image upload, including its options.

Properties

Name	Type	Description	Restrictions
fileName	string	The name for the new image.	required

Example

{
  "fileName": "example.png"
}

ImageUploadResponse

Response to an image upload including the URL to upload the image to.

Properties

Name	Type	Description	Restrictions
uploadUrl	string	The URL used to upload the image. Make a PUT request to this URL whose body is the contents of the image.	required

Example

{
  "uploadUrl": "<opaque_url>"
}

ImageUploadResult

A reference to a resource that was created by an image upload.

Properties

Name	Type	Description	Restrictions
image	string¦null	The ID of the image that was created.
type	string	The type of resource created from an image upload.	required

Enumerated Values

Property	Value
type	image

Example

{
  "image": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
  "type": "image"
}

ImageUploadResultCollection

A collection of created results from an image upload. When there are no additional results before the current collection, the previous property will be null. When there are no additional results after the current collection, the next property will be null.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	[ImageUploadResult]	The current page of data.

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "image": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
      "type": "image"
    }
  ]
}

InsertCellDestinationLink

Inserts a destination link at the provided cell. Creates a source link at the source anchor if one doesn’t already exist. The destination link will reference the latest published revision of the source link.

Properties

Name	Type	Description	Restrictions
insertAt	Cell	A cell indicates a single cell in a table. All indexes are zero based.	required
sourceAnchor	string	The unique identifier for the source anchor.	required

Example

{
  "insertAt": {
    "column": 2,
    "row": 41
  },
  "sourceAnchor": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru"
}

InsertColumns

Insert one or more columns into the table next to the given column on specified side

Properties

Name	Type	Description	Restrictions
count	integer	The number of columns to insert	Minimum: 1
nextTo	integer	The position after which to insert the columns	Minimum: 0
side	string	The direction where to insert nextTo

Enumerated Values

Property	Value
side	putAfter
side	putBefore

Example

{
  "count": 5,
  "nextTo": 5,
  "side": "putAfter"
}

InsertDestinationLink

A text edit for inserting a destination link in rich text. The destination link will reference the latest published revision of the source link.

Properties

Name	Type	Description	Restrictions
insertAt	Caret	A caret (as in Caret Navigation) is a location between two characters in a paragraph.	required
sourceAnchor	string	The unique identifier for the source anchor.	required

Example

{
  "insertAt": {
    "offset": 2,
    "paragraphIndex": 4
  },
  "sourceAnchor": "WAxsaHxoYvTB4D0twUm6YtiF99TNO0gBkSOhgYBed9AMB99EUxqELDQychBaGR9SkZucm5sK"
}

InsertFootnote

A text edit for inserting a footnote into rich text. The created rich text id associated with the footnote annotation area can be retrieved from the rich text edit operation results. This edit is not supported in table rich cell edits.

Properties

Name	Type	Description	Restrictions
insertAt	Caret	A caret (as in Caret Navigation) is a location between two characters in a paragraph.	required

Example

{
  "insertAt": {
    "offset": 10,
    "paragraphIndex": 1
  }
}

InsertImage

A text edit for inserting an image into rich text.

Properties

Name	Type	Description	Restrictions
dimensions	object	The dimensions of the inserted image.	required
dimensions.height	number	The vertical measurement in points.	required, Minimum: 1
dimensions.width	number	The horizontal measurement in points.	required, Minimum: 1
image	string	The unique identifier of the image to insert. Each image can only be inserted into content once.	required
insertAt	Caret	A caret (as in Caret Navigation) is a location between two characters in a paragraph.	required

Example

{
  "dimensions": {
    "height": 240,
    "width": 320
  },
  "image": "8610c7b132e944cb9e5c11daf08b1b1c",
  "insertAt": {
    "offset": 5,
    "paragraphIndex": 0
  }
}

InsertPageNumber

A text edit for inserting a page number into header or footer text.

Properties

Name	Type	Description	Restrictions
insertAt	Caret	A caret (as in Caret Navigation) is a location between two characters in a paragraph.	required

Example

{
  "insertAt": {
    "offset": 5,
    "paragraphIndex": 0
  }
}

InsertParagraph

A text edit for inserting a new paragraph.

Properties

Name	Type	Description	Restrictions
insertAt	Caret	A caret (as in Caret Navigation) is a location between two characters in a paragraph.	required

Example

{
  "insertAt": {
    "offset": 5,
    "paragraphIndex": 0
  }
}

InsertRows

Insert one or more rows into the table next to the given row on specified side

Properties

Name	Type	Description	Restrictions
count	integer	The number of rows to insert	Minimum: 1
nextTo	integer	The position after which to insert the rows	Minimum: 0
side	string	The direction where to insert nextTo

Enumerated Values

Property	Value
side	putAfter
side	putBefore

Example

{
  "count": 5,
  "nextTo": 5,
  "side": "putAfter"
}

InsertSoftReturn

A text edit for inserting a soft return into text. This moves the following text elements to a new line without creating a new paragraph.

Properties

Name	Type	Description	Restrictions
insertAt	Caret	A caret (as in Caret Navigation) is a location between two characters in a paragraph.	required

Example

{
  "insertAt": {
    "offset": 5,
    "paragraphIndex": 0
  }
}

InsertText

A text edit for inserting new rich text.

Properties

Name	Type	Description	Restrictions
format	ApplicableTextFormat	Formatting options to be applied to rich text elements
inheritFormats	boolean	Indicates if this text should use the formats from the text around where this new text is being inserted at. The specified formats will override inherited formats.
insertAt	Caret	A caret (as in Caret Navigation) is a location between two characters in a paragraph.	required
style	string¦null	The unique identifier of a style.
text	string	The text to insert.	required, Minimum length: 1

Example

{
  "format": {
    "bold": true,
    "font": "Times New Roman"
  },
  "inheritFormats": true,
  "insertAt": {
    "offset": 5,
    "paragraphIndex": 0
  },
  "style": "c3R5bGUta2V5Ol90Ymw",
  "text": "Hello, world!"
}

Line

A drawing element for lines, arrows, connectors, etc. All of these elements have two points: a head and tail.

Properties

Name	Type	Description	Restrictions
head	LineTerminator	Defines the shape, size, and location of a line’’s head and tail (the starting point and stop point of a line segment or connector).	required
id	DrawingElementId	Identifier of the drawing element	required
length	number	The length of the line in points.	required
margins	Margins	The margins of a rectangle for properties of objects such as a shape, text box, or page.	required
stroke	Stroke	Line stroke setting for things like shape edges. Use a null to indicate no stroke line.	required
tail	LineTerminator	Defines the shape, size, and location of a line’’s head and tail (the starting point and stop point of a line segment or connector).	required
wrapStyle	WrapStyleType	The relative position type	required

Example

{
  "head": {
    "cap": "none",
    "position": {
      "paragraphRelative": {
        "paragraphIndex": 3,
        "x": 0,
        "y": 0
      },
      "type": "paragraphRelative"
    },
    "size": "small"
  },
  "id": "WW91IGZvdW5kIG1lIQ",
  "length": 120,
  "margins": {
    "bottom": 10,
    "left": 10,
    "right": 10,
    "top": 10
  },
  "stroke": {
    "color": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "pattern": "solid",
    "width": 2
  },
  "tail": {
    "cap": "none",
    "position": {
      "paragraphRelative": {
        "paragraphIndex": 3,
        "x": 0,
        "y": 0
      },
      "type": "paragraphRelative"
    },
    "size": "small"
  },
  "wrapStyle": "inFrontOfText"
}

LineCap

The way the terminator of a line looks.

Properties

Name	Type	Description	Restrictions
anonymous	string	The way the terminator of a line looks.

Enumerated Values

Property	Value
anonymous	none
anonymous	triangle
anonymous	circle
anonymous	diamond

Example

"none"

LineCapSize

The size of a cap at a line terminator.

Properties

Name	Type	Description	Restrictions
anonymous	string	The size of a cap at a line terminator.

Enumerated Values

Property	Value
anonymous	small
anonymous	medium
anonymous	large

Example

"small"

LineRelativePosition

The relative position for the head and tail of a line drawing element.

Properties

Name	Type	Description	Restrictions
designPageRelative	DesignPageRelative	Represents the position of a drawing relative to the top-left corner of the section.
paragraphRelative	ParagraphRelative	Represents a position relative to the start of the paragraph corresponding to the paragraph index.
slideRelative	SlideRelative	Represents the position of a drawing relative to the top-left corner a slide.
type	LineRelativeType	The relative position type used for the head and tail of a line drawing element.	required

Example

{
  "paragraphRelative": {
    "paragraphIndex": 3,
    "x": 0,
    "y": 0
  },
  "type": "paragraphRelative"
}

LineRelativeType

The relative position type used for the head and tail of a line drawing element.

Properties

Name	Type	Description	Restrictions
anonymous	string	The relative position type used for the head and tail of a line drawing element.

Enumerated Values

Property	Value
anonymous	designPageRelative
anonymous	paragraphRelative
anonymous	slideRelative

Example

"paragraphRelative"

LineSpacing

Defines the line spacing of a paragraph.

Properties

Name	Type	Description	Restrictions
unit	string	The unit of the line spacing value.
value	number	The line spacing value. Valid percent range: 80% - 720% Valid points range: 1 - 400 points	Minimum: 1

Enumerated Values

Property	Value
unit	percent
unit	points

Example

{
  "unit": "percent",
  "value": 100
}

LineSpacingUnit

The units for a line spacing value as a percent of line height or points.

Properties

Name	Type	Description	Restrictions
anonymous	string	The units for a line spacing value as a percent of line height or points.

Enumerated Values

Property	Value
anonymous	percent
anonymous	points

Example

"percent"

LineTerminator

Defines the shape, size, and location of a line’’s head and tail (the starting point and stop point of a line segment or connector).

Properties

Name	Type	Description	Restrictions
cap	LineCap	The way the terminator of a line looks.	required
position	LineRelativePosition	The relative position for the head and tail of a line drawing element.	required
size	LineCapSize	The size of a cap at a line terminator.	required

Example

{
  "cap": "none",
  "position": {
    "paragraphRelative": {
      "paragraphIndex": 3,
      "x": 0,
      "y": 0
    },
    "type": "paragraphRelative"
  },
  "size": "small"
}

LinksStatus

Indicates the status for links in a document, presentation, or spreadsheet.

Properties

Name	Type	Description	Restrictions
allLinks	LinkStatus	Indicates the status of all links.	required
ownLinks	LinkStatus	Indicates the status of links one has last edited.	required

Example

{
  "allLinks": "published",
  "ownLinks": "published"
}

LinkStatus

Indicates the status of a link

Properties

Name	Type	Description	Restrictions
anonymous	string	Indicates the status of a link

Enumerated Values

Property	Value
anonymous	published
anonymous	unpublished

Example

"published"

ListFormat

The list formatting options applied to the given paragraph.

Properties

Name	Type	Description	Restrictions
level	integer	The list level associated with the list.	Minimum: 0
prefix	string¦null	The list value prefix
startAt	integer¦null	The value the list starts at (for ordered lists). Null indicates that the list continues from the previous item.
style	StyleRef	A reference to a style.
suffix	string¦null	The list value suffix

Example

{
  "level": 1,
  "prefix": "[",
  "startAt": 1,
  "style": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "style": "c3R5bGUta2V5Ol90Ymw",
    "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
  },
  "suffix": "]"
}

ListGlyphAlignment

How the list glyph is aligned relative to the indentation point of the list level.

Properties

Name	Type	Description	Restrictions
anonymous	string	How the list glyph is aligned relative to the indentation point of the list level.

Enumerated Values

Property	Value
anonymous	glyphAlignLeft
anonymous	glyphAlignRight

Example

"glyphAlignLeft"

ListProgression

The properties applied at a particular level of a list.

Properties

Name	Type	Description	Restrictions
formats	ListProgressionFormats	The formats applied at a list progression.
listLevel	integer	The list indentation level of this list progression.

Example

{
  "formats": {
    "bold": {
      "bold": false,
      "locked": false
    },
    "fontFamily": {
      "fontFamily": "Times New Roman",
      "locked": false
    },
    "glyphAlignment": {
      "alignment": "glyphAlignLeft"
    },
    "indentation": {
      "firstLineIndent": 54,
      "startIndent": 27
    },
    "italic": {
      "italic": false,
      "locked": false
    },
    "listText": {
      "locked": false,
      "prefix": "Item",
      "suffix": "."
    },
    "style": {
      "sequenceType": "unorderedSequence",
      "unorderedGlyph": "•"
    },
    "symbolColor": {
      "locked": false,
      "symbolColor": {
        "blue": 128,
        "green": 128,
        "red": 128
      }
    },
    "symbolSize": {
      "locked": false,
      "symbolSize": 14
    },
    "underline": {
      "locked": false,
      "underline": false
    }
  },
  "listLevel": 1
}

ListProgressionAlignment

The alignment of the list progression glyph.

Properties

Name	Type	Description	Restrictions
alignment	ListGlyphAlignment	How the list glyph is aligned relative to the indentation point of the list level.

Example

{
  "alignment": "glyphAlignLeft"
}

ListProgressionBold

The bold format applied to the list progression glyph.

Properties

Name	Type	Description	Restrictions
bold	boolean	Whether or not the glyph is bold
locked	boolean	Whether the bold format is locked.

Example

{
  "bold": false,
  "locked": false
}

ListProgressionColor

The color of the list progression glyph.

Properties

Name	Type	Description	Restrictions
locked	boolean	Whether the color is locked.
symbolColor	Color	Represents a color.

Example

{
  "locked": false,
  "symbolColor": {
    "blue": 128,
    "green": 128,
    "red": 128
  }
}

ListProgressionFont

The font family of the list progression glyph.

Properties

Name	Type	Description	Restrictions
fontFamily	string	The name of the font.
locked	boolean	Whether the font family is locked.

Example

{
  "fontFamily": "Times New Roman",
  "locked": false
}

ListProgressionFormats

The formats applied at a list progression.

Properties

Name	Type	Description	Restrictions
bold	ListProgressionBold	The bold format applied to the list progression glyph.
fontFamily	ListProgressionFont	The font family of the list progression glyph.
glyphAlignment	ListProgressionAlignment	The alignment of the list progression glyph.
indentation	ListProgressionIndentation	The indentation formats applied to the list progression.
italic	ListProgressionItalic	The italic format applied to the list progression glyph.
listText	ListProgressionText	The prefix and suffix text applied to the list progression glyph.
style	ListProgressionStyle	The list sequence style of this list progression.
symbolColor	ListProgressionColor	The color of the list progression glyph.
symbolSize	ListProgressionSize	The size of the list progression glyph.
underline	ListProgressionUnderline	The underline format applied to the list progression glyph.

Example

{
  "bold": {
    "bold": false,
    "locked": false
  },
  "fontFamily": {
    "fontFamily": "Times New Roman",
    "locked": false
  },
  "glyphAlignment": {
    "alignment": "glyphAlignLeft"
  },
  "indentation": {
    "firstLineIndent": 54,
    "startIndent": 27
  },
  "italic": {
    "italic": false,
    "locked": false
  },
  "listText": {
    "locked": false,
    "prefix": "Item",
    "suffix": "."
  },
  "style": {
    "sequenceType": "unorderedSequence",
    "unorderedGlyph": "•"
  },
  "symbolColor": {
    "locked": false,
    "symbolColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    }
  },
  "symbolSize": {
    "locked": false,
    "symbolSize": 14
  },
  "underline": {
    "locked": false,
    "underline": false
  }
}

ListProgressionIndentation

The indentation formats applied to the list progression.

Properties

Name	Type	Description	Restrictions
firstLineIndent	number	The amount of indent, in points, from the margin to apply to the first line of a paragraph in addition to the start indent. Positive is towards the center of the page.
startIndent	number	The amount of indent, in points, from the margin to apply to all the lines of a paragraph from the start of each line. Positive is towards the center of the page.

Example

{
  "firstLineIndent": 54,
  "startIndent": 27
}

ListProgressionItalic

The italic format applied to the list progression glyph.

Properties

Name	Type	Description	Restrictions
italic	boolean	Whether or not the glyph is italicized
locked	boolean	Whether the italic format is locked.

Example

{
  "italic": false,
  "locked": false
}

ListProgressionSize

The size of the list progression glyph.

Properties

Name	Type	Description	Restrictions
locked	boolean	Whether the size is locked.
symbolSize	number	The size of the list item glyph in points.

Example

{
  "locked": false,
  "symbolSize": 14
}

ListProgressionStyle

The list sequence style of this list progression.

Properties

Name	Type	Description	Restrictions
sequenceType	ListSequenceType	The type of list sequence. If the list style is unordered, the sequence type of the first list progression must be unordered. If the list style is ordered, the sequence type of the first list progression may not be unordered.
unorderedGlyph	string¦null	The custom glyph to use for unordered lists. If the sequenceType is not set to unordered, then this field is ignored.

Example

{
  "sequenceType": "unorderedSequence",
  "unorderedGlyph": "•"
}

ListProgressionText

The prefix and suffix text applied to the list progression glyph.

Properties

Name	Type	Description	Restrictions
locked	boolean	Whether the prefix and suffix are locked.
prefix	string	Prefix to be prepended to the glyph.
suffix	string	Suffix to be appended to the glyph.

Example

{
  "locked": false,
  "prefix": "Item",
  "suffix": "."
}

ListProgressionUnderline

The underline format applied to the list progression glyph.

Properties

Name	Type	Description	Restrictions
locked	boolean	Whether the underline format is locked.
underline	boolean	Whether or not the glyph be underline?

Example

{
  "locked": false,
  "underline": false
}

ListSequenceType

The type of list sequence. If the list style is unordered, the sequence type of the first list progression must be unordered. If the list style is ordered, the sequence type of the first list progression may not be unordered.

Properties

Name	Type	Description	Restrictions
anonymous	string	The type of list sequence. If the list style is unordered, the sequence type of the first list progression must be unordered. If the list style is ordered, the sequence type of the first list progression may not be unordered.

Enumerated Values

Property	Value
anonymous	unorderedSequence
anonymous	numericSequence
anonymous	uppercaseAlphabeticSequence
anonymous	lowercaseAlphabeticSequence
anonymous	uppercaseRomanSequence
anonymous	lowercaseRomanSequence
anonymous	enclosedSequence

Example

"unorderedSequence"

ListStyle

A style which describes a set for formats for the levels of a list.

Properties

Name	Type	Description	Restrictions
id	string	The unique identifier of a style.
index	integer	The index of this style in its group.
isNormalStyle	boolean	Whether this style is a “normal” style. Normals styles cannot be deleted or renamed.
listProgressions	[ListProgression]	The ten list progression levels for this list style.
name	string	The name of the text style.	Minimum length: 1
notes	StyleNotes	Custom tooltip for a style.
type	ListStyleType	The type of the list style.

Example

{
  "id": "c3R5bGUta2V5Ol90Ymw",
  "index": 1,
  "isNormalStyle": false,
  "listProgressions": [
    {
      "formats": {
        "bold": {
          "bold": false,
          "locked": false
        },
        "fontFamily": {
          "fontFamily": "Times New Roman",
          "locked": false
        },
        "glyphAlignment": {
          "alignment": "glyphAlignLeft"
        },
        "indentation": {
          "firstLineIndent": 54,
          "startIndent": 27
        },
        "italic": {
          "italic": false,
          "locked": false
        },
        "listText": {
          "locked": false,
          "prefix": "Item",
          "suffix": "."
        },
        "style": {
          "sequenceType": "unorderedSequence",
          "unorderedGlyph": "•"
        },
        "symbolColor": {
          "locked": false,
          "symbolColor": {
            "blue": 128,
            "green": 128,
            "red": 128
          }
        },
        "symbolSize": {
          "locked": false,
          "symbolSize": 14
        },
        "underline": {
          "locked": false,
          "underline": false
        }
      },
      "listLevel": 1
    }
  ],
  "name": "My List Style",
  "notes": "My Style",
  "type": "orderedListStyle"
}

ListStyleType

The type of the list style.

Properties

Name	Type	Description	Restrictions
anonymous	string	The type of the list style.

Enumerated Values

Property	Value
anonymous	orderedListStyle
anonymous	unorderedListStyle

Example

"orderedListStyle"

LockedCellEditMode

Whether or not an edit applied to locked cells is prevented. Validation will prevent an edit with a locked cell when set to strict. When set to trim the edit will succeed with the locked cells trimmed out.

Properties

Name	Type	Description	Restrictions
anonymous	string	Whether or not an edit applied to locked cells is prevented. Validation will prevent an edit with a locked cell when set to strict. When set to trim the edit will succeed with the locked cells trimmed out.

Enumerated Values

Property	Value
anonymous	strict
anonymous	trim

Example

"strict"

Margins

The margins of a rectangle for properties of objects such as a shape, text box, or page.

Properties

Name	Type	Description	Restrictions
bottom	number¦null	The bottom edge margin in points.	Minimum: 0
left	number¦null	The left edge margin in points.	Minimum: 0
right	number¦null	The right edge margin in points.	Minimum: 0
top	number¦null	The top edge margin in points.	Minimum: 0

Example

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

MoveColumns

Moves one or more columns from one location in the table to next to the given column on the specified side of that column. The column to move the other columns next to may not be within the set of columns to move.

Properties

Name	Type	Description	Restrictions
move	ColumnRange	Describes a column range
nextTo	integer	The position after which to move the columns	Minimum: 0
side	string	The direction where to move from nextTo

Enumerated Values

Property	Value
side	putAfter
side	putBefore

Example

{
  "move": {
    "startColumn": 5,
    "stopColumn": 5
  },
  "nextTo": 5,
  "side": "putAfter"
}

MoveRows

Move one or more row from one location in the table to next to the given row on the specified side

Properties

Name	Type	Description	Restrictions
move	RowRange	Describes a row range
nextTo	integer	The position after which to move the rows	Minimum: 0
side	string	The direction where to move from nextTo

Enumerated Values

Property	Value
side	putAfter
side	putBefore

Example

{
  "move": {
    "startRow": 5,
    "stopRow": 5
  },
  "nextTo": 5,
  "side": "putAfter"
}

Opacity

The opacity of a color where 1.0 is completely opaque and 0.0 is completely transparent.

Properties

Name	Type	Description	Restrictions
anonymous	number	The opacity of a color where 1.0 is completely opaque and 0.0 is completely transparent.

Example

0.5

Paddings

The paddings of a rectangle for properties of objects such as a shape, text box, or page.

Properties

Name	Type	Description	Restrictions
bottom	number¦null	The bottom edge padding in points.	required, Minimum: 0
left	number¦null	The left edge padding in points.	required, Minimum: 0
right	number¦null	The right edge padding in points.	required, Minimum: 0
top	number¦null	The top edge padding in points.	required, Minimum: 0

Example

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

PageNumber

A dynamic content text element which will be replaced with the current page number.

Properties

Name	Type	Description	Restrictions
format	RichTextFormat	The formatting options applied to rich text elements.
length	integer	The number of characters (32-bit unicode code point) for a text element or range of text in a selection. Most elements will have a length of 1, even if it is dynamic content which will be replaced by possibly multiple characters. The lengths are used when editing with offsets from an element. The sum of the lengths up to a specific element from another is the offset between those text elements.	Minimum: 1
offset	integer	The number of items to skip over in a collection before the items which will be returned or worked on. The items may be shapes, sections, elements, characters, slides, etc depending on which object or path the offset is being used on.	Minimum: 0
style	StyleRef	A reference to a style.

Example

{
  "format": {
    "backgroundColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "baselineShift": "superscript",
    "bold": true,
    "characterSpacing": -25,
    "font": "Times New Roman",
    "italic": true,
    "size": 14,
    "strikethrough": true,
    "textColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "underline": true
  },
  "length": 1,
  "offset": 10,
  "style": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "style": "c3R5bGUta2V5Ol90Ymw",
    "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
  }
}

Paragraph

A paragraph of rich-text content.

Properties

Name	Type	Description	Restrictions
elements	[TextElement]	The text elements that make up the paragraph	read-only
format	RichTextFormat	The formatting options applied to rich text elements.
index	integer	The index of this paragraph relative to other paragraphs in a RichText	read-only, Minimum: 0
list	ListFormat	The list formatting options applied to the given paragraph.
properties	ParagraphProperties	The properties for rich-text paragraphs. Null values indicate that the format is inheriting from style or the container when reading.
style	StyleRef	A reference to a style.

Example

{
  "elements": [
    {
      "chart": {
        "dimensions": {
          "height": 240,
          "width": 240
        },
        "length": 10,
        "offset": 10,
        "style": {
          "location": "<opaque_url>",
          "revision": "2B3C4D5E",
          "style": "c3R5bGUta2V5Ol90Ymw",
          "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
        },
        "table": {
          "revision": "24601abc",
          "table": "WA66srK9AtGU3PvTjs4dMCR9B34EoH6LqyloPIRNdxS5Bgs3p199MQzPsA"
        }
      },
      "type": "chart"
    }
  ],
  "format": {
    "backgroundColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "baselineShift": "superscript",
    "bold": true,
    "characterSpacing": -25,
    "font": "Times New Roman",
    "italic": true,
    "size": 14,
    "strikethrough": true,
    "textColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "underline": true
  },
  "index": 0,
  "list": {
    "level": 1,
    "prefix": "[",
    "startAt": 1,
    "style": {
      "location": "<opaque_url>",
      "revision": "2B3C4D5E",
      "style": "c3R5bGUta2V5Ol90Ymw",
      "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
    },
    "suffix": "]"
  },
  "properties": {
    "alignment": "justified",
    "endIndent": 240,
    "firstLineIndent": 240,
    "lineSpacing": {
      "unit": "percent",
      "value": 100
    },
    "pageBreakBefore": false,
    "spaceAfterParagraph": 10.5,
    "spaceBeforeParagraph": 12.5,
    "startIndent": 240
  },
  "style": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "style": "c3R5bGUta2V5Ol90Ymw",
    "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
  }
}

ParagraphProperties

The properties for rich-text paragraphs. Null values indicate that the format is inheriting from style or the container when reading.

Properties

Name	Type	Description	Restrictions
alignment	ParagraphPropertiesAlignment	Indicates the horizontal alignment of the text within a paragraph
endIndent	number¦null	The amount of indent, in points, from the margin to apply to all the lines of a paragraph at the end of each line. Positive is towards the enter of the page.
firstLineIndent	number¦null	The amount of indent, in points, from the margin to apply to the first line of a paragraph in addition to the start indent. Positive is towards the center of the page.
lineSpacing	LineSpacing	Defines the line spacing of a paragraph.
pageBreakBefore	boolean¦null	Whether or not this paragraph starts on a new page
spaceAfterParagraph	number¦null	The amount space, in points, after the paragraph.
spaceBeforeParagraph	number¦null	The amount of space, in points, before the paragraph.
startIndent	number¦null	The amount of indent, in points, from the margin to apply to all the lines of a paragraph from the start of each line. Positive is towards the center of the page.

Example

{
  "alignment": "justified",
  "endIndent": 240,
  "firstLineIndent": 240,
  "lineSpacing": {
    "unit": "percent",
    "value": 100
  },
  "pageBreakBefore": false,
  "spaceAfterParagraph": 10.5,
  "spaceBeforeParagraph": 12.5,
  "startIndent": 240
}

ParagraphPropertiesAlignment

Indicates the horizontal alignment of the text within a paragraph

Properties

Name	Type	Description	Restrictions
anonymous	string¦null	Indicates the horizontal alignment of the text within a paragraph

Enumerated Values

Property	Value
anonymous	left
anonymous	center
anonymous	right
anonymous	justified

Example

"justified"

ParagraphRelative

Represents a position relative to the start of the paragraph corresponding to the paragraph index.

Properties

Name	Type	Description	Restrictions
paragraphIndex	integer	The zero-based inclusive index of a paragraph.	Minimum: 0
x	number	The horizontal offset in points typically from the left edge.
y	number	The vertical offset in points typically from the top edge where larger numbers are further down/

Example

{
  "paragraphIndex": 3,
  "x": 0,
  "y": 0
}

ParagraphSelection

A selection of one or more paragraphs, starting from the start paragraph and ending with the stop paragraph. Both start and stop paragraph indexes are inclusive.

Properties

Name	Type	Description	Restrictions
start	integer	The zero-based inclusive starting index of a paragraph.	Minimum: 0
stop	integer	The zero-based inclusive stopping index of a paragraph.	Minimum: 0

Example

{
  "start": 1,
  "stop": 3
}

ParagraphsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of Paragraph 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¦null	Pagination link for next set of results	read-only
data	[Paragraph]	A paragraph of rich-text content.	read-only
revision	Revision	Identifies a unique revision of content. The same revision can be used for any content request within a file because revisions are allocated at the file-level. When querying for content, this can be used to get a consistent version of the content. When editing content, this can be used to make the change to the content at a known state. In either case, omitting the revision (when allowed) will always default to the latest revision of the file.

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "elements": [
        {
          "chart": {
            "dimensions": {
              "height": 240,
              "width": 240
            },
            "length": 10,
            "offset": 10,
            "style": {
              "location": "<opaque_url>",
              "revision": "2B3C4D5E",
              "style": "c3R5bGUta2V5Ol90Ymw",
              "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
            },
            "table": {
              "revision": "24601abc",
              "table": "WA66srK9AtGU3PvTjs4dMCR9B34EoH6LqyloPIRNdxS5Bgs3p199MQzPsA"
            }
          },
          "type": "chart"
        }
      ],
      "format": {
        "bold": true
      },
      "index": 0,
      "properties": {
        "alignment": "justified",
        "endIndent": 240,
        "firstLineIndent": 240,
        "pageBreakBefore": false,
        "startIndent": 240
      },
      "style": {
        "location": "<opaque_url>",
        "revision": "2B3C4D5E",
        "style": "c3R5bGUta2V5Ol90Ymw",
        "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
      }
    }
  ],
  "revision": "2c6438ab4541de6d"
}

PatchDocumentListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

PatchPresentationListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

PatchSectionListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

PatchSheetListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

PatchSlideLayoutListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

PatchSlideListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

PatchSpreadsheetListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

PatchTablePropertiesListResult

RReturns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

Position

A coordinate position on a page, slide, etc.

Properties

Name	Type	Description	Restrictions
x	number	The horizontal offset in points typically from the left edge.	required
y	number	The vertical offset in points typically from the top edge where larger numbers are further down/	required

Example

{
  "x": 0,
  "y": 0
}

PrototypeFileExport

Details about a file export including the file name and target type.

Properties

Name	Type	Description	Restrictions
kind	string	Kind (Type) of the file which will be exported.
workivaFileExportOptions	WorkivaFileExportOptions¦null	Additional export options used for Workiva (.tar.gz) files. Should only be provided when type is “Workiva”.

Enumerated Values

Property	Value
kind	Workiva

Example

{
  "kind": "Workiva",
  "workivaFileExportOptions": {
    "sourceId": "V0ZEYXRhRW50aXR5HkZvbGRlcjowNmUzNjRiNy0wYmFiLTRiOTQtYmM5Yy1lZWRjZTdjMDA4ZTE"
  }
}

PrototypeFileExportById

Details about a file export including the target type.

Properties

Name	Type	Description	Restrictions
documentExport	DocumentExport¦null	Details about the document export, including its format and options
folderExport	FolderExport¦null	Details about the folder export, including its options
kind	string	Kind (Type) of the file which will be exported.
presentationExport	PresentationExport¦null	Details about the presentation export, including its format and options
spreadsheetExport	PlatformSpreadsheetExport¦null	Details about a spreadsheet export.

Enumerated Values

Property	Value
kind	Document
kind	Spreadsheet
kind	Presentation
kind	SupportingDocument
kind	Folder

Example

{
  "kind": "SupportingDocument"
}

RangeData

Properties

Name	Type	Description	Restrictions
range	string	A1 style representation of the range containing this data
values	LegacyRangeValues	Row-major ordered multidimensional array of cell values

Example

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

RangeDataResponse

Response containing range data

Properties

Name	Type	Description	Restrictions
data	RangeData
next_url	string	A fully qualified URL, including required query parameters, for the next page of results. If there is no next page to query for, this will be empty.
page	integer	The one based page index that the result corresponds to. Only included during paging.
paged_region	string	The entire region that the collection of pages represents. Only included during data paging.
per_page	integer	The maximum number of items in a page. A page is not guaranteed to have exactly this many items. Only included during paging.
request_id	string	A unique identifier for the request
revision	integer	The revision number of this spreadsheet

Example

{
  "data": {
    "range": "A1:B2",
    "values": [
      [
        "Row1-Column1 Data",
        "Row1-Column2 Data"
      ],
      [
        "Row2-Column1 Data",
        "Row2-Column2 Data"
      ]
    ]
  },
  "next_url": "https://api.app.wdesk.com/spreadsheets/v1/spreadsheets/567nd179ed984eb5a52aaaba5f83a230/sheets/k78a604b74564afa76b5ba96755123456/data/A1%3AB20?page=2&per_page=1&revision=3",
  "page": 2,
  "paged_region": "A1:B20",
  "per_page": 1,
  "request_id": "d6a6ce3f-f120-4104-9587-a5a2dc45626c",
  "revision": 3
}

RangeLink

Contains properties for a range link.

Properties

Name	Type	Description	Restrictions
destination	RangeLinkDestination	Contains properties for a range link destination.
id	RangeLinkId	The unique identifier of a range link.	required
revision	Revision	Identifies a unique revision of content. The same revision can be used for any content request within a file because revisions are allocated at the file-level. When querying for content, this can be used to get a consistent version of the content. When editing content, this can be used to make the change to the content at a known state. In either case, omitting the revision (when allowed) will always default to the latest revision of the file.	required
source	RangeLinkSource	Contains properties for a range link source.
table	TableId	The unique identifier of a table	required
type	RangeLinkType	The type of range link.	required

Example

{
  "destination": {
    "source": {
      "rangeLink": "f649093edf354cfe8ce52fa60990a109",
      "revision": "2B3C4D5E",
      "table": "8610c7b132e944cb9e5c11daf08b1b1c"
    }
  },
  "id": "f649093edf354cfe8ce52fa60990a109",
  "revision": "2c6438ab4541de6d",
  "source": {
    "range": {
      "startColumn": 0,
      "startRow": 5,
      "stopColumn": 3,
      "stopRow": 9
    }
  },
  "table": "WA7i5vbm7lNaEn6XT97lNaEn6XT9AtcW5vb22BJjMrqxmrujMrqxmru",
  "type": "source"
}

RangeLinkDestination

Contains properties for a range link destination.

Properties

Name	Type	Description	Restrictions
source	RangeLinkRef	A reference to a range link.	required

Example

{
  "source": {
    "rangeLink": "f649093edf354cfe8ce52fa60990a109",
    "revision": "2B3C4D5E",
    "table": "8610c7b132e944cb9e5c11daf08b1b1c"
  }
}

RangeLinkEdit

An edit for modifying, creating, removing a range link over a table The edit property associated with the edit type is required. Any edit property that doesn’’t correspond to its type will be ignored.

Properties

Name	Type	Description	Restrictions
changeSourceRange	ChangeSourceRange¦null	Changes a source links range
createDestination	CreateDestinationRangeLink¦null	Creates a range destination link on the provided range
createSource	CreateSourceRangeLink¦null	Creates a range source link on the provided range
removeDestination	RemoveDestinationRangeLink¦null	Removes a range destination link on the provided range
removeSource	RemoveSourceRangeLink¦null	Removes a range source link on the provided range
type	string	The type of the table range links edit	required

Enumerated Values

Property	Value
type	createSource
type	createDestination
type	removeSource
type	removeDestination
type	changeSourceRange

Example

{
  "removeSource": {
    "range": {
      "startColumn": 0,
      "startRow": 5,
      "stopColumn": 3,
      "stopRow": 9
    },
    "rangeLink": "WAxsaHxoYvTB4D0twUm6YtiF99TNO0gBkSOhgYBed9AMB99EUxqELDQychBaGR9SkZucm5sK"
  },
  "type": "removeSource"
}

RangeLinkEditResult

A reference to a resource that was created by an operation.

Properties

Name	Type	Description	Restrictions
rangeLink	string¦null	The ID of the rangeLink that was created.
type	string	The type of resource created from a range link edit.	required

Enumerated Values

Property	Value
type	rangeLink

Example

{
  "rangeLink": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
  "type": "rangeLink"
}

RangeLinkEditResultCollection

A collection of created results from a range link edit. When there are no additional results before the current collection, the previous property will be null. When there are no additional results after the current collection, the next property will be null.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	[RangeLinkEditResult]	The current page of data.
revision	Revision	Identifies a unique revision of content. The same revision can be used for any content request within a file because revisions are allocated at the file-level. When querying for content, this can be used to get a consistent version of the content. When editing content, this can be used to make the change to the content at a known state. In either case, omitting the revision (when allowed) will always default to the latest revision of the file.

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "rangeLink": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
      "type": "rangeLink"
    }
  ],
  "revision": "24601abc"
}

RangeLinkId

The unique identifier of a range link.

Properties

Name	Type	Description	Restrictions
anonymous	string	The unique identifier of a range link.	Minimum length: 1

Example

"f649093edf354cfe8ce52fa60990a109"

RangeLinkListResult

Data model for range link list

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	[RangeLink]	The current page of range links

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "destination": {
        "source": {
          "rangeLink": "f649093edf354cfe8ce52fa60990a109",
          "revision": "2B3C4D5E",
          "table": "8610c7b132e944cb9e5c11daf08b1b1c"
        }
      },
      "id": "f649093edf354cfe8ce52fa60990a109",
      "revision": "2c6438ab4541de6d",
      "source": {
        "range": {
          "startColumn": 0,
          "startRow": 5,
          "stopColumn": 3,
          "stopRow": 9
        }
      },
      "table": "WA7i5vbm7lNaEn6XT97lNaEn6XT9AtcW5vb22BJjMrqxmrujMrqxmru",
      "type": "source"
    }
  ]
}

RangeLinkRef

A reference to a range link.

Properties

Name	Type	Description	Restrictions
rangeLink	RangeLinkId	The unique identifier of a range link.	required
revision	Revision	Identifies a unique revision of content. The same revision can be used for any content request within a file because revisions are allocated at the file-level. When querying for content, this can be used to get a consistent version of the content. When editing content, this can be used to make the change to the content at a known state. In either case, omitting the revision (when allowed) will always default to the latest revision of the file.
table	TableId	The unique identifier of a table	required

Example

{
  "rangeLink": "f649093edf354cfe8ce52fa60990a109",
  "revision": "2B3C4D5E",
  "table": "8610c7b132e944cb9e5c11daf08b1b1c"
}

RangeLinkSource

Contains properties for a range link source.

Properties

Name	Type	Description	Restrictions
range	CellRange	A range of cells in a table. If any field is omitted or null, the range is unbounded in that direction. All indexes are zero based.	required

Example

{
  "range": {
    "startColumn": 0,
    "startRow": 5,
    "stopColumn": 3,
    "stopRow": 9
  }
}

RangeLinkType

The type of range link.

Properties

Name	Type	Description	Restrictions
anonymous	string	The type of range link.

Enumerated Values

Property	Value
anonymous	source
anonymous	destination

Example

"source"

RemoveCellsLink

Removes source and destination links in a table range. This operation will be a no-op if no cell links exist within the table range.

Properties

Name	Type	Description	Restrictions
ranges	[CellRange]	The ranges to remove links from.	required

Example

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

RemoveDestinationRangeLink

Removes a range destination link on the provided range

Properties

Name	Type	Description	Restrictions
rangeLink	RangeLinkId	The unique identifier of a range link.	required

Example

{
  "rangeLink": "f649093edf354cfe8ce52fa60990a109"
}

RemoveHyperlinks

Removes hyperlinks from a range of text. If a selection starts or stops in the middle of an existing hyperlink the selection will be expanded to include the start and stop of the existing hyperlink.

Properties

Name	Type	Description	Restrictions
selection	RichTextSelection	The selection where the hyperlinks will be removed. All hyperlinks within the selection will be removed.	required

Example

{
  "selection": {
    "start": {
      "offset": 0,
      "paragraphIndex": 0
    },
    "stop": {
      "offset": 10,
      "paragraphIndex": 2
    }
  }
}

RemoveLinks

A text edit for removing source and destination links in rich text. This operation will be a no-op if no links exist within the range of text.

Properties

Name	Type	Description	Restrictions
selection	RichTextSelection	Describes a selection within piece of rich text	required

Example

{
  "selection": {
    "start": {
      "offset": 0,
      "paragraphIndex": 2
    },
    "stop": {
      "offset": 70,
      "paragraphIndex": 4
    }
  }
}

RemoveSourceRangeLink

Removes a range source link on the provided range

Properties

Name	Type	Description	Restrictions
rangeLink	RangeLinkId	The unique identifier of a range link.	required

Example

{
  "rangeLink": "WAxsaHxoYvTB4D0twUm6YtiF99TNO0gBkSOhgYBed9AMB99EUxqELDQychBaGR9SkZucm5sK"
}

Revision

Identifies a unique revision of content. The same revision can be used for any content request within a file because revisions are allocated at the file-level. When querying for content, this can be used to get a consistent version of the content. When editing content, this can be used to make the change to the content at a known state. In either case, omitting the revision (when allowed) will always default to the latest revision of the file.

Properties

Name	Type	Description	Restrictions
anonymous	string	Identifies a unique revision of content. The same revision can be used for any content request within a file because revisions are allocated at the file-level. When querying for content, this can be used to get a consistent version of the content. When editing content, this can be used to make the change to the content at a known state. In either case, omitting the revision (when allowed) will always default to the latest revision of the file.

Example

"2c6438ab4541de6d"

RichCellBatchEdit

Collection of edits to perform on the rich text of a cell in the table.

Properties

Name	Type	Description	Restrictions
cell	Cell	A cell indicates a single cell in a table. All indexes are zero based.	required
data	[TextEdit]	An edit for modifying rich text. The type of the edit is required. Any edit property that doesn’t correspond to its specified type will be ignored.	required
isolateEdits	boolean	Whether the edits in a batch should be isolated from one-another. The edits will still be applied in order, but subsequent edits are unaffected by the previous edits in the same batch. For example, if one edit inserts some content, the next edits will act as if the content doesn’t exist yet. Or if an edit deletes some content, the next edits will act as if the content is still there. This mode makes it easier to apply many edits on existing content because you don’t need to manually keep track of how the previous edits have moved the content. For example, if you want to replace all instances of one word with another it will be easier to do this with isolated edits.	required

Example

{
  "cell": {
    "column": 2,
    "row": 5
  },
  "data": [
    {
      "insertText": {
        "format": {
          "font": "Times New Roman",
          "size": 14,
          "underline": true
        },
        "inheritFormats": true,
        "insertAt": {
          "offset": 0,
          "paragraphIndex": 0
        },
        "text": "Thank you"
      },
      "type": "insertText"
    }
  ],
  "isolateEdits": true
}

RichCellLinkBatchEdit

A collection of edits to perform on the rich text links of a cell in table content.

Properties

Name	Type	Description	Restrictions
cell	Cell	A cell indicates a single cell in a table. All indexes are zero based.	required
data	[TextLinkEdit]	The link edits to apply.	required
isolateEdits	boolean	Whether the edits in a batch should be isolated from one-another. The edits will still be applied in order, but subsequent edits are unaffected by the previous edits in the same batch. For example, if one edit inserts some content, the next edits will act as if the content doesn’t exist yet. Or if an edit deletes some content, the next edits will act as if the content is still there. This mode makes it easier to apply many edits on existing content because you don’t need to manually keep track of how the previous edits have moved the content. For example, if you want to replace all instances of one word with another it will be easier to do this with isolated edits.	required

Example

{
  "cell": {
    "column": 0,
    "row": 1
  },
  "data": [
    {
      "insertDestinationLink": {
        "insertAt": {
          "offset": 10,
          "paragraphIndex": 2
        },
        "sourceAnchor": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru"
      },
      "type": "insertDestinationLink"
    },
    {
      "removeLinks": {
        "selection": {
          "start": {
            "offset": 0,
            "paragraphIndex": 4
          },
          "stop": {
            "offset": 12,
            "paragraphIndex": 6
          }
        }
      },
      "type": "removeLinks"
    }
  ],
  "isolateEdits": false
}

RichTextAnchorCreation

Details about the rich text anchor creation.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.	required
selection	RichTextSelection	Describes a selection within piece of rich text	required
type	RichTextSelectionAnchorAttachmentPointType	The type of attachment point.	required

Example

{
  "revision": "24601abc",
  "selection": {
    "start": {
      "offset": 0,
      "paragraphIndex": 0
    },
    "stop": {
      "offset": 10,
      "paragraphIndex": 2
    }
  },
  "type": "sourceLink"
}

RichTextBaselineShift

Indicates the offset from the baseline of the characters. The baseline is the imaginary bottom line for a line of text which the bottom of the characters are placed, not including any descender such as g, j, p, and y have. superscript shifts the baseline up and reduces the rendered font size to 65% of the specified font size. subscript works the same as superscript except it moves the baseline down. baseline uses the default size and baseline for regular text. type: string

Properties

Name	Type	Description	Restrictions
anonymous	string¦null	Indicates the offset from the baseline of the characters. The baseline is the imaginary bottom line for a line of text which the bottom of the characters are placed, not including any descender such as g, j, p, and y have. superscript shifts the baseline up and reduces the rendered font size to 65% of the specified font size. subscript works the same as superscript except it moves the baseline down. baseline uses the default size and baseline for regular text. type: string

Enumerated Values

Property	Value
anonymous	baseline
anonymous	superscript
anonymous	subscript

Example

"superscript"

RichTextBatchEdit

A collection of edits to apply to rich text.

Properties

Name	Type	Description	Restrictions
data	[TextEdit]	The edits to apply to the rich text.	required, Minimum items: 1, Maximum items: 100
islolateEdits	boolean	Whether the edits in a batch should be isolated from one-another. The edits will still be applied in order, but subsequent edits are unaffected by the previous edits in the same batch. For example, if one edit inserts some content, the next edits will act as if the content doesn’t exist yet. Or if an edit deletes some content, the next edits will act as if the content is still there. This mode makes it easier to apply many edits on existing content because you don’t need to manually keep track of how the previous edits have moved the content. For example, if you want to replace all instances of one word with another it will be easier to do this with isolated edits.
revision	Revision¦null	Identifies a unique revision of content. The same revision can be used for any content request within a file because revisions are allocated at the file-level. When querying for content, this can be used to get a consistent version of the content. When editing content, this can be used to make the change to the content at a known state. In either case, omitting the revision (when allowed) will always default to the latest revision of the file.

Example

{
  "data": [
    {
      "insertText": {
        "format": {
          "bold": true,
          "font": "Times New Roman"
        },
        "inheritFormats": true,
        "insertAt": {
          "offset": 5,
          "paragraphIndex": 0
        },
        "text": "Hello, world!"
      },
      "type": "insertText"
    }
  ],
  "isolateEdits": false,
  "revision": "24601abc"
}

RichTextDuplicationEdit

A text edit for duplicating content into rich text. The edit property associated with the edit type is required. Any edit property that doesn’t correspond to its type will be ignored.

Properties

Name	Type	Description	Restrictions
duplicateTable	DuplicateTable¦null	An edit to duplicate a table in rich text.
revision	Revision¦null	Identifies a unique revision of content. The same revision can be used for any content request within a file because revisions are allocated at the file-level. When querying for content, this can be used to get a consistent version of the content. When editing content, this can be used to make the change to the content at a known state. In either case, omitting the revision (when allowed) will always default to the latest revision of the file.
type	string	The type of rich text duplication edit.	required

Enumerated Values

Property	Value
type	duplicateTable

Example

{
  "duplicateTable": {
    "insertAt": {
      "offset": 0,
      "paragraphIndex": 2
    },
    "sourceTable": "WAxsaHxoYvTB4D0twUm6YtiF99TNO0gBkSOhgYBed9AMB99EUxqELDQychBaGR9SkZucm5sK"
  },
  "revision": "24601abc",
  "type": "duplicateTable"
}

RichTextEditResult

A reference to a resource that was created by a rich text edit.

Properties

Name	Type	Description	Restrictions
richText	RichTextId¦null	The unique identifier of the rich text created by the rich text edit.
table	TableId¦null	The unique identifier of the table created by the rich text edit.
type	string	The type of resource created from a rich text edit.

Enumerated Values

Property	Value
type	table
type	richText

Example

{
  "table": "8610c7b132e944cb9e5c11daf08b1b1c",
  "type": "table"
}

RichTextFormat

The formatting options applied to rich text elements.

Properties

Name	Type	Description	Restrictions
backgroundColor	Color¦null	The background color in RGB format
baselineShift	RichTextBaselineShift	Indicates the offset from the baseline of the characters. The baseline is the imaginary bottom line for a line of text which the bottom of the characters are placed, not including any descender such as g, j, p, and y have. superscript shifts the baseline up and reduces the rendered font size to 65% of the specified font size. subscript works the same as superscript except it moves the baseline down. baseline uses the default size and baseline for regular text. type: string
bold	boolean¦null	Whether or not the text is bold
characterSpacing	integer¦null	The amount of space, in 1/1000 of an em, between characters.
font	string¦null	The name of the font
italic	boolean¦null	Whether or not the text is italicized
size	number¦null	The font size of the characters in points	Maximum: 100, Minimum: 1
strikethrough	boolean¦null	Whether or not the text is struck through
textColor	Color¦null	The text color in RGB format
underline	boolean¦null	Whether or not the text is underlined

Example

{
  "backgroundColor": {
    "blue": 128,
    "green": 128,
    "red": 128
  },
  "baselineShift": "superscript",
  "bold": true,
  "characterSpacing": -25,
  "font": "Times New Roman",
  "italic": true,
  "size": 14,
  "strikethrough": true,
  "textColor": {
    "blue": 128,
    "green": 128,
    "red": 128
  },
  "underline": true
}

RichTextId

The unique identifier of rich text.

Properties

Name	Type	Description	Restrictions
anonymous	string	The unique identifier of rich text.	Minimum length: 1

Example

"WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"

RichTextInsertTable

A text edit for inserting an embedded table into rich text. If a dimensions property is set it will be respected unless it forces a cell to shrink beyond a minimum width. The created table id associated with the embedded table can be retrieved from the rich text edit operation results. This edit is not supported in table rich cell edits.

Properties

Name	Type	Description	Restrictions
columnCount	integer	The number of columns in the table.	required, Minimum: 1
dimensions	object	The dimensions of the inserted table. If a width or height are omitted the width or height will be defaulted based off the number of columns or rows.
dimensions.height	number¦null	The vertical measurement in points.	Minimum: 1
dimensions.width	number¦null	The horizontal measurement in points.	Minimum: 1
insertAt	Caret	A caret (as in Caret Navigation) is a location between two characters in a paragraph.	required
rowCount	integer	The number of rows in the table.	required, Minimum: 1

Example

{
  "columnCount": 3,
  "dimensions": {
    "height": 240,
    "width": 320
  },
  "insertAt": {
    "offset": 5,
    "paragraphIndex": 0
  },
  "rowCount": 10
}

RichTextLinksBatchEdit

A collection of link edits to perform on rich text content.

Properties

Name	Type	Description	Restrictions
data	[TextLinkEdit]	The link edits to apply to rich text.	required, Minimum items: 1, Maximum items: 100
isolateEdits	boolean	Whether the edits in a batch should be isolated from one-another. The edits will still be applied in order, but subsequent edits are unaffected by the previous edits in the same batch. For example, if one edit inserts some content, the next edits will act as if the content doesn’t exist yet. Or if an edit deletes some content, the next edits will act as if the content is still there. This mode makes it easier to apply many edits on existing content because you don’t need to manually keep track of how the previous edits have moved the content. For example, if you want to replace all instances of one word with another it will be easier to do this with isolated edits.
revision	Revision¦null	Identifies a unique revision of content. The same revision can be used for any content request within a file because revisions are allocated at the file-level. When querying for content, this can be used to get a consistent version of the content. When editing content, this can be used to make the change to the content at a known state. In either case, omitting the revision (when allowed) will always default to the latest revision of the file.

Example

{
  "data": [
    {
      "insertDestinationLink": {
        "insertAt": {
          "offset": 10,
          "paragraphIndex": 4
        },
        "sourceAnchor": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru"
      },
      "type": "insertDestinationLink"
    }
  ],
  "isolateEdits": false,
  "revision": "24601abc"
}

RichTextLinksEditResult

A reference to a resource that was created by rich text links edit.

Properties

Name	Type	Description	Restrictions
destinationLink	string¦null	The unique identifier of a destination link created by the rich text links edit.
type	string	The type of resource created from a rich text link edit

Enumerated Values

Property	Value
type	destinationLink

Example

{
  "destinationLink": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
  "type": "destinationLink"
}

RichTextRef

A reference to rich text content in a document, spreadsheet, or presentation

Properties

Name	Type	Description	Restrictions
location	string¦null	❗️ Deprecated: A URL that a GET request can be made against to retrieve this rich text	read-only
revision	string	The revision of the rich text being referred to	read-only
richText	RichTextId	The unique identifier of rich text.	read-only

Example

{
  "location": "string",
  "revision": "2B3C4D5E",
  "richText": "WA2NiYGJgm7cWr4W6Ka9BHScz56m2AT2FqTmBgekyk399M99I9Bb69BoEt3WHCag"
}

RichTextSelection

Describes a selection within piece of rich text

Properties

Name	Type	Description	Restrictions
start	Caret	A caret (as in Caret Navigation) is a location between two characters in a paragraph.	required
stop	Caret	A caret (as in Caret Navigation) is a location between two characters in a paragraph.	required

Example

{
  "start": {
    "offset": 0,
    "paragraphIndex": 0
  },
  "stop": {
    "offset": 10,
    "paragraphIndex": 2
  }
}

RichTextSelectionAnchorAttachmentPoint

An attachment point to a selection in rich text content.

Properties

Name	Type	Description	Restrictions
selection	RichTextSelection	Describes a selection within piece of rich text
type	RichTextSelectionAnchorAttachmentPointType	The type of attachment point.

Example

{
  "selection": {
    "start": {
      "offset": 0,
      "paragraphIndex": 0
    },
    "stop": {
      "offset": 10,
      "paragraphIndex": 0
    }
  },
  "type": "sourceLink"
}

RichTextSelectionAnchorAttachmentPointType

The type of attachment point.

Properties

Name	Type	Description	Restrictions
anonymous	string	The type of attachment point.

Enumerated Values

Property	Value
anonymous	comment
anonymous	sourceLink

Example

"sourceLink"

Rotation

The rotation in degrees of a shape around the center point of the shape. The rotation is applied after the shape is positioned and sized meaning the position and dimensions are for the shape without any rotation.

Properties

Name	Type	Description	Restrictions
anonymous	number	The rotation in degrees of a shape around the center point of the shape. The rotation is applied after the shape is positioned and sized meaning the position and dimensions are for the shape without any rotation.	Maximum: 360, Minimum: 0

Example

90

RowPropertiesListResult

Data model for row properties list

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	[TableRowProperties]	The current page of row properties
revision	Revision	Identifies a unique revision of content. The same revision can be used for any content request within a file because revisions are allocated at the file-level. When querying for content, this can be used to get a consistent version of the content. When editing content, this can be used to make the change to the content at a known state. In either case, omitting the revision (when allowed) will always default to the latest revision of the file.

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "filtered": false,
      "height": 24,
      "hidden": false
    }
  ],
  "revision": "2c6438ab4541de6d"
}

RowRange

Describes a row range

Properties

Name	Type	Description	Restrictions
startRow	integer	The zero based index of the start of the range (inclusive).	Minimum: 0
stopRow	integer	The zero based index of the end of the range (inclusive).	Minimum: 0

Example

{
  "startRow": 5,
  "stopRow": 5
}

SectionPageNumber

A dynamic content text element which will be replaced with the page number of a specified section.

Properties

Name	Type	Description	Restrictions
format	RichTextFormat	The formatting options applied to rich text elements.
length	integer	The number of characters (32-bit unicode code point) for a text element or range of text in a selection. Most elements will have a length of 1, even if it is dynamic content which will be replaced by possibly multiple characters. The lengths are used when editing with offsets from an element. The sum of the lengths up to a specific element from another is the offset between those text elements.	Minimum: 1
offset	integer	The number of items to skip over in a collection before the items which will be returned or worked on. The items may be shapes, sections, elements, characters, slides, etc depending on which object or path the offset is being used on.	Minimum: 0
section	SectionRef	A reference to a section in a document outline
style	StyleRef	A reference to a style.

Example

{
  "format": {
    "backgroundColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "baselineShift": "superscript",
    "bold": true,
    "characterSpacing": -25,
    "font": "Times New Roman",
    "italic": true,
    "size": 14,
    "strikethrough": true,
    "textColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "underline": true
  },
  "length": 1,
  "offset": 10,
  "section": {
    "document": "16b1f641613847469b7aa1ca29af40b1",
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "section": "16b1f641613847469b7aa1ca29af40b1_650855815308"
  },
  "style": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "style": "c3R5bGUta2V5Ol90Ymw",
    "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
  }
}

SetCellsBorders

Applies borders to cells in the given ranges of a table.

Properties

Name	Type	Description	Restrictions
bottom	CellBorder¦null	The border of a rectangle for properties of objects such as a table cell.
left	CellBorder¦null	The border of a rectangle for properties of objects such as a table cell.
ranges	CellRanges	A collection of cell ranges in a table.	required
right	CellBorder¦null	The border of a rectangle for properties of objects such as a table cell.
top	CellBorder¦null	The border of a rectangle for properties of objects such as a table cell.

Example

{
  "bottom": {
    "color": {
      "blue": 255,
      "green": 136,
      "red": 155
    },
    "style": "single",
    "weight": 1
  },
  "left": null,
  "ranges": [
    {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": 2,
      "stopRow": 2
    }
  ],
  "right": null,
  "top": {
    "color": {
      "blue": 255,
      "green": 136,
      "red": 155
    },
    "style": "single",
    "weight": 1
  }
}

SetCellsLock

Locks or unlocks cells in the given ranges of a table. The operation will no-op if the cell is already in the state associated with the lock.

Properties

Name	Type	Description	Restrictions
lock	boolean	Whether to lock or unlock the ranges of cells.	required
ranges	CellRanges	A collection of cell ranges in a table.	required

Example

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

SetCellsProperties

Applies properties to cells in the given ranges of a table.

Properties

Name	Type	Description	Restrictions
fillColor	Color¦null	The fill color in RGB format
horizontalAlignment	CellHorizontalAlignment¦null	The horizontal alignment of the content in the cell.
indent	number¦null	The indentation of content in the cell.	Minimum: 0
ranges	CellRanges	A collection of cell ranges in a table.	required
verticalAlignment	CellVerticalAlignment¦null	The vertical alignment of the content in the cell.

Example

{
  "fillColor": {
    "blue": 255,
    "green": 136,
    "red": 155
  },
  "horizontalAlignment": "center",
  "indent": 4.2,
  "ranges": [
    {
      "startColumn": 0,
      "startRow": 0,
      "stopColumn": 2,
      "stopRow": 2
    }
  ],
  "verticalAlignment": "middle"
}

SetCellsStyle

Applies a style to cells in the given ranges of a table. The “Normal” text style is not supported in table cells. Use the “Table (Normal)” style to apply normal styles to text in a table cell.

Properties

Name	Type	Description	Restrictions
ranges	CellRanges	A collection of cell ranges in a table.	required
style	string	The unique identifier of a style.	required

Example

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

SetCellsText

Writes text to a range of a table. This will overwrite any existing text with the given text. Cell properties and some formatting will be preserved. Some formatting on text will be removed by the overwrite. The provided text may not be larger than the specified range. Any null or missing elements in the text will not modify the corresponding cell.

Properties

Name	Type	Description	Restrictions
range	CellRange	A range of cells in a table. If any field is omitted or null, the range is unbounded in that direction. All indexes are zero based.	required
text	[array]		required

Example

{
  "range": {
    "startColumn": 0,
    "startRow": 0,
    "stopColumn": 2,
    "stopRow": 2
  },
  "text": [
    [
      "A1",
      "B1"
    ],
    [
      "A2",
      "B2"
    ]
  ]
}

SetHyperlink

Applies a hyperlink to a range of text. Any existing hyperlinks in a selection will be overwritten to point to the new hyperlink associated with this edit. If a selection starts or stops in the middle of an existing hyperlink the selection will be expanded to include the start and stop of the existing hyperlink.

Properties

Name	Type	Description	Restrictions
document	string¦null	The document id associated with the document hyperlink
presentation	string¦null	The presentation id associated with the presentation hyperlink
section	object¦null	The document and section ids associated with the section hyperlink
section.document	string	The document id associated with the section hyperlink
section.section	string	The section id associated with the section hyperlink
selection	RichTextSelection	The selection where the hyperlink will be applied. The selection range cannot contain any new lines, source links, destination links, embedded content (tables, images, charts, etc.), footnotes, or any dynamic references (page numbers, list item references, etc.)	required
sheet	object¦null	The spreadsheet and sheet ids associated with the sheet hyperlink
sheet.sheet	string	The sheet id associated with the sheet hyperlink
sheet.spreadsheet	string	The spreadsheet id associated with the sheet hyperlink
slide	object¦null	The presentation and slide ids associated with the slide hyperlink
slide.presentation	string	The presentation id associated with the slide hyperlink
slide.slide	string	The slide id associated with the slide hyperlink
spreadsheet	string¦null	The spreadsheet id associated with the spreadsheet hyperlink
type	string	The type of hyperlink to create. The property associated with this hyperlink type is required.	required
url	string¦null	The raw URL associated with the URL hyperlink	Minimum length: 1

Enumerated Values

Property	Value
type	document
type	section
type	presentation
type	slide
type	spreadsheet
type	sheet
type	url

Example

{
  "section": {
    "document": "327afa1a152f372fa1aeadb35ed28925d",
    "section": "327afa1a152f372fa1aeadb35ed28925d_42"
  },
  "selection": {
    "start": {
      "offset": 0,
      "paragraphIndex": 0
    },
    "stop": {
      "offset": 10,
      "paragraphIndex": 2
    }
  },
  "type": "section"
}

SetInputCells

Sets the input cells for a range of cells in a table. Setting input cells requires the input mode ability. The operation will no-op if the cell is already in the state associated with the input cell.

Properties

Name	Type	Description	Restrictions
inputCell	boolean	Whether the cells should be input cells.	required
ranges	CellRanges	A collection of cell ranges in a table.	required

Example

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

SetListFormat

An edit to set list formats on a range of paragraphs in rich text. Not supported when the parent batch has isolated edits turned on.

Properties

Name	Type	Description	Restrictions
level	integer¦null	The list level to apply to each list paragraph in the selection. Ignored if null. Ignored for non-list paragraphs in the selection.	Maximum: 10, Minimum: 1
prefix	string¦null	The prefix for each list paragraph in the selection. Ignored if null. Ignored for non-list paragraphs in the selection.	Maximum length: 10
selection	ParagraphSelection	A selection of one or more paragraphs, starting from the start paragraph and ending with the stop paragraph. Both start and stop paragraph indexes are inclusive.	required
startAt	integer¦null	The starting number for each list paragraph in the selection. Ignored if null. Ignored for non-list paragraphs in the selection. Can only be set on ordered lists.	Minimum: 1
style	string¦null	Identifier for a style. The list style to apply to the selection. Ignored if null. Will make all normal paragraphs in the selection list paragraphs.	Minimum length: 1
suffix	string¦null	The suffix for each list paragraph in the selection. Ignored if null. Ignored for non-list paragraphs in the selection.	Maximum length: 10

Example

{
  "level": 1,
  "prefix": "A",
  "selection": {
    "start": 1,
    "stop": 3
  },
  "startAt": 1,
  "style": "c3R5bGUta2V5Ol90Ymw",
  "suffix": "."
}

SetParagraphProperties

An edit to set properties on a range of paragraphs in rich text. Null properties are ignored.

Properties

Name	Type	Description	Restrictions
alignment	string¦null	The alignment of the paragraph.
endIndent	number¦null	The amount of indent, in points, from the margin to apply to all the lines of a paragraph at the end of each line. Positive is towards the center of the page.
firstLineIndent	number¦null	The amount of indent, in points, from the margin to apply to the first line of a paragraph in addition to the start indent. Positive is towards the center of the page.
lineSpacing	LineSpacing¦null	Defines the line spacing of a paragraph.
pageBreakBefore	boolean¦null	Whether the paragraph starts a new page. Cannot be set for rich text cells.
selection	ParagraphSelection	A selection of one or more paragraphs, starting from the start paragraph and ending with the stop paragraph. Both start and stop paragraph indexes are inclusive.	required
spaceAfterParagraph	number¦null	The amount of space, in points, after the paragraph.	Maximum: 791, Minimum: 0
spaceBeforeParagraph	number¦null	The amount of space, in points, before the paragraph.	Maximum: 791, Minimum: 0
startIndent	number¦null	The amount of indent, in points, from the margin to apply to all the lines of a paragraph from the start of each line. Positive is towards the center of the page.

Enumerated Values

Property	Value
alignment	left
alignment	center
alignment	right
alignment	justified

Example

{
  "alignment": "center",
  "endIndent": 24,
  "firstLineIndent": 24,
  "lineSpacing": {
    "unit": "percent",
    "value": 120
  },
  "pageBreakBefore": true,
  "selection": {
    "start": 1,
    "stop": 3
  },
  "spaceAfterParagraph": 12,
  "spaceBeforeParagraph": 12,
  "startIndent": 24
}

SetParagraphStyle

Applies a text or table style to a range of paragraphs. The “Table (Normal)” style can only be applied to text in table cells. Likewise, the “Normal” style can only be applied to non-table text.

Properties

Name	Type	Description	Restrictions
selection	ParagraphSelection	A selection of one or more paragraphs, starting from the start paragraph and ending with the stop paragraph. Both start and stop paragraph indexes are inclusive.	required
style	string	The unique identifier of a style.	required

Example

{
  "selection": {
    "start": 1,
    "stop": 3
  },
  "style": "c3R5bGUta2V5Ol90Ymw"
}

SetSectionLockEdit

Updates the selected section’s lock to the set value

Properties

Name	Type	Description	Restrictions
lock	SectionLockType	A lock applied to a section.	required
selection	SectionSelection	A selection of one or more sections	required

Example

{
  "lock": "lock",
  "selection": [
    "e34730f79a144b1b8977aa8884c208ee_321",
    "e34730f79a144b1b8977aa8884c208ee_123"
  ]
}

SetTableBreaking

The property that will dictate how the table will break across pages

Properties

Name	Type	Description	Restrictions
breakingPercentage	integer¦null	The percentage the table will break at, only set when type is breakWhenExceeds	Maximum: 100, Minimum: 0
type	TableBreakingType¦null	The type of table breaking

Example

{
  "breakingPercentage": 100,
  "type": "breakWhenExceeds"
}

SetTableTextElementProperties

An edit for configuring table behavior when the table spans multiple pages. If a property is null in the request, then it will be ignored.

Properties

Name	Type	Description	Restrictions
headerRows	integer¦null	The rows that are going to be headers. The value must be smaller than the row size minus 2.	Maximum: 10, Minimum: 0
selection	RichTextSelection	Describes a selection within piece of rich text	required
tableBreaking	SetTableBreaking¦null	The property that will dictate how the table will break across pages
titleRow	boolean¦null	Whether the title row displays on each page
titleSuffix	string¦null	The table title suffix

Example

{
  "headerRows": 1,
  "selection": {
    "start": {
      "offset": 0,
      "paragraphIndex": 0
    },
    "stop": {
      "offset": 10,
      "paragraphIndex": 2
    }
  },
  "tableBreaking": {
    "breakingPercentage": 33,
    "type": "breakWhenExceeds"
  },
  "titleRow": true,
  "titleSuffix": "suffix"
}

Shape

A drawing element for a shape such as a rectangle, ellipse, polygon, etc. This also includes arrows, left bracket, right bracket, and flow chart shapes. Shapes can have zero to two modifiers or an auxiliary point depending on the shape type.

Properties

Name	Type	Description	Restrictions
dimensions	Dimensions	A dimension of a rectangle for properties of objects such as a shape, text box, table, chart, image, or page.
fill	Fill	A shape or box fill settings for things like shapes. Use a null to indicate no fill.
id	DrawingElementId	Identifier of the drawing element
margins	Margins	The margins of a rectangle for properties of objects such as a shape, text box, or page.
paddings	Paddings	The paddings of a rectangle for properties of objects such as a shape, text box, or page.
paragraphs	[Paragraph]	The rich text paragraphs.
position	DrawingRelativePosition	The relative position of a drawing element.
rotation	Rotation	The rotation in degrees of a shape around the center point of the shape. The rotation is applied after the shape is positioned and sized meaning the position and dimensions are for the shape without any rotation.
shapeType	ShapeType	The type of a shape to draw. Some shapes are aliased to others; for example, decision is an alias of diamond. The shape “offPageReference” is unsupported by some non-Workiva applications and may cause issues during export if used.
stroke	Stroke	Line stroke setting for things like shape edges. Use a null to indicate no stroke line.
wrapStyle	WrapStyleType	The relative position type

Example

{
  "dimensions": {
    "height": 240,
    "width": 320
  },
  "fill": {
    "color": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "opacity": 0.5
  },
  "id": "WW91IGZvdW5kIG1lIQ",
  "margins": {
    "bottom": 10,
    "left": 10,
    "right": 10,
    "top": 10
  },
  "paddings": {
    "bottom": 10,
    "left": 10,
    "right": 10,
    "top": 10
  },
  "paragraphs": [
    {
      "elements": [
        {
          "chart": {
            "dimensions": {
              "height": 240,
              "width": 240
            },
            "length": 10,
            "offset": 10,
            "style": {
              "location": "<opaque_url>",
              "revision": "2B3C4D5E",
              "style": "c3R5bGUta2V5Ol90Ymw",
              "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
            },
            "table": {
              "revision": "24601abc",
              "table": "WA66srK9AtGU3PvTjs4dMCR9B34EoH6LqyloPIRNdxS5Bgs3p199MQzPsA"
            }
          },
          "type": "chart"
        }
      ],
      "format": {
        "backgroundColor": {
          "blue": 128,
          "green": 128,
          "red": 128
        },
        "baselineShift": "superscript",
        "bold": true,
        "characterSpacing": -25,
        "font": "Times New Roman",
        "italic": true,
        "size": 14,
        "strikethrough": true,
        "textColor": {
          "blue": 128,
          "green": 128,
          "red": 128
        },
        "underline": true
      },
      "index": 0,
      "list": {
        "level": 1,
        "prefix": "[",
        "startAt": 1,
        "style": {
          "location": "<opaque_url>",
          "revision": "2B3C4D5E",
          "style": "c3R5bGUta2V5Ol90Ymw",
          "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
        },
        "suffix": "]"
      },
      "properties": {
        "alignment": "justified",
        "endIndent": 240,
        "firstLineIndent": 240,
        "lineSpacing": {
          "unit": "percent",
          "value": 100
        },
        "pageBreakBefore": false,
        "spaceAfterParagraph": 10.5,
        "spaceBeforeParagraph": 12.5,
        "startIndent": 240
      },
      "style": {
        "location": "<opaque_url>",
        "revision": "2B3C4D5E",
        "style": "c3R5bGUta2V5Ol90Ymw",
        "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
      }
    }
  ],
  "position": {
    "paragraphRelative": {
      "paragraphIndex": 3,
      "x": 0,
      "y": 0
    },
    "type": "paragraphRelative"
  },
  "rotation": 90,
  "shapeType": "rectangle",
  "stroke": {
    "color": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "pattern": "solid",
    "width": 2
  },
  "wrapStyle": "inFrontOfText"
}

ShapeType

The type of a shape to draw. Some shapes are aliased to others; for example, decision is an alias of diamond. The shape “offPageReference” is unsupported by some non-Workiva applications and may cause issues during export if used.

Properties

Name	Type	Description	Restrictions
anonymous	string	The type of a shape to draw. Some shapes are aliased to others; for example, decision is an alias of diamond. The shape “offPageReference” is unsupported by some non-Workiva applications and may cause issues during export if used.

Enumerated Values

Property	Value
anonymous	rectangle
anonymous	roundedRectangle
anonymous	ellipse
anonymous	triangle
anonymous	diamond
anonymous	trapezoid
anonymous	parallelogram
anonymous	pentagon
anonymous	hexagon
anonymous	octagon
anonymous	arrowRight
anonymous	arrowLeft
anonymous	arrowUp
anonymous	arrowDown
anonymous	chevron
anonymous	cylinder
anonymous	rectangularCallout
anonymous	roundedRectangularCallout
anonymous	ovalCallout
anonymous	leftBracket
anonymous	rightBracket
anonymous	inputOutput
anonymous	terminator
anonymous	subroutine
anonymous	internalStorage
anonymous	manualInput
anonymous	manualOperation
anonymous	offPageConnector
anonymous	card
anonymous	document
anonymous	preparation
anonymous	display
anonymous	database
anonymous	directAccess
anonymous	storedData
anonymous	offPageReference

Example

"rectangle"

SoftReturn

A text element for a soft return. This moves the following text elements to a new line without creating a new paragraph.

Properties

Name	Type	Description	Restrictions
format	RichTextFormat	The formatting options applied to rich text elements.
length	integer	The number of characters (32-bit unicode code point) for a text element or range of text in a selection. Most elements will have a length of 1, even if it is dynamic content which will be replaced by possibly multiple characters. The lengths are used when editing with offsets from an element. The sum of the lengths up to a specific element from another is the offset between those text elements.	Minimum: 1
offset	integer	The number of items to skip over in a collection before the items which will be returned or worked on. The items may be shapes, sections, elements, characters, slides, etc depending on which object or path the offset is being used on.	Minimum: 0
style	StyleRef	A reference to a style.

Example

{
  "format": {
    "backgroundColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "baselineShift": "superscript",
    "bold": true,
    "characterSpacing": -25,
    "font": "Times New Roman",
    "italic": true,
    "size": 14,
    "strikethrough": true,
    "textColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "underline": true
  },
  "length": 1,
  "offset": 10,
  "style": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "style": "c3R5bGUta2V5Ol90Ymw",
    "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
  }
}

SourceParagraph

A paragraph of rich text content that is from a source link.

Properties

Name	Type	Description	Restrictions
elements	[SourceTextElement]	Elements contained in this paragraph.	required
format	RichTextFormat¦null	The formatting options applied to rich text elements.	required
list	ListFormat¦null	The list formatting options applied to the given paragraph.
properties	ParagraphProperties¦null	The properties for rich-text paragraphs. Null values indicate that the format is inheriting from style or the container when reading.	required
style	StyleRef	A reference to a style.	required

Example

{
  "elements": [
    {
      "textSpan": {
        "format": {
          "font": "Times New Roman",
          "italic": true,
          "size": 12
        },
        "length": 11,
        "offset": 0,
        "style": {
          "revision": "1A2B3C4D",
          "style": "WW91IGZvdW5kIG1lIQ",
          "styleGuide": "WW91IGZvdW5kIG1lIQ"
        },
        "text": "Hello World"
      },
      "type": "textSpan"
    }
  ],
  "format": {
    "bold": true
  },
  "list": {
    "level": 2,
    "prefix": "[",
    "startAt": 1,
    "style": {
      "style": "WW91IGZvdW5kIG1lIQ",
      "styleGuide": "WW91IGZvdW5kIG1lIQ"
    },
    "suffix": "]"
  },
  "properties": {},
  "style": {
    "style": "X3R4dDozZDUyMDg4ODBlNDk0YmYxYWVjYTIzM2VlYmY3ODM4Mg",
    "styleGuide": "3d5208880e494bf1aeca233eebf78382"
  }
}

SourceTextElement

A text element containing rich text content that is from a source link. This is a subset of TextElement and contains only types that are allowed within source links.

Properties

Name	Type	Description	Restrictions
softReturn	SoftReturn¦null	A text element for a soft return. This moves the following text elements to a new line without creating a new paragraph.
textSpan	TextSpan¦null	A text element for a span of text with the same formatting. The text string may contain almost any unicode character except for unicode from the Private Use Area (PUA) of unicode (U+E000..U+F8FF), paragraph separators (U+2029), line feeds (U+000A), and carriage returns (U+000D). Paragraph separators and line feeds will be turned into paragraphs. Carriage returns will be normalized out of the text during insertion. Other control unicode, like line separators (U+2028), no break space (U+00A0), and tabs (U+0009), may appear in this text. The text will be quote escaped and may contain unicode escaped characters like \t or \u0000.
type	string	The type of the text element in rich text that is from a source link.	required
unspecified	UnspecifiedTextElement¦null	An unspecified text element to use as a placeholder for elements that have not been explicitly defined in API models.

Enumerated Values

Property	Value
type	softReturn
type	textSpan
type	unspecified

Example

{
  "textSpan": {
    "format": null,
    "length": 5,
    "offset": 0,
    "style": {},
    "text": "Hello"
  },
  "type": "textSpan"
}

Stroke

Line stroke setting for things like shape edges. Use a null to indicate no stroke line.

Properties

Name	Type	Description	Restrictions
color	Color	Represents a color.	required
pattern	StrokePattern	The pattern to apply to the stroke.
width	number	The width of the stroke in points.

Example

{
  "color": {
    "blue": 128,
    "green": 128,
    "red": 128
  },
  "pattern": "solid",
  "width": 2
}

StrokePattern

The pattern to apply to the stroke.

Properties

Name	Type	Description	Restrictions
anonymous	string	The pattern to apply to the stroke.

Enumerated Values

Property	Value
anonymous	solid
anonymous	dashed
anonymous	dotted
anonymous	dash-dot
anonymous	ditted
anonymous	small-dash
anonymous	long-dash
anonymous	long-dash-dot
anonymous	long-dash-dot-dot

Example

"solid"

StyleGuide

Content containing a style guide. This holds the text styles, table styles, and list styles which comprise a style guide.

Properties

Name	Type	Description	Restrictions
id	string	The unique identifier of a style guide.
orderedListStyles	[ListStyle]	The ordered styles.	Maximum items: 1000
revision	string	The current revision of the style guide	read-only
tableStyles	[TableStyle]	The table styles.	Maximum items: 1000
textStyles	[TextStyle]	The text styles.	Maximum items: 1000
unorderedListStyles	[ListStyle]	The unordered list styles.	Maximum items: 1000

Example

{
  "id": "e810327bd46b4438b7feed9f1e2d055d",
  "orderedListStyles": [
    {
      "id": "bGlzdC5hcmFiaWM6ZTgxMDMyN2JkNDZiNDQzOGI3ZmVlZDlmMWUyZDA1NWQ",
      "index": 0,
      "isNormalStyle": true,
      "listProgressions": [
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignLeft"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": "."
            },
            "style": {
              "sequenceType": "numericSequence"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 1
        },
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignLeft"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": "."
            },
            "style": {
              "sequenceType": "lowercaseAlphabeticSequence"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 2
        },
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignRight"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": "."
            },
            "style": {
              "sequenceType": "lowercaseRomanSequence"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 3
        },
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignLeft"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": "."
            },
            "style": {
              "sequenceType": "numericSequence"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 4
        },
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignLeft"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": "."
            },
            "style": {
              "sequenceType": "lowercaseAlphabeticSequence"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 5
        },
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignRight"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": "."
            },
            "style": {
              "sequenceType": "lowercaseRomanSequence"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 6
        },
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignLeft"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": "."
            },
            "style": {
              "sequenceType": "numericSequence"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 7
        },
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignLeft"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": "."
            },
            "style": {
              "sequenceType": "lowercaseAlphabeticSequence"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 8
        },
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignRight"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": "."
            },
            "style": {
              "sequenceType": "lowercaseRomanSequence"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 9
        },
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignLeft"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": "."
            },
            "style": {
              "sequenceType": "numericSequence"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 10
        }
      ],
      "name": "Numbered",
      "notes": "",
      "type": "orderedListStyle"
    }
  ],
  "revision": "2c6438ab455b1513",
  "tableStyles": [
    {
      "formats": {
        "alignment": null,
        "characterSpacing": {
          "characterSpacing": 0,
          "locked": false
        },
        "emphasis": {
          "bold": false,
          "italic": false,
          "locked": false,
          "underline": false
        },
        "firstLineIndent": {
          "firstLineIndent": 0,
          "locked": false
        },
        "fontColor": {
          "fontColor": {
            "blue": 0,
            "green": 0,
            "red": 0
          },
          "locked": false
        },
        "fontFamily": {
          "fontFamily": "Arial",
          "locked": true
        },
        "fontSize": {
          "fontSize": 10,
          "locked": true
        },
        "lineSpacing": {
          "lineSpacing": 100,
          "locked": false,
          "unit": "percent"
        },
        "spaceAfterParagraph": {
          "locked": false,
          "spaceAfterParagraph": 0
        },
        "spaceBeforeParagraph": {
          "locked": false,
          "spaceBeforeParagraph": 0
        },
        "startIndent": {
          "locked": false,
          "startIndent": 0
        }
      },
      "id": "X3RibDplODEwMzI3YmQ0NmI0NDM4YjdmZWVkOWYxZTJkMDU1ZA",
      "index": 0,
      "isNormalStyle": true,
      "name": "Table (Normal)",
      "notes": ""
    }
  ],
  "textStyles": [
    {
      "formats": {
        "alignment": null,
        "characterSpacing": {
          "characterSpacing": 0,
          "locked": false
        },
        "emphasis": {
          "bold": false,
          "italic": false,
          "locked": false,
          "underline": false
        },
        "firstLineIndent": {
          "firstLineIndent": 0,
          "locked": false
        },
        "fontColor": {
          "fontColor": {
            "blue": 0,
            "green": 0,
            "red": 0
          },
          "locked": false
        },
        "fontFamily": {
          "fontFamily": "Arial",
          "locked": true
        },
        "fontSize": {
          "fontSize": 12,
          "locked": true
        },
        "lineSpacing": {
          "lineSpacing": 120,
          "locked": false,
          "unit": "percent"
        },
        "spaceAfterParagraph": {
          "locked": false,
          "spaceAfterParagraph": 0
        },
        "spaceBeforeParagraph": {
          "locked": false,
          "spaceBeforeParagraph": 0
        },
        "startIndent": {
          "locked": false,
          "startIndent": 0
        }
      },
      "id": "X3R4dDplODEwMzI3YmQ0NmI0NDM4YjdmZWVkOWYxZTJkMDU1ZA",
      "index": 0,
      "isNormalStyle": true,
      "name": "Normal",
      "notes": "",
      "type": "paragraphStyle"
    }
  ],
  "unorderedListStyles": [
    {
      "id": "YnVsbGV0LnJvdW5kOmU4MTAzMjdiZDQ2YjQ0MzhiN2ZlZWQ5ZjFlMmQwNTVk",
      "index": 0,
      "isNormalStyle": true,
      "listProgressions": [
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignLeft"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": ""
            },
            "style": {
              "sequenceType": "unorderedSequence",
              "unorderedGlyph": "•"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 1
        },
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignLeft"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": ""
            },
            "style": {
              "sequenceType": "unorderedSequence",
              "unorderedGlyph": "◦"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 2
        },
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignLeft"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": ""
            },
            "style": {
              "sequenceType": "unorderedSequence",
              "unorderedGlyph": "▪"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 3
        },
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignLeft"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": ""
            },
            "style": {
              "sequenceType": "unorderedSequence",
              "unorderedGlyph": "•"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 4
        },
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignLeft"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": ""
            },
            "style": {
              "sequenceType": "unorderedSequence",
              "unorderedGlyph": "◦"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 5
        },
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignLeft"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": ""
            },
            "style": {
              "sequenceType": "unorderedSequence",
              "unorderedGlyph": "▪"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 6
        },
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignLeft"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": ""
            },
            "style": {
              "sequenceType": "unorderedSequence",
              "unorderedGlyph": "•"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 7
        },
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignLeft"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": ""
            },
            "style": {
              "sequenceType": "unorderedSequence",
              "unorderedGlyph": "◦"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 8
        },
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignLeft"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": ""
            },
            "style": {
              "sequenceType": "unorderedSequence",
              "unorderedGlyph": "▪"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 9
        },
        {
          "formats": {
            "bold": null,
            "fontFamily": null,
            "glyphAlignment": {
              "alignment": "glyphAlignLeft"
            },
            "indentation": null,
            "italic": null,
            "listText": {
              "locked": false,
              "prefix": "",
              "suffix": ""
            },
            "style": {
              "sequenceType": "unorderedSequence",
              "unorderedGlyph": "•"
            },
            "symbolColor": null,
            "symbolSize": null,
            "underline": null
          },
          "listLevel": 10
        }
      ],
      "name": "Bullet",
      "notes": "",
      "type": "unorderedListStyle"
    }
  ]
}

StyleGuideExport

Details about the style guide export, including its options. The most recent version will be exported if revision is omitted from the export details.

Properties

Name	Type	Description	Restrictions
revision	string	The revision of the style guide to export

Example

{
  "revision": "1A2B3C4D"
}

StyleGuideImportResponse

Response to a style guide import including the URL to upload the file to.

Properties

Name	Type	Description	Restrictions
uploadUrl	string	The signed URL used to upload the style guide. Make a POST request to this URL whose body is the contents of the style guide to upload.	required

Example

{
  "uploadUrl": "<opaque_url>"
}

StyleNotes

Custom tooltip for a style.

Properties

Name	Type	Description	Restrictions
anonymous	string	Custom tooltip for a style.

Example

"My Style"

StyleRef

A reference to a style.

Properties

Name	Type	Description	Restrictions
location	string¦null	❗️ Deprecated: A URL that a GET request can be made against to retrieve the style’s style guide.	read-only
revision	string	The revision of the referenced style.	read-only
style	string	The unique identifier of a style.
styleGuide	string	The unique identifier of a style guide.	read-only

Example

{
  "location": "<opaque_url>",
  "revision": "2B3C4D5E",
  "style": "c3R5bGUta2V5Ol90Ymw",
  "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
}

StyleText

Applies a text/table style to a range of text. Table styles can only be applied to cells. Likewise, the “Normal” text style can only be applied to non-table text and the “Table (Normal)” style can only be applied to table text.

Properties

Name	Type	Description	Restrictions
selection	RichTextSelection	Describes a selection within piece of rich text	required
style	string	The unique identifier of a style.	required

Example

{
  "selection": {
    "start": {
      "offset": 0,
      "paragraphIndex": 0
    },
    "stop": {
      "offset": 10,
      "paragraphIndex": 2
    }
  },
  "style": "c3R5bGUta2V5Ol90Ymw"
}

TableAnchorCreation

Table anchor creation object

Properties

Name	Type	Description	Restrictions
range	CellRange	A range of cells in a table. If any field is omitted or null, the range is unbounded in that direction. All indexes are zero based.	required
revision	string	Revision string value	required

Example

{
  "range": {
    "startColumn": 0,
    "startRow": 5,
    "stopColumn": 3,
    "stopRow": 9
  },
  "revision": "24601abc"
}

TableAnchorCreationResult

A reference to a resource that was created by an operation.

Properties

Name	Type	Description	Restrictions
anchor	string¦null	The ID of the anchor that was created.
type	string	The type of resource created from an image upload.	required

Enumerated Values

Property	Value
type	anchor

Example

{
  "anchor": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
  "type": "anchor"
}

TableAnchorCreationResultCollection

A collection of created results from a table anchor creation. When there are no additional results before the current collection, the previous property will be null. When there are no additional results after the current collection, the next property will be null.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for next set of results
data	[TableAnchorCreationResult]	The current page of data.
revision	string	Identifies a unique revision of content.

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "anchor": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
      "type": "anchor"
    }
  ],
  "revision": "24601abc"
}

TableBreaking

The property that will dictate how the table will be broken up

Properties

Name	Type	Description	Restrictions
breakingPercentage	integer¦null	The percentage the table will break at, only set when type is breakWhenExceeds
type	TableBreakingType	The type of table breaking

Example

{
  "breakingPercentage": 0,
  "type": "neverBreak"
}

TableBreakingType

The type of table breaking

Properties

Name	Type	Description	Restrictions
anonymous	string	The type of table breaking

Enumerated Values

Property	Value
anonymous	neverBreak
anonymous	alwaysBreak
anonymous	breakWhenExceeds

Example

"neverBreak"

TableCell

Content containing a cell of a table.

Properties

Name	Type	Description	Restrictions
inputCell	boolean	Whether this cell is an input cell.
locked	boolean	Whether this cell is locked.
merges	TableCellMerges¦null	Describes whether the current cell is merged with other cells. If the cell is the top left cell in a merge the parentOf type will be set. If a cell is not the top left cell in a merge the childOf type will be set.
properties	TableCellProperties¦null	The properties for a table cell. Null values indicate that the property is inheriting from style or the container when reading. Null values will not be modified when writing.
rawValue	string	The raw value or formula of the cell with no value formatting applied. This matches the formula bar value in the app.
value	CellValue	The content of a cell.

Example

{
  "inputCell": true,
  "locked": true,
  "merges": {
    "childOf": {
      "column": 3,
      "row": 5
    },
    "type": "childOf"
  },
  "properties": {
    "borders": {
      "bottom": {
        "color": {
          "blue": 255,
          "green": 136,
          "red": 155
        },
        "style": "single",
        "weight": 1
      },
      "left": {
        "color": {
          "blue": 255,
          "green": 136,
          "red": 155
        },
        "style": "single",
        "weight": 1
      },
      "right": {
        "color": {
          "blue": 255,
          "green": 136,
          "red": 155
        },
        "style": "single",
        "weight": 1
      },
      "top": {
        "color": {
          "blue": 255,
          "green": 136,
          "red": 155
        },
        "style": "single",
        "weight": 1
      }
    },
    "fillColor": {
      "blue": 255,
      "green": 136,
      "red": 155
    },
    "horizontalAlignment": "left",
    "indent": 10,
    "verticalAlignment": "middle"
  },
  "rawValue": "Hello World",
  "value": {
    "plainText": {
      "effectiveValue": "25",
      "format": {
        "bold": true,
        "font": "Arial",
        "size": 24
      },
      "style": {}
    },
    "type": "plainText"
  }
}

TableCellEditListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

TableCellMerges

Describes whether the current cell is merged with other cells. If the cell is the top left cell in a merge the parentOf type will be set. If a cell is not the top left cell in a merge the childOf type will be set.

Properties

Name	Type	Description	Restrictions
childOf	Cell¦null	The parent cell containing the content associated with this cell’s merge.
parentOf	CellRange¦null	The range of cells included in this cell’s merge.
type	string	The raw value or formula of the cell with no value formatting applied. This matches the formula bar value in the app.	required

Enumerated Values

Property	Value
type	parentOf
type	childOf

Example

{
  "childOf": {
    "column": 3,
    "row": 5
  },
  "type": "childOf"
}

TableCellProperties

The properties for a table cell. Null values indicate that the property is inheriting from style or the container when reading. Null values will not be modified when writing.

Properties

Name	Type	Description	Restrictions
borders	CellBorders¦null	The borders of the table cell.
fillColor	Color¦null	Represents a color.
horizontalAlignment	CellHorizontalAlignment	The horizontal alignment of the content in the cell.
indent	number¦null	The indentation of content in the cell.
verticalAlignment	string¦null	The vertical alignment of the content in the cell.

Enumerated Values

Property	Value
verticalAlignment	top
verticalAlignment	middle
verticalAlignment	bottom

Example

{
  "borders": {
    "bottom": {
      "color": {
        "blue": 255,
        "green": 136,
        "red": 155
      },
      "style": "single",
      "weight": 1
    },
    "left": {
      "color": {
        "blue": 255,
        "green": 136,
        "red": 155
      },
      "style": "single",
      "weight": 1
    },
    "right": {
      "color": {
        "blue": 255,
        "green": 136,
        "red": 155
      },
      "style": "single",
      "weight": 1
    },
    "top": {
      "color": {
        "blue": 255,
        "green": 136,
        "red": 155
      },
      "style": "single",
      "weight": 1
    }
  },
  "fillColor": {
    "blue": 255,
    "green": 136,
    "red": 155
  },
  "horizontalAlignment": "left",
  "indent": 10,
  "verticalAlignment": "middle"
}

TableCellsBatchEdit

A collection of edits to apply to table cells.

Properties

Name	Type	Description	Restrictions
data	[TableCellsEdit]	The edits to apply to table cells.	required, Minimum items: 1, Maximum items: 100
lockedCellEditMode	LockedCellEditMode	Whether or not an edit applied to locked cells is prevented. Validation will prevent an edit with a locked cell when set to strict. When set to trim the edit will succeed with the locked cells trimmed out.
revision	string¦null	Identifies the version of the table to apply the edits to. Defaults to the latest revision if not specified.

Example

{
  "data": [
    {
      "clearCellsFormat": {
        "clearAll": false,
        "clearBackgroundColor": true,
        "clearBold": false,
        "clearCharacterSpacing": true,
        "clearFont": false,
        "clearItalic": true,
        "clearSize": true,
        "clearStrikeThrough": true,
        "clearTextColor": true,
        "clearUnderline": true,
        "ranges": [
          {
            "startColumn": 0,
            "startRow": 0,
            "stopColumn": 2,
            "stopRow": 2
          }
        ]
      },
      "type": "clearCellsFormat"
    }
  ],
  "lockedCellEditMode": "strict",
  "revision": "24601abc"
}

TableCellsEdit

An edit for modifying a table cells. The edit property associated with the edit type is required. Any edit property that doesn’t correspond to its type will be ignored.

Properties

Name	Type	Description	Restrictions
clearCellsBorders	ClearCellsBorders¦null	Clears the cell borders from all the cells in the given ranges of a table.
clearCellsFormat	ClearCellsFormat¦null	Clears the text formatting from all the cells in the given ranges of a table. This will not clear out styles nor hyperlinks.
clearCellsProperties	ClearCellsProperties¦null	Clears the cell properties from all the cells in the given ranges of a table. This will not clear out styles, formats, or hyperlinks.
clearCellsText	ClearCellsText¦null	Deletes the text from all the cells in the ranges of a table. This will not remove the text formatting applied to the cells. The cells locations will remain, although empty, even if a complete row or column is specified by the range.
formatCells	FormatCells¦null	Applies formatting to cells in the given ranges of a table. Null properties are ignored.
richCellBatchEdit	RichCellBatchEdit¦null	Collection of edits to perform on the rich text of a cell in the table.
setCellsBorders	SetCellsBorders¦null	Applies borders to cells in the given ranges of a table.
setCellsLock	SetCellsLock¦null	Locks or unlocks cells in the given ranges of a table. The operation will no-op if the cell is already in the state associated with the lock.
setCellsProperties	SetCellsProperties¦null	Applies properties to cells in the given ranges of a table.
setCellsStyle	SetCellsStyle¦null	Applies a style to cells in the given ranges of a table. The “Normal” text style is not supported in table cells. Use the “Table (Normal)” style to apply normal styles to text in a table cell.
setCellsText	SetCellsText¦null	Writes text to a range of a table. This will overwrite any existing text with the given text. Cell properties and some formatting will be preserved. Some formatting on text will be removed by the overwrite. The provided text may not be larger than the specified range. Any null or missing elements in the text will not modify the corresponding cell.
setInputCells	SetInputCells¦null	Sets the input cells for a range of cells in a table. Setting input cells requires the input mode ability. The operation will no-op if the cell is already in the state associated with the input cell.
type	string	The type of cells edit	required

Enumerated Values

Property	Value
type	clearCellsBorders
type	clearCellsFormat
type	clearCellsProperties
type	clearCellsText
type	formatCells
type	richCellBatchEdit
type	setCellsBorders
type	setCellsLock
type	setCellsProperties
type	setCellsStyle
type	setCellsText
type	setInputCells

Example

{
  "clearCellsFormat": {
    "clearAll": false,
    "clearBackgroundColor": true,
    "clearBold": false,
    "clearCharacterSpacing": true,
    "clearFont": false,
    "clearItalic": true,
    "clearSize": true,
    "clearStrikeThrough": true,
    "clearTextColor": true,
    "clearUnderline": true,
    "ranges": [
      {
        "startColumn": 0,
        "startRow": 0,
        "stopColumn": 2,
        "stopRow": 2
      }
    ]
  },
  "type": "clearCellsFormat"
}

TableCellsResult

This represents a page of table cell results. Table content is paginated into smaller rectangles (pages) based on the limit in the given page range. The limit represents the total number of cells in a page such that each page page.rows * page.columns <= maxcellsperpage. The page will try to fill a whole row or column based off the offset and limit, filling either vertically from top to bottom or horizontally left to right. If the limit is less than the number of cells in a row or column, the page at the end of a row or column may be less than the limit to prevent a page from spanning across rows or columns.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for the next page of results.
data	[TableRow]	Cells for the current page of results.
range	CellRange	A range of cells in a table. If any field is omitted or null, the range is unbounded in that direction. All indexes are zero based.
revision	string	The revision of the table.	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "cells": [
        {
          "properties": {
            "borders": {
              "bottom": {
                "color": {
                  "blue": 128,
                  "green": 128,
                  "red": 128
                },
                "style": "single",
                "weight": 1
              },
              "left": {
                "color": {
                  "blue": 128,
                  "green": 128,
                  "red": 128
                },
                "style": "single",
                "weight": 1
              },
              "right": {
                "color": {
                  "blue": 128,
                  "green": 128,
                  "red": 128
                },
                "style": "single",
                "weight": 1
              },
              "top": {
                "color": {
                  "blue": 128,
                  "green": 128,
                  "red": 128
                },
                "style": "single",
                "weight": 1
              }
            },
            "fillColor": {
              "blue": 128,
              "green": 128,
              "red": 128
            },
            "horizontalAlignment": "left",
            "indent": 10,
            "verticalAlignment": "middle"
          },
          "rawValue": "Hello World",
          "value": {
            "destinationLink": {
              "destinationLink": {
                "destinationLink": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
                "revision": "24601abc"
              },
              "paragraphs": [
                {
                  "elements": [
                    {
                      "textSpan": {
                        "format": {
                          "font": "Times New Roman",
                          "italic": true,
                          "size": 12
                        },
                        "length": 11,
                        "offset": 0,
                        "style": {
                          "revision": "1A2B3C4D",
                          "style": "WW91IGZvdW5kIG1lIQ",
                          "styleGuide": "WW91IGZvdW5kIG1lIQ"
                        },
                        "text": "Hello World"
                      },
                      "type": "textSpan"
                    }
                  ],
                  "format": {
                    "bold": true
                  },
                  "list": {
                    "level": 2,
                    "prefix": "[",
                    "startAt": 1,
                    "style": {
                      "style": "WW91IGZvdW5kIG1lIQ",
                      "styleGuide": "WW91IGZvdW5kIG1lIQ"
                    },
                    "suffix": "]"
                  },
                  "properties": {},
                  "style": {
                    "style": "X3R4dDozZDUyMDg4ODBlNDk0YmYxYWVjYTIzM2VlYmY3ODM4Mg",
                    "styleGuide": "3d5208880e494bf1aeca233eebf78382"
                  }
                }
              ]
            },
            "type": "destinationLink"
          }
        }
      ]
    }
  ],
  "range": {
    "startColumn": 0,
    "startRow": 0,
    "stopColumn": 0,
    "stopRow": 0
  },
  "revision": "24601abc"
}

TableColumnProperties

Table column properties

Properties

Name	Type	Description	Restrictions
hidden	boolean	Whether the column is hidden
width	integer	The width of a column in points

Example

{
  "hidden": false,
  "width": 60
}

TableDrawingElement

A drawing element for a table.

Properties

Name	Type	Description	Restrictions
dimensions	Dimensions	A dimension of a rectangle for properties of objects such as a shape, text box, table, chart, image, or page.
fill	Fill	A shape or box fill settings for things like shapes. Use a null to indicate no fill.
id	DrawingElementId	Identifier of the drawing element
margins	Margins	The margins of a rectangle for properties of objects such as a shape, text box, or page.
position	DrawingRelativePosition	The relative position of a drawing element.
stroke	Stroke	Line stroke setting for things like shape edges. Use a null to indicate no stroke line.
table	TableRef	A reference to table content in a document, spreadsheet, or presentation
wrapStyle	WrapStyleType	The relative position type

Example

{
  "dimensions": {
    "height": 240,
    "width": 320
  },
  "fill": {
    "color": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "opacity": 0.5
  },
  "id": "WW91IGZvdW5kIG1lIQ",
  "margins": {
    "bottom": 10,
    "left": 10,
    "right": 10,
    "top": 10
  },
  "position": {
    "paragraphRelative": {
      "paragraphIndex": 3,
      "x": 0,
      "y": 0
    },
    "type": "paragraphRelative"
  },
  "stroke": {
    "color": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "pattern": "solid",
    "width": 2
  },
  "table": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "table": "WA7i5vbm7lNaEn6XT97lNaEn6XT9AtcW5vb22BJjMrqxmrujMrqxmru"
  },
  "wrapStyle": "inFrontOfText"
}

TableEdit

A table edit for modifying a table. The edit property associated with the edit type is required. Any edit property that doesn’t correspond to its type will be ignored.

Properties

Name	Type	Description	Restrictions
deleteColumns	DeleteColumns¦null	Delete one or more columns from the table
deleteRows	DeleteRows¦null	Delete one or more rows from the table
insertColumns	InsertColumns¦null	Insert one or more columns into the table next to the given column on specified side
insertRows	InsertRows¦null	Insert one or more rows into the table next to the given row on specified side
moveColumns	MoveColumns¦null	Moves one or more columns from one location in the table to next to the given column on the specified side of that column. The column to move the other columns next to may not be within the set of columns to move.
moveRows	MoveRows¦null	Move one or more row from one location in the table to next to the given row on the specified side
type	string	The type of edit operation to perform on the table	required

Enumerated Values

Property	Value
type	deleteColumns
type	deleteRows
type	moveColumns
type	moveRows
type	insertColumns
type	insertRows

Example

{
  "deleteColumns": {
    "columns": {
      "startColumn": 0,
      "stopColumn": 5
    }
  },
  "type": "deleteColumns"
}

TableEditListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

TableFiltersReapplication

A table filter reapply operation, which can reapply filters to a table and optionally force hide footnotes.

Properties

Name	Type	Description	Restrictions
forceHideFootnotes	boolean	Whether the filter should be reapplied if doing so would cause footnotes to be hidden.

Example

{
  "forceHideFootnotes": true
}

TableId

The unique identifier of a table

Properties

Name	Type	Description	Restrictions
anonymous	string	The unique identifier of a table	Minimum length: 1

Example

"WA7i5vbm7lNaEn6XT97lNaEn6XT9AtcW5vb22BJjMrqxmrujMrqxmru"

TableLinksBatchEdit

A collection of link edits to perform on table content.

Properties

Name	Type	Description	Restrictions
data	[TableLinksEdit]	The edits to apply to the table.	required, Minimum items: 1, Maximum items: 100
lockedCellEditMode	LockedCellEditMode	Whether or not an edit applied to locked cells is prevented. Validation will prevent an edit with a locked cell when set to strict. When set to trim the edit will succeed with the locked cells trimmed out.
revision	string¦null	Identifies the version of the table to apply the edits to. Defaults to the latest revision if not specified.

Example

{
  "data": [
    {
      "insertCellDestinationLink": {
        "insertAt": {
          "column": 2,
          "row": 41
        },
        "sourceAnchor": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru"
      },
      "type": "insertCellDestinationLink"
    }
  ],
  "lockedCellEditMode": "strict",
  "revision": "24601abc"
}

TableLinksEdit

An edit for modifying a link in a table. The edit property associated with the edit type is required. Any edit property that doesn’t correspond to its type will be ignored.

Properties

Name	Type	Description	Restrictions
insertCellDestinationLink	InsertCellDestinationLink¦null	Inserts a destination link at the provided cell. Creates a source link at the source anchor if one doesn’t already exist. The destination link will reference the latest published revision of the source link.
removeCellsLink	RemoveCellsLink¦null	Removes source and destination links in a table range. This operation will be a no-op if no cell links exist within the table range.
richCellLinkBatchEdit	RichCellLinkBatchEdit¦null	A collection of edits to perform on the rich text links of a cell in table content.
type	string	The type of the table links edit	required

Enumerated Values

Property	Value
type	insertCellDestinationLink
type	removeCellsLink
type	richCellLinkBatchEdit

Example

{
  "insertCellDestinationLink": {
    "insertAt": {
      "column": 2,
      "row": 41
    },
    "sourceAnchor": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru"
  },
  "type": "insertCellDestinationLink"
}

TableLinksEditResult

A reference to a resource that was created by an operation.

Properties

Name	Type	Description	Restrictions
destinationLink	string¦null	The unique identifier of a destination link created by the table links edit.
type	string	The type of resource created from a table link edit.	required

Enumerated Values

Property	Value
type	destinationLink

Example

{
  "destinationLink": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru",
  "type": "destinationLink"
}

TableLockType

A lock applied to a table.

Properties

Name	Type	Description	Restrictions
TableLockType	string	A lock applied to a table.

Enumerated Values

Property	Value
TableLockType	formatting

Example

"formatting"

TableProperties

The properties for a table.

Properties

Name	Type	Description	Restrictions
id	string	The unique identifier for the table.	required
lock	TableLockType¦null	The type of lock applied to this table, if any. Note this property is not tied to revision and will always reflect the table’s current lock state.	required
name	string	The name of the table. This will match the name of the sheet if this table is in a spreadsheet.	required
resizeRowsToFit	boolean¦null	Whether the rows of the table will resize automatically to fit the content of the cells.	required
revision	Revision	Identifies a unique revision of content. The same revision can be used for any content request within a file because revisions are allocated at the file-level. When querying for content, this can be used to get a consistent version of the content. When editing content, this can be used to make the change to the content at a known state. In either case, omitting the revision (when allowed) will always default to the latest revision of the file.	required
sheet	string	The unique identifier of the sheet.	required

Example

{
  "id": "string",
  "lock": "formatting",
  "name": "string",
  "resizeRowsToFit": false,
  "revision": "2c6438ab4541de6d",
  "sheet": "string"
}

TableRangeAnchorAttachmentPoint

A table range anchor attachment point.

Properties

Name	Type	Description	Restrictions
range	CellRange	A range of cells in a table. If any field is omitted or null, the range is unbounded in that direction. All indexes are zero based.

Example

{
  "range": {
    "startColumn": 0,
    "startRow": 5,
    "stopColumn": 3,
    "stopRow": 9
  }
}

TableReapplyFilterListResult

Returns a result with the new revision. Currently the result will only return a revision, but can return a data property that includes created resources in the future.

Properties

Name	Type	Description	Restrictions
revision	string	Identifies a unique revision of content.

Example

{
  "revision": "24601abc"
}

TableRow

A row of cell data in a cell.

Properties

Name	Type	Description	Restrictions
cells	[TableCell]	Content containing a cell of a table.

Example

{
  "cells": [
    {
      "merges": {
        "childOf": {
          "column": 3,
          "row": 5
        },
        "type": "childOf"
      },
      "properties": {
        "borders": {
          "bottom": {
            "color": {
              "blue": 255,
              "green": 136,
              "red": 155
            },
            "style": "single",
            "weight": 1
          },
          "left": {
            "color": {
              "blue": 255,
              "green": 136,
              "red": 155
            },
            "style": "single",
            "weight": 1
          },
          "right": {
            "color": {
              "blue": 255,
              "green": 136,
              "red": 155
            },
            "style": "single",
            "weight": 1
          },
          "top": {
            "color": {
              "blue": 255,
              "green": 136,
              "red": 155
            },
            "style": "single",
            "weight": 1
          }
        },
        "fillColor": {
          "blue": 255,
          "green": 136,
          "red": 155
        },
        "horizontalAlignment": "left",
        "indent": 10,
        "verticalAlignment": "middle"
      },
      "rawValue": "Hello World",
      "value": {
        "formula": {
          "calculatedValue": "25",
          "effectiveValue": "25",
          "format": {
            "bold": true,
            "font": "Arial",
            "size": 24
          },
          "style": {
            "style": "X3R4dDozZDUyMDg4ODBlNDk0YmYxYWVjYTIzM2VlYmY3ODM4Mg",
            "styleGuide": "3d5208880e494bf1aeca233eebf78382"
          }
        },
        "type": "formula"
      }
    }
  ]
}

TableRowProperties

Table row properties

Properties

Name	Type	Description	Restrictions
filtered	boolean	Whether the row is filtered
height	integer	The height of a row in points
hidden	boolean	Whether the row is hidden

Example

{
  "filtered": false,
  "height": 60,
  "hidden": false
}

TableStyle

A style which describes a set of formats for content in table cells.

Properties

Name	Type	Description	Restrictions
formats	TextStyleFormats	The formats applied by a text style.
id	string	The unique identifier of a style.
index	integer	The index of this style in its group.
isNormalStyle	boolean	Whether this style is a “normal” style. Normals styles cannot be deleted or renamed.
name	string	The name of the table style.	Minimum length: 1
notes	StyleNotes	Custom tooltip for a style.

Example

{
  "formats": {
    "alignment": {
      "alignment": "justified",
      "locked": false
    },
    "characterSpacing": {
      "characterSpacing": -25,
      "locked": false
    },
    "emphasis": {
      "bold": false,
      "italic": false,
      "locked": false,
      "underline": false
    },
    "firstLineIndent": {
      "firstLineIndent": 54,
      "locked": false
    },
    "fontColor": {
      "fontColor": {
        "blue": 128,
        "green": 128,
        "red": 128
      },
      "locked": false
    },
    "fontFamily": {
      "fontFamily": "Times New Roman",
      "locked": false
    },
    "fontSize": {
      "fontSize": 14,
      "locked": false
    },
    "lineSpacing": {
      "lineSpacing": 120,
      "locked": false,
      "unit": "percent"
    },
    "spaceAfterParagraph": {
      "locked": false,
      "spaceAfterParagraph": 10.5
    },
    "spaceBeforeParagraph": {
      "locked": false,
      "spaceBeforeParagraph": 12.5
    },
    "startIndent": {
      "locked": false,
      "startIndent": 27
    }
  },
  "id": "c3R5bGUta2V5Ol90Ymw",
  "index": 1,
  "isNormalStyle": false,
  "name": "Table Style",
  "notes": "My Style"
}

TableTextElement

A text element representing a table.

Properties

Name	Type	Description	Restrictions
format	RichTextFormat	The formatting options applied to rich text elements.
length	integer	The number of characters (32-bit unicode code point) for a text element or range of text in a selection. Most elements will have a length of 1, even if it is dynamic content which will be replaced by possibly multiple characters. The lengths are used when editing with offsets from an element. The sum of the lengths up to a specific element from another is the offset between those text elements.	Minimum: 1
offset	integer	The number of items to skip over in a collection before the items which will be returned or worked on. The items may be shapes, sections, elements, characters, slides, etc depending on which object or path the offset is being used on.	Minimum: 0
properties	TableTextElementProperties	The properties for a table text element.
style	StyleRef	A reference to a style.
table	TableRef	A reference to table content in a document, spreadsheet, or presentation

Example

{
  "format": {
    "backgroundColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "baselineShift": "superscript",
    "bold": true,
    "characterSpacing": -25,
    "font": "Times New Roman",
    "italic": true,
    "size": 14,
    "strikethrough": true,
    "textColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "underline": true
  },
  "length": 1,
  "offset": 10,
  "properties": {
    "headerRows": 1,
    "tableBreaking": {
      "breakingPercentage": 25,
      "type": "breakWhenExceeds"
    },
    "titleRow": true,
    "titleSuffix": "Title"
  },
  "style": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "style": "c3R5bGUta2V5Ol90Ymw",
    "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
  },
  "table": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "table": "WA7i5vbm7lNaEn6XT97lNaEn6XT9AtcW5vb22BJjMrqxmrujMrqxmru"
  }
}

TableTextElementProperties

The properties for a table text element.

Properties

Name	Type	Description	Restrictions
headerRows	integer	The rows that are going to be headers	required
tableBreaking	TableBreaking	The property that will dictate how the table will be broken up	required
titleRow	boolean	Whether the table has a title row	required
titleSuffix	string¦null	Optional table title suffix when title row is enabled.

Example

{
  "headerRows": 1,
  "tableBreaking": {
    "breakingPercentage": 25,
    "type": "breakWhenExceeds"
  },
  "titleRow": true,
  "titleSuffix": "Title"
}

TextAlignment

Indicates the horizontal alignment of the text within a paragraph.

Properties

Name	Type	Description	Restrictions
anonymous	string¦null	Indicates the horizontal alignment of the text within a paragraph.

Enumerated Values

Property	Value
anonymous	left
anonymous	center
anonymous	right
anonymous	justified

Example

"justified"

TextEdit

An edit for modifying rich text. The type of the edit is required. Any edit property that doesn’t correspond to its specified type will be ignored.

Properties

Name	Type	Description	Restrictions
clearListFormat	ClearListFormat¦null	An edit to clear list formatting from a range of paragraphs in rich text. Not supported when the parent batch has isolated edits turned on.
clearParagraphProperties	ClearParagraphProperties¦null	An edit to clear paragraph properties from a range of paragraphs in rich text.
clearTextFormat	ClearTextFormat¦null	An edit to clear formatting from a range of rich text. This will not clear out styles nor hyperlinks.
deleteText	DeleteText¦null	An edit to delete text from a range of rich text. Note that all content, such as tables, images, charts, or footnotes, will also be deleted. Links must be removed from the selection using a RemoveLinks links edit before deleting a selection containing links.
formatText	FormatText¦null	An edit to format a range of rich text.
insertFootnote	InsertFootnote¦null	A text edit for inserting a footnote into rich text. The created rich text id associated with the footnote annotation area can be retrieved from the rich text edit operation results. This edit is not supported in table rich cell edits.
insertImage	InsertImage¦null	A text edit for inserting an image into rich text.
insertPageNumber	InsertPageNumber¦null	A text edit for inserting a page number into header or footer text.
insertParagraph	InsertParagraph¦null	A text edit for inserting a new paragraph.
insertSoftReturn	InsertSoftReturn¦null	A text edit for inserting a soft return into text. This moves the following text elements to a new line without creating a new paragraph.
insertTable	RichTextInsertTable¦null	A text edit for inserting an embedded table into rich text. If a dimensions property is set it will be respected unless it forces a cell to shrink beyond a minimum width. The created table id associated with the embedded table can be retrieved from the rich text edit operation results. This edit is not supported in table rich cell edits.
insertText	InsertText¦null	A text edit for inserting new rich text.
removeHyperlinks	RemoveHyperlinks¦null	Removes hyperlinks from a range of text. If a selection starts or stops in the middle of an existing hyperlink the selection will be expanded to include the start and stop of the existing hyperlink.
setHyperlink	SetHyperlink¦null	Applies a hyperlink to a range of text. Any existing hyperlinks in a selection will be overwritten to point to the new hyperlink associated with this edit. If a selection starts or stops in the middle of an existing hyperlink the selection will be expanded to include the start and stop of the existing hyperlink.
setListFormat	SetListFormat¦null	An edit to set list formats on a range of paragraphs in rich text. Not supported when the parent batch has isolated edits turned on.
setParagraphProperties	SetParagraphProperties¦null	An edit to set properties on a range of paragraphs in rich text. Null properties are ignored.
setParagraphStyle	SetParagraphStyle¦null	Applies a text or table style to a range of paragraphs. The “Table (Normal)” style can only be applied to text in table cells. Likewise, the “Normal” style can only be applied to non-table text.
setTableProperties	SetTableTextElementProperties¦null	An edit for configuring table behavior when the table spans multiple pages. If a property is null in the request, then it will be ignored.
styleText	StyleText¦null	Applies a text/table style to a range of text. Table styles can only be applied to cells. Likewise, the “Normal” text style can only be applied to non-table text and the “Table (Normal)” style can only be applied to table text.
type	string	The type of rich text edit.	required

Enumerated Values

Property	Value
type	clearListFormat
type	clearParagraphProperties
type	clearTextFormat
type	deleteText
type	formatText
type	insertFootnote
type	insertImage
type	insertPageNumber
type	insertParagraph
type	insertSoftReturn
type	insertTable
type	insertText
type	removeHyperlinks
type	setHyperlink
type	setListFormat
type	setParagraphProperties
type	setParagraphStyle
type	setTableProperties
type	styleText

Example

{
  "insertText": {
    "format": {
      "bold": true,
      "font": "Times New Roman"
    },
    "inheritFormats": true,
    "insertAt": {
      "offset": 5,
      "paragraphIndex": 0
    },
    "text": "Hello, world!"
  },
  "type": "insertText"
}

TextElement

A text element containing rich text content.

Properties

Name	Type	Description	Restrictions
chart	ChartTextElement	An embedded content text element for a chart.
destinationLink	DestinationLinkTextElement	A destination link is an element which is replaced with content from a source link.
footnoteAnnotation	FootnoteAnnotation	A dynamic content text element which will be replaced with a footnote number for the footnote content which this element is within. This may only be added to footnotes.
footnoteIndicator	FootnoteIndicator	A dynamic content text element which will be replaced with a footnote number within rich text content to indicate that there is a footnote and works as an anchor to help determine which page of the document the footnote will be added to.
hyperlink	HyperlinkTextElement	A text element for a hyperlink.
image	ImageTextElement	A text element for image embedded content.
pageNumber	PageNumber	A dynamic content text element which will be replaced with the current page number.
sectionPageNumber	SectionPageNumber	A dynamic content text element which will be replaced with the page number of a specified section.
table	TableTextElement	A text element representing a table.
textSpan	TextSpan	A text element for a span of text with the same formatting. The text string may contain almost any unicode character except for unicode from the Private Use Area (PUA) of unicode (U+E000..U+F8FF), paragraph separators (U+2029), line feeds (U+000A), and carriage returns (U+000D). Paragraph separators and line feeds will be turned into paragraphs. Carriage returns will be normalized out of the text during insertion. Other control unicode, like line separators (U+2028), no break space (U+00A0), and tabs (U+0009), may appear in this text. The text will be quote escaped and may contain unicode escaped characters like \t or \u0000.
type	string	The type of the text element in rich text	required
unspecified	UnspecifiedTextElement	An unspecified text element to use as a placeholder for elements that have not been explicitly defined in API models.

Enumerated Values

Property	Value
type	chart
type	destinationLink
type	footnoteAnnotation
type	footnoteIndicator
type	hyperlink
type	image
type	pageNumber
type	sectionPageNumber
type	table
type	textSpan
type	softReturn
type	unspecified

Example

{
  "chart": {
    "dimensions": {
      "height": 240,
      "width": 240
    },
    "length": 10,
    "offset": 10,
    "style": {
      "location": "<opaque_url>",
      "revision": "2B3C4D5E",
      "style": "c3R5bGUta2V5Ol90Ymw",
      "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
    },
    "table": {
      "revision": "24601abc",
      "table": "WA66srK9AtGU3PvTjs4dMCR9B34EoH6LqyloPIRNdxS5Bgs3p199MQzPsA"
    }
  },
  "type": "chart"
}

TextLinkEdit

An edit for modifying a link in rich text. The type of the edit is required. Any edit property that doesn’t correspond to its specified type will be ignored.

Properties

Name	Type	Description	Restrictions
insertDestinationLink	InsertDestinationLink¦null	A text edit for inserting a destination link in rich text. The destination link will reference the latest published revision of the source link.
removeLinks	RemoveLinks¦null	A text edit for removing source and destination links in rich text. This operation will be a no-op if no links exist within the range of text.
type	string	The type of the link edit of rich text.	required

Enumerated Values

Property	Value
type	insertDestinationLink
type	removeLinks

Example

{
  "insertDestinationLink": {
    "insertAt": {
      "offset": 10,
      "paragraphIndex": 4
    },
    "sourceAnchor": "WA7i5vbm7lNaEn6XT9AtcW5vb22BJjMrqxmru"
  },
  "type": "insertDestinationLink"
}

TextSpan

A text element for a span of text with the same formatting. The text string may contain almost any unicode character except for unicode from the Private Use Area (PUA) of unicode (U+E000..U+F8FF), paragraph separators (U+2029), line feeds (U+000A), and carriage returns (U+000D). Paragraph separators and line feeds will be turned into paragraphs. Carriage returns will be normalized out of the text during insertion. Other control unicode, like line separators (U+2028), no break space (U+00A0), and tabs (U+0009), may appear in this text. The text will be quote escaped and may contain unicode escaped characters like \t or \u0000.

Properties

Name	Type	Description	Restrictions
format	RichTextFormat	The formatting options applied to rich text elements.
length	integer	The number of characters (32-bit unicode code point) for a text element or range of text in a selection. Most elements will have a length of 1, even if it is dynamic content which will be replaced by possibly multiple characters. The lengths are used when editing with offsets from an element. The sum of the lengths up to a specific element from another is the offset between those text elements.	Minimum: 1
offset	integer	The number of items to skip over in a collection before the items which will be returned or worked on. The items may be shapes, sections, elements, characters, slides, etc depending on which object or path the offset is being used on.	Minimum: 0
style	StyleRef	A reference to a style.
text	string	The string of characters (32-bit unicode code point)

Example

{
  "format": {
    "backgroundColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "baselineShift": "superscript",
    "bold": true,
    "characterSpacing": -25,
    "font": "Times New Roman",
    "italic": true,
    "size": 14,
    "strikethrough": true,
    "textColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "underline": true
  },
  "length": 1,
  "offset": 10,
  "style": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "style": "c3R5bGUta2V5Ol90Ymw",
    "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
  },
  "text": "Thank you"
}

TextStyle

A style which describes a set of formats for text elements.

Properties

Name	Type	Description	Restrictions
formats	TextStyleFormats	The formats applied by a text style.
id	string	The unique identifier of a style.
index	integer	The index of this style in its group.
isNormalStyle	boolean	Whether this style is a “normal” style. Normals styles cannot be deleted or renamed.
name	string	The name of the text style.	Minimum length: 1
notes	StyleNotes	Custom tooltip for a style.
type	TextStyleType	The type of the text style.

Example

{
  "formats": {
    "alignment": {
      "alignment": "justified",
      "locked": false
    },
    "characterSpacing": {
      "characterSpacing": -25,
      "locked": false
    },
    "emphasis": {
      "bold": false,
      "italic": false,
      "locked": false,
      "underline": false
    },
    "firstLineIndent": {
      "firstLineIndent": 54,
      "locked": false
    },
    "fontColor": {
      "fontColor": {
        "blue": 128,
        "green": 128,
        "red": 128
      },
      "locked": false
    },
    "fontFamily": {
      "fontFamily": "Times New Roman",
      "locked": false
    },
    "fontSize": {
      "fontSize": 14,
      "locked": false
    },
    "lineSpacing": {
      "lineSpacing": 120,
      "locked": false,
      "unit": "percent"
    },
    "spaceAfterParagraph": {
      "locked": false,
      "spaceAfterParagraph": 10.5
    },
    "spaceBeforeParagraph": {
      "locked": false,
      "spaceBeforeParagraph": 12.5
    },
    "startIndent": {
      "locked": false,
      "startIndent": 27
    }
  },
  "id": "c3R5bGUta2V5Ol90Ymw",
  "index": 1,
  "isNormalStyle": false,
  "name": "My Custom Style",
  "notes": "My Style",
  "type": "paragraphStyle"
}

TextStyleAlignment

The alignment applied by the text style.

Properties

Name	Type	Description	Restrictions
alignment	TextAlignment	Indicates the horizontal alignment of the text within a paragraph.
locked	boolean	Whether the alignment is locked.

Example

{
  "alignment": "justified",
  "locked": false
}

TextStyleCharacterSpacing

The character spacing applied by the text style. Setting this format requires the Edit Character Spacing ability.

Properties

Name	Type	Description	Restrictions
characterSpacing	number	The space between characters, in 1/1000 of an em.
locked	boolean	Whether the space between characters is locked.

Example

{
  "characterSpacing": -25,
  "locked": false
}

TextStyleEmphasis

The emphasis formats applied by the text style. This consists of the bold, italic, and underline formats.

Properties

Name	Type	Description	Restrictions
bold	boolean	Whether or not the text is bold
italic	boolean	Whether or not the text is italicized
locked	boolean	Whether the emphasis group is locked.
underline	boolean	Whether or not the text is underlined

Example

{
  "bold": false,
  "italic": false,
  "locked": false,
  "underline": false
}

TextStyleFirstLineIndent

The first line indent applied by the text style.

Properties

Name	Type	Description	Restrictions
firstLineIndent	number	The amount of indent, in points, from the margin to apply to the first line of a paragraph in addition to the start indent. Positive is towards the center of the page.
locked	boolean	Whether the first line indent is locked.

Example

{
  "firstLineIndent": 54,
  "locked": false
}

TextStyleFontColor

The font color applied by the text style.

Properties

Name	Type	Description	Restrictions
fontColor	Color¦null	The font color in RGB format
locked	boolean	Whether the font color is locked.

Example

{
  "fontColor": {
    "blue": 128,
    "green": 128,
    "red": 128
  },
  "locked": false
}

TextStyleFontFamily

The font applied by the text style.

Properties

Name	Type	Description	Restrictions
fontFamily	string	The name of the font.
locked	boolean	Whether the font is locked.

Example

{
  "fontFamily": "Times New Roman",
  "locked": false
}

TextStyleFontSize

The font size applied by the text style.

Properties

Name	Type	Description	Restrictions
fontSize	number	The font size of the characters in points.
locked	boolean	Whether the font size is locked.

Example

{
  "fontSize": 14,
  "locked": false
}

TextStyleFormats

The formats applied by a text style.

Properties

Name	Type	Description	Restrictions
alignment	TextStyleAlignment	The alignment applied by the text style.
characterSpacing	TextStyleCharacterSpacing	The character spacing applied by the text style. Setting this format requires the Edit Character Spacing ability.
emphasis	TextStyleEmphasis	The emphasis formats applied by the text style. This consists of the bold, italic, and underline formats.
firstLineIndent	TextStyleFirstLineIndent	The first line indent applied by the text style.
fontColor	TextStyleFontColor	The font color applied by the text style.
fontFamily	TextStyleFontFamily	The font applied by the text style.
fontSize	TextStyleFontSize	The font size applied by the text style.
lineSpacing	TextStyleLineSpacing	The line spacing applied by the text style.
spaceAfterParagraph	TextStyleSpaceAfterParagraph	The space after the paragraph applied by the text style.
spaceBeforeParagraph	TextStyleSpaceBeforeParagraph	The space before the paragraph applied by the text style.
startIndent	TextStyleStartIndent	The start indent applied by the text style.

Example

{
  "alignment": {
    "alignment": "justified",
    "locked": false
  },
  "characterSpacing": {
    "characterSpacing": -25,
    "locked": false
  },
  "emphasis": {
    "bold": false,
    "italic": false,
    "locked": false,
    "underline": false
  },
  "firstLineIndent": {
    "firstLineIndent": 54,
    "locked": false
  },
  "fontColor": {
    "fontColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "locked": false
  },
  "fontFamily": {
    "fontFamily": "Times New Roman",
    "locked": false
  },
  "fontSize": {
    "fontSize": 14,
    "locked": false
  },
  "lineSpacing": {
    "lineSpacing": 120,
    "locked": false,
    "unit": "percent"
  },
  "spaceAfterParagraph": {
    "locked": false,
    "spaceAfterParagraph": 10.5
  },
  "spaceBeforeParagraph": {
    "locked": false,
    "spaceBeforeParagraph": 12.5
  },
  "startIndent": {
    "locked": false,
    "startIndent": 27
  }
}

TextStyleLineSpacing

The line spacing applied by the text style.

Properties

Name	Type	Description	Restrictions
lineSpacing	number	How far apart lines should be spaced, as a percentage of line height or points. Valid percent range: 80% - 720% Valid points range: 1 - 400 points
locked	boolean	Whether the line spacing is locked.
unit	LineSpacingUnit	The units for a line spacing value as a percent of line height or points.

Example

{
  "lineSpacing": 120,
  "locked": false,
  "unit": "percent"
}

TextStyleSpaceAfterParagraph

The space after the paragraph applied by the text style.

Properties

Name	Type	Description	Restrictions
locked	boolean	Whether the space after paragraph is locked.
spaceAfterParagraph	number	The space after the paragraph, in points.

Example

{
  "locked": false,
  "spaceAfterParagraph": 10.5
}

TextStyleSpaceBeforeParagraph

The space before the paragraph applied by the text style.

Properties

Name	Type	Description	Restrictions
locked	boolean	Whether the space before paragraph is locked.
spaceBeforeParagraph	number	The space before the paragraph, in points.

Example

{
  "locked": false,
  "spaceBeforeParagraph": 12.5
}

TextStyleStartIndent

The start indent applied by the text style.

Properties

Name	Type	Description	Restrictions
locked	boolean	Whether the start indent is locked.
startIndent	number	The amount of indent, in points, from the margin to apply to all the lines of a paragraph from the start of each line. Positive is towards the center of the page.

Example

{
  "locked": false,
  "startIndent": 27
}

TextStyleType

The type of the text style.

Properties

Name	Type	Description	Restrictions
anonymous	string	The type of the text style.

Enumerated Values

Property	Value
anonymous	paragraphStyle
anonymous	headingStyle

Example

"paragraphStyle"

UnspecifiedDrawingElement

An unspecified drawing element to use as a placeholder for elements that have not been explicitly defined in API models.

The unspecified element makes it possible to add new features to the editor without requiring the API models to be updated in tandem. Not only does this element give some information about where the unspecified element is drawn, it gives the element’’s identifier.

Properties

Name	Type	Description	Restrictions
dimensions	Dimensions	A dimension of a rectangle for properties of objects such as a shape, text box, table, chart, image, or page.
fill	Fill	A shape or box fill settings for things like shapes. Use a null to indicate no fill.
id	DrawingElementId	Identifier of the drawing element
margins	Margins	The margins of a rectangle for properties of objects such as a shape, text box, or page.
position	DrawingRelativePosition	The relative position of a drawing element.
stroke	Stroke	Line stroke setting for things like shape edges. Use a null to indicate no stroke line.
wrapStyle	WrapStyleType	The relative position type

Example

{
  "dimensions": {
    "height": 240,
    "width": 320
  },
  "fill": {
    "color": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "opacity": 0.5
  },
  "id": "WW91IGZvdW5kIG1lIQ",
  "margins": {
    "bottom": 10,
    "left": 10,
    "right": 10,
    "top": 10
  },
  "position": {
    "paragraphRelative": {
      "paragraphIndex": 3,
      "x": 0,
      "y": 0
    },
    "type": "paragraphRelative"
  },
  "stroke": {
    "color": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "pattern": "solid",
    "width": 2
  },
  "wrapStyle": "inFrontOfText"
}

UnspecifiedTextElement

An unspecified text element to use as a placeholder for elements that have not been explicitly defined in API models.

Properties

Name	Type	Description	Restrictions
format	RichTextFormat	The formatting options applied to rich text elements.
length	integer	The number of characters (32-bit unicode code point) for a text element or range of text in a selection. Most elements will have a length of 1, even if it is dynamic content which will be replaced by possibly multiple characters. The lengths are used when editing with offsets from an element. The sum of the lengths up to a specific element from another is the offset between those text elements.	Minimum: 1
offset	integer	The number of items to skip over in a collection before the items which will be returned or worked on. The items may be shapes, sections, elements, characters, slides, etc depending on which object or path the offset is being used on.	Minimum: 0
style	StyleRef	A reference to a style.

Example

{
  "format": {
    "backgroundColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "baselineShift": "superscript",
    "bold": true,
    "characterSpacing": -25,
    "font": "Times New Roman",
    "italic": true,
    "size": 14,
    "strikethrough": true,
    "textColor": {
      "blue": 128,
      "green": 128,
      "red": 128
    },
    "underline": true
  },
  "length": 1,
  "offset": 10,
  "style": {
    "location": "<opaque_url>",
    "revision": "2B3C4D5E",
    "style": "c3R5bGUta2V5Ol90Ymw",
    "styleGuide": "a4a9271b80e94cccb541160c9f8e61d6"
  }
}

WorkivaFileExportOptions

Additional export options used for Workiva (.tar.gz) files. Should only be provided when type is “Workiva”.

Properties

Name	Type	Description	Restrictions
emailOnComplete	boolean	Whether or not to email the authorized user when this upload is complete.
includeAttachments	boolean	Whether to preserve attachments for exported content.
includeComments	boolean	Whether to preserve comments for exported content.
includeCustomFieldValues	boolean	Whether to preserve custom field values for exported content.
includeDocumentMarkup	boolean	Whether to preserve document markup for exported content.
includeInputCellValues	boolean	Whether to preserve input cell values for exported content.
includeOutlineLabels	boolean	Whether to preserve outline labels for exported content.
includeSmartLinkMetadata	boolean	Whether to include smart link metadata for exported content.
includeWdataIncomingConnections	boolean	Whether to preserve incoming wdata connections for exported content.
includeWdataOutgoingConnections	boolean	Whether to preserve outgoing wdata connections for exported content.
includeXBRL	boolean	Whether to preserve XBRL for exported content.
includeXBRLDisconnected	boolean	Whether to preserve disconnected XBRL for exported content.
keepInputModeEnabled	boolean	Whether to preserve input mode for exported content.
removeGRCLinks	boolean	Whether to remove any connections to original GRC database, preserving only the textual or value representation of these links.
removeLinks	boolean	Whether to remove any links from sources that are not part of the operation, preserving only the textual or value representation of these links.
sourceId	string	The ID of the file or folder to export.	required

Example

{
  "emailOnComplete": true,
  "includeAttachments": true,
  "includeComments": true,
  "includeCustomFieldValues": true,
  "includeDocumentMarkup": true,
  "includeInputCellValues": true,
  "includeOutlineLabels": true,
  "includeSmartLinkMetadata": true,
  "includeWdataIncomingConnections": true,
  "includeWdataOutgoingConnections": true,
  "includeXBRL": true,
  "includeXBRLDisconnected": true,
  "keepInputModeEnabled": true,
  "removeGRCLinks": true,
  "removeLinks": true,
  "sourceId": "V0ZEYXRhRW50aXR5HkZvbGRlcjo5ZjUwZWI5Ny02ZTJlLTQyMTktYmE5NS1kYzA2ODMyNGRjNGI"
}

WrapStyleType

The relative position type

Properties

Name	Type	Description	Restrictions
anonymous	string¦null	The relative position type

Enumerated Values

Property	Value
anonymous	inFrontOfText
anonymous	wrapText
anonymous	behindText

Example

"inFrontOfText"