REST Resource: documents

資源：Document

Google 文件。

JSON 表示法 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "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)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
欄位
documentId

string

僅供輸出。文件 ID。
title

string

文件的標題。
tabs[]

object (Tab)

文件中的分頁。

分頁可以包含子分頁，也就是位於另一個分頁中的分頁。子分頁以 Tab.childTabs 欄位表示。
revisionId

string

僅供輸出。文件的修訂版本 ID。可在更新要求中使用，用於指定要套用更新的文件修訂版本，以及如果文件在該修訂版本之後經過編輯，要求應如何運作。只有在使用者俱備文件編輯權限時，才會填入資料。

修訂版本 ID 不是序號，而是不透明字串。修訂版本 ID 的格式可能會隨時間變更。系統傳回的修訂版本 ID 只保證在傳回後的 24 小時內有效，且無法跨使用者共用。如果兩次呼叫之間的修訂版本 ID 維持不變，則文件並未變更。相反地，如果 ID 變更 (適用於相同文件和使用者)，通常代表文件已經更新。不過，ID 變更也可能是因為 ID 格式變更等內部因素造成。
suggestionsViewMode

enum (SuggestionsViewMode)

僅供輸出。套用至文件的建議檢視模式。

注意：編輯文件時，請務必根據具有 SUGGESTIONS_INLINE 的文件，進行變更。
body

object (Body)

僅供輸出。文件的主要內容。

舊版欄位：請改用 Document.tabs.documentTab.body，當 includeTabsContent 參數設為 true 時，這會顯示所有分頁的實際文件內容。如果為 false 或未設定，則此欄位會包含文件中第一個分頁的相關資訊。
headers

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

僅供輸出。文件中的標頭，並以標頭 ID 做為索引鍵。

舊版欄位：請改用 Document.tabs.documentTab.headers，當 includeTabsContent 參數設為 true 時，這會顯示所有分頁的實際文件內容。如果設為 false 或未設定，則這個欄位會包含文件中第一個分頁的相關資訊。
footers

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

僅供輸出。文件中的頁尾，以頁尾 ID 做為索引鍵。

舊版欄位：請改用 Document.tabs.documentTab.footers，這會在 includeTabsContent 參數設為 true 時，公開所有分頁中的實際文件內容。如果為 false 或未設定，則此欄位會包含文件中第一個分頁的相關資訊。
footnotes

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

僅供輸出。文件中的註腳，以註腳 ID 做為索引鍵。

舊版欄位：請改用 Document.tabs.documentTab.footnotes，當 includeTabsContent 參數設為 true 時，這會顯示所有分頁的實際文件內容。如果為 false 或未設定，則此欄位會包含文件中第一個分頁的相關資訊。
documentStyle

object (DocumentStyle)

僅供輸出。文件樣式。

舊版欄位：請改用 Document.tabs.documentTab.documentStyle，當 includeTabsContent 參數設為 true 時，這會顯示所有分頁的實際文件內容。如果設為 false 或未設定，則這個欄位會包含文件中第一個分頁的相關資訊。
suggestedDocumentStyleChanges

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

僅供輸出。建議變更文件樣式，並依建議 ID 索引鍵顯示。

舊版欄位：請改用 Document.tabs.documentTab.suggestedDocumentStyleChanges，這會在 includeTabsContent 參數設為 true 時，公開所有分頁中的實際文件內容。如果設為 false 或未設定，則這個欄位會包含文件中第一個分頁的相關資訊。
namedStyles

object (NamedStyles)

僅供輸出。文件的命名樣式。

舊版欄位：請改用 Document.tabs.documentTab.namedStyles，這會在 includeTabsContent 參數設為 true 時，公開所有分頁中的實際文件內容。如果設為 false 或未設定，則這個欄位會包含文件中第一個分頁的相關資訊。
suggestedNamedStylesChanges

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

僅供輸出。建議變更文件的已命名樣式，並以建議 ID 做為索引鍵。

舊版欄位：請改用 Document.tabs.documentTab.suggestedNamedStylesChanges，這會在 includeTabsContent 參數設為 true 時，公開所有分頁中的實際文件內容。如果為 false 或未設定，則此欄位會包含文件中第一個分頁的相關資訊。
lists

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

