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)
  }
  // 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 を更新します。

Update スプレッドシート プロパティ リクエスト

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

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 は次のいずれかになります。
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 は暗黙的に指定されます。指定しないでください。単一の "*" をすべてのフィールドの省略形として使用できます。

RepeatCellRequest

範囲内のすべてのセルを、指定されたセル オブジェクト内の値に更新します。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

「たとえ」の系列を使ってデータを生成する場合は「正」。これは、ソースデータの種類と量によって異なります。

共用体フィールド 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)

貼り付ける場所。範囲がコピー元の高さまたは幅の倍数のスパンをカバーしている場合、データは宛先の範囲を埋めるために繰り返されます。範囲がソース範囲より小さい場合、ソースデータ全体が(宛先範囲の末尾以外)コピーされます。

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 は次のいずれかになります。
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.」は指定しないでください。単一の "*" をすべてのフィールドの省略形として使用できます。

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 正規表現ルールに従う必要があります。置換文字列はキャプチャ グループを参照できます。たとえば、あるセルに "Google Sheets" があり、別のセルに "Google Docs" が含まれている場合、"$1 Rocks" に置き換えて "o.* (.*)" を検索すると、セルの内容がそれぞれ "GSheets Rocks""GDocs Rocks" に変更されます。

includeFormulas

boolean

検索に数式を含むセルを含める場合は True です。数式を含むセルをスキップする場合は false です。

共用体フィールド scope。検索または置換するスコープは、1 つだけ設定する必要があります。 scope は次のいずれかになります。
range

object (GridRange)

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

sheetId

integer

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

allSheets

boolean

すべてのシートを検索して置換します。

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, 4A1..A5 に対して、"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 は次のいずれかになります。
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 は次のいずれかになります。
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)

更新するフィールド。少なくとも 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 は次のいずれかになります。
dimensions

object (DimensionRange)

自動的にサイズ変更するディメンション。

dataSourceSheetDimensions

object (DataSourceSheetDimensionRange)

自動的にサイズ変更されるデータソース シートのディメンション。

AddChartRequest

スプレッドシートのシートにグラフを追加します。

JSON 表現
{
  "chart": {
    object (EmbeddedChart)
  }
}
フィールド
chart

object (EmbeddedChart)

スプレッドシートに追加するグラフ(配置場所を含む)。chartId フィールドは省略可能です。設定しない場合、ID がランダムに生成されます。(既存の埋め込みオブジェクトの ID を指定するとエラーになります)。

UpdateChartSpecRequest

グラフの仕様を更新します。{0}グラフの移動やサイズ変更は行われません。グラフの移動やサイズ変更を行うには、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 パラメータで更新するプロパティを指定するとともに、更新するメタデータに一致する DataFilter を少なくとも 1 つ指定する必要があります。

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, depth 1] + [C:D] の場合、グループは [B:E, depth 1] と [C:D, depth 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 は暗黙的に指定されます。指定しないでください。単一の "*" をすべてのフィールドの省略形として使用できます。

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 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)

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

DeleteDataSourceRequest

データソースを削除します。また、関連するデータソース シートを削除し、関連するすべてのデータソース オブジェクトのリンクを解除します。

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

string

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

RefreshDataSourceRequest

指定した参照に基づいてスプレッドシート内の 1 つ以上のデータソース オブジェクトを更新します。リクエストには、追加の 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)

参照

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 を含むセルへの参照。