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 )

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

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 сотрет предыдущие запуски.

ФорматЯчейки

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

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 )

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

ФорматЧисла

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

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

enum ( NumberFormatType )

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

pattern

string

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

ТипФорматаЧисла

Формат числа ячейки. В этой документации предполагается, что локаль — 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 Таблиц, где слова, которые длиннее строки, обрезаются, а не разрываются. Эта стратегия поддерживается не на всех платформах и постепенно выводится из обращения. Пример:

| 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 Направление текста справа налево задавалось пользователем.

ГиперссылкаDisplayType

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

Перечисления
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. Положительные углы направлены вверх, отрицательные — вниз.

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

vertical

boolean

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

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

ТекстФорматRun

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

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, если пользовательский интерфейс должен быть настроен на основе типа условия. Если true, условия "Список" будут показывать раскрывающийся список.

DataSourceTable

Таблица источника данных, которая позволяет пользователю импортировать статическую таблицу данных из DataSource в Sheets. Это также известно как «Извлечение» в редакторе 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 )

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

ИсточникДанныеТаблицаСтолбецВыборТип

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

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

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

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

ИсточникДанныеФормула

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

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

string

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

dataExecutionStatus

object ( DataExecutionStatus )

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

ЧипРан

Прогон чипа. Чип продолжается до начального индекса следующего прогона.

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 )

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

PersonProperties

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

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

string

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

displayFormat

enum ( DisplayFormat )

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

Формат отображения

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

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

RichLinkProperties

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

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

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

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

string

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

mimeType

string

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