Sheets

Лист

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

JSON-представление 
{
  "properties": {
    object (SheetProperties)
  },
  "data": [
    {
      object (GridData)
    }
  ],
  "merges": [
    {
      object (GridRange)
    }
  ],
  "conditionalFormats": [
    {
      object (ConditionalFormatRule)
    }
  ],
  "filterViews": [
    {
      object (FilterView)
    }
  ],
  "protectedRanges": [
    {
      object (ProtectedRange)
    }
  ],
  "basicFilter": {
    object (BasicFilter)
  },
  "charts": [
    {
      object (EmbeddedChart)
    }
  ],
  "bandedRanges": [
    {
      object (BandedRange)
    }
  ],
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "rowGroups": [
    {
      object (DimensionGroup)
    }
  ],
  "columnGroups": [
    {
      object (DimensionGroup)
    }
  ],
  "slicers": [
    {
      object (Slicer)
    }
  ]
}
Поля
properties

object ( SheetProperties )

Свойства листа.

data[]

object ( GridData )

Данные в сетке, если это сеточный лист.

Количество возвращаемых объектов GridData зависит от количества диапазонов, запрошенных на этом листе. Например, если это представление Sheet1 , и электронная таблица была запрошена с диапазонами Sheet1!A1:C10 и Sheet1!D15:E20 , то первый GridData будет иметь startRow / startColumn со значением 0 , а второй будет иметь startRow 14 ( строка 15 с отсчетом от нуля) и startColumn 3 (столбец D с отсчетом от нуля).

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

merges[]

object ( GridRange )

Диапазоны, которые объединены вместе.

conditionalFormats[]

object ( ConditionalFormatRule )

На этом листе действуют правила условного формата.

filterViews[]

object ( FilterView )

Виды фильтров на этом листе.

protectedRanges[]

object ( ProtectedRange )

Защищенные диапазоны на этом листе.

basicFilter

object ( BasicFilter )

Фильтр на этом листе, если таковой имеется.

charts[]

object ( EmbeddedChart )

Характеристики каждой диаграммы на этом листе.

bandedRanges[]

object ( BandedRange )

На этом листе показаны полосчатые (чередующиеся цвета) диапазоны.

developerMetadata[]

object ( DeveloperMetadata )

Метаданные разработчика, связанные с листом.

rowGroups[]

object ( DimensionGroup )

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

columnGroups[]

object ( DimensionGroup )

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

slicers[]

object ( Slicer )

Срезы на этом листе.

Свойства листа

Свойства листа.

JSON-представление 
{
  "sheetId": integer,
  "title": string,
  "index": integer,
  "sheetType": enum (SheetType),
  "gridProperties": {
    object (GridProperties)
  },
  "hidden": boolean,
  "tabColor": {
    object (Color)
  },
  "tabColorStyle": {
    object (ColorStyle)
  },
  "rightToLeft": boolean,
  "dataSourceSheetProperties": {
    object (DataSourceSheetProperties)
  }
}
Поля
sheetId

integer

Идентификатор листа. Должно быть неотрицательным. Это поле нельзя изменить после установки.

title

string

Имя листа.

index

integer

Индекс листа в электронной таблице. Если при добавлении или обновлении свойств листа это поле исключено, лист добавляется или перемещается в конец списка листов. При обновлении индексов листов или вставке листов перемещение учитывается в индексах «до перемещения». Например, если было три листа (S1, S2, S3), чтобы переместить S1 впереди S2, индекс должен быть установлен на 2. Запрос на обновление индекса листа игнорируется, если запрошенный индекс идентичен текущим листам. индекс или если запрошенный новый индекс равен индексу текущего листа + 1.

sheetType

enum ( SheetType )

Тип листа. По умолчанию GRID . Это поле нельзя изменить после установки.

gridProperties

object ( GridProperties )

Дополнительные свойства листа, если этот лист представляет собой сетку. (Если лист представляет собой объектный лист, содержащий диаграмму или изображение, то это поле будет отсутствовать.) При записи возникает ошибка установки каких-либо свойств сетки на листах без сетки.

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

hidden

boolean

True, если лист скрыт в пользовательском интерфейсе, и false, если он виден.