僅供輸出。文件中的清單，以清單 ID 做為索引鍵。

舊版欄位：請改用 Document.tabs.documentTab.lists，這會在 includeTabsContent 參數設為 true 時，公開所有分頁中的實際文件內容。如果設為 false 或未設定，則這個欄位會包含文件中第一個分頁的相關資訊。
namedRanges

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

僅供輸出。文件中的已命名範圍，以名稱做為索引鍵。

舊版欄位：請改用 Document.tabs.documentTab.namedRanges，這會在 includeTabsContent 參數設為 true 時，公開所有分頁中的實際文件內容。如果設為 false 或未設定，則這個欄位會包含文件中第一個分頁的相關資訊。
inlineObjects

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

僅供輸出。文件中的內嵌物件，以物件 ID 做為索引鍵。

舊版欄位：請改用 Document.tabs.documentTab.inlineObjects，當 includeTabsContent 參數設為 true 時，這會顯示所有分頁的實際文件內容。如果設為 false 或未設定，則這個欄位會包含文件中第一個分頁的相關資訊。
positionedObjects

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

僅供輸出。文件中已定位的物件，由物件 ID 指定。

舊版欄位：請改用 Document.tabs.documentTab.positionedObjects，這會在 includeTabsContent 參數設為 true 時，公開所有分頁中的實際文件內容。如果設為 false 或未設定，則這個欄位會包含文件中第一個分頁的相關資訊。

Tab 鍵

文件中的分頁。

JSON 表示法 
{
  "tabProperties": {
    object (TabProperties)
  },
  "childTabs": [
    {
      object (Tab)
    }
  ],

  // Union field content can be only one of the following:
  "documentTab": {
    object (DocumentTab)
  }
  // End of list of possible types for union field content.
}
欄位
tabProperties

object (TabProperties)

分頁的屬性，例如 ID 和標題。
childTabs[]

object (Tab)

這個分頁中的子分頁。
聯集欄位 content。分頁的內容。content 只能是下列其中一項：
documentTab

object (DocumentTab)

包含文件內容 (例如文字和圖片) 的分頁。

TabProperties

分頁的屬性。

JSON 表示法 
{
  "tabId": string,
  "title": string,
  "parentTabId": string,
  "index": integer,
  "nestingLevel": integer
}
欄位
tabId

string

僅供輸出。分頁的 ID。這個欄位無法變更。
title

string

使用者看到的分頁名稱。
parentTabId

string

選用設定。父項分頁的 ID。如果目前的分頁是根層級分頁，也就是沒有任何父項，則為空白。
index

integer

父項中分頁標籤的索引 (從零開始)。
nestingLevel

integer

僅供輸出。文件中的分頁深度。根層級分頁會從 0 開始。

DocumentTab

含有文件內容的分頁。

JSON 表示法 
{
  "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)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
欄位
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))

文件分頁中的已命名範圍，並以名稱做為索引鍵。
inlineObjects

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

文件分頁中的內嵌物件，並以物件 ID 為索引鍵。
positionedObjects

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

文件分頁中已定位的物件，以物件 ID 做為索引。

內文

文件內文。

內文通常含有完整的文件內容，但 headers、footers 和 footnotes 除外。

JSON 表示法 
{
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
欄位
content[]

object (StructuralElement)

內文的內容。

主體內容的索引從 0 開始。

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

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

代表可套用至文字的樣式。

繼承的文字樣式會在這個訊息中顯示為未設定的欄位。文字樣式的父項取決於文字樣式定義的位置：

如果文字樣式不是繼承父項，取消設定欄位後，樣式就會還原為與文件編輯器中預設值相符的值。

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)

字型系列以及文字的顯示粗細。

如果更新要求同時指定 weightedFontFamily 和 bold 的值，系統會先套用 weightedFontFamily，然後再套用 bold。

如未設定 weightedFontFamily#weight，則預設為 400。

如果已設定 weightedFontFamily，則 weightedFontFamily#fontFamily 也必須設定為非空白值。否則，系統會傳回 400 錯誤要求錯誤。
baselineOffset

