Requests

要求

套用至試算表的單一更新類型。

JSON 表示法 
{

  // Union field kind can be only one of the following:
  "updateSpreadsheetProperties": {
    object (UpdateSpreadsheetPropertiesRequest)
  },
  "updateSheetProperties": {
    object (UpdateSheetPropertiesRequest)
  },
  "updateDimensionProperties": {
    object (UpdateDimensionPropertiesRequest)
  },
  "updateNamedRange": {
    object (UpdateNamedRangeRequest)
  },
  "repeatCell": {
    object (RepeatCellRequest)
  },
  "addNamedRange": {
    object (AddNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "addSheet": {
    object (AddSheetRequest)
  },
  "deleteSheet": {
    object (DeleteSheetRequest)
  },
  "autoFill": {
    object (AutoFillRequest)
  },
  "cutPaste": {
    object (CutPasteRequest)
  },
  "copyPaste": {
    object (CopyPasteRequest)
  },
  "mergeCells": {
    object (MergeCellsRequest)
  },
  "unmergeCells": {
    object (UnmergeCellsRequest)
  },
  "updateBorders": {
    object (UpdateBordersRequest)
  },
  "updateCells": {
    object (UpdateCellsRequest)
  },
  "addFilterView": {
    object (AddFilterViewRequest)
  },
  "appendCells": {
    object (AppendCellsRequest)
  },
  "clearBasicFilter": {
    object (ClearBasicFilterRequest)
  },
  "deleteDimension": {
    object (DeleteDimensionRequest)
  },
  "deleteEmbeddedObject": {
    object (DeleteEmbeddedObjectRequest)
  },
  "deleteFilterView": {
    object (DeleteFilterViewRequest)
  },
  "duplicateFilterView": {
    object (DuplicateFilterViewRequest)
  },
  "duplicateSheet": {
    object (DuplicateSheetRequest)
  },
  "findReplace": {
    object (FindReplaceRequest)
  },
  "insertDimension": {
    object (InsertDimensionRequest)
  },
  "insertRange": {
    object (InsertRangeRequest)
  },
  "moveDimension": {
    object (MoveDimensionRequest)
  },
  "updateEmbeddedObjectPosition": {
    object (UpdateEmbeddedObjectPositionRequest)
  },
  "pasteData": {
    object (PasteDataRequest)
  },
  "textToColumns": {
    object (TextToColumnsRequest)
  },
  "updateFilterView": {
    object (UpdateFilterViewRequest)
  },
  "deleteRange": {
    object (DeleteRangeRequest)
  },
  "appendDimension": {
    object (AppendDimensionRequest)
  },
  "addConditionalFormatRule": {
    object (AddConditionalFormatRuleRequest)
  },
  "updateConditionalFormatRule": {
    object (UpdateConditionalFormatRuleRequest)
  },
  "deleteConditionalFormatRule": {
    object (DeleteConditionalFormatRuleRequest)
  },
  "sortRange": {
    object (SortRangeRequest)
  },
  "setDataValidation": {
    object (SetDataValidationRequest)
  },
  "setBasicFilter": {
    object (SetBasicFilterRequest)
  },
  "addProtectedRange": {
    object (AddProtectedRangeRequest)
  },
  "updateProtectedRange": {
    object (UpdateProtectedRangeRequest)
  },
  "deleteProtectedRange": {
    object (DeleteProtectedRangeRequest)
  },
  "autoResizeDimensions": {
    object (AutoResizeDimensionsRequest)
  },
  "addChart": {
    object (AddChartRequest)
  },
  "updateChartSpec": {
    object (UpdateChartSpecRequest)
  },
  "updateBanding": {
    object (UpdateBandingRequest)
  },
  "addBanding": {
    object (AddBandingRequest)
  },
  "deleteBanding": {
    object (DeleteBandingRequest)
  },
  "createDeveloperMetadata": {
    object (CreateDeveloperMetadataRequest)
  },
  "updateDeveloperMetadata": {
    object (UpdateDeveloperMetadataRequest)
  },
  "deleteDeveloperMetadata": {
    object (DeleteDeveloperMetadataRequest)
  },
  "randomizeRange": {
    object (RandomizeRangeRequest)
  },
  "addDimensionGroup": {
    object (AddDimensionGroupRequest)
  },
  "deleteDimensionGroup": {
    object (DeleteDimensionGroupRequest)
  },
  "updateDimensionGroup": {
    object (UpdateDimensionGroupRequest)
  },
  "trimWhitespace": {
    object (TrimWhitespaceRequest)
  },
  "deleteDuplicates": {
    object (DeleteDuplicatesRequest)
  },
  "updateEmbeddedObjectBorder": {
    object (UpdateEmbeddedObjectBorderRequest)
  },
  "addSlicer": {
    object (AddSlicerRequest)
  },
  "updateSlicerSpec": {
    object (UpdateSlicerSpecRequest)
  },
  "addDataSource": {
    object (AddDataSourceRequest)
  },
  "updateDataSource": {
    object (UpdateDataSourceRequest)
  },
  "deleteDataSource": {
    object (DeleteDataSourceRequest)
  },
  "refreshDataSource": {
    object (RefreshDataSourceRequest)
  }
  // End of list of possible types for union field kind.
}
欄位
聯集欄位 kind。的更新類型。只有一個欄位。kind 只能是下列其中一個值：
updateSpreadsheetProperties

object (UpdateSpreadsheetPropertiesRequest)

更新試算表的屬性。

updateSheetProperties

object (UpdateSheetPropertiesRequest)

更新工作表的屬性。

updateDimensionProperties

object (UpdateDimensionPropertiesRequest)

更新維度的屬性。

updateNamedRange

object (UpdateNamedRangeRequest)

更新已命名範圍。

repeatCell

object (RepeatCellRequest)

重複執行同一範圍內的單一儲存格。

addNamedRange

object (AddNamedRangeRequest)

新增已命名範圍。

deleteNamedRange

object (DeleteNamedRangeRequest)

刪除已命名範圍。
addSheet

object (AddSheetRequest)

新增工作表。

deleteSheet

object (DeleteSheetRequest)

刪除工作表。

autoFill

object (AutoFillRequest)

根據現有資料自動填入更多資料。
cutPaste

object (CutPasteRequest)

從特定區域剪下資料，並貼到另一個區域。
copyPaste

object (CopyPasteRequest)

複製某個區域的資料，並貼到另一個區域。
mergeCells

object (MergeCellsRequest)

合併儲存格。

unmergeCells

object (UnmergeCellsRequest)

取消合併合併的儲存格。

updateBorders

object (UpdateBordersRequest)

更新儲存格範圍中的框線。
updateCells

object (UpdateCellsRequest)

一次更新多個儲存格。
addFilterView

object (AddFilterViewRequest)

新增篩選器檢視畫面。

appendCells

object (AppendCellsRequest)

將最後一列後方的儲存格附加到工作表中。

clearBasicFilter

object (ClearBasicFilterRequest)

清除工作表中的基本篩選器。
deleteDimension

object (DeleteDimensionRequest)

刪除工作表中的列或欄。

deleteEmbeddedObject

object (DeleteEmbeddedObjectRequest)

刪除工作表中的內嵌物件 (例如圖表、圖片)。

deleteFilterView

object (DeleteFilterViewRequest)

刪除工作表中的篩選器檢視畫面。

duplicateFilterView

object (DuplicateFilterViewRequest)

複製篩選器檢視畫面。

duplicateSheet

object (DuplicateSheetRequest)

複製工作表。

findReplace

object (FindReplaceRequest)

尋找並取代部分文字的其他文字。
insertDimension

object (InsertDimensionRequest)

在工作表中插入新的資料列或資料欄。

insertRange

object (InsertRangeRequest)

在工作表中插入新的儲存格，並移動現有的儲存格。

moveDimension

object (MoveDimensionRequest)

將資料列或資料欄移至工作表中的其他位置。

updateEmbeddedObjectPosition

object (UpdateEmbeddedObjectPositionRequest)

更新內嵌物件 (例如圖表、圖片) 的位置。
pasteData

object (PasteDataRequest)

將資料 (HTML 或分隔符號) 貼到工作表中。

textToColumns

object (TextToColumnsRequest)

將某欄轉換成多欄。

updateFilterView

object (UpdateFilterViewRequest)

更新篩選器檢視畫面的屬性。
deleteRange

object (DeleteRangeRequest)

刪除工作表中的儲存格範圍，將剩餘的儲存格移動。

appendDimension

object (AppendDimensionRequest)

將維度附加到工作表結尾。

addConditionalFormatRule

object (AddConditionalFormatRuleRequest)

新增條件式格式規則。
updateConditionalFormatRule

object (UpdateConditionalFormatRuleRequest)

更新現有的條件式格式規則。

deleteConditionalFormatRule

object (DeleteConditionalFormatRuleRequest)

刪除現有的條件式格式規則。
sortRange

object (SortRangeRequest)

排序特定範圍內的資料。

setDataValidation

object (SetDataValidationRequest)

設定一或多個儲存格的資料驗證作業。
setBasicFilter

object (SetBasicFilterRequest)

設定工作表的基本篩選器。
addProtectedRange

object (AddProtectedRangeRequest)

新增受保護的範圍。

updateProtectedRange

object (UpdateProtectedRangeRequest)

更新受保護的範圍。

deleteProtectedRange

object (DeleteProtectedRangeRequest)

刪除受保護的範圍。
autoResizeDimensions

object (AutoResizeDimensionsRequest)

根據該維度的儲存格內容，自動調整一或多個維度的大小。

addChart

object (AddChartRequest)

新增圖表。
updateChartSpec

object (UpdateChartSpecRequest)

更新圖表規格。
updateBanding

object (UpdateBandingRequest)

更新頻帶範圍

addBanding

object (AddBandingRequest)

新增頻帶範圍

deleteBanding

object (DeleteBandingRequest)

移除頻帶範圍

createDeveloperMetadata

object (CreateDeveloperMetadataRequest)

建立新的開發人員中繼資料
updateDeveloperMetadata

object (UpdateDeveloperMetadataRequest)

更新現有的開發人員中繼資料項目
deleteDeveloperMetadata

object (DeleteDeveloperMetadataRequest)

刪除開發人員中繼資料
randomizeRange

object (RandomizeRangeRequest)

隨機排序範圍內資料列的順序。

addDimensionGroup

object (AddDimensionGroupRequest)

針對指定範圍建立群組。
deleteDimensionGroup

object (DeleteDimensionGroupRequest)

刪除指定範圍內的群組。

updateDimensionGroup

object (UpdateDimensionGroupRequest)

更新指定群組的狀態。
trimWhitespace

object (TrimWhitespaceRequest)

剪輯空白字元 (例如空格、分頁或換行符號) 的儲存格。

deleteDuplicates

object (DeleteDuplicatesRequest)

移除儲存格特定欄中包含重複值的資料列。

updateEmbeddedObjectBorder

object (UpdateEmbeddedObjectBorderRequest)

更新內嵌物件的邊框。
addSlicer

object (AddSlicerRequest)

新增篩選器控制項。

updateSlicerSpec

object (UpdateSlicerSpecRequest)

更新篩選器控制項的規格。
addDataSource

object (AddDataSourceRequest)

新增資料來源。

updateDataSource

object (UpdateDataSourceRequest)

更新資料來源。

deleteDataSource

object (DeleteDataSourceRequest)

刪除資料來源。
refreshDataSource

object (RefreshDataSourceRequest)

重新整理一或多個資料來源和相關資料庫物件。

UpdateSheetPropertiesRequest

更新試算表的屬性。

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

object (SpreadsheetProperties)

要更新的屬性。

fields

string (FieldMask format)

需要更新的欄位。至少須指定一個欄位。根「屬性」已暗示隱含，因此不應指定。單一 "*" 可用來當做每個欄位的簡寫。

UpdateSheetPropertiesRequest

更新具有指定 sheetId 的工作表屬性。

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

object (SheetProperties)

要更新的屬性。

fields

string (FieldMask format)

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

UpdateDimensionsPropertiesRequest

更新指定範圍內維度的屬性。

JSON 表示法 
{
  "properties": {
    object (DimensionProperties)
  },
  "fields": string,

  // Union field dimension_range can be only one of the following:
  "range": {
    object (DimensionRange)
  },
  "dataSourceSheetRange": {
    object (DataSourceSheetDimensionRange)
  }
  // End of list of possible types for union field dimension_range.
}
欄位
properties

object (DimensionProperties)

要更新的屬性。

fields

string (FieldMask format)

需要更新的欄位。至少須指定一個欄位。根 properties 暗示隱含，不應指定。單一 "*" 可用來當做每個欄位的簡寫。
聯集欄位 dimension_range。維度範圍。 dimension_range 只能是下列其中一個值：
range

object (DimensionRange)

要更新的資料列或資料欄。

dataSourceSheetRange

object (DataSourceSheetDimensionRange)

要更新資料來源工作表中的資料欄。

DataSourceSheetDimensionsRange

DATA_SOURCE 工作表中單一維度的範圍。

JSON 表示法 
{
  "sheetId": integer,
  "columnReferences": [
    {
      object (DataSourceColumnReference)
    }
  ]
}
欄位
sheetId

integer

該範圍所在的資料來源工作表 ID。

columnReferences[]

object (DataSourceColumnReference)

資料來源工作表中的資料欄。

UpdateNamedRangeRequest

使用指定 namedRangeId 更新已命名範圍的屬性。

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

object (NamedRange)

要以新屬性更新的已命名範圍。

fields

string (FieldMask format)

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

RepeatCellRequest

將指定儲存格中的所有儲存格更新為指定儲存格物件中的值。系統只會更新 fields 欄位中列出的欄位；其他欄位則不受影響。

如果儲存格包含公式，公式範圍的每個範圍就會自動遞增。舉例來說，如果儲存格的公式為 =A1 至 B2:C4，則 B2 為 =A1，B3 為 =A2，C4 為 =A3，C2 為 =B2，C3 為 =B2，C4 則為 =B3。 =B1

如要將公式範圍保持靜態，請使用 $ 指標。舉例來說，使用 =$A$1 公式可避免資料列和資料欄遞增。

JSON 表示法 
{
  "range": {
    object (GridRange)
  },
  "cell": {
    object (CellData)
  },
  "fields": string
}
欄位
range

object (GridRange)

要重複套用儲存格的範圍。

cell

object (CellData)

要寫入的資料。

fields

string (FieldMask format)

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

AddNamedRangeRequest

在試算表中新增已命名範圍。

JSON 表示法 
{
  "namedRange": {
    object (NamedRange)
  }
}
欄位
namedRange

object (NamedRange)

要新增的已命名範圍。namedRangeId 為選用欄位；如未設定，系統會隨機產生 ID。(指定現有範圍的 ID 時發生錯誤)。

DeleteNamedRangeRequest

從試算表中移除指定 ID 的已命名範圍。

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

string

要刪除的已命名範圍 ID。

AddSheetRequest

新增工作表。將索引加入指定索引時，所有後續工作表的索引都會遞增。如要新增物件工作表，請改用 AddChartRequest 並指定 EmbeddedObjectPosition.sheetId 或 EmbeddedObjectPosition.newSheet。

JSON 表示法 
{
  "properties": {
    object (SheetProperties)
  }
}
欄位
properties

object (SheetProperties)

新工作表應包含的屬性。所有屬性皆為選用屬性。sheetId 為選用欄位；如未設定，系統會隨機產生 ID。(指定既有的工作表 ID 時發生錯誤。)

DeleteSheetRequest

刪除要求的工作表。

JSON 表示法 
{
  "sheetId": integer
}
欄位
sheetId

integer

要刪除的工作表 ID。

如果工作表為 DATA_SOURCE 類型，系統會一併刪除關聯的 DataSource。

AutoFillRequest

根據現有資料填入更多資料。

JSON 表示法 
{
  "useAlternateSeries": boolean,

  // Union field area can be only one of the following:
  "range": {
    object (GridRange)
  },
  "sourceAndDestination": {
    object (SourceAndDestination)
  }
  // End of list of possible types for union field area.
}
欄位
useAlternateSeries

boolean

如果我們想使用「替代」系列產生資料，則為 True。這取決於來源資料的類型和數量。
聯集欄位 area。要自動填入的區域。 area 只能是下列其中一個值：
range

object (GridRange)

要自動填入的範圍。這項操作會檢查範圍，並偵測含有資料的位置，並自動將該項資料填入範圍的其他部分。

sourceAndDestination

object (SourceAndDestination)

要自動填入的來源和目的地區域。這會明確列出自動填入的來源，以及擴充該資料的位置。

SourceAndDestination

來源範圍的組合，以及如何擴充該來源。

JSON 表示法 
{
  "source": {
    object (GridRange)
  },
  "dimension": enum (Dimension),
  "fillLength": integer
}
欄位
source

object (GridRange)

要做為自動填入來源的資料位置。
dimension

enum (Dimension)

系統應填入資料的維度。
fillLength

integer

應填入資料的列數或欄數。正數會大於來源的最後一列或最後一欄。來源中的第一列或第一欄前，負數會展開。

CutPasteRequest

將資料從來源移至目的地。

JSON 表示法 
{
  "source": {
    object (GridRange)
  },
  "destination": {
    object (GridCoordinate)
  },
  "pasteType": enum (PasteType)
}
欄位
source

object (GridRange)

要截斷的來源資料。

destination

object (GridCoordinate)

貼上資料的左上角座標。
pasteType

enum (PasteType)

要貼上的資料類型。無論貼上的內容為何，所有來源資料都會遭到裁剪。

貼上類型

應貼上的資料類型。

列舉
PASTE_NORMAL 貼上值、公式、格式和合併。
PASTE_VALUES 「只能」貼上不含格式、公式或合併的值。
PASTE_FORMAT 僅貼上格式和資料驗證。
PASTE_NO_BORDERS 與 PASTE_NORMAL 相似，但無邊框。
PASTE_FORMULA 僅貼上公式。
PASTE_DATA_VALIDATION 僅貼上資料驗證。
PASTE_CONDITIONAL_FORMATTING 僅貼上條件式格式設定規則。

CopyPasteRequest

將資料從來源複製到目的地。

JSON 表示法 
{
  "source": {
    object (GridRange)
  },
  "destination": {
    object (GridRange)
  },
  "pasteType": enum (PasteType),
  "pasteOrientation": enum (PasteOrientation)
}
欄位
source

object (GridRange)

要複製的來源範圍。

destination

object (GridRange)

要貼上的位置。如果範圍包含來源高度或寬度的多個 Span，則資料會重複填入目的地範圍。如果範圍小於來源範圍，系統仍會複製整個來源資料 (超出目的地範圍的終點)。

pasteType

enum (PasteType)

要貼上的資料類型。

pasteOrientation

enum (PasteOrientation)

貼上資料時應如何導向。

貼上方向

執行貼上作業的方式。

列舉
NORMAL 照常貼上。
TRANSPOSE 貼上交易，而所有列都會變成欄，反之亦然。

MergeCellsRequest

合併範圍內的所有儲存格。

JSON 表示法 
{
  "range": {
    object (GridRange)
  },
  "mergeType": enum (MergeType)
}
欄位
range

object (GridRange)

要合併的儲存格範圍。

mergeType

enum (MergeType)

儲存格的合併方式。

合併類型

要建立的合併類型。

列舉
MERGE_ALL 從範圍內建立單一合併
MERGE_COLUMNS 為範圍內的每個資料欄建立合併
MERGE_ROWS 為範圍內的每一列建立合併

未合併儲存格要求

取消合併指定範圍內的儲存格。

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

object (GridRange)

應取消合併所有儲存格的範圍。如果範圍橫跨多個合併項目，則系統會取消合併。範圍不得部分合併。

UpdateBordersRequest

更新範圍的邊框。如果未在要求中設定欄位，表示邊框會維持原狀。舉例來說，假設有兩個後續的 UpdateBordersRequest：

  1. 範圍：A1:A5 { top: RED, bottom: WHITE }
  2. 範圍：A1:A5 { left: BLUE }

這會導致 A1:A5 加上 { top: RED, bottom: WHITE, left: BLUE } 的邊框。如要清除邊框，請將樣式明確設為 NONE。

JSON 表示法 
{
  "range": {
    object (GridRange)
  },
  "top": {
    object (Border)
  },
  "bottom": {
    object (Border)
  },
  "left": {
    object (Border)
  },
  "right": {
    object (Border)
  },
  "innerHorizontal": {
    object (Border)
  },
  "innerVertical": {
    object (Border)
  }
}
欄位
range

object (GridRange)

邊框的邊界應更新。
top

object (Border)

要置於範圍頂端的邊框。
bottom

object (Border)

要置於範圍底部的邊框。
left

object (Border)

要置於範圍左側的邊框。
right

object (Border)

要放在範圍右側的邊框。
innerHorizontal

object (Border)

要放入範圍的水平框線。

innerVertical

object (Border)

要放入範圍的垂直框線。

UpdateCellsRequest

使用新資料更新範圍內的所有儲存格。

JSON 表示法 
{
  "rows": [
    {
      object (RowData)
    }
  ],
  "fields": string,

  // Union field area can be only one of the following:
  "start": {
    object (GridCoordinate)
  },
  "range": {
    object (GridRange)
  }
  // End of list of possible types for union field area.
}
欄位
rows[]

object (RowData)

要寫入的資料。

fields

string (FieldMask format)

需更新的 CellData 欄位。至少須指定一個欄位。根層級為 CellData；「row.values.」不應指定。單一 "*" 可用來當做每個欄位的簡寫。
聯集欄位 area。寫入位置資料。只能設定一個值。 area 只能是下列其中一個值：
start

object (GridCoordinate)

開始寫入資料的座標。可以寫入不限數量的列數和欄數 (包括每列的不同欄數)。

range

object (GridRange)

寫入資料的範圍。

如果資料列中的資料未涵蓋整個要求範圍，系統會清除在 fields 中設定的欄位。

AddFilterViewRequest

新增篩選器檢視畫面。

JSON 表示法 
{
  "filter": {
    object (FilterView)
  }
}
欄位
filter

object (FilterView)

要新增的篩選器。filterViewId 為選用欄位；如未設定，系統會隨機產生 ID。(指定已存在的篩選器 ID 有誤。)

AttachCellsRequest

在工作表的最後一列中加入新的儲存格，並視需要插入新的資料列。

JSON 表示法 
{
  "sheetId": integer,
  "rows": [
    {
      object (RowData)
    }
  ],
  "fields": string
}
欄位
sheetId

integer

要附加資料的工作表 ID。

rows[]

object (RowData)

要附加的資料。
fields

string (FieldMask format)

需更新的 CellData 欄位。至少須指定一個欄位。根層級為 CellData；「row.values.」不應指定。單一 "*" 可用來當做每個欄位的簡寫。

ClearBasicFilterRequest

如果工作表上已有基本篩選器，則清除現有篩選器。

JSON 表示法 
{
  "sheetId": integer
}
欄位
sheetId

integer

應清除基本篩選器的工作表 ID。

DeleteDimensionsRequest

刪除工作表中的維度。

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

object (DimensionRange)

要從試算表中刪除的維度。

DeleteEmbedObjectRequest

刪除具有指定 ID 的內嵌物件。

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

integer

要刪除的內嵌物件 ID。

DeleteFilterViewRequest

刪除特定篩選器檢視畫面。

JSON 表示法 
{
  "filterId": integer
}
欄位
filterId

integer

要刪除的篩選器 ID。

DuplicateFilterViewRequest

複製特定篩選器檢視畫面。

JSON 表示法 
{
  "filterId": integer
}
欄位
filterId

integer

所複製篩選器的 ID。

DuplicateSheetRequest

複製工作表內容。

JSON 表示法 
{
  "sourceSheetId": integer,
  "insertSheetIndex": integer,
  "newSheetId": integer,
  "newSheetName": string
}
欄位
sourceSheetId

integer

要複製的工作表。

如果來源工作表的類型為 DATA_SOURCE，則系統會複製其備份 DataSource，並與工作表的新副本建立關聯。不會觸發任何資料執行作業，系統也會複製這份工作表的格線資料，但只有在批次要求完成後才能使用。
insertSheetIndex

integer

插入新工作表的零索引。在這之後，所有工作表的索引都會遞增。
newSheetId

integer

如已設定，則為新工作表的 ID。如未設定，系統會選擇 ID。如已設定，該 ID 不得與任何現有的工作表 ID 相衝突。如果已設定，這個值必須為正數。

newSheetName

string

新工作表的名稱。如果留空，系統會為您選擇新的名稱。

FindReplaceRequest

在範圍、工作表或所有工作表中尋找並取代儲存格中的資料。

JSON 表示法 
{
  "find": string,
  "replacement": string,
  "matchCase": boolean,
  "matchEntireCell": boolean,
  "searchByRegex": boolean,
  "includeFormulas": boolean,

  // Union field scope can be only one of the following:
  "range": {
    object (GridRange)
  },
  "sheetId": integer,
  "allSheets": boolean
  // End of list of possible types for union field scope.
}
欄位
find

string

要搜尋的值。

replacement

string

要取代的值。

matchCase

boolean

如果搜尋字詞區分大小寫，則為 True。

matchEntireCell

boolean

如果發現項目值應與整個儲存格相符，則為 True。

searchByRegex

boolean

如果發現項目值為規則運算式，則為 True。規則運算式和替換作業應遵循 Java 規則運算式規則，網址為 https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html。替換字串可以參照擷取群組。舉例來說，如果一個儲存格的內容為 "Google Sheets"，另一個儲存格包含 "Google Docs"，則搜尋 "$1 Rocks" 時，系統會將 "o.* (.*)" 的內容分別變更為 "GSheets Rocks" 和 "GDocs Rocks"。
includeFormulas

boolean

如果搜尋字詞應包含公式，則為 True。設為「否」即可略過含有公式的儲存格。

聯集欄位 scope。要尋找/取代的範圍，只能設定一個範圍。 scope 只能是下列其中一個值：
range

object (GridRange)

要尋找/取代的範圍。

sheetId

integer

「尋找/取代」工作表。

allSheets

boolean

True 即可尋找/取代所有工作表。

InsertDimensionsRequest

在特定工作表中插入資料列或資料欄。

JSON 表示法 
{
  "range": {
    object (DimensionRange)
  },
  "inheritFromBefore": boolean
}
欄位
range

object (DimensionRange)

要插入的尺寸。起始索引和結束索引都必須建立繫結。
inheritFromBefore

boolean

指定尺寸屬性是否應延伸至新插入的維度之前或之後。True 可沿用其維度 (在起始索引必須大於 0 時)，而 false 則繼承沿用的維度。

舉例來說，如果資料列索引 0 的紅色背景和列索引 1 有綠色背景，那麼在索引 1 中插入 2 列後，就能沿用綠色或紅色背景。如果 inheritFromBefore 為 true，兩個新資料列就會是紅色 (因為插入點前的資料列為紅色)，而 inheritFromBefore 為 false 時，兩個新的資料列會呈現綠色 (因為插入點之後的列顯示為綠色)。

InsertRangeRequest

將儲存格插入某個範圍，將現有儲存格上下移動。

JSON 表示法 
{
  "range": {
    object (GridRange)
  },
  "shiftDimension": enum (Dimension)
}
欄位
range

object (GridRange)

要插入新儲存格的範圍。
shiftDimension

enum (Dimension)

插入儲存格時轉移的維度。如為 ROWS，則會替換現有儲存格。如為 COLUMNS，會將現有儲存格向右移。

MoveDimensionsRequest

移動一或多個資料列或資料欄。

JSON 表示法 
{
  "source": {
    object (DimensionRange)
  },
  "destinationIndex": integer
}
欄位
source

object (DimensionRange)

要移動的來源維度。

destinationIndex

integer

將來源資料移至哪個位置的起始索引 (從以資料從來源中移除格線「之前」的座標為準)。視資料尺寸而定，現有資料會向右或向右移動 (視維度而定)。來源維度已從格狀檢視中移除，因此資料可能會與您指定的索引不同。

舉例來說，假設 A1..A5 為 0, 1, 2, 3, 4，且想要將 "1" 和 "2" 移至 "3" 和 "4"，則來源為 ROWS [1..3)，而目的地索引為 "4" (第 5 列的索引)。最終結果為 0, 3, 1, 2, 4的 A1..A5。

UpdateEmbedObjectPositionRequest

更新內嵌物件的位置 (例如移動或調整圖表或圖片的大小)。

JSON 表示法 
{
  "objectId": integer,
  "newPosition": {
    object (EmbeddedObjectPosition)
  },
  "fields": string
}
欄位
objectId

integer

要移動的物件 ID。

newPosition

object (EmbeddedObjectPosition)

要移動內嵌物件的明確位置。如果設定 newPosition.sheetId，系統就會以該 ID 建立新的工作表。如果將 newPosition.newSheet 設為 true，系統就會為你建立新工作表，並為你選擇一組 ID。
fields

string (FieldMask format)

設定新位置時應更新的 OverlayPosition 欄位。只有在已設定 newPosition.overlayPosition 的情況下才能使用，在這種情況下，必須指定至少一個欄位。根 newPosition.overlayPosition 暗示隱含，不應指定。單一 "*" 可用來當做每個欄位的簡寫。

貼上資料要求

在試算表中插入指定座標的資料。

JSON 表示法 
{
  "coordinate": {
    object (GridCoordinate)
  },
  "data": string,
  "type": enum (PasteType),

  // Union field kind can be only one of the following:
  "delimiter": string,
  "html": boolean
  // End of list of possible types for union field kind.
}
欄位
coordinate

object (GridCoordinate)

應插入資料的座標。
data

string

要插入的資料。
type

enum (PasteType)

如何貼上資料。

聯集欄位 kind。如何解讀資料，只需設定一個值。kind 只能是下列其中一個值：
delimiter

string

資料中的分隔符號。
html

boolean

如果資料是 HTML，則為 True。

TextToCOLUMNRequest

依據每個儲存格中的分隔符號，將資料欄分割為多個資料欄。

JSON 表示法 
{
  "source": {
    object (GridRange)
  },
  "delimiter": string,
  "delimiterType": enum (DelimiterType)
}
欄位
source

object (GridRange)

來源資料範圍。這只能包含一個資料欄。

delimiter

string

要使用的分隔符號。分隔符號類型為 CUSTOM 時才能使用。

delimiterType

enum (DelimiterType)

要使用的分隔符號類型。

DelimiterType

要分割的分隔符號。

列舉
DELIMITER_TYPE_UNSPECIFIED 預設值。這個值不可使用。
COMMA 」"
SEMICOLON ";
PERIOD 。」
SPACE 」
CUSTOM 於分隔符號中定義的自訂值。
AUTODETECT 自動偵測資料欄。

UpdateFilterViewRequest

更新篩選器檢視畫面的屬性。

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

object (FilterView)

篩選器檢視畫面的新屬性。
fields

string (FieldMask format)

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

DeleteRangeRequest

刪除特定儲存格範圍，將其他儲存格移至已刪除的區域。

JSON 表示法 
{
  "range": {
    object (GridRange)
  },
  "shiftDimension": enum (Dimension)
}
欄位
range

object (GridRange)

要刪除的儲存格範圍。

shiftDimension

enum (Dimension)

用來取代刪除儲存格的維度。如為 ROWS，系統會將現有儲存格往上移，以取代已刪除的儲存格。如果設為 COLUMNS，會將現有儲存格向左移，以取代已刪除的儲存格。

AttachDimensionsRequest

將資料列或資料欄附加到工作表結尾。

JSON 表示法 
{
  "sheetId": integer,
  "dimension": enum (Dimension),
  "length": integer
}
欄位
sheetId

integer

要附加至資料列或資料欄的工作表。
dimension

enum (Dimension)

是否要附加資料列或資料欄。

length

integer

要附加的列數或欄數。

AddConditionalFormatRuleRequest

在特定索引中新增條件式格式規則。所有後續的規則索引都會遞增。

JSON 表示法 
{
  "rule": {
    object (ConditionalFormatRule)
  },
  "index": integer
}
欄位
rule

object (ConditionalFormatRule)

要新增的規則。

index

integer

應該插入規則的零索引。

UpdateConditionalFormatRuleRequest

更新指定索引中的條件式格式規則，或是將條件式格式規則移至其他索引。

JSON 表示法 
{
  "index": integer,
  "sheetId": integer,

  // Union field instruction can be only one of the following:
  "rule": {
    object (ConditionalFormatRule)
  },
  "newIndex": integer
  // End of list of possible types for union field instruction.
}
欄位
index

integer

應該取代或移動的規則 (從零開始)。

sheetId

integer

要移動的規則工作表。如果設定了 newIndex，則為必要欄位，否則為未使用。
聯集欄位 instruction。應執行的更新類型。instruction 只能是下列其中一個值：
rule

object (ConditionalFormatRule)

應在指定索引取代規則的規則。
newIndex

integer

規則應從零開始的新索引。

DeleteConditionalFormatRuleRequest

刪除指定索引的條件式格式規則。所有後續規則的索引都會減少。

JSON 表示法 
{
  "index": integer,
  "sheetId": integer
}
欄位
index

integer

要刪除的規則從零開始。

sheetId

integer

即將刪除這項規則的工作表。

SortRangeRequest

按各欄的排序順序在資料列中排序資料。

JSON 表示法 
{
  "range": {
    object (GridRange)
  },
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ]
}
欄位
range

object (GridRange)

要排序的範圍。

sortSpecs[]

object (SortSpec)

每一欄的排序順序。如果值採用較舊的規格，系統就會使用後續規格。

SetDataValidationRequest

將資料範圍規則設定為範圍內每個儲存格。如要清除特定範圍內的驗證結果，不用指定任何規則即可呼叫此方法。

JSON 表示法 
{
  "range": {
    object (GridRange)
  },
  "rule": {
    object (DataValidationRule)
  }
}
欄位
range

object (GridRange)

資料驗證規則適用的範圍。

rule

object (DataValidationRule)

要納入範圍內每個儲存格的資料驗證規則，或是留空以清除範圍內的資料驗證。

SetBasicFilterRequest

設定與工作表相關聯的基本篩選器。

JSON 表示法 
{
  "filter": {
    object (BasicFilter)
  }
}
欄位
filter

object (BasicFilter)

要設定的篩選器。

AddProtectedRangeRequest

新增受保護的範圍。

JSON 表示法 
{
  "protectedRange": {
    object (ProtectedRange)
  }
}
欄位
protectedRange

object (ProtectedRange)

要新增的受保護範圍。protectedRangeId 為選用欄位；如未設定，系統會隨機產生 ID。(指定現有範圍的 ID 時發生錯誤)。

UpdateProtectedRangeRequest

使用指定的 protectedRangeId 更新現有的受保護範圍。

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

object (ProtectedRange)

要以新屬性更新的受保護範圍。

fields

string (FieldMask format)

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

DeleteProtectedRangeRequest

刪除具有指定 ID 的受保護範圍。

JSON 表示法 
{
  "protectedRangeId": integer
}
欄位
protectedRangeId

integer

要刪除的受保護範圍的 ID。

AutoResizeDimensionsRequest

根據該維度的儲存格內容，自動調整一或多個維度的大小。

JSON 表示法 
{

  // Union field dimension_range can be only one of the following:
  "dimensions": {
    object (DimensionRange)
  },
  "dataSourceSheetDimensions": {
    object (DataSourceSheetDimensionRange)
  }
  // End of list of possible types for union field dimension_range.
}
欄位
聯集欄位 dimension_range。維度範圍。 dimension_range 只能是下列其中一個值：
dimensions

object (DimensionRange)

系統會自動調整大小的尺寸。
dataSourceSheetDimensions

object (DataSourceSheetDimensionRange)

資料來源工作表上的維度，會自動調整大小。

AddChartRequest

在試算表中新增圖表。

JSON 表示法 
{
  "chart": {
    object (EmbeddedChart)
  }
}
欄位
chart

object (EmbeddedChart)

要加入試算表的圖表，包括應放置的位置。chartId 為選用欄位；如未設定，系統會隨機產生 ID。(指定已存在的內嵌物件 ID 有誤)。

UpdateChartSpecRequest

更新圖表規格。(這項操作不會移動或調整圖表大小)。如要移動圖表或調整圖表大小，請使用 UpdateEmbeddedObjectPositionRequest。)

