REST Resource: documents

资源:Document

Google 文档。

JSON 表示法
{
  "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)
    },
    ...
  }
}
字段
documentId

string

仅供输出。文档的 ID。

title

string

文档的标题。

body

object (Body)

仅供输出。文档的正文。

headers

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

仅供输出。文档中的标头,由标头 ID 键控。

footers

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

仅供输出。文档中的页脚,由页脚 ID 键控。

footnotes

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

仅供输出。文档中的脚注,以脚注 ID 为键。

documentStyle

object (DocumentStyle)

仅供输出。文档的样式。

suggestedDocumentStyleChanges

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

仅供输出。对文档样式建议的更改,由建议 ID 键控。

namedStyles

object (NamedStyles)

仅供输出。文档的已命名样式。

suggestedNamedStylesChanges

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

仅供输出。对文档的命名样式建议的更改,由建议 ID 键控。

lists

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

仅供输出。文档中的列表,由列表 ID 键控。

namedRanges

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

仅供输出。文档中的命名范围,按名称进行键控。

revisionId

string

仅供输出。文档的修订版本 ID。可用于更新请求,以指定要将更新应用到文档的哪个修订版本,以及如果文档在对该修订版本进行编辑后,该请求应采取何种行为。仅当用户拥有文档的编辑权限时填充。

修订版本 ID 不是序列号,而是不透明的字符串。修订版本 ID 的格式可能会随时间而变化。我们只保证所返回的修订版本 ID 在返回后的 24 小时内有效,并且无法在用户之间共享。如果两次调用之间的修订版本 ID 保持不变,则文档不会更改。相反,如果 ID 发生更改(针对同一文档和用户),则通常表示文档已更新。但是,ID 发生更改也可能由内部因素(例如 ID 格式更改)导致。

suggestionsViewMode

enum (SuggestionsViewMode)

仅供输出。应用于文档的建议视图模式。

注意:编辑文档时,必须基于带有 SUGGESTIONS_INLINE 的文档进行更改。

inlineObjects

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

仅供输出。文档中的内嵌对象,由对象 ID 键控。

positionedObjects

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

仅供输出。文档中已定位的对象,由对象 ID 键控。

正文

文档正文。

正文通常包含完整的文档内容,headersfootersfootnotes 除外。

JSON 表示法
{
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
字段
content[]

object (StructuralElement)

正文的内容。

正文内容的索引从零开始。

结构元素

StructuralElement 描述的是为文档提供结构的内容。

JSON 表示法
{
  "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.
}
字段
startIndex

integer

此结构元素的起始索引(从零开始),采用 UTF-16 代码单元。

endIndex

integer

此结构元素的结束索引(从零开始,不含该索引),采用 UTF-16 代码单元。

联合字段 content。结构元素的内容。content 只能是下列其中一项:
paragraph

object (Paragraph)

一种类型的结构元素。

sectionBreak

object (SectionBreak)

结构元素的分节类型。

table

object (Table)

结构元素的表格类型。

tableOfContents

object (TableOfContents)

结构元素的目录类型。

段落

表示段落的 StructuralElement。段落是以换行符结束的一系列内容。

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

object (ParagraphElement)

段落内容,细分为各个组成部分。

paragraphStyle

object (ParagraphStyle)

此段落的样式。

suggestedParagraphStyleChanges

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

建议的段落样式会更改为此段落,由建议 ID 键控。

bullet

object (Bullet)

此段落的项目符号。如果没有显示,则表示段落不属于列表。

suggestedBulletChanges

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

对此段落的项目符号的更改建议。

positionedObjectIds[]

string

绑定到此段落的已定位对象的 ID。

suggestedPositionedObjectIds

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

建议附加到此段落的定位对象的 ID,由建议 ID 键控。

段落元素

ParagraphElement 描述 Paragraph 中的内容。

JSON 表示法
{
  "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.
}
字段
startIndex

integer

此段落元素的起始索引(从零开始),采用 UTF-16 代码单元。

endIndex

integer

此段落元素的结束索引(不含基本零值),采用 UTF-16 代码单元。

联合字段 content。段落元素的内容。content 只能是下列其中一项:
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)

链接到某人或电子邮件地址的段落元素。

TextRun

表示所有具有相同样式的一系列文本的 ParagraphElement

JSON 表示法
{
  "content": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
字段
content

string

此运行的文本。

运行中的所有非文本元素都会替换为 Unicode 字符 U+E907。

suggestedInsertionIds[]

string

建议的插入 ID。如果是嵌套建议的更改,TextRun 可能会有多个插入 ID。如果为空,则不建议插入。

suggestedDeletionIds[]

string

建议的删除 ID。如果为空,则表示没有建议删除此内容。

textStyle

object (TextStyle)

此运行的文本样式。

suggestedTextStyleChanges

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

建议的文本样式将更改为此运行,由建议 ID 键控。

TextStyle

表示可应用于文本的样式。

继承的文本样式在此消息中表示为未设置的字段。文本样式的父项取决于文本样式的定义位置:

  • Paragraph 中文本的 TextStyle 继承自段落的相应 named style type
  • named style 上的 TextStyle 继承自 normal text 已命名的样式。
  • normal text 已命名样式的 TextStyle 继承自文档编辑器中的默认文本样式。
  • 表中包含的 Paragraph 元素的 TextStyle 可能会从表样式继承其文本样式。

如果文本样式未从父项继承,则取消设置字段会将样式还原为与文档编辑器中的默认值相匹配的值。

JSON 表示法
{
  "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)
  }
}
字段
bold

boolean

文本是否以粗体呈现。

italic

boolean

文本是否为斜体。

underline

boolean

文本是否带有下划线。

strikethrough

boolean

是否删除文本。

smallCaps

boolean

文字是否采用小大写字母。

backgroundColor

object (OptionalColor)

文本的背景颜色。如果设置了此项,颜色为 RGB 颜色或透明色,具体取决于 color 字段。

foregroundColor

object (OptionalColor)

文本的前景颜色。如果设置了此项,颜色为 RGB 颜色或透明色,具体取决于 color 字段。

fontSize

object (Dimension)

文本的字体大小。

weightedFontFamily

object (WeightedFontFamily)

文本的字体系列和渲染粗细。

如果更新请求同时指定 weightedFontFamilybold 的值,则首先应用 weightedFontFamily,然后应用 bold

如果未设置 weightedFontFamily#weight,则默认为 400

如果设置了 weightedFontFamily,则 weightedFontFamily#fontFamily 也必须设置为非空值。否则,系统将返回 400 错误请求错误。

baselineOffset

enum (BaselineOffset)

文本相对于正常位置的垂直偏移。

基线偏移为 SUPERSCRIPTSUBSCRIPT 的文本自动以较小的字体大小呈现,根据 fontSize 字段计算得出。此字段的更改不会影响 fontSize

可选颜色

一种颜色,可完全不透明或完全透明。

JSON 表示法
{
  "color": {
    object (Color)
  }
}
字段
color

object (Color)

如果设置,将用作不透明颜色。如果未设置,则此属性表示透明颜色。

颜色

纯色。

JSON 表示法
{
  "rgbColor": {
    object (RgbColor)
  }
}
字段
rgbColor

object (RgbColor)

RGB 颜色值。

颜色

RGB 颜色。

JSON 表示法
{
  "red": number,
  "green": number,
  "blue": number
}
字段
red

number

颜色的红色分量,介于 0.0 到 1.0 之间。

green

number

颜色的绿色分量,介于 0.0 到 1.0 之间。

blue

number

颜色的蓝色分量,介于 0.0 到 1.0 之间。

维度

指定单位内单个方向的量级。

JSON 表示法
{
  "magnitude": number,
  "unit": enum (Unit)
}
字段
magnitude

number

震级。

unit

enum (Unit)

量级的单位。

单位

度量单位。

枚举
UNIT_UNSPECIFIED 单位未知。
PT 点,1/72 英寸。

WeightedFontFamily

表示字体系列和文本粗细。

JSON 表示法
{
  "fontFamily": string,
  "weight": integer
}
字段
fontFamily

string

文本的字体系列。

字体系列可以是文档中的“字体”菜单或 Google Fonts 中的任何字体。如果字体名称无法识别,文本将采用 Arial 呈现。

weight

integer

字体粗细。此字段可具有 100 介于 100900 之间(包括这两个数值)的任意值。此范围对应于 CSS 2.1 规范第 15.6 节中所述的数值(不允许使用非数值)。

默认值为 400(“normal”)。

字体粗细仅构成所呈现字体粗细的一个组成部分。在考虑继承之后,weight 和文本样式的解析 bold 值的组合决定了呈现的权重:

  • 如果文本为粗体且粗细小于 400,则呈现的粗细为 400。
  • 如果文本为粗体,且粗细大于或等于 400 但小于 700,则呈现的粗细为 700
  • 如果权重大于或等于 700,呈现的权重等于权重。
  • 如果文本不是粗体,呈现的粗细等于其粗细。

基准偏移

文本相对于正常位置垂直偏移的方式。

枚举
BASELINE_OFFSET_UNSPECIFIED 文本的基线偏移量继承自父项。
NONE 文本没有垂直偏移。
SUPERSCRIPT 文本向上垂直偏移(上标)。
SUBSCRIPT 文本向下垂直偏移(下标)。

SuggestedTextStyle

建议的对 TextStyle 的更改。

