Requests

Запрос

Единственный тип обновления, применяемый к электронной таблице.

JSON-представление
{

  // Union field kind can be only one of the following:
  "updateSpreadsheetProperties": {
    object (UpdateSpreadsheetPropertiesRequest)
  },
  "updateSheetProperties": {
    object (UpdateSheetPropertiesRequest)
  },
  "updateDimensionProperties": {
    object (UpdateDimensionPropertiesRequest)
  },
  "updateNamedRange": {
    object (UpdateNamedRangeRequest)
  },
  "repeatCell": {
    object (RepeatCellRequest)
  },
  "addNamedRange": {
    object (AddNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "addSheet": {
    object (AddSheetRequest)
  },
  "deleteSheet": {
    object (DeleteSheetRequest)
  },
  "autoFill": {
    object (AutoFillRequest)
  },
  "cutPaste": {
    object (CutPasteRequest)
  },
  "copyPaste": {
    object (CopyPasteRequest)
  },
  "mergeCells": {
    object (MergeCellsRequest)
  },
  "unmergeCells": {
    object (UnmergeCellsRequest)
  },
  "updateBorders": {
    object (UpdateBordersRequest)
  },
  "updateCells": {
    object (UpdateCellsRequest)
  },
  "addFilterView": {
    object (AddFilterViewRequest)
  },
  "appendCells": {
    object (AppendCellsRequest)
  },
  "clearBasicFilter": {
    object (ClearBasicFilterRequest)
  },
  "deleteDimension": {
    object (DeleteDimensionRequest)
  },
  "deleteEmbeddedObject": {
    object (DeleteEmbeddedObjectRequest)
  },
  "deleteFilterView": {
    object (DeleteFilterViewRequest)
  },
  "duplicateFilterView": {
    object (DuplicateFilterViewRequest)
  },
  "duplicateSheet": {
    object (DuplicateSheetRequest)
  },
  "findReplace": {
    object (FindReplaceRequest)
  },
  "insertDimension": {
    object (InsertDimensionRequest)
  },
  "insertRange": {
    object (InsertRangeRequest)
  },
  "moveDimension": {
    object (MoveDimensionRequest)
  },
  "updateEmbeddedObjectPosition": {
    object (UpdateEmbeddedObjectPositionRequest)
  },
  "pasteData": {
    object (PasteDataRequest)
  },
  "textToColumns": {
    object (TextToColumnsRequest)
  },
  "updateFilterView": {
    object (UpdateFilterViewRequest)
  },
  "deleteRange": {
    object (DeleteRangeRequest)
  },
  "appendDimension": {
    object (AppendDimensionRequest)
  },
  "addConditionalFormatRule": {
    object (AddConditionalFormatRuleRequest)
  },
  "updateConditionalFormatRule": {
    object (UpdateConditionalFormatRuleRequest)
  },
  "deleteConditionalFormatRule": {
    object (DeleteConditionalFormatRuleRequest)
  },
  "sortRange": {
    object (SortRangeRequest)
  },
  "setDataValidation": {
    object (SetDataValidationRequest)
  },
  "setBasicFilter": {
    object (SetBasicFilterRequest)
  },
  "addProtectedRange": {
    object (AddProtectedRangeRequest)
  },
  "updateProtectedRange": {
    object (UpdateProtectedRangeRequest)
  },
  "deleteProtectedRange": {
    object (DeleteProtectedRangeRequest)
  },
  "autoResizeDimensions": {
    object (AutoResizeDimensionsRequest)
  },
  "addChart": {
    object (AddChartRequest)
  },
  "updateChartSpec": {
    object (UpdateChartSpecRequest)
  },
  "updateBanding": {
    object (UpdateBandingRequest)
  },
  "addBanding": {
    object (AddBandingRequest)
  },
  "deleteBanding": {
    object (DeleteBandingRequest)
  },
  "createDeveloperMetadata": {
    object (CreateDeveloperMetadataRequest)
  },
  "updateDeveloperMetadata": {
    object (UpdateDeveloperMetadataRequest)
  },
  "deleteDeveloperMetadata": {
    object (DeleteDeveloperMetadataRequest)
  },
  "randomizeRange": {
    object (RandomizeRangeRequest)
  },
  "addDimensionGroup": {
    object (AddDimensionGroupRequest)
  },
  "deleteDimensionGroup": {
    object (DeleteDimensionGroupRequest)
  },
  "updateDimensionGroup": {
    object (UpdateDimensionGroupRequest)
  },
  "trimWhitespace": {
    object (TrimWhitespaceRequest)
  },
  "deleteDuplicates": {
    object (DeleteDuplicatesRequest)
  },
  "updateEmbeddedObjectBorder": {
    object (UpdateEmbeddedObjectBorderRequest)
  },
  "addSlicer": {
    object (AddSlicerRequest)
  },
  "updateSlicerSpec": {
    object (UpdateSlicerSpecRequest)
  },
  "addDataSource": {
    object (AddDataSourceRequest)
  },
  "updateDataSource": {
    object (UpdateDataSourceRequest)
  },
  "deleteDataSource": {
    object (DeleteDataSourceRequest)
  },
  "refreshDataSource": {
    object (RefreshDataSourceRequest)
  },
  "cancelDataSourceRefresh": {
    object (CancelDataSourceRefreshRequest)
  }
  // End of list of possible types for union field kind.
}
Поля
kind поля Союза. Тип обновления. Требуется ровно одно поле. kind может быть только одним из следующих:
updateSpreadsheetProperties

object ( UpdateSpreadsheetPropertiesRequest )

Обновляет свойства электронной таблицы.

updateSheetProperties

object ( UpdateSheetPropertiesRequest )

Обновляет свойства листа.

updateDimensionProperties

object ( UpdateDimensionPropertiesRequest )

Обновляет свойства размеров.

updateNamedRange

object ( UpdateNamedRangeRequest )

Обновляет именованный диапазон.

repeatCell

object ( RepeatCellRequest )

Повторяет одну ячейку в диапазоне.

addNamedRange

object ( AddNamedRangeRequest )

Добавляет именованный диапазон.

deleteNamedRange

object ( DeleteNamedRangeRequest )

Удаляет именованный диапазон.

addSheet

object ( AddSheetRequest )

Добавляет лист.

deleteSheet

object ( DeleteSheetRequest )

Удаляет лист.

autoFill

object ( AutoFillRequest )

Автоматически заполняет дополнительные данные на основе существующих данных.

cutPaste

object ( CutPasteRequest )

Вырезает данные из одной области и вставляет их в другую.

copyPaste

object ( CopyPasteRequest )

Копирует данные из одной области и вставляет их в другую.

mergeCells

object ( MergeCellsRequest )

Объединяет ячейки вместе.

unmergeCells

object ( UnmergeCellsRequest )

Разъединяет объединенные ячейки.

updateBorders

object ( UpdateBordersRequest )

Обновляет границы диапазона ячеек.

updateCells

object ( UpdateCellsRequest )

Обновляет множество ячеек одновременно.

addFilterView

object ( AddFilterViewRequest )

Добавляет представление фильтра.

appendCells

object ( AppendCellsRequest )

Добавляет ячейки после последней строки с данными на листе.

clearBasicFilter

object ( ClearBasicFilterRequest )

Очищает базовый фильтр на листе.

deleteDimension

object ( DeleteDimensionRequest )

Удаляет строки или столбцы на листе.

deleteEmbeddedObject

object ( DeleteEmbeddedObjectRequest )

Удаляет внедренный объект (например, диаграмму, изображение) на листе.

deleteFilterView

object ( DeleteFilterViewRequest )

Удаляет представление фильтра с листа.

duplicateFilterView

object ( DuplicateFilterViewRequest )

Дублирует представление фильтра.

duplicateSheet

object ( DuplicateSheetRequest )

Дублирует лист.

findReplace

object ( FindReplaceRequest )

Находит и заменяет вхождения некоторого текста другим текстом.

insertDimension

object ( InsertDimensionRequest )

Вставляет новые строки или столбцы в лист.

insertRange

object ( InsertRangeRequest )

Вставляет новые ячейки в лист, сдвигая существующие ячейки.

moveDimension

object ( MoveDimensionRequest )

Перемещает строки или столбцы в другое место на листе.

updateEmbeddedObjectPosition

object ( UpdateEmbeddedObjectPositionRequest )

Обновляет положение встроенного объекта (например, диаграммы, изображения).

pasteData

object ( PasteDataRequest )

Вставляет данные (HTML или с разделителями) на лист.

textToColumns

object ( TextToColumnsRequest )

Преобразует столбец текста во множество столбцов текста.

updateFilterView

object ( UpdateFilterViewRequest )

Обновляет свойства представления фильтра.

deleteRange

object ( DeleteRangeRequest )

Удаляет диапазон ячеек с листа, сдвигая оставшиеся ячейки.

appendDimension

object ( AppendDimensionRequest )

Добавляет размеры в конец листа.

addConditionalFormatRule

object ( AddConditionalFormatRuleRequest )

Добавляет новое правило условного форматирования.

updateConditionalFormatRule

object ( UpdateConditionalFormatRuleRequest )

Обновляет существующее правило условного форматирования.

deleteConditionalFormatRule

object ( DeleteConditionalFormatRuleRequest )

Удаляет существующее правило условного форматирования.

sortRange

object ( SortRangeRequest )

Сортирует данные в диапазоне.

setDataValidation

object ( SetDataValidationRequest )

Устанавливает проверку данных для одной или нескольких ячеек.

setBasicFilter

object ( SetBasicFilterRequest )

Устанавливает базовый фильтр на листе.

addProtectedRange

object ( AddProtectedRangeRequest )

Добавляет защищенный диапазон.

updateProtectedRange

object ( UpdateProtectedRangeRequest )

Обновляет защищенный диапазон.

deleteProtectedRange

object ( DeleteProtectedRangeRequest )

Удаляет защищенный диапазон.

autoResizeDimensions

object ( AutoResizeDimensionsRequest )

Автоматически изменяет размеры одного или нескольких измерений в зависимости от содержимого ячеек в этом измерении.

addChart

object ( AddChartRequest )

Добавляет диаграмму.

updateChartSpec

object ( UpdateChartSpecRequest )

Обновляет характеристики диаграммы.

updateBanding

object ( UpdateBandingRequest )

Обновляет полосатый диапазон

addBanding

object ( AddBandingRequest )

Добавляет новый полосатый диапазон

deleteBanding

object ( DeleteBandingRequest )

Удаляет полосатый диапазон

createDeveloperMetadata

object ( CreateDeveloperMetadataRequest )

Создает новые метаданные разработчика

updateDeveloperMetadata

object ( UpdateDeveloperMetadataRequest )

Обновляет существующую запись метаданных разработчика.

deleteDeveloperMetadata

object ( DeleteDeveloperMetadataRequest )

Удаляет метаданные разработчика

randomizeRange

object ( RandomizeRangeRequest )

Рандомизирует порядок строк в диапазоне.

addDimensionGroup

object ( AddDimensionGroupRequest )

Создает группу в указанном диапазоне.

deleteDimensionGroup

object ( DeleteDimensionGroupRequest )

Удаляет группу в указанном диапазоне.

updateDimensionGroup

object ( UpdateDimensionGroupRequest )

Обновляет состояние указанной группы.

trimWhitespace

object ( TrimWhitespaceRequest )

Обрезает ячейки пробелов (например, пробелов, табуляции или новых строк).

deleteDuplicates

object ( DeleteDuplicatesRequest )

Удаляет строки, содержащие повторяющиеся значения в указанных столбцах диапазона ячеек.

updateEmbeddedObjectBorder

object ( UpdateEmbeddedObjectBorderRequest )

Обновляет границу внедренного объекта.

addSlicer

object ( AddSlicerRequest )

Добавляет слайсер.

updateSlicerSpec

object ( UpdateSlicerSpecRequest )

Обновляет характеристики среза.

addDataSource

object ( AddDataSourceRequest )

Добавляет источник данных.

updateDataSource

object ( UpdateDataSourceRequest )

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

deleteDataSource

object ( DeleteDataSourceRequest )

Удаляет источник данных.

refreshDataSource

object ( RefreshDataSourceRequest )

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

cancelDataSourceRefresh

object ( CancelDataSourceRefreshRequest )

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

Запрос свойств обновленной таблицы

Обновляет свойства электронной таблицы.

JSON-представление
{
  "properties": {
    object (SpreadsheetProperties)
  },
  "fields": string
}
Поля
properties

object ( SpreadsheetProperties )

Свойства для обновления.

fields

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневые «свойства» подразумеваются и не должны указываться. Одиночный символ "*" может использоваться как сокращение для перечисления каждого поля.

Запрос свойств обновления листа

Обновляет свойства листа с указанным sheetId .

JSON-представление
{
  "properties": {
    object (SheetProperties)
  },
  "fields": string
}
Поля
properties

object ( SheetProperties )

Свойства для обновления.

fields

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневые properties подразумеваются и не должны указываться. Одиночный символ "*" может использоваться как сокращение для перечисления каждого поля.

Запрос UpdateDimensionPropertiesRequest

Обновляет свойства размеров в указанном диапазоне.

JSON-представление
{
  "properties": {
    object (DimensionProperties)
  },
  "fields": string,

  // Union field dimension_range can be only one of the following:
  "range": {
    object (DimensionRange)
  },
  "dataSourceSheetRange": {
    object (DataSourceSheetDimensionRange)
  }
  // End of list of possible types for union field dimension_range.
}
Поля
properties

object ( DimensionProperties )

Свойства для обновления.

fields

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневые properties подразумеваются и не должны указываться. Одиночный символ "*" может использоваться как сокращение для перечисления каждого поля.

Поле объединения dimension_range . Размерный ряд. dimension_range может быть только одним из следующих:
range

object ( DimensionRange )

Строки или столбцы для обновления.

dataSourceSheetRange

object ( DataSourceSheetDimensionRange )

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

DataSourceSheetDimensionRange

Диапазон по одному измерению на листе DATA_SOURCE .

JSON-представление
{
  "sheetId": integer,
  "columnReferences": [
    {
      object (DataSourceColumnReference)
    }
  ]
}
Поля
sheetId

integer

Идентификатор листа источника данных, в котором находится диапазон.

columnReferences[]

object ( DataSourceColumnReference )

Столбцы на листе источника данных.

UpdateNamedRangeRequest

Обновляет свойства именованного диапазона с указанным namedRangeId .

JSON-представление
{
  "namedRange": {
    object (NamedRange)
  },
  "fields": string
}
Поля
namedRange

object ( NamedRange )

Именованный диапазон для обновления новыми свойствами.

fields

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой namedRange подразумевается и не должен указываться. Одиночный символ "*" может использоваться как сокращение для перечисления каждого поля.

Повторить запрос ячейки

Обновляет все ячейки диапазона до значений в данном объекте Cell. Обновляются только поля, перечисленные в поле fields ; другие без изменений.

При написании ячейки с формулой диапазоны формулы будут автоматически увеличиваться для каждого поля в диапазоне. Например, если записать ячейку с формулой =A1 в диапазон B2:C4, B2 будет =A1 , B3 будет =A2 , B4 будет =A3 , C2 будет =B1 , C3 будет =B2 , C4 будет =B3 .

Чтобы диапазоны формулы оставались статичными, используйте индикатор $ . Например, используйте формулу =$A$1 чтобы предотвратить увеличение строки и столбца.

JSON-представление
{
  "range": {
    object (GridRange)
  },
  "cell": {
    object (CellData)
  },
  "fields": string
}
Поля
range

object ( GridRange )

Диапазон повторения ячейки.

cell

object ( CellData )

Данные для записи.

fields

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневая cell подразумевается и не должна указываться. Одиночный символ "*" может использоваться как сокращение для перечисления каждого поля.

Адднамедранжерекуест

Добавляет именованный диапазон в электронную таблицу.

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

object ( NamedRange )

Именованный диапазон, который требуется добавить. Поле namedRangeId является необязательным; если он не установлен, идентификатор будет сгенерирован случайным образом. (Указание идентификатора уже существующего диапазона является ошибкой.)

Делетенамедранжерекуест

Удаляет именованный диапазон с заданным идентификатором из электронной таблицы.

JSON-представление
{
  "namedRangeId": string
}
Поля
namedRangeId

string

Идентификатор именованного диапазона, который необходимо удалить.

Аддлистрекуест

Добавляет новый лист. Когда лист добавляется по заданному индексу, индексы всех последующих листов увеличиваются. Чтобы добавить лист объекта, используйте вместо него AddChartRequest и укажите EmbeddedObjectPosition.sheetId или EmbeddedObjectPosition.newSheet .

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

object ( SheetProperties )

Свойства, которыми должен обладать новый лист. Все свойства являются необязательными. Поле sheetId является необязательным; если он не установлен, идентификатор будет сгенерирован случайным образом. (Указание идентификатора уже существующего листа является ошибкой.)

Удалитьлистрекуест

Удаляет запрошенный лист.

JSON-представление
{
  "sheetId": integer
}
Поля
sheetId

integer

Идентификатор листа, который необходимо удалить.

Если лист имеет тип DATA_SOURCE , связанный с ним DataSource также удаляется.

Запрос автозаполнения

Заполняет дополнительные данные на основе существующих данных.

JSON-представление
{
  "useAlternateSeries": boolean,

  // Union field area can be only one of the following:
  "range": {
    object (GridRange)
  },
  "sourceAndDestination": {
    object (SourceAndDestination)
  }
  // End of list of possible types for union field area.
}
Поля
useAlternateSeries

boolean

Верно, если нам нужно генерировать данные с «альтернативным» рядом. Это зависит от типа и объема исходных данных.

area поля Союза. Область для автозаполнения. area может быть только одной из следующих:
range

object ( GridRange )

Диапазон для автозаполнения. Это проверит диапазон и определит местоположение, в котором есть данные, и автоматически заполнит этими данными остальную часть диапазона.

sourceAndDestination

object ( SourceAndDestination )

Области источника и назначения для автозаполнения. Здесь явно указан источник автозаполнения и место расширения этих данных.

ИсточникиDestination

Сочетание исходного диапазона и способа расширения этого источника.

JSON-представление
{
  "source": {
    object (GridRange)
  },
  "dimension": enum (Dimension),
  "fillLength": integer
}
Поля
source

object ( GridRange )

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

dimension

enum ( Dimension )

Измерение, в которое должны быть заполнены данные.

fillLength

integer

Количество строк или столбцов, в которые должны быть заполнены данные. Положительные числа выходят за пределы последней строки или последнего столбца источника. Отрицательные числа раскрываются перед первой строкой или первым столбцом источника.

ВырезатьВставитьЗапрос

Перемещает данные из источника в место назначения.

JSON-представление
{
  "source": {
    object (GridRange)
  },
  "destination": {
    object (GridCoordinate)
  },
  "pasteType": enum (PasteType)
}
Поля
source

object ( GridRange )

Исходные данные для вырезания.

destination

object ( GridCoordinate )

Верхняя левая координата, куда следует вставить данные.

pasteType

enum ( PasteType )

Какие данные вставлять. Все исходные данные будут вырезаны, независимо от того, что вставлено.

Пастетип

Какие данные следует вставить.

Перечисления
PASTE_NORMAL Вставка значений, формул, форматов и слияний.
PASTE_VALUES Вставляйте значения ТОЛЬКО без форматирования, формул и слияний.
PASTE_FORMAT Вставьте только формат и проверку данных.
PASTE_NO_BORDERS Как PASTE_NORMAL , но без границ.
PASTE_FORMULA Вставьте только формулы.
PASTE_DATA_VALIDATION Вставьте только проверку данных.
PASTE_CONDITIONAL_FORMATTING Вставьте только правила условного форматирования.

КопироватьВставитьЗапрос

Копирует данные из источника в место назначения.

JSON-представление
{
  "source": {
    object (GridRange)
  },
  "destination": {
    object (GridRange)
  },
  "pasteType": enum (PasteType),
  "pasteOrientation": enum (PasteOrientation)
}
Поля
source

object ( GridRange )

Исходный диапазон для копирования.

destination

object ( GridRange )

Место для вставки. Если диапазон охватывает диапазон, кратный высоте или ширине источника, данные будут повторяться для заполнения целевого диапазона. Если диапазон меньше исходного диапазона, все исходные данные все равно будут скопированы (за пределами целевого диапазона).

pasteType

enum ( PasteType )

Какие данные вставлять.

pasteOrientation

enum ( PasteOrientation )

Как эти данные должны быть ориентированы при вставке.

ВставитьОриентация

Как должна выполняться операция вставки.

Перечисления
NORMAL Вставьте нормально.
TRANSPOSE Вставка транспонированной, при которой все строки становятся столбцами и наоборот.

Запрос слияния ячеек

Объединяет все ячейки диапазона.

JSON-представление
{
  "range": {
    object (GridRange)
  },
  "mergeType": enum (MergeType)
}
Поля
range

object ( GridRange )

Диапазон ячеек для объединения.

mergeType

enum ( MergeType )

Как ячейки должны быть объединены.

Тип слияния

Тип создаваемого слияния.

Перечисления
MERGE_ALL Создать одно слияние из диапазона
MERGE_COLUMNS Создайте слияние для каждого столбца в диапазоне.
MERGE_ROWS Создайте слияние для каждой строки в диапазоне.

UnmergeCellsRequest

Разъединяет ячейки в заданном диапазоне.

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

object ( GridRange )

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

Запрос обновления границ

Обновляет границы диапазона. Если поле не задано в запросе, это означает, что граница остается без изменений. Например, с двумя последующими UpdateBordersRequest:

  1. диапазон: A1:A5 { top: RED, bottom: WHITE }
  2. диапазон: A1:A5 { left: BLUE }

Это приведет к тому, что A1:A5 будет иметь границы { top: RED, bottom: WHITE, left: BLUE } . Если вы хотите очистить границу, явно установите стиль NONE .

JSON-представление
{
  "range": {
    object (GridRange)
  },
  "top": {
    object (Border)
  },
  "bottom": {
    object (Border)
  },
  "left": {
    object (Border)
  },
  "right": {
    object (Border)
  },
  "innerHorizontal": {
    object (Border)
  },
  "innerVertical": {
    object (Border)
  }
}
Поля
range

object ( GridRange )

Диапазон, границы которого следует обновить.

top

object ( Border )

Граница, которую необходимо разместить в верхней части диапазона.

bottom

object ( Border )

Граница, которую необходимо разместить внизу диапазона.

left

object ( Border )

Граница, которую необходимо разместить слева от диапазона.

right

object ( Border )

Граница, которую необходимо разместить справа от диапазона.

innerHorizontal

object ( Border )

Горизонтальная граница, помещаемая в диапазон.

innerVertical

object ( Border )

Вертикальная граница, которую необходимо поместить в диапазон.

UpdateCellsRequest

Обновляет все ячейки диапазона новыми данными.

JSON-представление
{
  "rows": [
    {
      object (RowData)
    }
  ],
  "fields": string,

  // Union field area can be only one of the following:
  "start": {
    object (GridCoordinate)
  },
  "range": {
    object (GridRange)
  }
  // End of list of possible types for union field area.
}
Поля
rows[]

object ( RowData )

Данные для записи.

fields

string ( FieldMask format)

Поля CellData, которые следует обновить. Должно быть указано хотя бы одно поле. Корень — это CellData; 'строка.значения'. не следует указывать. Одиночный символ "*" может использоваться как сокращение для перечисления каждого поля.

area поля Союза. Данные о местоположении должны быть записаны. Должно быть установлено ровно одно значение. area может быть только одной из следующих:
start

object ( GridCoordinate )

Координата, с которой начинается запись данных. Можно записать любое количество строк и столбцов (в том числе разное количество столбцов в строке).

range

object ( GridRange )

Диапазон, в который будут записываться данные.

Если данные в строках не охватывают весь запрошенный диапазон, поля, соответствующие заданным в fields будут очищены.

Аддфильтрвиевреквест

Добавляет представление фильтра.

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

object ( FilterView )

Фильтр, который нужно добавить. Поле filterViewId является необязательным; если он не установлен, идентификатор будет сгенерирован случайным образом. (Указание идентификатора уже существующего фильтра является ошибкой.)

Аппендселлсреквест

Добавляет новые ячейки после последней строки с данными на листе, при необходимости вставляя в лист новые строки.

JSON-представление
{
  "sheetId": integer,
  "rows": [
    {
      object (RowData)
    }
  ],
  "fields": string
}
Поля
sheetId

integer

Идентификатор листа, к которому нужно добавить данные.

rows[]

object ( RowData )

Данные для добавления.

fields

string ( FieldMask format)

Поля CellData, которые следует обновить. Должно быть указано хотя бы одно поле. Корень — это CellData; 'строка.значения'. не следует указывать. Одиночный символ "*" может использоваться как сокращение для перечисления каждого поля.

ClearBasicFilterRequest

Очищает базовый фильтр, если таковой имеется на листе.

JSON-представление
{
  "sheetId": integer
}
Поля
sheetId

integer

Идентификатор листа, на котором необходимо очистить базовый фильтр.

Удалитьдименсионрекуест

Удаляет размеры с листа.

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

object ( DimensionRange )

Размеры, которые необходимо удалить с листа.

УдалитьEmbeddedObjectRequest

Удаляет внедренный объект с заданным идентификатором.

JSON-представление
{
  "objectId": integer
}
Поля
objectId

integer

Идентификатор внедренного объекта, который необходимо удалить.

Удалитьфильтрвиевреквест

Удаляет определенный вид фильтра.

JSON-представление
{
  "filterId": integer
}
Поля
filterId

integer

Идентификатор фильтра, который нужно удалить.

ДубликатФильтерПросмотрЗапрос

Дублирует определенное представление фильтра.

JSON-представление
{
  "filterId": integer
}
Поля
filterId

integer

Идентификатор дублируемого фильтра.

Запрос дубликата листа

Дублирует содержимое листа.

JSON-представление
{
  "sourceSheetId": integer,
  "insertSheetIndex": integer,
  "newSheetId": integer,
  "newSheetName": string
}
Поля
sourceSheetId

integer

Лист для дублирования.

Если исходный лист имеет тип DATA_SOURCE , его резервный DataSource также дублируется и связывается с новой копией листа. Выполнение данных не запускается, данные сетки этого листа также копируются, но доступны только после завершения пакетного запроса.

insertSheetIndex

integer

Индекс, отсчитываемый от нуля, куда следует вставить новый лист. Индекс всех листов после этого увеличивается.

newSheetId

integer

Если установлено, идентификатор нового листа. Если не установлено, выбирается идентификатор. Если этот идентификатор установлен, он не должен конфликтовать с любым существующим идентификатором листа. Если установлено, оно должно быть неотрицательным.

newSheetName

string

Имя нового листа. Если пусто, вам будет выбрано новое имя.

НайтиЗаменитьЗапрос

Находит и заменяет данные в ячейках в диапазоне, на листе или на всех листах.

JSON-представление
{
  "find": string,
  "replacement": string,
  "matchCase": boolean,
  "matchEntireCell": boolean,
  "searchByRegex": boolean,
  "includeFormulas": boolean,

  // Union field scope can be only one of the following:
  "range": {
    object (GridRange)
  },
  "sheetId": integer,
  "allSheets": boolean
  // End of list of possible types for union field scope.
}
Поля
find

string

Значение для поиска.

replacement

string

Значение, используемое в качестве замены.

matchCase

boolean

True, если поиск чувствителен к регистру.

matchEntireCell

boolean

Истинно, если искомое значение должно соответствовать всей ячейке.

searchByRegex

boolean

Истинно, если искомое значение является регулярным выражением. Регулярное выражение и замена должны соответствовать правилам регулярных выражений Java по адресу https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html . Строка замены может ссылаться на группы захвата. Например, если одна ячейка имеет содержимое "Google Sheets" , а другая — "Google Docs" , то поиск "o.* (.*)" с заменой "$1 Rocks" изменит содержимое ячеек на "GSheets Rocks" и "GDocs Rocks" соответственно.

includeFormulas

boolean

True, если поиск должен включать ячейки с формулами. Значение false для пропуска ячеек с формулами.

scope поля Union. Область поиска/замены — должна быть установлена ​​одна и только одна. scope может быть только одной из следующих:
range

object ( GridRange )

Диапазон поиска/замены.

sheetId

integer

Лист для поиска/замены.

allSheets

boolean

Верно для поиска/замены на всех листах.

Инсертдименсионрекуест

Вставляет строки или столбцы в лист по определенному индексу.

JSON-представление
{
  "range": {
    object (DimensionRange)
  },
  "inheritFromBefore": boolean
}
Поля
range

object ( DimensionRange )

Размеры для вставки. И начальный, и конечный индексы должны быть ограничены.

inheritFromBefore

boolean

Должны ли свойства размера распространяться на размеры до или после вновь вставленных размеров. Значение true для наследования от предыдущих измерений (в этом случае начальный индекс должен быть больше 0) и значение false для наследования от последующих измерений.

Например, если индекс строки 0 имеет красный фон, а индекс строки 1 — зеленый фон, то вставка двух строк в индекс 1 может наследовать либо зеленый, либо красный фон. Если inheritFromBefore имеет значение true, две новые строки будут красными (поскольку строка до точки вставки была красной), тогда как если inheritFromBefore имеет значение false, две новые строки будут зелеными (поскольку строка после точки вставки была зеленой).

Инсертанжерекуест

Вставляет ячейки в диапазон, сдвигая существующие ячейки вверх или вниз.

JSON-представление
{
  "range": {
    object (GridRange)
  },
  "shiftDimension": enum (Dimension)
}
Поля
range

object ( GridRange )

Диапазон, в который нужно вставить новые ячейки.

shiftDimension

enum ( Dimension )

Размер, который будет смещен при вставке ячеек. Если ROWS , существующие ячейки будут сдвинуты вниз. Если COLUMNS , существующие ячейки будут сдвинуты вправо.

MoveDimensionRequest

Перемещает одну или несколько строк или столбцов.

JSON-представление
{
  "source": {
    object (DimensionRange)
  },
  "destinationIndex": integer
}
Поля
source

object ( DimensionRange )

Исходные размеры для перемещения.

destinationIndex

integer

Начальный индекс, отсчитываемый от нуля, указывающий, куда переместить исходные данные, на основе координат до удаления исходных данных из сетки. Существующие данные будут сдвинуты вниз или вправо (в зависимости от измерения), чтобы освободить место для перемещенных измерений. Исходные измерения удаляются из сетки, поэтому данные могут оказаться в индексе, отличном от указанного.

Например, если A1..A5 имеет значения 0, 1, 2, 3, 4 и требуется переместить "1" и "2" между "3" и "4" , источником будет ROWS [1..3) , а целевой индекс будет "4" (индекс строки 5, отсчитываемый от нуля). Конечным результатом будет A1..A5 со значениями 0, 3, 1, 2, 4 .

UpdateEmbeddedObjectPositionRequest

Обновите положение внедренного объекта (например, переместив или изменив размер диаграммы или изображения).

JSON-представление
{
  "objectId": integer,
  "newPosition": {
    object (EmbeddedObjectPosition)
  },
  "fields": string
}
Поля
objectId

integer

Идентификатор объекта, который необходимо переместить.

newPosition

object ( EmbeddedObjectPosition )

Явное положение для перемещения внедренного объекта. Если установлен newPosition.sheetId , будет создан новый лист с этим идентификатором. Если для newPosition.newSheet установлено значение true, будет создан новый лист с выбранным вами идентификатором.

fields

string ( FieldMask format)

Поля OverlayPosition , которые должны обновляться при установке новой позиции. Используется только в том случае, если установлен newPosition.overlayPosition , и в этом случае необходимо указать хотя бы одно поле. Корневой newPosition.overlayPosition подразумевается и не должен указываться. Одиночный символ "*" может использоваться как сокращение для перечисления каждого поля.

Вставить запрос данных

Вставляет данные в электронную таблицу, начиная с указанной координаты.

JSON-представление
{
  "coordinate": {
    object (GridCoordinate)
  },
  "data": string,
  "type": enum (PasteType),

  // Union field kind can be only one of the following:
  "delimiter": string,
  "html": boolean
  // End of list of possible types for union field kind.
}
Поля
coordinate

object ( GridCoordinate )

Координата, с которой данные должны начать вставляться.

data

string

Данные для вставки.

type

enum ( PasteType )

Как данные должны быть вставлены.

kind поля Союза. Как интерпретировать данные, необходимо установить ровно одно значение. kind может быть только одним из следующих:
delimiter

string

Разделитель в данных.

html

boolean

Истинно, если данные представлены в формате HTML.

TextToColumnsRequest

Разбивает столбец текста на несколько столбцов на основе разделителя в каждой ячейке.

JSON-представление
{
  "source": {
    object (GridRange)
  },
  "delimiter": string,
  "delimiterType": enum (DelimiterType)
}
Поля
source

object ( GridRange )

Диапазон исходных данных. Это должно охватывать ровно один столбец.

delimiter

string

Разделитель, который нужно использовать. Используется только в том случае, если delimiterType имеет CUSTOM .

delimiterType

enum ( DelimiterType )

Тип разделителя, который нужно использовать.

Тип разделителя

Разделитель для разделения.

Перечисления
DELIMITER_TYPE_UNSPECIFIED Значение по умолчанию. Это значение нельзя использовать.
COMMA ","
SEMICOLON ";"
PERIOD "."
SPACE " "
CUSTOM Пользовательское значение, определенное в разделителе.
AUTODETECT Автоматическое определение столбцов.

ОбновлениеФильтрПросмотрЗапрос

Обновляет свойства представления фильтра.

JSON-представление
{
  "filter": {
    object (FilterView)
  },
  "fields": string
}
Поля
filter

object ( FilterView )

Новые свойства представления фильтра.

fields

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой filter подразумевается и не должен указываться. Одиночный символ "*" может использоваться как сокращение для перечисления каждого поля.

УдалитьRangeRequest

Удаляет диапазон ячеек, перемещая другие ячейки в удаленную область.

JSON-представление
{
  "range": {
    object (GridRange)
  },
  "shiftDimension": enum (Dimension)
}
Поля
range

object ( GridRange )

Диапазон ячеек, которые необходимо удалить.

shiftDimension

enum ( Dimension )

Измерение, на которое будут заменены удаленные ячейки. Если ROWS , существующие ячейки будут сдвинуты вверх, чтобы заменить удаленные ячейки. Если COLUMNS , существующие ячейки будут сдвинуты влево, чтобы заменить удаленные ячейки.

Аппенддименсионреквест

Добавляет строки или столбцы в конец листа.

JSON-представление
{
  "sheetId": integer,
  "dimension": enum (Dimension),
  "length": integer
}
Поля
sheetId

integer

Лист, к которому добавляются строки или столбцы.

dimension

enum ( Dimension )

Следует ли добавлять строки или столбцы.

length

integer

Количество строк или столбцов для добавления.

Аддкондиционалформатрулерекуест

Добавляет новое правило условного форматирования по заданному индексу. Индексы всех последующих правил увеличиваются.

JSON-представление
{
  "rule": {
    object (ConditionalFormatRule)
  },
  "index": integer
}
Поля
rule

object ( ConditionalFormatRule )

Правило, которое нужно добавить.

index

integer

Индекс, отсчитываемый от нуля, в который следует вставить правило.

UpdateConditionalFormatRuleRequest

Обновляет правило условного форматирования по данному индексу или перемещает правило условного форматирования в другой индекс.

JSON-представление
{
  "index": integer,
  "sheetId": integer,

  // Union field instruction can be only one of the following:
  "rule": {
    object (ConditionalFormatRule)
  },
  "newIndex": integer
  // End of list of possible types for union field instruction.
}
Поля
index

integer

Отсчитываемый от нуля индекс правила, которое следует заменить или переместить.

sheetId

integer

Лист с правилом перемещения. Требуется, если установлен newIndex , в противном случае не используется.

Полевая instruction Союза. Такое обновление должно произойти. instruction может быть только одной из следующих:
rule

object ( ConditionalFormatRule )

Правило, которое должно заменить правило по данному индексу.

newIndex

integer

Новый индекс, отсчитываемый от нуля, которому должно соответствовать правило.

Удалитькондиционалформатрулерекуест

Удаляет правило условного форматирования по заданному индексу. Индексы всех последующих правил уменьшаются.

JSON-представление
{
  "index": integer,
  "sheetId": integer
}
Поля
index

integer

Отсчитываемый от нуля индекс правила, которое необходимо удалить.

sheetId

integer

Лист, из которого удаляется правило.

SortRangeRequest

Сортирует данные в строках на основе порядка сортировки каждого столбца.

JSON-представление
{
  "range": {
    object (GridRange)
  },
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ]
}
Поля
range

object ( GridRange )

Диапазон сортировки.

sortSpecs[]

object ( SortSpec )

Порядок сортировки по столбцу. Более поздние спецификации используются, когда значения в более ранних спецификациях равны.

SetDataValidationRequest

Устанавливает правило проверки данных для каждой ячейки диапазона. Чтобы очистить проверку в диапазоне, вызовите это без указания правила.

JSON-представление
{
  "range": {
    object (GridRange)
  },
  "rule": {
    object (DataValidationRule)
  }
}
Поля
range

object ( GridRange )

Диапазон, к которому должно применяться правило проверки данных.

rule

object ( DataValidationRule )

Правило проверки данных, которое необходимо установить для каждой ячейки в диапазоне, или оставить пустым, чтобы отменить проверку данных в диапазоне.

SetBasicFilterRequest

Устанавливает базовый фильтр, связанный с листом.

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

object ( BasicFilter )

Фильтр, который нужно установить.

Аддпротектедранжерекуест

Добавляет новый защищенный диапазон.

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

object ( ProtectedRange )

Защищенный диапазон, который необходимо добавить. Поле protectedRangeId является необязательным; если он не установлен, идентификатор будет сгенерирован случайным образом. (Указание идентификатора уже существующего диапазона является ошибкой.)

ОбновлениеProtectedRangeRequest

Обновляет существующий защищенный диапазон с указанным protectedRangeId .

JSON-представление
{
  "protectedRange": {
    object (ProtectedRange)
  },
  "fields": string
}
Поля
protectedRange

object ( ProtectedRange )

Защищенный диапазон для обновления новыми свойствами.

fields

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой protectedRange подразумевается и не должен указываться. Для обозначения каждого поля можно использовать одиночный символ "*" .

Удалитьпротектедранжерекуест

Удаляет защищенный диапазон с указанным идентификатором.

JSON-представление
{
  "protectedRangeId": integer
}
Поля
protectedRangeId

integer

Идентификатор защищенного диапазона, который необходимо удалить.

Запрос AutoResizeDimensionsRequest

Автоматически изменяет размеры одного или нескольких измерений в зависимости от содержимого ячеек в этом измерении.

JSON-представление
{

  // Union field dimension_range can be only one of the following:
  "dimensions": {
    object (DimensionRange)
  },
  "dataSourceSheetDimensions": {
    object (DataSourceSheetDimensionRange)
  }
  // End of list of possible types for union field dimension_range.
}
Поля
Поле объединения dimension_range . Размерный ряд. dimension_range может быть только одним из следующих:
dimensions

object ( DimensionRange )

Размеры для автоматического изменения размера.

dataSourceSheetDimensions

object ( DataSourceSheetDimensionRange )

Размеры на листе источника данных для автоматического изменения размера.

Аддчартреквест

Добавляет диаграмму на лист электронной таблицы.

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

object ( EmbeddedChart )

Диаграмма, которую следует добавить в электронную таблицу, включая место, где ее следует разместить. chartId является необязательным; если он не установлен, идентификатор будет сгенерирован случайным образом. (Указание идентификатора внедренного объекта, который уже существует, является ошибкой.)

ОбновлениеChartSpecRequest

Обновляет характеристики диаграммы. (Это не приводит к перемещению или изменению размера диаграммы. Чтобы переместить или изменить размер диаграммы, используйте UpdateEmbeddedObjectPositionRequest .)

JSON-представление
{
  "chartId": integer,
  "spec": {
    object (ChartSpec)
  }
}
Поля
chartId

integer

Идентификатор диаграммы, которую необходимо обновить.

spec

object ( ChartSpec )

Спецификация, применяемая к диаграмме.

ОбновлениеBandingRequest

Обновляет свойства предоставленного полосатого диапазона.

JSON-представление
{
  "bandedRange": {
    object (BandedRange)
  },
  "fields": string
}
Поля
bandedRange

object ( BandedRange )

Полосатый диапазон для обновления новыми свойствами.

fields

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой bandedRange подразумевается и не должен указываться. Одиночный символ "*" может использоваться как сокращение для перечисления каждого поля.

AddBandingRequest

Добавляет в таблицу новый полосатый диапазон.

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

object ( BandedRange )

Добавляемый полосатый диапазон. bandedRangeId является необязательным; если он не установлен, идентификатор будет сгенерирован случайным образом. (Указание идентификатора уже существующего диапазона является ошибкой.)

Удалить BandingRequest

Удаляет диапазон с заданным идентификатором из электронной таблицы.

JSON-представление
{
  "bandedRangeId": integer
}
Поля
bandedRangeId

integer

Идентификатор полосатого диапазона, который необходимо удалить.

CreateDeveloperMetadataRequest

Запрос на создание метаданных разработчика.

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

object ( DeveloperMetadata )

Метаданные разработчика, которые нужно создать.

Запрос обновления метаданных разработчика

Запрос на обновление свойств метаданных разработчика. Обновляет свойства метаданных разработчика, выбранные фильтрами, до значений, предоставленных в ресурсе DeveloperMetadata . Вызывающая сторона должна указать свойства, которые они хотят обновить, в параметре полей, а также указать хотя бы один DataFilter , соответствующий метаданным, которые они хотят обновить.

JSON-представление
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "developerMetadata": {
    object (DeveloperMetadata)
  },
  "fields": string
}
Поля
dataFilters[]

