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. Запрос на обновление индекса листа игнорируется, если запрошенный индекс идентичен текущему листу. index или если запрошенный новый индекс равен текущему индексу листа + 1.

sheetType

enum ( SheetType )

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

gridProperties

object ( GridProperties )

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

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

hidden

boolean

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

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

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

columnGroupControlAfter

boolean

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

DataSourceSheetProperties

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

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

string

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

columns[]

object ( DataSourceColumn )

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

dataExecutionStatus

object ( DataExecutionStatus )

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

GridData

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

Представление 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 )

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

DimensionProperties

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

Представление 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 .

InterpolationPointType

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

перечисления
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

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

При написании: если это поле истинно, то editors игнорируются. Кроме того, если это поле изменено с true на false, а поле editors не задано (и не включено в маску поля), тогда в качестве 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 заполняются в ответах. Если в запросе на обновление указаны оба поля, это поле имеет приоритет.

Полосатый диапазон

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

Представление 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 , это поле имеет приоритет.

DimensionGroup

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

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

object ( DimensionRange )

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

depth

integer

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

collapsed

boolean

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

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

Слайсер

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

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

integer

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

spec

object ( SlicerSpec )

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

position

object ( EmbeddedObjectPosition )

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

SlicerSpec

Характеристики слайсера.

Представление 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 .

title

string

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

textFormat

object ( TextFormat )

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

backgroundColor
(deprecated)

object ( Color )

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

backgroundColorStyle

object ( ColorStyle )

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

horizontalAlignment

enum ( HorizontalAlign )

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