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)
  },
  "insertPerson": {
    object (InsertPersonRequest)
  }
  // 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)

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

insertPerson

object (InsertPersonRequest)

插入提及對象。

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,
  "searchByRegex": boolean
}
欄位
text

string

要在文件中搜尋的文字。

matchCase

boolean

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

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

boolean

(選用步驟) 如果應將尋找值視為規則運算式，則為 True。模式中的任何反斜線都應逸出。

  • 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 ：空心方塊，對應於 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 數字字形，後面加上句號。

DeleteParagraphBulletsRequest

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

系統會在對應段落的開頭新增縮排，以視覺化方式保留每個段落的巢狀層級。

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 表示法 
{
  "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 Bad Request 錯誤。

無效的刪除要求範例如下：

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

從零開始的列索引。舉例來說，表格中的第二列的列索引為 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

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

取代圖片時，系統會移除現有圖片的部分屬性，以模擬 Google 文件編輯器的行為。image effects

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

string

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

uri

string

新圖片的 URI。

系統會在插入圖片時擷取一次，並儲存副本，以便在文件中顯示。圖片不得超過 50 MB，像素不得超過 2500 萬，且必須為 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 位置的 SectionStyle (如有指定)，否則會套用至 DocumentStyle。

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

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

enum (HeaderFooterType)

要建立的標頭類型。

sectionBreakLocation

object (Location)

標題所屬區段的開頭位置。SectionBreak如果 `sectionBreakLocation' 未設定，或參照文件內文中的第一個分節符，則標題會套用至 DocumentStyle

HeaderFooterType

可建立的頁首和頁尾類型。

列舉
DEFAULT 預設頁首/頁尾。

CreateFooterRequest

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

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

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

enum (HeaderFooterType)

要建立的頁尾類型。

sectionBreakLocation

object (Location)

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

CreateFootnoteRequest

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

新區段 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 代表所有列都未釘選。

InsertPersonRequest

插入提及對象。

JSON 表示法 
{
  "personProperties": {
    object (PersonProperties)
  },

  // 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.
}
欄位
personProperties

object (PersonProperties)

要插入的人員提及屬性。

聯集欄位 insertion_location。要插入提及內容的位置。 insertion_location 只能是下列其中一項：
location

object (Location)

在文件中特定索引處插入提及的使用者。

提及的使用者必須插入現有 Paragraph 的界限內。舉例來說，您無法在表格的起始索引處插入分頁符 (也就是表格和前一段落之間)。

無法在方程式中插入提及對象。

endOfSegmentLocation

object (EndOfSegmentLocation)

在頁首、頁尾、註腳或文件內文結尾插入提及的使用者。