REST Resource: documents

{
  "documentId": string,
  "title": string,
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}

string

Output only. The ID of the document.

string

The title of the document.

object (Body)

Output only. The main body of the document.

map (key: string, value: object (Header))

Output only. The headers in the document, keyed by header ID.

map (key: string, value: object (Footer))

Output only. The footers in the document, keyed by footer ID.

map (key: string, value: object (Footnote))

Output only. The footnotes in the document, keyed by footnote ID.

object (DocumentStyle)

Output only. The style of the document.

map (key: string, value: object (SuggestedDocumentStyle))

Output only. The suggested changes to the style of the document, keyed by suggestion ID.

object (NamedStyles)

Output only. The named styles of the document.

map (key: string, value: object (SuggestedNamedStyles))

Output only. The suggested changes to the named styles of the document, keyed by suggestion ID.

map (key: string, value: object (List))

Output only. The lists in the document, keyed by list ID.

map (key: string, value: object (NamedRanges))

Output only. The named ranges in the document, keyed by name.

string

Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document.

The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes.

enum (SuggestionsViewMode)

Output only. The suggestions view mode applied to the document.

Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE.

map (key: string, value: object (InlineObject))

Output only. The inline objects in the document, keyed by object ID.

map (key: string, value: object (PositionedObject))

Output only. The positioned objects in the document, keyed by object ID.

{
  "content": [
    {
      object (StructuralElement)
    }
  ]
}

object (StructuralElement)

The contents of the body.

The indexes for the body's content begin at zero.

{
  "startIndex": integer,
  "endIndex": integer,

  // Union field content can be only one of the following:
  "paragraph": {
    object (Paragraph)
  },
  "sectionBreak": {
    object (SectionBreak)
  },
  "table": {
    object (Table)
  },
  "tableOfContents": {
    object (TableOfContents)
  }
  // End of list of possible types for union field content.
}

integer

The zero-based start index of this structural element, in UTF-16 code units.

integer

The zero-based end index of this structural element, exclusive, in UTF-16 code units.

object (Paragraph)

A paragraph type of structural element.

object (SectionBreak)

A section break type of structural element.

object (Table)

A table type of structural element.

object (TableOfContents)

A table of contents type of structural element.

{
  "elements": [
    {
      object (ParagraphElement)
    }
  ],
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "suggestedParagraphStyleChanges": {
    string: {
      object (SuggestedParagraphStyle)
    },
    ...
  },
  "bullet": {
    object (Bullet)
  },
  "suggestedBulletChanges": {
    string: {
      object (SuggestedBullet)
    },
    ...
  },
  "positionedObjectIds": [
    string
  ],
  "suggestedPositionedObjectIds": {
    string: {
      object (ObjectReferences)
    },
    ...
  }
}

object (ParagraphElement)

The content of the paragraph, broken down into its component parts.

object (ParagraphStyle)

The style of this paragraph.

map (key: string, value: object (SuggestedParagraphStyle))

The suggested paragraph style changes to this paragraph, keyed by suggestion ID.

object (Bullet)

The bullet for this paragraph. If not present, the paragraph does not belong to a list.

map (key: string, value: object (SuggestedBullet))

The suggested changes to this paragraph's bullet.

string

The IDs of the positioned objects tethered to this paragraph.

map (key: string, value: object (ObjectReferences))

The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.

{
  "startIndex": integer,
  "endIndex": integer,

  // Union field content can be only one of the following:
  "textRun": {
    object (TextRun)
  },
  "autoText": {
    object (AutoText)
  },
  "pageBreak": {
    object (PageBreak)
  },
  "columnBreak": {
    object (ColumnBreak)
  },
  "footnoteReference": {
    object (FootnoteReference)
  },
  "horizontalRule": {
    object (HorizontalRule)
  },
  "equation": {
    object (Equation)
  },
  "inlineObjectElement": {
    object (InlineObjectElement)
  },
  "person": {
    object (Person)
  },
  "richLink": {
    object (RichLink)
  }
  // End of list of possible types for union field content.
}

integer

The zero-based start index of this paragraph element, in UTF-16 code units.

integer

The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.

object (TextRun)

A text run paragraph element.

object (AutoText)

An auto text paragraph element.

object (PageBreak)

A page break paragraph element.

object (ColumnBreak)

A column break paragraph element.

