Requests

リクエスト

スプレッドシートに適用する 1 種類の更新。

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)
  },
  "cancelDataSourceRefresh": {
    object (CancelDataSourceRefreshRequest)
  }
  // End of list of possible types for union field kind.
}
フィールド
共用体フィールド kind。更新の種類。フィールドが 1 つだけ必要です。 kind は次のいずれか 1 つのみを指定できます。
updateSpreadsheetProperties

object (UpdateSpreadsheetPropertiesRequest)

スプレッドシートのプロパティを更新します。

updateSheetProperties

object (UpdateSheetPropertiesRequest)

シートのプロパティを更新します。

updateDimensionProperties

object (UpdateDimensionPropertiesRequest)

ディメンションの更新プロパティです。

updateNamedRange

object (UpdateNamedRangeRequest)

名前付き範囲を更新します。

repeatCell

object (RepeatCellRequest)

範囲内の 1 つのセルを繰り返します。

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)

1 つ以上のセルのデータの入力規則を設定します。

setBasicFilter

object (SetBasicFilterRequest)

シートに基本フィルタを設定します。

addProtectedRange

object (AddProtectedRangeRequest)

保護されている範囲を追加します。

updateProtectedRange

object (UpdateProtectedRangeRequest)

保護されている範囲を更新します。

deleteProtectedRange

object (DeleteProtectedRangeRequest)

保護されている範囲を削除します。

autoResizeDimensions

object (AutoResizeDimensionsRequest)

そのディメンションのセルの内容に基づいて、1 つ以上のディメンションのサイズを自動的に変更します。

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)

1 つ以上のデータソースと関連する dbobject を更新します。

cancelDataSourceRefresh

object (CancelDataSourceRefreshRequest)

1 つまたは複数のデータソースと関連する dbobject の更新をキャンセルします。

UpdateSpreadsheetPropertiesRequest

スプレッドシートのプロパティを更新します。

JSON 表現 
{
  "properties": {
    object (SpreadsheetProperties)
  },
  "fields": string
}
フィールド
properties

object (SpreadsheetProperties)

更新するプロパティ。

fields

string (FieldMask format)

更新対象のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート「properties」は暗黙的に指定され、指定しないでください。単一の "*" すべてのフィールドをリストするための省略形として使用できます。

UpdateSheetPropertiesRequest

指定した情報でシートのプロパティを更新します。 sheetId。

JSON 表現 
{
  "properties": {
    object (SheetProperties)
  },
  "fields": string
}
フィールド
properties

object (SheetProperties)

更新するプロパティ。

fields

string (FieldMask format)

更新対象のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート properties 暗黙的に指定され、指定しないでください。単一の "*" すべてのフィールドをリストするための省略形として使用できます。

UpdateDimensionPropertiesRequest

指定した範囲内のディメンションのプロパティを更新します。

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)

更新対象のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート properties 暗黙的に指定され、指定しないでください。単一の "*" すべてのフィールドをリストするための省略形として使用できます。

共用体フィールド dimension_range。ディメンションの範囲。 dimension_range は次のいずれか 1 つのみを指定できます。
range

object (DimensionRange)

更新する行または列。

dataSourceSheetRange

object (DataSourceSheetDimensionRange)

更新するデータソース シートの列。

DataSourceSheetDimensionRange

1 つの次元に沿った範囲は、 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)

更新対象のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート namedRange 暗黙的に指定され、指定しないでください。単一の "*" すべてのフィールドをリストするための省略形として使用できます。

RepeatCellRequest

範囲内のすべてのセルを、指定された Cell オブジェクトの値に更新します。表示されるのは fields フィールドが更新されます。その他は変更されません。

数式を含むセルを書き込むと、その数式の範囲は範囲内のフィールドごとに自動的に増加します。たとえば、数式を含むセルを書き込む場合、 =A1 範囲 B2:C4 に入れる場合、B2 は =A1、B3 は次のようになります。 =A2 の場合、B4 は =A3の場合、C2 は =B1の場合、C3 は次のようになります。 =B2 の場合、C4 は =B3。

