リクエスト
スプレッドシートに適用する 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 を更新します。 |
cancelDataSourceRefresh
|
1 つ以上のデータソースと関連する dbobject の更新をキャンセルします。 |
UpdateSpreadsheetPropertiesRequest
スプレッドシートのプロパティを更新します。
JSON 表現 |
---|
{
"properties": {
object (
|
フィールド | |
---|---|
properties
|
更新するプロパティ。 |
fields
|
更新するフィールド。フィールドを少なくとも 1 つ指定する必要があります。ルートの「properties」は暗黙のものであり、指定しないでください。1 つの |
UpdateSheetPropertiesRequest
指定された sheetId
でシートのプロパティを更新します。
JSON 表現 |
---|
{
"properties": {
object (
|
フィールド | |
---|---|
properties
|
更新するプロパティ。 |
fields
|
更新するフィールド。フィールドを少なくとも 1 つ指定する必要があります。ルート |
UpdateDimensionPropertiesRequest
指定した範囲内のディメンションのプロパティを更新します。
JSON 表現 |
---|
{ "properties": { object ( |
フィールド | |
---|---|
properties
|
更新するプロパティ。 |
fields
|
更新するフィールド。フィールドを少なくとも 1 つ指定する必要があります。ルート |
共用体フィールド dimension_range 。ディメンションの範囲。
dimension_range は次のいずれかになります。 |
|
range
|
更新する行または列。 |
dataSourceSheetRange
|
更新するデータソース シートの列。 |
DataSourceSheetDimensionRange
DATA_SOURCE
シート上の 1 つのディメンションの範囲。
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 は次のいずれかになります。 |
|
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
|
範囲から結合を 1 つ作成する |
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.」は指定しないでください。1 つの |
共用体フィールド area 。位置情報を書き込む必要があります。必ず 1 つの値を設定する必要があります。area は次のいずれかになります。 |
|
start
|
データの書き込みを開始する座標。任意の数の行と列(1 行ごとに異なる列数を含む)を書き込むことができます。 |
range
|
データを書き込む範囲。
行のデータがリクエストされた範囲全体をカバーしていない場合、 |
AddFilterViewRequest
フィルタ表示を追加します。
JSON 表現 |
---|
{
"filter": {
object (
|
フィールド | |
---|---|
filter
|
追加するフィルタ。 |
AppendCellsRequest
シート内のデータを含む最後の行の後に新しいセルを追加し、必要に応じて新しい行をシートに挿入します。
JSON 表現 |
---|
{
"sheetId": integer,
"rows": [
{
object (
|
フィールド | |
---|---|
sheetId
|
データを追加するシート ID。 |
rows[]
|
追加するデータ。 |
fields
|
更新する CellData のフィールド。フィールドを少なくとも 1 つ指定する必要があります。ルートは CellData です。「row.values.」は指定しないでください。1 つの |
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 正規表現ルールに従う必要があります。置換文字列はキャプチャ グループを参照できます。たとえば、1 つのセルの内容が |
includeFormulas
|
数式を含むセルを検索に含める場合は true に設定します。False の場合、数式を含むセルをスキップします。 |
共用体フィールド scope 。検索または置換するスコープ。1 つだけ設定する必要があります。scope は次のいずれかになります。 |
|
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 は次のいずれかになります。 |
|
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
グラフの仕様を更新します。(グラフの移動やサイズ変更は行われません。グラフの移動やサイズ変更を行うには、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, 深度 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 (
|
フィールド | |
---|---|
range
|
グループを作成する範囲。 |
DeleteDimensionGroupRequest
範囲のディメンションの深さを下げて、指定された範囲のグループを削除します。
たとえば、シートに B:E の depth-1 グループと C:D の depth-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
|
|
CancelDataSourceRefreshRequest
指定された参照による、スプレッドシート内のデータソース オブジェクトの 1 つまたは複数の更新をキャンセルします。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド target 。キャンセルする対象を指定します。
target は次のいずれかになります。 |
|
references
|
更新をキャンセルするデータソース オブジェクトへの参照。 |
dataSourceId
|
|
isAll
|
スプレッドシート内のすべてのデータソースについて、既存のデータソース オブジェクトの更新をすべてキャンセルします。 |