object (FootnoteReference)

A footnote reference paragraph element.

object (HorizontalRule)

A horizontal rule paragraph element.

object (Equation)

An equation paragraph element.

object (InlineObjectElement)

An inline object paragraph element.

object (Person)

A paragraph element that links to a person or email address.

object (RichLink)

A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)

{
  "content": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}

string

The text of this run.

Any non-text elements in the run are replaced with the Unicode character U+E907.

string

The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

object (TextStyle)

The text style of this run.

map (key: string, value: object (SuggestedTextStyle))

The suggested text style changes to this run, keyed by suggestion ID.

{
  "bold": boolean,
  "italic": boolean,
  "underline": boolean,
  "strikethrough": boolean,
  "smallCaps": boolean,
  "backgroundColor": {
    object (OptionalColor)
  },
  "foregroundColor": {
    object (OptionalColor)
  },
  "fontSize": {
    object (Dimension)
  },
  "weightedFontFamily": {
    object (WeightedFontFamily)
  },
  "baselineOffset": enum (BaselineOffset),
  "link": {
    object (Link)
  }
}

boolean

Whether or not the text is rendered as bold.

boolean

Whether or not the text is italicized.

boolean

Whether or not the text is underlined.

boolean

Whether or not the text is struck through.

boolean

Whether or not the text is in small capital letters.

object (OptionalColor)

The background color of the text. If set, the color is either an RGB color or transparent, depending on the color field.

object (OptionalColor)

The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the color field.

object (Dimension)

The size of the text's font.

object (WeightedFontFamily)

The font family and rendered weight of the text.

If an update request specifies values for both weightedFontFamily and bold, the weightedFontFamily is applied first, then bold.

If weightedFontFamily#weight is not set, it defaults to 400.

If weightedFontFamily is set, then weightedFontFamily#fontFamily must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.

enum (BaselineOffset)

The text's vertical offset from its normal position.

Text with SUPERSCRIPT or SUBSCRIPT baseline offsets is automatically rendered in a smaller font size, computed based on the fontSize field. Changes in this field don't affect the fontSize.

object (Link)

The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text.

Changing the link in an update request causes some other changes to the text style of the range:

• When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults.
• Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL.
• Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as "ABC\n123", will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline.
• Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.

{
  "color": {
    object (Color)
  }
}

object (Color)

If set, this will be used as an opaque color. If unset, this represents a transparent color.

{
  "rgbColor": {
    object (RgbColor)
  }
}

object (RgbColor)

The RGB color value.

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

number

The red component of the color, from 0.0 to 1.0.

number

The green component of the color, from 0.0 to 1.0.

number

The blue component of the color, from 0.0 to 1.0.

{
  "magnitude": number,
  "unit": enum (Unit)
}

number

The magnitude.

enum (Unit)

The units for magnitude.

{
  "fontFamily": string,
  "weight": integer
}

string

The font family of the text.

The font family can be any font from the Font menu in Docs or from Google Fonts. If the font name is unrecognized, the text is rendered in Arial.

integer

The weight of the font. This field can have any value that's a multiple of 100 between 100 and 900, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, section 15.6, with non-numerical values disallowed.

The default value is 400 ("normal").

The font weight makes up just one component of the rendered font weight. A combination of the weight and the text style's resolved bold value determine the rendered weight, after accounting for inheritance:

• If the text is bold and the weight is less than 400, the rendered weight is 400.
• If the text is bold and the weight is greater than or equal to 400 but is less than 700, the rendered weight is 700.
• If the weight is greater than or equal to 700, the rendered weight is equal to the weight.
• If the text is not bold, the rendered weight is equal to the weight.

{

  // Union field destination can be only one of the following:
  "url": string,
  "bookmarkId": string,
  "headingId": string
  // End of list of possible types for union field destination.
}

string

An external URL.

string

The ID of a bookmark in this document.

string

The ID of a heading in this document.

{
  "textStyle": {
    object (TextStyle)
  },
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}

object (TextStyle)

A TextStyle that only includes the changes made in this suggestion. This can be used along with the textStyleSuggestionState to see which fields have changed and their new values.

object (TextStyleSuggestionState)

A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.