JSON 表示法
{
  "textStyle": {
    object (TextStyle)
  },
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
字段
textStyle

object (TextStyle)

仅包含此建议中所做更改的 TextStyle。这可以与 textStyleSuggestionState 结合使用,以查看哪些字段已更改以及它们的新值。

textStyleSuggestionState

object (TextStyleSuggestionState)

一个掩码,用于指示此建议中基础 TextStyle 上的哪些字段已更改。

TextStyleSuggestionState

一个掩码,用于指示此建议中基础 TextStyle 上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

JSON 表示法
{
  "boldSuggested": boolean,
  "italicSuggested": boolean,
  "underlineSuggested": boolean,
  "strikethroughSuggested": boolean,
  "smallCapsSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "foregroundColorSuggested": boolean,
  "fontSizeSuggested": boolean,
  "weightedFontFamilySuggested": boolean,
  "baselineOffsetSuggested": boolean,
  "linkSuggested": boolean
}
字段
boldSuggested

boolean

指示是否有对 bold 的建议更改。

italicSuggested

boolean

指示是否有对 italic 的建议更改。

underlineSuggested

boolean

指示是否有对 underline 的建议更改。

strikethroughSuggested

boolean

指示是否有对 strikethrough 的建议更改。

smallCapsSuggested

boolean

指示是否有对 smallCaps 的建议更改。

backgroundColorSuggested

boolean

指示是否有对 backgroundColor 的建议更改。

foregroundColorSuggested

boolean

指示是否有对 foregroundColor 的建议更改。

fontSizeSuggested

boolean

指示是否有对 fontSize 的建议更改。

weightedFontFamilySuggested

boolean

指示是否有对 weightedFontFamily 的建议更改。

baselineOffsetSuggested

boolean

指示是否有对 baselineOffset 的建议更改。

自动文字

ParagraphElement,表示文本中的某个位置,该位置会动态替换为可随时间变化的内容,例如页码。

JSON 表示法
{
  "type": enum (Type),
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
字段
type

enum (Type)

此自动文本的类型。

suggestedInsertionIds[]

string

建议的插入 ID。如果是嵌套建议的更改,AutoText 可能会有多个插入 ID。如果为空,则不建议插入。

suggestedDeletionIds[]

string

建议的删除 ID。如果为空,则表示没有建议删除此内容。

textStyle

object (TextStyle)

此自动文本的文本样式。

suggestedTextStyleChanges

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

建议的文本样式会更改为此自动文本,由建议 ID 键控。

类型

自动文本的类型。

枚举
TYPE_UNSPECIFIED 未指定的自动文本类型。
PAGE_NUMBER 表示当前页码的自动文本类型。
PAGE_COUNT 表示文档中总页数的自动文本类型。

分页符

表示分页符的 ParagraphElement。分页符会使后续文本从下一页顶部开始。

JSON 表示法
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
字段
suggestedInsertionIds[]

string

建议的插入 ID。如果是嵌套建议的更改,PageBreak 可能会有多个插入 ID。如果为空,则不建议插入。

suggestedDeletionIds[]

string

建议的删除 ID。如果为空,则表示没有建议删除此内容。

textStyle

object (TextStyle)

此 PageBreak 的文本样式。

与文本内容(如文本行和脚注引用)类似,分页符的文本样式可能会影响内容布局以及在其旁边插入的文本的样式。

suggestedTextStyleChanges

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

建议的文本样式将更改此 PageBreak,由建议 ID 键控。

分栏符

表示分栏符的 ParagraphElement。分栏符会将后续文本从下一列的顶部开始。

JSON 表示法
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
字段
suggestedInsertionIds[]

string

建议的插入 ID。如果是嵌套建议的更改,ColumnBreak 可能会有多个插入 ID。如果为空,则不建议插入。

suggestedDeletionIds[]

string

建议的删除 ID。如果为空,则表示没有建议删除此内容。

textStyle

object (TextStyle)

此 ColumnBreak 的文本样式。

与文本内容(如文本行和脚注引用)类似,分栏符的文本样式可能会影响内容布局以及在其旁边插入的文本的样式。

suggestedTextStyleChanges

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

建议的文本样式将更改为此 ColumnBreak,由建议 ID 键控。

脚注引用

表示脚注引用的 ParagraphElement。脚注引用是使用数字呈现的内嵌内容,用于标识脚注。

JSON 表示法
{
  "footnoteId": string,
  "footnoteNumber": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
字段
footnoteId

string

包含此脚注引用内容的 footnote 的 ID。

footnoteNumber

string

此脚注的呈现编号。

suggestedInsertionIds[]

string

建议的插入 ID。如果是嵌套建议的更改,FootnoteReference 可能会有多个插入 ID。如果为空,则不建议插入。

suggestedDeletionIds[]

string

建议的删除 ID。如果为空,则表示没有建议删除此内容。

textStyle

object (TextStyle)

此 FootnoteReference 的文本样式。

suggestedTextStyleChanges

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

建议的文本样式会更改为此 FootnoteReference,由建议 ID 键控。

HorizontalRule

表示水平线的 ParagraphElement

JSON 表示法
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
字段
suggestedInsertionIds[]

string

建议的插入 ID。如果是嵌套建议的更改,HorizontalRule 可以有多个插入 ID。如果为空,则不建议插入。

suggestedDeletionIds[]

string

建议的删除 ID。如果为空,则表示没有建议删除此内容。

textStyle

object (TextStyle)

此 HorizontalRule 的文本样式。

与文本内容(如文本行和脚注引用)类似,水平线的文本样式可能会影响内容布局以及在其旁边插入的文本的样式。

suggestedTextStyleChanges

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

建议的文本样式更改为此 HorizontalRule,由建议 ID 键控。

方程

表示等式的 ParagraphElement

JSON 表示法
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
字段
suggestedInsertionIds[]

string

建议的插入 ID。如果是嵌套建议的更改,Equation 可能会有多个插入 ID。如果为空,则不建议插入。

suggestedDeletionIds[]

string

建议的删除 ID。如果为空,则表示没有建议删除此内容。

InlineObjectElement

一个包含 InlineObjectParagraphElement

JSON 表示法
{
  "inlineObjectId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
字段
inlineObjectId

string

此元素包含的 InlineObject 的 ID。

suggestedInsertionIds[]

string

建议的插入 ID。如果是嵌套建议的更改,InlineObjectElement 可能会有多个插入 ID。如果为空,则不建议插入。

suggestedDeletionIds[]

string

建议的删除 ID。如果为空,则表示没有建议删除此内容。

textStyle

object (TextStyle)

此 InlineObjectElement 的文本样式。

与文本内容(如文本行和脚注引用)类似,内嵌对象元素的文本样式可能会影响内容布局以及在其旁边插入的文本的样式。

suggestedTextStyleChanges

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

建议的文本样式对此 InlineObject 的更改,由建议 ID 键控。

人物

文档中提到的人员或电子邮件地址。提及的人将作为一个不可更改的元素,其中包含人的姓名或电子邮件地址。

JSON 表示法
{
  "personId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "personProperties": {
    object (PersonProperties)
  }
}
字段
personId

string

仅供输出。此关联的唯一 ID。

suggestedInsertionIds[]

string

将此人链接插入到文档中的建议 ID。如果是嵌套建议的更改(例如,其他用户建议的更改),Person 可能会有多个插入 ID。如果为空,则表示系统不建议插入此人链接。

suggestedDeletionIds[]

string

从文档中移除此人链接的建议 ID。一个 Person 可能有多个删除 ID,例如,如果有多位用户建议删除它,如果为空,则不建议删除此联系人链接。

textStyle

object (TextStyle)

Person 的文本样式。

suggestedTextStyleChanges

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

建议的文本样式会更改为此 Person,由建议 ID 键控。

personProperties

object (PersonProperties)

仅供输出。此 Person 的属性。此字段始终显示。

PersonProperties

关联的 Person 的专用属性。

JSON 表示法
{
  "name": string,
  "email": string
}
字段
name

string

仅供输出。在链接文本中显示人员的姓名,而不是个人的电子邮件地址。

email

string

仅供输出。与此 Person 关联的电子邮件地址。此字段始终显示。

RichLinkProperties

RichLink 的专用属性。

JSON 表示法
{
  "title": string,
  "uri": string,
  "mimeType": string
}
字段
title

string

仅供输出。链接中显示的 RichLink 标题。此标题与插入或上次更新链接时关联资源的标题一致。此字段始终显示。

uri

string

仅供输出。RichLink 的 URI。此字段始终存在。

mimeType

string

仅供输出。RichLinkMIME 类型,如果存在(例如,当它是云端硬盘中的文件时)。

ParagraphStyle

应用于整个段落的样式。

继承的段落样式在此消息中表示为未设置的字段。段落样式的父项取决于段落样式的定义位置:

  • Paragraph 上的 ParagraphStyle 继承自段落的相应 named style type
  • named style 上的 ParagraphStyle 继承自 normal text 已命名的样式。
  • 已命名样式的 normal text 的 ParagraphStyle 继承自文档编辑器中的默认段落样式。
  • 表格中包含的 Paragraph 元素的 ParagraphStyle 可能会从表格样式继承其段落样式。

如果段落样式未从父级继承,则取消设置字段会将样式还原为与文档编辑器中的默认值相匹配的值。

JSON 表示法
{
  "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
}
字段
headingId

string

段落的标题 ID。如果为空,则表示此段落不是标题。

此属性为只读属性。

namedStyleType

enum (NamedStyleType)

段落的已命名样式类型。

由于更新命名的样式类型会影响 ParagraphStyle 中的其他属性,因此,系统会在更新其他属性之前应用已命名的样式类型。

alignment

enum (Alignment)

此段落的文本对齐方式。

lineSpacing

number

行与行之间的间距,以正常值百分比的形式表示,其中正常值以 100.0 表示。如果未设置,则值将继承自父级。

direction

enum (ContentDirection)

此段落的文本方向。如果未设置,则值默认为 LEFT_TO_RIGHT,因为系统不会继承段落方向。

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

当前段落是否应始终从页面的开头开始。如果未设置,则值将继承自父级。

如果尝试为不受支持的区域(包括 TableHeaderFooterFootnote)中的段落更新 pageBreakBefore,可能会导致文档无效状态,并返回“400 bad request”错误。

NamedStyleType

已命名样式的类型。

枚举
NAMED_STYLE_TYPE_UNSPECIFIED 未指定已命名样式的类型。
NORMAL_TEXT 普通文本。
TITLE 标题。
SUBTITLE 副标题。
HEADING_1 标题 1.
HEADING_2 标题 2.
HEADING_3 标题 3.
HEADING_4 4 级标题。
HEADING_5 5 级标题。
HEADING_6 标题 6.

对齐

段落的文本对齐类型。

枚举
ALIGNMENT_UNSPECIFIED 段落对齐方式继承自父级。
START 段落会与行首对齐。对于 LTR 文本,为左对齐,否则为右对齐。
CENTER 段落居中。
END 段落会与行尾对齐。对于 LTR 文本,为右对齐,否则为左对齐。
JUSTIFIED 该段落已两端对齐。

内容方向

路线内容可流入。

枚举
CONTENT_DIRECTION_UNSPECIFIED 未指定内容方向。
LEFT_TO_RIGHT 内容从左向右。
RIGHT_TO_LEFT 内容从右向左。

间距模式

不同的段落间距模式。

枚举
SPACING_MODE_UNSPECIFIED 间距模式继承自父级。
NEVER_COLLAPSE 段落间距始终会呈现。
COLLAPSE_LISTS 系统会在列表元素之间跳过段落间距。

ParagraphBorder

段落周围的边框。

JSON 表示法
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "padding": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
字段
color

object (OptionalColor)

边框的颜色。

width

object (Dimension)

边框的宽度。

padding

object (Dimension)

边框的内边距。

dashStyle

enum (DashStyle)

边框的短划线样式。

短划线样式

可用于渲染线性几何图形的短划线的类型。这些值基于“ST_PresetLineDashVal”简单类型,如“Office Open XML 文件格式 - 基础知识和标记语言参考”第 20.1.10.48 节所述(ECMA-376 第 4 版第 1 部分)。

枚举
DASH_STYLE_UNSPECIFIED 未指定短划线样式。
SOLID 实线。对应于 ECMA-376 ST_PresetLineDashVal 值“visible”。这是默认的短划线样式。
DOT 虚线。对应于 ECMA-376 ST_PresetLineDashVal 值“dot”。
DASH 虚线。对应于 ECMA-376 ST_PresetLineDashVal 值“dash”。

TabStop

段落中的制表位。

JSON 表示法
{
  "offset": {
    object (Dimension)
  },
  "alignment": enum (TabStopAlignment)
}
字段
offset

object (Dimension)

此制表位与起始外边距之间的偏移量。

alignment

enum (TabStopAlignment)

此制表位的对齐方式。如果未设置,则值默认为 START

TabStopAlignment

制表位的对齐方式。

枚举
TAB_STOP_ALIGNMENT_UNSPECIFIED 未指定制表位对齐。
START 制表位与行首对齐。这是默认值。
CENTER 制表位与线条中心对齐。
END 制表位与行尾对齐。

阴影

段落阴影。

JSON 表示法
{
  "backgroundColor": {
    object (OptionalColor)
  }
}
字段
backgroundColor

object (OptionalColor)

此段落阴影的背景颜色。

SuggestedParagraphStyle(建议的段落样式)

建议的对 ParagraphStyle 的更改。

JSON 表示法
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
字段
paragraphStyle

object (ParagraphStyle)

仅包含此建议中所做更改的 ParagraphStyle。这可以与 paragraphStyleSuggestionState 结合使用,以查看哪些字段已更改以及它们的新值。

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

一个掩码,用于指示此建议中基础 ParagraphStyle 上的哪些字段已更改。

ParagraphStyleSuggestionState

一个掩码,用于指示此建议中基础 ParagraphStyle 上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

JSON 表示法
{
  "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
}
字段
headingIdSuggested

boolean

指示是否有对 headingId 的建议更改。

namedStyleTypeSuggested

boolean

指示是否有对 namedStyleType 的建议更改。

alignmentSuggested

boolean

指示是否有对 alignment 的建议更改。

lineSpacingSuggested

boolean

指示是否有对 lineSpacing 的建议更改。

directionSuggested

boolean

指示是否有对 direction 的建议更改。

spacingModeSuggested

boolean

指示是否有对 spacingMode 的建议更改。

spaceAboveSuggested

boolean

指示是否有对 spaceAbove 的建议更改。

spaceBelowSuggested

boolean

指示是否有对 spaceBelow 的建议更改。

borderBetweenSuggested

boolean

指示是否有对 borderBetween 的建议更改。

borderTopSuggested

boolean

指示是否有对 borderTop 的建议更改。

borderBottomSuggested

boolean

指示是否有对 borderBottom 的建议更改。

borderLeftSuggested

boolean

指示是否有对 borderLeft 的建议更改。

borderRightSuggested

boolean

指示是否有对 borderRight 的建议更改。

indentFirstLineSuggested

boolean

指示是否有对 indentFirstLine 的建议更改。

indentStartSuggested

boolean

指示是否有对 indentStart 的建议更改。

indentEndSuggested

boolean

指示是否有对 indentEnd 的建议更改。

keepLinesTogetherSuggested

boolean

指示是否有对 keepLinesTogether 的建议更改。

keepWithNextSuggested

boolean

指示是否有对 keepWithNext 的建议更改。

avoidWidowAndOrphanSuggested

boolean

指示是否有对 avoidWidowAndOrphan 的建议更改。

shadingSuggestionState

object (ShadingSuggestionState)

一个掩码,用于指示此建议中 shading 中的哪些字段已更改。

pageBreakBeforeSuggested

boolean

指示是否有对 pageBreakBefore 的建议更改。

ShadingSuggestionState

一个掩码,用于指示在此建议的更改中基本 Shading 中的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

JSON 表示法
{
  "backgroundColorSuggested": boolean
}
字段
backgroundColorSuggested

boolean

指示是否有对 Shading 的建议更改。

子弹图

描述段落的项目符号。

JSON 表示法
{
  "listId": string,
  "nestingLevel": integer,
  "textStyle": {
    object (TextStyle)
  }
}
字段
listId

string

此段落所属列表的 ID。

nestingLevel

integer

此段落在列表中嵌套的级别。

textStyle

object (TextStyle)

应用于此项目符号的段落专用文本样式。

建议的项目符号

建议的对 Bullet 的更改。

JSON 表示法
{
  "bullet": {
    object (Bullet)
  },
  "bulletSuggestionState": {
    object (BulletSuggestionState)
  }
}
字段
bullet

object (Bullet)

仅包含此建议中所做更改的 Bullet。这可以与 bulletSuggestionState 结合使用,以查看哪些字段已更改以及它们的新值。

bulletSuggestionState

object (BulletSuggestionState)

一个掩码,用于指示此建议中基础 Bullet 上的哪些字段已更改。

BulletSuggestionState

一个掩码,用于指示此建议中基础 Bullet 上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

JSON 表示法
{
  "listIdSuggested": boolean,
  "nestingLevelSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
字段
listIdSuggested

boolean

指示是否有对 listId 的建议更改。

nestingLevelSuggested

boolean

指示是否有对 nestingLevel 的建议更改。

textStyleSuggestionState

object (TextStyleSuggestionState)

一个掩码,用于指示此建议中 text style 中的哪些字段已更改。

对象引用

对象 ID 的集合。

JSON 表示法
{
  "objectIds": [
    string
  ]
}
字段
objectIds[]

string

对象 ID。

分节符

表示分节符的 StructuralElement。版块是指具有相同 SectionStyle 的一系列内容。分节符表示新小节的开始,而小节样式会应用于分节符之后的小节。

文档正文始终以分节符开头。

JSON 表示法
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "sectionStyle": {
    object (SectionStyle)
  }
}
字段
suggestedInsertionIds[]

string

建议的插入 ID。如果是嵌套建议的更改,SectionBreak 可能会有多个插入 ID。如果为空,则不建议插入。

suggestedDeletionIds[]

string

建议的删除 ID。如果为空,则表示没有建议删除此内容。

sectionStyle

object (SectionStyle)

此分节符之后的小节样式。

版块样式

应用于区段的样式。

JSON 表示法
{
  "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
}
字段
columnProperties[]

object (SectionColumnProperties)

版块的列属性。

如果为空,则此部分包含一列具有文档编辑器中的默认属性。每个版块最多只能包含 3 列。

更新此属性时,需要设置具体的值。取消设置此属性将导致 400 bad request 错误。

columnSeparatorStyle

enum (ColumnSeparatorStyle)

列分隔符的样式。

即使相应部分中只有一列,您也可以设置此样式。

更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。

contentDirection

enum (ContentDirection)

此版块的内容方向。如果未设置,则值默认为 LEFT_TO_RIGHT

更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。

marginTop

object (Dimension)

相应部分的上边距。如果未设置,则值默认为 DocumentStyle 的 marginTop

更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。

marginBottom

object (Dimension)

此版块的下边距。如果未设置,则值默认为 DocumentStyle 的 marginBottom

更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。

marginRight

object (Dimension)

相应部分的右页外边距。如果未设置,则值默认为 DocumentStyle 的 marginRight。更新右外边距会导致此部分中的列调整大小。由于外边距会影响列宽,因此应用于列属性之前。

更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。

marginLeft

object (Dimension)

该部分的左侧页边距。如果未设置,则值默认为 DocumentStyle 的 marginLeft。更新左外边距会导致此部分中的列调整大小。由于外边距会影响列宽,因此应用于列属性之前。

更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。

marginHeader

object (Dimension)

部分的标题外边距。如果未设置,则值默认为 DocumentStyle 的 marginHeader。如果更新,则 DocumentStyle 上的 useCustomHeaderFooterMargins 会设置为 true。DocumentStyle 上 useCustomHeaderFooterMargins 的值表示是否要遵循此部分的页眉外边距。

更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。

sectionType

enum (SectionType)

仅供输出。部分的类型。

defaultHeaderId

string

默认标头的 ID。如果未设置,则该值将继承自上一个 SectionBreak'sSectionStyle。如果未设置第一个分节符的值,它将继承 DocumentStyle 的 defaultHeaderId

此属性为只读属性。

firstPageHeaderId

string

仅用于章节第一页的标题 ID。如果 useFirstPageHeaderFooter 为 true,此值将用作该节第一页的页眉。如果为 false,该节第一页的页眉会使用 defaultHeaderId。如果未设置,则该值将继承自上一个 SectionBreak'sSectionStyle。如果未设置第一个分节符的值,它将继承 DocumentStyle 的 firstPageHeaderId

此属性为只读属性。

evenPageHeaderId

string

仅用于偶数页的标题 ID。如果 DocumentStyle 的 useEvenPageHeaderFooter 的值为 true,则此值将用作该部分中偶数页的标题。如果为 false,偶数页上的标头都会使用 defaultHeaderId。如果未设置,则该值将继承自上一个 SectionBreak'sSectionStyle。如果未设置第一个分节符的值,它将继承 DocumentStyle 的 evenPageHeaderId

此属性为只读属性。

pageNumberStart

integer

开始计算该版块页数的页码。如果未设置,页面编号会从上一部分继续。如果在第一个 SectionBreak 中未设置该值,请参阅 DocumentStyle 的 pageNumberStart

更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。

flipPageOrientation

boolean

可选。指示是否在此部分翻转 DocumentStyle 的 pageSize 的尺寸,以允许在纵向和横向之间切换页面方向。如果未设置,则该值将继承自 DocumentStyle 的 flipPageOrientation

更新此属性时,需要设置具体的值。取消设置此属性会导致 400 错误请求错误。

版块列属性

适用于部分列的属性。

JSON 表示法
{
  "width": {
    object (Dimension)
  },
  "paddingEnd": {
    object (Dimension)
  }
}
字段
width

object (Dimension)

仅供输出。列宽。

paddingEnd

object (Dimension)

列末尾的内边距。

ColumnSeparatorStyle

列之间的列分隔符的样式。

枚举
COLUMN_SEPARATOR_STYLE_UNSPECIFIED 未指定的列分隔符样式。
NONE 各列之间没有列分隔符。
BETWEEN_EACH_COLUMN 在每列之间渲染列分隔符。

SectionType

表示当前部分起始部分相对于上一部分的位置。

枚举
SECTION_TYPE_UNSPECIFIED 未指定区段类型。
CONTINUOUS 此部分的起始位置紧跟在上一段落的最后一个段落之后。
NEXT_PAGE 此部分从下一页开始。

表示表的 StructuralElement

JSON 表示法
{
  "rows": integer,
  "columns": integer,
  "tableRows": [
    {
      object (TableRow)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableStyle": {
    object (TableStyle)
  }
}
字段
rows

integer

表中的行数。

columns

integer

表中的列数。

表格可能不是矩形,因此某些行可能有不同数量的单元格。

tableRows[]

object (TableRow)

每行的内容和样式。

suggestedInsertionIds[]

string

建议的插入 ID。如果是嵌套建议的更改,Table 可能会有多个插入 ID。如果为空,则不建议插入。

suggestedDeletionIds[]

string

建议的删除 ID。如果为空,则表示没有建议删除此内容。

tableStyle

object (TableStyle)

表格的样式。

TableRow

Table 中行的内容和样式。

JSON 表示法
{
  "startIndex": integer,
  "endIndex": integer,
  "tableCells": [
    {
      object (TableCell)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "suggestedTableRowStyleChanges": {
    string: {
      object (SuggestedTableRowStyle)
    },
    ...
  }
}
字段
startIndex

integer

此行的起始索引(从零开始),采用 UTF-16 代码单元。

endIndex

integer

此行的结束索引(从零开始,不含边界值),采用 UTF-16 代码单元。

tableCells[]

object (TableCell)

此行中每个单元格的内容和样式。

表格可能不是矩形,因此某些行的单元格数量可能与同一表格中其他行的数量不同。

suggestedInsertionIds[]

string

建议的插入 ID。如果是嵌套建议的更改,TableRow 可能会有多个插入 ID。如果为空,则不建议插入。

suggestedDeletionIds[]

string

建议的删除 ID。如果为空,则表示没有建议删除此内容。

tableRowStyle

object (TableRowStyle)

表格行的样式。

suggestedTableRowStyleChanges

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

建议的样式更改此行,由建议 ID 键控。

TableCell

Table 中单元格的内容和样式。

JSON 表示法
{
  "startIndex": integer,
  "endIndex": integer,
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "suggestedTableCellStyleChanges": {
    string: {
      object (SuggestedTableCellStyle)
    },
    ...
  }
}
字段
startIndex

integer

此单元格的起始索引(从零开始),采用 UTF-16 代码单元。

endIndex

integer

此单元格的结束索引(从零开始,不含该索引),采用 UTF-16 代码单元。

content[]

object (StructuralElement)

单元格的内容。

tableCellStyle

object (TableCellStyle)

单元格的样式。

suggestedInsertionIds[]

string

建议的插入 ID。如果是嵌套建议的更改,TableCell 可能会有多个插入 ID。如果为空,则不建议插入。

suggestedDeletionIds[]

string

建议的删除 ID。如果为空,则表示没有建议删除此内容。

suggestedTableCellStyleChanges

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

建议的表格单元格样式更改,由建议 ID 键控。

TableCellStyle

TableCell 的样式。

继承的表格单元格样式在此消息中表示为未设置的字段。表格单元格样式可以沿用表格的样式。

JSON 表示法
{
  "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)
}
字段
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)

表格单元格中的内容对齐方式。默认对齐方式与文档编辑器中新建的表格单元格的对齐方式保持一致。

表格单元格边框

表格单元格周围的边框。

表格单元格的边框不能是透明的。若要隐藏表格单元格边框,请将宽度设为 0。

JSON 表示法
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
字段
color

object (OptionalColor)

边框的颜色。

此颜色不能是透明的。

width

object (Dimension)

边框的宽度。

dashStyle

enum (DashStyle)

边框的短划线样式。

内容对齐

内容对齐的类型。

派生自“ST_TextAnchoringType”简单类型的一个子集,可在“Office Open XML 文件格式 - 基础知识和标记语言参考”第 20.1.10.59 节(ECMA-376 第 4 版第 1 部分)中找到。

枚举
CONTENT_ALIGNMENT_UNSPECIFIED 未指定的内容对齐方式。内容对齐方式继承自父项(如果存在)。
CONTENT_ALIGNMENT_UNSUPPORTED 内容对齐方式不受支持。
TOP 一种对齐方式,用于将内容与内容容器的顶部对齐。对应于 ECMA-376 ST_TextAnchoringType 't'。
MIDDLE 一种对齐方式,可将内容与内容容器的中间对齐。对应于 ECMA-376 ST_TextAnchoringType“ctr”。
BOTTOM 一种对齐方式,用于将内容与内容容器的底部对齐。对应于 ECMA-376 ST_TextAnchoringType 'b'。

SuggestedTableCellStyle

建议的对 TableCellStyle 的更改。

JSON 表示法
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "tableCellStyleSuggestionState": {
    object (TableCellStyleSuggestionState)
  }
}
字段
tableCellStyle

object (TableCellStyle)

仅包含此建议中所做更改的 TableCellStyle。这可以与 tableCellStyleSuggestionState 结合使用,以查看哪些字段已更改以及它们的新值。

tableCellStyleSuggestionState

object (TableCellStyleSuggestionState)

一个掩码,用于指示此建议中基础 TableCellStyle 上的哪些字段已更改。

TableCellStyleSuggestionState

一个掩码,用于指示此建议中基础 TableCellStyle 上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

JSON 表示法
{
  "rowSpanSuggested": boolean,
  "columnSpanSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "paddingLeftSuggested": boolean,
  "paddingRightSuggested": boolean,
  "paddingTopSuggested": boolean,
  "paddingBottomSuggested": boolean,
  "contentAlignmentSuggested": boolean
}
字段
rowSpanSuggested

boolean

指示是否有对 rowSpan 的建议更改。

columnSpanSuggested

boolean

指示是否有对 columnSpan 的建议更改。

backgroundColorSuggested

boolean

指示是否有对 backgroundColor 的建议更改。

borderLeftSuggested

boolean

指示是否有对 borderLeft 的建议更改。

borderRightSuggested

boolean

指示是否有对 borderRight 的建议更改。

borderTopSuggested

boolean

指示是否有对 borderTop 的建议更改。

borderBottomSuggested

boolean

指示是否有对 borderBottom 的建议更改。

paddingLeftSuggested

boolean

指示是否有对 paddingLeft 的建议更改。

paddingRightSuggested

boolean

指示是否有对 paddingRight 的建议更改。

paddingTopSuggested

boolean

指示是否有对 paddingTop 的建议更改。

paddingBottomSuggested

boolean

指示是否有对 paddingBottom 的建议更改。

contentAlignmentSuggested

boolean

指示是否有对 contentAlignment 的建议更改。

TableRowStyle

应用于表格行的样式。

JSON 表示法
{
  "minRowHeight": {
    object (Dimension)
  },
  "tableHeader": boolean,
  "preventOverflow": boolean
}
字段
minRowHeight

object (Dimension)

行的最小高度。该行在文档编辑器中将以等于或大于此值的高度呈现,以便显示该行单元格中的所有内容。

tableHeader

boolean

行是否为表格标题。

preventOverflow

boolean

确定行不能跨越页面边界或跨列边界。

SuggestedTableRowStyle

建议的对 TableRowStyle 的更改。

JSON 表示法
{
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "tableRowStyleSuggestionState": {
    object (TableRowStyleSuggestionState)
  }
}
字段
tableRowStyle

object (TableRowStyle)

仅包含此建议中所做更改的 TableRowStyle。这可以与 tableRowStyleSuggestionState 结合使用,以查看哪些字段已更改以及它们的新值。

tableRowStyleSuggestionState

object (TableRowStyleSuggestionState)

一个掩码,用于指示此建议中基础 TableRowStyle 上的哪些字段已更改。

TableRowStyleSuggestionState

一个掩码,用于指示此建议中基础 TableRowStyle 上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

JSON 表示法
{
  "minRowHeightSuggested": boolean
}
字段
minRowHeightSuggested

boolean

指示是否有对 minRowHeight 的建议更改。

表格样式

应用于表格的样式。

JSON 表示法
{
  "tableColumnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}
字段
tableColumnProperties[]

object (TableColumnProperties)

每列的属性。

请注意,在 Google 文档中,表格包含行,行包含单元格,类似于 HTML。因此,您可以在该行的 tableRowStyle 中找到该行的属性。

TableColumnProperties

表格中列的属性。

JSON 表示法
{
  "widthType": enum (WidthType),
  "width": {
    object (Dimension)
  }
}
字段
widthType

enum (WidthType)

列的宽度类型。

width

object (Dimension)

列宽。当列的 widthTypeFIXED_WIDTH 时进行设置。

宽度类型

列宽的类型。

枚举
WIDTH_TYPE_UNSPECIFIED 未指定列宽类型。
EVENLY_DISTRIBUTED

列宽在其他均匀分布的列之间均匀分布。

列宽是自动确定的,在计算完具有指定宽度的所有列后,将与表格的剩余宽度相等。

FIXED_WIDTH 固定的列宽。[width][google.apps.docs.v1.TableColumnProperties.width 属性包含列的宽度。

目录

表示目录的 StructuralElement

JSON 表示法
{
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
字段
content[]

object (StructuralElement)

目录的内容。

suggestedInsertionIds[]

string

建议的插入 ID。如果是嵌套建议的更改,TableOfContents 可以有多个插入 ID。如果为空,则不建议插入。

suggestedDeletionIds[]

string

建议的删除 ID。如果为空,则表示没有建议删除此内容。

Footnote

文档脚注。

JSON 表示法
{
  "footnoteId": string,
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
字段
footnoteId

string

脚注的 ID。

content[]

object (StructuralElement)

脚注的内容。

脚注内容的索引从零开始。

DocumentStyle

文档的样式。

JSON 表示法
{
  "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
}
字段
background

object (Background)

文档的背景。文档不能有透明的背景颜色。

defaultHeaderId

string

默认标头的 ID。如果未设置,则没有默认标头。

此属性为只读属性。

evenPageHeaderId

string

仅用于偶数页的标题 ID。useEvenPageHeaderFooter 的值可决定是将 defaultHeaderId 还是此值用于偶数页的页眉。如果未设置,则没有偶数页页眉。

此属性为只读属性。

firstPageHeaderId

string

仅用于首页的标题 ID。如果未设置,则第一个页面的唯一页眉不存在。useFirstPageHeaderFooter 的值用于确定第一页页眉是使用 defaultHeaderId 还是此值。如果未设置,则没有首页页眉。

此属性为只读属性。

pageNumberStart

integer

开始计算页数的页码。

marginTop

object (Dimension)

上边距。

更新文档样式的上页外边距会清除所有版块样式的上外边距。

marginBottom

object (Dimension)

下边距。

更新文档样式的下页边距会清除所有版块样式的下边距。

marginRight

object (Dimension)

右页外边距。

更新文档样式的右侧页面外边距会清除所有版块样式的右侧页面外边距。还可能会导致列在所有版块中调整大小。

marginLeft

object (Dimension)

左侧页边距。

更新文档样式的左侧页面外边距会清除所有版块样式的左侧页面外边距。还可能会导致列在所有版块中调整大小。

pageSize

object (Size)

文档中一页的大小。

marginHeader

object (Dimension)

页面顶部和页眉内容之间的间距。

flipPageOrientation

boolean

可选。指示是否翻转 pageSize 的尺寸,以允许在纵向和横向之间切换页面方向。

背景

表示文档的背景。

JSON 表示法
{
  "color": {
    object (OptionalColor)
  }
}
字段
color

object (OptionalColor)

背景颜色。

大小

宽度和高度。

JSON 表示法
{
  "height": {
    object (Dimension)
  },
  "width": {
    object (Dimension)
  }
}
字段
height

object (Dimension)

对象的高度。

width

object (Dimension)

对象的宽度。

SuggestedDocumentStyle

建议的对 DocumentStyle 的更改。

JSON 表示法
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "documentStyleSuggestionState": {
    object (DocumentStyleSuggestionState)
  }
}
字段
documentStyle

object (DocumentStyle)

仅包含此建议中所做更改的 DocumentStyle。这可以与 documentStyleSuggestionState 结合使用,以查看哪些字段已更改以及它们的新值。

documentStyleSuggestionState

object (DocumentStyleSuggestionState)

一个掩码,用于指示此建议中基础 DocumentStyle 上的哪些字段已更改。

DocumentStyleSuggestionState

一个掩码,用于指示此建议中基础 DocumentStyle 上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

JSON 表示法
{
  "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
}
字段
backgroundSuggestionState

object (BackgroundSuggestionState)

一个掩码,用于指示此建议中 background 中的哪些字段已更改。

defaultHeaderIdSuggested

boolean

指示是否有对 defaultHeaderId 的建议更改。

evenPageHeaderIdSuggested

boolean

指示是否有对 evenPageHeaderId 的建议更改。

firstPageHeaderIdSuggested

boolean

指示是否有对 firstPageHeaderId 的建议更改。

pageNumberStartSuggested

boolean

指示是否有对 pageNumberStart 的建议更改。

marginTopSuggested

boolean

指示是否有对 marginTop 的建议更改。

marginBottomSuggested

boolean

指示是否有对 marginBottom 的建议更改。

marginRightSuggested

boolean

指示是否有对 marginRight 的建议更改。

marginLeftSuggested

boolean

指示是否有对 marginLeft 的建议更改。

pageSizeSuggestionState

object (SizeSuggestionState)

一个掩码,用于指示此建议中 [size] [google.apps.docs.v1.DocumentStyle.size] 中的哪些字段已更改。

marginHeaderSuggested

boolean

指示是否有对 marginHeader 的建议更改。

flipPageOrientationSuggested

boolean

可选。指示是否有对 flipPageOrientation 的建议更改。

BackgroundSuggestionState

一个掩码,用于指示此建议中基础 Background 上的哪些字段已更改。对于任何设置为 true 的字段,Backgound 都会使用一个新的建议值。

JSON 表示法
{
  "backgroundColorSuggested": boolean
}
字段
backgroundColorSuggested

boolean

指示此建议中是否已修改当前背景颜色。

SizeSuggestionState

一个掩码,用于指示此建议中基础 Size 上的哪些字段已更改。对于任何设置为 true 的字段,Size 都会使用一个新的建议值。

JSON 表示法
{
  "heightSuggested": boolean,
  "widthSuggested": boolean
}
字段
heightSuggested

boolean

指示是否有对 height 的建议更改。

widthSuggested

boolean

指示是否有对 width 的建议更改。

NamedStyles

已命名的样式。文档中的段落可以从这些已命名的样式继承其 TextStyleParagraphStyle

JSON 表示法
{
  "styles": [
    {
      object (NamedStyle)
    }
  ]
}
字段
styles[]

object (NamedStyle)

已命名的样式。

每个可能的 named style types 都有一个对应的条目。

命名样式

已命名的样式。当文档中的段落具有相同的命名样式类型时,可以从这个已命名的样式继承它们的 TextStyleParagraphStyle

JSON 表示法
{
  "namedStyleType": enum (NamedStyleType),
  "textStyle": {
    object (TextStyle)
  },
  "paragraphStyle": {
    object (ParagraphStyle)
  }
}
字段
namedStyleType

enum (NamedStyleType)

已命名的样式的类型。

textStyle

object (TextStyle)

此已命名样式的文本样式。

paragraphStyle

object (ParagraphStyle)

此已命名样式的段落样式。

SuggestedNamedStyles

建议的对 NamedStyles 的更改。

JSON 表示法
{
  "namedStyles": {
    object (NamedStyles)
  },
  "namedStylesSuggestionState": {
    object (NamedStylesSuggestionState)
  }
}
字段
namedStyles

object (NamedStyles)

仅包含此建议中所做更改的 NamedStyles。这可以与 namedStylesSuggestionState 结合使用,以查看哪些字段已更改以及它们的新值。

namedStylesSuggestionState

object (NamedStylesSuggestionState)

一个掩码,用于指示此建议中基础 NamedStyles 上的哪些字段已更改。

NamedStylesSuggestionState

NamedStyles 消息的建议状态。

JSON 表示法
{
  "stylesSuggestionStates": [
    {
      object (NamedStyleSuggestionState)
    }
  ]
}
字段
stylesSuggestionStates[]

object (NamedStyleSuggestionState)

一个掩码,用于指示此建议中 styles 中相应 NamedStyle 的哪些字段已更改。

这些已命名样式建议状态的顺序与 named styles 建议中相应已命名样式的顺序一致。

NamedStyleSuggestionState

NamedStyle 消息的建议状态。

JSON 表示法
{
  "namedStyleType": enum (NamedStyleType),
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
字段
namedStyleType

enum (NamedStyleType)

此建议状态对应的已命名样式类型。

提供此字段是为了便于将 NamedStyleSuggestionState 与其对应的 NamedStyle 进行匹配。

textStyleSuggestionState

object (TextStyleSuggestionState)

一个掩码,用于指示此建议中 text style 中的哪些字段已更改。

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

一个掩码,用于指示此建议中 paragraph style 中的哪些字段已更改。

列表

List 表示全属于同一列表的一组段落的列表属性。列表中的段落在其 bullet 中引用了列表 ID。

JSON 表示法
{
  "listProperties": {
    object (ListProperties)
  },
  "suggestedListPropertiesChanges": {
    string: {
      object (SuggestedListProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
字段
listProperties

object (ListProperties)

列表的属性。

suggestedListPropertiesChanges

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

对列表属性建议的更改,由建议 ID 键控。

suggestedInsertionId

string

建议的插入 ID。如果为空,则不建议插入。

suggestedDeletionIds[]

string

建议的删除 ID。如果为空,则表示此列表没有建议删除。

ListProperties

list 的属性,用于描述与列表相关联的段落所含的项目符号的外观和风格。

JSON 表示法
{
  "nestingLevels": [
    {
      object (NestingLevel)
    }
  ]
}
字段
nestingLevels[]

object (NestingLevel)

描述关联级别项目符号的属性。

一个列表最多包含 9 层嵌套,其中嵌套层 0 对应于最高层,嵌套层 8 对应于最高嵌套层。嵌套层按升序返回,最少的嵌套层最先返回。

嵌套级别

包含描述列表项目符号在指定嵌套级别的外观和风格的属性。

JSON 表示法
{
  "bulletAlignment": enum (BulletAlignment),
  "glyphFormat": string,
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "textStyle": {
    object (TextStyle)
  },
  "startNumber": integer,

  // Union field glyph_kind can be only one of the following:
  "glyphType": enum (GlyphType),
  "glyphSymbol": string
  // End of list of possible types for union field glyph_kind.
}
字段
bulletAlignment

enum (BulletAlignment)

在分配给渲染项目符号的空间内,项目符号的对齐方式。

glyphFormat

string

项目符号在此嵌套级别使用的格式字符串。

字形格式包含一个或多个占位符,系统会根据 glyphTypeglyphSymbol 将这些占位符替换为适当的值。占位符遵循 %[nestingLevel] 格式。此外,占位符还可以有前缀和后缀。因此,字形格式遵循 <prefix>%[nestingLevel]<suffix> 模式。请注意,前缀和后缀是可选的,可以是任意字符串。

例如,字形格式 %0. 表示,渲染的字形将使用嵌套级别 0 的相应字形替换占位符,后跟英文句点作为后缀。因此,嵌套级别为 0 且字形类型为 UPPER_ALPHA 且字形格式为 %0. 的列表将生成包含已渲染字形的列表

A.

B.

C.

字形格式可包含当前嵌套级别的占位符以及父级嵌套级别的占位符。例如,一个列表在嵌套级别为 0 时可以具有 %0. 字形格式,在嵌套级别 1 时可以具有字形格式 %0.%1.。假设两个嵌套级别都有 DECIMAL 字形类型,这会导致生成的列表包含渲染的字形

1.

2.

2.1.

2.2.

3.

对于有序的嵌套级别,在特定段落的字形格式中替换占位符的字符串取决于段落在列表中的顺序。

indentFirstLine

object (Dimension)

此嵌套级别中段落首行的缩进量。

indentStart

object (Dimension)

此嵌套级别的段落的缩进量。根据段落的内容方向,应用于与文本开头对应的一侧。

textStyle

object (TextStyle)

此嵌套级别的项目符号的文本样式。

startNumber

integer

此嵌套级别上第一个列表项的数量。

对于字母列表和罗马数字列表,值 0 会被视为值 1。如果值同时为 0 和 1,字母数字列表和罗马数字列表将从 ai 开始分别开始。

对于字形无序的嵌套级别,系统会忽略此值。

联合字段 glyph_kind。项目符号使用的字形。这定义了用于替换 glyph_format 中的占位符的项目符号。glyph_kind 只能是下列其中一项:
glyphType

enum (GlyphType)

在该嵌套级别对段落进行排序时,项目符号使用的字形类型。

字形类型决定了当此嵌套级别的段落按顺序排列时,用于替换 glyphFormat 中的占位符的字形类型。例如,如果嵌套级别为 0、glyphFormat%0. 且字形类型为 DECIMAL,那么渲染的字形会将字形格式中的占位符 %0 替换为一个与列表中列表项顺序对应的数字。

glyphSymbol

string

当该嵌套级别的段落无序时,项目符号会使用的自定义字形符号。

字形符号会替换 glyphFormat 中的占位符。例如,如果字形符号是与 Unicode U+25cf 代码点对应的实心圆形,且 glyphFormat%0,呈现的字形将为实心圆形。

项目符号对齐

项目符号的对齐类型。

枚举
BULLET_ALIGNMENT_UNSPECIFIED 未指定项目符号对齐方式。
START 项目符号会与用于呈现项目符号的空间的开头对齐。对于 LTR 文本,为左对齐,否则为右对齐。
CENTER 项目符号会与用于呈现项目符号的空间的中心对齐。
END 项目符号会与用于呈现项目符号的空间的末尾对齐。对于 LTR 文本,为右对齐,否则为左对齐。

字形类型

对处于此嵌套级别的段落进行排序时,项目符号使用的字形类型。

枚举
GLYPH_TYPE_UNSPECIFIED 字形类型未指定或不受支持。
NONE 一个空字符串。
DECIMAL 数字,如 123
ZERO_DECIMAL 个数以零为前缀的数字,如 010203。包含多个数字的数字不带零前缀。
UPPER_ALPHA 大写字母,例如 ABC
ALPHA 小写字母,例如 abc
UPPER_ROMAN 大写罗马数字,如 IIIIII
ROMAN 小写的罗马数字,如 iiiiii

SuggestedListProperties

建议对 ListProperties 进行更改。

JSON 表示法
{
  "listProperties": {
    object (ListProperties)
  },
  "listPropertiesSuggestionState": {
    object (ListPropertiesSuggestionState)
  }
}
字段
listProperties

object (ListProperties)

仅包含此建议中所做更改的 ListProperties。这可以与 listPropertiesSuggestionState 结合使用,以查看哪些字段已更改以及它们的新值。

listPropertiesSuggestionState

object (ListPropertiesSuggestionState)

一个掩码,用于指示此建议中基础 ListProperties 上的哪些字段已更改。

ListPropertiesSuggestionState

一个掩码,用于指示此建议中基础 ListProperties 上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

JSON 表示法
{
  "nestingLevelsSuggestionStates": [
    {
      object (NestingLevelSuggestionState)
    }
  ]
}
字段
nestingLevelsSuggestionStates[]

object (NestingLevelSuggestionState)

一个掩码,用于指示此建议中 nestingLevels 中相应 NestingLevel 的哪些字段已更改。

嵌套级别建议状态按嵌套级别升序返回,最少的嵌套首先返回。

NestingLevelSuggestionState

一个掩码,用于指示此建议中基础 NestingLevel 上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

JSON 表示法
{
  "bulletAlignmentSuggested": boolean,
  "glyphTypeSuggested": boolean,
  "glyphFormatSuggested": boolean,
  "glyphSymbolSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "startNumberSuggested": boolean
}
字段
bulletAlignmentSuggested

boolean

指示是否有对 bulletAlignment 的建议更改。

glyphTypeSuggested

boolean

指示是否有对 glyphType 的建议更改。

glyphFormatSuggested

boolean

指示是否有对 glyphFormat 的建议更改。

glyphSymbolSuggested

boolean

指示是否有对 glyphSymbol 的建议更改。

indentFirstLineSuggested

boolean

指示是否有对 indentFirstLine 的建议更改。

indentStartSuggested

boolean

指示是否有对 indentStart 的建议更改。

textStyleSuggestionState

object (TextStyleSuggestionState)

一个掩码,用于指示此建议中 text style 中的哪些字段已更改。

startNumberSuggested

boolean

指示是否有对 startNumber 的建议更改。

命名的范围

文档中共用给定名称的所有 NamedRange 的集合。

JSON 表示法
{
  "name": string,
  "namedRanges": [
    {
      object (NamedRange)
    }
  ]
}
字段
name

string

所有 named ranges 共用的名称。

namedRanges[]

object (NamedRange)

使用相同名称的 NamedRange

命名的范围

具有相同命名范围 ID 的 Range 集合。

借助命名的范围,开发者可以将文档的各个部分与用户定义的任意标签相关联,以便日后通过编程方式读取或修改其内容。文档可以包含多个同名的命名范围,但每个命名范围都具有唯一 ID。

命名范围是使用单个 Range 创建的,在命名范围内插入的内容通常会扩展该范围。不过,某些文档更改可能会导致相应范围被拆分为多个范围。

命名的范围不是私有范围。有权访问该文档的所有应用和协作者都可以看到其命名的范围。

JSON 表示法
{
  "namedRangeId": string,
  "name": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
字段
namedRangeId

string

命名范围的 ID。

name

string

命名的范围的名称。

ranges[]

object (Range)

属于此命名范围的范围。

范围

指定连续的文本范围。

JSON 表示法
{
  "segmentId": string,
  "startIndex": integer,
  "endIndex": integer
}
字段
segmentId

string

此范围包含的页眉、页脚或脚注的 ID。空的细分 ID 表示文档的正文。

startIndex

integer

此范围的起始索引(从零开始),采用 UTF-16 代码单元。

在目前的所有用途中,都必须提供起始索引。此字段是一个 Int32Value,旨在适应未来具有开放式范围的用例。

endIndex

integer

此范围的结束索引(从零开始),不含边界值,采用 UTF-16 代码单元。

在目前的所有用途中,都必须提供结束索引。此字段是一个 Int32Value,旨在适应未来具有开放式范围的用例。

建议视图模式

应用于文档的建议视图模式,用于指示如何表示建议的更改。它提供阅读文档的选项,其中包含内嵌、已接受或已拒绝的所有建议。

枚举
DEFAULT_FOR_CURRENT_ACCESS 应用于返回的文档的建议查看模式取决于用户当前的访问权限级别。如果用户只有查看权限,系统会应用 PREVIEW_WITHOUT_SUGGESTIONS。否则,应用 SUGGESTIONS_INLINE。这是默认的建议视图模式。
SUGGESTIONS_INLINE

返回的文档中含有内嵌建议。建议的更改会与文档中的基本内容区分开来。

如果用户无权查看建议的更改,那么使用此模式检索文档的请求将返回 403 错误。

PREVIEW_SUGGESTIONS_ACCEPTED

返回的是预览文档,其中接受了所有建议的更改。

如果用户无权查看建议的更改,那么使用此模式检索文档的请求将返回 403 错误。

PREVIEW_WITHOUT_SUGGESTIONS 返回的文档是预览,如果文档中有任何建议,所有建议的更改都会被拒绝。

InlineObject

内嵌文本的对象。InlineObject 包含图像等 EmbeddedObject

JSON 表示法
{
  "objectId": string,
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "suggestedInlineObjectPropertiesChanges": {
    string: {
      object (SuggestedInlineObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
字段
objectId

string

此内嵌对象的 ID。可用于更新对象的属性。

inlineObjectProperties

object (InlineObjectProperties)

此内嵌对象的属性。

suggestedInlineObjectPropertiesChanges

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

对内嵌对象属性建议的更改,由建议 ID 键控。

suggestedInsertionId

string

建议的插入 ID。如果为空,则不建议插入。

suggestedDeletionIds[]

string

建议的删除 ID。如果为空,则表示没有建议删除此内容。

InlineObjectProperties

InlineObject 的属性。

JSON 表示法
{
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
字段
embeddedObject

object (EmbeddedObject)

此内嵌对象的嵌入对象。

EmbeddedObject

文档中的嵌入式对象。

JSON 表示法
{
  "title": string,
  "description": string,
  "embeddedObjectBorder": {
    object (EmbeddedObjectBorder)
  },
  "size": {
    object (Size)
  },
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "linkedContentReference": {
    object (LinkedContentReference)
  },

  // Union field properties can be only one of the following:
  "embeddedDrawingProperties": {
    object (EmbeddedDrawingProperties)
  },
  "imageProperties": {
    object (ImageProperties)
  }
  // End of list of possible types for union field properties.
}
字段
title

string

嵌入对象的标题。结合使用 titledescription 来显示替代文本。

description

string

嵌入对象的说明。结合使用 titledescription 来显示替代文本。

embeddedObjectBorder

object (EmbeddedObjectBorder)

嵌入对象的边框。

size

object (Size)

剪裁后图片的可见大小。

marginTop

object (Dimension)

嵌入对象的上外边距。

marginBottom

object (Dimension)

嵌入对象的下外边距。

marginRight

object (Dimension)

嵌入对象的右外边距。

marginLeft

object (Dimension)

嵌入对象的左外边距。

linkedContentReference

object (LinkedContentReference)

对外部链接的源内容的引用。例如,当嵌入的对象是链接的图表时,此引用会包含对 Google 表格源图表的引用。

如果未设置,则系统不会链接嵌入的对象。

联合字段 properties。每个嵌入对象类型特有的属性。properties 只能是下列其中一项:
embeddedDrawingProperties

object (EmbeddedDrawingProperties)

嵌入的绘图的属性。

imageProperties

object (ImageProperties)

图像的属性。

EmbeddedDrawingProperties

此类型没有任何字段。

嵌入绘图的属性,用于区分对象类型。嵌入的绘图是在文档中创建的绘图。请注意,不支持宽泛的详细信息。

ImageProperties

图像的属性。

JSON 表示法
{
  "contentUri": string,
  "sourceUri": string,
  "brightness": number,
  "contrast": number,
  "transparency": number,
  "cropProperties": {
    object (CropProperties)
  },
  "angle": number
}
字段
contentUri

string

默认生命周期为 30 分钟的图片的 URI。此 URI 使用请求者的帐号进行标记。拥有该 URI 的任何人都能以原始请求者的身份有效访问该图片。如果文档的共享设置发生变化,您可能会失去对图片的访问权限。

sourceUri

string

源 URI 是用于插入图片的 URI。来源 URI 可以为空。

brightness

number

图片的亮度效果。该值应在 [-1.0, 1.0] 的范围内,其中 0 表示无任何影响。

contrast

number

图片的对比度效果。该值应在 [-1.0, 1.0] 的范围内,其中 0 表示无任何影响。

transparency

number

图片的透明度效果。该值应在 [0.0, 1.0] 的范围内,其中 0 表示无效果,1 表示透明。

cropProperties

object (CropProperties)

图片的剪裁属性。

angle

number

图片的顺时针旋转角度,以弧度表示。

CropProperties

图片的剪裁属性。

剪裁矩形使用相对于原始内容的 4 条边缘的小数偏移来表示。

  • 如果偏移量在间隔 (0, 1) 内,则剪裁矩形的对应边缘将位于图片的原始边界矩形内部。
  • 如果偏移量为负或大于 1,则剪裁矩形的相应边缘将位于图片的原始边界矩形之外。
  • 如果所有偏移和旋转角度均为 0,则图片不会被剪裁。
JSON 表示法
{
  "offsetLeft": number,
  "offsetRight": number,
  "offsetTop": number,
  "offsetBottom": number,
  "angle": number
}
字段
offsetLeft

number

偏移指定剪裁矩形左侧边缘与原始内容左边缘之间的距离,以原始内容宽度的比例的形式表示。

offsetRight

number

偏移指定剪裁矩形右边缘与原始内容右边缘之间的距离,以原始内容宽度的比例的形式表示。

offsetTop

number

偏移指定剪裁矩形上边缘与原始内容上边缘之间的距离,以原始内容高度的比例的形式表示。

offsetBottom

number

偏移指定剪裁矩形底部边缘与原始内容下边缘之间的距离,以原始内容高度的比例表示。

angle

number

剪裁矩形围绕其中心的顺时针旋转角度(以弧度表示)。旋转后应用偏移。

EmbeddedObjectBorder

EmbeddedObject 周围的边框。

JSON 表示法
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle),
  "propertyState": enum (PropertyState)
}
字段
color

object (OptionalColor)

边框的颜色。

width

object (Dimension)

边框的宽度。

dashStyle

enum (DashStyle)

边框的短划线样式。

propertyState

enum (PropertyState)

边框属性的属性状态。

属性状态

房源可能所处的状态。

枚举
RENDERED 如果某个属性的状态为 RENDERED,则该元素在文档中呈现时具有对应的属性。这是默认值。
NOT_RENDERED 如果某个属性的状态为 NOT_RENDERED,则此元素在文档中呈现时不会有相应的属性。

LinkedContentReference

对外部链接的源内容的引用。

JSON 表示法
{

  // Union field reference can be only one of the following:
  "sheetsChartReference": {
    object (SheetsChartReference)
  }
  // End of list of possible types for union field reference.
}
字段
联合字段 reference。特定于链接内容类型的参考文件。reference 只能是下列其中一项:
sheetsChartReference

object (SheetsChartReference)

对链接的图表的引用。

表格图表参考

对嵌入 Google 表格的链接图表的引用。

JSON 表示法
{
  "spreadsheetId": string,
  "chartId": integer
}
字段
spreadsheetId

string

包含源图表的 Google 表格电子表格的 ID。

chartId

integer

嵌入的 Google 表格电子表格中特定图表的 ID。

SuggestedInlineObjectProperties

建议对 InlineObjectProperties 进行更改。

JSON 表示法
{
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "inlineObjectPropertiesSuggestionState": {
    object (InlineObjectPropertiesSuggestionState)
  }
}
字段
inlineObjectProperties

object (InlineObjectProperties)

仅包含此建议中所做更改的 InlineObjectProperties。这可以与 inlineObjectPropertiesSuggestionState 结合使用,以查看哪些字段已更改以及它们的新值。

inlineObjectPropertiesSuggestionState

object (InlineObjectPropertiesSuggestionState)

一个掩码,用于指示此建议中基础 InlineObjectProperties 上的哪些字段已更改。

InlineObjectPropertiesSuggestionState

一个掩码,用于指示此建议中基础 InlineObjectProperties 上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

JSON 表示法
{
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
字段
embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

一个掩码,用于指示此建议中 embeddedObject 中的哪些字段已更改。

EmbeddedObjectSuggestionState

一个掩码,用于指示此建议中基础 EmbeddedObject 上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

JSON 表示法
{
  "embeddedDrawingPropertiesSuggestionState": {
    object (EmbeddedDrawingPropertiesSuggestionState)
  },
  "imagePropertiesSuggestionState": {
    object (ImagePropertiesSuggestionState)
  },
  "titleSuggested": boolean,
  "descriptionSuggested": boolean,
  "embeddedObjectBorderSuggestionState": {
    object (EmbeddedObjectBorderSuggestionState)
  },
  "sizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginLeftSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "linkedContentReferenceSuggestionState": {
    object (LinkedContentReferenceSuggestionState)
  }
}
字段
embeddedDrawingPropertiesSuggestionState

object (EmbeddedDrawingPropertiesSuggestionState)

一个掩码,用于指示此建议中 embeddedDrawingProperties 中的哪些字段已更改。

imagePropertiesSuggestionState

object (ImagePropertiesSuggestionState)

一个掩码,用于指示此建议中 imageProperties 中的哪些字段已更改。

titleSuggested

boolean

指示是否有对 title 的建议更改。

descriptionSuggested

boolean

指示是否有对 description 的建议更改。

embeddedObjectBorderSuggestionState

object (EmbeddedObjectBorderSuggestionState)

一个掩码,用于指示此建议中 embeddedObjectBorder 中的哪些字段已更改。

sizeSuggestionState

object (SizeSuggestionState)

一个掩码,用于指示此建议中 size 中的哪些字段已更改。

marginLeftSuggested

boolean

指示是否有对 marginLeft 的建议更改。

marginRightSuggested

boolean

指示是否有对 marginRight 的建议更改。

marginTopSuggested

boolean

指示是否有对 marginTop 的建议更改。

marginBottomSuggested

boolean

指示是否有对 marginBottom 的建议更改。

linkedContentReferenceSuggestionState

object (LinkedContentReferenceSuggestionState)

一个掩码,用于指示此建议中 linkedContentReference 中的哪些字段已更改。

EmbeddedDrawingPropertiesSuggestionState

此类型没有任何字段。

一个掩码,用于指示此建议中基础 EmbeddedDrawingProperties 上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

ImagePropertiesSuggestionState

一个掩码,用于指示此建议中基础 ImageProperties 上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

JSON 表示法
{
  "contentUriSuggested": boolean,
  "sourceUriSuggested": boolean,
  "brightnessSuggested": boolean,
  "contrastSuggested": boolean,
  "transparencySuggested": boolean,
  "cropPropertiesSuggestionState": {
    object (CropPropertiesSuggestionState)
  },
  "angleSuggested": boolean
}
字段
contentUriSuggested

boolean

指示是否有对 contentUri 的建议更改。

sourceUriSuggested

boolean

指示 [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri] 是否有建议更改。

brightnessSuggested

boolean

指示是否建议更改 [亮度] [google.apps.docs.v1.EmbeddedObject.brightness]。

contrastSuggested

boolean

指示是否有建议对 [contrast] [google.apps.docs.v1.EmbeddedObject.contrast] 进行更改。

transparencySuggested

boolean

指明是否有建议对 [transparency] [google.apps.docs.v1.EmbeddedObject.transparency] 进行更改。

cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

一个掩码,用于指示此建议中 cropProperties 中的哪些字段已更改。

angleSuggested

boolean

指示 [angle] [google.apps.docs.v1.EmbeddedObject.angle] 是否有建议更改。

CropPropertiesSuggestionState

一个掩码,用于指示此建议中基础 CropProperties 上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

JSON 表示法
{
  "offsetLeftSuggested": boolean,
  "offsetRightSuggested": boolean,
  "offsetTopSuggested": boolean,
  "offsetBottomSuggested": boolean,
  "angleSuggested": boolean
}
字段
offsetLeftSuggested

boolean

指示是否有对 offsetLeft 的建议更改。

offsetRightSuggested

boolean

指示是否有对 offsetRight 的建议更改。

offsetTopSuggested

boolean

指示是否有对 offsetTop 的建议更改。

offsetBottomSuggested

boolean

指示是否有对 offsetBottom 的建议更改。

angleSuggested

boolean

指示是否有对 angle 的建议更改。

EmbeddedObjectBorderSuggestionState

一个掩码,用于指示此建议中基础 EmbeddedObjectBorder 上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

JSON 表示法
{
  "colorSuggested": boolean,
  "widthSuggested": boolean,
  "dashStyleSuggested": boolean,
  "propertyStateSuggested": boolean
}
字段
colorSuggested

boolean

指示是否建议对 [color] [google.apps.docs.v1.EmbeddedBorderObject.color] 进行更改。

widthSuggested

boolean

指示是否建议对 [width] [google.apps.docs.v1.EmbeddedBorderObject.width] 进行更改。

dashStyleSuggested

boolean

指示 [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style] 是否有建议的更改。

propertyStateSuggested

boolean

指示 [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state] 是否有建议的更改。

LinkedContentReferenceSuggestionState

一个掩码,用于指示此建议中基础 LinkedContentReference 上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

JSON 表示法
{
  "sheetsChartReferenceSuggestionState": {
    object (SheetsChartReferenceSuggestionState)
  }
}
字段
sheetsChartReferenceSuggestionState

object (SheetsChartReferenceSuggestionState)

一个掩码,用于指示此建议中 sheetsChartReference 中的哪些字段已更改。

表格图表参考建议状态

一个掩码,用于指示此建议中基础 SheetsChartReference 上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

JSON 表示法
{
  "spreadsheetIdSuggested": boolean,
  "chartIdSuggested": boolean
}
字段
spreadsheetIdSuggested

boolean

指示是否有对 spreadsheetId 的建议更改。

chartIdSuggested

boolean

指示是否有对 chartId 的建议更改。

PositionedObject

绑定到 Paragraph 且相对于段落开头的位置的对象。PositionedObject 包含图像等 EmbeddedObject

JSON 表示法
{
  "objectId": string,
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "suggestedPositionedObjectPropertiesChanges": {
    string: {
      object (SuggestedPositionedObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
字段
objectId

string

已定位的对象的 ID。

positionedObjectProperties

object (PositionedObjectProperties)

此已定位对象的属性。

suggestedPositionedObjectPropertiesChanges

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

对已定位对象属性的建议更改,由建议 ID 键控。

suggestedInsertionId

string

建议的插入 ID。如果为空,则不建议插入。

suggestedDeletionIds[]

string

建议的删除 ID。如果为空,则表示没有建议删除此内容。

PositionedObjectProperties

PositionedObject 的属性。

JSON 表示法
{
  "positioning": {
    object (PositionedObjectPositioning)
  },
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
字段
positioning

object (PositionedObjectPositioning)

此定位对象相对于引用此定位对象的 Paragraph 换行符的定位。

embeddedObject

object (EmbeddedObject)

已定位的对象的嵌入对象。

PositionedObjectPositioning

PositionedObject 的定位。定位的对象会定位到与其绑定的 Paragraph 的开头。

JSON 表示法
{
  "layout": enum (PositionedObjectLayout),
  "leftOffset": {
    object (Dimension)
  },
  "topOffset": {
    object (Dimension)
  }
}
字段
layout

enum (PositionedObjectLayout)

此放置对象的布局。

leftOffset

object (Dimension)

已定位对象的左边缘相对于与其共享到的 Paragraph 的起始位置的偏移量。对象的确切位置可能取决于文档中的其他信息以及文档的样式。

topOffset

object (Dimension)

已定位对象的上边缘相对于与其绑定的 Paragraph 的起始位置的偏移量。对象的确切位置可能取决于文档中的其他信息以及文档的样式。

PositionedObjectLayout

[PositionedObject][google.aps.docs.v1.PositionedObject] 的可能布局。

枚举
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED 未指定布局。
WRAP_TEXT 文本环绕放置的对象。
BREAK_LEFT 拆分文本,使定位的对象位于左侧,文本位于右侧。
BREAK_RIGHT 拆分文本,使定位的对象位于右侧,文本位于左侧。
BREAK_LEFT_RIGHT 拆分文本,使定位对象的左侧或右侧没有文本。
IN_FRONT_OF_TEXT 定位的对象位于文本前面。
BEHIND_TEXT 定位的对象位于文本后面。

SuggestedPositionedObjectProperties

建议对 PositionedObjectProperties 进行更改。

JSON 表示法
{
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "positionedObjectPropertiesSuggestionState": {
    object (PositionedObjectPropertiesSuggestionState)
  }
}
字段
positionedObjectProperties

object (PositionedObjectProperties)

仅包含此建议中所做更改的 PositionedObjectProperties。这可以与 positionedObjectPropertiesSuggestionState 结合使用,以查看哪些字段已更改以及它们的新值。

positionedObjectPropertiesSuggestionState

object (PositionedObjectPropertiesSuggestionState)

一个掩码,用于指示此建议中基础 PositionedObjectProperties 上的哪些字段已更改。

PositionedObjectPropertiesSuggestionState

一个掩码,用于指示此建议中基础 PositionedObjectProperties 上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

JSON 表示法
{
  "positioningSuggestionState": {
    object (PositionedObjectPositioningSuggestionState)
  },
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
字段
positioningSuggestionState

object (PositionedObjectPositioningSuggestionState)

一个掩码,用于指示此建议中 positioning 中的哪些字段已更改。

embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

一个掩码,用于指示此建议中 embeddedObject 中的哪些字段已更改。

PositionedObjectPositioningSuggestionState

一个掩码,用于指示此建议中基础 PositionedObjectPositioning 上的哪些字段已更改。对于任何设置为 true 的字段,系统都会提供一个新的建议值。

JSON 表示法
{
  "layoutSuggested": boolean,
  "leftOffsetSuggested": boolean,
  "topOffsetSuggested": boolean
}
字段
layoutSuggested

boolean

指示是否有对 layout 的建议更改。

leftOffsetSuggested

boolean

指示是否有对 leftOffset 的建议更改。

topOffsetSuggested

boolean

指示是否有对 topOffset 的建议更改。

方法

batchUpdate

对文档应用一个或多个更新。

create

使用请求中指定的标题创建空白文档。

get

获取指定文档的最新版本。