enum (BaselineOffset)

文字與正常位置的垂直偏移量。

具有 SUPERSCRIPT 或 SUBSCRIPT 基準偏移的文字會自動以較小的字型大小顯示 (根據 fontSize 欄位計算)。這個欄位的變更不會影響 fontSize。

OptionalColor

可完全不透明或完全透明的顏色。

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

WeightedFontFamily

代表文字的字型系列和粗細。

JSON 表示法 
{
  "fontFamily": string,
  "weight": integer
}
欄位
fontFamily

string

文字的字型系列。

字型系列可以是 Google 文件的「字型」選單或 Google Fonts 中的任何字型。如果系統無法辨識字型名稱，文字會以 Arial 轉譯。
weight

integer

字型的粗細。這個欄位的值可以是 100 到 900 的倍數 (含首尾)。100這個範圍與 CSS 2.1 規格第 15.6 節所列的數值相符，並禁止使用非數值。

預設值為 400 (「normal」)。

字型粗細只是實際字型粗細的一個元素。在考量繼承後，weight 和文字樣式的已解析 bold 值組合會決定算繪重量：

  • 如果文字為粗體，且權重小於 400，則轉譯權重為 400。
  • 如果文字為粗體，且權重大於或等於 400 但小於 700，則轉譯權重為 700。
  • 如果權重大於或等於 700，轉譯後的權重就會等於權重。
  • 如果文字不是粗體，則顯示的粗細即為權重。

BaselineOffset

文字可從正常位置垂直偏移的方式。

列舉
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。

AutoText

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 輸入代表文件總頁數的自動文字。

PageBreak

代表分頁符號的 ParagraphElement。分頁符號可讓後續文字從下一頁的頂端開始顯示。

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

string

建議的插入 ID。如果 PageBreak 是巢狀建議變更，可能會有多個插入 ID。如果為空白，則表示這不是建議的插入位置。
suggestedDeletionIds[]

string

建議的刪除 ID。如果為空白，表示系統不會建議刪除這項內容。
textStyle

object (TextStyle)

分頁符號的文字樣式。

與文字內容 (例如文字執行和註腳參考) 類似，分頁符號的文字樣式會影響內容版面配置，以及旁邊插入的文字樣式。
suggestedTextStyleChanges

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

依建議 ID 索引鍵顯示的建議文字樣式會變更為此分頁符號。

ColumnBreak

代表分欄符號的 ParagraphElement。分欄符號可讓後續文字從下一欄頂端開始。

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

string

建議的插入 ID。如果是巢狀建議變更，一個 ColumnBreak 可以有多個插入 ID。如果空白，就不建議採用這種插入方式。
suggestedDeletionIds[]

string

建議的刪除 ID。如果為空白，表示系統不會建議刪除這項內容。
textStyle

object (TextStyle)

此分欄的文字樣式。

與文字內容 (例如文字執行和註腳參考) 類似，分欄符號的文字樣式會影響內容版面配置，以及旁邊插入的文字樣式。
suggestedTextStyleChanges

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

建議文字樣式會變更為這個以建議 ID 做為索引的 ColumnBreak。

FootnoteReference

代表註腳參照的 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

包含 InlineObject 的 ParagraphElement。

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，例如多位使用者建議刪除該 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

僅供輸出。RichLink 的 MIME 類型 (例如雲端硬碟的檔案)。

ParagraphStyle

適用於整段段落的樣式。

在這封郵件中，沿用的段落樣式會以未設定的欄位表示。段落樣式的父項取決於段落樣式的定義位置：

如果段落樣式未從父項繼承，取消設定欄位後，樣式會還原為與 Google 文件編輯器中預設值相符的值。

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)

這個段落的 tab 停用清單。分頁符號清單不會繼承。

這個屬性處於唯讀狀態。
keepLinesTogether

boolean

設定段落的所有行是否應盡可能排在同一頁或欄中。如果未設定，系統會沿用父項的值。
keepWithNext

boolean

如果可以，請讓這個段落至少有一部分顯示在下一個段落或下一個段落中。如果未設定，系統會沿用父項的值。
avoidWidowAndOrphan