{
  "boldSuggested": boolean,
  "italicSuggested": boolean,
  "underlineSuggested": boolean,
  "strikethroughSuggested": boolean,
  "smallCapsSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "foregroundColorSuggested": boolean,
  "fontSizeSuggested": boolean,
  "weightedFontFamilySuggested": boolean,
  "baselineOffsetSuggested": boolean,
  "linkSuggested": boolean
}

boolean

Indicates if there was a suggested change to bold.

boolean

Indicates if there was a suggested change to italic.

boolean

Indicates if there was a suggested change to underline.

boolean

Indicates if there was a suggested change to strikethrough.

boolean

Indicates if there was a suggested change to smallCaps.

boolean

Indicates if there was a suggested change to backgroundColor.

boolean

Indicates if there was a suggested change to foregroundColor.

boolean

Indicates if there was a suggested change to fontSize.

boolean

Indicates if there was a suggested change to weightedFontFamily.

boolean

Indicates if there was a suggested change to baselineOffset.

boolean

Indicates if there was a suggested change to link.

{
  "type": enum (Type),
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}

enum (Type)

The type of this auto text.

string

The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

object (TextStyle)

The text style of this AutoText.

map (key: string, value: object (SuggestedTextStyle))

The suggested text style changes to this AutoText, keyed by suggestion ID.

{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}

string

The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

object (TextStyle)

The text style of this PageBreak.

Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.

map (key: string, value: object (SuggestedTextStyle))

The suggested text style changes to this PageBreak, keyed by suggestion ID.

{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}

string

The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

object (TextStyle)

The text style of this ColumnBreak.

Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.

map (key: string, value: object (SuggestedTextStyle))

The suggested text style changes to this ColumnBreak, keyed by suggestion ID.

{
  "footnoteId": string,
  "footnoteNumber": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}

string

The ID of the footnote that contains the content of this footnote reference.

string

The rendered number of this footnote.

string

The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

object (TextStyle)

The text style of this FootnoteReference.

map (key: string, value: object (SuggestedTextStyle))

The suggested text style changes to this FootnoteReference, keyed by suggestion ID.

{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}

string

The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

object (TextStyle)

The text style of this HorizontalRule.

Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.

map (key: string, value: object (SuggestedTextStyle))

The suggested text style changes to this HorizontalRule, keyed by suggestion ID.

{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}

string

The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

{
  "inlineObjectId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}

string

The ID of the InlineObject this element contains.

string

The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

object (TextStyle)

The text style of this InlineObjectElement.

Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.

map (key: string, value: object (SuggestedTextStyle))

The suggested text style changes to this InlineObject, keyed by suggestion ID.

{
  "personId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "personProperties": {
    object (PersonProperties)
  }
}

string

Output only. The unique ID of this link.

string

IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.

string

IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.

object (TextStyle)

The text style of this Person.

map (key: string, value: object (SuggestedTextStyle))

The suggested text style changes to this Person, keyed by suggestion ID.

object (PersonProperties)

Output only. The properties of this Person. This field is always present.

{
  "name": string,
  "email": string
}

string

Output only. The name of the person if it's displayed in the link text instead of the person's email address.

string

Output only. The email address linked to this Person. This field is always present.

{
  "richLinkId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "richLinkProperties": {
    object (RichLinkProperties)
  }
}

string

Output only. The ID of this link.

string

IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.

string

IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.

object (TextStyle)

The text style of this RichLink.

map (key: string, value: object (SuggestedTextStyle))

The suggested text style changes to this RichLink, keyed by suggestion ID.

object (RichLinkProperties)

Output only. The properties of this RichLink. This field is always present.

{
  "title": string,
  "uri": string,
  "mimeType": string
}

string

Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.

string

Output only. The URI to the RichLink. This is always present.

string

Output only. The MIME type of the RichLink, if there's one (for example, when it's a file in Drive).

{
  "headingId": string,
  "namedStyleType": enum (NamedStyleType),
  "alignment": enum (Alignment),
  "lineSpacing": number,
  "direction": enum (ContentDirection),
  "spacingMode": enum (SpacingMode),
  "spaceAbove": {
    object (Dimension)
  },
  "spaceBelow": {
    object (Dimension)
  },
  "borderBetween": {
    object (ParagraphBorder)
  },
  "borderTop": {
    object (ParagraphBorder)
  },
  "borderBottom": {
    object (ParagraphBorder)
  },
  "borderLeft": {
    object (ParagraphBorder)
  },
  "borderRight": {
    object (ParagraphBorder)
  },
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "indentEnd": {
    object (Dimension)
  },
  "tabStops": [
    {
      object (TabStop)
    }
  ],
  "keepLinesTogether": boolean,
  "keepWithNext": boolean,
  "avoidWidowAndOrphan": boolean,
  "shading": {
    object (Shading)
  },
  "pageBreakBefore": boolean
}

