Requests

要求

要套用至簡報的單一更新類型。

JSON 表示法
{

  "createSlide": {
    object (CreateSlideRequest)
  },
  "createShape": {
    object (CreateShapeRequest)
  },
  "createTable": {
    object (CreateTableRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "insertTableRows": {
    object (InsertTableRowsRequest)
  },
  "insertTableColumns": {
    object (InsertTableColumnsRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "deleteObject": {
    object (DeleteObjectRequest)
  },
  "updatePageElementTransform": {
    object (UpdatePageElementTransformRequest)
  },
  "updateSlidesPosition": {
    object (UpdateSlidesPositionRequest)
  },
  "deleteText": {
    object (DeleteTextRequest)
  },
  "createImage": {
    object (CreateImageRequest)
  },
  "createVideo": {
    object (CreateVideoRequest)
  },
  "createSheetsChart": {
    object (CreateSheetsChartRequest)
  },
  "createLine": {
    object (CreateLineRequest)
  },
  "refreshSheetsChart": {
    object (RefreshSheetsChartRequest)
  },
  "updateShapeProperties": {
    object (UpdateShapePropertiesRequest)
  },
  "updateImageProperties": {
    object (UpdateImagePropertiesRequest)
  },
  "updateVideoProperties": {
    object (UpdateVideoPropertiesRequest)
  },
  "updatePageProperties": {
    object (UpdatePagePropertiesRequest)
  },
  "updateTableCellProperties": {
    object (UpdateTableCellPropertiesRequest)
  },
  "updateLineProperties": {
    object (UpdateLinePropertiesRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "replaceAllShapesWithImage": {
    object (ReplaceAllShapesWithImageRequest)
  },
  "duplicateObject": {
    object (DuplicateObjectRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "replaceAllShapesWithSheetsChart": {
    object (ReplaceAllShapesWithSheetsChartRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "updateTableBorderProperties": {
    object (UpdateTableBorderPropertiesRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableRowProperties": {
    object (UpdateTableRowPropertiesRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "groupObjects": {
    object (GroupObjectsRequest)
  },
  "ungroupObjects": {
    object (UngroupObjectsRequest)
  },
  "updatePageElementAltText": {
    object (UpdatePageElementAltTextRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateSlideProperties": {
    object (UpdateSlidePropertiesRequest)
  },
  "updatePageElementsZOrder": {
    object (UpdatePageElementsZOrderRequest)
  },
  "updateLineCategory": {
    object (UpdateLineCategoryRequest)
  },
  "rerouteLine": {
    object (RerouteLineRequest)
  },
  "insertComment": {
    object (InsertCommentRequest)
  },
  "addCommentReply": {
    object (AddCommentReplyRequest)
  },
  "updateCommentPost": {
    object (UpdateCommentPostRequest)
  },
  "deleteComment": {
    object (DeleteCommentRequest)
  },
  "deleteCommentReply": {
    object (DeleteCommentReplyRequest)
  }
}
欄位
更新類型。必須填寫一個欄位。以下列出互斥欄位。回應中最多會設定一個欄位:
createSlide

object (CreateSlideRequest)

建立新投影片。

createShape

object (CreateShapeRequest)

建立新圖案。

createTable

object (CreateTableRequest)

建立新資料表。

insertText

object (InsertTextRequest)

在圖案或表格儲存格中插入文字。

insertTableRows

object (InsertTableRowsRequest)

在表格中插入列。

insertTableColumns

object (InsertTableColumnsRequest)

在表格中插入欄。

deleteTableRow

object (DeleteTableRowRequest)

從資料表中刪除資料列。

deleteTableColumn

object (DeleteTableColumnRequest)

從表格中刪除資料欄。

replaceAllText

object (ReplaceAllTextRequest)

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

deleteObject

object (DeleteObjectRequest)

從簡報中刪除頁面或網頁元素。

updatePageElementTransform

object (UpdatePageElementTransformRequest)

更新網頁元素的轉換。

updateSlidesPosition

object (UpdateSlidesPositionRequest)

更新簡報中一組投影片的位置。

deleteText

object (DeleteTextRequest)

從圖案或表格儲存格中刪除文字。

createImage

object (CreateImageRequest)

製作圖片。

createVideo

object (CreateVideoRequest)

建立影片。

createSheetsChart

object (CreateSheetsChartRequest)

建立內嵌的 Google 試算表圖表。

createLine

object (CreateLineRequest)

建立線條。

refreshSheetsChart

object (RefreshSheetsChartRequest)

重新整理 Google 試算表圖表。

updateShapeProperties

object (UpdateShapePropertiesRequest)

更新 Shape 的屬性。

updateImageProperties

object (UpdateImagePropertiesRequest)

更新 Image 的屬性。

updateVideoProperties

object (UpdateVideoPropertiesRequest)

更新 Video 的屬性。

updatePageProperties

object (UpdatePagePropertiesRequest)

更新 Page 的屬性。

updateTableCellProperties

object (UpdateTableCellPropertiesRequest)

更新 TableCell 的屬性。

updateLineProperties

object (UpdateLinePropertiesRequest)

更新 Line 的屬性。

createParagraphBullets

object (CreateParagraphBulletsRequest)

為段落建立項目符號。

replaceAllShapesWithImage

object (ReplaceAllShapesWithImageRequest)

將符合特定條件的所有圖形替換為圖片。

duplicateObject

object (DuplicateObjectRequest)

複製投影片或網頁元素。

updateTextStyle

object (UpdateTextStyleRequest)

更新 Shape 或 Table 內的文字樣式。

replaceAllShapesWithSheetsChart

object (ReplaceAllShapesWithSheetsChartRequest)

將符合特定條件的所有圖案替換為 Google 試算表圖表。

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

刪除段落中的項目符號。

updateParagraphStyle

object (UpdateParagraphStyleRequest)

更新 Shape 或 Table 內的段落樣式。

updateTableBorderProperties

object (UpdateTableBorderPropertiesRequest)

更新 Table 中表格框線的屬性。

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

更新 Table 資料欄的屬性。

updateTableRowProperties

object (UpdateTableRowPropertiesRequest)

更新資料列的屬性。Table

mergeTableCells

object (MergeTableCellsRequest)

合併 Table 中的儲存格。

unmergeTableCells

object (UnmergeTableCellsRequest)

取消合併 Table 中的儲存格。

groupObjects

object (GroupObjectsRequest)

將物件 (例如網頁元素) 分組。

ungroupObjects

object (UngroupObjectsRequest)

取消物件群組,例如 groups。

updatePageElementAltText

object (UpdatePageElementAltTextRequest)

更新圖片的替代文字標題和/或說明。page element

replaceImage

object (ReplaceImageRequest)

以新圖片取代現有圖片。

updateSlideProperties

object (UpdateSlidePropertiesRequest)

更新 Slide 的屬性

updatePageElementsZOrder

object (UpdatePageElementsZOrderRequest)

更新 page elements 的 Z 順序。

updateLineCategory

object (UpdateLineCategoryRequest)

更新 line 的類別。

rerouteLine

object (RerouteLineRequest)

重新將 line 路由,使其連線至所連線頁面元素上最接近的兩個連線網站。

insertComment

object (InsertCommentRequest)

在簡報中插入 CommentThread 。

addCommentReply

object (AddCommentReplyRequest)

回覆 CommentThread。

updateCommentPost

object (UpdateCommentPostRequest)

更新現有貼文 (主貼文或回覆) 的 CommentThread。

deleteComment

object (DeleteCommentRequest)

刪除 CommentThread。

deleteCommentReply

object (DeleteCommentReplyRequest)

從 CommentThread 中刪除回覆 Post。

互斥欄位結尾。

CreateSlideRequest

建立投影片。

JSON 表示法
{
  "objectId": string,
  "insertionIndex": integer,
  "slideLayoutReference": {
    object (LayoutReference)
  },
  "placeholderIdMappings": [
    {
      object (LayoutPlaceholderIdMapping)
    }
  ]
}
欄位
objectId

string

使用者提供的物件 ID。

如果指定 ID,簡報中所有網頁和網頁元素都不得重複。ID 開頭必須是英數字元或底線 (符合 regex [a-zA-Z0-9_]),其餘字元可包含英數字元、底線、連字號或半形冒號 (符合 regex [a-zA-Z0-9_-:])。ID 長度必須介於 5 到 50 個字元之間 (含頭尾)。

如未指定 ID,系統會產生專屬 ID。

insertionIndex

integer

選用的零起始索引,指出要插入投影片的位置。

如果未指定索引,系統會在結尾建立投影片。

slideLayoutReference

object (LayoutReference)

要插入的投影片的版面配置參照,根據目前母片,可以是下列其中一項:

  • 前一張投影片索引的主版。
  • 如果 insertionIndex 為零,則為第一張投影片的母片。
  • 簡報中的第一個母片 (如果沒有投影片)。

如果系統在目前的主版中找不到 LayoutReference,就會傳回 400 錯誤要求。

如未指定版面配置參照,投影片會使用預先定義的BLANK版面配置。

placeholderIdMappings[]

object (LayoutPlaceholderIdMapping)

從版面配置的 placeholder 到在指定版面配置的投影片上建立的預留位置,物件 ID 對應清單 (選用)。只能在指定 slideLayoutReference 時使用。

LayoutReference

投影片版面配置參照。這可能參照以下任一項目:

  • 預先定義的版面配置
  • 簡報中的其中一個版面配置。
JSON 表示法
{

  "predefinedLayout": enum (PredefinedLayout),
  "layoutId": string
}
欄位
LayoutReference 的種類。以下列出互斥欄位。回應中最多會設定一個欄位:
predefinedLayout

enum (PredefinedLayout)

預先定義的版面配置。

layoutId

string

版面配置 ID:簡報中其中一個版面配置的物件 ID。

互斥欄位結尾。

PredefinedLayout

預先定義的版面配置類型。這些是簡報中常見的版面配置。不過,我們無法保證這些版面配置會出現在目前的主版中,因為這些版面配置可能已遭刪除,或不屬於所用的主題。此外,每個版面配置上的預留位置可能已變更。

列舉
PREDEFINED_LAYOUT_UNSPECIFIED 未指定版面配置。
BLANK 空白版面配置,不含預留位置。
CAPTION_ONLY 底部有說明文字的版面配置。
TITLE 版面配置,包含標題和副標題。
TITLE_AND_BODY 版面配置,包含標題和內文。
TITLE_AND_TWO_COLUMNS 版面配置包含標題和兩欄。
TITLE_ONLY 只有標題的版面配置。
SECTION_HEADER 含有區段標題的版面配置。
SECTION_TITLE_AND_DESCRIPTION 版面配置:一側顯示標題和副標題,另一側顯示說明。
ONE_COLUMN_TEXT 版面配置包含一個標題和一個內文,排列在單一資料欄中。
MAIN_POINT 版面配置,並標示重點。
BIG_NUMBER 版面配置,包含大數字標題。

LayoutPlaceholderIdMapping

使用者為預留位置指定的 ID 對應,該預留位置將在指定版面配置的投影片上建立。

JSON 表示法
{
  "objectId": string,

  "layoutPlaceholder": {
    object (Placeholder)
  },
  "layoutPlaceholderObjectId": string
}
欄位
objectId

string

使用者提供的物件 ID,用於在投影片上建立上述預留位置。

如果指定 ID,簡報中所有網頁和網頁元素都不得重複。ID 開頭必須是英數字元或底線 (符合 regex [a-zA-Z0-9_]),其餘字元可包含英數字元、底線、連字號或半形冒號 (符合 regex [a-zA-Z0-9_-:])。ID 長度不得少於 5 個字元,也不得超過 50 個字元。

如未指定 ID,系統會產生專屬 ID。

用來識別版面配置上預留位置的種類。以下列出互斥欄位。回應中最多會設定一個欄位:
layoutPlaceholder

object (Placeholder)

版面配置中的預留位置,會套用至投影片。只需要 type 和 index。舉例來說,預先定義的TITLE_AND_BODY版面配置通常會有索引為 0 的 TITLE 預留位置,以及索引為 0 的 BODY 預留位置。

layoutPlaceholderObjectId

string

版面配置上預留位置的物件 ID,將套用至投影片。

互斥欄位結尾。

CreateShapeRequest

建立新圖案。

JSON 表示法
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "shapeType": enum (Type)
}
欄位
objectId

string

使用者提供的物件 ID。

如果指定 ID,簡報中所有網頁和網頁元素都不得重複。ID 開頭必須是英數字元或底線 (符合 regex [a-zA-Z0-9_]),其餘字元可包含英數字元、底線、連字號或半形冒號 (符合 regex [a-zA-Z0-9_-:])。ID 長度不得少於 5 個字元,也不得超過 50 個字元。如果留空,系統會產生專屬 ID。

elementProperties

object (PageElementProperties)

形狀的元素屬性。

shapeType

enum (Type)

形狀類型。

PageElementProperties

網頁元素的常見屬性。

注意:首次建立 PageElement 時,API 可能會修改 size 和 transform 的值,但視覺大小不會變更。

JSON 表示法
{
  "pageObjectId": string,
  "size": {
    object (Size)
  },
  "transform": {
    object (AffineTransform)
  }
}
欄位
pageObjectId

string

元素所在頁面的物件 ID。

size

object (Size)

元素的大小。

transform

object (AffineTransform)

元素的轉換。

CreateTableRequest

建立新資料表。

JSON 表示法
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "rows": integer,
  "columns": integer
}
欄位
objectId

string

使用者提供的物件 ID。

如果指定 ID,簡報中所有網頁和網頁元素都不得重複。ID 開頭必須是英數字元或底線 (符合 regex [a-zA-Z0-9_]),其餘字元可包含英數字元、底線、連字號或半形冒號 (符合 regex [a-zA-Z0-9_-:])。ID 長度不得少於 5 個字元,也不得超過 50 個字元。

如未指定 ID,系統會產生專屬 ID。

elementProperties

object (PageElementProperties)

資料表的元素屬性。

系統會以您提供的大小建立資料表,但不得小於下限。如果未提供大小,系統會自動調整表格大小。

表格轉換的比例必須為 1,且不得有剪切元件。如果未提供轉換,表格會置中顯示在頁面上。

rows

integer

資料表中的資料列數。

columns

integer

資料表中的欄數。

InsertTextRequest

在圖案或表格儲存格中插入文字。

JSON 表示法
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "text": string,
  "insertionIndex": integer
}
欄位
objectId

string

要插入文字的圖案或表格物件 ID。

cellLocation

object (TableCellLocation)

如要將文字插入表格儲存格,則為選填的表格儲存格位置。如果有的話,objectId 必須參照資料表。

text

string

要插入的文字。

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

系統會自動決定插入文字的文字樣式,通常會保留鄰近文字的樣式。在大多數情況下,文字會新增至插入索引處的 TextRun。

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

insertionIndex

integer

以 Unicode 程式碼單元為單位,根據 TextElement 索引,指出要插入文字的索引。

索引以零為基準,並從字串開頭計算。系統可能會調整索引,避免在 Unicode 字素叢集內插入內容。在這些情況下,系統會將文字插入字素叢集後方。

InsertTableRowsRequest

在表格中插入列。

JSON 表示法
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean,
  "number": integer
}
欄位
tableObjectId

string

要插入列的表格。

cellLocation

object (TableCellLocation)

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

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

insertBelow

boolean

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

  • True :在儲存格下方插入。
  • False :在儲存格上方插入。
number

integer

要插入的列數。每項要求最多 20 個。

InsertTableColumnsRequest

在表格中插入欄。

表格中的其他欄會調整大小,以配合新欄。

JSON 表示法
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean,
  "number": integer
}
欄位
tableObjectId

string

要插入資料欄的表格。

cellLocation

object (TableCellLocation)

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

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

insertRight

boolean

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

  • True :插入右側。
  • False : insert to the left.
number

integer

要插入的欄數。每項要求最多 20 個。

DeleteTableRowRequest

從資料表中刪除資料列。

JSON 表示法
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  }
}
欄位
tableObjectId

string

要從中刪除資料列的表格。

cellLocation

object (TableCellLocation)

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

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

DeleteTableColumnRequest

從表格中刪除資料欄。

JSON 表示法
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  }
}
欄位
tableObjectId

string

要從中刪除資料欄的表格。

cellLocation

object (TableCellLocation)

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

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

ReplaceAllTextRequest

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

JSON 表示法
{
  "replaceText": string,
  "pageObjectIds": [
    string
  ],

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

string

要取代相符文字的文字。

pageObjectIds[]

string

如果不是空白,則比對結果只會顯示指定網頁上的網頁元素。

如果提供 notes master 的頁面物件 ID,或簡報中沒有該物件 ID 的頁面,則會傳回 400 錯誤要求。

用於比對要取代的文字。以下列出互斥欄位。回應中最多會設定一個欄位:
containsText

object (SubstringMatchCriteria)

在與這個子字串相符的形狀中尋找文字。

互斥欄位結尾。

SubstringMatchCriteria

符合圖案或表格中特定文字字串的條件。

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

string

要在圖案或表格中搜尋的文字。

matchCase

boolean

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

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

boolean

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

  • True :搜尋文字會視為規則運算式。
  • False :搜尋文字會視為子字串進行比對。

DeleteObjectRequest

從簡報中刪除物件,可以是 pages 或 page elements。

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

string

要刪除的網頁或網頁元素物件 ID。

如果刪除作業後,group 只包含 1 個或不包含任何頁面元素,系統也會刪除群組。

如果版面配置中的預留位置遭到刪除,所有空白的繼承預留位置也會一併刪除。

UpdatePageElementTransformRequest

更新網頁元素的轉換。

更新群組的轉換會變更該群組中網頁元素的絕對轉換,這可能會改變這些元素的外觀。詳情請參閱 PageElement.transform 說明文件。

JSON 表示法
{
  "objectId": string,
  "transform": {
    object (AffineTransform)
  },
  "applyMode": enum (ApplyMode)
}
欄位
objectId

string

要更新的網頁元素物件 ID。

transform

object (AffineTransform)

用於更新網頁元素的輸入轉換矩陣。

applyMode

enum (ApplyMode)

轉換更新的套用模式。

ApplyMode

轉換更新的套用模式。

列舉
APPLY_MODE_UNSPECIFIED 未指定模式。
RELATIVE 將新的 AffineTransform 矩陣套用至現有矩陣,並以產生的串連取代現有矩陣。
ABSOLUTE 以新的 AffineTransform 矩陣取代現有矩陣。

UpdateSlidesPositionRequest

更新簡報中投影片的位置。

JSON 表示法
{
  "slideObjectIds": [
    string
  ],
  "insertionIndex": integer
}
欄位
slideObjectIds[]

string

要移動的簡報投影片 ID。這份清單中的投影片必須按照現有簡報順序排列,且不得重複。

insertionIndex

integer

投影片的插入位置索引,以移動前的投影片排列方式為準。必須介於零和簡報中的投影片數量之間 (含)。

DeleteTextRequest

從圖案或表格儲存格中刪除文字。

JSON 表示法
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "textRange": {
    object (Range)
  }
}
欄位
objectId

string

要刪除文字的圖案或表格的物件 ID。

cellLocation

object (TableCellLocation)

如果文字要從表格儲存格中刪除,則為選用的表格儲存格位置。如果有的話,objectId 必須參照資料表。

textRange

object (Range)

要刪除的文字範圍 (以TextElement索引為準)。

形狀或表格儲存格的文字結尾一律會有隱含的換行字元,無法刪除。 Range.Type.ALL 會使用正確的界線,但為範圍類型指定明確界線時,請務必小心 FROM_START_INDEX 和 FIXED_RANGE。舉例來說,如果文字是「ABC」,後面接著隱含換行符,則 textRange.start_index 的最大值為 2,textRange.end_index 的最大值為 3。

刪除跨越段落邊界的文字時,系統會合併兩個段落,因此段落樣式和清單可能會有所變更。

如果範圍只包含一個代理配對的程式碼單元,系統會擴展範圍,納入兩個程式碼單元。

範圍

指定索引集合的連續範圍,例如文字中的字元。

JSON 表示法
{
  "startIndex": integer,
  "endIndex": integer,
  "type": enum (Type)
}
欄位
startIndex

integer

集合開頭的選用索引 (以零為基準)。FIXED_RANGE 和 FROM_START_INDEX 範圍為必填欄位。

endIndex

integer

集合結尾的選填索引 (以零為基準)。FIXED_RANGE範圍為必填欄位。

type

enum (Type)

範圍類型。

類型

範圍類型。

列舉
RANGE_TYPE_UNSPECIFIED 未指定範圍類型,不得使用這個值。
FIXED_RANGE 固定範圍。必須同時指定 startIndex 和 endIndex。
FROM_START_INDEX 從 startIndex 開始,直到收集作業結束。不得指定 endIndex。
ALL 將範圍設為整個集合的長度。不得同時指定 startIndex 和 endIndex 。

CreateImageRequest

製作圖片。

JSON 表示法
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },

  "url": string
}
欄位
objectId

string

使用者提供的物件 ID。

如果指定 ID,簡報中所有網頁和網頁元素都不得重複。ID 開頭必須是英數字元或底線 (符合 regex [a-zA-Z0-9_]),其餘字元可包含英數字元、底線、連字號或半形冒號 (符合 regex [a-zA-Z0-9_-:])。ID 長度不得少於 5 個字元,也不得超過 50 個字元。

如未指定 ID,系統會產生專屬 ID。

elementProperties

object (PageElementProperties)

圖片的元素屬性。

如果提供的尺寸顯示比例與圖片顯示比例不符,系統會根據尺寸縮放圖片並置中,以維持顯示比例。這項作業完成後,系統會套用提供的轉換。

PageElementProperties.size 屬性為選用項目。如未指定大小,系統會使用圖片的預設大小。

PageElementProperties.transform 屬性為選用項目。如果未指定轉換,圖片會放置在頁面左上角。

圖片來源類型。以下列出互斥欄位。回應中最多會設定一個欄位:
url

string

圖片網址。

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

提供的網址必須可公開存取,且長度不得超過 2 KB。網址會與圖片一併儲存,並透過 Image.source_url 欄位公開。

互斥欄位結尾。

CreateVideoRequest

建立影片。

注意:如要從 Google 雲端硬碟建立影片,要求應用程式必須具備至少一個雲端硬碟、雲端硬碟唯讀或雲端硬碟檔案 OAuth 範圍。

JSON 表示法
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "source": enum (Source),
  "id": string
}
欄位
objectId

string

使用者提供的物件 ID。

如果指定 ID,簡報中所有網頁和網頁元素都不得重複。ID 開頭必須是英數字元或底線 (符合 regex [a-zA-Z0-9_]),其餘字元可包含英數字元、底線、連字號或半形冒號 (符合 regex [a-zA-Z0-9_-:])。ID 長度不得少於 5 個字元,也不得超過 50 個字元。

如未指定 ID,系統會產生專屬 ID。

elementProperties

object (PageElementProperties)

影片的元素屬性。

PageElementProperties.size 屬性為選用項目。如未指定大小,伺服器會選擇預設大小。

PageElementProperties.transform 屬性為選用項目。轉換不得有剪切元件。如果未指定轉換,影片會放置在網頁左上角。

source

enum (Source)

影片來源。

id

string

這部影片的影片來源專屬 ID。

例如:YouTube 影片 https://www.youtube.com/watch?v=7U3axjORYZ0 的 ID 為 7U3axjORYZ0。Google 雲端硬碟影片 https://drive.google.com/file/d/1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q ID 為 1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q。

如要存取 Google 雲端硬碟影片檔案,您可能需要為部分舊檔案的 HTTP 標頭新增資源金鑰。詳情請參閱「使用資源金鑰存取透過連結共用的檔案」。

CreateSheetsChartRequest

建立內嵌的 Google 試算表圖表。

注意:建立圖表時,至少需要 spreadsheets.readonly、spreadsheets、drive.readonly、drive.file 或 drive OAuth 範圍。

JSON 表示法
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "spreadsheetId": string,
  "chartId": integer,
  "linkingMode": enum (LinkingMode)
}
欄位
objectId

string

使用者提供的物件 ID。

如果指定 ID,簡報中所有網頁和網頁元素都不得重複。ID 開頭應為字元 [a-zA-Z0-9_],後面可接任意數量的下列字元 [a-zA-Z0-9_-:]。ID 長度不得少於 5 個字元,也不得超過 50 個字元。如果留空,系統會產生專屬 ID。

elementProperties

object (PageElementProperties)

圖表的元素屬性。

如果提供的尺寸顯示比例與圖表顯示比例不符,系統會根據尺寸縮放圖表並置中,以維持顯示比例。這項作業完成後,系統會套用提供的轉換。

spreadsheetId

string

含有圖表的 Google 試算表 ID。

您可能需要為部分舊檔案的 HTTP 標頭新增資源金鑰。詳情請參閱「使用資源金鑰存取透過連結共用的檔案」。

chartId

integer

Google 試算表中的特定圖表 ID。

linkingMode

enum (LinkingMode)

圖表連結至來源試算表的模式。如未指定,圖表會是未連結的圖片。

LinkingMode

圖表連結至來源試算表的模式。

列舉
NOT_LINKED_IMAGE 圖表未與來源試算表建立關聯,因此無法更新。未連結的圖表會以圖片形式插入。
LINKED 連結圖表後,圖表就會更新,其他協作者也會看到試算表的連結。

CreateLineRequest

建立線條。

JSON 表示法
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "lineCategory": enum (Category),
  "category": enum (LineCategory)
}
欄位
objectId