数式の範囲を静的にするには、 $ 表示されます。たとえば、次の数式を使用します。 =$A$1 行と列の両方がインクリメントされないようにします。

JSON 表現 
{
  "range": {
    object (GridRange)
  },
  "cell": {
    object (CellData)
  },
  "fields": string
}
フィールド
range

object (GridRange)

そのセルを繰り返す範囲。

cell

object (CellData)

書き込むデータ。

fields

string (FieldMask format)

更新対象のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート 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 は次のいずれか 1 つのみを指定できます。
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)

貼り付けるデータの種類。貼り付けるデータに関係なく、すべてのソースデータが切り取られます。

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)

貼り付け先の場所。範囲のカバー範囲がソースの高さまたは幅の倍数の場合は、データが繰り返されて宛先の範囲全体が表示されます。範囲がコピー元の範囲よりも小さい場合でも、コピー元データ全体が（コピー先範囲の末尾を超えて）コピーされます。

pasteType

enum (PasteType)

貼り付けるデータの種類。

pasteOrientation

enum (PasteOrientation)

貼り付ける際のデータの向き。

PasteOrientation

貼り付け操作の実行方法。

列挙型
NORMAL 通常どおりに貼り付けます。
TRANSPOSE すべての行が列になる、またはその逆になる、転置して貼り付けます。

MergeCellsRequest

範囲内のすべてのセルを結合します。

JSON 表現 
{
  "range": {
    object (GridRange)
  },
  "mergeType": enum (MergeType)
}
フィールド
range

object (GridRange)

結合するセルの範囲です。

mergeType

enum (MergeType)

セルを結合する方法。

MergeType

作成するマージのタイプ。

列挙型
MERGE_ALL 範囲から単一の結合を作成する
MERGE_COLUMNS 範囲内の各列のマージを作成する
MERGE_ROWS 範囲内の各行のマージを作成する

UnmergeCellsRequest

指定した範囲のセルの結合を解除します。

JSON 表現 
{
  "range": {
    object (GridRange)
  }
}
フィールド
range

object (GridRange)

すべてのセルの結合を解除する範囲です。範囲が複数の結合にまたがる場合、すべての結合が解除されます。範囲が結合の一部にまたがってはいけません。

UpdateBordersRequest

範囲の枠線を更新します。リクエストでフィールドが設定されていない場合、枠線はそのまま残ります。たとえば、次の 2 つの 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 のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルートは CellData です。'row.values.'指定しないでください。単一の "*" すべてのフィールドをリストするための省略形として使用できます。

共用体フィールド area。位置情報を書き込む必要があります。値を 1 つだけ設定する必要があります。 area は次のいずれか 1 つのみを指定できます。
start

object (GridCoordinate)

データの書き込みを開始する座標。任意の数の行と列（1 行ごとに異なる列数を含む）を書き込むことができます。

range

object (GridRange)

データを書き込む範囲。

行内のデータがリクエストされた範囲全体をカバーしていない場合、 fields は消去されます。

AddFilterViewRequest

フィルタ表示を追加します。

JSON 表現 
{
  "filter": {
    object (FilterView)
  }
}
フィールド
filter

object (FilterView)

追加するフィルタ。「 filterViewId フィールドは省略可能です。設定されていない場合、ID はランダムに生成されます。（既存のフィルタの ID を指定するとエラーになります）。

AppendCellsRequest

シート内のデータを含む最後の行の後に新しいセルを追加し、必要に応じてシートに新しい行を挿入します。

JSON 表現 
{
  "sheetId": integer,
  "rows": [
    {
      object (RowData)
    }
  ],
  "fields": string
}
フィールド
sheetId

integer

データを追加するシート ID。

rows[]

object (RowData)

追加するデータ。

fields

string (FieldMask format)

更新する CellData のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルートは CellData です。'row.values.'指定しないでください。単一の "*" すべてのフィールドをリストするための省略形として使用できます。