string

The heading ID of the paragraph. If empty, then this paragraph is not a heading.

This property is read-only.

enum (NamedStyleType)

The named style type of the paragraph.

Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.

enum (Alignment)

The text alignment for this paragraph.

number

The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.

enum (ContentDirection)

The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.

enum (SpacingMode)

The spacing mode for the paragraph.

object (Dimension)

The amount of extra space above the paragraph. If unset, the value is inherited from the parent.

object (Dimension)

The amount of extra space below the paragraph. If unset, the value is inherited from the parent.

object (ParagraphBorder)

The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent.

The between border is rendered when the adjacent paragraph has the same border and indent properties.

Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.

object (ParagraphBorder)

The border at the top of this paragraph. If unset, the value is inherited from the parent.

The top border is rendered when the paragraph above has different border and indent properties.

Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.

object (ParagraphBorder)

The border at the bottom of this paragraph. If unset, the value is inherited from the parent.

The bottom border is rendered when the paragraph below has different border and indent properties.

Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.

object (ParagraphBorder)

The border to the left of this paragraph. If unset, the value is inherited from the parent.

Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.

object (ParagraphBorder)

The border to the right of this paragraph. If unset, the value is inherited from the parent.

Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.

object (Dimension)

The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.

object (Dimension)

The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.

object (Dimension)

The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.

object (TabStop)

A list of the tab stops for this paragraph. The list of tab stops is not inherited.

This property is read-only.

boolean

Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.

boolean

Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.

boolean

Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.

object (Shading)

The shading of the paragraph. If unset, the value is inherited from the parent.

boolean

Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent.

Attempting to update pageBreakBefore for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.

{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "padding": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}

object (OptionalColor)

The color of the border.

object (Dimension)

The width of the border.

object (Dimension)

The padding of the border.

enum (DashStyle)

The dash style of the border.

{
  "offset": {
    object (Dimension)
  },
  "alignment": enum (TabStopAlignment)
}

object (Dimension)

The offset between this tab stop and the start margin.

enum (TabStopAlignment)

The alignment of this tab stop. If unset, the value defaults to START.

{
  "backgroundColor": {
    object (OptionalColor)
  }
}

object (OptionalColor)

The background color of this paragraph shading.

{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}

object (ParagraphStyle)

A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraphStyleSuggestionState to see which fields have changed and their new values.

object (ParagraphStyleSuggestionState)

A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion.

{
  "headingIdSuggested": boolean,
  "namedStyleTypeSuggested": boolean,
  "alignmentSuggested": boolean,
  "lineSpacingSuggested": boolean,
  "directionSuggested": boolean,
  "spacingModeSuggested": boolean,
  "spaceAboveSuggested": boolean,
  "spaceBelowSuggested": boolean,
  "borderBetweenSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "indentEndSuggested": boolean,
  "keepLinesTogetherSuggested": boolean,
  "keepWithNextSuggested": boolean,
  "avoidWidowAndOrphanSuggested": boolean,
  "shadingSuggestionState": {
    object (ShadingSuggestionState)
  },
  "pageBreakBeforeSuggested": boolean
}

boolean

Indicates if there was a suggested change to headingId.

boolean

Indicates if there was a suggested change to namedStyleType.

boolean

Indicates if there was a suggested change to alignment.

boolean

Indicates if there was a suggested change to lineSpacing.

boolean

Indicates if there was a suggested change to direction.

boolean

Indicates if there was a suggested change to spacingMode.

boolean

Indicates if there was a suggested change to spaceAbove.

boolean

Indicates if there was a suggested change to spaceBelow.

boolean

Indicates if there was a suggested change to borderBetween.

boolean

Indicates if there was a suggested change to borderTop.

boolean

Indicates if there was a suggested change to borderBottom.

boolean

Indicates if there was a suggested change to borderLeft.

boolean

Indicates if there was a suggested change to borderRight.

boolean