JSON 表示法 
{
  "chartId": integer,
  "spec": {
    object (ChartSpec)
  }
}
欄位
chartId

integer

要更新的圖表 ID。

spec

object (ChartSpec)

套用至圖表的規格。

UpdateBandingRequest

更新所提供頻帶範圍的屬性。

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

object (BandedRange)

要更新新屬性的頻帶範圍。

fields

string (FieldMask format)

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

AddBandingRequest

在試算表中新增頻帶範圍。

JSON 表示法 
{
  "bandedRange": {
    object (BandedRange)
  }
}
欄位
bandedRange

object (BandedRange)

要新增的頻帶範圍。bandedRangeId 為選用欄位；如未設定，系統會隨機產生 ID。(指定現有範圍的 ID 時發生錯誤)。

DeleteBandingRequest

從試算表中移除指定 ID 的頻帶範圍。

JSON 表示法 
{
  "bandedRangeId": integer
}
欄位
bandedRangeId

integer

要刪除的頻帶範圍 ID。

建立 DeveloperMetadataRequest

建立開發人員中繼資料的要求。

JSON 表示法 
{
  "developerMetadata": {
    object (DeveloperMetadata)
  }
}
欄位
developerMetadata

object (DeveloperMetadata)

要建立的開發人員中繼資料。