boolean

是否避免在段落出現疑惑和孤立。如未設定，則會沿用父項的值。
shading

object (Shading)

段落的底色。如果未設定，系統會沿用父項的值。
pageBreakBefore

boolean

是否應一律在頁面開頭顯示目前段落。如未設定，則會沿用父項的值。

嘗試更新不支援區域 (包括 Table、Header、Footer 和 Footnote) 中的段落 pageBreakBefore，可能會導致無效的文件狀態，並傳回 400 錯誤要求錯誤。

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 段落已對齊。

ContentDirection

路線內容可以流入。

列舉
CONTENT_DIRECTION_UNSPECIFIED 未指定內容方向。
LEFT_TO_RIGHT 內容會從左到右顯示。
RIGHT_TO_LEFT 內容會從右至左顯示。

SpacingMode

段落間距的各種模式。

列舉
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)

框線的虛線樣式。

DashStyle

可用於算繪線性幾何圖形的虛線類型。這些值是根據「Office Open XML 檔案格式 - 基礎知識和標記語言參考資料」(「Office Open XML File Formats - Fundamentals and Markup Language Reference」) 20.1.10.48 節所述的「ST_PresetLineDashVal」簡單類型，此為 ECMA-376 第 4 版的第 1 部分。

列舉
DASH_STYLE_UNSPECIFIED 未指定虛線樣式。
SOLID 實線。對應至 ECMA-376 ST_PresetLineDashVal 值「solid」。這是預設的破折號樣式。
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)

段落專屬文字樣式已套用至這個項目符號。

SuggestedBullet

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 的哪些欄位已變更。

ObjectReferences

物件 ID 集合。

JSON 表示法 
{
  "objectIds": [
    string
  ]
}
欄位
objectIds[]

string

物件 ID。

SectionBreak

StructuralElement 代表分節符號。版面是指具有相同 SectionStyle 的內容範圍。分節符號代表新區段的開始，而分節符號之後的區段樣式就會套用至該區段。

文件內文一律會以分節符號開頭。

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

string

建議的插入 ID。如果是巢狀建議變更，一個 SectionBreak 可以有多個插入 ID。如果空白，就不建議插入這個資料欄。
suggestedDeletionIds[]

string

建議的刪除 ID。如果為空白，表示系統不會建議刪除這項內容。
sectionStyle

object (SectionStyle)

此分隔符後的段落樣式。

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 錯誤的要求錯誤。
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，這個值會用於該區段第一頁的標題。如果為否，則該章節第一頁的標題會使用 defaultHeaderId。如未設定，值會沿用先前的 SectionBreak'sSectionStyle。如果在第一個 SectionBreak 中未設定值，則會繼承 DocumentStyle 的 firstPageHeaderId。

這個屬性處於唯讀狀態。
firstPageFooterId

string

只有版面第一頁的頁尾 ID。如果 useFirstPageHeaderFooter 為 true，則此值會用於該節第一頁的頁尾。如果值為 false，區段第一頁的頁尾會使用 defaultFooterId。如未設定，值會沿用先前的 SectionBreak'sSectionStyle。如果在第一個 SectionBreak 中未設定值，則會繼承 DocumentStyle 的 firstPageFooterId。

這個屬性處於唯讀狀態。
evenPageHeaderId

string

標頭的 ID，僅適用於偶數網頁。如果 DocumentStyle 的 useEvenPageHeaderFooter 值為 true，這個值就會用於該區段中的標頭。如果為 false，偶數頁的頁首會使用 defaultHeaderId。如未設定，值會沿用先前的 SectionBreak'sSectionStyle。如果在第一個 sectionBreak 中取消設定該值，它就會從 DocumentStyle 的 evenPageHeaderId 繼承。

這個屬性處於唯讀狀態。
evenPageFooterId

string

僅用於偶數頁的頁尾 ID。如果 DocumentStyle 的 useEvenPageHeaderFooter 值為 true，這個值就會用於該區段中的頁尾。如果設為 false，偶數頁的頁尾會使用 defaultFooterId。如未設定，值會沿用先前的 SectionBreak'sSectionStyle。如果在第一個 SectionBreak 中未設定值，則會繼承 DocumentStyle 的 evenPageFooterId。