string

使用者提供的物件 ID。

如果指定 ID,簡報中所有網頁和網頁元素都不得重複。ID 開頭必須是英數字元或底線 (符合 regex [a-zA-Z0-9_]),其餘字元可包含英數字元、底線、連字號或半形冒號 (符合 regex [a-zA-Z0-9_-:])。ID 長度不得少於 5 個字元,也不得超過 50 個字元。

如未指定 ID,系統會產生專屬 ID。

elementProperties

object (PageElementProperties)

線條的元素屬性。

lineCategory
(deprecated)

enum (Category)

要建立的線條類別。

已淘汰 :請改用 category。

系統會根據類別和路由方式,判斷要建立的確切 line type ,以便連結至其他頁面元素。

如果同時指定 category 和 lineCategory,系統會優先採用 category。

category

enum (LineCategory)

要建立的線條類別。

系統會根據類別和路由方式,判斷要建立的確切 line type ,以便連結至其他頁面元素。

如果同時指定 category 和 lineCategory,系統會優先採用 category。

如未指定 category 的值,但指定了 lineCategory 的值,則會使用指定的 lineCategory 值。

如未指定任一項,則會使用 STRAIGHT。

類別

線條類別。

列舉
STRAIGHT 直式接頭,包括直式接頭 1。如未指定類別,系統會預設使用這個類別。
BENT 連接器彎曲,包括連接器 2 至 5 彎曲。
CURVED 弧形連接器,包括弧形連接器 2 至 5。