tabColor
(deprecated)

object ( Color )

Цвет вкладки в пользовательском интерфейсе. Устарело: используйте tabColorStyle .

tabColorStyle

object ( ColorStyle )

Цвет вкладки в пользовательском интерфейсе. Если также задан tabColor , это поле имеет приоритет.

rightToLeft

boolean

Истинно, если лист является листом RTL, а не листом LTR.

dataSourceSheetProperties

object ( DataSourceSheetProperties )

Только вывод. Если оно присутствует, поле содержит свойства, специфичные для листа DATA_SOURCE .

Тип Листа

Вид листа.

Перечисления
SHEET_TYPE_UNSPECIFIED Значение по умолчанию, не использовать.
GRID Лист представляет собой сетку.
OBJECT На листе нет сетки, вместо него имеется объект, например диаграмма или изображение.
DATA_SOURCE Лист подключается к внешнему DataSource и отображает предварительный просмотр данных.

Свойства сетки

Свойства сетки.

JSON-представление 
{
  "rowCount": integer,
  "columnCount": integer,
  "frozenRowCount": integer,
  "frozenColumnCount": integer,
  "hideGridlines": boolean,
  "rowGroupControlAfter": boolean,
  "columnGroupControlAfter": boolean
}
Поля
rowCount

integer

Количество строк в сетке.

columnCount

integer

Количество столбцов в сетке.

frozenRowCount

integer

Количество строк, закрепленных в сетке.

frozenColumnCount

integer

Количество столбцов, замороженных в сетке.

hideGridlines

boolean

True, если сетка не отображает линии сетки в пользовательском интерфейсе.

rowGroupControlAfter

boolean

Истинно, если после группы отображается переключатель управления группировкой строк.

columnGroupControlAfter

boolean

Истинно, если после группы отображается переключатель управления группировкой столбцов.

Свойства листа источника данных

Дополнительные свойства листа DATA_SOURCE .

JSON-представление 
{
  "dataSourceId": string,
  "columns": [
    {
      object (DataSourceColumn)
    }
  ],
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
Поля
dataSourceId

string

Идентификатор DataSource к которому подключен лист.

columns[]

object ( DataSourceColumn )

Столбцы, отображаемые на листе, соответствуют значениям в RowData .

dataExecutionStatus

object ( DataExecutionStatus )

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

Гридданные

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

JSON-представление 
{
  "startRow": integer,
  "startColumn": integer,
  "rowData": [
    {
      object (RowData)
    }
  ],
  "rowMetadata": [
    {
      object (DimensionProperties)
    }
  ],
  "columnMetadata": [
    {
      object (DimensionProperties)
    }
  ]
}
Поля
startRow

integer

Первая строка, на которую ссылается этот GridData, начинается с нуля.

startColumn

integer

Первый столбец, на который ссылается GridData, начинается с нуля.

rowData[]

object ( RowData )

Данные в сетке, по одной записи в каждой строке, начиная со строки в startRow. Значения в RowData будут соответствовать столбцам, начиная с startColumn .

rowMetadata[]

object ( DimensionProperties )

Метаданные о запрошенных строках в сетке, начиная со строки в startRow .

columnMetadata[]

object ( DimensionProperties )

Метаданные о запрошенных столбцах в сетке, начиная со столбца в startColumn .

СтрокаДанные

Данные о каждой ячейке подряд.

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

object ( CellData )

Значения в строке, по одному на столбец.

Свойства размера

Свойства измерения.

JSON-представление 
{
  "hiddenByFilter": boolean,
  "hiddenByUser": boolean,
  "pixelSize": integer,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
}
Поля
hiddenByFilter

boolean

True, если это измерение фильтруется. Это поле доступно только для чтения.

hiddenByUser

boolean

Истинно, если это измерение явно скрыто.

pixelSize

integer

Высота (если строка) или ширина (если столбец) измерения в пикселях.

developerMetadata[]

object ( DeveloperMetadata )

Метаданные разработчика, связанные с одной строкой или столбцом.

dataSourceColumnReference

object ( DataSourceColumnReference )

Только вывод. Если установлено, это столбец на листе источника данных.

Правило условного формата

Правило, описывающее условное форматирование.

JSON-представление 
{
  "ranges": [
    {
      object (GridRange)
    }
  ],

  // Union field rule can be only one of the following:
  "booleanRule": {
    object (BooleanRule)
  },
  "gradientRule": {
    object (GradientRule)
  }
  // End of list of possible types for union field rule.
}
Поля
ranges[]

object ( GridRange )

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

rule поля объединения. Правило, управляющее этим условным форматом, должно быть установлено ровно одно. rule может быть только одним из следующих:
booleanRule

object ( BooleanRule )

В зависимости от правила форматирование либо «включено», либо «выключено».

gradientRule

object ( GradientRule )

Форматирование будет зависеть от градиентов в правиле.

Логическое правило

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

JSON-представление 
{
  "condition": {
    object (BooleanCondition)
  },
  "format": {
    object (CellFormat)
  }
}
Поля
condition

object ( BooleanCondition )

Условие правила. Если условие оценивается как истинное, формат применяется.

format

object ( CellFormat )

Формат применения. При условном форматировании можно применять только подмножество форматирования: bold , italic , strikethrough , foreground color и background color .

ГрадиентПравило

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

JSON-представление 
{
  "minpoint": {
    object (InterpolationPoint)
  },
  "midpoint": {
    object (InterpolationPoint)
  },
  "maxpoint": {
    object (InterpolationPoint)
  }
}
Поля
minpoint

object ( InterpolationPoint )

Начальная точка интерполяции.

midpoint

object ( InterpolationPoint )

Дополнительная промежуточная точка интерполяции.

maxpoint

object ( InterpolationPoint )

Последняя точка интерполяции.

ИнтерполяцияТочка

Одна точка интерполяции в условном формате градиента. Они закрепляют цветовую шкалу градиента в соответствии с выбранным цветом, типом и значением.

JSON-представление 
{
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  },
  "type": enum (InterpolationPointType),
  "value": string
}
Поля
color
(deprecated)

