Cells

CellData

Данные о конкретной клетке.

JSON-представление 
{
  "userEnteredValue": {
    object (ExtendedValue)
  },
  "effectiveValue": {
    object (ExtendedValue)
  },
  "formattedValue": string,
  "userEnteredFormat": {
    object (CellFormat)
  },
  "effectiveFormat": {
    object (CellFormat)
  },
  "hyperlink": string,
  "note": string,
  "textFormatRuns": [
    {
      object (TextFormatRun)
    }
  ],
  "dataValidation": {
    object (DataValidationRule)
  },
  "pivotTable": {
    object (PivotTable)
  },
  "dataSourceTable": {
    object (DataSourceTable)
  },
  "dataSourceFormula": {
    object (DataSourceFormula)
  },
  "chipRuns": [
    {
      object (ChipRun)
    }
  ]
}
Поля
userEnteredValue

object ( ExtendedValue )

Значение, введенное пользователем в ячейку. Например, 1234 , 'Hello' или =NOW() Примечание: Даты, время и даты и время представлены в виде чисел с плавающей запятой в формате serial number .

effectiveValue

object ( ExtendedValue )

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

formattedValue

string

Отформатированное значение ячейки. Это значение, отображаемое пользователю. Это поле доступно только для чтения.

userEnteredFormat

object ( CellFormat )

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

При написании текста новый формат будет объединен с существующим.

effectiveFormat

object ( CellFormat )

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

note

string

Любая заметка на телефоне.

textFormatRuns[]

object ( TextFormatRun )

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

При записи новые запуски перезапишут все предыдущие. При записи нового значения userEnteredValue предыдущие запуски будут удалены.

dataValidation

object ( DataValidationRule )

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

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

pivotTable

object ( PivotTable )

В этой ячейке закреплена сводная таблица. Размер самой сводной таблицы вычисляется динамически на основе ее данных, группировки, фильтров, значений и т. д. Определение сводной таблицы содержится только в верхней левой ячейке сводной таблицы. В остальных ячейках в полях effectiveValue будут содержаться вычисленные значения результатов сводной таблицы.

dataSourceTable

object ( DataSourceTable )

В этой ячейке находится таблица-источник данных. Размер самой таблицы-источника данных вычисляется динамически на основе ее конфигурации. Определение таблицы-источника данных содержится только в первой ячейке таблицы-источника данных. В остальных ячейках в полях effectiveValue будут отображаться значения результатов таблицы-источника данных.

dataSourceFormula

object ( DataSourceFormula )

Только вывод. Информация о формуле источника данных в ячейке. Поле устанавливается, если userEnteredValue — это формула, ссылающаяся на какой-либо лист DATA_SOURCE , например =SUM(DataSheet!Column) .

chipRuns[]

object ( ChipRun )

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

При считывании учитываются все серии с чипами и без них. В сериях без чипов Chip будет пустым.

При записи учитываются только последовательности, содержащие чипы. Последовательности, содержащие чипы, имеют длину 1 и обозначаются в введенном пользователем тексте символом-заполнителем «@». Новые последовательности перезапишут все предыдущие. Запись нового значения userEnteredValue удалит предыдущие последовательности.

CellFormat

Формат ячейки.

JSON-представление 
{
  "numberFormat": {
    object (NumberFormat)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "borders": {
    object (Borders)
  },
  "padding": {
    object (Padding)
  },
  "horizontalAlignment": enum (HorizontalAlign),
  "verticalAlignment": enum (VerticalAlign),
  "wrapStrategy": enum (WrapStrategy),
  "textDirection": enum (TextDirection),
  "textFormat": {
    object (TextFormat)
  },
  "hyperlinkDisplayType": enum (HyperlinkDisplayType),
  "textRotation": {
    object (TextRotation)
  }
}
Поля
numberFormat

object ( NumberFormat )

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

backgroundColor
(deprecated)

object ( Color )

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

backgroundColorStyle

object ( ColorStyle )

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

borders

object ( Borders )

Границы клетки.

padding

object ( Padding )

Внутренняя обшивка ячейки.

horizontalAlignment

enum ( HorizontalAlign )

Горизонтальное выравнивание значения в ячейке.

verticalAlignment

enum ( VerticalAlign )

Вертикальное выравнивание значения в ячейке.

wrapStrategy

enum ( WrapStrategy )

Стратегия переноса значения в ячейке.

textDirection

enum ( TextDirection )

Направление текста в ячейке.

textFormat

object ( TextFormat )

Формат текста в ячейке (если не переопределен в результате выполнения операции форматирования). Установка ссылки на уровне ячейки здесь удаляет существующие ссылки в ячейке. Установка поля ссылки в TextFormatRun имеет приоритет над ссылкой на уровне ячейки.

textRotation

object ( TextRotation )

Поворот, примененный к тексту в ячейке.

NumberFormat

Формат чисел в ячейке.

JSON-представление 
{
  "type": enum (NumberFormatType),
  "pattern": string
}
Поля
type

enum ( NumberFormatType )

Тип формата чисел. При вводе данных это поле необходимо заполнить.

pattern

string

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

NumberFormatType

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

Перечисления
NUMBER_FORMAT_TYPE_UNSPECIFIED Формат чисел не указан и зависит от содержимого ячейки. Не используйте его явно.
TEXT Форматирование текста, например, 1000.12
NUMBER Форматирование чисел, например, 1,000.12
PERCENT Форматирование в процентах, например, 10.12%
CURRENCY Форматирование валюты, например, $1,000.12
DATE Форматирование даты, например, 9/26/2008
TIME Форматирование времени, например, 3:59:00 PM
DATE_TIME Форматирование даты и времени, например, 9/26/08 15:59:00
SCIENTIFIC Научный формат чисел, например, 1.01E+03

Границы

Границы клетки.

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

object ( Border )

Верхняя граница клетки.

bottom

object ( Border )

Нижняя граница клетки.

left

object ( Border )

Левая граница клетки.

right

object ( Border )

Правая граница клетки.

Граница

Граница вдоль клетки.

JSON-представление 
{
  "style": enum (Style),
  "width": integer,
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  }
}
Поля
style