RefreshSheetsChartRequest

重新整理嵌入的 Google 試算表圖表,以 Google 試算表中的最新版圖表取代。

注意:如要重新整理圖表,至少需要 spreadsheets.readonly、spreadsheets、drive.readonly 或 drive OAuth 範圍。

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

string

要重新整理的圖表物件 ID。

UpdateShapePropertiesRequest

更新 Shape 的屬性。

JSON 表示法
{
  "objectId": string,
  "shapeProperties": {
    object (ShapeProperties)
  },
  "fields": string
}
欄位
objectId

string

要套用更新的圖案物件 ID。

shapeProperties

object (ShapeProperties)

要更新的形狀屬性。

fields

string (FieldMask format)

要更新的欄位。

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

舉例來說,如要更新形狀背景的純色填滿顏色,請將 fields 設為 "shapeBackgroundFill.solidFill.color"。

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

UpdateImagePropertiesRequest

更新 Image 的屬性。

JSON 表示法
{
  "objectId": string,
  "imageProperties": {
    object (ImageProperties)
  },
  "fields": string
}
欄位
objectId

string

要套用更新的圖片物件 ID。

imageProperties

object (ImageProperties)

要更新的圖片屬性。

fields

string (FieldMask format)

要更新的欄位。

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

舉例來說,如要更新圖片外框顏色,請將 fields 設為 "outline.outlineFill.solidFill.color"。

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

