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 は次のいずれかになります。
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」は暗黙的に指定されるため、指定する必要はありません。1 つの "*" は、すべてのフィールドを一覧表示するための省略形として使用できます。

UpdateSheetPropertiesRequest

指定された sheetId を使用してシートのプロパティを更新します。

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

object (SheetProperties)

更新するプロパティ。
fields

string (FieldMask format)

更新が必要なフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート properties は暗黙的に指定されるため、指定する必要はありません。1 つの "*" は、すべてのフィールドを一覧表示するための省略形として使用できます。

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 は暗黙的に指定されるため、指定する必要はありません。1 つの "*" は、すべてのフィールドを一覧表示するための省略形として使用できます。
共用体フィールド dimension_range。ディメンションの範囲。dimension_range は次のいずれかになります。
range

object (DimensionRange)

更新する行または列。
dataSourceSheetRange

object (DataSourceSheetDimensionRange)

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

DataSourceSheetDimensionRange

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 は暗黙的に指定されるため、指定する必要はありません。1 つの "*" は、すべてのフィールドを一覧表示するための省略形として使用できます。

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 は暗黙的に指定されるため、指定する必要はありません。1 つの "*" は、すべてのフィールドを一覧表示するための省略形として使用できます。

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)

貼り付けるデータの種類。貼り付ける内容に関係なく、ソースデータはすべてカットされます。

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 範囲から 1 つの結合を作成する
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 は指定しないでください。1 つの "*" は、すべてのフィールドを一覧表示するための省略形として使用できます。
共用体フィールド area。位置情報データは書き込まれる必要があります。必ず 1 つの値を設定する必要があります。 area は次のいずれかになります。
start

object (GridCoordinate)

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

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 は指定しないでください。1 つの "*" は、すべてのフィールドを一覧表示するための省略形として使用できます。

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 と競合しない 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。正規表現と置換は、https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html の Java 正規表現ルールに従っている必要があります。置換文字列では、キャプチャ グループを参照できます。たとえば、1 つのセルに "Google Sheets" の内容があり、別のセルに "Google Docs" の内容がある場合、"o.* (.*)" を検索して "$1 Rocks" に置き換えると、セルの内容はそれぞれ "GSheets Rocks" と "GDocs Rocks" に変更されます。
includeFormulas

boolean

数式を含むセルを検索する場合は true にします。False にすると、数式を含むセルはスキップされます。

共用体フィールド scope。検索/置換の対象となるスコープ。1 つだけ設定する必要があります。scope は次のいずれかになります。
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

ソース データがグリッドから削除される前の座標に基づいて、ソース データを移動する場所のゼロベースの開始インデックス。移動したディメンションにスペースを確保するため、既存のデータは（ディメンションに応じて）下または右に移動します。ソース ディメンションはグリッドから削除されるため、データが指定されたインデックスとは異なるインデックスに格納される可能性があります。

たとえば、0, 1, 2, 3, 4 の A1..A5 があり、"1" と "2" を "3" と "4" の間に移動する場合、ソースは ROWS [1..3)、宛先インデックスは "4"（行 5 のゼロベースのインデックス）になります。最終的な結果は、0, 3, 1, 2, 4 の A1..A5 になります。

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 は暗黙的に指定されるため、指定する必要はありません。1 つの "*" は、すべてのフィールドを一覧表示するための省略形として使用できます。

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 は次のいずれかになります。
delimiter

string

データ内の区切り文字。
html

boolean

データが HTML の場合は true。

TextToColumnsRequest

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

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

object (GridRange)

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

delimiter

string

使用する区切り文字。delimiterType が 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 は暗黙的に指定されるため、指定する必要はありません。1 つの "*" は、すべてのフィールドを一覧表示するための省略形として使用できます。

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 は次のいずれかになります。
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)
  },
  "filteredRowsIncluded": boolean
}
フィールド
range

object (GridRange)

データの入力規則を適用する範囲。
rule

object (DataValidationRule)

範囲内の各セルに設定するデータ入力規則。範囲内のデータ入力規則を消去するには空白にします。

filteredRowsIncluded

boolean

省略可。true の場合、データの入力規則はフィルタされた行にも適用されます。

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 は暗黙的に指定されるため、指定する必要はありません。1 つの "*" は、すべてのフィールドを一覧表示するための省略形として使用できます。

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 は次のいずれかになります。
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 は暗黙的に指定されるため、指定する必要はありません。1 つの "*" は、すべてのフィールドを一覧表示するための省略形として使用できます。

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 パラメータで指定し、更新するメタデータと一致する DataFilter を少なくとも 1 つ指定する必要があります。

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

object (DataFilter)

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

developerMetadata

object (DeveloperMetadata)

データフィルタで一致するすべてのメタデータが更新される値。

fields

string (FieldMask format)

更新が必要なフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート developerMetadata は暗黙的に指定されるため、指定する必要はありません。1 つの "*" は、すべてのフィールドを一覧表示するための省略形として使用できます。

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 の深さより 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 は暗黙的に指定されるため、指定する必要はありません。1 つの "*" は、すべてのフィールドを一覧表示するための省略形として使用できます。

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 は暗黙的に指定されるため、指定する必要はありません。1 つの "*" は、すべてのフィールドを一覧表示するための省略形として使用できます。

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 データソースを追加する場合、リクエストには追加の bigquery.readonly OAuth スコープが必要です。

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

object (DataSource)

追加するデータソース。

UpdateDataSourceRequest

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

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

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

object (DataSource)

更新するデータソース。
fields

string (FieldMask format)

更新が必要なフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート dataSource は暗黙的に指定されるため、指定する必要はありません。1 つの "*" は、すべてのフィールドを一覧表示するための省略形として使用できます。

DeleteDataSourceRequest

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

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

string

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

RefreshDataSourceRequest

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

BigQuery データソースを更新する場合、リクエストには追加の bigquery.readonly 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 は次のいずれかになります。
references

object (DataSourceObjectReferences)

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

string

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

boolean

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

DataSourceObjectReferences

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

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

object (DataSourceObjectReference)

参照。

CancelDataSourceRefreshRequest

指定された参照によって、スプレッドシート内のデータソース オブジェクトの 1 つ以上の更新をキャンセルします。

BigQuery データソースの更新をキャンセルする場合、リクエストには追加の bigquery.readonly 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 は次のいずれかになります。
references

object (DataSourceObjectReferences)

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

string

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

boolean

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