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,
  "iconEmoji": string
}
欄位
tabId

string

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

string

使用者看到的索引標籤名稱。
parentTabId

string

(選用步驟) 父項分頁的 ID。如果目前分頁是根層級分頁 (也就是沒有任何父項)，這個屬性就會空白。
index

integer

索引從零開始，代表父項中的分頁。
nestingLevel

integer

僅供輸出。文件內索引標籤的深度。根層級索引標籤從 0 開始。
iconEmoji

string

(選用步驟) 分頁會顯示表情符號圖示。有效的表情符號圖示會以非空白的 Unicode 字串表示。如果一組字元無法代表單一表情符號，即為無效。

如果表情符號無效，系統會傳回 400 Bad Request 錯誤。

如果未設定或空白，分頁會顯示預設分頁圖示。

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)

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

系統會根據 fontSize 欄位計算，自動以較小的字型大小算繪具有 SUPERSCRIPT 或 SUBSCRIPT 基準線偏移的文字。這個欄位的變更不會影響 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 字型中的任何字型。如果系統無法辨識字型名稱，文字會以 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))

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

建議的文字樣式會變更為這個 ColumnBreak，並以建議 ID 做為鍵。

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。如果空白，系統就不會建議刪除這個人員連結。
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)

這個段落的定位點清單。不會沿用定位點清單。

這項屬性為唯讀。
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 段落會與行首對齊。如果是從左到右的文字，則靠左對齊；否則靠右對齊。
CENTER 段落置中。
END 段落會對齊行尾，如果是從左到右的文字，則靠右對齊；否則靠左對齊。
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 File Formats - Fundamentals and Markup Language Reference」第 1 部分 (ECMA-376 第 5 版) 第 20.1.10.49 節所述的「ST_PresetLineDashVal」簡單型別為準。

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

區段的資料欄屬性。

如果為空白，則該節會包含一個資料欄，並在 Google 文件編輯器中顯示預設屬性。每個部分最多可更新為 3 欄。

更新這項屬性時，必須設定具體值。取消設定這項屬性會導致 400 Bad Request 錯誤。
columnSeparatorStyle

enum (ColumnSeparatorStyle)

資料欄分隔線的樣式。

即使區段只有一個資料欄，也可以設定這個樣式。

更新這項屬性時，必須設定具體值。取消設定這項屬性會導致 400 Bad Request 錯誤。
contentDirection

enum (ContentDirection)

這個專區的內容方向。如未設定，預設值為 LEFT_TO_RIGHT。

更新這項屬性時，必須設定具體值。取消設定這項屬性會導致 400 Bad Request 錯誤。
marginTop

object (Dimension)

區段的頂端頁面邊界。如未設定，值預設為 DocumentStyle 中的 marginTop。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。

更新這項屬性時，必須設定具體值。取消設定這項屬性會導致 400 Bad Request 錯誤。
marginBottom

object (Dimension)

該節的頁面下邊界。如未設定，值預設為 DocumentStyle 中的 marginBottom。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。

更新這項屬性時，必須設定具體值。取消設定這項屬性會導致 400 Bad Request 錯誤。
marginRight

object (Dimension)

該節的右頁邊。如未設定，預設值為 DocumentStyle 中的 marginRight。更新右邊界會導致這個部分的欄調整大小。由於邊界會影響欄寬，因此系統會在欄屬性之前套用邊界。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。

更新這項屬性時，必須設定具體值。取消設定這項屬性會導致 400 Bad Request 錯誤。
marginLeft

object (Dimension)

該節的左頁面邊界。如未設定，預設值為 DocumentStyle 中的 marginLeft。更新左邊界會導致這個部分的欄位調整大小。由於邊界會影響欄寬，因此系統會在欄屬性之前套用邊界。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。

更新這項屬性時，必須設定具體值。取消設定這項屬性會導致 400 Bad Request 錯誤。
marginHeader

object (Dimension)

區段的頁首邊界。如未設定，預設值為 DocumentStyle 中的 marginHeader。如果更新，DocumentStyle 中的 useCustomHeaderFooterMargins 會設為 true。DocumentStyle 的 useCustomHeaderFooterMargins 值會指出是否要為這個區段保留頁首邊界。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。

更新這項屬性時，必須設定具體值。取消設定這項屬性會導致 400 Bad Request 錯誤。
sectionType

enum (SectionType)

僅供輸出。版面類型。
defaultHeaderId

string