UpdateDeveloperMetadataRequest

更新開發人員中繼資料屬性的要求。將篩選器選取的開發人員中繼資料屬性更新為 DeveloperMetadata 資源提供的值。呼叫端必須指定在欄位參數中要更新的屬性，以及至少指定一個要更新的中繼資料的 DataFilter。

JSON 表示法 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "developerMetadata": {
    object (DeveloperMetadata)
  },
  "fields": string
}
欄位
dataFilters[]

object (DataFilter)

與要更新的開發人員中繼資料項目相符的篩選器。
developerMetadata

object (DeveloperMetadata)

所有與資料篩選器相符的中繼資料會更新為該值。

fields

string (FieldMask format)

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

DeleteDeveloperMetadataRequest

刪除開發人員中繼資料的要求。

JSON 表示法 
{
  "dataFilter": {
    object (DataFilter)
  }
}
欄位
dataFilter

object (DataFilter)

資料篩選器，用於說明選取要刪除的開發人員中繼資料項目的條件。

RandomizeRangeRequest

隨機排序範圍內資料列的順序。

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

object (GridRange)

要隨機變換的範圍。

新增維度群組要求

針對指定範圍建立群組。

如果要求的範圍是現有群組 G 的超集，則 G 深度會增加，而這個新群組 G 則會擁有該群組的深度。舉例來說，[C:D, depth 1] + [B:E] 群組會產生 [B:E, depth 1] 和 [C:D, depth 2] 群組。如果要求範圍是現有群組 G 範圍中的子集，新群組 G 的深度就會大於 G 的深度。舉例來說，[B:E, depth 1] + [C:D] 群組會產生 [B:E, depth 1] 和 [C:D, depth 2] 群組。如果要求範圍的開始和結束時間在現有群組 G 的範圍內或開始、結束，則現有群組 G 的範圍就會變成範圍聯集，而新群組 G 的深度則會超過 G 和範圍的深度，做為範圍的交集。舉例來說，[B:D, depth 1] + [C:E] 群組會產生 [B:E, depth 1] 和 [C:D, depth 2] 群組。

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

