Requests

object (ReplaceAllTextRequest)

取代指定文字的所有例項。

object (InsertTextRequest)

在指定位置插入文字。

object (UpdateTextStyleRequest)

更新指定範圍的文字樣式。

object (CreateParagraphBulletsRequest)

為段落建立項目符號。

object (DeleteParagraphBulletsRequest)

從段落中刪除項目符號。

object (CreateNamedRangeRequest)

建立已命名範圍。

object (DeleteNamedRangeRequest)

刪除已命名範圍。

object (UpdateParagraphStyleRequest)

更新指定範圍內的段落樣式。

object (DeleteContentRangeRequest)

刪除文件中的內容。

object (InsertInlineImageRequest)

在指定位置插入內嵌圖片。

object (InsertTableRequest)

在指定位置插入表格。

object (InsertTableRowRequest)

在資料表中插入空白資料列。

object (InsertTableColumnRequest)

在資料表中插入空欄。

object (DeleteTableRowRequest)

從資料表刪除資料列。

object (DeleteTableColumnRequest)

從資料表刪除資料欄。

object (InsertPageBreakRequest)

在指定位置插入分頁符號。

object (DeletePositionedObjectRequest)

從文件中刪除已定位的物件。

object (UpdateTableColumnPropertiesRequest)

更新資料表中資料欄的屬性。

object (UpdateTableCellStyleRequest)

更新表格儲存格的樣式。

object (UpdateTableRowStyleRequest)

更新資料表中的資料列樣式。

object (ReplaceImageRequest)

替換文件中的圖片。

object (UpdateDocumentStyleRequest)

更新文件的樣式。

object (MergeTableCellsRequest)

合併表格中的儲存格。

object (UnmergeTableCellsRequest)

取消合併表格中的儲存格。

object (CreateHeaderRequest)

建立標頭。

object (CreateFooterRequest)

建立頁尾。

object (CreateFootnoteRequest)

建立腳註。

object (ReplaceNamedRangeContentRequest)

取代指定範圍中的內容。

object (UpdateSectionStyleRequest)

更新指定範圍的區段樣式。

object (InsertSectionBreakRequest)

在指定位置插入分節符號。

object (DeleteHeaderRequest)

刪除文件中的標頭。

object (DeleteFooterRequest)

從文件中刪除頁尾。

object (PinTableHeaderRowsRequest)

更新資料表中的固定標題列數量。

string

系統會用這段文字取代相符的文字。

object (TabsCriteria)

選用設定。用來指定要替換哪些分頁的條件。

如果省略，則替換項目會套用至所有分頁。

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

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

• 如果省略，取代功能會套用至單一分頁。

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

• 如果提供，則會將替換項目套用至指定的分頁。

• 如果省略，則替換項目會套用至所有分頁。

object (SubstringMatchCriteria)

尋找文件中與此子字串相符的文字。

string

要在文件中搜尋的文字。

boolean

指出搜尋是否應區分大小寫：

• True ：搜尋時會區分大小寫。
• False ：搜尋時不區分大小寫。

string

要求執行作業的分頁 ID 清單。

string

要插入的文字。

插入換行字元會在該索引處隱含建立新的 Paragraph。新段落的段落樣式會從目前插入索引的段落複製，包括清單和項目符號。

系統會自動決定插入文字的文字樣式，通常會保留相鄰文字的樣式。在大多數情況下，插入文字的文字樣式會緊接在插入索引之前的文字。

插入的文字會移除部分控制字元 (U+0000-U+0008、U+000C-U+001F) 和 Unicode 基本多語言字面私人使用區域 (U+E000-U+F8FF) 中的字元。

object (Location)

在文件的特定索引處插入文字。

文字必須插入現有 Paragraph 的邊界內。舉例來說，文字無法插入表格的起始索引 (也就是表格與前一個段落之間)。文字必須插入在前段中。

object (EndOfSegmentLocation)

在頁首、頁尾、註腳或文件內文結尾插入文字。

string

位置所在頁首、頁尾或註腳的 ID。空白的區隔 ID 代表文件的內文。

integer

以 UTF-16 程式碼單位表示的零基索引。

索引相對於 segmentId 指定的區段開頭。

string

