Requests

要求

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

JSON 表示法
{

  "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)
  },
  "addDocumentTab": {
    object (AddDocumentTabRequest)
  },
  "deleteTab": {
    object (DeleteTabRequest)
  },
  "updateDocumentTabProperties": {
    object (UpdateDocumentTabPropertiesRequest)
  },
  "insertPerson": {
    object (InsertPersonRequest)
  },
  "updateNamedStyle": {
    object (UpdateNamedStyleRequest)
  },
  "insertRichLink": {
    object (InsertRichLinkRequest)
  },
  "insertDate": {
    object (InsertDateRequest)
  },
  "insertComment": {
    object (InsertCommentRequest)
  },
  "addCommentReply": {
    object (AddCommentReplyRequest)
  },
  "updateCommentPost": {
    object (UpdateCommentPostRequest)
  },
  "deleteComment": {
    object (DeleteCommentRequest)
  },
  "deleteCommentReply": {
    object (DeleteCommentReplyRequest)
  },
  "acceptSuggestion": {
    object (AcceptSuggestionRequest)
  },
  "rejectSuggestion": {
    object (RejectSuggestionRequest)
  },
  "deleteSuggestion": {
    object (DeleteSuggestionRequest)
  }
}
欄位
申請適用的具體要求。必須填寫一個欄位。以下列出互斥欄位。回應中最多會設定一個欄位:
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)

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

addDocumentTab

object (AddDocumentTabRequest)

新增文件分頁。

deleteTab

object (DeleteTabRequest)

刪除文件分頁。

updateDocumentTabProperties

object (UpdateDocumentTabPropertiesRequest)

更新文件分頁的屬性。

insertPerson

object (InsertPersonRequest)

插入提及對象。

updateNamedStyle

object (UpdateNamedStyleRequest)

更新已命名的樣式。

insertDate

object (InsertDateRequest)

插入日期。

insertComment

object (InsertCommentRequest)

在文件中插入 CommentThread 。

addCommentReply

object (AddCommentReplyRequest)

新增對 CommentThread 或 SuggestionThread 的回覆。

updateCommentPost

object (UpdateCommentPostRequest)

更新現有貼文 (主貼文或回覆),包括 CommentThread 或 SuggestionThread。

deleteComment

object (DeleteCommentRequest)

刪除 CommentThread。

deleteCommentReply

object (DeleteCommentReplyRequest)

從 Post 或 CommentThread 刪除回覆 SuggestionThread。

acceptSuggestion

object (AcceptSuggestionRequest)

接受建議。

rejectSuggestion

object (RejectSuggestionRequest)

拒絕建議。

deleteSuggestion

object (DeleteSuggestionRequest)

刪除建議。

互斥欄位結尾。

ReplaceAllTextRequest

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

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

  "containsText": {
    object (SubstringMatchCriteria)
  }
}
欄位
replaceText

string

要取代相符文字的文字。

tabsCriteria

object (TabsCriteria)

(選用步驟) 用來指定要在哪些分頁中進行替換的條件。

如果省略,取代作業會套用至所有分頁。

在含有單一索引標籤的文件中:

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

  • 如果省略,則取代作業會套用至單一分頁。

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

  • 如有提供,系統會將取代內容套用至指定分頁。

  • 如果省略,則取代作業會套用至所有分頁。

用來比對要取代文字的條件。以下列出互斥欄位。回應中最多會設定一個欄位:
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,

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
欄位
text

string

要插入的文字。

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

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

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

文字的插入位置。以下列出互斥欄位。回應中最多會設定一個欄位:
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,

  "range": {
    object (Range)
  }
}
欄位
textStyle

object (TextStyle)

要為文字設定的樣式。

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

為反映 Google 文件編輯器的行為,變更特定文字樣式時,系統可能會一併變更其他項目。詳情請參閱 TextStyle 的說明文件。

fields

string (FieldMask format)

要更新的欄位。

至少須指定一個欄位。根目錄 textStyle 為隱含值,不應指定。單一 "*" 可做為列出每個欄位的簡寫。

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

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

要更新文字樣式的範圍類型。以下列出互斥欄位。回應中最多會設定一個欄位:
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)
  },

  "namedRangeId": string,
  "name": string
}
欄位
tabsCriteria

object (TabsCriteria)