object (DimensionRange)

建立群組的範圍。

DeleteDimensionsGroupRequest

將範圍內維度的尺寸縮減，以刪除指定範圍內的群組。

舉例來說，假設工作表有 B-E 深度的深度深度 1，群組為深度：2 至 D 群組。刪除超過 D:E 的工作表時，工作表會位於 B:D 層級，且深度深度為 1 或 C 至 2 的群組。

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

object (DimensionRange)

要刪除的群組範圍。

UpdateDimensionsGroupRequest

更新指定群組的狀態。

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

object (DimensionGroup)

應更新狀態的群組。群組的範圍和深度應在工作表中指定有效的群組，並更新所有其他欄位。

fields

string (FieldMask format)

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

TrimWhitespaceRequest

在指定的範圍內，每個儲存格中的空白字元 (例如空格、分頁或換行) 剪輯。這項要求會移除所有儲存格文字開頭和結尾的所有空白字元，並將剩餘空白字元的所有子字元合併成單一空格。如果產生的剪輯文字以「+」或「='」字元開頭，文字會保持為字串值，而且不會解讀為公式。

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

object (GridRange)

要剪輯的儲存格範圍。

DeleteDuplicatesRequest

移除這個範圍內的資料列，當中包含的指定欄含有的值與先前一列的值重複。含有相同值但字母大小寫、格式或公式的資料列都算是重複資料列。

