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)

內文內容。

主體內容的索引以零為起始值。

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

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

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

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

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)

此自動文字的文字樣式。
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))

建議的文字樣式會變更為這個 PageBreak，並以建議 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)

這個 ColumnBreak 的文字樣式。

與文字內容 (例如文字行和註腳參照) 類似，分欄符的文字樣式可能會影響內容版面配置，以及插入在分欄符旁的文字樣式。
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，則該 Person 可能會有多個刪除 ID。如果空白，系統就不會建議刪除這個使用者連結。
textStyle

object (TextStyle)

這個 Person 的文字樣式。
suggestedTextStyleChanges

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

建議文字樣式會變更為這個 Person，並以建議 ID 做為索引。
personProperties

object (PersonProperties)

僅供輸出。這個 Person 的屬性。這個欄位一律會出現。

PersonProperties

已連結 Person 專屬的屬性。

JSON 表示法 
{
  "name": string,
  "email": string
}
欄位
name

string

僅供輸出。如果連結文字顯示使用者名稱，而非電子郵件地址，請輸入使用者名稱。
email

string

僅供輸出。與這個 Person 連結的電子郵件地址。這個欄位一律會出現。

RichLinkProperties

特定於 RichLink 的屬性。

JSON 表示法 
{
  "title": string,
  "uri": string,
  "mimeType": string
}
欄位
title

string

僅供輸出。連結中顯示的 RichLink 標題。這個標題會與插入或上次更新連結時的連結資源標題相符。這個欄位一律會出現。
uri

string

僅供輸出。RichLink 的 URI。這個值一律會存在。
mimeType

string

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

ParagraphStyle

套用至整個段落的樣式。

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

  • Paragraph 上的 ParagraphStyle 會繼承段落的對應 named style type。
  • named style 上的 ParagraphStyle 會繼承 normal text 命名樣式。
  • normal text 命名樣式的 ParagraphStyle 會繼承 Google 文件編輯器中的預設段落樣式。
  • 表格中 Paragraph 元素的 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's SectionStyle。如果在第一個 SectionBreak 中未設定值，則會繼承 DocumentStyle 的 firstPageHeaderId。

這是唯讀屬性。
firstPageFooterId

string

頁尾 ID，僅用於該部分的第一頁。如果 useFirstPageHeaderFooter 為 true，這個值會用於區段第一頁的頁尾。如果為 false，則章節第一頁的頁尾會使用 defaultFooterId。如果未設定，則值會繼承先前的 SectionBreak's SectionStyle。如果在第一個 SectionBreak 中未設定值，則會繼承 DocumentStyle 的 firstPageFooterId。

這是唯讀屬性。
evenPageHeaderId

string

僅用於偶數頁的標頭 ID。如果 DocumentStyle 的 useEvenPageHeaderFooter 值為 true，這個值會用於該區段中偶數頁的標題。如果為 false，偶數頁的頁首會使用 defaultHeaderId。如果未設定，則值會繼承先前的 SectionBreak's SectionStyle。如果在第一個 SectionBreak 中未設定值，則會繼承 DocumentStyle 的 evenPageHeaderId。

這是唯讀屬性。
evenPageFooterId

string

僅用於偶數頁的頁尾 ID。如果 DocumentStyle 的 useEvenPageHeaderFooter 值為 true，這個值會用於該區段中偶數頁的頁尾。如果設為 false，偶數頁的頁尾會使用 defaultFooterId。如果未設定，則值會繼承先前的 SectionBreak's SectionStyle。如果在第一個 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)

表格儲存格中內容的對齊方式。預設對齊方式會與 Google 文件編輯器中新建立的資料表儲存格對齊方式一致。

TableCellBorder

表格儲存格周圍的邊框。

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

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

object (OptionalColor)

邊框的顏色。

這個顏色不得為透明。
width

object (Dimension)

框線的寬度。
dashStyle

enum (DashStyle)

框線的虛線樣式。

ContentAlignment

內容對齊類型。

源自「Office Open XML 檔案格式 - 基礎知識和標記語言參考資料」(第 1 部分) 的 ECMA-376 第 4 版中「20.1.10.59 節」的「ST_TextAnchoringType」簡單型別值子集。

列舉
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 如果屬性狀態為「已算繪」，則元素在文件中算繪時會具有對應的屬性。這是預設值。
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

指出是否有建議變更 [contrast] [google.apps.docs.v1.EmbeddedObject.contrast]。
transparencySuggested

boolean

指出是否有建議變更 [transparency] [google.apps.docs.v1.EmbeddedObject.transparency]。
cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

遮罩，指出在這個建議中，cropProperties 的哪些欄位已變更。
angleSuggested

boolean

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

CropPropertiesSuggestionState

遮罩，用來指出在這個建議中，哪些基本 CropProperties 欄位已變更。對於設為 true 的任何欄位，都會有新的建議值。

JSON 表示法 
{
  "offsetLeftSuggested": boolean,
  "offsetRightSuggested": boolean,
  "offsetTopSuggested": boolean,
  "offsetBottomSuggested": boolean,
  "angleSuggested": boolean
}
欄位
offsetLeftSuggested

boolean

指出是否有建議變更 offsetLeft。
offsetRightSuggested

boolean

指出是否有建議變更 offsetRight。
offsetTopSuggested

boolean

指出是否有建議變更 offsetTop。
offsetBottomSuggested

boolean

指出是否有建議變更 offsetBottom。
angleSuggested

boolean

指出是否有建議變更 angle。

EmbeddedObjectBorderSuggestionState

遮罩，用來指出在這個建議中，哪些基本 EmbeddedObjectBorder 欄位已變更。對於設為 true 的任何欄位，都會有新的建議值。

JSON 表示法 
{
  "colorSuggested": boolean,
  "widthSuggested": boolean,
  "dashStyleSuggested": boolean,
  "propertyStateSuggested": boolean
}
欄位
colorSuggested

boolean

指出是否建議變更 [color] [google.apps.docs.v1.EmbeddedBorderObject.color]。
widthSuggested

boolean

指出是否有建議變更 [width] [google.apps.docs.v1.EmbeddedBorderObject.width]。
dashStyleSuggested

boolean

指出是否有建議變更 [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style]。
propertyStateSuggested

boolean

指出是否建議變更 [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state]。

LinkedContentReferenceSuggestionState

遮罩，用來指出在這個建議中，哪些基本 LinkedContentReference 欄位已變更。對於設為 true 的任何欄位，都會有新的建議值。

JSON 表示法 
{
  "sheetsChartReferenceSuggestionState": {
    object (SheetsChartReferenceSuggestionState)
  }
}
欄位
sheetsChartReferenceSuggestionState

object (SheetsChartReferenceSuggestionState)

遮罩，指出在這個建議中，sheetsChartReference 的哪些欄位已變更。

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

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