這個屬性處於唯讀狀態。
useFirstPageHeaderFooter

boolean

指出是否要使用第一頁的頁首/頁尾 ID 做為該章節的第一頁。如果未設定，則會繼承 DocumentStyle 的 useFirstPageHeaderFooter，適用於第一個部分。如果未針對後續產業設定這個值，應解讀為 false。

更新這個屬性時，必須設定具體值。取消設定此屬性會導致 400 錯誤要求。
pageNumberStart

integer

要開始計算這個區塊頁面數量的頁碼。如未設定，系統會從上一節開始編號。如果在第一個 SectionBreak 中未設定值，請參閱 DocumentStyle 的 pageNumberStart。

更新這個屬性時，必須設定具體值。取消設定這個屬性會導致 400 錯誤要求錯誤。
flipPageOrientation

boolean

選用設定。指出是否要翻轉這個部分的 DocumentStyle 的 pageSize 尺寸，以允許在直向和橫向之間變更頁面方向。如果未設定，則值會繼承 DocumentStyle 的 flipPageOrientation。

更新這個屬性時，必須設定具體值。取消設定這個屬性會導致 400 錯誤要求錯誤。

SectionColumnProperties

適用於區段欄的屬性。

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)

表格儲存格內容的對齊方式。在文件編輯器中，預設對齊方式會與新建的表格儲存格對齊。

TableCellBorder

表格儲存格周圍的邊框。

表格儲存格邊框不得設為透明。如要隱藏表格儲存格框線，請將寬度設為 0。

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

object (OptionalColor)

邊框的顏色。

這個顏色不得為透明。
width

object (Dimension)

邊框的寬度。
dashStyle

enum (DashStyle)

框線的虛線樣式。

ContentAlignment

內容對齊的類型。

衍生自「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)

資料列的最小高度。列在 Google 文件編輯器中顯示時，高度會等於或大於這個值，以便顯示列中儲存格中的所有內容。
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。

TableStyle

套用至表格的樣式。