object ( Color )

Цвет, который должна использовать эта точка интерполяции. Устарело: используйте colorStyle .

colorStyle

object ( ColorStyle )

Цвет, который должна использовать эта точка интерполяции. Если также задан color , это поле имеет приоритет.

type

enum ( InterpolationPointType )

Как следует интерпретировать значение.

value

string

Значение, которое использует эта точка интерполяции. Может быть формула. Не используется, если type MIN или MAX .

Тип интерполяцииPointType

Что-то вроде точки интерполяции.

Перечисления
INTERPOLATION_POINT_TYPE_UNSPECIFIED Значение по умолчанию, не использовать.
MIN Точка интерполяции использует минимальное значение в ячейках в диапазоне условного формата.
MAX Точка интерполяции использует максимальное значение в ячейках в диапазоне условного формата.
NUMBER Точка интерполяции использует именно значение в InterpolationPoint.value .
PERCENT

Точкой интерполяции является заданный процент по всем ячейкам диапазона условного формата. Это эквивалентно NUMBER , если значение было: =(MAX(FLATTEN(range)) * (value / 100)) + (MIN(FLATTEN(range)) * (1 - (value / 100))) (где ошибки в диапазон игнорируется при выравнивании).

PERCENTILE Точкой интерполяции является заданный процентиль по всем ячейкам диапазона условного формата. Это эквивалентно NUMBER , если значение было: =PERCENTILE(FLATTEN(range), value / 100) (при этом ошибки в диапазоне игнорируются при выравнивании).

ФильтрПросмотр

Представление фильтра.

JSON-представление 
{
  "filterViewId": integer,
  "title": string,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}
Поля
filterViewId

integer

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

title

string

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

range

object ( GridRange )

Диапазон, охватываемый этим представлением фильтра.

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

namedRangeId

string

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

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

sortSpecs[]

object ( SortSpec )

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

criteria
(deprecated)

map (key: integer, value: object ( FilterCriteria ))

Критерии отображения/скрытия значений для каждого столбца. Ключ карты — это индекс столбца, а значение — это критерий для этого столбца.

Это поле устарело в пользу filterSpecs .

filterSpecs[]

object ( FilterSpec )

Критерии фильтра для отображения/скрытия значений в каждом столбце.

