Responses

レスポンス

更新からの単一のレスポンス。

JSON 表現 
{

  "addNamedRange": {
    object (AddNamedRangeResponse)
  },
  "addSheet": {
    object (AddSheetResponse)
  },
  "addFilterView": {
    object (AddFilterViewResponse)
  },
  "duplicateFilterView": {
    object (DuplicateFilterViewResponse)
  },
  "duplicateSheet": {
    object (DuplicateSheetResponse)
  },
  "findReplace": {
    object (FindReplaceResponse)
  },
  "updateEmbeddedObjectPosition": {
    object (UpdateEmbeddedObjectPositionResponse)
  },
  "updateConditionalFormatRule": {
    object (UpdateConditionalFormatRuleResponse)
  },
  "deleteConditionalFormatRule": {
    object (DeleteConditionalFormatRuleResponse)
  },
  "addProtectedRange": {
    object (AddProtectedRangeResponse)
  },
  "addChart": {
    object (AddChartResponse)
  },
  "addBanding": {
    object (AddBandingResponse)
  },
  "createDeveloperMetadata": {
    object (CreateDeveloperMetadataResponse)
  },
  "updateDeveloperMetadata": {
    object (UpdateDeveloperMetadataResponse)
  },
  "deleteDeveloperMetadata": {
    object (DeleteDeveloperMetadataResponse)
  },
  "addDimensionGroup": {
    object (AddDimensionGroupResponse)
  },
  "deleteDimensionGroup": {
    object (DeleteDimensionGroupResponse)
  },
  "trimWhitespace": {
    object (TrimWhitespaceResponse)
  },
  "deleteDuplicates": {
    object (DeleteDuplicatesResponse)
  },
  "addSlicer": {
    object (AddSlicerResponse)
  },
  "addDataSource": {
    object (AddDataSourceResponse)
  },
  "updateDataSource": {
    object (UpdateDataSourceResponse)
  },
  "refreshDataSource": {
    object (RefreshDataSourceResponse)
  },
  "cancelDataSourceRefresh": {
    object (CancelDataSourceRefreshResponse)
  },
  "addTable": {
    object (AddTableResponse)
  }
}
フィールド
共用体フィールド kind。返信の種類。リクエストにレスポンスがない場合、フィールドが設定されていない可能性があります。kind は次のいずれかになります。
addNamedRange

object (AddNamedRangeResponse)

名前付き範囲を追加したときの返信。
addSheet

object (AddSheetResponse)

シートの追加からの返信。
addFilterView

object (AddFilterViewResponse)

フィルタ表示の追加からの返信。
duplicateFilterView

object (DuplicateFilterViewResponse)

フィルタ表示の複製からの返信。
duplicateSheet

object (DuplicateSheetResponse)

シートの複製からの返信。
findReplace

object (FindReplaceResponse)

検索/置換の実行からの返信。
updateEmbeddedObjectPosition

object (UpdateEmbeddedObjectPositionResponse)

埋め込みオブジェクトの位置を更新したときの返信。
updateConditionalFormatRule

object (UpdateConditionalFormatRuleResponse)

条件付き書式ルールを更新したときの返信。
deleteConditionalFormatRule

object (DeleteConditionalFormatRuleResponse)

条件付き書式ルールを削除したときの返信。

addProtectedRange

object (AddProtectedRangeResponse)

保護されている範囲を追加したときの返信。
addChart

object (AddChartResponse)

グラフを追加したときの返信。

addBanding

object (AddBandingResponse)

帯域範囲を追加したときの返信。
createDeveloperMetadata

object (CreateDeveloperMetadataResponse)

デベロッパー メタデータ エントリの作成からの返信。
updateDeveloperMetadata

object (UpdateDeveloperMetadataResponse)

デベロッパー メタデータ エントリの更新からの返信。
deleteDeveloperMetadata

object (DeleteDeveloperMetadataResponse)

デベロッパー メタデータ エントリの削除からの返信。
addDimensionGroup

object (AddDimensionGroupResponse)

ディメンション グループを追加したときの返信。
deleteDimensionGroup

object (DeleteDimensionGroupResponse)

