Responses

レスポンス

更新に対する 1 つのレスポンス。

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)

データソース オブジェクトの更新をキャンセルした場合の応答。

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

発生回数(1 つのセル内で複数回行われる場合もあります)が変更されました。たとえば、"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 その他のすべてのエラー。