UpdateVideoPropertiesRequest

更新 Video 的屬性。

JSON 表示法
{
  "objectId": string,
  "videoProperties": {
    object (VideoProperties)
  },
  "fields": string
}
欄位
objectId

string

更新內容套用的影片物件 ID。

videoProperties

object (VideoProperties)

要更新的影片屬性。

fields

string (FieldMask format)

要更新的欄位。

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

舉例來說,如要更新影片外框顏色,請將 fields 設為 "outline.outlineFill.solidFill.color"。

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

UpdatePagePropertiesRequest

更新 Page 的屬性。

JSON 表示法
{
  "objectId": string,
  "pageProperties": {
    object (PageProperties)
  },
  "fields": string
}
欄位
objectId

string

更新套用的頁面物件 ID。

pageProperties

object (PageProperties)

要更新的頁面屬性。

fields

string (FieldMask format)

要更新的欄位。

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

舉例來說,如要更新頁面背景的純色填滿顏色,請將 fields 設為 "pageBackgroundFill.solidFill.color"。

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

UpdateTableCellPropertiesRequest

更新 TableCell 的屬性。

JSON 表示法
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  },
  "tableCellProperties": {
    object (TableCellProperties)
  },
  "fields": string
}
欄位
objectId

string

資料表的物件 ID。

