Лист
Лист в электронной таблице.
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 | Истинно, если лист является листом RTL, а не листом LTR. |
dataSourceSheetProperties | Только вывод. Если присутствует, поле содержит свойства, специфичные для листа |
Тип листа
Вид листа.
Перечисления | |
---|---|
SHEET_TYPE_UNSPECIFIED | Значение по умолчанию, не использовать. |
GRID | Лист представляет собой сетку. |
OBJECT | На листе нет сетки, вместо нее отображается объект, например диаграмма или изображение. |
DATA_SOURCE | Лист подключается к внешнему DataSource и отображает предварительный просмотр данных. |
Свойства сетки
Свойства сетки.
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, если переключатель управления группировкой столбцов отображается после группы. |
DataSourceSheetСвойства
Дополнительные свойства листа 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[] | Метаданные о запрошенных столбцах в сетке, начиная со столбца в |
ДанныеСтроки
Данные о каждой ячейке в строке.
JSON-представление |
---|
{
"values": [
{
object ( |
Поля | |
---|---|
values[] | Значения в строке, по одному в каждом столбце. |
РазмерСвойства
Свойства измерения.
JSON-представление |
---|
{ "hiddenByFilter": boolean, "hiddenByUser": boolean, "pixelSize": integer, "developerMetadata": [ { object ( |
Поля | |
---|---|
pixelSize | Высота (если строка) или ширина (если столбец) измерения в пикселях. |
developerMetadata[] | Метаданные разработчика, связанные с одной строкой или столбцом. |
dataSourceColumnReference | Только вывод. Если установлено, это столбец в листе источника данных. |
ПравилоУсловногоФормата
Правило, описывающее условный формат.
JSON-представление |
---|
{ "ranges": [ { object ( |
Поля | |
---|---|
ranges[] | Диапазоны, которые форматируются, если условие истинно. Все диапазоны должны быть на одной сетке. |
rule поля объединения. Правило, управляющее этим условным форматом, должно быть установлено ровно одно. rule может быть только одним из следующих: | |
booleanRule | Форматирование либо «включено», либо «выключено» в зависимости от правила. |
gradientRule | Форматирование будет меняться в зависимости от градиентов в правиле. |
Логическое правило
Правило, которое может сработать или не сработать в зависимости от условия.
JSON-представление |
---|
{ "condition": { object ( |
Поля | |
---|---|
condition | Условие правила. Если условие оценивается как истинное, формат применяется. |
format | Применяемый формат. Условное форматирование может применять только подмножество форматирования: |
GradientRule
Правило, которое применяет формат шкалы градиентного цвета на основе перечисленных точек интерполяции. Формат ячейки будет меняться в зависимости от ее содержимого по сравнению со значениями точек интерполяции.
JSON-представление |
---|
{ "minpoint": { object ( |
Поля | |
---|---|
minpoint | Начальная точка интерполяции. |
midpoint | Необязательная промежуточная точка интерполяции. |
maxpoint | Конечная точка интерполяции. |
ИнтерполяцияPoint
Единая точка интерполяции в условном формате градиента. Они закрепляют цветовую шкалу градиента в соответствии с выбранным цветом, типом и значением.
JSON-представление |
---|
{ "color": { object ( |
Поля | |
---|---|
color | Цвет, который должна использовать эта точка интерполяции. Устарело: используйте |
colorStyle | Цвет, который должна использовать эта точка интерполяции. Если также задан |
type | Как следует интерпретировать значение. |
value | Значение, используемое этой точкой интерполяции. Может быть формулой. Не используется, если |
ТипТочкиИнтерполяции
Вид точки интерполяции.
Перечисления | |
---|---|
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[] | Критерии фильтра для отображения/скрытия значений по столбцам. В ответах заполняются как |
ProtectedRange
Защищенный ареал.
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 | Свойства для полос столбцов. Эти свойства применяются по принципу «столбец за столбцом» для всех столбцов в диапазоне. Необходимо указать хотя бы одно из свойств |
BandingСвойства
Свойства, ссылающиеся на одно измерение (строку или столбец). Если заданы оба свойства 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[] | Свойства столбца таблицы. |
TableRowsСвойства
Свойства строки таблицы.
JSON-представление |
---|
{ "headerColorStyle": { object ( |
Поля | |
---|---|
headerColorStyle | Цвет строки заголовка. Если это поле задано, строка заголовка заполняется указанным цветом. В противном случае строка заголовка заполняется цветом по умолчанию. |
firstBandColorStyle | Первый цвет, который чередуется. Если это поле задано, первая полосатая строка заполняется указанным цветом. В противном случае первая полосатая строка заполняется цветом по умолчанию. |
secondBandColorStyle | Второй цвет, который чередуется. Если это поле задано, вторая полосатая строка заполняется указанным цветом. В противном случае вторая полосатая строка заполняется цветом по умолчанию. |
footerColorStyle | Цвет последней строки. Если это поле не задано, нижний колонтитул не добавляется, последняя строка заполняется |
Свойства столбцов таблицы
Столбец таблицы.
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 | Тип столбца чипа рейтинга |
Правило проверки данных столбца таблицы
Правило проверки данных для столбца в таблице.
JSON-представление |
---|
{
"condition": {
object ( |
Поля | |
---|---|
condition | Условие, что данные в ячейке должны совпадать. Действительно только если [BooleanCondition.type] — ONE_OF_LIST. |