object ( DataFilter )

Фильтры, соответствующие записям метаданных разработчика, которые необходимо обновить.

developerMetadata

object ( DeveloperMetadata )

Значение, до которого будут обновлены все метаданные, соответствующие фильтрам данных.

fields

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой developerMetadata подразумевается и не должен указываться. Одиночный символ "*" может использоваться как сокращение для перечисления каждого поля.

Удалить девелоперметаданныезапрос

Запрос на удаление метаданных разработчика.

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

object ( DataFilter )

Фильтр данных, описывающий критерии, используемые для выбора записи метаданных разработчика для удаления.

Рандомизироватьдиапазонзапрос

Рандомизирует порядок строк в диапазоне.

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

object ( GridRange )

Диапазон рандомизации.

Запрос AddDimensionGroupRequest

Создает группу в указанном диапазоне.

Если запрошенный диапазон является расширенным набором диапазона существующей группы G, то глубина G увеличивается, и эта новая группа G' имеет глубину этой группы. Например, группа [C:D, глубина 1] + [B:E] приводит к созданию групп [B:E, глубина 1] и [C:D, глубина 2]. Если запрошенный диапазон является подмножеством диапазона существующей группы G, то глубина новой группы G' становится на единицу больше глубины G. Например, группа [B:E, глубина 1] + [C :D] приводит к группам [B:E, глубина 1] и [C:D, глубина 2]. Если запрошенный диапазон начинается до и заканчивается внутри или начинается внутри и заканчивается после диапазона существующей группы G, то диапазон существующей группы G становится объединением диапазонов, а новая группа G' имеет глубину на единицу большую. чем глубина G и диапазон как пересечение диапазонов. Например, группа [B:D, глубина 1] + [C:E] приводит к созданию групп [B:E, глубина 1] и [C:D, глубина 2].

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