ClearBasicFilterRequest

シートに基本フィルタがある場合はクリアします。

JSON 表現 
{
  "sheetId": integer
}
フィールド
sheetId

integer

基本フィルタをクリアするシート ID。

DeleteDimensionRequest

シートから寸法を削除します。

JSON 表現 
{
  "range": {
    object (DimensionRange)
  }
}
フィールド
range

object (DimensionRange)

シートから削除するディメンション。

DeleteEmbeddedObjectRequest

指定された 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 と競合しないようにする必要があります。設定する場合は負でない値にしてください。

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.置換文字列はキャプチャ グループを参照できます。たとえば、1 つのセルの内容が "Google Sheets" もう 1 つは "Google Docs"してから、次を検索 "o.* (.*)" 新しい ReplicaSet の "$1 Rocks" すると、セルの内容が "GSheets Rocks" および "GDocs Rocks" できます。

includeFormulas

boolean

検索に数式を含むセルを含める場合は true。数式が含まれているセルをスキップする場合は False です。

共用体フィールド scope。検索/置換の対象であるスコープ。1 つのみ設定する必要があります。 scope は次のいずれか 1 つのみを指定できます。
range

object (GridRange)

検索または置換する範囲。

sheetId

integer

検索または置換するシート。

allSheets

boolean

すべてのシートを検索して置換する場合は True。

InsertDimensionRequest

シートの特定のインデックスで行または列を挿入します。

JSON 表現 
{
  "range": {
    object (DimensionRange)
  },
  "inheritFromBefore": boolean
}
フィールド
range

object (DimensionRange)

挿入するディメンション。開始インデックスと終了インデックスはどちらも制限されている必要があります。

inheritFromBefore

boolean

新しく挿入されたディメンションの前後のディメンションからディメンション プロパティを拡張するかどうか。以前のディメンションから継承する場合は true（この場合、開始インデックスは 0 より大きい必要があります）を、false に設定するとそれ以降のディメンションから継承します。

たとえば、行インデックス 0 の背景が赤で、行インデックス 1 の背景が緑の場合、インデックス 1 に 2 つの行を挿入すると、緑または赤の背景を継承できます。条件 inheritFromBefore が true の場合、2 つの新しい行は赤になります（挿入ポイントの前の行が赤であるため）。 inheritFromBefore false の場合、2 つの新しい行は緑色になります（挿入ポイントの後の行が緑色であるため）。

InsertRangeRequest

既存のセルを上下に移動して、範囲にセルを挿入します。

JSON 表現 
{
  "range": {
    object (GridRange)
  },
  "shiftDimension": enum (Dimension)
}
フィールド
range

object (GridRange)

新しいセルを挿入する範囲。

shiftDimension

enum (Dimension)

セルの挿入時に移動する寸法。条件 ROWS の既存のセルを下に移動します。条件 COLUMNS の既存のセルを右に移動します。

MoveDimensionRequest

1 つ以上の行または列を移動します。

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 行目のゼロベースのインデックス）。最終的な結果は次のようになります。 A1..A5 / 0, 3, 1, 2, 4。

UpdateEmbeddedObjectPositionRequest

埋め込みオブジェクトの位置を更新する（グラフや画像の移動やサイズ変更など）。

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 が設定されている場合、少なくとも 1 つのフィールドを指定する必要があります。ルート newPosition.overlayPosition 暗黙的に指定され、指定しないでください。単一の "*" すべてのフィールドをリストするための省略形として使用できます。

PasteDataRequest

指定した座標からスプレッドシートにデータを挿入します。

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。データの解釈方法。値は 1 つだけ設定する必要があります。 kind は次のいずれか 1 つのみを指定できます。
delimiter

string

データ内の区切り文字。

html

boolean

データが HTML の場合は true。

TextToColumnsRequest

各セルの区切り文字に基づいて、テキストの列を複数の列に分割します。

JSON 表現 
{
  "source": {
    object (GridRange)
  },
  "delimiter": string,
  "delimiterType": enum (DelimiterType)
}
フィールド
source

