- 資源:文件
- 分頁
- TabProperties
- DocumentTab
- 內文
- StructuralElement
- 段落
- ParagraphElement
- TextRun
- TextStyle
- OptionalColor
- 顏色
- RgbColor
- 維度
- 單位
- WeightedFontFamily
- BaselineOffset
- 連結
- BookmarkLink
- HeadingLink
- SuggestedTextStyle
- TextStyleSuggestionState
- AutoText
- 類型
- PageBreak
- ColumnBreak
- FootnoteReference
- HorizontalRule
- 方程式
- InlineObjectElement
- 人物
- PersonProperties
- RichLink
- RichLinkProperties
- ParagraphStyle
- NamedStyleType
- 對齊方式
- ContentDirection
- SpacingMode
- ParagraphBorder
- DashStyle
- TabStop
- TabStopAlignment
- 陰影
- SuggestedParagraphStyle
- ParagraphStyleSuggestionState
- ShadingSuggestionState
- Bullet
- SuggestedBullet
- BulletSuggestionState
- ObjectReferences
- SectionBreak
- SectionStyle
- SectionColumnProperties
- ColumnSeparatorStyle
- SectionType
- 資料表
- TableRow
- TableCell
- TableCellStyle
- TableCellBorder
- ContentAlignment
- SuggestedTableCellStyle
- TableCellStyleSuggestionState
- TableRowStyle
- SuggestedTableRowStyle
- TableRowStyleSuggestionState
- TableStyle
- TableColumnProperties
- WidthType
- TableOfContents
- 標題
- 頁尾
- 註腳
- DocumentStyle
- 背景
- 大小
- SuggestedDocumentStyle
- DocumentStyleSuggestionState
- BackgroundSuggestionState
- SizeSuggestionState
- NamedStyles
- NamedStyle
- SuggestedNamedStyles
- NamedStylesSuggestionState
- NamedStyleSuggestionState
- 清單
- ListProperties
- NestingLevel
- BulletAlignment
- GlyphType
- SuggestedListProperties
- ListPropertiesSuggestionState
- NestingLevelSuggestionState
- NamedRanges
- NamedRange
- 範圍
- InlineObject
- InlineObjectProperties
- EmbeddedObject
- EmbeddedDrawingProperties
- ImageProperties
- CropProperties
- EmbeddedObjectBorder
- PropertyState
- LinkedContentReference
- SheetsChartReference
- SuggestedInlineObjectProperties
- InlineObjectPropertiesSuggestionState
- EmbeddedObjectSuggestionState
- EmbeddedDrawingPropertiesSuggestionState
- ImagePropertiesSuggestionState
- CropPropertiesSuggestionState
- EmbeddedObjectBorderSuggestionState
- LinkedContentReferenceSuggestionState
- SheetsChartReferenceSuggestionState
- PositionedObject
- PositionedObjectProperties
- PositionedObjectPositioning
- PositionedObjectLayout
- SuggestedPositionedObjectProperties
- PositionedObjectPropertiesSuggestionState
- PositionedObjectPositioningSuggestionState
- SuggestionsViewMode
- 方法
資源:Document
Google 文件。
JSON 表示法 |
---|
{ "documentId": string, "title": string, "tabs": [ { object ( |
欄位 | |
---|---|
document |
僅供輸出。文件 ID。 |
title |
文件標題。 |
tabs[] |
文件中的分頁。 分頁可以包含子分頁,也就是位於另一個分頁中的分頁。子分頁會以 |
revision |
僅供輸出。文件的修訂版本 ID。可在更新要求中使用,用於指定要套用更新的文件修訂版本,以及如果文件在該修訂版本之後經過編輯,要求應如何運作。只有在使用者俱備文件編輯權限時,才會填入資料。 修訂版本 ID 不是連續編號,而是不透明字串。修訂版本 ID 的格式可能會隨時間變更。系統傳回的修訂版本 ID 只保證在傳回後的 24 小時內有效,且無法跨使用者共用。如果兩次呼叫之間的修訂 ID 沒有變更,表示文件並未變更。相反地,如果 ID 有所變更 (針對相同的文件和使用者),通常表示文件已更新。不過,ID 變更也可能是因為 ID 格式變更等內部因素造成。 |
suggestions |
僅供輸出。套用至文件的建議檢視模式。 注意:編輯文件時,請務必根據具有 |
body |
僅供輸出。文件的主要內容。 舊版欄位:請改用 |
headers |
僅供輸出。文件中的標頭,以標頭 ID 做為索引。 舊版欄位:請改用 |
footers |
僅供輸出。文件中的頁尾,以頁尾 ID 做為索引。 舊版欄位:請改用 |
footnotes |
僅供輸出。文件中的註腳,以註腳 ID 做為索引鍵。 舊版欄位:請改用 |
document |
僅供輸出。文件樣式。 舊版欄位:請改用 |
suggested |
僅供輸出。建議的文件樣式變更,以建議 ID 做為索引。 舊版欄位:請改用 |
named |
僅供輸出。文件的命名樣式。 舊版欄位:請改用 |
suggested |
僅供輸出。建議變更文件的命名樣式,並以建議 ID 做為索引。 舊版欄位:請改用 |
lists |
僅供輸出。文件中的清單,以清單 ID 做為索引鍵。 舊版欄位:請改用 |
named |
僅供輸出。文件中的已命名範圍,以名稱做為索引。 舊版欄位:請改用 |
inline |
僅供輸出。文件中的內嵌物件,以物件 ID 做為索引。 舊版欄位:請改用 |
positioned |
僅供輸出。文件中已定位的物件,以物件 ID 做為索引。 舊版欄位:請改用 |
Tab 鍵
文件中的分頁。
JSON 表示法 |
---|
{ "tabProperties": { object ( |
欄位 | |
---|---|
tab |
分頁的屬性,例如 ID 和標題。 |
child |
這個分頁中的子分頁。 |
聯集欄位 content 。分頁的內容。content 只能是下列其中一項: |
|
document |
含有文件內容 (例如文字和圖片) 的分頁。 |
TabProperties
分頁的屬性。
JSON 表示法 |
---|
{ "tabId": string, "title": string, "parentTabId": string, "index": integer, "nestingLevel": integer } |
欄位 | |
---|---|
tab |
僅供輸出。分頁的 ID。這個欄位無法變更。 |
title |
使用者看到的分頁名稱。 |
parent |
選用設定。父項分頁的 ID。如果目前的分頁是根層級分頁,也就是沒有任何父項,則為空白。 |
index |
父項中分頁的索引,從零開始。 |
nesting |
僅供輸出。文件中的分頁深度。根層級分頁會從 0 開始。 |
DocumentTab
含有文件內容的分頁。
JSON 表示法 |
---|
{ "body": { object ( |
欄位 | |
---|---|
body |
文件分頁的主要內容。 |
headers |
文件分頁中的標頭,以標頭 ID 做為索引。 |
footers |
文件分頁中的頁尾,以頁尾 ID 做為索引。 |
footnotes |
文件分頁中的註腳,以註腳 ID 做為索引。 |
document |
文件分頁的樣式。 |
suggested |
建議變更文件分頁的樣式,並依建議 ID 索引鍵顯示。 |
named |
文件分頁的命名樣式。 |
suggested |
建議對文件分頁的命名樣式進行哪些變更,並以建議 ID 做為索引。 |
lists |
「文件」分頁中的清單,以清單 ID 為索引鍵。 |
named |
文件分頁中的已命名範圍,按名稱排序。 |
inline |
文件分頁中的內嵌物件,以物件 ID 做為索引。 |
positioned |
文件分頁中已定位的物件,以物件 ID 做為索引。 |
內文
文件內文。
JSON 表示法 |
---|
{
"content": [
{
object ( |
欄位 | |
---|---|
content[] |
內文內容。 主體內容的索引從 0 開始。 |
StructuralElement
StructuralElement 會說明為文件提供結構的內容。
JSON 表示法 |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
欄位 | |
---|---|
start |
這個結構元素的起始索引 (以 UTF-16 程式碼單位表示),從零開始計算。 |
end |
此結構元素的從零開始索引,不含 UTF-16 程式碼單位。 |
聯集欄位 content 。結構元素的內容。content 只能是下列其中一項: |
|
paragraph |
段落類型的結構元素。 |
section |
結構元素的區段插入類型。 |
table |
結構元素的資料表類型。 |
table |
目錄類型的結構元素。 |
段落
StructuralElement
代表段落。段落是指以換行字元結尾的內容範圍。
JSON 表示法 |
---|
{ "elements": [ { object ( |
欄位 | |
---|---|
elements[] |
段落內容,已細分為各個元件。 |
paragraph |
這個段落的樣式。 |
suggested |
建議的段落樣式會變更為這個段落,並依建議 ID 索引鍵顯示。 |
bullet |
這個段落的項目符號。如果沒有,則表示該段落不屬於清單。 |
suggested |
這個段落的項目符號建議變更。 |
positioned |
與本段落綁定的定位物件 ID。 |
suggested |
建議附加至本段落的已定位物件 ID,並以建議 ID 做為索引。 |
ParagraphElement
ParagraphElement 可用來說明 Paragraph
中的內容。
JSON 表示法 |
---|
{ "startIndex": integer, "endIndex": integer, // Union field |
欄位 | |
---|---|
start |
這個段落元素從零開始的索引,採用 UTF-16 程式碼單位。 |
end |
這個段落元素的零基結尾索引,以 UTF-16 碼元為單位。 |
聯集欄位 content 。段落元素的內容。content 只能是下列其中一項: |
|
text |
文字行段落元素。 |
auto |
自動文字段落元素。 |
page |
分頁段落元素。 |
column |
分欄段落元素。 |
footnote |
註腳參考段落元素。 |
horizontal |
水平規則段落元素。 |
equation |
方程式段落元素。 |
inline |
內嵌物件段落元素。 |
person |
連結至使用者或電子郵件地址的段落元素。 |
rich |
一種連結至 Google 資源的段落元素,例如 Google 雲端硬碟中的檔案、YouTube 影片或日曆活動。 |
TextRun
ParagraphElement
代表一連串具有相同樣式的文字。
JSON 表示法 |
---|
{ "content": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
欄位 | |
---|---|
content |
這次執行作業的文字。 任何不含文字的元素都會替換為 Unicode 字元 U+E907。 |
suggested |
建議的插入 ID。如果 |
suggested |
建議刪除的 ID。如果為空白,表示系統不會建議刪除這項內容。 |
text |
這次執行作業的文字樣式。 |
suggested |
系統會根據建議 ID 將建議的文字樣式變更為這個執行作業。 |
TextStyle
代表可套用至文字的樣式。
繼承的文字樣式會在這個訊息中顯示為未設定的欄位。文字樣式的父項取決於文字樣式的定義位置:
Paragraph
中文字的 TextStyle 會繼承段落的對應named style type
。named style
上的 TextStyle 繼承normal text
具名樣式。normal text
命名樣式的 TextStyle 會繼承 Google 文件編輯器中的預設文字樣式。- 表格中
Paragraph
元素的 TextStyle 可能會從表格樣式繼承文字樣式。
如果文字樣式未從父項繼承,取消設定欄位後,樣式會還原為與 Google 文件編輯器中預設值相符的值。
JSON 表示法 |
---|
{ "bold": boolean, "italic": boolean, "underline": boolean, "strikethrough": boolean, "smallCaps": boolean, "backgroundColor": { object ( |
欄位 | |
---|---|
bold |
是否將文字轉譯為粗體。 |
italic |
文字是否斜體。 |
underline |
是否為文字加上底線。 |
strikethrough |
是否要將文字劃掉。 |
small |
文字是否使用小寫大寫字母。 |
background |
文字的背景顏色。設定後,顏色會是 RGB 顏色或透明,視 |
foreground |
文字的前景顏色。如果已設定,顏色會是 RGB 顏色或透明,具體取決於 |
font |
文字的字型大小。 |
weighted |
字型系列以及文字的顯示粗細。 如果更新要求同時指定 如未設定 如果設定了 |
baseline |
文字與正常位置的垂直偏移量。 含有 |
link |
文字的超連結目的地。如未設定,則不會提供任何連結。連結不會從父項文字繼承。 變更更新要求中的連結會導致範圍的文字樣式發生其他變更:
|
OptionalColor
可完全不透明或完全透明的顏色。
JSON 表示法 |
---|
{
"color": {
object ( |
欄位 | |
---|---|
color |
如果已設定,則會用作不透明色彩。如果未設定,則代表透明色。 |
顏色
純色。
JSON 表示法 |
---|
{
"rgbColor": {
object ( |
欄位 | |
---|---|
rgb |
RGB 顏色值。 |
RgbColor
RGB 顏色。
JSON 表示法 |
---|
{ "red": number, "green": number, "blue": number } |
欄位 | |
---|---|
red |
色彩的紅色元件,介於 0.0 到 1.0。 |
green |
顏色的綠色元件,從 0.0 到 1.0。 |
blue |
顏色的藍色元件,從 0.0 到 1.0。 |
維度
以指定單位表示的單一方向的量。
JSON 表示法 |
---|
{
"magnitude": number,
"unit": enum ( |
欄位 | |
---|---|
magnitude |
規模。 |
unit |
規模的單位。 |
單位
。
列舉 | |
---|---|
UNIT_UNSPECIFIED |
單位不明。 |
PT |
一個點,1/72 英寸。 |
WeightedFontFamily
代表文字的字型系列和粗細。
JSON 表示法 |
---|
{ "fontFamily": string, "weight": integer } |
欄位 | |
---|---|
font |
文字的字型系列。 字型系列可以是 Google 文件的「字型」選單或 Google Fonts 中的任何字型。如果系統無法辨識字型名稱,文字會以 |
weight |
字型的粗細。這個欄位的值可以是 預設值為 字型粗細只是算繪字型粗細的其中一個元件。在考量繼承後,
|
BaselineOffset
文字可從正常位置垂直偏移的方式。
列舉 | |
---|---|
BASELINE_OFFSET_UNSPECIFIED |
文字的基準線偏移會繼承自父項。 |
NONE |
文字未垂直偏移。 |
SUPERSCRIPT |
文字會垂直向上偏移 (上標)。 |
SUBSCRIPT |
文字會垂直向下偏移 (下標)。 |
連結
參照文件的其他部分或外部網址資源。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 destination 。連結目的地。destination 只能是下列其中一項: |
|
url |
這是外部網址, |
tab |
這份文件中分頁的 ID。 |
bookmark |
本文件中的書籤。 在包含單一分頁的文件中,如果 |
heading |
本文件中的標題。 在含有單一分頁的文件中,如果 |
bookmark |
此文件中的書籤 ID。 舊版欄位:請改為將 如果這個欄位用於寫入要求,系統會將書籤視為來自要求中指定的分頁 ID。如果要求中未指定分頁 ID,系統會將其視為來自文件中的第一個分頁。 |
heading |
這份文件中標題的 ID。 舊版欄位:請改為將 如果在寫入要求中使用這個欄位,系統會將標題視為來自要求中指定的分頁 ID。如果要求中未指定分頁 ID,系統會將其視為來自文件中的第一個分頁。 |
BookmarkLink
本文件中的書籤參照。
JSON 表示法 |
---|
{ "id": string, "tabId": string } |
欄位 | |
---|---|
id |
這份文件中書籤的 ID。 |
tab |
包含此書籤的分頁 ID。 |
HeadingLink
參照這份文件中的標題。
JSON 表示法 |
---|
{ "id": string, "tabId": string } |
欄位 | |
---|---|
id |
這份文件中標題的 ID。 |
tab |
包含此標題的分頁 ID。 |
SuggestedTextStyle
對 TextStyle
提出的變更建議。
JSON 表示法 |
---|
{ "textStyle": { object ( |
欄位 | |
---|---|
text |
只包含這項建議中所做的變更的 |
text |
遮罩,用來指出在這個建議中,哪些基本 |
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 } |
欄位 | |
---|---|
bold |
指出是否有建議變更 |
italic |
指出 |
underline |
指出是否有建議變更 |
strikethrough |
指出 |
small |
指出是否有建議變更 |
background |
指出 |
foreground |
指出是否有建議變更 |
font |
指出是否有建議變更 |
weighted |
指出是否有建議變更 |
baseline |
指出是否有建議變更 |
link |
指出是否有建議變更 |
AutoText
ParagraphElement
代表文字內容中的一個位置,這些位置會隨時間變化的內容動態取代,例如頁碼。
JSON 表示法 |
---|
{ "type": enum ( |
欄位 | |
---|---|
type |
這個自動文字的類型。 |
suggested |
建議的插入 ID。如果 |
suggested |
建議刪除的 ID。如果為空白,表示系統不會建議刪除這項內容。 |
text |
此自動文字的文字樣式。 |
suggested |
建議文字樣式會變更為這段 AutoText,並以建議 ID 做為索引。 |
類型
自動文字類型。
列舉 | |
---|---|
TYPE_UNSPECIFIED |
未指定的自動簡訊類型。 |
PAGE_NUMBER |
輸入代表目前頁碼的自動文字。 |
PAGE_COUNT |
輸入代表文件總頁數的自動文字。 |
PageBreak
ParagraphElement
代表分頁符號。分頁符號會讓後續文字從下一頁頂端開始。
JSON 表示法 |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
欄位 | |
---|---|
suggested |
建議的插入 ID。如果是巢狀建議變更,一個 |
suggested |
建議刪除的 ID。如果空白,代表系統沒有建議刪除這項內容。 |
text |
此分頁的文字樣式。 與文字內容 (例如文字行和腳註參照) 類似,分頁符號的文字樣式可能會影響內容版面配置,以及插入在分頁符號旁的文字樣式。 |
suggested |
建議的文字樣式會變更為這個 PageBreak,並以建議 ID 做為索引。 |
ColumnBreak
代表分欄符號的 ParagraphElement
。欄位換行會讓後續文字從下一欄的頂端開始。
JSON 表示法 |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
欄位 | |
---|---|
suggested |
建議的插入 ID。如果 |
suggested |
建議刪除的 ID。如果為空白,表示系統不會建議刪除這項內容。 |
text |
這個 ColumnBreak 的文字樣式。 與文字內容 (例如文字行和註腳參照) 類似,分欄符的文字樣式可能會影響內容版面配置,以及插入在分欄符旁的文字樣式。 |
suggested |
建議文字樣式會變更為這個以建議 ID 做為索引的 ColumnBreak。 |
FootnoteReference
ParagraphElement
代表註腳參照。註腳參考是以數字呈現的內嵌內容,可以用來識別註腳。
JSON 表示法 |
---|
{ "footnoteId": string, "footnoteNumber": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
欄位 | |
---|---|
footnote |
包含此註腳參照內容的 |
footnote |
這個註腳的顯示數量。 |
suggested |
建議的插入 ID。如果 |
suggested |
建議刪除的 ID。如果為空白,表示系統不會建議刪除這項內容。 |
text |
此 FootnoteReference 的文字樣式。 |
suggested |
建議的文字樣式會變更為這個 FootnoteReference,並以建議 ID 做為索引。 |
HorizontalRule
代表水平線的 ParagraphElement
。
JSON 表示法 |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
欄位 | |
---|---|
suggested |
建議的插入 ID。如果 |
suggested |
建議刪除的 ID。如果為空白,表示系統不會建議刪除這項內容。 |
text |
此 HorizontalRule 的文字樣式。 與文字內容 (例如文字行和註腳參照) 類似,水平線的文字樣式可能會影響內容版面配置,以及插入在水平線旁的文字樣式。 |
suggested |
建議的文字樣式會變更為這個 HorizontalRule,並以建議 ID 做為索引。 |
方程式
代表方程式的 ParagraphElement
。
JSON 表示法 |
---|
{ "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ] } |
欄位 | |
---|---|
suggested |
建議的插入 ID。如果 |
suggested |
建議的刪除 ID。如果為空白,表示系統不會建議刪除這項內容。 |
InlineObjectElement
包含 InlineObject
的 ParagraphElement
。
JSON 表示法 |
---|
{ "inlineObjectId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
欄位 | |
---|---|
inline |
這個元素包含的 |
suggested |
建議的插入 ID。如果 |
suggested |
建議刪除的 ID。如果為空白,表示系統不會建議刪除這項內容。 |
text |
這個 InlineObjectElement 的文字樣式。 與文字內容 (例如文字行和附註參照) 類似,內嵌物件元素的文字樣式可能會影響內容版面配置,以及插入在文字旁邊的文字樣式。 |
suggested |
建議文字樣式會變更為此 InlineObject,並以建議 ID 做為索引。 |
人物
文件中提及的使用者或電子郵件地址。這些提及內容會以單一不可變動的元素形式顯示,其中包含使用者的姓名或電子郵件地址。
JSON 表示法 |
---|
{ "personId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
欄位 | |
---|---|
person |
僅供輸出。這個連結的專屬 ID。 |
suggested |
將此人連結插入文件的建議 ID。如果 |
suggested |
從文件中移除這位使用者連結的建議 ID。舉例來說,如果有多位使用者建議刪除 |
text |
這個 |
suggested |
建議文字樣式會變更為這個 |
person |
僅供輸出。這個 |
PersonProperties
已連結 Person
的專屬屬性。
JSON 表示法 |
---|
{ "name": string, "email": string } |
欄位 | |
---|---|
name |
僅供輸出。如果連結文字顯示使用者名稱,而非電子郵件地址,請輸入使用者名稱。 |
email |
僅供輸出。與這個 |
RichLink
指向 Google 資源 (例如雲端硬碟檔案、YouTube 影片或日曆活動) 的連結。
JSON 表示法 |
---|
{ "richLinkId": string, "suggestedInsertionIds": [ string ], "suggestedDeletionIds": [ string ], "textStyle": { object ( |
欄位 | |
---|---|
rich |
僅供輸出。這個連結的 ID。 |
suggested |
在文件中插入此連結的建議 ID。如果是巢狀建議變更, |
suggested |
從文件中移除這個連結的建議 ID。例如, |
text |
此 |
suggested |
建議文字樣式會變更為這個 |
rich |
僅供輸出。這個 |
RichLinkProperties
特定於 RichLink
的屬性。
JSON 表示法 |
---|
{ "title": string, "uri": string, "mimeType": string } |
欄位 | |
---|---|
title |
僅供輸出。連結中顯示的 |
uri |
僅供輸出。 |
mime |
|
ParagraphStyle
套用至整個段落的樣式。
繼承的段落樣式會在這個訊息中顯示為未設定的欄位。段落樣式的父項取決於段落樣式定義的位置:
Paragraph
上的 ParagraphStyle 繼承了段落對應的named style type
。named style
上的 ParagraphStyle 會繼承normal text
命名樣式。normal text
具名樣式的 ParagraphStyle 繼承文件編輯器中的預設段落樣式。- 表格中
Paragraph
元素的 ParagraphStyle 可能會從表格樣式繼承段落樣式。
如果段落樣式不是沿用上層項目,取消設定欄位會將樣式還原為與文件編輯器中預設值相符的值。
JSON 表示法 |
---|
{ "headingId": string, "namedStyleType": enum ( |
欄位 | |
---|---|
heading |
段落的標題 ID。如果為空白,則表示此段落並非標題。 這是唯讀屬性。 |
named |
段落的命名樣式類型。 由於更新已命名的樣式類型會影響 ParagraphStyle 中的其他屬性,因此系統會先套用已命名的樣式類型,再更新其他屬性。 |
alignment |
這個段落的文字對齊方式。 |
line |
行間距的大小,以正常值的百分比表示,其中正常值為 100.0。如果未設定,系統會沿用父項的值。 |
direction |
這個段落的文字方向。如果未設定,由於段落方向不會繼承,因此值預設為 |
spacing |
段落的間距模式。 |
space |
段落上方的額外空間大小。如未設定,則會沿用父項的值。 |
space |
段落下方的額外空白空間量。如未設定,則會沿用父項的值。 |
border |
本段與前後段落之間的邊框。如果未設定,系統會沿用父項的值。 如果相鄰段落具有相同的邊框和縮排屬性,系統就會算繪段落間框線。 您無法部分更新段落邊框。變更段落框線時,必須指定完整的新的框線。 |
border |
這個段落頂端的邊框。如果未設定,系統會沿用父項的值。 如果上方的段落有不同的框線和縮排屬性,則系統會顯示上框線。 您無法部分更新段落邊框。變更段落邊框時,必須完整指定新的邊框。 |
border |
本段落底部的邊框。如未設定,則會沿用父項的值。 如果下方段落的邊框和縮排屬性不同,系統就會算繪底部邊框。 您無法部分更新段落邊框。變更段落框線時,必須指定完整的新的框線。 |
border |
這個段落左側的邊框。如果未設定,系統會沿用父項的值。 您無法部分更新段落邊框。變更段落邊框時,必須完整指定新的邊框。 |
border |
這個段落右側的邊框。如果未設定,系統會沿用父項的值。 您無法部分更新段落邊框。變更段落邊框時,必須完整指定新的邊框。 |
indent |
段落首行縮排的長度。如果未設定,系統會沿用父項的值。 |
indent |
根據目前的段落方向,在段落開頭對應側的縮排量。如未設定,則會沿用父項的值。 |
indent |
根據目前段落方向,在文字結尾側的段落縮排量。如果未設定,系統會沿用父項的值。 |
tab |
這個段落的 tab 停用清單。分頁符號清單不會繼承。 這是唯讀屬性。 |
keep |
是否應盡可能將段落的所有行排列在同一頁面或欄中。如果未設定,系統會沿用父項的值。 |
keep |
是否應將此段落的至少一部分與下一個段落一起排版 (如果可行)。如果未設定,系統會沿用父項的值。 |
avoid |
是否避免在段落出現疑惑和孤立。如果未設定,系統會沿用父項的值。 |
shading |
段落的底色。如未設定,則會沿用父項的值。 |
page |
目前段落是否一律從頁面開頭開始。如果未設定,系統會沿用父項的值。 如果嘗試更新不支援區域 (包括 |
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 ( |
欄位 | |
---|---|
color |
邊框的顏色。 |
width |
框線的寬度。 |
padding |
邊框的邊框間距。 |
dash |
框線的虛線樣式。 |
DashStyle
可用於算繪線性幾何圖形的虛線類型。這些值是以「Office Open XML 檔案格式 - 基礎知識和標記語言參考資料」第 20.1.10.48 節所述的「ST_PresetLineDashVal」簡易類型為基礎,第 1 版是 ECMA-376 第 4 版。
列舉 | |
---|---|
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 ( |
欄位 | |
---|---|
offset |
此分頁停靠點與起始邊界之間的偏移量。 |
alignment |
這個分頁停靠點的對齊方式。如未設定,值會預設為 |
TabStopAlignment
定位點的對齊方式。
列舉 | |
---|---|
TAB_STOP_ALIGNMENT_UNSPECIFIED |
未指定定位點對齊。 |
START |
制表符會與行首對齊。此為預設值。 |
CENTER |
定位點會對齊線條中心。 |
END |
分頁符號會對齊至行尾。 |
陰影
段落的底色。
JSON 表示法 |
---|
{
"backgroundColor": {
object ( |
欄位 | |
---|---|
background |
這個段落陰影的背景顏色。 |
SuggestedParagraphStyle
對 ParagraphStyle
提出的變更建議。
JSON 表示法 |
---|
{ "paragraphStyle": { object ( |
欄位 | |
---|---|
paragraph |
|
paragraph |
表示這項建議中 |
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 ( |
欄位 | |
---|---|
heading |
指出是否有建議變更 |
named |
指出 |
alignment |
指出是否有建議變更 |
line |
指出 |
direction |
指出是否有建議變更 |
spacing |
指出是否有建議變更 |
space |
指出是否有建議變更 |
space |
指出 |
border |
指出是否有建議變更 |
border |
指出是否有建議變更 |
border |
指出是否有建議變更 |
border |
指出是否有建議變更 |
border |
指出是否有建議變更 |
indent |
指出是否有建議變更 |
indent |
指出是否有建議變更 |
indent |
指出是否有建議變更 |
keep |
指出 |
keep |
指出是否有建議變更 |
avoid |
指出是否有建議變更 |
shading |
一種遮罩,指出這項建議中 |
page |
指出是否有建議變更 |
ShadingSuggestionState
遮罩,用來指出在建議變更中,哪些基本 Shading
欄位已變更。對於設為 true 的任何欄位,都會有新的建議值。
JSON 表示法 |
---|
{ "backgroundColorSuggested": boolean } |
欄位 | |
---|---|
background |
指出是否有建議的 |
項目符號
說明段落的項目符號。
JSON 表示法 |
---|
{
"listId": string,
"nestingLevel": integer,
"textStyle": {
object ( |
欄位 | |
---|---|
list |
這段文字所屬清單的 ID。 |
nesting |
這個段落在清單中的巢狀層級。 |
text |
此項目符號套用的段落專屬文字樣式。 |
SuggestedBullet
Bullet
的建議變更。
JSON 表示法 |
---|
{ "bullet": { object ( |
欄位 | |
---|---|
bullet |
只包含這項建議中所做的變更的 |
bullet |
遮罩,用於指出在這個建議中,哪些基本 |
BulletSuggestionState
遮罩,用來指出在這個建議中,哪些基本 Bullet
欄位已變更。對於設為 true 的任何欄位,都會有新的建議值。
JSON 表示法 |
---|
{
"listIdSuggested": boolean,
"nestingLevelSuggested": boolean,
"textStyleSuggestionState": {
object ( |
欄位 | |
---|---|
list |
指出是否有建議的 |
nesting |
指出 |
text |
遮罩,指出在這個建議中, |
ObjectReferences
物件 ID 集合。
JSON 表示法 |
---|
{ "objectIds": [ string ] } |
欄位 | |
---|---|
object |
物件 ID。 |
SectionBreak
StructuralElement
代表分節符號。部分是指具有相同 SectionStyle
的內容範圍。分節符號代表新一節的開始,而分節樣式會套用至分節符號後的區段。
文件內文一律會以分節符號開頭。
JSON 表示法 |
---|
{
"suggestedInsertionIds": [
string
],
"suggestedDeletionIds": [
string
],
"sectionStyle": {
object ( |
欄位 | |
---|---|
suggested |
建議的插入 ID。如果 |
suggested |
建議的刪除 ID。如果為空白,表示系統不會建議刪除這項內容。 |
section |
此分隔符後的段落樣式。 |
SectionStyle
套用至區段的樣式。
JSON 表示法 |
---|
{ "columnProperties": [ { object ( |
欄位 | |
---|---|
column |
版塊的欄屬性。 如果是空白,則該區段會在文件編輯器中包含一個含有預設屬性的資料欄。您可以更新單元,使其最多只包含 3 個欄。 更新這個屬性時,必須設定具體值。取消設定這項屬性會導致 400 錯誤要求。 |
column |
資料欄分隔符的樣式。 即使區段中只有一欄,您也可以設定這類樣式。 更新這項屬性時,必須設定具體值。取消設定這個屬性會導致 400 錯誤要求。 |
content |
這個部分的內容方向。如未設定,值會預設為 更新這項屬性時,必須設定具體值。取消設定這個屬性會導致 400 無效要求錯誤。 |
margin |
版面上邊界。如果未設定,則預設值為 DocumentStyle 的 更新這個屬性時,必須設定具體值。取消設定此屬性會導致 400 錯誤要求。 |
margin |
版面底部邊界。如果未設定,則預設值為 DocumentStyle 的 更新這項屬性時,必須設定具體值。取消設定這個屬性會導致 400 錯誤要求錯誤。 |
margin |
區段的右邊頁邊界。如未設定,值會預設為 DocumentStyle 的 更新這項屬性時,必須設定具體值。取消設定這個屬性會導致 400 錯誤要求。 |
margin |
區段的左邊界。如未設定,值會預設為 DocumentStyle 的 更新這項屬性時,必須設定具體值。取消設定這個屬性會導致 400 錯誤要求錯誤。 |
margin |
區段的頁首邊界。如果未設定,則預設值為 DocumentStyle 的 更新這項屬性時,必須設定具體值。取消設定這個屬性會導致 400 錯誤要求錯誤。 |
margin |
區段的頁尾邊界。如果未設定,則預設值為 DocumentStyle 的 更新這個屬性時,必須設定具體值。取消設定此屬性會導致 400 錯誤要求。 |
section |
僅供輸出。版面類型。 |
default |
預設標頭的 ID。如果未設定,則值會繼承先前的 這個屬性處於唯讀狀態。 |
default |
預設頁尾的 ID。如果未設定,則值會繼承先前的 這是唯讀屬性。 |
first |
標頭 ID,僅用於該部分的第一頁。如果 這是唯讀屬性。 |
first |
只有版面第一頁的頁尾 ID。如果 這是唯讀屬性。 |
even |
僅用於偶數頁的標頭 ID。如果 DocumentStyle 的 這個屬性處於唯讀狀態。 |
even |
僅用於偶數頁的頁尾 ID。如果 DocumentStyle 的 這個屬性處於唯讀狀態。 |
use |
指出是否要為章節的第一頁使用第一頁標頭 / 頁尾 ID。如果未設定,則會繼承 DocumentStyle 的 更新這項屬性時,必須設定具體值。取消設定此屬性會導致 400 錯誤要求。 |
page |
這個部分的頁碼起始編號。如果未設定,頁碼會從上一節開始。如果在第一個 更新這個屬性時,必須設定具體值。取消設定此屬性會導致 400 錯誤要求。 |
flip |
選用設定。指出是否要翻轉這個部分的 DocumentStyle 的 更新這個屬性時,必須設定具體值。取消設定此屬性會導致 400 錯誤要求。 |
SectionColumnProperties
適用於某部分資料欄的屬性。
JSON 表示法 |
---|
{ "width": { object ( |
欄位 | |
---|---|
width |
僅供輸出。資料欄的寬度。 |
padding |
資料欄結尾的邊框間距。 |
ColumnSeparatorStyle
資料欄之間的分隔符樣式。
列舉 | |
---|---|
COLUMN_SEPARATOR_STYLE_UNSPECIFIED |
未指定資料欄分隔符樣式。 |
NONE |
資料欄之間沒有資料欄分隔線。 |
BETWEEN_EACH_COLUMN |
在每個資料欄之間顯示資料欄分隔線。 |
SectionType
代表目前區段的開始位置相對於前一區段的位置。
列舉 | |
---|---|
SECTION_TYPE_UNSPECIFIED |
未指定區段類型。 |
CONTINUOUS |
這個部分會緊接在前一節的最後一個段落後開始。 |
NEXT_PAGE |
該區段會在下一頁開始。 |
資料表
代表資料表的 StructuralElement
。
JSON 表示法 |
---|
{ "rows": integer, "columns": integer, "tableRows": [ { object ( |
欄位 | |
---|---|
rows |
資料表中的資料列數。 |
columns |
資料表中的欄數。 表格可能不是矩形,因此部分資料列的儲存格數量可能不同。 |
table |
每個資料列的內容和樣式。 |
suggested |
建議的插入 ID。如果 |
suggested |
建議的刪除 ID。如果為空白,表示系統不會建議刪除這項內容。 |
table |
表格樣式。 |
TableRow
Table
中資料列的內容和樣式。
JSON 表示法 |
---|
{ "startIndex": integer, "endIndex": integer, "tableCells": [ { object ( |
欄位 | |
---|---|
start |
這個資料列的起始索引,以 UTF-16 編碼單位表示。 |
end |
這個資料列的零起算結尾索引,以 UTF-16 碼元為單位。 |
table |
這個資料列中每個儲存格的內容和樣式。 表格可能不是矩形,因此某些資料列的儲存格數量可能與同一個表格中的其他資料列不同。 |
suggested |
建議的插入 ID。如果 |
suggested |
建議刪除的 ID。如果為空白,表示系統不會建議刪除這項內容。 |
table |
表格列的樣式。 |
suggested |
建議樣式會變更為這個以建議 ID 做為索引的資料列。 |
TableCell
Table
中儲存格內容和樣式。
JSON 表示法 |
---|
{ "startIndex": integer, "endIndex": integer, "content": [ { object ( |
欄位 | |
---|---|
start |
這個儲存格的起始索引從零開始,採用 UTF-16 程式碼單位。 |
end |
以 UTF-16 碼元為單位,這個儲存格的結尾索引 (從 0 開始)。 |
content[] |
儲存格內容。 |
table |
儲存格的樣式。 |
suggested |
建議的插入 ID。如果 |
suggested |
建議刪除的 ID。如果為空白,表示系統不會建議刪除這項內容。 |
suggested |
建議的表格儲存格樣式變更,並依建議 ID 輸入。 |
TableCellStyle
TableCell
的樣式。
繼承的資料表單元格樣式會在這個訊息中以未設定的欄位表示。表格儲存格樣式可繼承表格樣式。
JSON 表示法 |
---|
{ "rowSpan": integer, "columnSpan": integer, "backgroundColor": { object ( |
欄位 | |
---|---|
row |
儲存格的列距。 這個屬性處於唯讀狀態。 |
column |
儲存格在資料欄中的跨距。 這是唯讀屬性。 |
background |
儲存格的背景顏色。 |
border |
儲存格的左框線。 |
border |
儲存格的右側框線。 |
border |
儲存格的上框線。 |
border |
儲存格的底部框線。 |
padding |
儲存格左邊的邊框間距。 |
padding |
儲存格右邊的邊距。 |
padding |
儲存格的上邊框間距。 |
padding |
儲存格底部邊距。 |
content |
表格儲存格中內容的對齊方式。預設對齊方式會與 Google 文件編輯器中新建立的資料表儲存格對齊方式一致。 |
TableCellBorder
表格儲存格周圍的邊框。
表格儲存格邊框不得設為透明。如要隱藏表格儲存格邊框,請將邊框寬度設為 0。
JSON 表示法 |
---|
{ "color": { object ( |
欄位 | |
---|---|
color |
邊框的顏色。 這個顏色不得為透明。 |
width |
框線的寬度。 |
dash |
框線的虛線樣式。 |
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 ( |
欄位 | |
---|---|
table |
只包含這項建議中所做的變更的 |
table |
遮罩,用來指出在這個建議中,哪些基本 |
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 } |
欄位 | |
---|---|
row |
指出是否有建議變更 |
column |
指出是否有建議變更 |
background |
指出 |
border |
指出 |
border |
指出是否有建議變更 |
border |
指出 |
border |
指出是否有建議變更 |
padding |
指出 |
padding |
指出 |
padding |
指出 |
padding |
指出是否有建議變更 |
content |
指出 |
TableRowStyle
套用至表格資料列的樣式。
JSON 表示法 |
---|
{
"minRowHeight": {
object ( |
欄位 | |
---|---|
min |
資料列的最小高度。列在 Google 文件編輯器中顯示時,高度會等於或大於這個值,以便顯示列中儲存格中的所有內容。 |
table |
資料列是否為表格標題。 |
prevent |
資料列是否無法溢出頁面或欄界線。 |
SuggestedTableRowStyle
對 TableRowStyle
提出的變更建議。
JSON 表示法 |
---|
{ "tableRowStyle": { object ( |
欄位 | |
---|---|
table |
只包含這項建議中所做的變更的 |
table |
遮罩,用來指出在這個建議中,哪些基本 |
TableRowStyleSuggestionState
表示這項建議中 TableRowStyle
基礎中的哪些欄位已變更的遮罩。對於設為 true 的任何欄位,都會有新的建議值。
JSON 表示法 |
---|
{ "minRowHeightSuggested": boolean } |
欄位 | |
---|---|
min |
指出 |
TableStyle
套用至表格的樣式。
JSON 表示法 |
---|
{
"tableColumnProperties": [
{
object ( |
欄位 | |
---|---|
table |
每個資料欄的屬性。 請注意,在 Google 文件中,表格包含資料列,而資料列包含儲存格,類似於 HTML。因此,您可以在資料列的 |
TableColumnProperties
資料表中資料欄的屬性。
JSON 表示法 |
---|
{ "widthType": enum ( |
欄位 | |
---|---|
width |
資料欄的寬度類型。 |
width |
資料欄的寬度。設定資料欄的 |
WidthType
資料欄的寬度類型。
列舉 | |
---|---|
WIDTH_TYPE_UNSPECIFIED |
未指定資料欄寬度類型。 |
EVENLY_DISTRIBUTED |
資料欄寬度會平均分配給其他平均分配的資料欄。 系統會自動決定資料欄的寬度,並考量所有具有指定寬度的欄,然後保留相同比例的表格寬度。 |
FIXED_WIDTH |
固定的資料欄寬度。[width][google.apps.docs.v1.TableColumnProperties.width 屬性包含資料欄的寬度。 |
TableOfContents
StructuralElement
代表目錄。
JSON 表示法 |
---|
{
"content": [
{
object ( |
欄位 | |
---|---|
content[] |
目錄內容。 |
suggested |
建議的插入 ID。如果是巢狀建議變更, |
suggested |
建議刪除的 ID。如果為空白,表示系統不會建議刪除這項內容。 |
標頭
文件標題。
JSON 表示法 |
---|
{
"headerId": string,
"content": [
{
object ( |
欄位 | |
---|---|
header |
標頭的 ID。 |
content[] |
標頭內容。 標頭內容的索引從 0 開始。 |
註腳
文件註腳。
JSON 表示法 |
---|
{
"footnoteId": string,
"content": [
{
object ( |
欄位 | |
---|---|
footnote |
註腳的 ID。 |
content[] |
註腳內容。 附註內容的索引以零為起點。 |
DocumentStyle
文件樣式。
JSON 表示法 |
---|
{ "background": { object ( |
欄位 | |
---|---|
background |
文件的背景。證件不得使用透明背景顏色。 |
default |
預設標頭的 ID。如未設定,就不會有預設標頭。 這是唯讀屬性。 |
default |
預設頁尾的 ID。如果未設定,系統就不會顯示預設頁尾。 這個屬性處於唯讀狀態。 |
even |
標頭的 ID,僅適用於偶數網頁。 這是唯讀屬性。 |
even |
僅用於偶數頁的頁尾 ID。 這個屬性處於唯讀狀態。 |
first |
標頭 ID,僅用於第一頁。如果沒有設定,第一頁的標頭就會不存在。 這個屬性處於唯讀狀態。 |
first |
僅用於第一頁的頁尾 ID。如果未設定,第一頁就不會顯示專屬的頁尾。 這個屬性處於唯讀狀態。 |
use |
指出是否要使用第一頁的頁首 / 頁尾 ID。 |
use |
指出是否要使用偶數頁的頁首 / 頁尾 ID。 |
page |
開始計算頁數的頁碼。 |
margin |
頁面頂端邊界。 更新文件樣式的頁面頂端邊界後,所有區段樣式的頁面頂端邊界都會清除。 |
margin |
頁面底部邊界。 更新文件樣式的底部邊界會清除所有區段樣式的底部邊界。 |
margin |
右頁面邊界。 更新文件樣式的右頁面邊界會清除所有區段樣式的右頁面邊界。這也可能會導致所有部分的資料欄大小改變。 |
margin |
左頁邊界。 更新文件樣式的左頁邊界會清除所有區段樣式的左頁邊界。這也可能會導致所有部分的資料欄大小改變。 |
page |
文件中的頁面大小。 |
margin |
網頁頂端與標題內容之間的間距。 |
margin |
網頁底部與頁尾內容之間的間距。 |
use |
指出是否遵守 DocumentStyle 這是唯讀屬性。 |
flip |
選用設定。指出是否要翻轉 |
背景
代表文件背景。
JSON 表示法 |
---|
{
"color": {
object ( |
欄位 | |
---|---|
color |
背景顏色。 |
大小
寬度和高度。
JSON 表示法 |
---|
{ "height": { object ( |
欄位 | |
---|---|
height |
物件的高度。 |
width |
物件的寬度。 |
SuggestedDocumentStyle
對 DocumentStyle
的建議變更。
JSON 表示法 |
---|
{ "documentStyle": { object ( |
欄位 | |
---|---|
document |
只包含這項建議中所做的變更的 |
document |
遮罩,用來指出在這個建議中,哪些基本 |
DocumentStyleSuggestionState
遮罩,用來指出在這個建議中,哪些基本 DocumentStyle
欄位已變更。對於設為 true 的任何欄位,都會有新的建議值。
JSON 表示法 |
---|
{ "backgroundSuggestionState": { object ( |
欄位 | |
---|---|
background |
遮罩,指出在這個建議中, |
default |
指出是否有建議變更 |
default |
指出是否有建議變更 |
even |
指出是否有建議變更 |
even |
指出是否有建議變更 |
first |
指出是否有建議變更 |
first |
指出是否有建議變更 |
use |
指出是否有建議變更 |
use |
指出 |
page |
指出是否有建議變更 |
margin |
指出是否有建議變更 |
margin |
指出是否有建議變更 |
margin |
指出是否有建議變更 |
margin |
指出是否有建議變更 |
page |
這個遮罩會指出 [size] [google.apps.docs.v1.DocumentStyle.size] 中哪些欄位已變更。 |
margin |
指出 |
margin |
指出是否有建議變更 |
use |
指出是否有建議變更 |
flip |
選用設定。指出是否有建議變更 |
BackgroundSuggestionState
遮罩,用來指出在這個建議中,哪些基本 Background
欄位已變更。對於設為 true 的任何欄位,Backgound
會有新的建議值。
JSON 表示法 |
---|
{ "backgroundColorSuggested": boolean } |
欄位 | |
---|---|
background |
指出目前的背景顏色是否已修改這項建議。 |
SizeSuggestionState
JSON 表示法 |
---|
{ "heightSuggested": boolean, "widthSuggested": boolean } |
欄位 | |
---|---|
height |
指出是否有建議變更 |
width |
指出是否有建議變更 |
NamedStyles
命名風格。文件中的段落可以從這些命名格式繼承 TextStyle
和 ParagraphStyle
。
JSON 表示法 |
---|
{
"styles": [
{
object ( |
欄位 | |
---|---|
styles[] |
具名樣式。 每個可能的 |
NamedStyle
具名樣式。當文件中的段落具有相同的命名樣式類型時,段落可以從這個命名樣式繼承 TextStyle
和 ParagraphStyle
。
JSON 表示法 |
---|
{ "namedStyleType": enum ( |
欄位 | |
---|---|
named |
此具名樣式的類型。 |
text |
這個命名樣式的文字樣式。 |
paragraph |
此命名樣式的段落樣式。 |
SuggestedNamedStyles
對 NamedStyles
的建議變更。
JSON 表示法 |
---|
{ "namedStyles": { object ( |
欄位 | |
---|---|
named |
只包含這項建議中所做的變更的 |
named |
遮罩,用於指出在這個建議中,哪些基本 |
NamedStylesSuggestionState
NamedStyles
訊息的建議狀態。
JSON 表示法 |
---|
{
"stylesSuggestionStates": [
{
object ( |
欄位 | |
---|---|
styles |
遮罩,用於指出在這個建議中, 這些命名樣式建議狀態的順序,會與 |
NamedStyleSuggestionState
NamedStyle
訊息的建議狀態。
JSON 表示法 |
---|
{ "namedStyleType": enum ( |
欄位 | |
---|---|
named |
這個建議狀態對應的命名樣式類型。 這個欄位可讓您輕鬆將 NamedStyleSuggestionState 與對應的 |
text |
遮罩,指出建議內容中 |
paragraph |
一種遮罩,指出這項建議中 |
清單
List 代表屬於同一清單的一組段落清單屬性。清單中的段落在 bullet
中會參照清單 ID。
JSON 表示法 |
---|
{ "listProperties": { object ( |
欄位 | |
---|---|
list |
清單的屬性。 |
suggested |
對清單屬性的建議變更,並依建議 ID 輸入。 |
suggested |
建議的插入 ID。如果空白,表示這不是建議使用的插入方式。 |
suggested |
建議刪除的 ID。如果留空,則系統不會建議刪除這個清單。 |
ListProperties
list
的屬性,說明項目項目符號的外觀和風格。
JSON 表示法 |
---|
{
"nestingLevels": [
{
object ( |
欄位 | |
---|---|
nesting |
說明相關層級的項目符號特性。 清單最多可有 9 個巢狀層級,其中巢狀層級 0 對應於最頂層,巢狀層級 8 對應於最深層。系統會依遞增順序傳回巢狀層級,並優先傳回最小巢狀結構層級。 |
NestingLevel
包含的屬性可說明特定巢狀結構層級清單項目符號的外觀和風格。
JSON 表示法 |
---|
{ "bulletAlignment": enum ( |
欄位 | |
---|---|
bullet |
在用於顯示項目符號的空間中,項目符號的對齊方式。 |
glyph |
這個巢狀結構層級中項目符號使用的格式字串。 圖示格式包含一或多個預留位置,這些預留位置會根據 舉例來說,字符格式
字符格式可包含目前巢狀層級的預留位置,以及上層巢狀層級的預留位置。舉例來說,清單的圖示格式在巢狀層級 0 為
如為經過排序的巢狀層級,以字符格式取代特定段落的字串,取決於該段落在清單內的順序。 |
indent |
這個巢狀層級中,段落首行縮排的量。 |
indent |
這個巢狀層級的段落縮排量。根據段落內容方向,套用至與文字開頭相對應的側邊。 |
text |
此巢狀結構層級的項目符號文字樣式。 |
start |
這個巢狀層級中第一個清單項目的編號。 對於以字母和羅馬數字排序的清單,系統會將 0 視為 1。如果值同時為 0 和 1,有字母和羅馬數字的清單將分別從 對於包含無序圖形的巢狀層級,系統會忽略這個值。 |
聯集欄位 glyph_kind 。子彈使用的標記類型。這會定義用來取代 glyph_format 中預留位置的子彈符號標記。glyph_kind 只能是下列其中一項: |
|
glyph |
當這個巢狀層級的段落已排序時,用於標示項目符號的符號類型。 當這個巢狀層級的段落排序時,字符類型會決定用來取代 |
glyph |
當這個巢狀層級的段落為無序時,由項目符號使用的自訂字形符號。 字符符號會取代 |
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 ( |
欄位 | |
---|---|
list |
|
list |
遮罩,用來指出在這個建議中,哪些基本 |
ListPropertiesSuggestionState
表示這項建議中 ListProperties
基礎中的哪些欄位已變更的遮罩。對於設為 true 的任何欄位,都會有新的建議值。
JSON 表示法 |
---|
{
"nestingLevelsSuggestionStates": [
{
object ( |
欄位 | |
---|---|
nesting |
遮罩,用於指出在建議中, 系統會依巢狀層級遞增順序傳回巢狀層級建議狀態,先傳回最少巢狀層級。 |
NestingLevelSuggestionState
遮罩,用來指出在這個建議中,哪些基本 NestingLevel
欄位已變更。對於設為 true 的任何欄位,都會有新的建議值。
JSON 表示法 |
---|
{
"bulletAlignmentSuggested": boolean,
"glyphTypeSuggested": boolean,
"glyphFormatSuggested": boolean,
"glyphSymbolSuggested": boolean,
"indentFirstLineSuggested": boolean,
"indentStartSuggested": boolean,
"textStyleSuggestionState": {
object ( |
欄位 | |
---|---|
bullet |
指出 |
glyph |
指出是否有建議變更 |
glyph |
指出是否有建議變更 |
glyph |
指出 |
indent |
指出是否有建議變更 |
indent |
指出 |
text |
遮罩,指出建議內容中 |
start |
指出是否有建議變更 |
NamedRanges
文件中所有共用特定名稱的 NamedRange
集合。
JSON 表示法 |
---|
{
"name": string,
"namedRanges": [
{
object ( |
欄位 | |
---|---|
name |
所有 |
named |
具有相同名稱的 |
NamedRange
一組已命名範圍 ID 相同的 Range
。
開發人員可以使用命名範圍,將文件的部分內容與任意使用者定義的標籤建立關聯,以便日後透過程式讀取或編輯這些內容。一份文件可以包含多個名稱相同的命名範圍,但每個命名範圍都有專屬 ID。
系統會使用單一 Range
建立已命名範圍,而插入已命名範圍內的內容通常會擴展該範圍。不過,某些文件變更可能會導致範圍拆分為多個範圍。
已命名範圍屬於私人範圍。所有可存取文件的應用程式和協作者都能看到其命名範圍。
JSON 表示法 |
---|
{
"namedRangeId": string,
"name": string,
"ranges": [
{
object ( |
欄位 | |
---|---|
named |
命名範圍的 ID。 |
name |
已命名範圍的名稱。 |
ranges[] |
屬於此命名範圍的範圍。 |
範圍
指定連續的文字範圍。
JSON 表示法 |
---|
{ "segmentId": string, "startIndex": integer, "endIndex": integer, "tabId": string } |
欄位 | |
---|---|
segment |
這個範圍包含的標頭、頁尾或註腳 ID。空白的區隔 ID 代表文件的內容。 |
start |
這個範圍的起始索引,以 UTF-16 碼元為單位。 在目前的所有用途中,都必須提供起始索引。這個欄位是 Int32Value,以便日後支援開放式範圍的用途。 |
end |
這個範圍以零為基準的結束索引,不含 UTF-16 程式碼單位。 在目前的所有用途中,都必須提供結束索引。這個欄位為 Int32Value,目的是因應未來開放式範圍的用途。 |
tab |
包含這個範圍的分頁。若省略此參數,請求會套用至第一個分頁。 在包含單一分頁的文件中:
在含有多個分頁的文件中:
|
InlineObject
與文字內嵌顯示的物件。InlineObject 包含 EmbeddedObject
,例如圖片。
JSON 表示法 |
---|
{ "objectId": string, "inlineObjectProperties": { object ( |
欄位 | |
---|---|
object |
此內嵌物件 ID。可用來更新物件的屬性。 |
inline |
這個內嵌物件的屬性。 |
suggested |
建議對內嵌物件屬性所做的變更,並以建議 ID 做為索引。 |
suggested |
建議的插入 ID。如果空白,表示這不是建議使用的插入方式。 |
suggested |
建議刪除的 ID。如果為空白,表示系統不會建議刪除這項內容。 |
InlineObjectProperties
InlineObject
的屬性。
JSON 表示法 |
---|
{
"embeddedObject": {
object ( |
欄位 | |
---|---|
embedded |
這個內嵌物件的嵌入物件。 |
EmbeddedObject
文件中的嵌入物件。
JSON 表示法 |
---|
{ "title": string, "description": string, "embeddedObjectBorder": { object ( |
欄位 | |
---|---|
title |
嵌入物件的標題。 |
description |
嵌入物件的說明。 |
embedded |
嵌入物件的框線。 |
size |
裁剪後圖片的可見大小。 |
margin |
嵌入物件的上邊界。 |
margin |
內嵌物件的底部邊界。 |
margin |
內嵌物件的右邊界。 |
margin |
嵌入物件的左邊界。 |
linked |
外部連結來源內容的參照。舉例來說,如果嵌入的物件是連結圖表,則會包含來源 Google 試算表圖表的參照。 如果未設定,則內嵌物件不會連結。 |
聯集欄位 properties 。每個嵌入物件類型專屬的屬性。properties 只能是下列其中一項: |
|
embedded |
嵌入式繪圖的屬性。 |
image |
圖片的屬性。 |
EmbeddedDrawingProperties
這個類型沒有任何欄位。
嵌入式繪圖的屬性,用於區分物件類型。內嵌繪圖是在文件中建立及編輯的繪圖。請注意,系統不支援詳細資料。
圖片屬性
圖片的屬性。
JSON 表示法 |
---|
{
"contentUri": string,
"sourceUri": string,
"brightness": number,
"contrast": number,
"transparency": number,
"cropProperties": {
object ( |
欄位 | |
---|---|
content |
圖片的 URI,預設生命週期為 30 分鐘。這個 URI 會標記要求者的帳戶。任何知道 URI 的使用者都能以原始要求者的身分存取圖片。如果文件的共用設定有所變更,可能會失去圖片存取權。 |
source |
來源 URI 是用於插入圖片的 URI。來源 URI 可以留空。 |
brightness |
圖片的亮度效果。值應介於 [-1.0, 1.0] 之間,其中 0 表示無效果。 |
contrast |
圖片的對比效果。這個值應以間隔 [-1.0, 1.0] 表示,其中 0 代表沒有任何效果。 |
transparency |
圖片的透明度效果。這個值應介於 [0.0, 1.0] 之間,其中 0 表示無效果,1 表示透明。 |
crop |
圖片的裁剪屬性。 |
angle |
圖片順時針旋轉角度,以弧度為單位。 |
CropProperties
圖片的裁剪屬性。
裁剪矩形會以原始內容 4 個邊緣的部分偏移值表示。
- 如果偏移量介於 (0, 1) 之間,裁剪矩形的對應邊緣會位於圖片原始邊界矩形內。
- 如果偏移值為負值或大於 1,裁剪矩形的對應邊緣會位於圖片原始邊界矩形之外。
- 如果所有偏移和旋轉角度皆為 0,則系統不會裁剪圖片。
JSON 表示法 |
---|
{ "offsetLeft": number, "offsetRight": number, "offsetTop": number, "offsetBottom": number, "angle": number } |
欄位 | |
---|---|
offset |
偏移量會指定裁剪矩形的左邊緣距離原始內容左邊緣的距離,以原始內容的寬度為分母。 |
offset |
偏移值是用來指定裁剪矩形的右側邊緣與原始內容右側邊緣的距離,以原始內容寬度的比例為基準。 |
offset |
偏移值會指定裁剪矩形頂端邊緣與原始內容頂端邊緣之間的距離,以原始內容高度的百分比表示。 |
offset |
偏移值會指定裁剪矩形的底部邊緣與原始內容底部邊緣之間的距離,以原始內容高度的百分比表示。 |
angle |
裁剪矩形以其中心為基準,順時針旋轉的角度,以弧度為單位。系統會先套用偏移值,然後再套用旋轉。 |
EmbeddedObjectBorder
EmbeddedObject
周圍的邊框。
JSON 表示法 |
---|
{ "color": { object ( |
欄位 | |
---|---|
color |
邊框的顏色。 |
width |
框線的寬度。 |
dash |
框線的虛線樣式。 |
property |
邊框屬性的屬性狀態。 |
PropertyState
房源的可能狀態。
列舉 | |
---|---|
RENDERED |
如果屬性狀態為「已算繪」,則元素在文件中算繪時會具有對應的屬性。這是預設值。 |
NOT_RENDERED |
如果屬性狀態為 NOT_RENDERED,則元素在文件中顯示時,不會具有對應的屬性。 |
LinkedContentReference
外部連結來源內容的參照。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 reference 。特定連結內容類型的參照。reference 只能是下列其中一項: |
|
sheets |
連結圖表的參照。 |
SheetsChartReference
參照從 Google 試算表嵌入的連結圖表。
JSON 表示法 |
---|
{ "spreadsheetId": string, "chartId": integer } |
欄位 | |
---|---|
spreadsheet |
包含來源圖表的 Google 試算表試算表 ID。 |
chart |
嵌入的 Google 試算表試算表中特定圖表的 ID。 |
SuggestedInlineObjectProperties
對 InlineObjectProperties
的建議變更。
JSON 表示法 |
---|
{ "inlineObjectProperties": { object ( |
欄位 | |
---|---|
inline |
只包含這項建議中所做的變更的 |
inline |
遮罩,用於指出在這個建議中,哪些基本 |
InlineObjectPropertiesSuggestionState
遮罩,用來指出在這個建議中,哪些基本 InlineObjectProperties
欄位已變更。對於設為 true 的任何欄位,都會有新的建議值。
JSON 表示法 |
---|
{
"embeddedObjectSuggestionState": {
object ( |
欄位 | |
---|---|
embedded |
遮罩,指出在這個建議中, |
EmbeddedObjectSuggestionState
表示這項建議中 EmbeddedObject
基礎中的哪些欄位已變更的遮罩。對於設為 true 的任何欄位,都會有新的建議值。
JSON 表示法 |
---|
{ "embeddedDrawingPropertiesSuggestionState": { object ( |
欄位 | |
---|---|
embedded |
遮罩,指出建議內容中 |
image |
遮罩,指出建議內容中 |
title |
指出是否有建議變更 |
description |
指出是否有建議變更 |
embedded |
遮罩,指出在這個建議中, |
size |
遮罩,指出建議內容中 |
margin |
指出 |
margin |
指出是否有建議變更 |
margin |
指出是否有建議變更 |
margin |
指出是否有建議變更 |
linked |
遮罩,指出在這個建議中, |
EmbeddedDrawingPropertiesSuggestionState
這個類型沒有任何欄位。
遮罩,用來指出在這個建議中,哪些基本 EmbeddedDrawingProperties
欄位已變更。對於設為 true 的任何欄位,都會有新的建議值。
ImagePropertiesSuggestionState
遮罩,用來指出在這個建議中,哪些基本 ImageProperties
欄位已變更。對於設為 true 的任何欄位,都會有新的建議值。
JSON 表示法 |
---|
{
"contentUriSuggested": boolean,
"sourceUriSuggested": boolean,
"brightnessSuggested": boolean,
"contrastSuggested": boolean,
"transparencySuggested": boolean,
"cropPropertiesSuggestionState": {
object ( |
欄位 | |
---|---|
content |
指出 |
source |
指出對 [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri] 的變更有建議。 |
brightness |
指出是否建議變更 [brightness] [google.apps.docs.v1.EmbeddedObject.brightness]。 |
contrast |
指出是否有建議變更 [contrast] [google.apps.docs.v1.EmbeddedObject.contrast]。 |
transparency |
指出是否有建議變更 [transparency] [google.apps.docs.v1.EmbeddedObject.transparency]。 |
crop |
遮罩,指出在這個建議中, |
angle |
指出是否有建議變更 [angle] [google.apps.docs.v1.EmbeddedObject.angle]。 |
CropPropertiesSuggestionState
遮罩,用來指出在這個建議中,哪些基本 CropProperties
欄位已變更。對於設為 true 的任何欄位,都會有新的建議值。
JSON 表示法 |
---|
{ "offsetLeftSuggested": boolean, "offsetRightSuggested": boolean, "offsetTopSuggested": boolean, "offsetBottomSuggested": boolean, "angleSuggested": boolean } |
欄位 | |
---|---|
offset |
指出是否有建議變更 |
offset |
指出 |
offset |
指出是否有建議變更 |
offset |
指出是否有建議變更 |
angle |
指出是否有建議變更 |
EmbeddedObjectBorderSuggestionState
遮罩,用來指出在這個建議中,哪些基本 EmbeddedObjectBorder
欄位已變更。任何設為 true 的欄位都有新的建議值。
JSON 表示法 |
---|
{ "colorSuggested": boolean, "widthSuggested": boolean, "dashStyleSuggested": boolean, "propertyStateSuggested": boolean } |
欄位 | |
---|---|
color |
指出是否建議變更 [color] [google.apps.docs.v1.EmbeddedBorderObject.color]。 |
width |
指出是否有建議變更 [width] [google.apps.docs.v1.EmbeddedBorderObject.width]。 |
dash |
指出是否建議變更 [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style]。 |
property |
指出是否有建議變更 [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state]。 |
LinkedContentReferenceSuggestionState
表示這項建議中 LinkedContentReference
基礎中的哪些欄位已變更的遮罩。對於設為 true 的任何欄位,都會有新的建議值。
JSON 表示法 |
---|
{
"sheetsChartReferenceSuggestionState": {
object ( |
欄位 | |
---|---|
sheets |
一種遮罩,指出這項建議中 |
SheetsChartReferenceSuggestionState
遮罩,用來指出在這個建議中,哪些基本 SheetsChartReference
欄位已變更。任何設為 true 的欄位都有新的建議值。
JSON 表示法 |
---|
{ "spreadsheetIdSuggested": boolean, "chartIdSuggested": boolean } |
欄位 | |
---|---|
spreadsheet |
指出是否有建議變更 |
chart |
指出 |
PositionedObject
與 Paragraph
綁定,並相對於段落開頭定位的物件。PositionedObject 包含 EmbeddedObject
,例如圖片。
JSON 表示法 |
---|
{ "objectId": string, "positionedObjectProperties": { object ( |
欄位 | |
---|---|
object |
這個已定位物件的 ID。 |
positioned |
這個已定位物件的屬性。 |
suggested |
對已定位物件屬性建議的變更,以建議 ID 做為索引。 |
suggested |
建議的插入 ID。如果為空白,則表示這不是建議的插入位置。 |
suggested |
建議刪除的 ID。如果為空白,表示系統不會建議刪除這項內容。 |
PositionedObjectProperties
PositionedObject
的屬性。
JSON 表示法 |
---|
{ "positioning": { object ( |
欄位 | |
---|---|
positioning |
此定位物件相對於參照此定位物件的 |
embedded |
這個已定位物件的嵌入物件。 |
PositionedObjectPositioning
PositionedObject
的位置。已定位的物件會相對於繫結的 Paragraph
起始位置定位。
JSON 表示法 |
---|
{ "layout": enum ( |
欄位 | |
---|---|
layout |
這個已定位物件的版面配置。 |
left |
相對於繫結的 |
top |
相對於連結的 |
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 ( |
欄位 | |
---|---|
positioned |
只包含這項建議中所做的變更的 |
positioned |
表示這項建議中 |
PositionedObjectPropertiesSuggestionState
遮罩,用來指出在這個建議中,哪些基本 PositionedObjectProperties
欄位已變更。對於設為 true 的任何欄位,都會有新的建議值。
JSON 表示法 |
---|
{ "positioningSuggestionState": { object ( |
欄位 | |
---|---|
positioning |
遮罩,指出建議內容中 |
embedded |
遮罩,指出建議內容中 |
PositionedObjectPositioningSuggestionState
遮罩,用來指出在這個建議中,哪些基本 PositionedObjectPositioning
欄位已變更。任何設為 true 的欄位都有新的建議值。
JSON 表示法 |
---|
{ "layoutSuggested": boolean, "leftOffsetSuggested": boolean, "topOffsetSuggested": boolean } |
欄位 | |
---|---|
layout |
指出是否有建議變更 |
left |
指出 |
top |
指出是否有建議變更 |
SuggestionsViewMode
套用至文件的建議檢視模式,指出建議變更的呈現方式。提供選項,可在讀取文件時,將所有建議內嵌、接受或拒絕。
列舉 | |
---|---|
DEFAULT_FOR_CURRENT_ACCESS |
系統會根據使用者的目前存取層級,決定要套用至傳回文件的 SuggestionsViewMode。如果使用者只有檢視權限,則會套用 PREVIEW_WITHOUT_SUGGESTIONS 。否則會套用 SUGGESTIONS_INLINE 。這是預設的建議檢視模式。 |
SUGGESTIONS_INLINE |
傳回的文件內含建議內容。系統會在文件中將建議的變更與基本內容區分開來。 如果使用者沒有權限查看建議的變更,則使用此模式要求擷取文件時,系統會傳回 403 錯誤。 |
PREVIEW_SUGGESTIONS_ACCEPTED |
系統會傳回預覽文件,其中包含所有已接受的建議變更。 如果使用者沒有權限查看建議的變更,則使用此模式要求擷取文件時,系統會傳回 403 錯誤。 |
PREVIEW_WITHOUT_SUGGESTIONS |
傳回的文件為預覽畫面,其中會列出文件中的任何建議變更, |
方法 |
|
---|---|
|
為文件套用一或多項更新。 |
|
使用要求中提供的標題建立空白文件。 |
|
取得指定文件的最新版本。 |