И criteria , и filterSpecs заполняются в ответах. Если в запросе на обновление указаны оба поля, это поле имеет приоритет.

Защищенныйдиапазон

Защищенный диапазон.

JSON-представление 
{
  "protectedRangeId": integer,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "description": string,
  "warningOnly": boolean,
  "requestingUserCanEdit": boolean,
  "unprotectedRanges": [
    {
      object (GridRange)
    }
  ],
  "editors": {
    object (Editors)
  }
}
Поля
protectedRangeId

integer

Идентификатор защищенного диапазона. Это поле доступно только для чтения.

range

object ( GridRange )

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

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

namedRangeId

string

Именованный диапазон, на котором основан этот защищенный диапазон, если таковой имеется.

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

description

string

Описание этого защищенного диапазона.

warningOnly

boolean

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

При написании: если это поле истинно, то editors игнорируются. Кроме того, если это поле изменено с true на false, а поле editors не установлено (и не включено в маску поля), тогда в качестве редакторов будут установлены все редакторы в документе.

requestingUserCanEdit

boolean

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

unprotectedRanges[]

object ( GridRange )

Список незащищенных диапазонов внутри защищенного листа. Незащищенные диапазоны поддерживаются только на защищенных листах.

editors

object ( Editors )

Пользователи и группы с доступом к редактированию защищенного диапазона. Это поле видно только пользователям с доступом к редактированию защищенного диапазона и документа. Редакторы не поддерживаются защитой warningOnly .

Редакторы

Редакторы защищенного диапазона.

JSON-представление 
{
  "users": [
    string
  ],
  "groups": [
    string
  ],
  "domainUsersCanEdit": boolean
}
Поля
users[]

string

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

groups[]

string

Адреса электронной почты групп, имеющих доступ к редактированию защищенного диапазона.

domainUsersCanEdit

boolean

Истинно, если кто-либо в домене документа имеет доступ к редактированию защищенного диапазона. Защита домена поддерживается только для документов внутри домена.

БазовыйФильтр

Фильтр по умолчанию, связанный с листом.

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

object ( GridRange )

Диапазон, охватываемый фильтром.

sortSpecs[]

object ( SortSpec )

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

criteria
(deprecated)

map (key: integer, value: object ( FilterCriteria ))

Критерии отображения/скрытия значений для каждого столбца. Ключ карты — это индекс столбца, а значение — это критерий для этого столбца.

Это поле устарело в пользу filterSpecs .

filterSpecs[]

object ( FilterSpec )

Критерии фильтра для каждого столбца.

И criteria , и filterSpecs заполняются в ответах. Если в запросе на обновление указаны оба поля, это поле имеет приоритет.

BandedRange

Полосатый диапазон (чередующихся цветов) на листе.

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

integer

Идентификатор полосатого диапазона.

range

object ( GridRange )

Диапазон, в котором применяются эти свойства.

rowProperties

object ( BandingProperties )

Свойства полос строк. Эти свойства применяются последовательно ко всем строкам диапазона. Должен быть указан хотя бы один из rowProperties или columnProperties .

columnProperties

object ( BandingProperties )

Свойства полос столбцов. Эти свойства применяются по отдельности ко всем столбцам диапазона. Должен быть указан хотя бы один из rowProperties или columnProperties .

Свойства полосатости

Свойства, относящиеся к одному измерению (строке или столбцу). Если установлены оба BandedRange.row_properties и BandedRange.column_properties , цвета заливки применяются к ячейкам в соответствии со следующими правилами:

Например, цвет первой строки имеет приоритет над цветом первого столбца, но цвет первого столбца имеет приоритет над цветом второй строки. Аналогично, заголовок строки имеет приоритет над заголовком столбца в верхней левой ячейке, но заголовок столбца имеет приоритет над цветом первой строки, если заголовок строки не установлен.

JSON-представление 
{
  "headerColor": {
    object (Color)
  },
  "headerColorStyle": {
    object (ColorStyle)
  },
  "firstBandColor": {
    object (Color)
  },
  "firstBandColorStyle": {
    object (ColorStyle)
  },
  "secondBandColor": {
    object (Color)
  },
  "secondBandColorStyle": {
    object (ColorStyle)
  },
  "footerColor": {
    object (Color)
  },
  "footerColorStyle": {
    object (ColorStyle)
  }
}
Поля
headerColor
(deprecated)