Indicates if there was a suggested change to indentFirstLine.

boolean

Indicates if there was a suggested change to indentStart.

boolean

Indicates if there was a suggested change to indentEnd.

boolean

Indicates if there was a suggested change to keepLinesTogether.

boolean

Indicates if there was a suggested change to keepWithNext.

boolean

Indicates if there was a suggested change to avoidWidowAndOrphan.

object (ShadingSuggestionState)

A mask that indicates which of the fields in shading have been changed in this suggestion.

boolean

Indicates if there was a suggested change to pageBreakBefore.

{
  "backgroundColorSuggested": boolean
}

boolean

Indicates if there was a suggested change to the Shading.

{
  "listId": string,
  "nestingLevel": integer,
  "textStyle": {
    object (TextStyle)
  }
}

string

The ID of the list this paragraph belongs to.

integer

The nesting level of this paragraph in the list.

object (TextStyle)

The paragraph-specific text style applied to this bullet.

{
  "bullet": {
    object (Bullet)
  },
  "bulletSuggestionState": {
    object (BulletSuggestionState)
  }
}

object (Bullet)

A Bullet that only includes the changes made in this suggestion. This can be used along with the bulletSuggestionState to see which fields have changed and their new values.

object (BulletSuggestionState)

A mask that indicates which of the fields on the base Bullet have been changed in this suggestion.