此外，由於資料檢視含有篩選器篩選器，這項要求也會移除未顯示的重複資料列。移除重複項目時，每個上列重複掃描的第一個例項都會保留在結果範圍內。系統不會移除指定範圍外的內容，而且只要有重複的資料列，即使彼此沒有重複，系統也不會保留資料列。

JSON 表示法 
{
  "range": {
    object (GridRange)
  },
  "comparisonColumns": [
    {
      object (DimensionRange)
    }
  ]
}
欄位
range

object (GridRange)

您要移除重複資料列的範圍。

comparisonColumns[]

object (DimensionRange)

要用來分析重複值的範圍。如未選取任何資料欄，則系統會分析所有資料欄來找出重複資料欄。

UpdateEmbedObjectBorderRequest

更新內嵌物件的邊框屬性。

JSON 表示法 
{
  "objectId": integer,
  "border": {
    object (EmbeddedObjectBorder)
  },
  "fields": string
}
欄位
objectId

integer

要更新的內嵌物件 ID。

border

object (EmbeddedObjectBorder)

套用至嵌入物件的邊框。

fields

string (FieldMask format)

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

AddSlicerRequest

將篩選器控制項新增至試算表中的試算表。

JSON 表示法 
{
  "slicer": {
    object (Slicer)
  }
}
欄位
slicer