object ( DimensionRange )

Диапазон, в котором создается группа.

Удалитьдименсионгруппреквест

Удаляет группу в указанном диапазоне, уменьшая глубину размеров в диапазоне.

Например, предположим, что на листе есть группа глубины 1 над B:E и группа глубины 2 над C:D. При удалении группы над D:E на листе остается группа глубины 1 над B:D и группа глубины 2 над C:C.

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

object ( DimensionRange )

Диапазон удаляемой группы.

Запрос UpdateDimensionGroupRequest

Обновляет состояние указанной группы.

JSON-представление
{
  "dimensionGroup": {
    object (DimensionGroup)
  },
  "fields": string
}
Поля
dimensionGroup

object ( DimensionGroup )

Группа, состояние которой должно быть обновлено. Диапазон и глубина группы должны указывать действительную группу на листе, а все остальные поля обновляться.

fields

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневая dimensionGroup подразумевается и не должна указываться. Одиночный символ "*" может использоваться как сокращение для перечисления каждого поля.

TrimWhitespaceRequest

Обрезает пробелы (например, пробелы, табуляции или новые строки) в каждой ячейке в указанном диапазоне. Этот запрос удаляет все пробелы в начале и конце текста каждой ячейки и уменьшает любую последовательность оставшихся символов пробелов до одного пробела. Если полученный обрезанный текст начинается с символа «+» или «=", текст остается строковым значением и не интерпретируется как формула.

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

