Responses

レスポンス

アップデートからの単一のレスポンス。

JSON 表現 
{

  // Union field kind can be only one of the following:
  "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)
  }
  // End of list of possible types for union field kind.
}
フィールド
共用体フィールド 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)

データソース オブジェクトの更新をキャンセルした結果のレスポンス。

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

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,

  // Union field old_info can be only one of the following:
  "oldRule": {
    object (ConditionalFormatRule)
  },
  "oldIndex": integer
  // End of list of possible types for union field old_info.
}
フィールド
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 更新をキャンセルするためのスプレッドシートへの API 呼び出しが失敗しました。

RefreshCancellationErrorCode

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

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