enum ( Style )

Стиль рамки.

width
(deprecated)

integer

Ширина границы в пикселях. Устарело; ширина определяется полем "style".

color
(deprecated)

object ( Color )

Цвет границы. Устарело: используйте colorStyle .

colorStyle

object ( ColorStyle )

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

Стиль

Стиль рамки.

Перечисления
STYLE_UNSPECIFIED Стиль не указан. Не используйте этот стиль.
DOTTED Граница обозначена пунктирными линиями.
DASHED Граница размыта.
SOLID Граница представляет собой тонкую сплошную линию.
SOLID_MEDIUM Граница представляет собой сплошную линию средней толщины.
SOLID_THICK Граница представляет собой толстую сплошную линию.
NONE Без рамки. Используется только при обновлении рамки с целью её удаления.
DOUBLE Граница представляет собой две сплошные линии.

Набивка

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

JSON-представление 
{
  "top": integer,
  "right": integer,
  "bottom": integer,
  "left": integer
}
Поля
top

integer

Верхняя защитная прокладка ячейки.

right

integer

Правильная изоляция ячейки.

bottom

integer

Нижняя прокладка ячейки.

left

integer

Левая часть ячейки.

Вертикальное выравнивание

Вертикальное выравнивание текста в ячейке.

Перечисления
VERTICAL_ALIGN_UNSPECIFIED Вертикальное выравнивание не указано. Не используйте этот параметр.
TOP Текст выровнен по верхнему краю ячейки.
MIDDLE Текст выровнен по центру ячейки.
BOTTOM Текст выровнен по нижнему краю ячейки.

Стратегия обертывания

Как перенести текст в ячейке.

Перечисления
WRAP_STRATEGY_UNSPECIFIED Значение по умолчанию не использовать.
OVERFLOW_CELL

Строки, длина которых превышает ширину ячейки, будут записаны в следующую ячейку, если эта ячейка пуста. Если следующая ячейка не пуста, это работает так же, как CLIP . Текст никогда не будет переноситься на следующую строку, если пользователь вручную не вставит новую строку. Пример:

| First sentence. |
| Manual newline that is very long. <- Text continues into next cell
| Next newline.   |
LEGACY_WRAP

Данная стратегия переноса строк представляет собой старую стратегию переноса строк в Google Sheets, где слова, длиннее одной строки, обрезаются, а не разбиваются на части. Эта стратегия поддерживается не на всех платформах и постепенно выводится из эксплуатации. Пример:

| Cell has a |
| loooooooooo| <- Word is clipped.
| word.      |
CLIP

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

| First sentence. |
| Manual newline t| <- Text is clipped
| Next newline.   |
WRAP

Слова, длина которых превышает одну строку, переносятся на уровне символов, а не обрезаются. Пример: 

| Cell has a |
| loooooooooo| <- Word is broken.
| ong word.  |

Текстовое направление

Направление текста в ячейке.

Перечисления
TEXT_DIRECTION_UNSPECIFIED Направление текста не указано. Не используйте этот параметр.
LEFT_TO_RIGHT Направление текста слева направо задавалось пользователем.
RIGHT_TO_LEFT Направление текста (справа налево) задавалось пользователем.

HyperlinkDisplayType

Следует ли явно отображать гиперссылку. Если не указано иное, гиперссылка уже создана.

Перечисления
LINKED Гиперссылка должна быть явно отображена.
PLAIN_TEXT Гиперссылка отображаться не должна.

Поворот текста

Поворот, применяемый к тексту в ячейке.

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

  // Union field type can be only one of the following:
  "angle": integer,
  "vertical": boolean
  // End of list of possible types for union field type.
}
Поля
type поля объединения. Тип вращения: вертикальное или угловое. type может быть только одним из следующих:
angle

integer