(選用步驟) 用來指定要刪除範圍的分頁標籤。如果省略,系統會對所有分頁套用範圍刪除作業。

在含有單一索引標籤的文件中:

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

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

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

  • 如有提供,範圍刪除作業會套用至指定分頁。

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

這個值會決定要刪除的範圍。必須設定一個選項。以下列出互斥欄位。回應中最多會設定一個欄位:
namedRangeId

string

要刪除的已命名範圍 ID。

name

string

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

互斥欄位結尾。

UpdateParagraphStyleRequest

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

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

  "range": {
    object (Range)
  }
}
欄位
paragraphStyle

object (ParagraphStyle)

要為段落設定的樣式。

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

fields

string (FieldMask format)

要更新的欄位。

至少須指定一個欄位。根目錄 paragraphStyle 為隱含值,不應指定。單一 "*" 可做為列出每個欄位的簡寫。

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

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

要更新段落樣式的範圍類型。以下列出互斥欄位。回應中最多會設定一個欄位:
range

object (Range)

要設定樣式的段落重疊範圍。

互斥欄位結尾。

DeleteContentRangeRequest

從文件中刪除內容。

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

object (Range)

要刪除的內容範圍。

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

嘗試刪除特定範圍可能會導致文件結構無效,這時系統會傳回 400 Bad Request 錯誤。

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

InsertInlineImageRequest

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

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

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
欄位
uri

string

圖片 URI。

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

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

objectSize

object (Size)

圖片在文件中顯示的大小。這個屬性為選用屬性,文件中圖片的最終大小取決於下列規則: * 如果未指定寬度和高度,系統會根據圖片的解析度計算預設大小。 * 如果指定一個維度,系統會計算另一個維度,以保留圖片的顯示比例。* 如果同時指定寬度和高度,系統會縮放圖片,使其符合提供的尺寸,同時維持長寬比。

圖片的插入位置。以下列出互斥欄位。回應中最多會設定一個欄位:
location

object (Location)

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

圖片必須插入現有 Paragraph 的界線內。舉例來說,您無法在表格的起始索引處插入分頁符 (也就是表格和前一段落之間)。

內嵌圖片無法插入註腳或方程式。

endOfSegmentLocation

object (EndOfSegmentLocation)

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

內嵌圖片無法插入註腳。

互斥欄位結尾。

InsertTableRequest

在指定位置插入表格。

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

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

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
欄位
rows

integer

資料表中的列數。

columns

integer

資料表中的欄數。

表格的插入位置。以下列出互斥欄位。回應中最多會設定一個欄位:
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 : insert to the left.

DeleteTableRowRequest

從資料表中刪除資料列。

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

object (TableCellLocation)

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

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

DeleteTableColumnRequest

從表格中刪除資料欄。

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

object (TableCellLocation)

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

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

InsertPageBreakRequest

在指定位置插入分頁符號,然後換行。

JSON 表示法
{

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
欄位
要插入分頁符號的位置。以下列出互斥欄位。回應中最多會設定一個欄位:
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 Bad Request 錯誤。

fields

string (FieldMask format)

要更新的欄位。

至少須指定一個欄位。根目錄 tableColumnProperties 為隱含值,不應指定。單一 "*" 可做為列出每個欄位的簡寫。

舉例來說,如要更新欄寬,請將 fields 設為 "width"。

UpdateTableCellStyleRequest

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

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

  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
}
欄位
tableCellStyle

object (TableCellStyle)

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

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

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

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

要更新的欄位。

至少須指定一個欄位。根目錄 tableCellStyle 為隱含值,不應指定。單一 "*" 可做為列出每個欄位的簡寫。

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

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

要更新的儲存格。以下列出互斥欄位。回應中最多會設定一個欄位:
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,像素不得超過 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 Bad Request 錯誤。

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

enum (HeaderFooterType)

要建立的頁尾類型。

sectionBreakLocation

object (Location)

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

CreateFootnoteRequest

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

新 Footnote 區隔會包含空格,後面接著換行字元。

