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)

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

取代所有文字要求

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

JSON 表示法 
{
  "replaceText": string,

  // 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

用來取代相符文字的文字。
聯集欄位 criteria。符合替換文字的條件。 criteria 只能是下列其中一個值：
containsText

object (SubstringMatchCriteria)

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

SubstringMatchCriteria

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

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

string

要在文件中搜尋的文字。
matchCase

boolean

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

  • True ：搜尋須區分大小寫。
  • False : 不區分大小寫。

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
}
欄位
segmentId

string

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

integer

以 UTF-16 程式碼單元為基礎的零索引。

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

EndOfSegmentLocation

內文、標頭、頁尾或註腳的結尾。位置緊接在文件區隔的最後一行。

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

string

位置所在的標頭、頁尾或註腳 ID。空白的區隔 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)

設定文字的樣式。

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

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

string (FieldMask format)

需要更新的欄位。

至少須指定一個欄位。根 textStyle 暗示隱含，不應指定。單一 "*" 可用來當做每個欄位的簡寫。

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

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

聯集欄位 insertion_location。文字樣式更新所用的範圍類型。 insertion_location 只能是下列其中一個值：
range

object (Range)

要設定樣式的文字範圍。

系統可能會擴大範圍，納入鄰近的換行符號。

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

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

CreateParagraphBulletRequest

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

每個段落的巢狀結構也會計算每個段落前方的定位點。為避免項目符號和對應段落之間的空格過多，提出要求時系統會移除這些主要分頁。這可能會改變部分文字的索引。

如果段落更新前的段落位於符合預設設定的清單中，則要更新的段落會新增至前面的清單。

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

object (Range)

要套用項目符號預設值的範圍。

bulletPreset

enum (BulletGlyphPreset)

要使用的項目符號字符類型。

BulletGlyphPreset

預設清單項目符號字符模式。

這些模式會使用下列項目符號：

  • ARROW ：箭頭，對應萬國碼 (Unicode) U+2794 代碼點
  • ARROW3D ：箭頭為 3D 陰影的箭頭，對應至萬國碼 (Unicode) U+27a2 碼點
  • CHECKBOX ：空心方形，對應萬國碼 (Unicode) 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 前 3 個清單巢狀層級的編號為 DECIMAL、ALPHA 和 ROMAN 數字字符，後面接著半形句號。
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS 包含前 3 個清單巢狀層級的 DECIMAL、ALPHA 和 ROMAN 數字字符，後面加上括號。
NUMBERED_DECIMAL_NESTED 在這個編號清單中，包含 DECIMAL 數字字符，並以半形句號分隔，每個巢狀層級層級都會以前一個巢狀層級字符做為前置字串。例如：「1.」、「1.1」、「2.」、「2.2.」。
NUMBERED_UPPERALPHA_ALPHA_ROMAN 前 3 個清單巢狀層級的編號為 UPPERALPHA、ALPHA 和 ROMAN 數字字符，後面接著半形句號。
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL 前 3 個清單巢狀層級的編號為 UPPERROMAN、UPPERALPHA 和 DECIMAL 數字字符，後面接著半形句號。
NUMBERED_ZERODECIMAL_ALPHA_ROMAN 前 3 個清單巢狀層級的編號為 ZERODECIMAL、ALPHA 和 ROMAN 數字字符，後面接著半形句號。

DeleteParagraphBulletRequest

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

在每個段落的開頭加上縮排，即可保留各段落的巢狀層級。

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

object (Range)

項目符號刪除範圍。

CreateNamedRangeRequest

建立參照指定範圍的 NamedRange。

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

string

NamedRange 的名稱。名稱可以重複。

名稱長度不得少於 1 個半形字元，且長度不得超過 256 個字元，格式為 UTF-16 程式碼單元。
range

object (Range)

要套用名稱的範圍。

DeleteNamedRangeRequest

刪除 NamedRange。