object (GridRange)

ソースデータの範囲。列は 1 つだけにする必要があります。

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)

更新対象のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート filter 暗黙的に指定され、指定しないでください。単一の "*" すべてのフィールドをリストするための省略形として使用できます。

DeleteRangeRequest

特定のセル範囲を削除し、他のセルを削除した範囲に移動します。

JSON 表現 
{
  "range": {
    object (GridRange)
  },
  "shiftDimension": enum (Dimension)
}
フィールド
range

object (GridRange)

削除するセルの範囲。

shiftDimension

enum (Dimension)

削除されたセルを置き換えるディメンション。条件 ROWS - 既存のセルが上に移動され、削除されたセルが置き換えられます。条件 COLUMNS - 既存のセルが左に移動され、削除されたセルが置き換えられます。

AppendDimensionRequest

シートの末尾に行または列を追加します。

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 は次のいずれか 1 つのみを指定できます。
rule

object (ConditionalFormatRule)

指定されたインデックスにあるルールを置き換えるルール。

newIndex

integer

ルールを適用する際の 0 ベースの新しいインデックス。

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)

更新対象のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート protectedRange 暗黙的に指定され、指定しないでください。単一の "*" すべてのフィールドをリストするための省略形として使用できます。

DeleteProtectedRangeRequest

指定された ID の保護されている範囲を削除します。

JSON 表現 
{
  "protectedRangeId": integer
}
フィールド
protectedRangeId

integer

削除する保護されている範囲の ID。

AutoResizeDimensionsRequest

そのディメンションのセルの内容に基づいて、1 つ以上のディメンションのサイズを自動的に変更します。

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 は次のいずれか 1 つのみを指定できます。
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)

更新対象のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート bandedRange 暗黙的に指定され、指定しないでください。単一の "*" すべてのフィールドをリストするための省略形として使用できます。

AddBandingRequest

スプレッドシートに新しい帯域範囲を追加します。

JSON 表現 
{
  "bandedRange": {
    object (BandedRange)
  }
}
フィールド
bandedRange

object (BandedRange)

追加するバンド範囲。「 bandedRangeId フィールドは省略可能です。設定されていない場合、ID はランダムに生成されます。（すでに存在する範囲の ID を指定するとエラーになります）。

DeleteBandingRequest

指定された ID のバンド範囲をスプレッドシートから削除します。

JSON 表現 
{
  "bandedRangeId": integer
}
フィールド
bandedRangeId

integer

削除するバンド付き範囲の ID。

CreateDeveloperMetadataRequest

デベロッパー メタデータを作成するためのリクエスト。

JSON 表現 
{
  "developerMetadata": {
    object (DeveloperMetadata)
  }
}
フィールド
developerMetadata

object (DeveloperMetadata)

作成するデベロッパー メタデータ。

UpdateDeveloperMetadataRequest

デベロッパー メタデータのプロパティを更新するリクエスト。フィルタによって選択されたデベロッパー メタデータのプロパティを、 DeveloperMetadata リソースです。呼び出し元は、更新したいプロパティを fields パラメータで指定し、少なくとも 1 つを指定する必要があります。 DataFilter メタデータに一致する必要があります。

JSON 表現 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "developerMetadata": {
    object (DeveloperMetadata)
  },
  "fields": string
}
フィールド
dataFilters[]

object (DataFilter)

更新するデベロッパー メタデータ エントリに一致するフィルタ。

developerMetadata

object (DeveloperMetadata)

データフィルタに一致するすべてのメタデータを更新する値。

fields

string (FieldMask format)

更新対象のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート developerMetadata 暗黙的に指定され、指定しないでください。単一の "*" すべてのフィールドをリストするための省略形として使用できます。

DeleteDeveloperMetadataRequest

デベロッパー メタデータを削除するリクエスト。

JSON 表現 
{
  "dataFilter": {
    object (DataFilter)
  }
}
フィールド
dataFilter

