Лист
Лист в электронной таблице.
| JSON-представление |
|---|
{ "properties": { object ( |
| Поля | |
|---|---|
properties | Свойства листа. |
data[] | Данные в таблице, если это табличный лист. Количество возвращаемых объектов GridData зависит от количества запрошенных диапазонов на этом листе. Например, если это лист Для листа |
merges[] | Диапазоны, которые объединяются. |
conditionalFormats[] | Правила условного форматирования в этом листе. |
filterViews[] | Представления фильтров в этом листе. |
protectedRanges[] | Защищенные участки указаны в этом листе. |
basicFilter | Фильтр на этом листе, если таковой имеется. |
charts[] | Технические характеристики каждой диаграммы на этом листе. |
bandedRanges[] | На этом листе представлены полосы (чередующиеся цвета). |
developerMetadata[] | Метаданные разработчика, связанные с листом. |
rowGroups[] | Все группы строк на этом листе упорядочены по возрастанию начального индекса диапазона, а затем по глубине группы. |
columnGroups[] | Все группы столбцов на этом листе упорядочены по возрастанию начального индекса диапазона, а затем по глубине группы. |
slicers[] | На этом листе расположены слайсеры. |
tables[] | Таблицы на этом листе. |
Свойства листа
Свойства листа.
| JSON-представление |
|---|
{ "sheetId": integer, "title": string, "index": integer, "sheetType": enum ( |
| Поля | |
|---|---|
sheetId | Идентификатор листа. Должно быть неотрицательным. После установки значение в этом поле изменить нельзя. |
title | Название листа. |
index | Индекс листа в электронной таблице. При добавлении или обновлении свойств листа, если это поле исключено, лист добавляется или перемещается в конец списка листов. При обновлении индексов листов или вставке листов перемещение учитывается в индексах «до перемещения». Например, если есть три листа (S1, S2, S3), то для перемещения S1 вперед S2 индекс необходимо установить равным 2. Запрос на обновление индекса листа игнорируется, если запрашиваемый индекс идентичен текущему индексу листа или если запрашиваемый новый индекс равен текущему индексу листа + 1. |
sheetType | Тип листа. По умолчанию — |
gridProperties | Дополнительные свойства листа, если этот лист является сеткой. (Если лист является объектным, содержащим диаграмму или изображение, то это поле будет отсутствовать.) При записи некорректно задавать какие-либо свойства сетки на листах, не являющихся сеткой. Если этот лист является листом |
tabColor | Цвет вкладки в пользовательском интерфейсе. Устарело: используйте |
tabColorStyle | Цвет вкладки в пользовательском интерфейсе. Если также задан параметр |
rightToLeft | Возвращает true, если лист имеет формат RTL (справа налево), а не LTR (слева направо). |
dataSourceSheetProperties | Только для вывода. Если поле присутствует, оно содержит свойства, специфичные для листа |
Тип листа
Тип простыни.
| Перечисления | |
|---|---|
SHEET_TYPE_UNSPECIFIED | Значение по умолчанию, не использовать. |
GRID | Лист представляет собой сетку. |
OBJECT | В таблице нет сетки, вместо этого она содержит объект, например, диаграмму или изображение. |
DATA_SOURCE | Этот лист подключается к внешнему DataSource и отображает предварительный просмотр данных. |
GridProperties
Свойства сетки.
| JSON-представление |
|---|
{ "rowCount": integer, "columnCount": integer, "frozenRowCount": integer, "frozenColumnCount": integer, "hideGridlines": boolean, "rowGroupControlAfter": boolean, "columnGroupControlAfter": boolean } |
| Поля | |
|---|---|
rowCount | Количество строк в сетке. |
columnCount | Количество столбцов в сетке. |
frozenRowCount | Количество строк, зафиксированных в сетке. |
frozenColumnCount | Количество столбцов, зафиксированных в сетке. |
hideGridlines | Возвращает true, если в пользовательском интерфейсе не отображаются линии сетки. |
rowGroupControlAfter | Значение true, если переключатель управления группировкой строк отображается после группы. |
columnGroupControlAfter | Значение true, если переключатель управления группировкой столбцов отображается после группы. |
DataSourceSheetProperties
Дополнительные свойства листа DATA_SOURCE .
| JSON-представление |
|---|
{ "dataSourceId": string, "columns": [ { object ( |
| Поля | |
|---|---|
dataSourceId | Идентификатор источника |
columns[] | Столбцы, отображаемые на листе, соответствуют значениям в |
dataExecutionStatus | Статус выполнения данных. |
GridData
Данные в таблице, а также метаданные об измерениях.
| JSON-представление |
|---|
{ "startRow": integer, "startColumn": integer, "rowData": [ { object ( |
| Поля | |
|---|---|
startRow | Первая строка, на которую ссылается этот GridData, начинается с нуля. |
startColumn | В данном GridData указан первый столбец, нумерация которых начинается с нуля. |
rowData[] | Данные в таблице, по одной записи в каждой строке, начиная со строки в переменной startRow. Значения в переменной RowData будут соответствовать столбцам, начиная со |
rowMetadata[] | Метаданные о запрошенных строках в сетке, начиная со строки в |
columnMetadata[] | Метаданные о запрошенных столбцах в таблице, начиная со столбца в |
RowData
Данные о каждой ячейке в строке.
| JSON-представление |
|---|
{
"values": [
{
object ( |
| Поля | |
|---|---|
values[] | Значения в строке, по одному в каждом столбце. |
DimensionProperties
Свойства, относящиеся к измерению.
| JSON-представление |
|---|
{ "hiddenByFilter": boolean, "hiddenByUser": boolean, "pixelSize": integer, "developerMetadata": [ { object ( |
| Поля | |
|---|---|
pixelSize | Высота (если это строка) или ширина (если это столбец) измерения в пикселях. |
developerMetadata[] | Метаданные разработчика, связанные с отдельной строкой или столбцом. |
dataSourceColumnReference | Только для вывода. Если задано, это столбец в листе источника данных. |
ConditionalFormatRule
Правило, описывающее условное форматирование.
| JSON-представление |
|---|
{ "ranges": [ { object ( |
| Поля | |
|---|---|
ranges[] | Диапазоны, форматируемые при выполнении условия. Все диапазоны должны находиться в одной сетке. |
rule объединения полей. Правило, управляющее этим условным форматированием, должно быть установлено ровно одно. rule может быть только одним из следующих: | |
booleanRule | Форматирование либо включено, либо выключено в соответствии с правилом. |
gradientRule | Форматирование будет меняться в зависимости от градиентов в разметке. |
Логическое правило
Правило, которое может совпадать, а может и не совпадать в зависимости от условий.
| JSON-представление |
|---|
{ "condition": { object ( |
| Поля | |
|---|---|
condition | Условие правила. Если условие истинно, применяется указанный формат. |
format | Применяемый формат. Условное форматирование может применять только подмножество форматирования: |
GradientRule
Правило, применяющее градиентную цветовую шкалу на основе указанных точек интерполяции. Формат ячейки будет меняться в зависимости от её содержимого и значений точек интерполяции.
| JSON-представление |
|---|
{ "minpoint": { object ( |
| Поля | |
|---|---|
minpoint | Начальная точка интерполяции. |
midpoint | Дополнительная промежуточная точка интерполяции. |
maxpoint | Последняя точка интерполяции. |
Точка интерполяции
Отдельная точка интерполяции в условном формате градиента. Эти точки фиксируют цветовую шкалу градиента в соответствии с выбранным цветом, типом и значением.
| JSON-представление |
|---|
{ "color": { object ( |
| Поля | |
|---|---|
color | Цвет, который должна использовать эта точка интерполяции. Устарело: используйте |
colorStyle | Цвет, который должна использовать эта точка интерполяции. Если |
type | Как следует интерпретировать это значение. |
value | Значение, используемое в данной точке интерполяции. Может быть формулой. Не используется, если |
InterpolationPointType
Тип точки интерполяции.
| Перечисления | |
|---|---|
INTERPOLATION_POINT_TYPE_UNSPECIFIED | Значение по умолчанию не использовать. |
MIN | В качестве точки интерполяции используется минимальное значение в ячейках в диапазоне условного формата. |
MAX | В качестве точки интерполяции используется максимальное значение в ячейках в диапазоне условного формата. |
NUMBER | Точка интерполяции использует в точности значение из InterpolationPoint.value . |
PERCENT | Точка интерполяции — это заданный процент по всем ячейкам в диапазоне условного формата. Это эквивалентно |
PERCENTILE | Точка интерполяции — это заданный процентиль по всем ячейкам в диапазоне условного формата. Это эквивалентно NUMBER , если значение было: =PERCENTILE(FLATTEN(range), value / 100) (где ошибки в диапазоне игнорируются при сглаживании). |
ФильтрВид
Представление с фильтрами. Дополнительную информацию см. в разделе «Управление видимостью данных с помощью фильтров» .
| JSON-представление |
|---|
{ "filterViewId": integer, "title": string, "range": { object ( |
| Поля | |
|---|---|
filterViewId | Идентификатор представления фильтра. |
title | Название представления фильтра. |
range | Диапазон, охватываемый данным фильтром. При записи можно задать только один из параметров: |
namedRangeId | Укажите именованный диапазон, на который опирается данный фильтр, если таковой имеется. При записи можно задать только один из параметров: |
tableId | Если таковая имеется, то какой таблицей поддерживается данный фильтр. При записи можно задать только один из параметров: |
sortSpecs[] | Порядок сортировки по столбцам. При равенстве значений в предыдущих параметрах используются более поздние значения. |
criteria | Критерии для отображения/скрытия значений по столбцам. Ключом карты является индекс столбца, а значением — критерий для этого столбца. Это поле устарело и заменено на |
filterSpecs[] | Критерии фильтрации для отображения или скрытия значений в каждом столбце. В ответах заполняются как |
Защищенный полигон
Охраняемая территория.
| JSON-представление |
|---|
{ "protectedRangeId": integer, "range": { object ( |
| Поля | |
|---|---|
protectedRangeId | Идентификатор защищаемого диапазона. Это поле доступно только для чтения. |
range | Диапазон, который подлежит защите. Диапазон может быть полностью неограниченным, в этом случае он считается защищаемым листом. При записи можно задать только один из параметров: |
namedRangeId | Указанный диапазон, которым поддерживается данный охраняемый диапазон, если таковой имеется. При записи можно задать только один из параметров: |
tableId | Таблица, на которую распространяется действие данного защищенного диапазона, если таковая имеется. При записи можно задать только один из параметров: |
description | Описание данной охраняемой территории. |
warningOnly | Значение true указывает на то, что при редактировании защищаемого диапазона будет отображаться предупреждение. Защита на основе предупреждений означает, что каждый пользователь может редактировать данные в защищаемом диапазоне, за исключением случаев, когда при редактировании будет появляться предупреждение с просьбой подтвердить редактирование. При написании: если это поле имеет значение true, то |
requestingUserCanEdit | Значение true указывает, что пользователь, запросивший защищаемый диапазон, может редактировать защищаемую область. Это поле доступно только для чтения. |
unprotectedRanges[] | Список незащищенных диапазонов внутри защищенного листа. Незащищенные диапазоны поддерживаются только на защищенных листах. |
editors | Пользователи и группы, имеющие доступ к редактированию защищенного диапазона. Это поле видно только пользователям, имеющим доступ к редактированию защищенного диапазона и документа. Редакторы не поддерживаются при использовании защиты |
Редакторы
Редакторы охраняемой территории.
| JSON-представление |
|---|
{ "users": [ string ], "groups": [ string ], "domainUsersCanEdit": boolean } |
| Поля | |
|---|---|
users[] | Адреса электронной почты пользователей, имеющих права на редактирование защищенного диапазона. |
groups[] | Адреса электронной почты групп, имеющих права на редактирование защищенного диапазона. |
domainUsersCanEdit | Значение true, если у любого пользователя в домене документа есть права на редактирование защищаемого диапазона. Защита домена поддерживается только для документов, находящихся в пределах домена. |
Базовый фильтр
Фильтр по умолчанию, связанный с листом. Дополнительную информацию см. в разделе «Управление видимостью данных с помощью фильтров» .
| JSON-представление |
|---|
{ "range": { object ( |
| Поля | |
|---|---|
range | Диапазон действия фильтра. |
tableId | Если таковая имеется, укажите таблицу, на основе которой работает этот фильтр. При записи можно задать только один из параметров: |
sortSpecs[] | Порядок сортировки по столбцам. При равенстве значений в предыдущих параметрах используются более поздние значения. |
criteria | Критерии для отображения/скрытия значений по столбцам. Ключом карты является индекс столбца, а значением — критерий для этого столбца. Это поле устарело и заменено на |
filterSpecs[] | Критерии фильтрации для каждого столбца. В ответах заполняются как |
BandedRange
На листе представлена полосатая (чередующаяся) цветовая гамма.
| JSON-представление |
|---|
{ "bandedRangeId": integer, "bandedRangeReference": string, "range": { object ( |
| Поля | |
|---|---|
bandedRangeId | Идентификатор диапазона, ограниченного полосами. Если не задан, обратитесь к параметру |
bandedRangeReference | Только для вывода. Ссылка на диапазон полос, используемая для идентификации идентификатора, который не поддерживается параметром |
range | Диапазон, в котором применяются эти свойства. |
rowProperties | Свойства для полос строк. Эти свойства применяются построчно ко всем строкам в диапазоне. Необходимо указать хотя бы одно из |
columnProperties | Свойства для полос столбцов. Эти свойства применяются к каждому столбцу отдельно для всех столбцов в диапазоне. Необходимо указать хотя бы одно из |
BandingProperties
Свойства относятся к одному измерению (строке или столбцу). Если заданы параметры BandedRange.row_properties и BandedRange.column_properties , цвета заливки ячеек применяются в соответствии со следующими правилами:
-
headerColorиfooterColorимеют приоритет над цветами полос. -
firstBandColorимеет приоритет надsecondBandColor. -
rowPropertiesимеет приоритет надcolumnProperties.
Например, цвет первой строки имеет приоритет над цветом первого столбца, но цвет первого столбца имеет приоритет над цветом второй строки. Аналогично, заголовок строки имеет приоритет над заголовком столбца в ячейке в верхнем левом углу, но заголовок столбца имеет приоритет над цветом первой строки, если заголовок строки не задан.
| JSON-представление |
|---|
{ "headerColor": { object ( |
| Поля | |
|---|---|
headerColor | Цвет первой строки или столбца. Если это поле задано, первая строка или столбец заполняется этим цветом, и цвета чередуются между |
headerColorStyle | Цвет первой строки или столбца. Если это поле задано, первая строка или столбец заполняется этим цветом, и цвета чередуются между |
firstBandColor | Первый чередующийся цвет. (Обязательно) Устарело: используйте |
firstBandColorStyle | Первый чередующийся цвет. (Обязательно) Если также задан параметр |
secondBandColor | Второй чередующийся цвет. (Обязательно) Устарело: используйте |
secondBandColorStyle | Второй чередующийся цвет. (Обязательно) Если также задан параметр |
footerColor | Цвет последней строки или столбца. Если это поле не задано, последняя строка или столбец заполняется либо цветом |
footerColorStyle | Цвет последней строки или столбца. Если это поле не задано, последняя строка или столбец заполняется либо цветом |
DimensionGroup
Группа, расположенная на листе в интервале строк или столбцов, может содержать другие группы или быть включена в другие группы. Группа может быть свернута или развернута как единое целое на листе.
| JSON-представление |
|---|
{
"range": {
object ( |
| Поля | |
|---|---|
range | Ареал распространения этой группы. |
depth | Глубина группы, показывающая, сколько групп имеют диапазон, который полностью содержит диапазон данной группы. |
collapsed | Это поле истинно, если данная группа свернута. Свернутая группа остается свернутой, если расширяется перекрывающаяся группа на меньшей глубине. Значение true не означает, что все измерения в группе скрыты, поскольку видимость измерения может изменяться независимо от этого свойства группы. Однако при обновлении этого свойства все измерения в группе становятся скрытыми, если это поле имеет значение true, или видимыми, если это поле имеет значение false. |
Слайсер
Слайсер в листе.
| JSON-представление |
|---|
{ "slicerId": integer, "spec": { object ( |
| Поля | |
|---|---|
slicerId | Идентификатор среза. |
spec | Технические характеристики слайсера. |
position | Положение слайсера. Обратите внимание, что слайсер можно разместить только на существующем листе. Кроме того, ширина и высота слайсера могут автоматически регулироваться, чтобы оставаться в допустимых пределах. |
SlicerSpec
Технические характеристики слайсера.
| JSON-представление |
|---|
{ "dataRange": { object ( |
| Поля | |
|---|---|
dataRange | Диапазон данных среза. |
filterCriteria | Критерии фильтрации среза. |
columnIndex | Индекс столбца в таблице данных, к которой применяется фильтр, начинающийся с нуля. |
applyToPivotTables | Значение True, если фильтр должен применяться к сводным таблицам. Если значение не задано, по умолчанию используется |
title | Название слайсера. |
textFormat | Формат текста заголовка в срезе. Поле ссылки не поддерживается. |
backgroundColor | Цвет фона элемента управления. Устарело: используйте |
backgroundColorStyle | Цвет фона среза. Если |
horizontalAlignment | Горизонтальное выравнивание заголовка в срезе. Если не указано, по умолчанию используется выравнивание по |
Стол
Стол.
| JSON-представление |
|---|
{ "tableId": string, "name": string, "range": { object ( |
| Поля | |
|---|---|
tableId | Идентификатор таблицы. |
name | Название таблицы. Оно уникально для всех таблиц в одной и той же электронной таблице. |
range | Диапазон цен на столы. |
rowsProperties | Свойства строк таблицы. |
columnProperties[] | Свойства столбцов таблицы. |
TableRowsProperties
Свойства строк таблицы.
| JSON-представление |
|---|
{ "headerColorStyle": { object ( |
| Поля | |
|---|---|
headerColorStyle | Цвет строки заголовка. Если это поле задано, строка заголовка заполняется указанным цветом. В противном случае строка заголовка заполняется цветом по умолчанию. |
firstBandColorStyle | Первый чередующийся цвет. Если это поле задано, первая полосатая строка заполняется указанным цветом. В противном случае первая полосатая строка заполняется цветом по умолчанию. |
secondBandColorStyle | Второй чередующийся цвет. Если это поле задано, вторая полосатая строка заполняется указанным цветом. В противном случае вторая полосатая строка заполняется цветом по умолчанию. |
footerColorStyle | Цвет последней строки. Если это поле не задано, нижний колонтитул не добавляется, последняя строка заполняется либо цветом |
TableColumnProperties
Столбец таблицы.
| JSON-представление |
|---|
{ "columnIndex": integer, "columnName": string, "columnType": enum ( |
| Поля | |
|---|---|
columnIndex | Индекс столбца, начинающийся с 0. Этот индекс является относительным и зависит от положения столбца в таблице, и не обязательно совпадает с индексом столбца на листе. |
columnName | Название столбца. |
columnType | Тип столбца. |
dataValidationRule | Правило проверки данных столбца. Устанавливается только для столбцов типа «Выпадающий список». |
Тип столбца
Тип столбца для заданного столбца в таблице.
| Перечисления | |
|---|---|
COLUMN_TYPE_UNSPECIFIED | Тип столбца не указан. |
DOUBLE | Тип столбца с числом. |
CURRENCY | Тип столбца валюты. |
PERCENT | Тип столбца: проценты. |
DATE | Тип столбца «Дата». |
TIME | Тип столбца времени. |
DATE_TIME | Тип столбца даты и времени. |
TEXT | Тип текстового столбца. |
BOOLEAN | Логический тип столбца. |
DROPDOWN | Тип столбца выпадающего списка. |
FILES_CHIP | Тип столбца чипа файлов |
PEOPLE_CHIP | Тип колонки с чипами для людей |
FINANCE_CHIP | Тип колонки финансовых чипов |
PLACE_CHIP | Тип колонки с чипами для размещения |
RATINGS_CHIP | Тип колонки с рейтинговыми чипами |
Правило проверки данных таблицы TableColumnData
Правило проверки данных для столбца в таблице.
| JSON-представление |
|---|
{
"condition": {
object ( |
| Поля | |
|---|---|
condition | Условие, которому должны соответствовать данные в ячейке. Действительно только если [BooleanCondition.type] равно ONE_OF_LIST. |