JSON 表示法
{

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
欄位
要插入註腳參照的位置。以下列出互斥欄位。回應中最多會設定一個欄位:
location

object (Location)

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

附註參照必須插入現有 Paragraph 的界限內。舉例來說,您無法在表格的起始索引處插入分頁符 (也就是表格和前一段落之間)。

註腳參照無法插入方程式、頁首、頁尾或註腳中。由於只能在內文插入附註參照,因此 segment ID 欄位必須空白。

endOfSegmentLocation

object (EndOfSegmentLocation)

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

註腳參考不得插入標頭、頁尾或註腳。由於只能在內文插入附註參照,因此 segment ID 欄位必須空白。

互斥欄位結尾。

ReplaceNamedRangeContentRequest

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

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

如果取代或刪除任何範圍會導致文件結構無效,系統會傳回 400 Bad Request 錯誤。

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

  "text": string

  "namedRangeId": string,
  "namedRangeName": string
}
欄位
tabsCriteria

object (TabsCriteria)

(選用步驟) 用來指定要取代的索引標籤。如果省略,取代作業會套用至所有分頁。

在含有單一索引標籤的文件中:

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

  • 如果省略,則取代作業會套用至單一分頁。

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

  • 如有提供,系統會將取代內容套用至指定分頁。

  • 如果省略,則取代作業會套用至所有分頁。

要用來取代已命名範圍現有內容的內容。以下列出互斥欄位。回應中最多會設定一個欄位:
text

string

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

互斥欄位結尾。
要取代內容的已命名範圍參照。以下列出互斥欄位。回應中最多會設定一個欄位:
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),

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
欄位
sectionType

enum (SectionType)

要插入的版面類型。

要插入分頁符的位置。以下列出互斥欄位。回應中最多會設定一個欄位:
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 代表所有資料列都未釘選。

AddDocumentTabRequest

新增文件分頁。在指定索引處新增分頁時,後續所有分頁的索引都會遞增。

JSON 表示法
{
  "tabProperties": {
    object (TabProperties)
  }
}
欄位
tabProperties

object (TabProperties)

要新增的分頁屬性。所有屬性皆為選填。

DeleteTabRequest

刪除分頁。如果分頁有子分頁,也會一併刪除。

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

string

要刪除的分頁 ID。

UpdateDocumentTabPropertiesRequest

更新文件分頁的屬性。

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

object (TabProperties)

要更新的分頁屬性。

fields

string (FieldMask format)

要更新的欄位。

至少須指定一個欄位。根目錄 tabProperties 為隱含值,不應指定。單一 "*" 可做為列出每個欄位的簡寫。

InsertPersonRequest

插入提及對象。

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

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
欄位
personProperties

object (PersonProperties)

要插入的人員提及屬性。

系統會在此位置插入提及的使用者。以下列出互斥欄位。回應中最多會設定一個欄位:
location

object (Location)

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

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

互斥欄位結尾。

UpdateNamedStyleRequest

更新已命名的樣式。

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

object (NamedStyle)

要更新的文件樣式。

fields

string (FieldMask format)

應更新的 NamedStyle 欄位。

至少須指定 namedStyleType。根目錄 namedStyle 為隱含值,不應指定。單一 "*" 可做為列出每個欄位的簡寫。

舉例來說,如要將文字樣式更新為粗體,請將 fields 設為包含 "textStyle" 和 "textStyle.bold"。如要更新段落樣式的對齊屬性,請將 fields 設為包含 "paragraphStyle" 和 "paragraphStyle.alignment"。

如要將屬性重設為預設值,請在欄位遮罩中加入該屬性的欄位名稱,但將欄位本身設為未設定。如果使用空白的 TextStyle 或 ParagraphStyle 指定 "textStyle"、"paragraphStyle",系統會重設所有巢狀欄位。

tabId

string

要更新的文件分頁。根據預設,更新會套用至第一個分頁。

InsertRichLinkRequest

在指定位置插入 RichLink。