tableRange

object (TableRange)

代表要套用更新的表格子集的表格範圍。如未指定表格範圍,更新會套用至整個表格。

tableCellProperties

object (TableCellProperties)

要更新的表格儲存格屬性。

fields

string (FieldMask format)

要更新的欄位。

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

舉例來說,如要更新表格儲存格背景的純色填滿顏色,請將 fields 設為 "tableCellBackgroundFill.solidFill.color"。

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

TableRange

表格範圍代表對表格子集的參照。

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

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

表格範圍的位置 = (0, 0)、列時距 = 3 且欄時距 = 2,指定下列儲存格:

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

object (TableCellLocation)

表格範圍的起始位置。

rowSpan

integer

表格範圍的資料列跨度。

columnSpan

integer

表格範圍的欄跨度。

UpdateLinePropertiesRequest

更新 Line 的屬性。

JSON 表示法
{
  "objectId": string,
  "lineProperties": {
    object (LineProperties)
  },
  "fields": string
}
欄位
objectId

string

更新套用至的行物件 ID。

lineProperties

object (LineProperties)

要更新的行屬性。

fields

string (FieldMask format)

要更新的欄位。

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

舉例來說,如要更新線條的實心填滿顏色,請將 fields 設為 "lineFill.solidFill.color"。

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

CreateParagraphBulletsRequest

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

系統會計算每個段落開頭的定位點,判斷各段落的巢狀層級。為避免項目符號和對應段落之間出現過多空白,這項要求會移除這些前置定位點。這可能會變更文字部分的索引。

如果更新段落前方的段落位於符合預設格式的清單中,更新的段落就會新增至該清單。

JSON 表示法
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "textRange": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
欄位
objectId

string

包含要新增項目符號文字的圖案或表格物件 ID。

cellLocation

object (TableCellLocation)

如果待修改的文字位於表格儲存格中,則為選用的表格儲存格位置。如果有的話,objectId 必須參照資料表。

textRange

object (Range)

要套用項目符號預設樣式的文字範圍,以索引為準。TextElement

bulletPreset

enum (BulletGlyphPreset)

要使用的項目符號字元種類。預設為 BULLET_DISC_CIRCLE_SQUARE 預設集。

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」。
  • DIGIT :數字,例如「1」、「2」或「3」。
  • ZERODIGIT :數字,個位數前面會加上零,例如「01」、「02」或「03」。如果數字超過一位數,則不會加上前置零。
  • ROMAN :小寫羅馬數字,例如「i」、「ii」或「iii」。
  • UPPERROMAN :大寫羅馬數字,例如「I」、「II」或「III」。
  • LEFTTRIANGLE :指向左方的三角形,對應於 Unicode U+25c4 代碼點
列舉
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_DIGIT_ALPHA_ROMAN 編號清單,前 3 個清單巢狀層級分別使用 DIGIT、ALPHA 和 ROMAN 數字字形,後面加上半形句號。
NUMBERED_DIGIT_ALPHA_ROMAN_PARENS 編號清單,前 3 個清單巢狀層級分別使用 DIGIT、ALPHA 和 ROMAN 數字字形,後面加上半形括號。
NUMBERED_DIGIT_NESTED 編號清單,其中DIGIT以半形句點分隔數字字元,且每個巢狀層級都使用前一個巢狀層級的字元做為前置字元。例如「1.」、'1.1.', '2.', '2.2.'。
NUMBERED_UPPERALPHA_ALPHA_ROMAN 編號清單,前 3 個清單巢狀層級分別使用 UPPERALPHA、ALPHA 和 ROMAN 數字字形,後面加上半形句號。
NUMBERED_UPPERROMAN_UPPERALPHA_DIGIT 編號清單,前 3 個清單巢狀層級分別使用 UPPERROMAN、UPPERALPHA 和 DIGIT 數字字形,後面加上半形句號。
NUMBERED_ZERODIGIT_ALPHA_ROMAN 編號清單,前 3 個清單巢狀層級分別使用 ZERODIGIT、ALPHA 和 ROMAN 數字字形,後面加上半形句號。