ディメンション グループの削除からの返信。
trimWhitespace

object (TrimWhitespaceResponse)

空白をトリミングした返信。
deleteDuplicates

object (DeleteDuplicatesResponse)

重複する値を含む行を削除したことに対する返信。
addSlicer

object (AddSlicerResponse)

スライサーを追加したときの返信。
addDataSource

object (AddDataSourceResponse)

データソースの追加からの返信。
updateDataSource

object (UpdateDataSourceResponse)

データソースの更新からの返信。
refreshDataSource

object (RefreshDataSourceResponse)

データソース オブジェクトの更新からの返信。
cancelDataSourceRefresh

object (CancelDataSourceRefreshResponse)

データソース オブジェクトの更新をキャンセルしたときの返信。
addTable

object (AddTableResponse)

テーブルの追加からの返信。

DataSourceObjectReference

データソース オブジェクトへの参照。

JSON 表現 
{

  "sheetId": string,
  "chartId": integer,
  "dataSourceTableAnchorCell": {
    object (GridCoordinate)
  },
  "dataSourcePivotTableAnchorCell": {
    object (GridCoordinate)
  },
  "dataSourceFormulaCell": {
    object (GridCoordinate)
  }
}
フィールド
共用体フィールド value。参照タイプ。value は次のいずれかになります。
sheetId

string

DATA_SOURCE シートへの参照。
chartId

integer

データソース グラフへの参照。
dataSourceTableAnchorCell

object (GridCoordinate)

セルにアンカー設定された DataSourceTable への参照。
dataSourcePivotTableAnchorCell

object (GridCoordinate)

セルにアンカー設定されたデータソースへの参照。 PivotTable

dataSourceFormulaCell

object (GridCoordinate)

DataSourceFormula を含むセルへの参照。

AddNamedRangeResponse

名前付き範囲を追加した結果。

JSON 表現 
{
  "namedRange": {
    object (NamedRange)
  }
}
フィールド
namedRange

object (NamedRange)

追加する名前付き範囲。

AddSheetResponse

シートを追加した結果。

JSON 表現 
{
  "properties": {
    object (SheetProperties)
  }
}
フィールド
properties

object (SheetProperties)

新しく追加されたシートのプロパティ。

AddFilterViewResponse

フィルタ表示を追加した結果。

JSON 表現 
{
  "filter": {
    object (FilterView)
  }
}
フィールド
filter

object (FilterView)

新しく追加されたフィルタ表示。

DuplicateFilterViewResponse

フィルタ表示の複製の結果。

JSON 表現 
{
  "filter": {
    object (FilterView)
  }
}
フィールド
filter

object (FilterView)

新しく作成されたフィルタ。

DuplicateSheetResponse

シートの複製の結果。

JSON 表現 
{
  "properties": {
    object (SheetProperties)
  }
}
フィールド
properties

object (SheetProperties)

重複するシートのプロパティ。

FindReplaceResponse

検索/置換の結果。

JSON 表現 
{
  "valuesChanged": integer,
  "formulasChanged": integer,
  "rowsChanged": integer,
  "sheetsChanged": integer,
  "occurrencesChanged": integer
}
フィールド
valuesChanged

integer

数式以外のセルの数が変更されました。
formulasChanged

integer

数式セルの数が変更されました。
rowsChanged

integer

変更された行の数。
sheetsChanged

integer

変更されたシートの数。
occurrencesChanged

integer

出現回数（セル内で複数回出現する可能性あり）が変更された。たとえば、"Google Sheets" で "e" を "o" に置き換える場合、"Google Sheets" -> "Googlo Shoots" であるため、"3" になります。

UpdateEmbeddedObjectPositionResponse

埋め込みオブジェクトの位置を更新した結果。

JSON 表現 
{
  "position": {
    object (EmbeddedObjectPosition)
  }
}
フィールド
position

object (EmbeddedObjectPosition)

埋め込みオブジェクトの新しい位置。

UpdateConditionalFormatRuleResponse

条件付き書式ルールの更新結果。

JSON 表現 
{
  "newRule": {
    object (ConditionalFormatRule)
  },
  "newIndex": integer,

  "oldRule": {
    object (ConditionalFormatRule)
  },
  "oldIndex": integer
}
フィールド
newRule