位置所在的分頁。如果省略，要求會套用至第一個分頁。

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

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

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

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

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

• 如果省略這個值，要求就會套用至文件中的第一個分頁。

string

位置所在的頁首、頁尾或附註 ID。空白區段 ID 代表文件的內文。

string

位置所在的分頁。如果省略，要求會套用至第一個分頁。

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

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

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

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

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

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

object (TextStyle)

要設定的文字樣式。

如果特定樣式的值與父項的值相符，樣式就會設為沿用。

某些文字樣式變更可能會導致其他變更，以便反映 Google 文件編輯器的行為。詳情請參閱 TextStyle 的說明文件。

string (FieldMask format)

應更新的欄位。

至少須指定一個欄位。根 textStyle 是隱含的，因此不應指定。單一 "*" 可用來簡短列出每個欄位。

例如，如要將文字樣式更新為粗體，請將 fields 設為 "bold"。

如要將屬性重設為預設值，請在欄位遮罩中加入欄位名稱，但將欄位本身設為未設定。

object (Range)

要設定樣式的文字範圍。

範圍可能會延伸至包含相鄰換行符號的範圍。

如果範圍完全包含屬於清單的段落，段落的項目符號也會更新為相符的文字樣式。

無法在相對的 UpdateTextStyleRequest 中插入範圍。

object (Range)

要套用子彈圖示預設值的範圍。

enum (BulletGlyphPreset)

要使用的項目符號類型。

object (Range)

要刪除項目符號的範圍。

string

NamedRange 的名稱。名稱不必是唯一值。

名稱長度必須至少為 1 個字元，且不得超過 256 個字元 (以 UTF-16 程式碼單位計算)。

object (Range)

要套用名稱的範圍。

object (TabsCriteria)

選用設定。用來指定要刪除範圍的資料分頁。如果省略，範圍刪除作業會套用至所有分頁。

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

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

• 如果省略，系統會將刪除範圍套用至單一分頁。

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

• 如有提供，範圍刪除設定會套用至指定分頁。

• 如未提供，範圍刪除作業會套用至所有分頁。

string

要刪除的已命名範圍 ID。

string

要刪除的範圍名稱。系統會刪除所有具有指定名稱的已命名範圍。

object (ParagraphStyle)

要套用至段落的樣式。

某些段落樣式變更可能會導致其他變更，以便反映 Google 文件編輯器的行為。詳情請參閱 ParagraphStyle 的說明文件。

string (FieldMask format)

應更新的欄位。

至少須指定一個欄位。根 paragraphStyle 是隱含的，因此不應指定。單一 "*" 可用來簡短列出每個欄位。

舉例來說，如要更新段落樣式的對齊屬性，請將 fields 設為 "alignment"。

如要將屬性重設為預設值，請在欄位遮罩中加入欄位名稱，但不要設定該欄位本身。

object (Range)

重疊段落的範圍，以便套用樣式。

object (Range)

要刪除的內容範圍。

如果刪除跨段落邊界的文字，可能會在兩個段落合併後變更段落樣式、清單、定位物件和書籤。

嘗試刪除特定範圍可能會導致無效的文件結構，在這種情況下，系統會傳回 400 錯誤要求錯誤。

以下列舉一些無效的刪除要求：

• 刪除代理對的一組代碼。
• 刪除 Body、Header、Footer、Footnote、TableCell 或 TableOfContents 的最後一個換行字元。
• 刪除 Table、TableOfContents 或 Equation 的開頭或結尾，而不刪除整個元素。
• 刪除 Table、TableOfContents 或 SectionBreak 前面的換行字元，但不刪除元素。
• 刪除資料表中的個別資料列或儲存格。允許刪除表格儲存格中的內容。

string

圖片 URI。

系統會在插入時擷取圖片一次，並儲存副本供文件內顯示。圖片檔案大小不得超過 50 MB、不得超過 2500 萬像素，且須為 PNG、JPEG 或 GIF 格式。

提供的 URI 必須可供所有人存取，且長度不得超過 2 KB。URI 本身會與圖片一併儲存，並透過 ImageProperties.content_uri 欄位公開。

object (Size)

