リクエスト
スプレッドシートに適用する 1 種類の更新。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド
kind 。更新の種類。フィールドが 1 つだけ必要です。
kind
は次のいずれか 1 つのみを指定できます。
|
|
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 を更新します。 |
cancelDataSourceRefresh
|
1 つまたは複数のデータソースと関連する dbobject の更新をキャンセルします。 |
UpdateSpreadsheetPropertiesRequest
スプレッドシートのプロパティを更新します。
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
は次のいずれか 1 つのみを指定できます。
|
|
range
|
更新する行または列。 |
dataSourceSheetRange
|
更新するデータソース シートの列。 |
DataSourceSheetDimensionRange
1 つの次元に沿った範囲は、
DATA_SOURCE
できます。
JSON 表現 |
---|
{
"sheetId": integer,
"columnReferences": [
{
object (
|
フィールド | |
---|---|
sheetId
|
範囲が含まれているデータソース シートの ID。 |
columnReferences[]
|
データソース シートの列です。 |
UpdateNamedRangeRequest
名前付き範囲のプロパティを、指定された
namedRangeId
。
JSON 表現 |
---|
{
"namedRange": {
object (
|
フィールド | |
---|---|
namedRange
|
新しいプロパティで更新する名前付き範囲。 |
fields
|
更新対象のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート
|
RepeatCellRequest
範囲内のすべてのセルを、指定された Cell オブジェクトの値に更新します。表示されるのは
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
|
「代替」を使用してデータを生成する場合は trueシリーズとして提供されますこれは、ソースデータの種類と量によって異なります。 |
共用体フィールド
area 。自動入力する領域。
area
は次のいずれか 1 つのみを指定できます。
|
|
range
|
自動入力する範囲。これにより、範囲が検証され、データがある場所が検出され、そのデータが残りの範囲に自動的に入力されます。 |
sourceAndDestination
|
自動入力される送信元と宛先の領域。これにより、自動入力のソースと、そのデータの拡張先が明示的にリストされます。 |
SourceAndDestination
ソース範囲とそのソースの拡張方法の組み合わせ。
JSON 表現 |
---|
{ "source": { object ( |
フィールド | |
---|---|
source
|
自動入力のソースとして使用するデータの場所。 |
dimension
|
データを入力するディメンション。 |
fillLength
|
データを入力する行または列の数。正の数値は、ソースの最終行または最後の列を超えて拡張されます。負の数値は、ソースの最初の行または最初の列の前に展開されます。 |
CutPasteRequest
データをソースから宛先に移動します。
JSON 表現 |
---|
{ "source": { object ( |
フィールド | |
---|---|
source
|
切り取るソースデータ。 |
destination
|
データを貼り付ける左上の座標。 |
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 ( |
フィールド | |
---|---|
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
は次のいずれか 1 つのみを指定できます。
|
|
start
|
データの書き込みを開始する座標。任意の数の行と列(1 行ごとに異なる列数を含む)を書き込むことができます。 |
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 と競合しないようにする必要があります。設定する場合は負でない値にしてください。 |
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。正規表現と置換は、Java 正規表現ルールに従う必要があります。
https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.置換文字列はキャプチャ グループを参照できます。たとえば、1 つのセルの内容が
|
includeFormulas
|
検索に数式を含むセルを含める場合は true。数式が含まれているセルをスキップする場合は False です。 |
共用体フィールド
scope 。検索/置換の対象であるスコープ。1 つのみ設定する必要があります。
scope
は次のいずれか 1 つのみを指定できます。
|
|
range
|
検索または置換する範囲。 |
sheetId
|
検索または置換するシート。 |
allSheets
|
すべてのシートを検索して置換する場合は True。 |
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
は次のいずれか 1 つのみを指定できます。
|
|
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
は次のいずれか 1 つのみを指定できます。
|
|
rule
|
指定されたインデックスにあるルールを置き換えるルール。 |
newIndex
|
ルールを適用する際の 0 ベースの新しいインデックス。 |
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
は次のいずれか 1 つのみを指定できます。
|
|
dimensions
|
自動的にサイズ変更するディメンション。 |
dataSourceSheetDimensions
|
自動的にサイズ変更されるデータソース シートのディメンション。 |
AddChartRequest
スプレッドシートのシートにグラフを追加します。
JSON 表現 |
---|
{
"chart": {
object (
|
フィールド | |
---|---|
chart
|
スプレッドシートに追加するグラフ(配置する位置を含む)。「
|
UpdateChartSpecRequest
グラフの仕様を更新します。(この操作でグラフの移動やサイズ変更が行われることはありません。グラフの移動やサイズ変更には、
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 パラメータで指定し、少なくとも 1 つを指定する必要があります。
DataFilter
メタデータに一致する必要があります。
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、深さ 1] + [C:D] は、グループ [B:E、深さ 1] と [C:D、深さ 2] になります。リクエストされた範囲が既存のグループ G の範囲内で開始して終了した場合、または既存のグループ G の範囲内で終了した場合、既存のグループ G の範囲はこれらの範囲を結合し、新しいグループ G'深度は G の深さより 1 大きく、範囲はそれらの範囲の交点となります。たとえば、グループ [B:D、深さ 1] + [C:E] は、グループ [B:E、深さ 1] と [C:D、深さ 2] になります。
JSON 表現 |
---|
{
"range": {
object (
|
フィールド | |
---|---|
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
BigQuery データソースを追加する場合の OAuth スコープ。
JSON 表現 |
---|
{
"dataSource": {
object (
|
フィールド | |
---|---|
dataSource
|
追加するデータソース。 |
UpdateDataSourceRequest
データソースを更新します。データソースが正常に更新されると、関連する更新を行うために実行がトリガーされます。
DATA_SOURCE
更新済みのデータソースからデータを読み取ることができます。
このリクエストには、
bigquery.readonly
BigQuery データソースを更新する場合の OAuth スコープ。
JSON 表現 |
---|
{
"dataSource": {
object (
|
フィールド | |
---|---|
dataSource
|
更新するデータソース。 |
fields
|
更新対象のフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート
|
DeleteDataSourceRequest
データソースを削除します。このリクエストにより、関連付けられているデータソース シートが削除され、関連付けられているすべてのデータソース オブジェクトのリンクが解除されます。
JSON 表現 |
---|
{ "dataSourceId": string } |
フィールド | |
---|---|
dataSourceId
|
削除するデータソースの ID。 |
RefreshDataSourceRequest
指定した参照で、スプレッドシート内の 1 つまたは複数のデータソース オブジェクトを更新します。
このリクエストには、
bigquery.readonly
BigQuery データソースを更新する場合の OAuth スコープ。
複数の更新リクエストが 1 つのバッチで同じデータソース オブジェクトを参照する場合は、最後の更新リクエストのみが処理され、すべてのリクエストのレスポンスはそれに応じて同じになります。
JSON 表現 |
---|
{ "force": boolean, // Union field |
フィールド | |
---|---|
force
|
現在の状態に関係なく、データソース オブジェクトを更新します。設定されておらず、参照先のデータソース オブジェクトがエラー状態だった場合、更新はすぐに失敗します。 |
共用体フィールド
target 。更新する対象を指定します。
target
は次のいずれか 1 つのみを指定できます。
|
|
references
|
更新するデータソース オブジェクトへの参照。 |
dataSourceId
|
参照:
|
isAll
|
スプレッドシート内の既存のデータソース オブジェクトをすべて更新します。 |
DataSourceObjectReferences
データソース オブジェクトへの参照のリスト。
JSON 表現 |
---|
{
"references": [
{
object (
|
フィールド | |
---|---|
references[]
|
参照。 |
CancelDataSourceRefreshRequest
指定した参照によるスプレッドシート内のデータソース オブジェクトの更新をキャンセルします。
このリクエストには、
bigquery.readonly
BigQuery データソースで更新をキャンセルする場合の OAuth スコープ。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド
target 。キャンセルする内容を指定します。
target
は次のいずれか 1 つのみを指定できます。
|
|
references
|
更新をキャンセルするデータソース オブジェクトへの参照。 |
dataSourceId
|
参照:
|
isAll
|
スプレッドシート内のすべてのデータソースについて、既存のデータソース オブジェクトの更新をすべてキャンセルします。 |