JSON 表示法 
{
  "tableColumnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}
欄位
tableColumnProperties[]

object (TableColumnProperties)

每個資料欄的屬性。

請注意，在 Google 文件中，表格包含資料列，而資料列包含儲存格，類似於 HTML。因此，您可以在資料列的 tableRowStyle 中找到資料列的屬性。

TableColumnProperties

資料表中資料欄的屬性。

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

enum (WidthType)

資料欄的寬度類型。
width

object (Dimension)

資料欄的寬度。設定資料欄的 widthType 為 FIXED_WIDTH 時。

WidthType

資料欄的寬度類型。

列舉
WIDTH_TYPE_UNSPECIFIED 未指定資料欄寬度類型。
EVENLY_DISTRIBUTED

資料欄寬度會平均分配給其他平均分配的資料欄。

系統會自動決定欄的寬度，並在考量所有指定寬度的欄後，將剩餘的寬度平均分配給表格。
FIXED_WIDTH 固定欄寬。[width][google.apps.docs.v1.TableColumnProperties.width 屬性包含資料欄的寬度。

TableOfContents

代表目錄的 StructuralElement。

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

object (StructuralElement)

目錄內容。
suggestedInsertionIds[]

string

建議的插入 ID。如果是巢狀建議變更，TableOfContents 可以有多個插入 ID。如果空白，就不建議插入這個資料欄。
suggestedDeletionIds[]

string

建議的刪除 ID。如果空白，代表系統沒有建議刪除這項內容。

註腳

文件註腳。

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 或這個值。如果未設定，就不會有偶數頁標頭。

這個屬性處於唯讀狀態。
evenPageFooterId

string

僅適用於偶數頁面的頁尾 ID。useEvenPageHeaderFooter 的值會決定是否要在偶數頁的頁尾使用 defaultFooterId 或這個值。如果未設定，就不會有偶數頁頁尾。

這個屬性處於唯讀狀態。
firstPageHeaderId

string

只有第一頁的標頭 ID。如果沒有設定，第一頁的標頭就會不存在。useFirstPageHeaderFooter 的值會決定是否要使用 defaultHeaderId 或這個值，做為第一頁標頭。如未設定，就不會提供第一頁頁首。

這是唯讀屬性。
firstPageFooterId

string

僅用於第一頁的頁尾 ID。如果未設定，第一頁就不會顯示專屬的頁尾。useFirstPageHeaderFooter 的值可決定是否使用 defaultFooterId 或這個值做為第一頁的頁尾。如果未設定，就不會顯示第一頁頁尾。

這是唯讀屬性。
useFirstPageHeaderFooter

boolean

指出是否要使用第一頁的頁首/頁尾 ID。
useEvenPageHeaderFooter

boolean

指出是否要使用偶數頁面的頁首 / 頁尾 ID。
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 是否有建議的變更。
evenPageFooterIdSuggested

boolean

指出 evenPageFooterId 是否有建議的變更。
firstPageHeaderIdSuggested

boolean

指出是否有建議變更 firstPageHeaderId。
firstPageFooterIdSuggested

boolean

指出 firstPageFooterId 是否有建議的變更。
useFirstPageHeaderFooterSuggested

boolean

指出是否有建議變更 useFirstPageHeaderFooter。
useEvenPageHeaderFooterSuggested

boolean

指出 useEvenPageHeaderFooter 是否有建議的變更。
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

命名風格。文件中的段落可以從這些命名格式繼承 TextStyle 和 ParagraphStyle。

JSON 表示法 
{
  "styles": [
    {
      object (NamedStyle)
    }
  ]
}
欄位
styles[]

object (NamedStyle)

命名風格。

每個可能的 named style types 都有一個項目。

NamedStyle

具名樣式。當文件中的段落具有相同的命名樣式類型時，段落可以從這個命名樣式繼承 TextStyle 和 ParagraphStyle。

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 的哪些欄位已變更。

清單

清單代表一組段落的清單屬性，這些段落都屬於同一個清單。清單中的段落會在 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 則對應至最深的巢狀層級。系統會以遞增順序傳回巢狀層級，最少巢狀層級的會優先傳回。

NestingLevel

包含的屬性可說明特定巢狀結構層級清單項目符號的外觀和風格。

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

在這個巢狀層級中，項目符號使用的格式字串。

圖示格式包含一或多個預留位置，這些預留位置會根據 glyphType 或 glyphSymbol 替換為適當的值。預留位置採用 %[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，有字母和羅馬數字的清單將分別從 a 和 i 開始。

如為含有未排序字符的巢狀等級，系統會忽略這個值。
聯集欄位 glyph_kind。項目符號使用的字符類型。這會定義用於取代 glyph_format 中預留位置的子彈符號標記。glyph_kind 只能採用下列其中一種設定：
glyphType

enum (GlyphType)

在此巢狀結構中的段落依順序排列時，項目符號使用的字符類型。

當這個巢狀層級的段落排序時，字符類型會決定用來取代 glyphFormat 中預留位置的字符類型。舉例來說，如果巢狀層級為 0，glyphFormat 為 %0.，字符類型為 DECIMAL，那麼算繪的字符會將字符格式的預留位置 %0 替換成與清單內清單項目順序對應的數字。
glyphSymbol

string

這個巢狀結構層級的段落沒有排序時，項目符號所用的自訂字符符號。

字符符號會取代 glyphFormat 中的預留位置。舉例來說，如果字形符號是與 Unicode U+25cf 代碼點相對應的實心圓形，而 glyphFormat 是 %0，則轉譯的字形就會是實心圓形。

BulletAlignment

項目符號的對齊類型。

列舉
BULLET_ALIGNMENT_UNSPECIFIED 未指定項目符號對齊方式。
START 子彈會對齊用於顯示子彈的空間起始位置。讓 LTR 文字靠左對齊，否則靠右對齊。
CENTER 項目符號會與分配到項目符號的空間中心對齊。
END 項目符號會對齊分配的空格結尾。靠右對齊 (使用 LTR 文字)，否則靠左對齊。

GlyphType

在此巢狀結構中的段落依序排列時，項目符號使用的字符類型。

列舉
GLYPH_TYPE_UNSPECIFIED 未指定或不支援的字符類型。
NONE 空字串。
DECIMAL 數字，例如 1、2 或 3。
ZERO_DECIMAL 單位數字前面有零的前置字元，例如 01、02 或 03。數字如果有兩位數，則不會在開頭加上零。
UPPER_ALPHA 大寫字母，例如 A、B 或 C。
ALPHA 小寫英文字母，例如 a、b 或 c。
UPPER_ROMAN 大寫的羅馬數字，例如 I、II 或 III。
ROMAN 小寫羅馬數字，例如 i、ii 或 iii。

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 是否有建議的變更。

NamedRanges

文件中所有共用特定名稱的 NamedRange 集合。

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

string

所有 named ranges 共用的名稱。
namedRanges[]

object (NamedRange)

共用相同名稱的 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,
  "tabId": string
}
欄位
segmentId

string

這個範圍包含的標頭、頁尾或註腳 ID。空白區段 ID 代表文件的內文。
startIndex

integer

這個範圍的起始索引，以 UTF-16 編碼單位表示。

無論是目前用途，都必須提供起始索引。這個欄位是 Int32Value，可支援日後開放式範圍的用途。
endIndex

integer

這個範圍的零起始結束索引，以 UTF-16 碼元為單位。

無論是目前何種用途，都必須提供結尾索引。這個欄位為 Int32Value，目的是因應未來開放式範圍的用途。
tabId

string

包含這個範圍的分頁。若省略此參數，請求會套用至第一個分頁。

在包含單一分頁的文件中：

  • 如有提供，必須與單一分頁的 ID 相符。

  • 如果省略，要求會套用至單一分頁。

在含有多個分頁的文件中：

  • 如有提供，要求會套用至指定分頁。

  • 如果您省略這個屬性，要求會套用至文件的第一個分頁。

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

嵌入物件的標題。title 和 description 都會合併顯示替代文字。
description

string

嵌入物件的說明。title 和 description 都會合併顯示替代文字。
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

這個類型沒有任何欄位。

嵌入繪圖的屬性，用來區分物件類型。內嵌繪圖是在文件中建立及編輯的繪圖。請注意，系統不支援大量詳細資料。

圖片屬性

圖片的屬性。

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

string

圖片的 URI，預設生命週期為 30 分鐘。這個 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)

邊框屬性的屬性狀態。

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)

