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)),则设置该字段。

单元格格式

单元格的格式。

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 中设置 link 字段优先于单元格级链接。

textRotation

object (TextRotation)

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

数字格式

单元格的数字格式。

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

文本方向

单元格中文本的方向。

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

超链接显示类型

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

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

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,“列表”条件将显示下拉菜单。

DataSourceTable

一个数据源表,可让用户将 DataSource 中的静态数据表导入 Google 表格。在表格编辑器中,这也称为“提取”。

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)

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