ReplaceAllShapesWithImageRequest

將符合指定條件的所有形狀,替換為提供的圖片。

將圖片插入簡報後,圖片會取代形狀,但不會採用形狀的格式,而是以矩形呈現。

JSON 表示法
{
  "replaceMethod": enum (ReplaceMethod),
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "pageObjectIds": [
    string
  ],

  "containsText": {
    object (SubstringMatchCriteria)
  }

  "imageUrl": string
}
欄位
replaceMethod
(deprecated)

enum (ReplaceMethod)

取代方法。

已淘汰 :請改用 imageReplaceMethod。

如果同時指定 replaceMethod 和 imageReplaceMethod,系統會優先採用 imageReplaceMethod。

imageReplaceMethod

enum (ImageReplaceMethod)

圖片替換方法。

如果同時指定 replaceMethod 和 imageReplaceMethod,系統會優先採用 imageReplaceMethod。

如未指定 imageReplaceMethod 的值,但指定了 replaceMethod 的值,則會使用指定的 replaceMethod 值。

如未指定,則會使用 CENTER_INSIDE。

pageObjectIds[]

string

如果不是空白,則比對結果只會顯示指定網頁上的網頁元素。

如果提供 notes page 或 notes master 的頁面物件 ID,或是簡報中沒有該物件 ID 的頁面,系統會傳回 400 錯誤要求。

形狀必須符合的條件,才能進行替換。以下列出互斥欄位。回應中最多會設定一個欄位:
containsText

object (SubstringMatchCriteria)

如果設定此要求,系統會取代所有含有指定文字的圖案。

互斥欄位結尾。
圖片來源類型。以下列出互斥欄位。回應中最多會設定一個欄位:
imageUrl

string

圖片網址。

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

提供的網址長度最多為 2 KB。網址本身會與圖片一併儲存,並透過 Image.source_url 欄位公開。

互斥欄位結尾。

ReplaceMethod

取代方法。

列舉
CENTER_INSIDE 縮放圖片並置中,使其符合原始形狀的邊界,並維持圖片的長寬比。圖片的實際大小可能小於形狀大小。如未指定方法,系統會預設採用這個方法。
CENTER_CROP 縮放及置中圖片,填滿原始形狀的界線。圖片可能會經過裁剪,以填滿形狀。圖片的算繪大小會與原始形狀相同。

ImageReplaceMethod

圖片替換方法。

列舉
IMAGE_REPLACE_METHOD_UNSPECIFIED 未指定圖片更換方法。不得使用這個值。
CENTER_INSIDE 縮放圖片並置中,使其符合原始形狀的邊界,並維持圖片的長寬比。圖片的實際大小可能小於形狀大小。如未指定方法,系統會預設採用這個方法。
CENTER_CROP 縮放及置中圖片,填滿原始形狀的界線。圖片可能會經過裁剪,以填滿形狀。圖片的算繪大小會與原始形狀相同。

DuplicateObjectRequest

複製投影片或網頁元素。

複製投影片時,系統會立即在指定投影片後方建立副本。複製網頁元素時,副本會放在與原始元素相同頁面的相同位置。

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

string

要複製的物件 ID。

objectIds

map (key: string, value: string)

複製的物件可能包含其他物件,例如複製投影片或群組網頁元素時。這張對應表會定義重複物件的 ID 產生方式:鍵是原始物件的 ID,值則是將指派給對應重複物件的 ID。您也可以在這個對應中指定來源物件重複項的 ID,方法是使用與 objectId 欄位相同的值做為鍵,並使用新 ID 做為值。

所有鍵都必須對應簡報中的現有 ID。所有值在簡報中都不得重複,且開頭須為英數字元或底線 (符合 regex [a-zA-Z0-9_]);其餘字元可包含英數字元、底線、連字號或半形冒號 (符合 regex [a-zA-Z0-9_-:])。新 ID 的長度不得少於 5 個字元,也不得超過 50 個字元。

如果地圖中省略了來源物件的任何 ID,系統會指派新的隨機 ID。如果對應表為空白或未設定,所有重複物件都會收到新的隨機 ID。

UpdateTextStyleRequest

更新 Shape 或 Table 中文字的樣式。

JSON 表示法
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "style": {
    object (TextStyle)
  },
  "textRange": {
    object (Range)
  },
  "fields": string
}
欄位
objectId

string

要設定樣式的文字所屬形狀或表格的物件 ID。

cellLocation

object (TableCellLocation)

表格中含有要設定樣式文字的儲存格位置。如果 objectId 是指表格,則 cellLocation 必須有值。否則不得使用。

style

object (TextStyle)

要為文字設定的樣式。

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

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

textRange

object (Range)

要設定樣式的文字範圍。

範圍可能會擴大,納入相鄰的新行。

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

fields

string (FieldMask format)

要更新的欄位。

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

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

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

ReplaceAllShapesWithSheetsChartRequest

使用提供的 Google 試算表圖表,取代符合指定條件的所有圖案。圖表會縮放並置中,以符合原始圖案的邊界。

注意:如要以圖表取代圖案,至少需要 spreadsheets.readonly、spreadsheets、drive.readonly 或 drive OAuth 範圍。

JSON 表示法
{
  "containsText": {
    object (SubstringMatchCriteria)
  },
  "spreadsheetId": string,
  "chartId": integer,
  "linkingMode": enum (LinkingMode),
  "pageObjectIds": [
    string
  ]
}
欄位
containsText

object (SubstringMatchCriteria)

形狀必須符合的條件,才能進行替換。這項要求會取代所有含有指定文字的圖案。

spreadsheetId

string

含有圖表的 Google 試算表 ID。

chartId

integer

Google 試算表中的特定圖表 ID。

linkingMode

enum (LinkingMode)

圖表連結至來源試算表的模式。如未指定,圖表會是未連結的圖片。

pageObjectIds[]

string

如果不是空白,則比對結果只會顯示指定網頁上的網頁元素。

如果提供 notes page 或 notes master 的頁面物件 ID,或是簡報中沒有該物件 ID 的頁面,系統會傳回 400 錯誤要求。

LinkingMode

圖表連結至來源試算表的模式。