object ( GridRange )

Диапазон, ячейки которого необходимо обрезать.

Запрос удаления дубликатов

Удаляет строки в этом диапазоне, содержащие значения в указанных столбцах, которые являются дубликатами значений в любой предыдущей строке. Строки с одинаковыми значениями, но разным регистром букв, форматированием или формулами считаются повторяющимися.

Этот запрос также удаляет повторяющиеся строки, скрытые от просмотра (например, из-за фильтра). При удалении дубликатов первый экземпляр каждой повторяющейся строки, просматриваемый сверху вниз, сохраняется в результирующем диапазоне. Содержимое за пределами указанного диапазона не удаляется, а строки, считающиеся повторяющимися, не обязательно должны находиться рядом друг с другом в диапазоне.

JSON-представление
{
  "range": {
    object (GridRange)
  },
  "comparisonColumns": [
    {
      object (DimensionRange)
    }
  ]
}
Поля
range

object ( GridRange )

Диапазон, из которого удаляются повторяющиеся строки.

comparisonColumns[]

object ( DimensionRange )

Столбцы в диапазоне для анализа на наличие повторяющихся значений. Если ни один столбец не выбран, все столбцы анализируются на наличие дубликатов.

UpdateEmbeddedObjectBorderRequest

Обновляет свойство границы внедренного объекта.