object (DataFilter)

削除するデベロッパー メタデータ エントリを選択するために使用する条件を記述するデータフィルタ。

RandomizeRangeRequest

範囲内の行の順序をランダム化します。

JSON 表現 
{
  "range": {
    object (GridRange)
  }
}
フィールド
range

object (GridRange)

ランダム化する範囲です。

AddDimensionGroupRequest

指定した範囲でグループを作成します。

リクエストされた範囲が既存のグループ G の範囲のスーパーセットである場合、G の深さが増分され、この新しいグループ G'その深さがあります。たとえば、グループ [C:D、深さ 1] + [B:E] は、グループ [B:E、深さ 1] と [C:D、深さ 2] になります。要求された範囲が既存のグループ G の範囲のサブセットである場合、新しいグループ G' の深さはG の深さより 1 大きくなります。たとえば、グループ [B:E、深さ 1] + [C:D] は、グループ [B:E、深さ 1] と [C:D、深さ 2] になります。リクエストされた範囲が既存のグループ G の範囲内で開始して終了する場合、または既存のグループ G の範囲内で終了する場合は、既存のグループ G の範囲がこれらの範囲を結合し、新しいグループ G'深度は G の深さより 1 大きく、範囲はそれらの範囲の交点となります。たとえば、グループ [B:D、深さ 1] + [C:E] は、グループ [B:E、深さ 1] と [C:D、深さ 2] になります。

JSON 表現 
{
  "range": {
    object (DimensionRange)
  }
}
フィールド
range

object (DimensionRange)

グループを作成する範囲。

DeleteDimensionGroupRequest

範囲内のディメンションの深さを減らして、指定した範囲のグループを削除します。

たとえば、シートに B:E 上の深度 1 のグループと、C:D 上の深度 2 のグループがあるとします。D:E でグループを削除すると、シートには B:D の上に深さ 1 のグループ、C:C の上に深さ 2 のグループが作成されます。

JSON 表現 
{
  "range": {
    object (DimensionRange)
  }
}
フィールド
range

object (DimensionRange)

削除するグループの範囲。

UpdateDimensionGroupRequest

指定したグループの状態を更新します。

JSON 表現 
{
  "dimensionGroup": {
    object (DimensionGroup)
  },
  "fields": string
}
フィールド
dimensionGroup

object (DimensionGroup)

状態を更新するグループ。グループの範囲と深さには有効なグループを指定し、その他すべてのフィールドも更新します。

fields

string (FieldMask format)

更新対象のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート dimensionGroup 暗黙的に指定され、指定しないでください。単一の "*" すべてのフィールドをリストするための省略形として使用できます。

TrimWhitespaceRequest

指定した範囲のすべてのセルの空白（スペース、タブ、改行など）を削除します。この要求により、各セルのテキストの先頭と末尾にあるすべての空白文字が削除され、残りの空白文字が 1 つのスペースに短縮されます。カットされたテキストが「+」で始まる場合、または「=」を含む場合、テキストは文字列値として維持され、数式として解釈されません。

JSON 表現 
{
  "range": {
    object (GridRange)
  }
}
フィールド
range

object (GridRange)

トリミングするセルの範囲。

DeleteDuplicatesRequest

この範囲内で、指定された列の値が前の行の値と重複している行を削除します。値が同一で、大文字と小文字、書式、数式が異なる行は、重複とみなされます。

また、フィルタなどが原因でビューから非表示になっている重複する行も削除されます。重複を削除する場合、重複した各行の最初のインスタンスが上から下へスキャンされて結果の範囲に保持されます。指定した範囲外のコンテンツは削除されません。また、重複と見なされる行は、範囲内で互いに隣接する必要はありません。

JSON 表現 
{
  "range": {
    object (GridRange)
  },
  "comparisonColumns": [
    {
      object (DimensionRange)
    }
  ]
}
フィールド
range

object (GridRange)

重複する行を削除する範囲。

comparisonColumns[]

object (DimensionRange)