圖片應如文件中所示的大小。這個屬性為選用屬性，且文件中的圖片最終大小取決於下列規則：* 如未指定寬度或高度，系統會根據解析度計算預設圖片大小。* 如果指定一個尺寸，系統會計算另一個尺寸，以保留圖片的顯示比例。* 如果同時指定寬度和高度，系統會將圖片縮放至指定的尺寸，同時保留顯示比例。

object (Location)

在文件的特定索引處插入圖片。

圖片必須插入現有 Paragraph 的邊界內。舉例來說，您無法在表格的起始索引 (也就是表格與前一個段落之間) 插入這類內容。

內嵌圖片無法插入於附註或公式中。

object (EndOfSegmentLocation)

在頁首、頁尾或文件內文結尾插入文字。

無法在註腳中插入內嵌圖片。

integer

資料表中的資料列數。

integer

資料表中的欄數。

object (Location)

在特定模型索引處插入表格。

系統會在插入的資料表前插入換行字元，因此資料表的起始索引會是指定位置索引 + 1。

資料表必須插入現有 Paragraph 的邊界內。舉例來說，系統無法將結構定義插入資料表的起始索引 (也就是現有資料表與前段之間)。

無法在註腳或方程式中插入表格。

object (EndOfSegmentLocation)

在指定的頁首、頁尾或文件內文結尾處插入表格。系統會在插入的表格前插入換行字元。

無法在註腳中插入表格。

object (TableCellLocation)

要插入資料列的參照表格儲存格位置。

系統會在參照儲存格所在的列上方 (或下方) 插入新列。如果參照儲存格是合併儲存格，系統會在合併儲存格上方 (或下方) 插入新列。

boolean

是否要在參照儲存格位置下方插入新列。

• True ：插入至儲存格下方。
• False：在儲存格上方插入。

object (Location)

表格在文件中的起始位置。

integer

從零開始的資料列索引。舉例來說，資料表中的第二列資料列索引為 1。

integer

從零開始的資料欄索引。舉例來說，表格中的第二欄資料欄索引為 1。

object (TableCellLocation)

要插入資料欄的參照表格儲存格位置。

系統會在參照儲存格所在的資料欄左側 (或右側) 插入新資料欄。如果參照儲存格是合併儲存格，系統會在合併儲存格的左側 (或右側) 插入新資料欄。

boolean

是否要在參照儲存格位置的右側插入新欄。

• True ：插入至右側。
• False ：向左插入。

object (TableCellLocation)

要刪除資料列的參照表格儲存格位置。

系統會刪除這個儲存格跨越的資料列。如果這是跨越多列的合併儲存格，系統會刪除跨越的所有列。如果刪除後資料表中沒有任何資料列，則會刪除整個資料表。

object (TableCellLocation)

要刪除資料欄的參照表格儲存格位置。

即將刪除這個儲存格範圍的資料欄。如果合併的儲存格涵蓋多個資料欄，則儲存格範圍涵蓋的所有資料欄將遭到刪除。如果刪除後資料表中沒有任何資料欄，則會刪除整個資料表。

object (Location)

在文件的特定索引處插入分頁符。

您必須在現有 Paragraph 的邊界內插入分頁符號。舉例來說，您無法在表格的起始索引 (也就是表格與前一個段落之間) 插入這類內容。

分頁符號無法插入表格、方程式、註腳、標頭或頁尾。由於分頁符號只能插入內文中，因此 segment ID 欄位必須為空白。

object (EndOfSegmentLocation)

在文件內文結尾插入分頁符號。

分頁符號無法插入在附註、標頭或頁尾中。由於分頁符號只能插入內文中，因此 segment ID 欄位必須為空白。

string

要刪除的位置物件 ID。

string

要刪除的物件所在的分頁。如果省略，要求會套用至第一個分頁。

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

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

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

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

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

• 如果省略這個值，要求就會套用至文件中的第一個分頁。

object (Location)

文件中表格的位置。

integer

應更新屬性的零起始欄索引清單。如果未指定索引，系統會更新所有資料欄。

object (TableColumnProperties)

要更新的表格欄屬性。

如果 tableColumnProperties#width 的值小於 5 點 (5/72 英寸)，系統會傳回 400 錯誤的要求錯誤。

string (FieldMask format)

要更新的欄位。