JSON 表示法 
{

  // 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.
}
欄位
聯集欄位 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)

要設定段落的樣式。

某些段落樣式變更可能會對文件編輯器的行為保持一致。詳情請參閱 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，大小不得超過 2500 萬像素，且必須是 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

從 0 開始計算。舉例來說，表格中的第二列含有 1 的列索引。

columnIndex

integer

以 0 欄為基礎的索引。舉例來說，表格中的第二欄有 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
}
欄位
objectId

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)、資料列 span = 3，欄 span = 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"。

取代圖片要求

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

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

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

string

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

uri

string

新圖片的 URI。

系統會在插入時間擷取一次圖片，另一份副本會儲存至文件中。圖片大小必須小於 50 MB，檔案大小不得超過 2500 萬像素，且為 PNG、JPEG 或 GIF 格式。

提供的 URI 超過 2 KB 的長度。URI 會儲存在映像檔中，並透過 ImageProperties.source_uri 欄位公開發布。
imageReplaceMethod

enum (ImageReplaceMethod)

替換方法。

ImageReplaceMethod

圖片取代方法。

列舉
IMAGE_REPLACE_METHOD_UNSPECIFIED 未指定的圖片取代方法。這個值不可使用。
CENTER_CROP 縮放圖片並置中，填滿圖像的邊界。系統可能會裁剪圖片，以填滿原始圖片的邊界。圖片的顯示大小會與原始圖片相同。

UpdateDocumentStyleRequest

更新 DocumentStyle。

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

object (DocumentStyle)

用於文件的樣式。

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

string (FieldMask format)

需要更新的欄位。

至少須指定一個欄位。根 documentStyle 暗示隱含，不應指定。單一 "*" 可用來當做每個欄位的簡寫。

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

MergeTableCellsRequest

合併 Table 中的儲存格。

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

object (TableRange)

表格範圍，用於指定要合併的資料表。

系統會將合併儲存格中的所有文字串連在一起，並將其儲存在範圍的「頭」儲存格中。這是內容方向從左至右時，範圍的左上角。

如果該範圍不是矩形 (當範圍涵蓋已合併的儲存格，或資料表是非矩形)，就可能傳回 400 錯誤要求。

取消合併儲存格儲存格

取消合併 Table 中的儲存格。

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

object (TableRange)

表格範圍，用於指定要取消合併的資料表。

這個範圍中的所有合併儲存格都將取消合併，而未合併的儲存格不會受到影響。如果範圍沒有合併的儲存格，則要求不會有任何動作。

如果任何合併儲存格內有任何文字，文字將保留未合併儲存格的「標題」儲存格。當內容方向由左至右時，「head」儲存格位於左上角。

CreateHeaderRequest

可建立 Header。如果有指定標頭，則會套用至 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 位置的 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 表示法 
{

  // 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.
}
欄位
聯集欄位 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)

要在區段設定的樣式。

某些部分的樣式變更可能會讓其他變更反映文件編輯器的行為。詳情請參閱 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
}
欄位
headerId

string

要刪除的標頭 ID。如果這個標頭是在 DocumentStyle 上定義，則系統會移除這個標頭的參照，因此文件的第一個部分不會顯示該類型的標頭。如果這個標頭在 SectionStyle 上已定義，系統就會移除這個標頭的參照，並繼續沿用前一節的標頭。

DeleteFooterRequest

從文件中刪除 Footer。

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

string

要刪除的頁尾 ID。如果這個頁尾在 DocumentStyle 上定義了，這個頁尾的參照即會移除，因此該文件的第一部分就不會有該類型的頁尾。如果這個頁尾在 SectionStyle 上定義，則系統會移除這個頁尾的參照，並改為移除前一節的頁尾。

PinTableHeaderRowsRequest

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

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

object (Location)

文件中表格開始的位置。
pinnedHeaderRowsCount

integer

要固定的資料表資料列數量，0 代表所有資料列已取消固定。