重複値を分析する範囲内の列。列が選択されていない場合は、すべての列が重複していないか分析されます。

UpdateEmbeddedObjectBorderRequest

埋め込みオブジェクトの枠線プロパティを更新します。

JSON 表現 
{
  "objectId": integer,
  "border": {
    object (EmbeddedObjectBorder)
  },
  "fields": string
}
フィールド
objectId

integer

更新する埋め込みオブジェクトの ID。

border

object (EmbeddedObjectBorder)

埋め込みオブジェクトに適用する枠線。

fields

string (FieldMask format)

更新対象のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート 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)

更新対象のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート SlicerSpec 暗黙的に指定され、指定しないでください。すべてのフィールドをリストする場合、1 つの「*」を使用して省略できます。

AddDataSourceRequest

データソースを追加します。データソースが正常に追加されると、 DATA_SOURCE シートが作成され、データソースからデータを読み取るためにシートが更新される実行がトリガーされます。

このリクエストには、 bigquery.readonly BigQuery データソースを追加する場合の OAuth スコープ。

JSON 表現 
{
  "dataSource": {
    object (DataSource)
  }
}
フィールド
dataSource

object (DataSource)

追加するデータソース。

UpdateDataSourceRequest

データソースを更新します。データソースが正常に更新されると、関連する更新を行うために実行がトリガーされます。 DATA_SOURCE 更新済みのデータソースからデータを読み取ることができます。

このリクエストには、 bigquery.readonly BigQuery データソースを更新する場合の OAuth スコープ。

JSON 表現 
{
  "dataSource": {
    object (DataSource)
  },
  "fields": string
}
フィールド
dataSource

object (DataSource)

更新するデータソース。

fields

string (FieldMask format)

更新対象のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート dataSource 暗黙的に指定され、指定しないでください。単一の "*" すべてのフィールドをリストするための省略形として使用できます。

DeleteDataSourceRequest

データソースを削除します。このリクエストにより、関連付けられているデータソース シートが削除され、関連付けられているすべてのデータソース オブジェクトのリンクが解除されます。

JSON 表現 
{
  "dataSourceId": string
}
フィールド
dataSourceId

string

削除するデータソースの ID。

RefreshDataSourceRequest

指定した参照で、スプレッドシート内の 1 つまたは複数のデータソース オブジェクトを更新します。

このリクエストには、 bigquery.readonly BigQuery データソースを更新する場合の OAuth スコープ。

複数の更新リクエストが 1 つのバッチで同じデータソース オブジェクトを参照する場合は、最後の更新リクエストのみが処理され、すべてのリクエストのレスポンスはそれに応じて同じになります。

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 は次のいずれか 1 つのみを指定できます。
references

object (DataSourceObjectReferences)

更新するデータソース オブジェクトへの参照。

dataSourceId

string

参照: DataSource。指定すると、データソースに関連付けられているすべてのデータソース オブジェクトが更新されます。

isAll

boolean

スプレッドシート内の既存のデータソース オブジェクトをすべて更新します。

DataSourceObjectReferences

データソース オブジェクトへの参照のリスト。

JSON 表現 
{
  "references": [
    {
      object (DataSourceObjectReference)
    }
  ]
}
フィールド
references[]

object (DataSourceObjectReference)

参照。

CancelDataSourceRefreshRequest

指定した参照によるスプレッドシート内のデータソース オブジェクトの更新をキャンセルします。

このリクエストには、 bigquery.readonly BigQuery データソースで更新をキャンセルする場合の OAuth スコープ。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド target。キャンセルする内容を指定します。 target は次のいずれか 1 つのみを指定できます。
references

object (DataSourceObjectReferences)

更新をキャンセルするデータソース オブジェクトへの参照。

dataSourceId

string

参照: DataSource。指定すると、このデータソースに関連付けられているすべてのデータソース オブジェクトの更新がキャンセルされます。

isAll

boolean

スプレッドシート内のすべてのデータソースについて、既存のデータソース オブジェクトの更新をすべてキャンセルします。