至少須指定一個欄位。根層級 tableColumnProperties 為默示值，因此不應指定。單一 "*" 可用來簡短列出每個欄位。

例如，如要更新資料欄寬度，請將 fields 設為 "width"。

object (TableCellStyle)

要在表格儲存格上設定的樣式。

更新邊框時，如果某個儲存格與相鄰儲存格共用邊框，相鄰儲存格的對應邊框屬性也會一併更新。系統不會更新合併且隱藏的邊框。

由於在同一項要求中更新相鄰儲存格共用的邊框可能會導致邊框更新衝突，因此邊框更新會依下列順序套用：

• borderRight
• borderLeft
• borderBottom
• borderTop

string (FieldMask format)

應更新的欄位。

至少須指定一個欄位。根 tableCellStyle 是隱含的，因此不應指定。單一 "*" 可用於列出每個欄位的快捷方式。

舉例來說，如要更新表格儲存格的背景顏色，請將 fields 設為 "backgroundColor"。

如要將屬性重設為預設值，請在欄位遮罩中加入欄位名稱，但將欄位本身設為未設定。

object (TableRange)

這個表格範圍代表要套用更新的資料表中子集。

object (Location)

表格在文件中的起始位置。如有指定，系統會將更新套用至表格中的所有儲存格。

object (TableCellLocation)

表格範圍的起始儲存格位置。

integer

表格範圍的列跨距。

integer

表格範圍的欄跨距。

object (Location)

表格在文件中的起始位置。

integer

從零開始列索引的清單，其樣式應更新。如果沒有指定索引，則會更新所有資料列。

object (TableRowStyle)

要在資料列上設定的樣式。

string (FieldMask format)

應更新的欄位。

至少須指定一個欄位。根層級 tableRowStyle 為默示值，因此不應指定。單一 "*" 可用來簡短列出每個欄位。

例如，如要更新最小列高，請將 fields 設為 "minRowHeight"。

string

要取代的現有圖片 ID。您可以從 get 要求的回應中擷取 ID。

string

新映像檔的 URI。

系統會在插入圖片時擷取圖片一次，並會儲存副本以供在文件中顯示。圖片大小不得超過 50 MB，且不得超過 2,000 萬像素，格式必須為 PNG、JPEG 或 GIF。

所提供的 URI 長度不得超過 2 KB。URI 會與圖片一併儲存，並透過 ImageProperties.source_uri 欄位公開。

enum (ImageReplaceMethod)

替換方法。

string

要取代的圖片所在的分頁。如果省略，要求會套用至第一個分頁。

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

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

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

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

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

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

object (DocumentStyle)

要在文件上設定的樣式。

部分文件樣式變更可能會使其他變更，以反映文件編輯器的行為。詳情請參閱 DocumentStyle 的說明文件。

string (FieldMask format)

應更新的欄位。

至少須指定一個欄位。根 documentStyle 是隱含的，因此不應指定。單一 "*" 可用來簡短列出每個欄位。

例如，如要更新背景，請將 fields 設為 "background"。

string

包含要更新樣式的分頁。若省略這項屬性，要求會套用至第一個分頁。

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

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

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

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

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

• 如果未提供，請求會套用至文件中的第一個分頁。

object (TableRange)

表格範圍，用於指定要合併表格的儲存格。

合併儲存格中的任何文字都會串連，並儲存在該區間的「頭」儲存格中。當內容方向為由左至右時，這會是範圍的左上方儲存格，否則則是範圍的右上方儲存格。

如果範圍不是矩形 (在某些範圍涵蓋已合併的儲存格，或表格不是矩形的情況下，可能會發生這種情況)，系統會傳回 400 錯誤要求錯誤。

object (TableRange)

指定表格中要取消合併的儲存格表格範圍。

這個範圍內的所有合併儲存格都會取消合併，但已取消合併的儲存格不會受到影響。如果指定範圍內沒有合併的儲存格，要求就不會執行任何操作。

如果合併的儲存格中有任何文字，文字仍會保留在系統所產生未合併儲存格的「head」儲存格中。如果內容方向是從左到右，則「頭部」儲存格是左上角儲存格，否則是右上角儲存格。

enum (HeaderFooterType)

要建立的標頭類型。