列舉
NOT_LINKED_IMAGE 圖表未與來源試算表建立關聯,因此無法更新。未連結的圖表會以圖片形式插入。
LINKED 連結圖表後,圖表就會更新,其他協作者也會看到試算表的連結。

DeleteParagraphBulletsRequest

刪除與指定文字索引 range 重疊的所有段落中的項目符號。

系統會在對應段落的開頭加入縮排,以視覺化方式保留每個段落的巢狀結構層級。

JSON 表示法
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "textRange": {
    object (Range)
  }
}
欄位
objectId

string

含有要刪除項目符號文字的圖案或表格物件 ID。

cellLocation

object (TableCellLocation)

如果待修改的文字位於表格儲存格中,則為選用的表格儲存格位置。如果有的話,objectId 必須參照資料表。

textRange

object (Range)

要刪除項目符號的文字範圍 (以索引為準)。 TextElement

UpdateParagraphStyleRequest

更新與指定文字索引範圍重疊的 Shape 或 Table 中所有段落的樣式。

JSON 表示法
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "style": {
    object (ParagraphStyle)
  },
  "textRange": {
    object (Range)
  },
  "fields": string
}
欄位
objectId

string

要設定樣式的文字所屬形狀或表格的物件 ID。

cellLocation

object (TableCellLocation)

表格中含有要設定樣式段落的儲存格位置。如果 objectId 是指表格,則 cellLocation 必須有值。否則不得為空值。

style

object (ParagraphStyle)

段落的樣式。

textRange

object (Range)

包含要設定樣式的段落的文字範圍。

fields

string (FieldMask format)

要更新的欄位。

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

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

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

UpdateTableBorderPropertiesRequest

更新 Table 中表格框線的屬性。

JSON 表示法
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  },
  "borderPosition": enum (BorderPosition),
  "tableBorderProperties": {
    object (TableBorderProperties)
  },
  "fields": string
}
欄位
objectId

string

資料表的物件 ID。

tableRange

object (TableRange)

代表要套用更新的表格子集的表格範圍。如未指定表格範圍,更新會套用至整個表格。

borderPosition

enum (BorderPosition)

更新應套用的表格範圍中的邊框位置。如未指定邊框位置,更新就會套用至表格範圍內的所有邊框。

tableBorderProperties

object (TableBorderProperties)

要更新的表格框線屬性。

fields

string (FieldMask format)

要更新的欄位。

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

舉例來說,如要更新表格框線的實心填滿顏色,請將 fields 設為 "tableBorderFill.solidFill.color"。

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

BorderPosition

表格邊框位置。

列舉
ALL 範圍內的所有邊界。
BOTTOM 範圍底部的邊界。
INNER 範圍內側的邊界。
INNER_HORIZONTAL 範圍內部的水平框線。
INNER_VERTICAL 範圍內側的垂直框線。
LEFT 範圍左側的邊界。
OUTER 範圍外側的邊框。
RIGHT 範圍右側的邊界。
TOP 範圍頂端的邊界。

UpdateTableColumnPropertiesRequest

更新 Table 資料欄的屬性。

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

string

資料表的物件 ID。

columnIndices[]

integer

以零為起始的索引清單,指定要更新的資料欄。如未提供任何索引,系統會更新資料表中的所有資料欄。

tableColumnProperties

object (TableColumnProperties)

要更新的表格欄屬性。

如果要求中的 tableColumnProperties#columnWidth 值小於 406,400 EMU (32 點),系統會傳回 400 Bad Request 錯誤。

fields

string (FieldMask format)

要更新的欄位。

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

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

如果欄位遮罩中包含「columnWidth」,但屬性未設定,欄寬預設為 406,400 EMU (32 點)。

UpdateTableRowPropertiesRequest

更新資料列的屬性。Table

JSON 表示法
{
  "objectId": string,
  "rowIndices": [
    integer
  ],
  "tableRowProperties": {
    object (TableRowProperties)
  },
  "fields": string
}
欄位
objectId

string

資料表的物件 ID。

rowIndices[]

integer

以零為基準的索引清單,指定要更新的列。如未提供任何索引,系統會更新資料表中的所有資料列。

tableRowProperties

object (TableRowProperties)

要更新的資料列屬性。

fields

string (FieldMask format)

要更新的欄位。

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

舉例來說,如要更新列高下限,請將 fields 設為 "minRowHeight"。

如果欄位遮罩中包含「minRowHeight」,但屬性未設定,最低列高預設為 0。

MergeTableCellsRequest

合併 Table 中的儲存格。

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

string

資料表的物件 ID。

tableRange

object (TableRange)

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

合併儲存格時,其中的文字會串連起來,並儲存在範圍的左上角 (「前端」) 儲存格。如果範圍不是矩形 (在範圍涵蓋已合併的儲存格時,有時會發生這種情況),系統會傳回 400 錯誤要求錯誤。

UnmergeTableCellsRequest

取消合併 Table 中的儲存格。

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

string

資料表的物件 ID。

tableRange

object (TableRange)

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

這個範圍內的所有合併儲存格都會取消合併,而原本就未合併的儲存格則不受影響。如果範圍沒有合併的儲存格,要求就不會執行任何動作。如果合併的儲存格含有文字,文字會保留在取消合併後儲存格區塊的左上角 (「標題」) 儲存格。

GroupObjectsRequest

將物件分組,建立物件群組。舉例來說,群組 PageElements 建立 Group 在同一個頁面上的所有子項。

JSON 表示法
{
  "groupObjectId": string,
  "childrenObjectIds": [
    string
  ]
}
欄位
groupObjectId

string

要建立的群組的使用者提供物件 ID。

如果指定 ID,簡報中所有網頁和網頁元素都不得重複。ID 開頭必須是英數字元或底線 (符合 regex [a-zA-Z0-9_]),其餘字元可包含英數字元、底線、連字號或半形冒號 (符合 regex [a-zA-Z0-9_-:])。ID 長度不得少於 5 個字元,也不得超過 50 個字元。

如未指定 ID,系統會產生專屬 ID。

childrenObjectIds[]

string

要分組的物件 ID。

只有頁面元素可以分組。同一頁面上至少要有兩個網頁元素,且這些元素尚未加入其他群組。部分頁面元素 (例如 videos、 tables 和 placeholders) 無法加入群組。

UngroupObjectsRequest

取消物件群組,例如 groups。

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

string

要取消分組的物件 ID。

只有不在其他 groups 內的 groups 可以取消分組。所有群組都應位於同一頁面。群組本身會遭到刪除。所有子項的視覺大小和位置都會保留。

UpdatePageElementAltTextRequest

更新 page element 的替代文字標題和/或說明。

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

string

更新套用的網頁元素物件 ID。

title

string