object (Slicer)

應加入試算表的篩選器控制項，包括應放置的位置。slicerId 為選用欄位；如未設定，系統會隨機產生 ID。(指定現有篩選器控制項的 ID 有誤)。

UpdateSlicerSpecRequest

更新篩選器控制項的規格。(這項操作不會移動或調整篩選器控制項的大小)。如要移動或調整篩選器控制項的大小，請使用 UpdateEmbeddedObjectPositionRequest。

JSON 表示法 
{
  "slicerId": integer,
  "spec": {
    object (SlicerSpec)
  },
  "fields": string
}
欄位
slicerId

integer

要更新的篩選器控制項 ID。

spec

object (SlicerSpec)

套用至篩選器控制項的規格。
fields

string (FieldMask format)

需要更新的欄位。至少須指定一個欄位。根 SlicerSpec 暗示隱含，不應指定。單一「*」可用於列出每個欄位。

AddDataSourceRequest

新增資料來源。資料來源新增成功後，系統會建立關聯的 DATA_SOURCE 工作表，並觸發執行作業來重新整理工作表，以便讀取資料來源中的資料。要求需要額外的 bigquery.readonly OAuth 範圍。

JSON 表示法 
{
  "dataSource": {
    object (DataSource)
  }
}
欄位
dataSource

