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 键控。

Paragraph 元素

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)

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

文本运行

一个 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

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

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

如果文本样式并非继承自父项,那么取消设置字段会使样式还原为与文档编辑器中的默认设置相匹配的值。

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 颜色值。

RgbColor

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 英寸。

加权字体系列

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

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

string

文本的字体系列。

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

weight

integer

字体粗细。此字段的值可以是 100900(含)之间的 100 的倍数。此范围对应于 CSS 2.1 规范第 15.6 节中所述的数值,但不允许使用非数字值。

默认值为 400(“正常”)。

字体粗细只是所渲染字体粗细的一个组件。在考虑继承之后,weight 与文本样式的已解析 bold 值的组合决定了呈现的权重:

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

基准偏移量

文本可通过垂直位置偏离正常位置的方式。

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

建议的文本样式

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)

此 AutoText 的文本样式。

suggestedTextStyleChanges

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

建议的文本样式更改为此 AutoText,由建议 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。如果为空,则表示没有建议删除此内容。

内嵌对象

包含 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 的属性。此字段始终存在。

人物属性

关联的 Person 专用的属性。

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

string

仅供输出。用户的姓名(如果显示在链接文字中),而非用户的电子邮件地址)。

email

string

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

富媒体链接属性

特定于 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 请求错误。

已命名样式类型

已命名样式的类型。

枚举
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 段落已两端对齐。

ContentDirection

内容可在其中流入。

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

间距模式

段落间距的不同模式。

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

段落边框

段落周围的边框。

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)

边框的短划线样式。

虚线样式

能够渲染线性几何图形的短划线的类型。这些值基于“Office Open XML 文件格式 - 基础和标记语言参考”第 20.1.10.48 节中描述的“ST_PresetLineDashVal”简单类型,ECMA-376 第 4 版

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

Tab 键

段落内按制表符停止。

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)

此段落阴影的背景颜色。

建议的段落样式

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 上的哪些字段。

列表建议状态

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

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

boolean

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

nestingLevelSuggested

boolean

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

textStyleSuggestionState

object (TextStyleSuggestionState)

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

ObjectReference

对象 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
}
字段
columnProperties[]

object (SectionColumnProperties)

部分的列属性。

如果为空,此部分会包含一个列,其中包含文档编辑器中的默认属性。可以将部分更新为不超过 3 列。

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

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。更新后,useCustomHeaderFooterMargins 在 DocumentStyle 上设置为 true。DocumentStyle 上 useCustomHeaderFooterMargins 的值表示该部分是否遵循了标题外边距。

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

sectionType

enum (SectionType)

仅供输出。区段类型。

defaultHeaderId

string

默认标头的 ID。如果未设置,则值继承自之前的 SectionBreak's SectionStyle。如果在第一个 SectionBreak 中未设置该值,则它会从 DocumentStyle 的 defaultHeaderId 继承。

此属性处于只读状态。

firstPageHeaderId

string

此版块第一页中使用的标头 ID。如果 useFirstPageHeaderFooter 为 true,则将在此部分的首页上使用此值。如果值为 false,该版块第一页上的标题会使用 defaultHeaderId。如果未设置,则值继承自之前的 SectionBreak's SectionStyle。如果在第一个 SectionBreak 中未设置该值,则它会从 DocumentStyle 的 firstPageHeaderId 继承。

此属性处于只读状态。

evenPageHeaderId

string

仅用于偶数页的标头的 ID。如果 DocumentStyle 的 useEvenPageHeaderFooter 的值为 true,则此值对该部分的偶数页标头使用。如果值为 false,则偶数页的标头会使用 defaultHeaderId。如果未设置,则值继承自之前的 SectionBreak's SectionStyle。如果在第一个 SectionBreak 中未设置该值,则它会从 DocumentStyle 的 evenPageHeaderId 继承。

此属性处于只读状态。

pageNumberStart

integer

此部分要开始统计的页数。如果此政策未设置,系统会按照上一部分中的页面编号继续。如果您在第一个 SectionBreak 中未设置该值,请参阅 DocumentStyle 的 pageNumberStart

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

部分列属性

应用于部分列的属性。

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

object (Dimension)

仅供输出。列的宽度。

paddingEnd

object (Dimension)

列末尾的内边距。

ColumnSeparatorStyles

列之间的分隔线样式。

枚举
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 键控。

表格单元格样式

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

单元格的列 span。

此属性处于只读状态。

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)

边框的短划线样式。

ContentAlign

内容对齐类型。

源自“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'。

建议的表格单元格样式

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 建议的更改。

表行样式

应用于表格行的样式。

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

object (Dimension)

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

tableHeader

boolean

行是否是表格标题。

preventOverflow

boolean

行是否无法跨页或列边界溢出。

建议的表行样式

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)