JSON-представление
{
  "objectId": integer,
  "border": {
    object (EmbeddedObjectBorder)
  },
  "fields": string
}
Поля
objectId

integer

Идентификатор внедренного объекта, который необходимо обновить.

border

object ( EmbeddedObjectBorder )

Граница, применяемая к внедренному объекту.

fields

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневая border подразумевается и не должна указываться. Одиночный символ "*" может использоваться как сокращение для перечисления каждого поля.

Добавить слайсерреквест

Добавляет срез на лист электронной таблицы.

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

object ( Slicer )

Срез, который следует добавить в электронную таблицу, включая позицию, в которой его следует разместить. Поле slicerId является необязательным; если он не установлен, идентификатор будет сгенерирован случайным образом. (Указание идентификатора уже существующего среза является ошибкой.)

ОбновлениеSlicerSpecRequest

Обновляет характеристики среза. (Это не перемещает и не изменяет размер среза. Чтобы переместить или изменить размер среза, используйте UpdateEmbeddedObjectPositionRequest .

JSON-представление
{
  "slicerId": integer,
  "spec": {
    object (SlicerSpec)
  },
  "fields": string
}
Поля
slicerId

integer

Идентификатор среза, который необходимо обновить.

spec

object ( SlicerSpec )

Спецификация, применяемая к срезу.

fields

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой SlicerSpec подразумевается и не должен указываться. Один "*"` может использоваться как сокращение для перечисления каждого поля.

Адддатасаурцерекуест

Добавляет источник данных. После успешного добавления источника данных создается связанный лист DATA_SOURCE и запускается выполнение обновления листа для чтения данных из источника данных.

Для запроса требуется дополнительная область OAuth bigquery.readonly , если вы добавляете источник данных BigQuery.

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

object ( DataSource )

Источник данных, который нужно добавить.

Запрос обновления источника данных

Обновляет источник данных. После успешного обновления источника данных запускается выполнение обновления связанного листа DATA_SOURCE для чтения данных из обновленного источника данных.

Для запроса требуется дополнительная область OAuth bigquery.readonly , если вы обновляете источник данных BigQuery.

JSON-представление
{
  "dataSource": {
    object (DataSource)
  },
  "fields": string
}
Поля
dataSource

object ( DataSource )

Источник данных для обновления.

fields

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой dataSource подразумевается и не должен указываться. Одиночный символ "*" может использоваться как сокращение для перечисления каждого поля.

УдалитьDataSourceRequest

Удаляет источник данных. Запрос также удаляет связанный лист источника данных и отключает все связанные объекты источника данных.

JSON-представление
{
  "dataSourceId": string
}
Поля
dataSourceId

string

Идентификатор источника данных, который требуется удалить.

Обновить запрос источника данных

Обновляет один или несколько объектов источника данных в электронной таблице по указанным ссылкам.

Для запроса требуется дополнительная область OAuth bigquery.readonly , если вы обновляете источник данных BigQuery.

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

JSON-представление
{
  "force": boolean,

  // Union field target can be only one of the following:
  "references": {
    object (DataSourceObjectReferences)
  },
  "dataSourceId": string,
  "isAll": boolean
  // End of list of possible types for union field target.
}
Поля
force

boolean

Обновляет объекты источника данных независимо от текущего состояния. Если этот параметр не установлен и объект источника данных, на который ссылаются, находился в состоянии ошибки, обновление завершится сбоем немедленно.

target Союза. Указывает, что обновить. target может быть только одно из следующих:
references

object ( DataSourceObjectReferences )

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

dataSourceId

string

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

isAll

boolean

Обновляет все существующие объекты источников данных в электронной таблице.

Ссылки на DataSourceObjectReferences

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

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

object ( DataSourceObjectReference )

Ссылки.

ОтменаDataSourceRefreshRequest

Отменяет одно или несколько обновлений объектов источника данных в электронной таблице по указанным ссылкам.

Для запроса требуется дополнительная область OAuth bigquery.readonly если вы отменяете обновление источника данных BigQuery.

JSON-представление
{

  // Union field target can be only one of the following:
  "references": {
    object (DataSourceObjectReferences)
  },
  "dataSourceId": string,
  "isAll": boolean
  // End of list of possible types for union field target.
}
Поля
target Союза. Указывает, что отменить. target может быть только одно из следующих:
references

object ( DataSourceObjectReferences )

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

dataSourceId

string

Ссылка на DataSource . Если указано, отменяет все связанные обновления объекта источника данных для этого источника данных.

isAll

boolean

Отменяет все существующие обновления объектов источников данных для всех источников данных в электронной таблице.