預設標題的 ID。如果未設定，值會沿用前一個 SectionBreak's SectionStyle。如果第一個 SectionBreak 中未設定值，則會沿用 DocumentStyle 的 defaultHeaderId。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。

這項屬性為唯讀。
firstPageHeaderId

string

標題的 ID，僅用於該節的第一頁。如果 useFirstPageHeaderFooter 為 true，系統會將這個值做為該節第一頁的標題。如果為 false，則該節第一頁的標題會使用 defaultHeaderId。如果未設定，值會沿用前一個 SectionBreak's SectionStyle。如果第一個 SectionBreak 中未設定值，則會沿用 DocumentStyle 的 firstPageHeaderId。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。

這項屬性為唯讀。
firstPageFooterId

string

頁尾的 ID，僅用於該節的第一頁。如果 useFirstPageHeaderFooter 為 true，系統會將這個值用於該節第一頁的頁尾。如果為 false，章節第一頁的頁尾會使用 defaultFooterId。如果未設定，值會沿用前一個 SectionBreak's SectionStyle。如果第一個 SectionBreak 中未設定值，則會沿用 DocumentStyle 的 firstPageFooterId。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。

這項屬性為唯讀。
evenPageHeaderId

string

僅用於偶數頁的頁首 ID。如果 DocumentStyle 的 useEvenPageHeaderFooter 值為 true，這個值會用於該節中偶數頁面的頁首。如果設為 false，偶數頁的頁首會使用 defaultHeaderId。如果未設定，值會沿用前一個 SectionBreak's SectionStyle。如果第一個 SectionBreak 中未設定值，則會沿用 DocumentStyle 的 evenPageHeaderId。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。

這項屬性為唯讀。
evenPageFooterId

string

僅用於偶數頁的頁尾 ID。如果 DocumentStyle 的 useEvenPageHeaderFooter 值為 true，這個值會用於該節中偶數頁面的頁尾。如果設為 false，偶數頁的頁尾會使用 defaultFooterId。如果未設定，值會沿用前一個 SectionBreak's SectionStyle。如果第一個 SectionBreak 中未設定值，則會沿用 DocumentStyle 的 evenPageFooterId。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。

這項屬性為唯讀。
useFirstPageHeaderFooter

boolean

指出是否要將第一頁頁首 / 頁尾 ID 用於章節的第一頁。如果未設定，則會從第一個區段的 DocumentStyle useFirstPageHeaderFooter 繼承。如果後續產業未設定值，則應解讀為 false。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。

更新這項屬性時，必須設定具體值。取消設定這項屬性會導致 400 Bad Request 錯誤。
pageNumberStart

integer

這個章節的頁碼計算起始頁碼。如果未設定，頁碼會接續上一節。如果第一個 SectionBreak 中未設定值，請參閱 DocumentStyle 的 pageNumberStart。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。

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

boolean

(選用步驟) 指出是否要翻轉這個區段的 DocumentStyle pageSize 維度，以便在直向和橫向之間變更頁面方向。如未設定，值會從 DocumentStyle 的 flipPageOrientation 繼承。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。

更新這項屬性時，必須設定具體值。取消設定這項屬性會導致 400 Bad Request 錯誤。

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 File Formats - Fundamentals and Markup Language Reference」第 1 部分 (ECMA-376 第 5 版) 第 20.1.10.60 節中「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)

資料列的最小高度。為了顯示資料列儲存格中的所有內容，文件編輯器會以等於或大於這個值的高度算繪資料列。
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,
  "documentFormat": {
    object (DocumentFormat)
  }
}
欄位
background

object (Background)

文件背景。文件不得使用透明背景顏色。
defaultHeaderId

string

預設標題的 ID。如未設定，則沒有預設標頭。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。

這項屬性為唯讀。
evenPageHeaderId

string

僅用於偶數頁的頁首 ID。useEvenPageHeaderFooter 的值會決定偶數頁面的頁首要使用 defaultHeaderId 還是這個值。如未設定，則不會有偶數頁頁首。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。

這項屬性為唯讀。
evenPageFooterId

string

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

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。

這項屬性為唯讀。
firstPageHeaderId

string

僅用於第一頁的標頭 ID。如果未設定，則第一頁不會有專屬頁首。useFirstPageHeaderFooter 的值會決定第一頁的標頭要使用 defaultHeaderId 還是這個值。如未設定，就不會有第一頁頁首。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。

這項屬性為唯讀。
firstPageFooterId

string