object (ConditionalFormatRule)

古いルールを置き換えた新しいルール（置き換えた場合）、または移動されたルール（移動した場合）

newIndex

integer

新しいルールのインデックス。
共用体フィールド old_info。前のルールに関する情報。old_info は次のいずれかになります。
oldRule

object (ConditionalFormatRule)

古い（削除された）ルール。ルールが移動された場合は設定されません（newRule と同じであるため）。
oldIndex

integer

ルールの古いインデックス。ルールが置き換えられた場合は設定されません（newIndex と同じであるため）。

DeleteConditionalFormatRuleResponse

条件付き書式ルールを削除した結果。

JSON 表現 
{
  "rule": {
    object (ConditionalFormatRule)
  }
}
フィールド
rule

object (ConditionalFormatRule)

削除されたルール。

AddProtectedRangeResponse

新しい保護されている範囲を追加した結果。

JSON 表現 
{
  "protectedRange": {
    object (ProtectedRange)
  }
}
フィールド
protectedRange

object (ProtectedRange)

新しく追加された保護されている範囲。

AddChartResponse

スプレッドシートにグラフを追加した結果。

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

object (EmbeddedChart)

新しく追加されたグラフ。

AddBandingResponse

帯域範囲を追加した結果。

JSON 表現 
{
  "bandedRange": {
    object (BandedRange)
  }
}
フィールド
bandedRange

object (BandedRange)

追加された帯域範囲。

CreateDeveloperMetadataResponse

デベロッパー メタデータの作成からのレスポンス。

JSON 表現 
{
  "developerMetadata": {
    object (DeveloperMetadata)
  }
}
フィールド
developerMetadata

object (DeveloperMetadata)

作成されたデベロッパー メタデータ。

UpdateDeveloperMetadataResponse

デベロッパー メタデータの更新からのレスポンス。

JSON 表現 
{
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ]
}
フィールド
developerMetadata[]

object (DeveloperMetadata)

更新されたデベロッパー メタデータ。

DeleteDeveloperMetadataResponse

デベロッパー メタデータの削除からのレスポンス。

JSON 表現 
{
  "deletedDeveloperMetadata": [
    {
      object (DeveloperMetadata)
    }
  ]
}
フィールド
deletedDeveloperMetadata[]

object (DeveloperMetadata)

削除されたメタデータ。

AddDimensionGroupResponse

グループを追加した結果。

JSON 表現 
{
  "dimensionGroups": [
    {
      object (DimensionGroup)
    }
  ]
}
フィールド
dimensionGroups[]

object (DimensionGroup)

ディメンションにグループを追加した後の、そのディメンションのすべてのグループ。

DeleteDimensionGroupResponse

グループを削除した結果。

JSON 表現 
{
  "dimensionGroups": [
    {
      object (DimensionGroup)
    }
  ]
}
フィールド
dimensionGroups[]

object (DimensionGroup)

ディメンションからグループを削除した後の、そのディメンションのすべてのグループ。

TrimWhitespaceResponse

セル内の空白文字をトリミングした結果。

JSON 表現 
{
  "cellsChangedCount": integer
}
フィールド
cellsChangedCount

integer

空白文字が削除されたセルの数。

DeleteDuplicatesResponse

範囲内の重複を削除した結果。

JSON 表現 
{
  "duplicatesRemovedCount": integer
}
フィールド
duplicatesRemovedCount

integer

削除された重複行の数。

AddSlicerResponse

スプレッドシートにスライサーを追加した結果。

JSON 表現 
{
  "slicer": {
    object (Slicer)
  }
}
フィールド
slicer

object (Slicer)

新しく追加されたスライサー。

AddDataSourceResponse

データソースを追加した結果。