Угол между стандартной ориентацией и желаемой ориентацией. Измеряется в градусах. Допустимые значения находятся в диапазоне от -90 до 90. Положительные углы соответствуют углу вверх, отрицательные — углу вниз.

Примечание: для текста слева направо положительные углы соответствуют направлению против часовой стрелки, а для текста справа налево — по часовой стрелке.

vertical

boolean

Если это так, текст читается сверху вниз, но ориентация отдельных символов остается неизменной. Например: 

| V |
| e |
| r |
| t |
| i |
| c |
| a |
| l |

TextFormatRun

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

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

integer

Нулевой символьный индекс, с которого начинается этот запуск, в кодовых единицах UTF-16.

format

object ( TextFormat )

Формат этого запуска. Отсутствующие значения наследуют формат ячейки.

Правило проверки данных

Правило проверки данных.

JSON-представление 
{
  "condition": {
    object (BooleanCondition)
  },
  "inputMessage": string,
  "strict": boolean,
  "showCustomUi": boolean
}
Поля
condition

object ( BooleanCondition )

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

inputMessage

string

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

strict

boolean

Возвращает true, если недопустимые данные следует отклонить.

showCustomUi

boolean

Значение true указывает, что пользовательский интерфейс должен настраиваться в зависимости от типа условия. В этом случае для условий типа «Список» будет отображаться выпадающий список.

DataSourceTable

Таблица-источник данных, позволяющая пользователю импортировать статическую таблицу данных из DataSource в Google Sheets. В редакторе Google Sheets это также называется "Извлечение".

JSON-представление 
{
  "dataSourceId": string,
  "columnSelectionType": enum (DataSourceTableColumnSelectionType),
  "columns": [
    {
      object (DataSourceColumnReference)
    }
  ],
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ],
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "rowLimit": integer,
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
Поля
dataSourceId

string

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

columnSelectionType

enum ( DataSourceTableColumnSelectionType )

Тип выбора столбцов для таблицы-источника данных. По умолчанию — SELECTED .

columns[]

object ( DataSourceColumnReference )

Выбранные столбцы для таблицы-источника данных. columnSelectionType должен быть SELECTED .

filterSpecs[]

object ( FilterSpec )

Спецификации фильтра указаны в таблице источника данных.

sortSpecs[]

object ( SortSpec )

Укажите параметры сортировки в таблице источника данных. Результат сортировки таблицы источника данных будет отсортирован в соответствии с указанными параметрами сортировки.

rowLimit

integer

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

dataExecutionStatus

object ( DataExecutionStatus )

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

DataSourceTableColumnSelectionType

Типы выбора столбцов таблицы источника данных.

Перечисления
DATA_SOURCE_TABLE_COLUMN_SELECTION_TYPE_UNSPECIFIED Тип выбора столбца по умолчанию не использовать.
SELECTED Выберите столбцы, указанные в поле columns .
SYNC_ALL

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

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

DataSourceFormula

Формула источника данных.

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

string

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

dataExecutionStatus

object ( DataExecutionStatus )

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

ChipRun

Цикл работы микросхемы. Микросхема продолжает работу до начального индекса следующего цикла.

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

integer

Обязательно. Нулевой символьный индекс, с которого начинается выполнение программы, в кодовых единицах UTF-16.

chip

object ( Chip )

Необязательно. Чип этого запуска.

Чип

Умный чип.

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

  // Union field properties can be only one of the following:
  "personProperties": {
    object (PersonProperties)
  },
  "richLinkProperties": {
    object (RichLinkProperties)
  }
  // End of list of possible types for union field properties.
}
Поля
properties поля объединения. Свойства микросхемы. properties могут принимать только одно из следующих значений:
personProperties

object ( PersonProperties )

Свойства связанного лица.

Свойства человека

Свойства, специфичные для связанного лица.

JSON-представление 
{
  "email": string,
  "displayFormat": enum (DisplayFormat)
}
Поля
email

string

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

displayFormat

enum ( DisplayFormat )

Необязательный параметр. Формат отображения информации о пользователе. Если не задано, используется формат отображения по умолчанию.

DisplayFormat

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

Перечисления
DISPLAY_FORMAT_UNSPECIFIED Значение по умолчанию, не использовать.
DEFAULT Формат отображения по умолчанию.
LAST_NAME_COMMA_FIRST_NAME Формат отображения: фамилия, имя.
EMAIL Формат отображения в электронных письмах.

RichLinkProperties

Свойства ссылки на ресурс Google (например, файл в Google Диске, видео на YouTube, адрес в Google Картах или событие в Календаре). Только файлы в Google Диске могут быть записаны как «чипы». Все остальные типы расширенных ссылок доступны только для чтения.

При записи URI не могут превышать 2000 байт.

ПРИМЕЧАНИЕ: Для записи файлов на диск требуется как минимум одна из областей действия OAuth: drive.file , drive.readonly или drive .

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

string

Обязательно. URI ссылки. Этот параметр всегда присутствует.

mimeType

string

Только вывод. MIME-тип ссылки, если таковой имеется (например, если это файл в Google Диска).