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 シート上の 1 つのディメンションの範囲。

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)

データの書き込みを開始する座標。任意の数の行と列(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.」は指定しないでください。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

ソースデータがグリッドから削除されるの座標に基づく、ソースデータの移動先を示すゼロベースの開始インデックス。既存のデータが(ディメンションに応じて)上下にシフトされ、移動したディメンション用のスペースが確保されます。ソース ディメンションがグリッドから削除されるため、指定されたインデックスとは異なるインデックスにデータが含まれる可能性があります。

たとえば、A1..A50, 1, 2, 3, 4 で、"1""2""3""4" の間に移動する場合、ソースは ROWS [1..3)、宛先インデックスは "4"(5 行目のゼロベースのインデックス)になります。最終結果は 0, 3, 1, 2, 4A1..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

使用する区切り文字。区切り文字の種類が 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)
  }
}
フィールド
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 は暗黙的に指定されるため、指定しないでください。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 の depth-1 グループと C:D の depth-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.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 は暗黙的に指定されるため、指定しないでください。1 つの "*" で、すべてのフィールドをリストする際の省略形として使用できます。

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

CancelDataSourceRefreshRequest

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

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

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