リクエスト
スプレッドシートに適用する 1 種類の更新。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド kind 。アップデートの種類。フィールドは 1 つだけ指定する必要があります。kind は次のいずれかになります。 |
|
updateSpreadsheetProperties
|
スプレッドシートのプロパティを更新します。 |
updateSheetProperties
|
シートのプロパティを更新します。 |
updateDimensionProperties
|
ディメンションのプロパティを更新します。 |
updateNamedRange
|
名前付き範囲を更新します。 |
repeatCell
|
範囲内の 1 つのセルを繰り返します。 |
addNamedRange
|
名前付き範囲を追加します。 |
deleteNamedRange
|
名前付き範囲を削除します。 |
addSheet
|
シートを追加します。 |
deleteSheet
|
シートを削除します。 |
autoFill
|
既存のデータに基づいて、自動的にデータが入力されます。 |
cutPaste
|
ある領域からデータを切り取って別の領域に貼り付けます。 |
copyPaste
|
ある領域からデータをコピーして、別の領域に貼り付けます。 |
mergeCells
|
セルを結合します。 |
unmergeCells
|
結合したセルの結合を解除します。 |
updateBorders
|
セル範囲の境界を更新します。 |
updateCells
|
多数のセルを一度に更新します。 |
addFilterView
|
フィルタ表示を追加します。 |
appendCells
|
最後の行に、シート内のデータを含むセルを追加します。 |
clearBasicFilter
|
シートの基本フィルタをクリアします。 |
deleteDimension
|
シート内の行または列を削除します。 |
deleteEmbeddedObject
|
シート内の埋め込みオブジェクト(グラフ、画像など)を削除します。 |
deleteFilterView
|
シートからフィルタ表示を削除します。 |
duplicateFilterView
|
フィルタ表示を複製します。 |
duplicateSheet
|
シートを複製します。 |
findReplace
|
一部のテキストのオカレンスを検索して他のテキストに置き換えます。 |
insertDimension
|
シートに新しい行または列を挿入します。 |
insertRange
|
シートに新しいセルを挿入して、既存のセルを移動します。 |
moveDimension
|
行または列をシート内の別の場所に移動します。 |
updateEmbeddedObjectPosition
|
埋め込みオブジェクト(グラフ、画像など)の位置を更新します。 |
pasteData
|
データ(HTML または区切り文字)をシートに貼り付けます。 |
textToColumns
|
テキストの列を複数のテキスト列に変換します。 |
updateFilterView
|
フィルタビューのプロパティを更新します。 |
deleteRange
|
シートからセルの範囲を削除し、残りのセルを移動します。 |
appendDimension
|
シートの末尾にディメンションを追加します。 |
addConditionalFormatRule
|
新しい条件付き書式ルールを追加します。 |
updateConditionalFormatRule
|
既存の条件付き書式ルールを更新します。 |
deleteConditionalFormatRule
|
既存の条件付き書式ルールを削除します。 |
sortRange
|
範囲内のデータを並べ替えます。 |
setDataValidation
|
1 つ以上のセルのデータ検証を設定します。 |
setBasicFilter
|
シートの基本フィルタを設定します。 |
addProtectedRange
|
保護されている範囲を追加します。 |
updateProtectedRange
|
保護されている範囲を更新します。 |
deleteProtectedRange
|
保護されている範囲を削除します。 |
autoResizeDimensions
|
1 つ以上のディメンションは、そのディメンションに含まれるセルの内容に基づいて自動的にサイズ変更されます。 |
addChart
|
グラフを追加します。 |
updateChartSpec
|
グラフの仕様を更新します。 |
updateBanding
|
帯域を更新する |
addBanding
|
新しい帯域を追加 |
deleteBanding
|
縞模様の範囲を削除する |
createDeveloperMetadata
|
新しいデベロッパー メタデータを作成する |
updateDeveloperMetadata
|
既存のデベロッパー メタデータ エントリを更新する |
deleteDeveloperMetadata
|
デベロッパー メタデータを削除します。 |
randomizeRange
|
範囲内の行の順序をランダム化します。 |
addDimensionGroup
|
指定された範囲にグループを作成します。 |
deleteDimensionGroup
|
指定された範囲のグループを削除します。 |
updateDimensionGroup
|
指定されたグループの状態を更新します。 |
trimWhitespace
|
空白のセル(スペース、タブ、改行など)を削除します。 |
deleteDuplicates
|
セル範囲の指定された列に重複値を含む行を削除します。 |
updateEmbeddedObjectBorder
|
埋め込みオブジェクトの枠線を更新します。 |
addSlicer
|
スライサーを追加します。 |
updateSlicerSpec
|
スライサーの仕様を更新します。 |
addDataSource
|
データソースを追加します。 |
updateDataSource
|
データソースを更新します。 |
deleteDataSource
|
データソースを削除します。 |
refreshDataSource
|
1 つ以上のデータソースと関連 dbobject を更新します。 |
Update スプレッドシート プロパティ リクエスト
スプレッドシートのプロパティを更新します。
JSON 表現 |
---|
{
"properties": {
object (
|
フィールド | |
---|---|
properties
|
更新するプロパティ。 |
fields
|
更新するフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート「properties」は暗黙的に指定されます。指定しないでください。単一の |
UpdateSheetPropertiesRequest
指定された sheetId
でシートのプロパティを更新します。
JSON 表現 |
---|
{
"properties": {
object (
|
フィールド | |
---|---|
properties
|
更新するプロパティ。 |
fields
|
更新するフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート |
UpdateDimensionPropertiesRequest
指定範囲内のディメンションのプロパティを更新します。
JSON 表現 |
---|
{ "properties": { object ( |
フィールド | |
---|---|
properties
|
更新するプロパティ。 |
fields
|
更新するフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート |
共用体フィールド dimension_range 。ディメンションの範囲。dimension_range は次のいずれかになります。 |
|
range
|
更新する行または列。 |
dataSourceSheetRange
|
更新するデータソース シートの列。 |
DataSourceSheetDimensionRange
DATA_SOURCE
シート上の単一ディメンションに沿った範囲。
JSON 表現 |
---|
{
"sheetId": integer,
"columnReferences": [
{
object (
|
フィールド | |
---|---|
sheetId
|
範囲が存在するデータソース シートの ID。 |
columnReferences[]
|
データソース シートの列。 |
UpdateNamedRangeRequest
指定された namedRangeId
を使用して、指定された範囲のプロパティを更新します。
JSON 表現 |
---|
{
"namedRange": {
object (
|
フィールド | |
---|---|
namedRange
|
新しいプロパティで更新する名前付き範囲。 |
fields
|
更新するフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート |
RepeatCellRequest
範囲内のすべてのセルを、指定されたセル オブジェクト内の値に更新します。fields
フィールドにあるフィールドのみが更新されます。その他のフィールドは変更されません。
数式を含むセルを記述した場合、範囲内のフィールドごとに数式の範囲が自動的に増えます。たとえば、数式 =A1
を含むセルを範囲 B2:C4、B2 には =A1
、B3 には =A2
、B4 には =A3
、C2 には =B1
、C3 には =B2
、C4 には =B3
を記述できます。
数式の範囲を静的にするには、$
インジケーターを使用します。たとえば、行と列の両方が増加しないようにするには、=$A$1
という式を使用します。
JSON 表現 |
---|
{ "range": { object ( |
フィールド | |
---|---|
range
|
セルを繰り返す範囲です。 |
cell
|
書き込むデータ。 |
fields
|
更新するフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート |
AddNamedRangeRequest
スプレッドシートに名前付き範囲を追加します。
JSON 表現 |
---|
{
"namedRange": {
object (
|
フィールド | |
---|---|
namedRange
|
追加する名前付き範囲。 |
DeleteNamedRangeRequest
指定された ID を持つ名前付き範囲をスプレッドシートから削除します。
JSON 表現 |
---|
{ "namedRangeId": string } |
フィールド | |
---|---|
namedRangeId
|
削除する名前付き範囲の ID。 |
AddSheetRequest
新しいシートを追加します。指定したインデックスでシートが追加されると、後続のシートのすべてのインデックスが増加します。オブジェクト シートを追加するには、代わりに AddChartRequest
を使用して EmbeddedObjectPosition.sheetId
または EmbeddedObjectPosition.newSheet
を指定します。
JSON 表現 |
---|
{
"properties": {
object (
|
フィールド | |
---|---|
properties
|
新しいシートのプロパティ。すべてのプロパティは省略可能です。 |
DeleteSheetRequest
リクエストされたシートを削除します。
JSON 表現 |
---|
{ "sheetId": integer } |
フィールド | |
---|---|
sheetId
|
削除するシートの ID。
シートが |
AutoFillRequest
既存のデータに基づいて、その他の情報を入力します。
JSON 表現 |
---|
{ "useAlternateSeries": boolean, // Union field |
フィールド | |
---|---|
useAlternateSeries
|
「たとえ」の系列を使ってデータを生成する場合は「正」。これは、ソースデータの種類と量によって異なります。 |
共用体フィールド area 。自動入力する領域です。
area は次のいずれかになります。 |
|
range
|
自動入力する範囲を指定します。これにより、範囲が調査され、データを含む場所が検出され、残りの範囲にそのデータが自動的に入力されます。 |
sourceAndDestination
|
自動入力元のソースとリンク先の領域。これにより、自動入力のソースと、そのデータの拡張先が明示的にリストされます。 |
SourceAndDestination
ソース範囲とソースの拡張方法の組み合わせ。
JSON 表現 |
---|
{ "source": { object ( |
フィールド | |
---|---|
source
|
自動入力のソースとして使用するデータの場所。 |
dimension
|
データが表示されるディメンションです。 |
fillLength
|
データの入力が必要な行または列の数。正の数値は、ソースの最後の行または最後の列を超えて拡張されます。負の数値は、ソースの最初の行または最初の列の前に展開されます。 |
CutPasteRequest
移行元から移行先にデータを移動します。
JSON 表現 |
---|
{ "source": { object ( |
フィールド | |
---|---|
source
|
切り取るソースデータ。 |
destination
|
データを貼り付ける左上の座標。 |
pasteType
|
貼り付けるデータの種類。貼り付けるかどうかにかかわらず、すべてのソースデータがカットされます。 |
貼り付けタイプ
貼り付けるデータの種類。
列挙型 | |
---|---|
PASTE_NORMAL
|
値、数式、形式、結合を貼り付けます。 |
PASTE_VALUES
|
値は、書式、数式、または結合なしで貼り付けてください。 |
PASTE_FORMAT
|
形式とデータ検証のみを貼り付けます。 |
PASTE_NO_BORDERS
|
PASTE_NORMAL に似ていますが、枠線はありません。
|
PASTE_FORMULA
|
数式のみ貼り付けてください。 |
PASTE_DATA_VALIDATION
|
データ検証のみを貼り付けます。 |
PASTE_CONDITIONAL_FORMATTING
|
条件付き書式ルールのみを貼り付けます。 |
CopyPasteRequest
送信元から宛先にデータをコピーします。
JSON 表現 |
---|
{ "source": { object ( |
フィールド | |
---|---|
source
|
コピーするソース範囲。 |
destination
|
貼り付ける場所。範囲がコピー元の高さまたは幅の倍数のスパンをカバーしている場合、データは宛先の範囲を埋めるために繰り返されます。範囲がソース範囲より小さい場合、ソースデータ全体が(宛先範囲の末尾以外)コピーされます。 |
pasteType
|
貼り付けるデータの種類。 |
pasteOrientation
|
貼り付け時のデータの向き。 |
PasteOrientation
貼り付け処理の実行方法。
列挙型 | |
---|---|
NORMAL
|
通常どおり貼り付けます。 |
TRANSPOSE
|
すべての行が列になるように転置するペースト(その逆)。 |
MergeCellsRequest
範囲内のすべてのセルを結合します。
JSON 表現 |
---|
{ "range": { object ( |
フィールド | |
---|---|
range
|
結合するセルの範囲を指定します。 |
mergeType
|
セルのマージ方法。 |
MergeType
作成するマージのタイプ。
列挙型 | |
---|---|
MERGE_ALL
|
範囲内の単一のマージを作成します |
MERGE_COLUMNS
|
範囲内の各列のマージを作成する |
MERGE_ROWS
|
範囲内の各行に対してマージを作成します。 |
UnmergeCellsRequest
指定された範囲内のセルの結合を解除します。
JSON 表現 |
---|
{
"range": {
object (
|
フィールド | |
---|---|
range
|
すべてのセルの結合を解除する範囲。範囲が複数の結合にまたがっている場合、すべてが結合されます。範囲は、部分的に結合することはできません。 |
UpdateBordersRequest
範囲の境界を更新します。リクエストでフィールドが設定されていない場合、境界は現状のままになります。たとえば、次の 2 つの UpdateBordersRequest では、次のようになります。
-
範囲: A1:A5
{ top: RED, bottom: WHITE }
-
範囲: A1:A5
{ left: BLUE }
枠線 A1:A5 は { top: RED, bottom: WHITE, left: BLUE }
になります。枠線を消去する場合は、スタイルを明示的に NONE
に設定します。
JSON 表現 |
---|
{ "range": { object ( |
フィールド | |
---|---|
range
|
枠線を更新する範囲。 |
top
|
範囲の一番上に配置する枠線。 |
bottom
|
範囲の下部に配置する枠線。 |
left
|
範囲の左側に配置する枠線。 |
right
|
範囲の右側に配置する枠線。 |
innerHorizontal
|
範囲内に置く水平の枠線。 |
innerVertical
|
範囲内に置く垂直の枠線。 |
UpdateCellsRequest
範囲内のすべてのセルを新しいデータで更新します。
JSON 表現 |
---|
{ "rows": [ { object ( |
フィールド | |
---|---|
rows[]
|
書き込むデータ。 |
fields
|
更新する CellData のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルートは CellData です。「row.values.」は指定しないでください。単一の |
共用体フィールド area 。位置情報を書き込みます。値は 1 つのみ設定する必要があります。area は次のいずれかになります。 |
|
start
|
データの書き込みを開始する座標。任意の数の行と列(行ごとに異なる列数)を書き込むことができます。 |
range
|
データを書き込む範囲。
行内のデータがリクエストされた範囲全体をカバーしていない場合、 |
AddFilterViewRequest
フィルタ表示を追加します。
JSON 表現 |
---|
{
"filter": {
object (
|
フィールド | |
---|---|
filter
|
追加するフィルタ。 |
AppendCellsRequest
シート内のデータの最終行の後に新しいセルを追加し、必要に応じてシートに新しい行を挿入します。
JSON 表現 |
---|
{
"sheetId": integer,
"rows": [
{
object (
|
フィールド | |
---|---|
sheetId
|
データを追加するシート ID。 |
rows[]
|
追加するデータ。 |
fields
|
更新する CellData のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルートは CellData です。「row.values.」は指定しないでください。単一の |
ClearBasicFilterRequest
シートに基本フィルタが存在する場合は、クリアします。
JSON 表現 |
---|
{ "sheetId": integer } |
フィールド | |
---|---|
sheetId
|
基本フィルタをクリアするシート ID。 |
DeleteDimensionRequest
シートからディメンションを削除します。
JSON 表現 |
---|
{
"range": {
object (
|
フィールド | |
---|---|
range
|
シートから削除するディメンション。 |
DeleteEmbeddedObjectRequest
指定された ID の埋め込みオブジェクトを削除します。
JSON 表現 |
---|
{ "objectId": integer } |
フィールド | |
---|---|
objectId
|
削除する埋め込みオブジェクトの ID。 |
DeleteFilterViewRequest
特定のフィルタビューを削除します。
JSON 表現 |
---|
{ "filterId": integer } |
フィールド | |
---|---|
filterId
|
削除するフィルタの ID。 |
DuplicateFilterViewRequest
特定のフィルタビューを複製します。
JSON 表現 |
---|
{ "filterId": integer } |
フィールド | |
---|---|
filterId
|
複製されるフィルタの ID。 |
DuplicateSheetRequest
シートの内容を複製します。
JSON 表現 |
---|
{ "sourceSheetId": integer, "insertSheetIndex": integer, "newSheetId": integer, "newSheetName": string } |
フィールド | |
---|---|
sourceSheetId
|
複製するシート。
ソースシートが |
insertSheetIndex
|
新しいシートが挿入されるゼロベースのインデックス。これ以降のすべてのシートのインデックスはインクリメントされます。 |
newSheetId
|
設定されている場合、新しいシートの ID。設定されていない場合は ID が選択されます。設定する場合、ID が既存のシート ID と競合しないようにする必要があります。設定する場合、負でない値にする必要があります。 |
newSheetName
|
新しいシートの名前。空の場合、新しい名前が自動的に選択されます。 |
FindReplaceRequest
範囲、シート、またはすべてのシートのセルでデータを検索して置換します。
JSON 表現 |
---|
{ "find": string, "replacement": string, "matchCase": boolean, "matchEntireCell": boolean, "searchByRegex": boolean, "includeFormulas": boolean, // Union field |
フィールド | |
---|---|
find
|
検索する値を指定します。 |
replacement
|
置換として使用する値。 |
matchCase
|
検索で大文字と小文字が区別される場合は true。 |
matchEntireCell
|
検索値がセル全体と一致する場合は true。 |
searchByRegex
|
検索値が正規表現の場合は True。正規表現と置換は、https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html にある Java 正規表現ルールに従う必要があります。置換文字列はキャプチャ グループを参照できます。たとえば、あるセルに |
includeFormulas
|
検索に数式を含むセルを含める場合は True です。数式を含むセルをスキップする場合は false です。 |
共用体フィールド scope 。検索または置換するスコープは、1 つだけ設定する必要があります。
scope は次のいずれかになります。 |
|
range
|
検索または置換する範囲です。 |
sheetId
|
検索または置換するシート。 |
allSheets
|
すべてのシートを検索して置換します。 |
InsertDimensionRequest
シート内の特定のインデックスに行または列を挿入します。
JSON 表現 |
---|
{
"range": {
object (
|
フィールド | |
---|---|
range
|
挿入するディメンション。開始インデックスと終了インデックスの両方を制限する必要があります。 |
inheritFromBefore
|
新たに挿入したディメンションの前と後のどちらでディメンション プロパティを拡張する必要があるか。前のディメンションから継承するには true(この場合、開始インデックスは 0 より大きくする必要があります)または false は後続のディメンションから継承します。
たとえば、行インデックス 0 が赤の背景で、行インデックス 1 が緑の背景である場合、インデックス 1 に 2 行を挿入すると、緑または赤の背景のいずれかが継承されます。 |
InsertRangeRequest
範囲内にセルを挿入し、既存のセルを上下に移動させます。
JSON 表現 |
---|
{ "range": { object ( |
フィールド | |
---|---|
range
|
新しいセルを挿入する範囲。 |
shiftDimension
|
セルの挿入時にシフトされるディメンション。 |
MoveDimensionRequest
1 つまたは複数の行または列を移動します。
JSON 表現 |
---|
{
"source": {
object (
|
フィールド | |
---|---|
source
|
移動するソースディメンション。 |
destinationIndex
|
ソースデータをグリッドから削除する前の座標に基づいて、ソースデータの移動先のゼロベースの開始インデックス。既存のデータは(ディメンションに応じて)上下にシフトされ、移動するディメンションのスペースを確保します。ソース ディメンションはグリッドから削除されるため、データの値は指定したインデックスとは異なることがあります。
たとえば、 |
UpdateEmbeddedObjectPositionRequest
埋め込みオブジェクトの位置(グラフや画像の移動やサイズ変更など)を更新します。
JSON 表現 |
---|
{
"objectId": integer,
"newPosition": {
object (
|
フィールド | |
---|---|
objectId
|
移動するオブジェクトの ID。 |
newPosition
|
埋め込みオブジェクトを移動する明示的な位置。 |
fields
|
新しい位置を設定するときに更新する必要がある |
PasteDataRequest
指定した座標からデータをスプレッドシートに挿入します。
JSON 表現 |
---|
{ "coordinate": { object ( |
フィールド | |
---|---|
coordinate
|
データの挿入が開始される座標。 |
data
|
挿入するデータ。 |
type
|
データの貼り付け方法。 |
共用体フィールド kind 。データの解釈方法を指定するには、値を 1 つのみ設定する必要があります。kind は次のいずれかになります。 |
|
delimiter
|
データ内の区切り文字。 |
html
|
データが HTML の場合は True。 |
TextToColumnsRequest
各セルの区切り文字に基づいて、テキストの列を複数の列に分割します。
JSON 表現 |
---|
{ "source": { object ( |
フィールド | |
---|---|
source
|
ソースデータの範囲。列はちょうど 1 列にまたがる必要があります。 |
delimiter
|
使用する区切り文字。区切り文字が |
delimiterType
|
使用する区切り文字の型。 |
DelimiterType
分割する区切り文字。
列挙型 | |
---|---|
DELIMITER_TYPE_UNSPECIFIED
|
デフォルト値。この値は使用しないでください。 |
COMMA
|
"," |
SEMICOLON
|
「;」 |
PERIOD
|
"." |
SPACE
|
" " |
CUSTOM
|
区切り文字で定義されたカスタム値。 |
AUTODETECT
|
列を自動的に検出します。 |
UpdateFilterViewRequest
フィルタビューのプロパティを更新します。
JSON 表現 |
---|
{
"filter": {
object (
|
フィールド | |
---|---|
filter
|
フィルタビューの新しいプロパティ。 |
fields
|
更新するフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート |
DeleteRangeRequest
セル範囲を削除し、削除したセルに他のセルを移動します。
JSON 表現 |
---|
{ "range": { object ( |
フィールド | |
---|---|
range
|
削除するセルの範囲。 |
shiftDimension
|
削除されたセルの置換元のディメンション。 |
AppendDimensionRequest
シートの末尾に行または列を追加します。
JSON 表現 |
---|
{
"sheetId": integer,
"dimension": enum (
|
フィールド | |
---|---|
sheetId
|
行または列の追加先となるシート。 |
dimension
|
行または列を追加するかどうか。 |
length
|
追加する行または列の数。 |
AddConditionalFormatRuleRequest
指定されたインデックスに新しい条件付き書式ルールを追加します。後続のすべてのルールのインデックスは増分されます。
JSON 表現 |
---|
{
"rule": {
object (
|
フィールド | |
---|---|
rule
|
追加するルール。 |
index
|
ルールを挿入するゼロベースのインデックス。 |
UpdateConditionalFormatRuleRequest
指定されたインデックスで条件付き書式ルールを更新するか、条件付き書式ルールを別のインデックスに移動します。
JSON 表現 |
---|
{ "index": integer, "sheetId": integer, // Union field |
フィールド | |
---|---|
index
|
置換または移動する必要があるルールのゼロベースのインデックス。 |
sheetId
|
移動するルールのシート。 |
共用体フィールド instruction 。実施する必要がある更新の種類。instruction は次のいずれかになります。 |
|
rule
|
特定のインデックスのルールを置き換える必要があるルール。 |
newIndex
|
ルールの最終的なゼロベースのインデックス。 |
DeleteConditionalFormatRuleRequest
指定されたインデックスの条件付き書式ルールを削除します。後続のすべてのルールのインデックスは減少します。
JSON 表現 |
---|
{ "index": integer, "sheetId": integer } |
フィールド | |
---|---|
index
|
削除するルールのゼロベースのインデックス。 |
sheetId
|
ルールを削除するシート。 |
SortRangeRequest
列ごとに並べ替え順序に基づいて行のデータを並べ替えます。
JSON 表現 |
---|
{ "range": { object ( |
フィールド | |
---|---|
range
|
並べ替える範囲。 |
sortSpecs[]
|
列ごとの並べ替え順序。以前の仕様と値が等しい場合、後の仕様が使用されます。 |
SetDataValidationRequest
範囲内のすべてのセルにデータ検証ルールを設定します。特定の範囲の検証をクリアするには、ルールを指定せずにこれを呼び出します。
JSON 表現 |
---|
{ "range": { object ( |
フィールド | |
---|---|
range
|
データの入力規則を適用する範囲を指定します。 |
rule
|
範囲内の各セルに設定するデータ検証ルール。または、範囲内のデータ検証をクリアする場合は空。 |
SetBasicFilterRequest
シートの基本フィルタを設定します。
JSON 表現 |
---|
{
"filter": {
object (
|
フィールド | |
---|---|
filter
|
設定するフィルタ。 |
AddProtectedRangeRequest
新しい保護範囲を追加します。
JSON 表現 |
---|
{
"protectedRange": {
object (
|
フィールド | |
---|---|
protectedRange
|
保護されている範囲を追加します。 |
UpdateProtectedRangeRequest
protectedRangeId
を指定して、既存の保護されている範囲を更新します。
JSON 表現 |
---|
{
"protectedRange": {
object (
|
フィールド | |
---|---|
protectedRange
|
新しいプロパティで更新する保護された範囲。 |
fields
|
更新するフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート |
DeleteProtectedRangeRequest
指定された ID で保護された範囲を削除します。
JSON 表現 |
---|
{ "protectedRangeId": integer } |
フィールド | |
---|---|
protectedRangeId
|
削除する保護されている範囲の ID。 |
AutoResizeDimensionsRequest
1 つ以上のディメンションは、そのディメンションに含まれるセルの内容に基づいて自動的にサイズ変更されます。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド dimension_range 。ディメンションの範囲。dimension_range は次のいずれかになります。 |
|
dimensions
|
自動的にサイズ変更するディメンション。 |
dataSourceSheetDimensions
|
自動的にサイズ変更されるデータソース シートのディメンション。 |
AddChartRequest
スプレッドシートのシートにグラフを追加します。
JSON 表現 |
---|
{
"chart": {
object (
|
フィールド | |
---|---|
chart
|
スプレッドシートに追加するグラフ(配置場所を含む)。 |
UpdateChartSpecRequest
グラフの仕様を更新します。{0}グラフの移動やサイズ変更は行われません。グラフの移動やサイズ変更を行うには、UpdateEmbeddedObjectPositionRequest
を使用します)。
JSON 表現 |
---|
{
"chartId": integer,
"spec": {
object (
|
フィールド | |
---|---|
chartId
|
更新するグラフの ID。 |
spec
|
グラフに適用する仕様。 |
UpdateBandingRequest
指定されたバンド範囲のプロパティを更新します。
JSON 表現 |
---|
{
"bandedRange": {
object (
|
フィールド | |
---|---|
bandedRange
|
新しいプロパティで更新する帯域範囲。 |
fields
|
更新するフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート |
AddBandingRequest
スプレッドシートに新しい帯域を追加します。
JSON 表現 |
---|
{
"bandedRange": {
object (
|
フィールド | |
---|---|
bandedRange
|
加算するバンド範囲です。 |
DeleteBandingRequest
指定された ID の帯域をスプレッドシートから削除します。
JSON 表現 |
---|
{ "bandedRangeId": integer } |
フィールド | |
---|---|
bandedRangeId
|
削除するバンド範囲の ID。 |
CreateDeveloperMetadataRequest
デベロッパー メタデータの作成リクエスト。
JSON 表現 |
---|
{
"developerMetadata": {
object (
|
フィールド | |
---|---|
developerMetadata
|
作成するデベロッパー メタデータ。 |
UpdateDeveloperMetadataRequest
デベロッパー メタデータのプロパティを更新するリクエスト。フィルタで選択されたデベロッパー メタデータのプロパティを、DeveloperMetadata
リソースで指定された値に更新します。呼び出し元は、fields パラメータで更新するプロパティを指定するとともに、更新するメタデータに一致する DataFilter
を少なくとも 1 つ指定する必要があります。
JSON 表現 |
---|
{ "dataFilters": [ { object ( |
フィールド | |
---|---|
dataFilters[]
|
更新するデベロッパー メタデータ エントリと一致するフィルタ。 |
developerMetadata
|
データフィルタで一致したすべてのメタデータが更新される値。 |
fields
|
更新するフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート |
DeleteDeveloperMetadataRequest
デベロッパー メタデータの削除リクエスト。
JSON 表現 |
---|
{
"dataFilter": {
object (
|
フィールド | |
---|---|
dataFilter
|
削除するデベロッパー メタデータ エントリを選択するための条件を記述するデータフィルタ。 |
RandomizeRangeRequest
範囲内の行の順序をランダム化します。
JSON 表現 |
---|
{
"range": {
object (
|
フィールド | |
---|---|
range
|
ランダム化する範囲。 |
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 (
|
フィールド | |
---|---|
range
|
グループを作成する範囲。 |
DeleteDimensionGroupRequest
範囲内のディメンションの深さを小さくして、指定された範囲内のグループを削除します。
たとえば、シートに B:E の上に深度 1 のグループがあり、C:D に深度 2 のグループがあるとします。D:E でグループを削除すると、シートは B:D で深度 1 のグループ、C:C で深度 2 のグループになります。
JSON 表現 |
---|
{
"range": {
object (
|
フィールド | |
---|---|
range
|
削除するグループの範囲。 |
UpdateDimensionGroupRequest
指定されたグループの状態を更新します。
JSON 表現 |
---|
{
"dimensionGroup": {
object (
|
フィールド | |
---|---|
dimensionGroup
|
状態を更新するグループ。グループの範囲と深さには、シートで有効なグループを指定し、他のすべてのフィールドを更新する必要があります。 |
fields
|
更新するフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート |
TrimWhitespaceRequest
指定した範囲のすべてのセルのスペース(タブ、改行など)を削除します。このリクエストでは、各セルのテキストの先頭と末尾にあるすべての空白を削除し、残りの空白文字が 1 つのスペースに続くすべての部分を減らします。トリミングされたテキストが「+」または「=」で始まる場合、そのテキストは文字列値として保持され、数式として解釈されません。
JSON 表現 |
---|
{
"range": {
object (
|
フィールド | |
---|---|
range
|
トリミングするセルの範囲。 |
DeleteDuplicatesRequest
指定された列の値が前の行と重複する行を含む、この範囲内の行を削除します。値が同じで、大文字と小文字、書式、数式が異なる行は、重複していると見なされます。
また、このリクエストでは、フィルタなどが原因で非表示になっている重複行も削除されます。重複を除去すると、重複する各行をスキャンした最初のインスタンスが下から下に向かってスキャンされます。指定した範囲外のコンテンツは削除されません。重複とみなされる行が、範囲内で隣接している必要はありません。
JSON 表現 |
---|
{ "range": { object ( |
フィールド | |
---|---|
range
|
重複行を削除する範囲。 |
comparisonColumns[]
|
重複値について分析する範囲の列です。列を選択しない場合は、すべての列で重複を分析します。 |
UpdateEmbeddedObjectBorderRequest
埋め込みオブジェクトの境界プロパティを更新します。
JSON 表現 |
---|
{
"objectId": integer,
"border": {
object (
|
フィールド | |
---|---|
objectId
|
更新する埋め込みオブジェクトの ID。 |
border
|
埋め込みオブジェクトに適用される枠線。 |
fields
|
更新するフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート |
AddSlicerRequest
スプレッドシートのシートにスライサーを追加します。
JSON 表現 |
---|
{
"slicer": {
object (
|
フィールド | |
---|---|
slicer
|
スプレッドシートに追加するスライサー(配置場所を含む)。 |
UpdateSlicerSpecRequest
スライサーの仕様を更新します。(スライサーの移動やサイズ変更は行われません)。スライサーの移動やサイズ変更を行うには、UpdateEmbeddedObjectPositionRequest
を使用します。
JSON 表現 |
---|
{
"slicerId": integer,
"spec": {
object (
|
フィールド | |
---|---|
slicerId
|
更新するスライサーの ID。 |
spec
|
スライサーに適用する仕様。 |
fields
|
更新するフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート |
AddDataSourceRequest
データソースを追加します。データソースが正常に追加されると、関連する DATA_SOURCE
シートが作成され、データソースからデータを読み取るためにシートの更新が実行されます。リクエストには、追加の bigquery.readonly
OAuth スコープが必要です。
JSON 表現 |
---|
{
"dataSource": {
object (
|
フィールド | |
---|---|
dataSource
|
追加するデータソース。 |
UpdateDataSourceRequest
データソースを更新します。データソースが正常に更新されると、関連する DATA_SOURCE
シートを更新して実行が開始され、更新されたデータソースからデータが読み取られます。リクエストには、追加の bigquery.readonly
OAuth スコープが必要です。
JSON 表現 |
---|
{
"dataSource": {
object (
|
フィールド | |
---|---|
dataSource
|
更新するデータソース。 |
fields
|
更新するフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート |
DeleteDataSourceRequest
データソースを削除します。また、関連するデータソース シートを削除し、関連するすべてのデータソース オブジェクトのリンクを解除します。
JSON 表現 |
---|
{ "dataSourceId": string } |
フィールド | |
---|---|
dataSourceId
|
削除するデータソースの ID。 |
RefreshDataSourceRequest
指定した参照に基づいてスプレッドシート内の 1 つ以上のデータソース オブジェクトを更新します。リクエストには、追加の bigquery.readonly
OAuth スコープが必要です。
同じデータソース オブジェクトを参照する複数の更新リクエストが 1 つのバッチ内に存在する場合、最後の更新リクエストのみが処理され、それに応じてすべてのリクエストに同じレスポンスが返されます。
JSON 表現 |
---|
{ "force": boolean, // Union field |
フィールド | |
---|---|
force
|
現在の状態に関係なく、データソース オブジェクトを更新します。設定されず、参照されているデータソース オブジェクトがエラー状態だった場合、更新はすぐに失敗します。 |
共用体フィールド target 。更新する対象を指定します。
target は次のいずれかになります。 |
|
references
|
更新するデータソース オブジェクトへの参照。 |
dataSourceId
|
|
isAll
|
スプレッドシート内の既存のデータソース オブジェクトをすべて更新します。 |
DataSourceObjectReferences
データソース オブジェクトへの参照のリスト。
JSON 表現 |
---|
{
"references": [
{
object (
|
フィールド | |
---|---|
references[]
|
参照 |
DataSourceObjectReference
データソース オブジェクトへの参照。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド value 。参照タイプ。value は次のいずれかになります。 |
|
sheetId
|
|
chartId
|
データソース グラフへの参照。 |
dataSourceTableAnchorCell
|
セルに固定された |
dataSourcePivotTableAnchorCell
|
セル |
dataSourceFormulaCell
|
|