網頁元素的更新替代文字標題。如未設定,系統會保留現有值。螢幕閱讀器和其他無障礙介面會顯示標題。僅使用與網頁元素內容相關的人類可讀取值。

description

string

網頁元素的更新替代文字說明。如未設定,系統會保留現有值。螢幕閱讀器和其他無障礙介面會顯示這項說明。僅使用與網頁元素內容相關的人類可讀取值。

ReplaceImageRequest

以新圖片取代現有圖片。

更換圖片會移除現有圖片的部分 image effects 。

JSON 表示法
{
  "imageObjectId": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),

  "url": string
}
欄位
imageObjectId

string

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

imageReplaceMethod

enum (ImageReplaceMethod)

取代方法。

圖片來源類型。以下列出互斥欄位。回應中最多會設定一個欄位:
url

string

圖片網址。

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

提供的網址長度不得超過 2 KB。網址會與圖片一併儲存,並透過 Image.source_url 欄位公開。

互斥欄位結尾。

UpdateSlidePropertiesRequest

更新 Slide 的屬性。

JSON 表示法
{
  "objectId": string,
  "slideProperties": {
    object (SlideProperties)
  },
  "fields": string
}
欄位
objectId

string

要套用更新的投影片物件 ID。

slideProperties

object (SlideProperties)

要更新的投影片屬性。

fields

string (FieldMask format)

要更新的欄位。

至少須指定一個欄位。根「slideProperties」是隱含的,不應指定。單一 "*" 可做為列出每個欄位的簡寫。

舉例來說,如要更新投影片是否略過,請將 fields 設為 "isSkipped"。

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

UpdatePageElementsZOrderRequest

更新網頁元素的 Z 順序。Z 順序是指頁面上元素從後到前的順序。前面的網頁元素可能會遮蓋後方的元素。

JSON 表示法
{
  "pageElementObjectIds": [
    string
  ],
  "operation": enum (ZOrderOperation)
}
欄位
pageElementObjectIds[]

string

要更新的網頁元素物件 ID。

所有網頁元素都必須位於同一網頁,且不得分組。

operation

enum (ZOrderOperation)

要套用至頁面元素的 Z 順序作業。

對多個網頁元素套用這項作業時,系統會保留這些網頁元素在作業前的相對 Z 順序。

ZOrderOperation

更新頁面元素 Z 順序的作業。

列舉
Z_ORDER_OPERATION_UNSPECIFIED 未指定作業。
BRING_TO_FRONT 將頁面元素移至頁面最前方。
BRING_FORWARD 將頁面元素在頁面上向前移動一個元素,相對於指定頁面元素中最靠前的元素。
SEND_BACKWARD 將頁面元素在頁面上往後移動一個元素,相對於指定頁面元素中最靠後的元素。
SEND_TO_BACK 將頁面元素移到頁面後方。

UpdateLineCategoryRequest

更新 line 的類別。

JSON 表示法
{
  "objectId": string,
  "lineCategory": enum (LineCategory)
}
欄位
objectId

string

更新套用至的行物件 ID。

只有標示為「連接器」的線條 (category) 可以更新。

更新類別後,路線可能會重新規劃。

lineCategory

enum (LineCategory)

要更新的行類別。

確切的line type取決於要更新的類別,以及如何將其連線至其他頁面元素。

RerouteLineRequest

重新將 line 路由,使其連線至所連線頁面元素上最接近的兩個連線網站。

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

string

要重新轉送的行物件 ID。

只有標示為「連接器」的線條 (category) 可以重新導向。線條的開始和結束連線必須位於不同的頁面元素上。

InsertCommentRequest

在簡報中插入 CommentThread 。

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

  "objectId": string,
  "shapeTextAnchor": {
    object (ShapeTextAnchor)
  },
  "tableCellTextAnchor": {
    object (TableCellTextAnchor)
  },
  "tableAnchor": {
    object (TableAnchor)
  }
}
欄位
content

string

留言文字 (純文字)。

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

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

assigneeEmailAddress

string

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

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

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

註解所連結的簡報位置。以下列出互斥欄位。回應中最多會設定一個欄位:
objectId

string

與這則留言相關聯的 Page 或 PageElement 物件 ID。如果指定的 objectId 是 Group,留言最多會錨定至群組的 100 個非群組後代。

shapeTextAnchor

object (ShapeTextAnchor)

將註解錨定至 內的特定文字範圍。 Shape。

tableCellTextAnchor

object (TableCellTextAnchor)

將註解錨定至單一儲存格內的特定文字範圍。 Table.

tableAnchor

object (TableAnchor)

將註解錨定至 Table 中的特定儲存格範圍。如果範圍內的儲存格不含文字,則會傳回 400 錯誤要求錯誤。

互斥欄位結尾。

ShapeTextAnchor

錨點,指向 Shape's 內的特定文字範圍。text如要在演講者備忘稿中插入註解,請使用 ShapeTextAnchor 和 speaker notes 物件 ID。

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

string

包含文字的網頁元素物件 ID。

textRange

object (Range)

錨點的文字範圍。

TableCellTextAnchor

錨點,指向 TableCell 內的特定文字範圍。TextElement

JSON 表示法
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "textRange": {
    object (Range)
  }
}
欄位
objectId

string

包含儲存格的表格物件 ID。

cellLocation

object (TableCellLocation)

儲存格在表格中的位置。

textRange

object (Range)

錨點的文字範圍。

TableAnchor

錨點,指向 Table 中的特定儲存格範圍。用於將註解錨定至表格中範圍內每個儲存格的所有文字。

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

string

資料表的物件 ID。

tableRange

object (TableRange)

要套用錨點的表格儲存格範圍。如果省略,系統會將表格中的所有儲存格做為錨點。

AddCommentReplyRequest

將回覆 Post 插入 CommentThread。

JSON 表示法
{
  "commentId": string,
  "post": {
    object (Post)
  }
}
欄位
commentId

string

要新增回覆的 CommentThread ID。

post

object (Post)

代表回覆的 Post。

UpdateCommentPostRequest

更新 Post 中的 CommentThread。

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

  • 提出要求的使用者不是貼文作者。
JSON 表示法
{
  "commentId": string,
  "postId": string,
  "content": string
}
欄位
commentId

string

貼文所屬的 CommentThread ID。

postId

string

要更新的貼文 ID。

content

string

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

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

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

DeleteCommentRequest

刪除 CommentThread。

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

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

string

要刪除的 CommentThread ID。

DeleteCommentReplyRequest

從 CommentThread 中刪除回覆 Post。

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

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

  • 回覆貼文包含 comment action。

  • 回覆貼文包含 assignee。

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

string

貼文所屬的 CommentThread ID。

postId

string

要刪除的回覆 ID Post 。