{
  "listIdSuggested": boolean,
  "nestingLevelSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}

boolean

Indicates if there was a suggested change to the listId.

boolean

Indicates if there was a suggested change to the nestingLevel.

object (TextStyleSuggestionState)

A mask that indicates which of the fields in text style have been changed in this suggestion.

{
  "objectIds": [
    string
  ]
}

string

The object IDs.

{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "sectionStyle": {
    object (SectionStyle)
  }
}

string

The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

object (SectionStyle)

The style of the section after this section break.

{
  "columnProperties": [
    {
      object (SectionColumnProperties)
    }
  ],
  "columnSeparatorStyle": enum (ColumnSeparatorStyle),
  "contentDirection": enum (ContentDirection),
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "sectionType": enum (SectionType),
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "flipPageOrientation": boolean
}

object (SectionColumnProperties)

The section's columns properties.

If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns.

When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.

enum (ColumnSeparatorStyle)

The style of column separators.

This style can be set even when there's one column in the section.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

enum (ContentDirection)

The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

object (Dimension)

The top page margin of the section. If unset, the value defaults to marginTop from DocumentStyle.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

object (Dimension)

The bottom page margin of the section. If unset, the value defaults to marginBottom from DocumentStyle.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

object (Dimension)

The right page margin of the section. If unset, the value defaults to marginRight from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

object (Dimension)

The left page margin of the section. If unset, the value defaults to marginLeft from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

object (Dimension)

The header margin of the section. If unset, the value defaults to marginHeader from DocumentStyle. If updated, useCustomHeaderFooterMargins is set to true on DocumentStyle. The value of useCustomHeaderFooterMargins on DocumentStyle indicates if a header margin is being respected for this section.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

object (Dimension)

The footer margin of the section. If unset, the value defaults to marginFooter from DocumentStyle. If updated, useCustomHeaderFooterMargins is set to true on DocumentStyle. The value of useCustomHeaderFooterMargins on DocumentStyle indicates if a footer margin is being respected for this section

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

enum (SectionType)

Output only. The type of section.

string

The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's defaultHeaderId.

This property is read-only.

string

The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's defaultFooterId.

This property is read-only.

string

The ID of the header used only for the first page of the section. If useFirstPageHeaderFooter is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the defaultHeaderId. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's firstPageHeaderId.

This property is read-only.

string

The ID of the footer used only for the first page of the section. If useFirstPageHeaderFooter is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the defaultFooterId. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's firstPageFooterId.

This property is read-only.

string

The ID of the header used only for even pages. If the value of DocumentStyle's useEvenPageHeaderFooter is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the defaultHeaderId. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's evenPageHeaderId.

This property is read-only.

string

The ID of the footer used only for even pages. If the value of DocumentStyle's useEvenPageHeaderFooter is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the defaultFooterId. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's evenPageFooterId.

This property is read-only.

boolean

Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's useFirstPageHeaderFooter for the first section. If the value is unset for subsequent sectors, it should be interpreted as false.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

integer

The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's pageNumberStart.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

boolean

Optional. Indicates whether to flip the dimensions of DocumentStyle's pageSize for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flipPageOrientation.

When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.

{
  "width": {
    object (Dimension)
  },
  "paddingEnd": {
    object (Dimension)
  }
}

object (Dimension)

Output only. The width of the column.

object (Dimension)

The padding at the end of the column.

{
  "rows": integer,
  "columns": integer,
  "tableRows": [
    {
      object (TableRow)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableStyle": {
    object (TableStyle)
  }
}

integer

Number of rows in the table.

integer

Number of columns in the table.

It's possible for a table to be non-rectangular, so some rows may have a different number of cells.

object (TableRow)

The contents and style of each row.

string

The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

object (TableStyle)

The style of the table.

{
  "startIndex": integer,
  "endIndex": integer,
  "tableCells": [
    {
      object (TableCell)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "suggestedTableRowStyleChanges": {
    string: {
      object (SuggestedTableRowStyle)
    },
    ...
  }
}

integer

The zero-based start index of this row, in UTF-16 code units.

integer

The zero-based end index of this row, exclusive, in UTF-16 code units.

object (TableCell)

The contents and style of each cell in this row.

It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.

string

The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

object (TableRowStyle)

The style of the table row.

map (key: string, value: object (SuggestedTableRowStyle))

The suggested style changes to this row, keyed by suggestion ID.

{
  "startIndex": integer,
  "endIndex": integer,
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "suggestedTableCellStyleChanges": {
    string: {
      object (SuggestedTableCellStyle)
    },
    ...
  }
}

integer

The zero-based start index of this cell, in UTF-16 code units.

integer

The zero-based end index of this cell, exclusive, in UTF-16 code units.

object (StructuralElement)

The content of the cell.

object (TableCellStyle)

The style of the cell.

string

The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

map (key: string, value: object (SuggestedTableCellStyle))

The suggested changes to the table cell style, keyed by suggestion ID.

{
  "rowSpan": integer,
  "columnSpan": integer,
  "backgroundColor": {
    object (OptionalColor)
  },
  "borderLeft": {
    object (TableCellBorder)
  },
  "borderRight": {
    object (TableCellBorder)
  },
  "borderTop": {
    object (TableCellBorder)
  },
  "borderBottom": {
    object (TableCellBorder)
  },
  "paddingLeft": {
    object (Dimension)
  },
  "paddingRight": {
    object (Dimension)
  },
  "paddingTop": {
    object (Dimension)
  },
  "paddingBottom": {
    object (Dimension)
  },
  "contentAlignment": enum (ContentAlignment)
}

integer

The row span of the cell.

This property is read-only.

integer

The column span of the cell.

This property is read-only.

object (OptionalColor)

The background color of the cell.

object (TableCellBorder)

The left border of the cell.

object (TableCellBorder)

The right border of the cell.

object (TableCellBorder)

The top border of the cell.

object (TableCellBorder)

The bottom border of the cell.

object (Dimension)

The left padding of the cell.

object (Dimension)

The right padding of the cell.

object (Dimension)

The top padding of the cell.

object (Dimension)

The bottom padding of the cell.

enum (ContentAlignment)

The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.

{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}

object (OptionalColor)

The color of the border.

This color cannot be transparent.

object (Dimension)

The width of the border.

enum (DashStyle)

The dash style of the border.

{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "tableCellStyleSuggestionState": {
    object (TableCellStyleSuggestionState)
  }
}

object (TableCellStyle)

A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the tableCellStyleSuggestionState to see which fields have changed and their new values.

object (TableCellStyleSuggestionState)

A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.

{
  "rowSpanSuggested": boolean,
  "columnSpanSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "paddingLeftSuggested": boolean,
  "paddingRightSuggested": boolean,
  "paddingTopSuggested": boolean,
  "paddingBottomSuggested": boolean,
  "contentAlignmentSuggested": boolean
}

boolean

Indicates if there was a suggested change to rowSpan.

boolean

Indicates if there was a suggested change to columnSpan.

boolean

Indicates if there was a suggested change to backgroundColor.

boolean

Indicates if there was a suggested change to borderLeft.

boolean

Indicates if there was a suggested change to borderRight.

boolean

Indicates if there was a suggested change to borderTop.

boolean

Indicates if there was a suggested change to borderBottom.

boolean

Indicates if there was a suggested change to paddingLeft.

boolean

Indicates if there was a suggested change to paddingRight.

boolean

Indicates if there was a suggested change to paddingTop.

boolean

Indicates if there was a suggested change to paddingBottom.

boolean

Indicates if there was a suggested change to contentAlignment.

{
  "minRowHeight": {
    object (Dimension)
  },
  "tableHeader": boolean,
  "preventOverflow": boolean
}

object (Dimension)

The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.

boolean

Whether the row is a table header.

boolean

Whether the row cannot overflow across page or column boundaries.

{
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "tableRowStyleSuggestionState": {
    object (TableRowStyleSuggestionState)
  }
}

object (TableRowStyle)

A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the tableRowStyleSuggestionState to see which fields have changed and their new values.

object (TableRowStyleSuggestionState)

A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.

{
  "minRowHeightSuggested": boolean
}

boolean

Indicates if there was a suggested change to minRowHeight.

{
  "tableColumnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}

object (TableColumnProperties)

The properties of each column.

Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's tableRowStyle.

{
  "widthType": enum (WidthType),
  "width": {
    object (Dimension)
  }
}

enum (WidthType)

The width type of the column.

object (Dimension)

The width of the column. Set when the column's widthType is FIXED_WIDTH.

{
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}

object (StructuralElement)

The content of the table of contents.

string

The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.

string

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

{
  "headerId": string,
  "content": [
    {
      object (StructuralElement)
    }
  ]
}

string

The ID of the header.

object (StructuralElement)

The contents of the header.

The indexes for a header's content begin at zero.

{
  "footerId": string,
  "content": [
    {
      object (StructuralElement)
    }
  ]
}

string

The ID of the footer.

object (StructuralElement)

The contents of the footer.

The indexes for a footer's content begin at zero.

{
  "footnoteId": string,
  "content": [
    {
      object (StructuralElement)
    }
  ]
}

string

The ID of the footnote.

object (StructuralElement)

The contents of the footnote.

The indexes for a footnote's content begin at zero.

{
  "background": {
    object (Background)
  },
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "useEvenPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "pageSize": {
    object (Size)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "useCustomHeaderFooterMargins": boolean,
  "flipPageOrientation": boolean
}

object (Background)

The background of the document. Documents cannot have a transparent background color.

string

The ID of the default header. If not set, there's no default header.

This property is read-only.

string

The ID of the default footer. If not set, there's no default footer.

This property is read-only.

string

The ID of the header used only for even pages. The value of useEvenPageHeaderFooter determines whether to use the defaultHeaderId or this value for the header on even pages. If not set, there's no even page header.

This property is read-only.

string

The ID of the footer used only for even pages. The value of useEvenPageHeaderFooter determines whether to use the defaultFooterId or this value for the footer on even pages. If not set, there's no even page footer.

This property is read-only.

string

The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of useFirstPageHeaderFooter determines whether to use the defaultHeaderId or this value for the header on the first page. If not set, there's no first page header.

This property is read-only.

string

The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of useFirstPageHeaderFooter determines whether to use the defaultFooterId or this value for the footer on the first page. If not set, there's no first page footer.

This property is read-only.

boolean

Indicates whether to use the first page header / footer IDs for the first page.

boolean

Indicates whether to use the even page header / footer IDs for the even pages.

integer

The page number from which to start counting the number of pages.

object (Dimension)

The top page margin.

Updating the top page margin on the document style clears the top page margin on all section styles.

object (Dimension)

The bottom page margin.

Updating the bottom page margin on the document style clears the bottom page margin on all section styles.

object (Dimension)

The right page margin.

Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections.

object (Dimension)

The left page margin.

Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections.

object (Size)

The size of a page in the document.

object (Dimension)

The amount of space between the top of the page and the contents of the header.

object (Dimension)

The amount of space between the bottom of the page and the contents of the footer.

boolean

Indicates whether DocumentStyle marginHeader, SectionStyle marginHeader and DocumentStyle marginFooter, SectionStyle marginFooter are respected. When false, the default values in the Docs editor for header and footer margin are used.

This property is read-only.

boolean

Optional. Indicates whether to flip the dimensions of the pageSize, which allows changing the page orientation between portrait and landscape.

{
  "color": {
    object (OptionalColor)
  }
}

object (OptionalColor)

The background color.

{
  "height": {
    object (Dimension)
  },
  "width": {
    object (Dimension)
  }
}

object (Dimension)

The height of the object.

object (Dimension)

The width of the object.

{
  "documentStyle": {
    object (DocumentStyle)
  },
  "documentStyleSuggestionState": {
    object (DocumentStyleSuggestionState)
  }
}

object (DocumentStyle)

A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the documentStyleSuggestionState to see which fields have changed and their new values.

object (DocumentStyleSuggestionState)

A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion.

{
  "backgroundSuggestionState": {
    object (BackgroundSuggestionState)
  },
  "defaultHeaderIdSuggested": boolean,
  "defaultFooterIdSuggested": boolean,
  "evenPageHeaderIdSuggested": boolean,
  "evenPageFooterIdSuggested": boolean,
  "firstPageHeaderIdSuggested": boolean,
  "firstPageFooterIdSuggested": boolean,
  "useFirstPageHeaderFooterSuggested": boolean,
  "useEvenPageHeaderFooterSuggested": boolean,
  "pageNumberStartSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginLeftSuggested": boolean,
  "pageSizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginHeaderSuggested": boolean,
  "marginFooterSuggested": boolean,
  "useCustomHeaderFooterMarginsSuggested": boolean,
  "flipPageOrientationSuggested": boolean
}

object (BackgroundSuggestionState)

A mask that indicates which of the fields in background have been changed in this suggestion.

boolean

Indicates if there was a suggested change to defaultHeaderId.

boolean

Indicates if there was a suggested change to defaultFooterId.

boolean

Indicates if there was a suggested change to evenPageHeaderId.

boolean

Indicates if there was a suggested change to evenPageFooterId.

boolean

Indicates if there was a suggested change to firstPageHeaderId.

boolean

Indicates if there was a suggested change to firstPageFooterId.

boolean

Indicates if there was a suggested change to useFirstPageHeaderFooter.

boolean

Indicates if there was a suggested change to useEvenPageHeaderFooter.

boolean

Indicates if there was a suggested change to pageNumberStart.

boolean

Indicates if there was a suggested change to marginTop.

boolean

Indicates if there was a suggested change to marginBottom.

boolean

Indicates if there was a suggested change to marginRight.

boolean

Indicates if there was a suggested change to marginLeft.

object (SizeSuggestionState)

A mask that indicates which of the fields in [size] [google.apps.docs.v1.DocumentStyle.size] have been changed in this suggestion.

boolean

Indicates if there was a suggested change to marginHeader.

boolean

Indicates if there was a suggested change to marginFooter.

boolean

Indicates if there was a suggested change to useCustomHeaderFooterMargins.

boolean

Optional. Indicates if there was a suggested change to flipPageOrientation.

{
  "backgroundColorSuggested": boolean
}

boolean

Indicates whether the current background color has been modified in this suggestion.

{
  "heightSuggested": boolean,
  "widthSuggested": boolean
}

boolean

Indicates if there was a suggested change to height.

boolean

Indicates if there was a suggested change to width.

{
  "styles": [
    {
      object (NamedStyle)
    }
  ]
}

object (NamedStyle)

The named styles.

There's an entry for each of the possible named style types.

{
  "namedStyleType": enum (NamedStyleType),
  "textStyle": {
    object (TextStyle)
  },
  "paragraphStyle": {
    object (ParagraphStyle)
  }
}

enum (NamedStyleType)

The type of this named style.

object (TextStyle)

The text style of this named style.

object (ParagraphStyle)

The paragraph style of this named style.

{
  "namedStyles": {
    object (NamedStyles)
  },
  "namedStylesSuggestionState": {
    object (NamedStylesSuggestionState)
  }
}

object (NamedStyles)

A NamedStyles that only includes the changes made in this suggestion. This can be used along with the namedStylesSuggestionState to see which fields have changed and their new values.

object (NamedStylesSuggestionState)

A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion.

{
  "stylesSuggestionStates": [
    {
      object (NamedStyleSuggestionState)
    }
  ]
}

object (NamedStyleSuggestionState)

A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion.

The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion.

{
  "namedStyleType": enum (NamedStyleType),
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}