object ( Color )

Цвет первой строки или столбца. Если это поле установлено, первая строка или столбец заполняется этим цветом, а цвета чередуются между firstBandColor и secondBandColor начиная со второй строки или столбца. В противном случае первая строка или столбец заполняется параметром firstBandColor , и цвета продолжают чередоваться, как обычно. Устарело: используйте headerColorStyle .

headerColorStyle

object ( ColorStyle )

Цвет первой строки или столбца. Если это поле установлено, первая строка или столбец заполняется этим цветом, а цвета чередуются между firstBandColor и secondBandColor начиная со второй строки или столбца. В противном случае первая строка или столбец заполняется параметром firstBandColor , и цвета продолжают чередоваться, как обычно. Если также задан headerColor , это поле имеет приоритет.

firstBandColor
(deprecated)

object ( Color )

Первый цвет, который чередуется. (Обязательно) Устарело: используйте firstBandColorStyle .

firstBandColorStyle

object ( ColorStyle )

Первый цвет, который чередуется. (Обязательно) Если также задан firstBandColor , это поле имеет приоритет.

secondBandColor
(deprecated)

object ( Color )

Второй цвет чередующийся. (Обязательно) Устарело: используйте secondBandColorStyle .

secondBandColorStyle

object ( ColorStyle )

Второй цвет чередующийся. (Обязательно) Если также задан secondBandColor , это поле имеет приоритет.

footerColor
(deprecated)

object ( Color )

Цвет последней строки или столбца. Если это поле не установлено, последняя строка или столбец заполняется либо firstBandColor , либо secondBandColor в зависимости от цвета предыдущей строки или столбца. Устарело: используйте footerColorStyle .

footerColorStyle

object ( ColorStyle )

Цвет последней строки или столбца. Если это поле не установлено, последняя строка или столбец заполняется либо firstBandColor , либо secondBandColor в зависимости от цвета предыдущей строки или столбца. Если также установлен footerColor , это поле имеет приоритет.

Группа измерений

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

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

object ( DimensionRange )

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

depth

integer

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

collapsed

boolean

Это поле истинно, если эта группа свернута. Свернутая группа остается свернутой, если перекрывающаяся группа на меньшей глубине расширяется.

Истинное значение не означает, что все измерения внутри группы скрыты, поскольку видимость измерения может меняться независимо от этого свойства группы. Однако при обновлении этого свойства все измерения внутри него становятся скрытыми, если это поле имеет значение true, или становятся видимыми, если это поле имеет значение false.

Слайсер

Слайсер в листе.

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

integer

Идентификатор среза.

spec

object ( SlicerSpec )

Спецификация слайсера.

position

object ( EmbeddedObjectPosition )

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

Спецификация слайсера

Технические характеристики слайсера.

JSON-представление 
{
  "dataRange": {
    object (GridRange)
  },
  "filterCriteria": {
    object (FilterCriteria)
  },
  "columnIndex": integer,
  "applyToPivotTables": boolean,
  "title": string,
  "textFormat": {
    object (TextFormat)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "horizontalAlignment": enum (HorizontalAlign)
}
Поля
dataRange

object ( GridRange )

Диапазон данных среза.

filterCriteria

object ( FilterCriteria )

Критерии фильтрации среза.

columnIndex

integer

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

applyToPivotTables

boolean

Значение true, если фильтр следует применять к сводным таблицам. Если не установлено, по умолчанию установлено значение True .

title

string

Название слайсера.

textFormat

object ( TextFormat )

Текстовый формат заголовка в срезе. Поле ссылки не поддерживается.

backgroundColor
(deprecated)

object ( Color )

Цвет фона среза. Устарело: используйте backgroundColorStyle .

backgroundColorStyle

object ( ColorStyle )

Цвет фона среза. Если также установлен backgroundColor , это поле имеет приоритет.

horizontalAlignment

enum ( HorizontalAlign )

Горизонтальное выравнивание заголовка в срезе. Если не указано, по умолчанию — LEFT