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)
  }
}
田野
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)。

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

单元格的左侧内边距。

VerticalAlign

文本在单元格中的垂直对齐方式。

枚举
VERTICAL_ALIGN_UNSPECIFIED 未指定垂直对齐。请勿使用。
TOP 文本会与单元格顶部明确对齐。
MIDDLE 文本明确与单元格的中间对齐。
BOTTOM 文本会与单元格底部明确对齐。

WrapStrategy

如何将单元格中的文本换行。

枚举
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.  |

TextDirection

单元格中文本的方向。

枚举
TEXT_DIRECTION_UNSPECIFIED 未指定文本方向。请勿使用。
LEFT_TO_RIGHT 文本方向由用户设置从左到右。
RIGHT_TO_LEFT 文本方向由用户设置从右到左。

HyperlinkDisplayType

是否显式呈现超链接。如果未指定，则链接超链接。

枚举
LINKED 超链接应显式呈现。
PLAIN_TEXT 超链接不应呈现。

TextRotation

对单元格中的文本应用的旋转。

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 |

TextFormatRun

文本格式的运行。此运行的格式将持续到下一次运行的起始索引。更新时，必须设置所有字段。

JSON 表示法 
{
  "startIndex": integer,
  "format": {
    object (TextFormat)
  }
}
田野
startIndex

integer

此运行开始的位置（从零开始的字符索引），以 UTF-16 代码单元表示。

format

object (TextFormat)

此次运行的格式。缺失的值将沿用单元格的格式。

DataValidationRule

数据验证规则。

JSON 表示法 
{
  "condition": {
    object (BooleanCondition)
  },
  "inputMessage": string,
  "strict": boolean,
  "showCustomUi": boolean
}
田野
condition

object (BooleanCondition)

单元格中的数据必须匹配的条件。

inputMessage

string

向单元格添加数据时向用户显示的消息。

strict

boolean

如果应拒绝无效数据，则为 true。

showCustomUi

boolean

如果应根据条件类型自定义界面，则为 true。如果为 true，则为“List”则会显示一个下拉菜单

DataSourceTable

数据源表，可让用户从 DataSource 表格。这也称为“提取”。

JSON 表示法 
{
  "dataSourceId": string,
  "columnSelectionType": enum (DataSourceTableColumnSelectionType),
  "columns": [
    {
      object (DataSourceColumnReference)
    }
  ],
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ],
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "rowLimit": integer,
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
田野
dataSourceId

string

与数据源表关联的数据源的 ID。

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

与公式关联的数据源的 ID。

dataExecutionStatus

object (DataExecutionStatus)

仅限输出。数据执行状态。