每列的属性。

请注意,在文档中,表包含行,而行包含单元格,类似于 HTML。因此,可以在一个行的 tableRowStyle 上找到某个行的属性。

表列属性

表中列的属性。

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
}
字段
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)

页面顶部与标题内容之间的间距。

背景

表示文档的背景。

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

object (OptionalColor)

背景颜色。

大小

宽度和高度。

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

object (Dimension)

对象的高度。

width

object (Dimension)

对象的宽度。

建议的文档样式

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
}
字段
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 建议的更改。

BackgroundSuggestionState

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

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

boolean

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

SizeSuggestionState

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

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

boolean

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

widthSuggested

boolean

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

已命名样式

已命名的样式。文档中的段落可以继承这些已命名样式的 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)

此命名样式的段落样式。

建议的名称样式

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 中的哪些字段已更改。

列表

列表代表一组属于同一列表的段落的列表属性。属于列表的段落会在其 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 字形,后跟一个英文句点作为后缀。因此,若字形类型为 UPPER_ALPHA 且字形格式为 %0. 且嵌套级别为 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 中的占位符。例如,如果 glyphSymbol 是与 Unicode U+25cf 代码点对应的实心圆,并且 glyphFormat%0,渲染的字形将是实心圆。

项目符号对齐方式

项目符号的对齐类型。

枚举
BULLET_ALIGNMENT_UNSPECIFIED 项目符号对齐方式未指定。
START 项目符号与所分配用于渲染项目符号的空间开头一致。对于 LTR 文本,则为左对齐;否则为右对齐。
CENTER 项目符号会分配到分配到项目列表的空间。
END 项目符号会分配到分配到渲染项目符号的空间末尾。对于 LTR 文本,则为右对齐;否则为左对齐。

字形

按此嵌套级别段落中的项目符号排序时,项目符号使用的字形类型。

枚举
GLYPH_TYPE_UNSPECIFIED 字形类型未指定或不受支持。
NONE 一个空字符串。
DECIMAL 数字,例如 123
ZERO_DECIMAL 数字前面带有一个零的数字,例如 010203。位数超过 1 的数字不带前缀“0”。
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 对返回的文档应用建议的 ViewViewMode 取决于用户当前的访问权限级别。如果用户仅拥有查看权限,则系统会应用 PREVIEW_WITHOUT_SUGGESTIONS。否则,应用 SUGGESTIONS_INLINE。这是默认的建议视图模式。
SUGGESTIONS_INLINE

返回的文档内嵌了建议。建议的更改将与文档中的基础内容区分开来。

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

PREVIEW_SUGGESTIONS_ACCEPTED

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

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

PREVIEW_WITHOUT_SUGGESTIONS 返回的文档是一个预览,其中的所有建议更改都会被拒绝,前提是文档中有任何建议。

内嵌对象

内嵌文本的对象。内嵌对象包含图片等 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。如果为空,则表示没有建议删除此内容。

内嵌对象属性

InlineObject 的属性。

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

object (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)

图片的属性。

嵌入式绘图属性

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

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

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

剪裁属性

图片的剪裁属性。

剪裁矩形使用从原始内容 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

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

嵌入式对象边框

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 中的哪些字段已更改。

嵌入式对象建议状态

一个掩码,用于指示在此建议中更改了基础 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 中的哪些字段已更改。

嵌入式绘图属性建议状态

一个掩码,用于指示在此建议中更改了基础 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.EmbedObject.source_uri] 的建议更改。

brightnessSuggested

boolean

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

contrastSuggested

boolean

表示是否有建议更改 [对比度] [google.apps.docs.v1.EmbedObject.contrast]。

transparencySuggested

boolean

指示 [透明度] [google.apps.docs.v1.EmbedObject.transparency] 是否有建议的更改。

cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

一个掩码,用于表示 cropProperties 中的哪些字段已更改。

angleSuggested

boolean

表示建议对 [角度] [google.apps.docs.v1.EmbedObject.angle] 进行更改。

剪裁属性建议状态

一个掩码,用于指示在此建议中更改了基础 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 建议的更改。

嵌入式对象边界建议状态

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

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

boolean

表示建议不要对 [color] [google.apps.docs.v1.EmbedBorderObject.color] 进行更改。

widthSuggested

boolean

表示建议将 [宽度] [google.apps.docs.v1.EmbedBorderObject.width] 更改。

dashStyleSuggested

boolean

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

propertyStateSuggested

boolean

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

LinkedContentReferenceSuggestionState

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

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

object (SheetsChartReferenceSuggestionState)

一个掩码,用于表示 sheetsChartReference 中的哪些字段已更改。

SheetsChartReferenceSuggestionState

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

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

boolean

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

chartIdSuggested

boolean

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

定位对象

共享到 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

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