object (Location)

這個標頭應屬於的部分開頭的 SectionBreak 位置。如果未設定 `sectionBreakLocation`，或如果該值參照文件主體中的第一個區段分隔符，標題會套用至 DocumentStyle

enum (HeaderFooterType)

要建立的頁尾類型。

object (Location)

SectionBreak 的位置，緊接在 SectionStyle 所屬的部分之前。如未設定這項政策，或參照文件中第一個分節符號，則頁尾會套用至文件樣式。

object (Location)

在文件的特定索引中插入註腳參照。

註腳參照必須插入現有 Paragraph 的邊界內。舉例來說，您無法在表格的起始索引 (也就是表格與前一個段落之間) 插入這類內容。

註腳參照無法插入方程式、頁首、頁尾或註腳中。註腳參照只能插入內文，因此 segment ID 欄位必須留空。

object (EndOfSegmentLocation)

在文件內文結尾插入註腳參考。

不得在標頭、頁尾或註腳中插入註腳參考。註腳參照只能插入內文，因此 segment ID 欄位必須留空。

object (TabsCriteria)

選用設定。用來指定要替換哪些分頁的條件。如果省略，則替換項目會套用至所有分頁。

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

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

• 如果省略，取代功能會套用至單一分頁。

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

• 如果提供，則會將替換項目套用至指定的分頁。

• 如果省略，則替換項目會套用至所有分頁。

string

將指定已命名範圍的內容替換成指定文字。

string

要取代內容的命名區塊 ID。

如果沒有指定 ID 的命名區間，系統會傳回 400 錯誤要求錯誤。

string

內容將會替換的 NamedRanges 名稱。

如果有多個named ranges 使用指定名稱，則會取代每個名稱的內容。如果沒有指定名稱的已命名範圍，則要求為免人工管理。

object (Range)

要樣式的區段重疊的範圍。

由於分節符號只能插入內文中，因此 segment ID 欄位必須為空白。

object (SectionStyle)

要套用至區段的樣式。

為了反映 Google 文件編輯器的行為，某些段落樣式變更可能會導致其他變更。詳情請參閱 SectionStyle 的說明文件。

string (FieldMask format)

要更新的欄位。

至少須指定一個欄位。根層級 sectionStyle 為默示值，因此不得指定。單一 "*" 可用於列出每個欄位的簡寫。

舉例來說，如要更新左側邊界，請將 fields 設為 "marginLeft"。

enum (SectionType)

要插入的段落類型。

object (Location)

在文件的特定索引插入換行符號和分節符號。

區段分隔符必須插入現有 Paragraph 的邊界內。舉例來說，您無法在表格的起始索引 (也就是表格與前一個段落之間) 插入這類內容。

無法在表格、方程式、註腳、標題或頁尾中插入分節符號。由於區段分隔符只能插入內文中，因此 segment ID 欄位必須為空白。

object (EndOfSegmentLocation)

在文件主體結尾處插入換行符號和區段分隔符。

您無法在附註、頁首或頁尾中插入區段分隔符。由於分節符號只能插入內文中，因此 segment ID 欄位必須為空白。

string

要刪除的標頭 ID。如果此標頭是在 DocumentStyle 上定義，系統會移除對此標頭的參照，導致文件的第一個部分沒有該類型的標頭。如果這個標頭是在 SectionStyle 上定義，系統會移除對此標頭的參照，並從上一個區段繼續使用該類型的標頭。

string

包含要刪除的標頭的分頁。如果省略，要求會套用至第一個分頁。

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

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

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

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

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

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

string

要刪除的頁尾 ID。如果這個頁尾是在 DocumentStyle 上定義，系統會移除對這個頁尾的參照，導致文件第一個部分沒有這類頁尾。如果這個頁尾是在 SectionStyle 上定義，系統會移除對這個頁尾的參照，並從上一個部分繼續使用該類型的頁尾。

string

包含待刪除頁尾的分頁。如果省略，要求會套用至第一個分頁。

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

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

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

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

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

• 如果省略這個值，要求就會套用至文件中的第一個分頁。

object (Location)

表格在文件中的起始位置。

integer

要固定的資料表資料列數量，其中 0 表示所有資料列都會解除固定。