JSON 表現 
{
  "dataSource": {
    object (DataSource)
  },
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
フィールド
dataSource

object (DataSource)

作成されたデータソース。
dataExecutionStatus

object (DataExecutionStatus)

データの実行ステータス。

UpdateDataSourceResponse

データソースの更新からのレスポンス。

JSON 表現 
{
  "dataSource": {
    object (DataSource)
  },
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
フィールド
dataSource

object (DataSource)

更新されたデータソース。
dataExecutionStatus

object (DataExecutionStatus)

データの実行ステータス。

RefreshDataSourceResponse

1 つまたは複数のデータソース オブジェクトの更新からのレスポンス。

JSON 表現 
{
  "statuses": [
    {
      object (RefreshDataSourceObjectExecutionStatus)
    }
  ]
}
フィールド
statuses[]

object (RefreshDataSourceObjectExecutionStatus)

リクエストで指定されたデータソース オブジェクト参照のすべての更新ステータス。isAll が指定されている場合、このフィールドには失敗ステータスのもののみが含まれます。

RefreshDataSourceObjectExecutionStatus

1 つのデータソース オブジェクトの更新の実行ステータス。

JSON 表現 
{
  "reference": {
    object (DataSourceObjectReference)
  },
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
フィールド
reference

object (DataSourceObjectReference)

更新されるデータソース オブジェクトへの参照。
dataExecutionStatus

object (DataExecutionStatus)

データの実行ステータス。

CancelDataSourceRefreshResponse

1 つまたは複数のデータソース オブジェクトの更新をキャンセルしたときのレスポンス。

JSON 表現 
{
  "statuses": [
    {
      object (CancelDataSourceRefreshStatus)
    }
  ]
}
フィールド
statuses[]

object (CancelDataSourceRefreshStatus)

リクエストで指定されたすべてのデータソース オブジェクトの更新のキャンセル ステータス。isAll が指定されている場合、このフィールドには失敗ステータスのもののみが含まれます。同じ batchUpdate で同じデータソース オブジェクトの更新と更新のキャンセルを行うこともできません。

CancelDataSourceRefreshStatus

単一のデータソース オブジェクトの更新をキャンセルしたステータス。

JSON 表現 
{
  "reference": {
    object (DataSourceObjectReference)
  },
  "refreshCancellationStatus": {
    object (RefreshCancellationStatus)
  }
}
フィールド
reference

object (DataSourceObjectReference)

更新がキャンセルされるデータソース オブジェクトへの参照。
refreshCancellationStatus

object (RefreshCancellationStatus)

キャンセル ステータス。

RefreshCancellationStatus

更新のキャンセル ステータス。

cancel request を送信して、1 つまたは複数のデータソース オブジェクトの更新を明示的にキャンセルできます。

JSON 表現 
{
  "state": enum (RefreshCancellationState),
  "errorCode": enum (RefreshCancellationErrorCode)
}
フィールド
state

enum (RefreshCancellationState)

スプレッドシートの更新をキャンセルする呼び出しの状態。
errorCode

enum (RefreshCancellationErrorCode)

エラーコード。

RefreshCancellationState

更新キャンセル状態の列挙。

列挙型
REFRESH_CANCELLATION_STATE_UNSPECIFIED デフォルト値。使用しないでください。
CANCEL_SUCCEEDED シートへの API 呼び出しが成功し、更新がキャンセルされました。これは、キャンセルが正常に完了したことを意味するのではなく、呼び出しが正常に行われたことを意味します。
CANCEL_FAILED 更新をキャンセルする Sheets への API 呼び出しが失敗しました。

RefreshCancellationErrorCode

更新キャンセル エラーコードの列挙。

列挙型
REFRESH_CANCELLATION_ERROR_CODE_UNSPECIFIED デフォルト値。使用しないでください。
EXECUTION_NOT_FOUND キャンセルする実行がクエリエンジンまたはスプレッドシートに見つかりません。
CANCEL_PERMISSION_DENIED ユーザーにクエリをキャンセルする権限がありません。
QUERY_EXECUTION_COMPLETED クエリの実行はすでに完了しているため、キャンセルできませんでした。
CONCURRENT_CANCELLATION 別のキャンセルがすでに処理中です。
CANCEL_OTHER_ERROR その他のすべてのエラー。

AddTableResponse

テーブルを追加した結果。

JSON 表現 
{
  "table": {
    object (Table)
  }
}
フィールド
table

object (Table)

出力専用。追加されたテーブル。