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

Изменилось количество вхождений (возможно, несколько в одной ячейке). Например, если заменить "e" на "o" в "Google Sheets" , то получится "3" потому что "Google Sheets" -> "Googlo Shoots" .

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

Ответ на обновление одного или нескольких объектов источника данных.

JSON-представление
{
  "statuses": [
    {
      object (RefreshDataSourceObjectExecutionStatus)
    }
  ]
}
Поля
statuses[]

object ( RefreshDataSourceObjectExecutionStatus )

Все статусы обновления для ссылок на объекты источника данных, указанных в запросе. Если указано значение isAll , поле содержит только те ссылки, которые находятся в состоянии сбоя.

RefreshDataSourceObjectExecutionStatus

Статус выполнения обновления объекта источника данных.

JSON-представление
{
  "reference": {
    object (DataSourceObjectReference)
  },
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
Поля
reference

object ( DataSourceObjectReference )

Ссылка на обновляемый объект источника данных.

dataExecutionStatus

object ( DataExecutionStatus )

Статус выполнения данных.

ОтменитьОтменитьОбновитьОтвет

Ответ на отмену обновления одного или нескольких объектов источника данных.

JSON-представление
{
  "statuses": [
    {
      object (CancelDataSourceRefreshStatus)
    }
  ]
}
Поля
statuses[]

object ( CancelDataSourceRefreshStatus )

Статусы отмены обновлений всех объектов источника данных, указанных в запросе. Если указано значение isAll , поле содержит только те объекты, которые находятся в состоянии сбоя. Обновление и отмена обновления одного и того же объекта источника данных также не допускаются в рамках одного и того же batchUpdate .

Отменить обновление источника данных

Состояние отмены обновления отдельного объекта источника данных.

JSON-представление
{
  "reference": {
    object (DataSourceObjectReference)
  },
  "refreshCancellationStatus": {
    object (RefreshCancellationStatus)
  }
}
Поля
reference

object ( DataSourceObjectReference )

Ссылка на объект источника данных, обновление которого отменяется.

refreshCancellationStatus

object ( RefreshCancellationStatus )

Статус отмены.

RefreshCancellationStatus

Статус отмены обновления.

Вы можете отправить cancel request , чтобы явно отменить обновление одного или нескольких объектов источника данных.

JSON-представление
{
  "state": enum (RefreshCancellationState),
  "errorCode": enum (RefreshCancellationErrorCode)
}
Поля
state

enum ( RefreshCancellationState )

Состояние вызова для отмены обновления в Google Sheets.

errorCode

enum ( RefreshCancellationErrorCode )

Код ошибки.

RefreshCancellationState

Перечень состояний отмены обновления.

Перечисления
REFRESH_CANCELLATION_STATE_UNSPECIFIED Значение по умолчанию, не использовать.
CANCEL_SUCCEEDED Вызов API к Google Sheets для отмены обновления прошел успешно. Это не означает, что отмена произошла успешно, а лишь то, что вызов был выполнен успешно.
CANCEL_FAILED Вызов API к Google Sheets для отмены обновления завершился неудачей.

RefreshCancellationErrorCode

Перечень кодов ошибок, приводящих к отмене обновления.

Перечисления
REFRESH_CANCELLATION_ERROR_CODE_UNSPECIFIED Значение по умолчанию, не использовать.
EXECUTION_NOT_FOUND Запрос, который необходимо отменить, не найден ни в механизме запросов, ни в Google Sheets.
CANCEL_PERMISSION_DENIED Пользователь не имеет права отменить запрос.
QUERY_EXECUTION_COMPLETED Выполнение запроса уже завершено, поэтому отменить его невозможно.
CONCURRENT_CANCELLATION Уже рассматривается еще одна отмена.
CANCEL_OTHER_ERROR Все остальные ошибки.

AddTableResponse

Результат добавления таблицы.

JSON-представление
{
  "table": {
    object (Table)
  }
}
Поля
table

object ( Table )

Только вывод. Добавленная таблица.