僅用於第一頁的頁尾 ID。如果未設定，則第一頁不會有專屬頁尾。useFirstPageHeaderFooter 的值會決定第一頁的頁尾要使用 defaultFooterId 還是這個值。如未設定，就不會有第一頁頁尾。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。

這項屬性為唯讀。
useFirstPageHeaderFooter

boolean

指出是否要將第一頁頁首 / 頁尾 ID 用於第一頁。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。
useEvenPageHeaderFooter

boolean

指出是否要將偶數頁頁首 / 頁尾 ID 用於偶數頁。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。
pageNumberStart

integer

計算頁數的起始頁碼。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。
marginTop

object (Dimension)

頁面上邊界。

更新文件樣式的頂端頁面邊界，會清除所有區段樣式的頂端頁面邊界。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。
marginBottom

object (Dimension)

頁面下邊界。

更新文件樣式的頁面下邊界時，系統會清除所有區段樣式的頁面下邊界。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。
marginRight

object (Dimension)

右側頁面邊界。

更新文件樣式的右頁面邊界，會清除所有區段樣式的右頁面邊界。這也可能導致所有區段中的資料欄調整大小。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。
marginLeft

object (Dimension)

左側頁面邊界。

更新文件樣式的左側頁面邊界時，系統會清除所有區段樣式的左側頁面邊界。這也可能導致所有區段中的資料欄調整大小。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。
pageSize

object (Size)

文件中的頁面大小。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。
marginHeader

object (Dimension)

頁面頂端與標題內容之間的空間大小。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。
flipPageOrientation

boolean

(選用步驟) 指出是否要翻轉 pageSize 的尺寸，以便在直向和橫向之間變更頁面方向。

如果 [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] 為 PAGELESS，系統不會轉譯這項屬性。
documentFormat

object (DocumentFormat)

指定文件層級的格式設定，例如文件模式 (分頁或不分頁)。

背景

代表文件的背景。

JSON 表示法 
{
  "color": {
    object (OptionalColor)
  }
}
欄位
color

object (OptionalColor)

背景顏色。

大小

寬度和高度。

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

object (Dimension)

物件的高度。
width

object (Dimension)

物件的寬度。

DocumentFormat

代表文件層級的格式設定。

JSON 表示法 
{
  "documentMode": enum (DocumentMode)
}
欄位
documentMode

enum (DocumentMode)

文件是否分頁或不分頁。

DocumentMode

文件是否分頁或不分頁。

列舉
DOCUMENT_MODE_UNSPECIFIED 未指定文件模式。
PAGES 文件含有頁面。
PAGELESS 文件採用不分頁格式。

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

清單

「List」代表一組段落的清單屬性，這些段落都屬於同一個清單。屬於清單的段落會在 bullet 中參照清單的 ID。

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

object (ListProperties)

清單的屬性。
suggestedListPropertiesChanges

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

建議的清單屬性變更，以建議 ID 做為鍵。
suggestedInsertionId

string

建議的廣告空間 ID。如果為空白，則表示這不是建議的插入位置。
suggestedDeletionIds[]

string

建議的刪除 ID。如果為空白，表示沒有建議刪除的清單。

ListProperties

list 的屬性，用於描述與清單相關聯段落的項目符號外觀。

JSON 表示法 
{
  "nestingLevels": [
    {
      object (NestingLevel)
    }
  ]
}
欄位
nestingLevels[]

object (NestingLevel)

說明相關層級的項目符號屬性。

清單最多可有 9 個巢狀層級，巢狀層級 0 對應最頂層，巢狀層級 8 則對應最深層。系統會以遞增順序傳回巢狀層級，最少巢狀層級會優先傳回。

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 中的預留位置。舉例來說，如果 glyphSymbol 是對應於 Unicode U+25cf 程式碼點的實心圓，而 glyphFormat 是 %0，則轉譯的字元會是實心圓。

BulletAlignment

項目符號的對齊類型。

列舉
BULLET_ALIGNMENT_UNSPECIFIED 未指定項目符號對齊方式。
START 項目符號會對齊分配給項目符號的空間開頭。如果是從左到右的文字，則靠左對齊；否則靠右對齊。
CENTER 項目符號會對齊分配給項目符號的空間中心。
END 項目符號會對齊項目符號的顯示空間結尾。如果是從左到右的文字，則靠右對齊；否則靠左對齊。

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

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

boolean

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

boolean

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

object (CropPropertiesSuggestionState)

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

boolean

指出 [角度] [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

指出是否建議變更 [寬度] [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 換行的位置，該 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

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