已連結圖表的參照。

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

指出是否建議變更 [brightness] [google.apps.docs.v1.EmbeddedObject.brightness]。
contrastSuggested

boolean

表示有 [對比] 的建議變更 [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 的哪些欄位已變更。

SheetsChartReferenceSuggestionState

遮罩，用來指出在這個建議中，哪些基本 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 是否有建議的變更。

SuggestionsViewMode

文件套用的建議檢視模式，代表建議的變更的呈現方式。提供選項，可在讀取文件時，將所有建議內嵌、接受或拒絕。

列舉
DEFAULT_FOR_CURRENT_ACCESS 套用至傳回的文件的 SuggestionsViewMode 取決於使用者目前的存取層級。如果使用者只有檢視權限，系統會套用 PREVIEW_WITHOUT_SUGGESTIONS。否則會套用 SUGGESTIONS_INLINE。這是預設的建議檢視模式。
SUGGESTIONS_INLINE

傳回的文件內含建議內容。系統會在文件中將建議的變更與基本內容區分開來。

如果使用者沒有查看建議變更的權限，使用這個模式擷取文件的要求將傳回 403 錯誤。
PREVIEW_SUGGESTIONS_ACCEPTED

傳回的文件是預覽畫面，其中會顯示所有接受的建議變更。

如果使用者沒有查看建議變更的權限，使用這個模式擷取文件的要求將傳回 403 錯誤。
PREVIEW_WITHOUT_SUGGESTIONS 傳回的文件為預覽畫面，其中會列出文件中的任何建議變更，

方法

batchUpdate

 為文件套用一或多項更新。

create

 使用要求中提供的標題建立空白文件。

get

 取得指定文件的最新版本。