JSON 表示法
{
  "richLinkProperties": {
    object (RichLinkProperties)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
欄位
要插入多媒體連結的位置。以下列出互斥欄位。回應中最多會設定一個欄位:
location

object (Location)

在文件的特定索引處插入複合式連結。

豐富連結必須插入現有 Paragraph 的界限內。舉例來說,您無法在表格的起始索引處插入分頁符 (也就是表格和前一段落之間)。

無法在方程式中插入複合連結。

endOfSegmentLocation

object (EndOfSegmentLocation)

在頁首、頁尾、註腳或文件內文的結尾插入豐富連結。

互斥欄位結尾。

InsertDateRequest

在指定位置插入日期。

JSON 表示法
{
  "dateElementProperties": {
    object (DateElementProperties)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
欄位
dateElementProperties

object (DateElementProperties)

要插入的日期屬性。

插入日期的位置。以下列出互斥欄位。回應中最多會設定一個欄位:
location

object (Location)

在文件中特定索引處插入日期。

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

endOfSegmentLocation

object (EndOfSegmentLocation)

在指定頁首、頁尾或文件內文的結尾插入日期。

互斥欄位結尾。

InsertCommentRequest

在文件中插入 CommentThread 。

JSON 表示法
{
  "content": string,
  "assigneeEmailAddress": string,

  "range": {
    object (Range)
  }
}
欄位
content

string

留言文字 (純文字)。

這類文字內容的處理方式,與在 Google 文件編輯器中建立的註解類似。格式設定、通知等行為與舊版相同。

這個欄位不得空白,且不得超過 2048 個 UTF-8 程式碼單元。

assigneeEmailAddress

string

(選用步驟) 留言指派對象的電子郵件地址。

如要建立未指派的留言,請留空。

不得超過 2048 個 UTF-8 程式碼單元。

與這則註解相關聯的文件位置。以下列出互斥欄位。回應中最多會設定一個欄位:
range

object (Range)

與這則註解相關聯的文件中的 Range。

互斥欄位結尾。

AddCommentReplyRequest

將回覆插入 Post CommentThread 或 SuggestionThread。

JSON 表示法
{
  "post": {
    object (Post)
  },

  "commentId": string,
  "suggestionId": string
}
欄位
post

object (Post)

代表回覆的 Post。

要新增回覆的執行緒 ID。以下列出互斥欄位。回應中最多會設定一個欄位:
commentId

string

要新增回覆的 CommentThread ID。

suggestionId

string

要新增回覆的 SuggestionThread ID。

互斥欄位結尾。

UpdateCommentPostRequest

更新 CommentThread 或 SuggestionThread 中的 Post。

如果發生下列情況,系統會傳回 400 Bad Request 錯誤:

  • 該貼文是 SuggestionThread 的headPost一部分。

  • 提出要求的使用者不是貼文作者。

JSON 表示法
{
  "postId": string,
  "content": string,

  "commentId": string,
  "suggestionId": string
}
欄位
postId

string

要更新的貼文 ID。

content

string

留言的新文字,以純文字格式呈現。

這類文字內容的處理方式,與在 Google 文件編輯器中建立的註解類似。格式設定、通知等行為與舊版相同。

這個欄位不得空白,且不得超過 2048 個 UTF-8 程式碼單元。

貼文所屬的討論串 ID。以下列出互斥欄位。回應中最多會設定一個欄位:
commentId

string

貼文所屬的 CommentThread ID。

suggestionId

string

貼文所屬的 SuggestionThread ID。

互斥欄位結尾。

DeleteCommentRequest

刪除 CommentThread。

如果要求的使用者不是 headPost 的作者,系統會傳回 400 錯誤要求錯誤。

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

string

要刪除的 CommentThread ID。

DeleteCommentReplyRequest

從 Post 或 SuggestionThread 刪除回覆 CommentThread。

如果發生下列情況,系統會傳回 400 Bad Request 錯誤:

  • 提出要求的使用者不是貼文作者。

  • 回覆貼文包含 [動作][google.apps.docs.v1.Post.action]。

  • 回覆貼文包含 assignee。

JSON 表示法
{
  "postId": string,

  "commentId": string,
  "suggestionId": string
}
欄位
postId

string

要刪除的回覆 ID Post 。

貼文所屬的討論串 ID。以下列出互斥欄位。回應中最多會設定一個欄位:
commentId

string

貼文所屬的 CommentThread ID。

suggestionId

string

貼文所屬的 SuggestionThread ID。

互斥欄位結尾。

AcceptSuggestionRequest

接受建議。

如果要求存取的使用者沒有文件的編輯權限,系統會傳回 403 禁止存取錯誤。

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

string

建議的 ID。

RejectSuggestionRequest

拒絕建議。

如果要求的使用者沒有文件的編輯權限,且不是建議的作者,系統會傳回 403 禁止存取錯誤。

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

string

建議的 ID。

DeleteSuggestionRequest

刪除建議。

如果要求的使用者不是建議的作者,則會傳回 403 禁止錯誤。

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

string

建議的 ID。