object (DataSource)

要新增的資料來源。

UpdateDataSourceRequest

更新資料來源。資料來源成功更新後，會觸發執行作業來重新整理相關聯的 DATA_SOURCE 工作表，以從更新後的資料來源讀取資料。要求需要額外的 bigquery.readonly OAuth 範圍。

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

object (DataSource)

要更新的資料來源。

fields

string (FieldMask format)

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

DeleteDataSourceRequest

刪除資料來源。要求也會刪除相關聯的資料來源工作表，並取消連結所有相關聯的資料來源物件。

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

string

要刪除的資料來源 ID。

RefreshDataSourceRequest

透過指定的參考資料，重新整理試算表中的一或多個資料來源物件。要求需要額外的 bigquery.readonly OAuth 範圍。

如有多個重新整理要求，並以單一批次參照相同的資料來源物件，系統只會處理最近一次的重新整理要求，而這些要求都會有相同的回應。

JSON 表示法 
{
  "force": boolean,

  // Union field target can be only one of the following:
  "references": {
    object (DataSourceObjectReferences)
  },
  "dataSourceId": string,
  "isAll": boolean
  // End of list of possible types for union field target.
}
欄位
force

boolean

無論資料來源為何，重新整理資料來源物件。如未設定，且參照的資料來源物件處於錯誤狀態，系統就會立即重新整理。
聯集欄位 target。指定要重新整理的內容。target 只能是下列其中一個值：
references

