Requests

要求

要套用至文件的單一更新。

JSON 表示法 
{

  // Union field request can be only one of the following:
  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "createNamedRange": {
    object (CreateNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "deleteContentRange": {
    object (DeleteContentRangeRequest)
  },
  "insertInlineImage": {
    object (InsertInlineImageRequest)
  },
  "insertTable": {
    object (InsertTableRequest)
  },
  "insertTableRow": {
    object (InsertTableRowRequest)
  },
  "insertTableColumn": {
    object (InsertTableColumnRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "insertPageBreak": {
    object (InsertPageBreakRequest)
  },
  "deletePositionedObject": {
    object (DeletePositionedObjectRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableCellStyle": {
    object (UpdateTableCellStyleRequest)
  },
  "updateTableRowStyle": {
    object (UpdateTableRowStyleRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateDocumentStyle": {
    object (UpdateDocumentStyleRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "createHeader": {
    object (CreateHeaderRequest)
  },
  "createFooter": {
    object (CreateFooterRequest)
  },
  "createFootnote": {
    object (CreateFootnoteRequest)
  },
  "replaceNamedRangeContent": {
    object (ReplaceNamedRangeContentRequest)
  },
  "updateSectionStyle": {
    object (UpdateSectionStyleRequest)
  },
  "insertSectionBreak": {
    object (InsertSectionBreakRequest)
  },
  "deleteHeader": {
    object (DeleteHeaderRequest)
  },
  "deleteFooter": {
    object (DeleteFooterRequest)
  },
  "pinTableHeaderRows": {
    object (PinTableHeaderRowsRequest)
  }
  // End of list of possible types for union field request.
}
欄位
聯集欄位 request。要套用的具體要求。必須指定一個欄位。 request 只能是下列其中一個：
replaceAllText

object (ReplaceAllTextRequest)

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

insertText

object (InsertTextRequest)

在指定位置插入文字。

updateTextStyle

object (UpdateTextStyleRequest)

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

object (CreateParagraphBulletsRequest)

為段落建立項目符號。
deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

從段落中刪除項目符號。

createNamedRange

object (CreateNamedRangeRequest)

建立命名範圍。
deleteNamedRange

object (DeleteNamedRangeRequest)

刪除已命名範圍。
updateParagraphStyle

object (UpdateParagraphStyleRequest)

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

object (DeleteContentRangeRequest)

刪除文件中的內容。
insertInlineImage

object (InsertInlineImageRequest)

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

object (InsertTableRequest)

在指定位置插入表格。
insertTableRow

object (InsertTableRowRequest)

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

object (InsertTableColumnRequest)

在資料表中插入空欄。
deleteTableRow

object (DeleteTableRowRequest)

從資料表刪除資料列。
deleteTableColumn

object (DeleteTableColumnRequest)

從資料表中刪除資料欄。
insertPageBreak

object (InsertPageBreakRequest)

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

object (DeletePositionedObjectRequest)

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

object (UpdateTableColumnPropertiesRequest)

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

updateTableCellStyle

object (UpdateTableCellStyleRequest)

更新表格儲存格的樣式。
updateTableRowStyle

object (UpdateTableRowStyleRequest)

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

object (ReplaceImageRequest)

替換文件中的圖片。

updateDocumentStyle

object (UpdateDocumentStyleRequest)

更新文件的樣式。
mergeTableCells

object (MergeTableCellsRequest)

合併表格中的儲存格。

unmergeTableCells

object (UnmergeTableCellsRequest)

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

createHeader

object (CreateHeaderRequest)

建立標頭。
createFootnote

object (CreateFootnoteRequest)

建立腳註。
replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

取代指定範圍中的內容。
updateSectionStyle

object (UpdateSectionStyleRequest)

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

object (InsertSectionBreakRequest)

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

object (DeleteHeaderRequest)

從文件中刪除標題。
pinTableHeaderRows

object (PinTableHeaderRowsRequest)

更新表格中已固定標題列的數量。

ReplaceAllTextRequest

將符合條件的所有文字例項替換為 replace text。

JSON 表示法 
{
  "replaceText": string,
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.
}
欄位
replaceText

string

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

object (TabsCriteria)

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

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

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

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

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

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

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

  • 如果省略，則替換項目會套用至所有分頁。
聯集欄位 criteria。用來比對要取代的文字的條件。criteria 只能是下列其中一個：
containsText

object (SubstringMatchCriteria)

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

SubstringMatchCriteria

符合文件中特定文字串的條件。

JSON 表示法 
{
  "text": string,
  "matchCase": boolean
}
欄位
text

string

要在文件中搜尋的文字。

matchCase

boolean

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

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

TabsCriteria

指定要求在哪個分頁執行的條件。

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

string

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

InsertTextRequest

在指定位置插入文字。

JSON 表示法 
{
  "text": string,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
欄位
text

string

要插入的文字。

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

系統會自動決定插入文字的文字樣式，通常會保留相鄰文字的樣式。在大多數情況下，插入文字的文字樣式會與插入索引前立即顯示的文字相符。

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

聯集欄位 insertion_location。插入文字的位置。 insertion_location 只能是下列其中一個：
location

object (Location)

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

位置

文件中的特定位置。

JSON 表示法 
{
  "segmentId": string,
  "index": integer,
  "tabId": string
}
欄位
segmentId

string

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

integer

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

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

string

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

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

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

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

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

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

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

EndOfSegmentLocation

位置在內文、頁首、頁尾或註腳的結尾處。位置位於文件片段中最後一行換行符號之前。

JSON 表示法 
{
  "segmentId": string,
  "tabId": string
}
欄位
segmentId

string

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

string

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

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

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

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

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

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

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

UpdateTextStyleRequest

更新文字樣式。

JSON 表示法 
{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
欄位
textStyle

object (TextStyle)

要套用至文字的樣式。

如果特定樣式的值與父項相符，系統會將該樣式設為繼承。

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

string (FieldMask format)

應更新的欄位。

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

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

如要將屬性重設為預設值，請在欄位遮罩中加入欄位名稱，但將欄位本身設為未設定。
聯集欄位 insertion_location。用於更新文字樣式的範圍類型。insertion_location 只能是下列其中一個：
range

object (Range)

要套用樣式的文字範圍。

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

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

範圍無法插入相對 UpdateTextStyleRequest 中。

CreateParagraphBulletsRequest

為與指定範圍重疊的所有段落建立項目符號。

每個段落的巢狀層級會根據每個段落前面的前導制表計算。為避免在項目符號與對應段落之間出現多餘的空格，這項要求會移除這些前置制表符號。這可能會變更部分文字的索引。

如果要更新的段落前方，有與預設值相符的清單，系統會將要更新的段落新增至該清單。

JSON 表示法 
{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
欄位
range

object (Range)

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

enum (BulletGlyphPreset)

要使用的項目符號類型。

BulletGlyphPreset

清單的預設子彈圖示模式。

這些模式使用以下類型的項目符號：

  • ARROW ：箭頭，對應於 Unicode U+2794 碼點
  • ARROW3D ：箭頭加上 3D 陰影，對應至 Unicode U+27a2 碼點
  • CHECKBOX : 空心正方形，對應萬國碼 U+274f 碼點
  • CIRCLE : 空心圓圈，對應於 Unicode U+25cb 碼點
  • DIAMOND ：實心鑽石，對應至 Unicode U+25c6 碼位
  • DIAMONDX ：鑽石圖示加上「x」，對應至 Unicode U+2756 碼點
  • HOLLOWDIAMOND ：空心菱形，對應至 Unicode U+25c7 碼點
  • DISC ：實心圓，對應至 Unicode U+25cf 碼點
  • SQUARE : 實心正方形，對應於 Unicode U+25a0 碼點
  • STAR ：星號，對應至 Unicode U+2605 碼點
  • ALPHA ：小寫字母，例如「a」、「b」或「c」。
  • UPPERALPHA ：大寫字母，例如「A」、「B」或「C」。
  • DECIMAL ：數字，例如「1」、「2」或「3」。
  • ZERODECIMAL ：單位數字前面加上零的數字，例如「01」、「02」或「03」。超過一個位數的數字不會加上零。
  • ROMAN ：小寫羅馬數字，例如「i」、「ii」或「iii」。
  • UPPERROMAN ：大寫羅馬數字，例如「I」、「II」或「III」。
  • LEFTTRIANGLE ：左向三角形，對應至 Unicode U+25c4 碼點
列舉
BULLET_GLYPH_PRESET_UNSPECIFIED 未指定子彈圖示預設值。
BULLET_DISC_CIRCLE_SQUARE 項目符號清單，其中前 3 個清單巢狀層級的項目符號為 DISC、CIRCLE 和 SQUARE。
BULLET_DIAMONDX_ARROW3D_SQUARE 項目符號清單，其中前 3 個清單巢狀層級的項目符號為 DIAMONDX、ARROW3D 和 SQUARE。
BULLET_CHECKBOX 項目符號清單，其中包含所有清單巢狀層級的 CHECKBOX 項目符號。
BULLET_ARROW_DIAMOND_DISC 項目符號清單，其中前 3 個清單巢狀層級的項目符號為 ARROW、DIAMOND 和 DISC。
BULLET_STAR_CIRCLE_SQUARE 項目符號清單，其中前 3 個清單巢狀層級的項目符號為 STAR、CIRCLE 和 SQUARE。
BULLET_ARROW3D_CIRCLE_SQUARE 項目符號清單，其中前 3 個清單巢狀層級的項目符號為 ARROW3D、CIRCLE 和 SQUARE。
BULLET_LEFTTRIANGLE_DIAMOND_DISC 項目符號清單，其中前 3 個清單巢狀層級的項目符號為 LEFTTRIANGLE、DIAMOND 和 DISC。
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE 項目符號清單，其中前 3 個清單巢狀層級的項目符號為 DIAMONDX、HOLLOWDIAMOND 和 SQUARE。
BULLET_DIAMOND_CIRCLE_SQUARE 項目符號清單，其中前 3 個清單巢狀層級的項目符號為 DIAMOND、CIRCLE 和 SQUARE。
NUMBERED_DECIMAL_ALPHA_ROMAN 編號清單，其中 DECIMAL、ALPHA 和 ROMAN 數字符號代表前 3 個清單巢狀層級，後面加上句號。
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS 編號清單，其中 DECIMAL、ALPHA 和 ROMAN 數字符號代表前 3 個清單巢狀層級，後面接著括號。
NUMBERED_DECIMAL_NESTED 以 DECIMAL 數字符號為數字清單，以句號分隔，每個巢狀層級都使用上一個巢狀層級的符號做為字首。例如：「1.」，'1.1.''2.', '2.2.'。
NUMBERED_UPPERALPHA_ALPHA_ROMAN 編號清單，其中 UPPERALPHA、ALPHA 和 ROMAN 數字符號代表前 3 個清單巢狀層級，後面加上句號。
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL 編號清單，其中 UPPERROMAN、UPPERALPHA 和 DECIMAL 數字符號代表前 3 個清單巢狀層級，後面加上句號。
NUMBERED_ZERODECIMAL_ALPHA_ROMAN 編號清單，其中 ZERODECIMAL、ALPHA 和 ROMAN 數字符號代表前 3 個清單巢狀層級，後面加上句號。

DeleteParagraphBulletsRequest

從與指定範圍重疊的所有段落中刪除項目符號。

在對應段落的開頭加上縮排，即可在視覺上保留每個段落的巢狀結構層級。

JSON 表示法 
{
  "range": {
    object (Range)
  }
}
欄位
range

object (Range)

要刪除項目符號的範圍。

CreateNamedRangeRequest

建立參照指定範圍的 NamedRange。

JSON 表示法 
{
  "name": string,
  "range": {
    object (Range)
  }
}
欄位
name

string

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

名稱長度必須至少為 1 個字元，且不得超過 256 個半形字元。
range

object (Range)

要套用名稱的範圍。

DeleteNamedRangeRequest

刪除 NamedRange。

JSON 表示法 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "name": string
  // End of list of possible types for union field named_range_reference.
}
欄位
tabsCriteria

object (TabsCriteria)

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

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

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

  • 如果省略，範圍刪除作業會套用至單一分頁。

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

  • 如果提供，範圍刪除作業就會套用至指定的分頁。

  • 如未提供，範圍刪除作業會套用至所有分頁。
聯集欄位 named_range_reference。決定要刪除哪個或哪些範圍的值。必須明確設定一個。named_range_reference 只能是下列其中一個：
namedRangeId

string

要刪除的已命名範圍 ID。
name

string

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

UpdateParagraphStyleRequest

更新與指定範圍重疊的所有段落樣式。

JSON 表示法 
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
欄位
paragraphStyle

object (ParagraphStyle)

要套用至段落的樣式。

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

string (FieldMask format)

應更新的欄位。

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

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

如要將屬性重設為預設值，請在欄位遮罩中加入欄位名稱，但將欄位本身設為未設定。
聯集欄位 insertion_location。用於更新段落樣式的範圍類型。insertion_location 只能是下列其中一個：
range

object (Range)

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

DeleteContentRangeRequest

刪除文件中的內容。

JSON 表示法 
{
  "range": {
    object (Range)
  }
}
欄位
range

object (Range)

要刪除的內容範圍。

刪除跨越段落邊界的文字時，系統會合併兩個段落，因此可能會變更段落樣式、清單、定位物件和書籤。

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

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

InsertInlineImageRequest

在指定位置插入包含圖片的 InlineObject。

JSON 表示法 
{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
欄位
uri

string

圖片 URI。

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

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

object (Size)

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

聯集欄位 insertion_location。圖片的插入位置。insertion_location 只能是下列其中一個：
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

內文圖片無法插入註腳內。

InsertTableRequest

在指定位置插入表格。

系統會在插入的表格前插入換行字元。

JSON 表示法 
{
  "rows": integer,
  "columns": integer,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
欄位
rows

integer

資料表中的資料列數。
columns

integer

資料表中的欄數。
聯集欄位 insertion_location。要插入表格的位置。insertion_location 只能是下列其中一個：
location

object (Location)

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

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

資料表必須插入現有 Paragraph 的邊界內。舉例來說，無法在表格的起始索引 (即現有表格與其前一個段落之間) 插入這類資料。

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

無法在附註中插入表格。

InsertTableRowRequest

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

JSON 表示法 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}
欄位
tableCellLocation

object (TableCellLocation)

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

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

insertBelow

boolean

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

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

TableCellLocation

表格中單一儲存格的所在位置。

JSON 表示法 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}
欄位
tableStartLocation

object (Location)

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

integer

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

integer

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

InsertTableColumnRequest

在資料表中插入空白欄。

JSON 表示法 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}
欄位
tableCellLocation

object (TableCellLocation)

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

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

insertRight

boolean

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

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

DeleteTableRowRequest

從資料表刪除資料列。

JSON 表示法 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
欄位
tableCellLocation

object (TableCellLocation)

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

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

DeleteTableColumnRequest

從資料表中刪除資料欄。

JSON 表示法 
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
欄位
tableCellLocation

object (TableCellLocation)

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

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

InsertPageBreakRequest

在指定位置插入分頁符號，後面接著換行符號。

JSON 表示法 
{

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
欄位
聯集欄位 insertion_location。要插入分頁符號的位置。 insertion_location 只能是下列其中一個：
location

object (Location)

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

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

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

object (EndOfSegmentLocation)

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

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

DeletePositionedObjectRequest

從文件中刪除 PositionedObject。

JSON 表示法 
{
  "objectId": string,
  "tabId": string
}
欄位
objectId

string

要刪除的位置物件 ID。
tabId

string

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

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

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

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

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

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

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

UpdateTableColumnPropertiesRequest

更新資料表中資料欄的 TableColumnProperties。

JSON 表示法 
{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
欄位
tableStartLocation

object (Location)

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

integer

屬性應更新的以零為基底的資料欄索引清單。如果未指定索引，系統會更新所有資料欄。
tableColumnProperties

object (TableColumnProperties)

要更新的表格欄屬性。

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

string (FieldMask format)

應更新的欄位。

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

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

UpdateTableCellStyleRequest

更新表格儲存格範圍的樣式。

JSON 表示法 
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  // Union field cells can be only one of the following:
  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
  // End of list of possible types for union field cells.
}
欄位
tableCellStyle

object (TableCellStyle)

要套用至表格儲存格的樣式。

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

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

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

應更新的欄位。

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

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

如要將屬性重設為預設值，請在欄位遮罩中加入屬性欄位名稱，但將欄位本身設為未設定。
聯集欄位 cells。要更新的儲存格。cells 只能是下列其中一個：
tableRange

object (TableRange)

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

object (Location)

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

TableRange

表格範圍代表資料表子集的參照。

請注意，表格範圍指定的儲存格不一定會形成矩形。舉例來說，假設我們有一個 3 x 3 的表格，其中最後一列的所有儲存格都會合併在一起。資料表如下所示： 

 [   ][   ][   ]
 [   ][   ][   ]
 [             ]

表格範圍的儲存格位置 = (tableStartLocation, row = 0, column = 0)、列跨距 = 3 和欄跨距 = 2 會指定下列儲存格： 

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
JSON 表示法 
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
欄位
tableCellLocation

object (TableCellLocation)

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

integer

表格範圍的列跨距。
columnSpan

integer

表格範圍的欄跨距。

UpdateTableRowStyleRequest

更新資料表中資料列的 TableRowStyle。

JSON 表示法 
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}
欄位
tableStartLocation

object (Location)

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

integer

應更新樣式的零基列索引清單。如果未指定索引，系統會更新所有資料列。
tableRowStyle

object (TableRowStyle)

要套用至資料列的樣式。
fields

string (FieldMask format)

應更新的欄位。

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

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

ReplaceImageRequest

使用新圖片取代現有圖片。

替換圖片會從現有圖片中移除部分 image effects，以反映 Google 文件編輯器的行為。

JSON 表示法 
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}
欄位
imageObjectId

string

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

string

新圖片的 URI。

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

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

enum (ImageReplaceMethod)

替換方法。
tabId

string

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

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

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

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

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

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

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

ImageReplaceMethod

圖片替換方法。

列舉
IMAGE_REPLACE_METHOD_UNSPECIFIED 未指定圖片取代方法。請勿使用這個值。
CENTER_CROP 將圖片縮放並置中，以填滿原始圖片的邊界。圖片可能會經過裁剪，以便填滿原始圖片的邊界。圖片的算繪大小會與原始圖片相同。

UpdateDocumentStyleRequest

更新 DocumentStyle。

JSON 表示法 
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}
欄位
documentStyle

object (DocumentStyle)

要在文件上設定的樣式。

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

string (FieldMask format)

應更新的欄位。

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

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

string

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

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

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

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

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

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

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

MergeTableCellsRequest

合併 Table 中的儲存格。

JSON 表示法 
{
  "tableRange": {
    object (TableRange)
  }
}
欄位
tableRange

object (TableRange)

指定要合併表格哪些儲存格的表格範圍。

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

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

UnmergeTableCellsRequest

取消合併 Table 中的儲存格。

JSON 表示法 
{
  "tableRange": {
    object (TableRange)
  }
}
欄位
tableRange

object (TableRange)

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

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

如果任何合併儲存格中含有文字，文字會保留在未合併儲存格區塊的「標頭」儲存格中。如果內容方向是從左到右，則「頭部」儲存格是左上角儲存格，否則是右上角儲存格。

CreateHeaderRequest

建立 Header。如果指定 SectionBreak，新標頭會套用至 SectionBreak 位置的 SectionStyle；否則會套用至 DocumentStyle。

如果已存在指定類型的標頭，系統會傳回 400 無效要求錯誤。

JSON 表示法 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
欄位
type

enum (HeaderFooterType)

要建立的標頭類型。
sectionBreakLocation

object (Location)

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

HeaderFooterType

可建立的標題和頁尾類型。

列舉
DEFAULT 預設的頁首/頁尾。

CreateFooterRequest

建立 Footer。如果指定 SectionBreak，系統會將新的頁尾套用至 SectionBreak 位置的 SectionStyle，否則會套用至 DocumentStyle。

如果已存在指定類型的頁尾，系統會傳回 400 錯誤要求錯誤。

JSON 表示法 
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
欄位
type

enum (HeaderFooterType)

要建立的頁尾類型。
sectionBreakLocation

object (Location)

SectionBreak 的位置，緊接在 SectionStyle 所屬的部分之前。如果未設定這個值，或參照文件中的第一個區段分隔符，頁尾會套用至文件樣式。

CreateFootnoteRequest

建立 Footnote 區段，並在指定位置插入新的 FootnoteReference。

新的 Footnote 區段會包含空格，後面接著換行字元。

JSON 表示法 
{

  // Union field footnote_reference_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field footnote_reference_location.
}
欄位
聯集欄位 footnote_reference_location。要插入註腳參照的位置。 footnote_reference_location 只能是下列其中一個：
location

object (Location)

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

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

註腳參照無法插入方程式、標頭、頁尾或註腳中。由於附註參照資料只能插入內文，因此 segment ID 欄位必須為空白。
endOfSegmentLocation

object (EndOfSegmentLocation)

在文件主體結尾插入註腳參照。

註腳參考資料無法插入標頭、頁尾或註腳中。由於附註參照資料只能插入內文，因此 segment ID 欄位必須為空白。

ReplaceNamedRangeContentRequest

將指定 NamedRange 或 NamedRanges 的內容替換為指定的替換內容。

請注意，單一 NamedRange 可能包含多個不連續的 ranges。在這種情況下，系統只會替換第一個範圍的內容。系統會刪除其他區間及其內容。

如果替換或刪除任何區間會導致無效的文件結構，系統會傳回 400 無效要求錯誤。

JSON 表示法 
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // Union field replacement_content can be only one of the following:
  "text": string
  // End of list of possible types for union field replacement_content.

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "namedRangeName": string
  // End of list of possible types for union field named_range_reference.
}
欄位
tabsCriteria

object (TabsCriteria)

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

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

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

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

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

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

  • 如果省略，則替換項目會套用至所有分頁。
聯集欄位 replacement_content。要用來取代指定範圍現有內容的內容。replacement_content 只能是下列其中一個：
text

string

將指定的命名範圍內容替換為指定的文字。
聯集欄位 named_range_reference。要取代內容的命名範圍參照。named_range_reference 只能是下列其中一個：
namedRangeId

string

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

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

string

內容將會替換的 NamedRanges 名稱。

如果有多個named ranges 使用指定名稱，則會取代每個名稱的內容。如果沒有任何已命名範圍使用指定名稱，則要求會變成無操作。

UpdateSectionStyleRequest

更新 SectionStyle。

JSON 表示法 
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
欄位
range

object (Range)

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

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

object (SectionStyle)

要套用至區段的樣式。

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

string (FieldMask format)

應更新的欄位。

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

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

InsertSectionBreakRequest

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

系統會在章節分隔符號前插入換行字元。

JSON 表示法 
{
  "sectionType": enum (SectionType),

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
欄位
sectionType

enum (SectionType)

要插入的段落類型。
聯集欄位 insertion_location。插入中斷的位置。 insertion_location 只能是下列其中一個：
location

object (Location)

在文件的特定索引中插入換行符號和段落分隔符。

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

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

object (EndOfSegmentLocation)

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

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

DeleteHeaderRequest

從文件中刪除 Header。

JSON 表示法 
{
  "headerId": string,
  "tabId": string
}
欄位
headerId

string

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

string

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

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

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

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

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

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

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

DeleteFooterRequest

從文件中刪除 Footer。

JSON 表示法 
{
  "footerId": string,
  "tabId": string
}
欄位
footerId

string

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

string

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

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

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

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

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

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

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

PinTableHeaderRowsRequest

更新表格中已固定表格標題列的數量。

JSON 表示法 
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
欄位
tableStartLocation

object (Location)

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

integer

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