CellData
有关特定单元格的相关数据。
| JSON 表示法 | 
|---|
      { "userEnteredValue": { object (  | 
    
| 字段 | |
|---|---|
      userEnteredValue
      | 
     
       
        
       用户在单元格中输入的值。例如:
         | 
    
      effectiveValue
      | 
     
       
        单元格的有效值。对于包含公式的单元格,此值为计算值。对于包含字面量的单元格,此值与 userEnteredValue 相同。此字段为只读字段。  | 
    
      formattedValue
      | 
     
       
        单元格的格式化值。这是向用户显示的值。此字段为只读字段。  | 
    
      userEnteredFormat
      | 
     
       
        用户为单元格输入的格式。 写入时,新格式将与现有格式合并。  | 
    
      effectiveFormat
      | 
     
       
        单元格使用的有效格式。这包括应用任何条件格式后的结果,以及(如果单元格包含公式)计算得出的数字格式。如果有效格式为默认格式,则不会写入有效格式。此字段为只读字段。  | 
    
      hyperlink
      | 
     
       
        
       此单元格指向的超链接(如果有)。如果单元格包含多个超链接,则此字段将为空。此字段为只读字段。如需进行设置,请在   | 
    
      note
      | 
     
       
        单元格中的任何备注。  | 
    
      textFormatRuns[]
      | 
     
       
        应用于单元格子部分的富文本段落。运行作业仅适用于用户输入的字符串,而不适用于公式、布尔值或数字。运行的属性从文本中的特定索引开始,并持续到下一次运行。除非明确更改,否则运行作业将继承单元格的属性。 
       写入时,新运行作业将覆盖之前的所有运行作业。写入新的   | 
    
      dataValidation
      | 
     
       
        单元格上的数据验证规则(如果有)。 在写入时,新的数据验证规则会覆盖任何先前的规则。  | 
    
      pivotTable
      | 
     
       
        
       此单元格中锚定的透视表。数据透视表本身的大小是根据其数据、分组、过滤条件、值等进行动态计算的。只有数据透视表的左上角单元格包含数据透视表定义。其他单元格的   | 
    
      dataSourceTable
      | 
     
       
        
       锚定在此单元格的数据源表。数据源表本身的大小会根据其配置动态计算。只有数据源表的第一个单元格包含数据源表定义。其他单元格将在其   | 
    
      dataSourceFormula
      | 
     
       
        
       仅限输出。关于单元格中数据源公式的信息。如果   | 
    
      chipRuns[]
      | 
     
       
        可选。应用于单元格子部分的条状标签序列。运行的属性从文本中的特定索引开始,并持续到下一次运行。 
       读取时,系统会包含所有带条状标签和不带条状标签的运行。未嵌入条状标签的运行作业将具有空的  
       写入时,仅包含包含条状标签的运行。包含条状标签的运行长度为 1,在用户输入的文本中用“@”占位符符号表示。新的运行作业将覆盖之前的所有运行作业。写入新的   | 
    
CellFormat
单元格的格式。
| JSON 表示法 | 
|---|
      { "numberFormat": { object (  | 
    
| 字段 | |
|---|---|
      numberFormat
      | 
     
       
        一种格式,用于说明应如何向用户呈现数字值。  | 
    
      backgroundColor
       
      | 
     
       
        
       单元格的背景颜色。已废弃:请使用   | 
    
      backgroundColorStyle
      | 
     
       
        
       单元格的背景颜色。如果同时设置了   | 
    
      borders
      | 
     
       
        单元格的边框。  | 
    
      padding
      | 
     
       
        单元格的内边距。  | 
    
      horizontalAlignment
      | 
     
       
        单元格中值的水平对齐方式。  | 
    
      verticalAlignment
      | 
     
       
        单元格中值的垂直对齐方式。  | 
    
      wrapStrategy
      | 
     
       
        单元格中值的换行策略。  | 
    
      textDirection
      | 
     
       
        单元格中文本的方向。  | 
    
      textFormat
      | 
     
       
        
       单元格中文本的格式(除非被运行的格式替换)。在此处设置单元格级链接会清除单元格的现有链接。在   | 
    
      hyperlinkDisplayType
      | 
     
       
        超链接在单元格中的显示方式(如果有)。  | 
    
      textRotation
      | 
     
       
        应用于单元格中文本的旋转角度。  | 
    
NumberFormat
单元格的数字格式。
| JSON 表示法 | 
|---|
      {
  "type": enum ( | 
    
| 字段 | |
|---|---|
      type
      | 
     
       
        数字格式的类型。写入时,必须设置此字段。  | 
    
      pattern
      | 
     
       
        用于设置格式的模式字符串。如果未设置,系统会根据用户的语言区域使用默认模式(如果给定类型需要)。如需详细了解支持的模式,请参阅日期和数字格式指南。  | 
    
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 (  | 
    
| 字段 | |
|---|---|
      top
      | 
     
       
        单元格的上边框。  | 
    
      bottom
      | 
     
       
        单元格的底边框。  | 
    
      left
      | 
     
       
        单元格的左边框。  | 
    
      right
      | 
     
       
        单元格的右边框。  | 
    
边框
单元格边框。
| JSON 表示法 | 
|---|
      { "style": enum (  | 
    
| 字段 | |
|---|---|
      style
      | 
     
       
        边框的样式。  | 
    
      width
       
      | 
     
       
        边框的宽度(以像素为单位)。已废弃;宽度由“style”字段决定。  | 
    
      color
       
      | 
     
       
        
       边框的颜色。已废弃:请使用   | 
    
      colorStyle
      | 
     
       
        
       边框的颜色。如果同时设置了   | 
    
样式
边框的样式。
| 枚举 | |
|---|---|
      STYLE_UNSPECIFIED
      | 
     未指定样式。请勿使用此方法。 | 
      DOTTED
      | 
     边框为虚线。 | 
      DASHED
      | 
     边框为虚线。 | 
      SOLID
      | 
     边框是细实线。 | 
      SOLID_MEDIUM
      | 
     边框为中等粗细的实线。 | 
      SOLID_THICK
      | 
     边框为粗实线。 | 
      NONE
      | 
     无边框。仅在更新边框以清除边框时使用。 | 
      DOUBLE
      | 
     边框是两条实线。 | 
内边距
单元格周围的内边距(以像素为单位)。更新内边距时,必须指定每个字段。
| JSON 表示法 | 
|---|
      { "top": integer, "right": integer, "bottom": integer, "left": integer }  | 
    
| 字段 | |
|---|---|
      top
      | 
     
       
        单元格的上内边距。  | 
    
      right
      | 
     
       
        单元格的右内边距。  | 
    
      bottom
      | 
     
       
        单元格的底部内边距。  | 
    
      left
      | 
     
       
        单元格的左内边距。  | 
    
VerticalAlign
单元格中文本的垂直对齐方式。
| 枚举 | |
|---|---|
      VERTICAL_ALIGN_UNSPECIFIED
      | 
     未指定垂直对齐方式。请勿使用此方法。 | 
      TOP
      | 
     文本会明确对齐到单元格的顶部。 | 
      MIDDLE
      | 
     文本会明确对齐到单元格的中间。 | 
      BOTTOM
      | 
     文本会明确对齐到单元格的底部。 | 
WrapStrategy
如何在单元格中换行文本。
| 枚举 | |
|---|---|
      WRAP_STRATEGY_UNSPECIFIED
      | 
     默认值,请勿使用。 | 
      OVERFLOW_CELL
      | 
     
       
       如果行长度超出单元格宽度,则会写入到下一个单元格(前提是该单元格为空)。如果下一个单元格不为空,则此行为与   | 
    
      LEGACY_WRAP
      | 
     
       此换行策略代表旧版 Google 表格换行策略,其中长度超过一行的字词会被截断,而不是换行。并非所有平台都支持此策略,而且我们正在逐步淘汰此策略。示例:  | 
    
      CLIP
      | 
     
       长度超过单元格宽度的行将被剪裁。除非用户手动插入新行,否则文本绝不会换行。示例:  | 
    
      WRAP
      | 
     
       长度超过一行的字词会在字符级别换行,而不是被截断。示例:  | 
    
TextDirection
单元格中文本的方向。
| 枚举 | |
|---|---|
      TEXT_DIRECTION_UNSPECIFIED
      | 
     未指定文本方向。请勿使用此方法。 | 
      LEFT_TO_RIGHT
      | 
     文本方向由用户设置为从左到右。 | 
      RIGHT_TO_LEFT
      | 
     文本方向由用户设置为从右到左。 | 
HyperlinkDisplayType
是否显式呈现超链接。如果未指定,则超链接会关联。
| 枚举 | |
|---|---|
      HYPERLINK_DISPLAY_TYPE_UNSPECIFIED
      | 
     默认值:呈现超链接。请勿使用此方法。 | 
      LINKED
      | 
     应明确呈现超链接。 | 
      PLAIN_TEXT
      | 
     不应呈现超链接。 | 
TextRotation
应用于单元格中文本的旋转角度。
| JSON 表示法 | 
|---|
      { // Union field  | 
    
| 字段 | |
|---|---|
      联合字段 type。旋转类型,垂直或倾斜。
      type只能是以下其中一项:
      | 
    |
      angle
      | 
     
       
        标准屏幕方向与所需屏幕方向之间的角度。以度为单位。有效值介于 -90 到 90 之间。正角度是向上倾斜,负角度是向下倾斜。 注意:对于 LTR 文本方向,正角度为逆时针方向,而对于 RTL 文本方向,正角度为顺时针方向  | 
    
      vertical
      | 
     
       
        如果为 true,文本会从上到下阅读,但各个字符的方向保持不变。例如:  | 
    
TextFormatRun
文本格式的运行。此运行的格式将持续到下次运行的开始索引。更新时,必须设置所有字段。
| JSON 表示法 | 
|---|
      {
  "startIndex": integer,
  "format": {
    object ( | 
    
| 字段 | |
|---|---|
      startIndex
      | 
     
       
        此运行开始的字符索引(从零开始),以 UTF-16 代码单元为单位。  | 
    
      format
      | 
     
       
        此次运行的格式。缺失的值会继承单元格的格式。  | 
    
DataValidationRule
数据验证规则。
| JSON 表示法 | 
|---|
      {
  "condition": {
    object ( | 
    
| 字段 | |
|---|---|
      condition
      | 
     
       
        单元格中的数据必须符合的条件。  | 
    
      inputMessage
      | 
     
       
        向用户显示的消息,用于在向单元格添加数据时显示。  | 
    
      strict
      | 
     
       
        如果应拒绝无效数据,则为 true。  | 
    
      showCustomUi
      | 
     
       
        如果应根据条件类型自定义界面,则为 true。如果为 true,则“列表”条件将显示下拉菜单。  | 
    
DataSourceTable
   数据源表,可让用户将 DataSource 中的静态数据表导入 Google 表格。这在 Google 表格编辑器中也称为“提取”。
  
| JSON 表示法 | 
|---|
      { "dataSourceId": string, "columnSelectionType": enum (  | 
    
| 字段 | |
|---|---|
      dataSourceId
      | 
     
       
        数据源表关联的数据源的 ID。  | 
    
      columnSelectionType
      | 
     
       
        
       用于为数据源表选择列的类型。默认值为   | 
    
      columns[]
      | 
     
       
        
       为数据源表选择的列。  | 
    
      filterSpecs[]
      | 
     
       
        数据源表中的过滤条件规范。  | 
    
      sortSpecs[]
      | 
     
       
        数据源表中的排序规范。数据源表的结果会按排序规范有序排列。  | 
    
      rowLimit
      | 
     
       
        要返回的行数上限。如果未设置,系统会应用默认限制。如需了解默认值和上限,请参阅 Google 表格编辑器。  | 
    
      dataExecutionStatus
      | 
     
       
        仅限输出。数据执行状态。  | 
    
DataSourceTableColumnSelectionType
数据源表列选择类型。
| 枚举 | |
|---|---|
      DATA_SOURCE_TABLE_COLUMN_SELECTION_TYPE_UNSPECIFIED
      | 
     默认的列选择类型,请勿使用。 | 
      SELECTED
      | 
     
      选择由 columns 字段指定的列。
      | 
    
      SYNC_ALL
      | 
     
       同步数据源中的所有现有列和日后增加的列。 如果设置,数据源表会在刷新时提取数据源中的所有列。  | 
    
DataSourceFormula
数据源公式。
| JSON 表示法 | 
|---|
      {
  "dataSourceId": string,
  "dataExecutionStatus": {
    object ( | 
    
| 字段 | |
|---|---|
      dataSourceId
      | 
     
       
        公式关联的数据源的 ID。  | 
    
      dataExecutionStatus
      | 
     
       
        仅限输出。数据执行状态。  | 
    
ChipRun
条状标签的运行。条状标签会一直持续到下次运行的开始索引。
| JSON 表示法 | 
|---|
      {
  "startIndex": integer,
  "chip": {
    object ( | 
    
| 字段 | |
|---|---|
      startIndex
      | 
     
       
        必需。此运行开始的字符索引(从零开始),以 UTF-16 代码单元为单位。  | 
    
      chip
      | 
     
       
        可选。此运行的条状标签。  | 
    
Chip
智能条状标签。
| JSON 表示法 | 
|---|
      { // Union field  | 
    
| 字段 | |
|---|---|
      联合字段 properties。条状标签的属性。
      properties只能是以下其中一项:
      | 
    |
      personProperties
      | 
     
       
        关联的人员的属性。  | 
    
      richLinkProperties
      | 
     
       
        富媒体链接的属性。  | 
    
PersonProperties
特定于关联的人员的属性。
| JSON 表示法 | 
|---|
      {
  "email": string,
  "displayFormat": enum ( | 
    
| 字段 | |
|---|---|
      email
      | 
     
       
        必需。与此人关联的电子邮件地址。此字段始终存在。  | 
    
      displayFormat
      | 
     
       
        可选。人员条状标签的显示格式。如果未设置,则使用默认显示格式。  | 
    
DisplayFormat
首选显示格式(如有)。
| 枚举 | |
|---|---|
      DISPLAY_FORMAT_UNSPECIFIED
      | 
     默认值,请勿使用。 | 
      DEFAULT
      | 
     默认显示格式。 | 
      LAST_NAME_COMMA_FIRST_NAME
      | 
     姓氏、名字的显示格式。 | 
      EMAIL
      | 
     电子邮件显示格式。 | 
RichLinkProperties
指向 Google 资源(例如云端硬盘中的文件、YouTube 视频、Google 地图地址或 Google 日历活动)的链接的属性。只有云端硬盘文件可以写入条状标签。所有其他富媒体链接类型均为只读。
写入时,URI 不得超过 2000 字节。
   注意:如需写入云端硬盘文件条状标签,您需要至少拥有 drive.file、drive.readonly 或 drive OAuth 范围之一。
  
| JSON 表示法 | 
|---|
      { "uri": string, "mimeType": string }  | 
    
| 字段 | |
|---|---|
      uri
      | 
     
       
        必需。链接的 URI。始终存在。  | 
    
      mimeType
      | 
     
       
        仅限输出。链接的 MIME 类型(如果有,例如当链接是云端硬盘中的文件时)。  |