object (DataSourceObjectReferences)

要重新整理的資料來源物件參照。

dataSourceId

string

參照 DataSource。指定時，系統會重新整理資料來源的所有相關聯的資料來源物件。

isAll

boolean

重新整理試算表中所有現有的資料來源物件。

DataSourceObjectReferences

資料來源物件參照清單。

JSON 表示法 
{
  "references": [
    {
      object (DataSourceObjectReference)
    }
  ]
}
欄位
references[]

object (DataSourceObjectReference)

參考資料。

DataSourceObjectReference

參照資料來源物件。

JSON 表示法 
{

  // Union field value can be only one of the following:
  "sheetId": string,
  "chartId": integer,
  "dataSourceTableAnchorCell": {
    object (GridCoordinate)
  },
  "dataSourcePivotTableAnchorCell": {
    object (GridCoordinate)
  },
  "dataSourceFormulaCell": {
    object (GridCoordinate)
  }
  // End of list of possible types for union field value.
}
欄位
聯集欄位 value。參考資料類型。value 只能是下列其中一個值：
sheetId

string

參照 DATA_SOURCE 工作表。
chartId

integer

資料來源圖表的參照。
dataSourceTableAnchorCell

object (GridCoordinate)

參照錨定在儲存格中的 DataSourceTable。
dataSourcePivotTableAnchorCell

object (GridCoordinate)

參照錨定在儲存格中的資料來源 PivotTable。
dataSourceFormulaCell

object (GridCoordinate)

參照包含 DataSourceFormula 的儲存格。