REST Resource: spreadsheets

资源：电子表格

表示电子表格的资源。

JSON 表示法 
{
  "spreadsheetId": string,
  "properties": {
    object (SpreadsheetProperties)
  },
  "sheets": [
    {
      object (Sheet)
    }
  ],
  "namedRanges": [
    {
      object (NamedRange)
    }
  ],
  "spreadsheetUrl": string,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSources": [
    {
      object (DataSource)
    }
  ],
  "dataSourceSchedules": [
    {
      object (DataSourceRefreshSchedule)
    }
  ]
}
字段
spreadsheetId

string

电子表格的 ID。此字段为只读字段。
properties

object (SpreadsheetProperties)

电子表格的整体属性。
sheets[]

object (Sheet)

电子表格中的工作表。
namedRanges[]

object (NamedRange)

电子表格中定义的命名范围。
spreadsheetUrl

string

电子表格的网址。此字段为只读字段。
developerMetadata[]

object (DeveloperMetadata)

与电子表格关联的开发者元数据。
dataSources[]

object (DataSource)

与电子表格关联的外部数据源的列表。
dataSourceSchedules[]

object (DataSourceRefreshSchedule)

仅限输出。数据源刷新时间表列表。

SpreadsheetProperties

电子表格的属性。

JSON 表示法 
{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  },
  "importFunctionsExternalUrlAccessAllowed": boolean
}
字段
title

string

电子表格的标题。
locale

string

电子表格的语言区域，采用以下某种格式：

  • ISO 639-1 语言代码，例如 en

  • ISO 639-2 语言代码（例如 fil），如果没有 639-1 代码

  • ISO 语言代码和国家/地区代码的组合，例如 en_US

注意：更新此字段时，并非所有语言区域/语言都受支持。
autoRecalc

enum (RecalculationInterval)

在重新计算易失性函数之前等待的时间。
timeZone

string

电子表格的时区，采用 CLDR 格式，例如 America/New_York。如果系统无法识别时区，则可能是自定义时区，例如 GMT-07:00。
defaultFormat

object (CellFormat)

电子表格中所有单元格的默认格式。如果单元格的格式与此默认格式相同，则不会设置 CellData.effectiveFormat。此字段为只读字段。
iterativeCalculationSettings

object (IterativeCalculationSettings)

确定是否以及如何通过迭代计算来解析循环引用。如果缺少此字段，则表示循环引用会导致计算错误。
spreadsheetTheme

object (SpreadsheetTheme)

应用于电子表格的主题。
importFunctionsExternalUrlAccessAllowed

boolean

是否允许图片和导入函数访问外部网址。仅当值为 true 时才可读取。如果为 false，您可以将其设置为 true。如果管理员启用了许可名单功能，系统会绕过此值，并始终返回 true。

RecalculationInterval

枚举可能的重算间隔选项。

枚举
RECALCULATION_INTERVAL_UNSPECIFIED 默认值。请勿使用此值。
ON_CHANGE 易变函数会在每次发生更改时更新。
MINUTE 易变函数会在每次更改和每分钟更新一次。
HOUR 易变函数会在每次更改时和每小时更新一次。

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

颜色

表示 RGBA 颜色空间中的一种颜色。此表示法旨在简化各种语言之间的颜色表示法转换，而不是追求紧凑性。例如，此表示法的字段可以轻松提供给 Java 中的 java.awt.Color 构造函数；也可以轻松提供给 iOS 中的 UIColor 的 +colorWithRed:green:blue:alpha 方法；只需稍加处理，便可在 JavaScript 中轻松格式化为 CSS rgba() 字符串。

本参考页面不包含应用于解释 RGB 值的绝对颜色空间（例如 sRGB、Adobe RGB、DCI-P3 和 BT.2020）的相关信息。默认情况下，应用应采用 sRGB 颜色空间。

当需要确定颜色是否相同时，除非另有文档说明，否则实现会将两个颜色视为相同，前提是它们的所有红色、绿色、蓝色和 Alpha 值各自的差值不超过 1e-5。

示例 (Java)：

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

示例 (iOS / Obj-C)：

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

示例 (JavaScript)：

// ...

var protoToCssColor = function(rgbColor) {
   var redFrac = rgbColor.red || 0.0;
   var greenFrac = rgbColor.green || 0.0;
   var blueFrac = rgbColor.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgbColor)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgbColor.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...
JSON 表示法 
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
字段
red

number

颜色中的红色量，以介于区间 [0, 1] 内的值表示。
green

number

颜色中的绿色量，以介于区间 [0, 1] 内的值表示。
blue

number

颜色中的蓝色量，以介于区间 [0, 1] 内的值表示。
alpha

number

此颜色在像素中的应用比例。也就是说，最终像素颜色由以下等式定义：

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

也就是说，值为 1.0 表示纯色，而值为 0.0 表示完全透明的颜色。它会使用封装容器消息，而非简单的浮动标量，以便区分默认值和未设置的值。如果省略此字段，此颜色对象将呈现为纯色（就像已明确给定 Alpha 值为 1.0）。

ColorStyle

颜色值。

JSON 表示法 
{

  // Union field kind can be only one of the following:
  "rgbColor": {
    object (Color)
  },
  "themeColor": enum (ThemeColorType)
  // End of list of possible types for union field kind.
}
字段
联合字段 kind。颜色值的类型。kind 只能是下列其中一项：
rgbColor

object (Color)

RGB 颜色。通常不支持 Color 对象中的 alpha 值。
themeColor

enum (ThemeColorType)

主题颜色。

ThemeColorType

主题颜色类型。

SpreadsheetProperties 包含一个 SpreadsheetTheme，用于定义这些主题颜色类型与具体颜色的映射。

枚举
THEME_COLOR_TYPE_UNSPECIFIED 未指定主题颜色
TEXT 表示主文本颜色
BACKGROUND 表示主背景颜色
ACCENT1 表示第一个强调色
ACCENT2 表示第二种强调色
ACCENT3 表示第三种强调色
ACCENT4 表示第四种强调色
ACCENT5 表示第五种强调色
ACCENT6 表示第六种强调色

边框

单元格的边框。

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

单元格的左内边距。

HorizontalAlign

单元格中文本的水平对齐方式。

枚举
HORIZONTAL_ALIGN_UNSPECIFIED 未指定水平对齐方式。请勿使用此方法。
LEFT 文本会明确对齐到单元格的左侧。
CENTER 文本会明确对齐到单元格的中心。
RIGHT 文本会明确对齐到单元格的右侧。

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 文本方向由用户设置为从右至左。

TextFormat

单元格中一连串文本的格式。缺失的值表示未指定该字段。

JSON 表示法 
{
  "foregroundColor": {
    object (Color)
  },
  "foregroundColorStyle": {
    object (ColorStyle)
  },
  "fontFamily": string,
  "fontSize": integer,
  "bold": boolean,
  "italic": boolean,
  "strikethrough": boolean,
  "underline": boolean,
  "link": {
    object (Link)
  }
}
字段
foregroundColor
(deprecated)

object (Color)

文本的前景颜色。已废弃：请使用 foregroundColorStyle。
foregroundColorStyle

object (ColorStyle)

文本的前景颜色。如果同时设置了 foregroundColor，则此字段优先。
fontFamily

string

字体系列。
fontSize

integer

字体的大小。
bold

boolean

如果文本为粗体，则为 true。
italic

boolean

如果文本是斜体，则为 true。
strikethrough

boolean

如果文本带有删除线，则为 true。
underline

boolean

如果文本带有下划线，则为 true。

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 |

IterativeCalculationSettings

用于控制如何通过迭代计算来解析循环依赖项的设置。

JSON 表示法 
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
字段
maxIterations

integer

启用迭代计算时，要执行的计算轮次数上限。
convergenceThreshold

number

启用迭代计算后，如果连续结果的差值低于此阈值，计算轮次将停止。

SpreadsheetTheme

表示电子表格主题

JSON 表示法 
{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object (ThemeColorPair)
    }
  ]
}
字段
primaryFontFamily

string

主字体系列的名称。
themeColors[]

object (ThemeColorPair)

电子表格主题颜色对。如需进行更新，您必须提供所有主题颜色对。

ThemeColorPair

将电子表格主题颜色类型映射到其代表的具体颜色的对。

JSON 表示法 
{
  "colorType": enum (ThemeColorType),
  "color": {
    object (ColorStyle)
  }
}
字段
colorType

enum (ThemeColorType)

电子表格主题颜色的类型。
color

object (ColorStyle)

与主题颜色类型对应的具体颜色。

Google 表格

电子表格中的工作表。

JSON 表示法 
{
  "properties": {
    object (SheetProperties)
  },
  "data": [
    {
      object (GridData)
    }
  ],
  "merges": [
    {
      object (GridRange)
    }
  ],
  "conditionalFormats": [
    {
      object (ConditionalFormatRule)
    }
  ],
  "filterViews": [
    {
      object (FilterView)
    }
  ],
  "protectedRanges": [
    {
      object (ProtectedRange)
    }
  ],
  "basicFilter": {
    object (BasicFilter)
  },
  "charts": [
    {
      object (EmbeddedChart)
    }
  ],
  "bandedRanges": [
    {
      object (BandedRange)
    }
  ],
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "rowGroups": [
    {
      object (DimensionGroup)
    }
  ],
  "columnGroups": [
    {
      object (DimensionGroup)
    }
  ],
  "slicers": [
    {
      object (Slicer)
    }
  ],
  "tables": [
    {
      object (Table)
    }
  ]
}
字段
properties

object (SheetProperties)

工作表的属性。
data[]

object (GridData)

网格中的数据（如果这是网格工作表）。

返回的 GridData 对象数量取决于在此工作表中请求的范围数量。例如，如果此值表示 Sheet1，并且请求的电子表格范围为 Sheet1!A1:C10 和 Sheet1!D15:E20，则第一个 GridData 的 startRow/startColumn 为 0，而第二个 GridData 的 startRow 14（从零开始编号的行 15）和 startColumn 3（从零开始编号的列 D）将分别为 startRow 14 和 startColumn 3。

对于 DATA_SOURCE 工作表，您无法请求特定范围，GridData 包含所有值。
merges[]

object (GridRange)

要合并的范围。
conditionalFormats[]

object (ConditionalFormatRule)

此工作表中的条件格式规则。
filterViews[]

object (FilterView)

此工作表中的过滤视图。
protectedRanges[]

object (ProtectedRange)

此工作表中的受保护范围。
basicFilter

object (BasicFilter)

此工作表上的过滤条件（如果有）。
charts[]

object (EmbeddedChart)

此工作表中每个图表的规范。
bandedRanges[]

object (BandedRange)

此工作表中带条纹（交替颜色）的范围。
developerMetadata[]

object (DeveloperMetadata)

与工作表关联的开发者元数据。
rowGroups[]

object (DimensionGroup)

此工作表中的所有行组，按范围起始索引从小到大、然后按组深度从小到大排序。
columnGroups[]

object (DimensionGroup)

此工作表中的所有列组，按范围起始索引从小到大、然后按组深度从小到大排序。
slicers[]

object (Slicer)

此工作表中的切片器。
tables[]

object (Table)

此工作表中的表格。

SheetProperties

工作表的属性。

JSON 表示法 
{
  "sheetId": integer,
  "title": string,
  "index": integer,
  "sheetType": enum (SheetType),
  "gridProperties": {
    object (GridProperties)
  },
  "hidden": boolean,
  "tabColor": {
    object (Color)
  },
  "tabColorStyle": {
    object (ColorStyle)
  },
  "rightToLeft": boolean,
  "dataSourceSheetProperties": {
    object (DataSourceSheetProperties)
  }
}
字段
sheetId

integer

工作表的 ID。必须为非负数。此字段一经设置便无法更改。
title

string

工作表的名称。
index

integer

电子表格中工作表的索引。在添加或更新工作表属性时，如果排除此字段，则系统会将工作表添加或移至工作表列表的末尾。更新工作表索引或插入工作表时，系统会将移动考虑在“移动前”索引中。例如，如果有三个工作表（S1、S2、S3），则必须将索引设置为 2，才能将 S1 移到 S2 前面。如果请求的索引与工作表的当前索引相同，或者请求的新索引等于当前工作表索引 + 1，系统会忽略工作表索引更新请求。
sheetType

enum (SheetType)

工作表的类型。默认为 GRID。此字段一经设置便无法更改。
gridProperties

object (GridProperties)

如果此工作表是网格，则为其提供其他属性。（如果工作表是包含图表或图片的对象工作表，则此字段将不存在。）在编写时，如果在非网格工作表上设置任何网格属性，则会出错。

如果此工作表是 DATA_SOURCE 工作表，则此字段仅用于输出，但包含反映数据源工作表在界面中呈现方式的属性，例如 rowCount。
hidden

boolean

如果工作表在界面中处于隐藏状态，则为 true；如果处于可见状态，则为 false。
tabColor
(deprecated)

object (Color)

界面中标签页的颜色。已废弃：请使用 tabColorStyle。
tabColorStyle

object (ColorStyle)

界面中标签页的颜色。如果同时设置了 tabColor，则此字段优先。
rightToLeft

boolean

如果工作表是 RTL 工作表（而非 LTR 工作表），则为 true。
dataSourceSheetProperties

object (DataSourceSheetProperties)

仅限输出。如果存在，该字段包含 DATA_SOURCE 工作表专用属性。

SheetType

工作表的类型。

枚举
SHEET_TYPE_UNSPECIFIED 默认值，请勿使用。
GRID 工作表是网格。
OBJECT 工作表没有网格，而是包含图表或图片等对象。
DATA_SOURCE 该工作表会连接到外部 DataSource，并显示数据预览。

GridProperties

网格的属性。

JSON 表示法 
{
  "rowCount": integer,
  "columnCount": integer,
  "frozenRowCount": integer,
  "frozenColumnCount": integer,
  "hideGridlines": boolean,
  "rowGroupControlAfter": boolean,
  "columnGroupControlAfter": boolean
}
字段
rowCount

integer

网格的行数。
columnCount

integer

网格中的列数。
frozenRowCount

integer

网格中冻结的行数。
frozenColumnCount

integer

网格中冻结的列数。
hideGridlines

boolean

如果网格在界面中不显示网格线，则为 true。
rowGroupControlAfter

boolean

如果行分组控件切换开关显示在组后面，则为 true。
columnGroupControlAfter

boolean

如果列分组控件切换开关显示在组后面，则为 true。

DataSourceSheetProperties

DATA_SOURCE 工作表的其他属性。

JSON 表示法 
{
  "dataSourceId": string,
  "columns": [
    {
      object (DataSourceColumn)
    }
  ],
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
字段
dataSourceId

string

工作表关联到的 DataSource 的 ID。
columns[]

object (DataSourceColumn)

工作表上显示的列，与 RowData 中的值对应。
dataExecutionStatus

object (DataExecutionStatus)

数据执行状态。

DataSourceColumn

数据源中的列。

JSON 表示法 
{
  "reference": {
    object (DataSourceColumnReference)
  },
  "formula": string
}
字段
reference

object (DataSourceColumnReference)

列引用。
formula

string

计算列的公式。

DataSourceColumnReference

引用数据源列的唯一标识符。

JSON 表示法 
{
  "name": string
}
字段
name

string

列的显示名称。它应在数据源中是唯一的。

DataExecutionStatus

数据执行状态。

系统会创建数据执行作业，以便将数据源对象与 DataSource 中的最新数据同步。它通常安排在后台运行，您可以检查其 state 以确定执行是否已完成

在以下几种情况下，系统会触发数据执行作业运行：

  • Adding a data source 会创建关联的数据源工作表以及数据执行作业，以将数据从数据源同步到工作表。
  • Updating a data source 会以类似方式创建数据执行来刷新关联的数据源工作表。
  • 您可以发送 refresh request 以显式刷新一个或多个数据源对象。
JSON 表示法 
{
  "state": enum (DataExecutionState),
  "errorCode": enum (DataExecutionErrorCode),
  "errorMessage": string,
  "lastRefreshTime": string
}
字段
state

enum (DataExecutionState)

数据执行状态。
errorCode

enum (DataExecutionErrorCode)

错误代码。
errorMessage

string

错误消息，可能为空。
lastRefreshTime

string (Timestamp format)

获取上次成功刷新数据的时间。

DataExecutionState

数据执行状态的枚举。

枚举
DATA_EXECUTION_STATE_UNSPECIFIED 默认值，请勿使用。
NOT_STARTED 数据执行尚未开始。
RUNNING 数据执行已开始并正在运行。
CANCELLING 数据执行作业目前正在取消。
SUCCEEDED 数据执行已成功完成。
FAILED 数据执行已完成，但出现了错误。

DataExecutionErrorCode

数据执行错误代码的枚举。

枚举
DATA_EXECUTION_ERROR_CODE_UNSPECIFIED 默认值，请勿使用。
TIMED_OUT 数据执行超时。
TOO_MANY_ROWS 数据执行结果返回的行数超出限制。
TOO_MANY_COLUMNS 数据执行结果返回的列数超出上限。
TOO_MANY_CELLS 数据执行结果返回的单元格数超出上限。
ENGINE 从后端数据执行引擎（例如 BigQuery）收到错误。如需了解详情，请参阅 errorMessage。
PARAMETER_INVALID 提供的一个或多个数据源参数无效。
UNSUPPORTED_DATA_TYPE 数据执行结果返回了不受支持的数据类型。
DUPLICATE_COLUMN_NAMES 数据执行结果返回了重复的列名称或别名。
INTERRUPTED 数据执行会中断。请稍后刷新。
CONCURRENT_QUERY 数据执行目前正在进行中，在完成之前无法刷新。
OTHER 其他错误。
TOO_MANY_CHARS_PER_CELL 数据执行结果返回的值超出了单个单元格中允许的字符数上限。
DATA_NOT_FOUND 找不到数据源引用的数据库。*/
PERMISSION_DENIED 用户无权访问数据源引用的数据库。
MISSING_COLUMN_ALIAS 数据执行结果返回的列缺少别名。
OBJECT_NOT_FOUND 数据源对象不存在。
OBJECT_IN_ERROR_STATE 数据源对象目前处于错误状态。如需强制刷新，请在 RefreshDataSourceRequest 中设置 force。
OBJECT_SPEC_INVALID 数据源对象规范无效。
DATA_EXECUTION_CANCELLED 数据执行已取消。

GridData

网格中的数据以及维度相关的元数据。

JSON 表示法 
{
  "startRow": integer,
  "startColumn": integer,
  "rowData": [
    {
      object (RowData)
    }
  ],
  "rowMetadata": [
    {
      object (DimensionProperties)
    }
  ],
  "columnMetadata": [
    {
      object (DimensionProperties)
    }
  ]
}
字段
startRow

integer

GridData 引用的第一行，从零开始编号。
startColumn

integer

GridData 引用的第一列，从零开始编号。
rowData[]

object (RowData)

网格中的数据，每行一个条目，从 startRow 中的行开始。RowData 中的值将与从 startColumn 开始的列相对应。
rowMetadata[]

object (DimensionProperties)

与网格中请求的行（从 startRow 中的行开始）相关的元数据。
columnMetadata[]

object (DimensionProperties)

与网格中请求的列相关的元数据，从 startColumn 中的列开始。

RowData

行中每个单元格的数据。

JSON 表示法 
{
  "values": [
    {
      object (CellData)
    }
  ]
}
字段
values[]

object (CellData)

行中的值，每列一个值。

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)）的公式，则系统会设置该字段。

ExtendedValue

电子表格中单元格可以具有的值类型。

JSON 表示法 
{

  // Union field value can be only one of the following:
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "formulaValue": string,
  "errorValue": {
    object (ErrorValue)
  }
  // End of list of possible types for union field value.
}
字段
联合字段 value。单元格中的值类型。如果未设置任何字段，则单元格不含数据。value 只能是下列其中一项：
numberValue

number

表示双精度值。注意：日期、时间和日期时间均采用 SERIAL_NUMBER 格式的双精度数表示。
stringValue

string

表示字符串值。不包括前导单引号。例如，如果用户在界面中输入 '123，则系统会将其表示为 "123" 的 stringValue。
boolValue

boolean

表示布尔值。
formulaValue

string

表示公式。
errorValue

object (ErrorValue)

表示错误。此字段为只读字段。

ErrorValue

单元格中存在错误。

JSON 表示法 
{
  "type": enum (ErrorType),
  "message": string
}
字段
type

enum (ErrorType)

错误类型。
message

string

包含有关错误的更多信息的消息（采用电子表格的语言区域）。

ErrorType

错误类型。

枚举
ERROR_TYPE_UNSPECIFIED 默认错误类型，请勿使用。
ERROR 对应于 #ERROR! 错误。
NULL_VALUE 对应于 #NULL! 错误。
DIVIDE_BY_ZERO 对应于 #DIV/0 错误。
VALUE 对应于 #VALUE! 错误。
REF 对应于 #REF! 错误。
NAME 对应于 #NAME? 错误。
NUM 对应于 #NUM! 错误。
N_A 对应于 #N/A 错误。
LOADING 对应于 Loading... 状态。

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

BooleanCondition

计算结果为 true 或 false 的条件。条件格式、数据验证和过滤条件中的条件都使用 BooleanConditions。

JSON 表示法 
{
  "type": enum (ConditionType),
  "values": [
    {
      object (ConditionValue)
    }
  ]
}
字段
type

enum (ConditionType)

条件的类型。
values[]

object (ConditionValue)

条件的值。支持的值数量取决于 condition type。有些支持零个值，有些支持一个或两个值，ConditionType.ONE_OF_LIST 支持任意数量的值。

ConditionType

条件的类型。

枚举
CONDITION_TYPE_UNSPECIFIED 默认值，请勿使用。
NUMBER_GREATER 单元格的值必须大于条件的值。受数据验证、条件格式和过滤条件支持。需要单个 ConditionValue。
NUMBER_GREATER_THAN_EQ 单元格的值必须大于或等于条件的值。受数据验证、条件格式和过滤条件支持。需要单个 ConditionValue。
NUMBER_LESS 单元格的值必须小于条件的值。受数据验证、条件格式和过滤条件支持。需要单个 ConditionValue。
NUMBER_LESS_THAN_EQ 单元格的值必须小于或等于条件的值。受数据验证、条件格式和过滤条件支持。需要单个 ConditionValue。
NUMBER_EQ 单元格的值必须等于条件的值。受数据验证、条件格式和过滤条件支持。需要一个 ConditionValue 来对非数据源对象执行数据验证、条件格式设置和过滤，并且需要至少一个 ConditionValue 来对数据源对象执行过滤。
NUMBER_NOT_EQ 单元格的值不得等于条件的值。受数据验证、条件格式和过滤条件支持。需要一个 ConditionValue 来对非数据源对象执行数据验证、条件格式设置和过滤，并且需要至少一个 ConditionValue 来对数据源对象执行过滤。
NUMBER_BETWEEN 单元格的值必须介于两个条件值之间。受数据验证、条件格式和过滤条件支持。需要恰好两个 ConditionValues。
NUMBER_NOT_BETWEEN 单元格的值不得介于两个条件值之间。受数据验证、条件格式和过滤条件支持。需要恰好两个 ConditionValues。
TEXT_CONTAINS 单元格的值必须包含条件的值。受数据验证、条件格式和过滤条件支持。需要单个 ConditionValue。
TEXT_NOT_CONTAINS 单元格的值不得包含条件的值。受数据验证、条件格式和过滤条件支持。需要单个 ConditionValue。
TEXT_STARTS_WITH 单元格的值必须以条件的值开头。支持条件格式和过滤条件。需要单个 ConditionValue。
TEXT_ENDS_WITH 单元格的值必须以条件的值结尾。支持条件格式和过滤条件。需要单个 ConditionValue。
TEXT_EQ 单元格的值必须与条件的值完全相同。受数据验证、条件格式和过滤条件支持。需要一个 ConditionValue 来对非数据源对象执行数据验证、条件格式设置和过滤，并且需要至少一个 ConditionValue 来对数据源对象执行过滤。
TEXT_IS_EMAIL 单元格的值必须是有效的电子邮件地址。受数据验证支持。无需 ConditionValues。
TEXT_IS_URL 单元格的值必须是有效的网址。受数据验证支持。无需 ConditionValues。
DATE_EQ 单元格的值必须与条件的值相同。受数据验证、条件格式和过滤条件支持。需要一个 ConditionValue 来对非数据源对象执行数据验证、条件格式设置和过滤，并且需要至少一个 ConditionValue 来对数据源对象执行过滤。
DATE_BEFORE 单元格的值必须早于条件值的日期。受数据验证、条件格式和过滤条件支持。需要单个 ConditionValue，该 ConditionValue 可以是 relative date。
DATE_AFTER 单元格的值必须晚于条件值的日期。受数据验证、条件格式和过滤条件支持。需要单个 ConditionValue，该 ConditionValue 可以是 relative date。
DATE_ON_OR_BEFORE 单元格的值必须在条件值的日期当天或之前。受数据验证支持。需要单个 ConditionValue，该 ConditionValue 可以是 relative date。
DATE_ON_OR_AFTER 单元格的值必须晚于条件值的日期。受数据验证支持。需要单个 ConditionValue，该 ConditionValue 可以是 relative date。
DATE_BETWEEN 单元格的值必须介于两个条件值的日期之间。受数据验证支持。需要恰好两个 ConditionValues。
DATE_NOT_BETWEEN 单元格的值必须超出两个条件值的日期范围。受数据验证支持。需要恰好两个 ConditionValues。
DATE_IS_VALID 单元格的值必须是日期。受数据验证支持。无需 ConditionValues。
ONE_OF_RANGE 单元格的值必须在条件值范围的网格中列出。受数据验证支持。需要一个 ConditionValue，且值必须是 A1 表示法中的有效范围。
ONE_OF_LIST 单元格的值必须在条件值列表中。受数据验证支持。支持任意数量的 condition values，每个列表项对应一个。值不支持公式。
BLANK 单元格的值必须为空。支持条件格式和过滤条件。无需 ConditionValues。
NOT_BLANK 单元格的值不得为空。支持条件格式和过滤条件。无需 ConditionValues。
CUSTOM_FORMULA 条件的公式必须评估为 true。受数据验证、条件格式和过滤条件支持。数据源工作表过滤条件不支持此属性。需要单个 ConditionValue。
BOOLEAN 单元格的值必须为 TRUE/FALSE，或在条件值列表中。受数据验证支持。以单元格复选框的形式呈现。支持零个、一个或两个 ConditionValues。不指定值表示单元格必须为 TRUE 或 FALSE，其中 TRUE 会呈现为已选中，而 FALSE 会呈现为未选中。一个值表示当单元格包含该值时，将呈现为勾选状态；当单元格为空时，将呈现为未勾选状态。两个值表示，当单元格包含第一个值时，将呈现为勾选状态；当单元格包含第二个值时，将呈现为未勾选状态。例如，[“是”“否”] 表示当单元格值为“是”时，系统会呈现选中复选框，当单元格值为“否”时，系统会呈现未选中复选框。
TEXT_NOT_EQ 单元格的值必须与条件的值完全不符。数据源对象上的过滤条件支持此属性。需要至少一个 ConditionValue。
DATE_NOT_EQ 单元格的值必须与条件的值完全不符。数据源对象上的过滤条件支持此属性。需要至少一个 ConditionValue。
FILTER_EXPRESSION 单元格的值必须遵循指定的模式。需要单个 ConditionValue。

ConditionValue

条件的值。

JSON 表示法 
{

  // Union field value can be only one of the following:
  "relativeDate": enum (RelativeDate),
  "userEnteredValue": string
  // End of list of possible types for union field value.
}
字段
联合字段 value。条件的值，必须设置一个值。value 只能是下列其中一项：
relativeDate

enum (RelativeDate)

相对日期（基于当前日期）。仅当 type 为 DATE_BEFORE、DATE_AFTER、DATE_ON_OR_BEFORE 或 DATE_ON_OR_AFTER 时有效。

数据验证不支持相对日期。仅在条件格式和条件过滤器中受支持。
userEnteredValue

string

条件所依据的值。系统会像用户在单元格中输入内容一样解析该值。支持公式（必须以 = 或“+”开头）。

RelativeDate

控制日期条件的评估方式。

枚举
RELATIVE_DATE_UNSPECIFIED 默认值，请勿使用。
PAST_YEAR 该值为今天前一年的日期。
PAST_MONTH 该值为今天前一个月。
PAST_WEEK 该值为距今一周。
YESTERDAY 值为昨天。
TODAY 值为今天。
TOMORROW 值为明天。

PivotTable

数据透视表。

JSON 表示法 
{
  "rows": [
    {
      object (PivotGroup)
    }
  ],
  "columns": [
    {
      object (PivotGroup)
    }
  ],
  "criteria": {
    integer: {
      object (PivotFilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (PivotFilterSpec)
    }
  ],
  "values": [
    {
      object (PivotValue)
    }
  ],
  "valueLayout": enum (PivotValueLayout),
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  },

  // Union field source_data can be only one of the following:
  "source": {
    object (GridRange)
  },
  "dataSourceId": string
  // End of list of possible types for union field source_data.
}
字段
rows[]

object (PivotGroup)

数据透视表中的每一行分组。
columns[]

object (PivotGroup)

数据透视表中的每一列分组。
criteria
(deprecated)

map (key: integer, value: object (PivotFilterCriteria))

每个来源列偏移量的可选过滤条件映射。

系统会先应用过滤条件，然后再将数据汇总到数据透视表中。映射的键是您要过滤的来源范围的列偏移量，值是该列的条件。

例如，如果来源为 C10:E15，则键 0 将对应于列 C 的过滤条件，而键 1 对应于列 D 的过滤条件。

此字段已弃用，取而代之的是 filterSpecs。
filterSpecs[]

object (PivotFilterSpec)

在汇总数据透视表的数据之前应用于来源列的过滤条件。

系统会在响应中填充 criteria 和 filterSpecs。如果更新请求中同时指定了这两个字段，则此字段的优先级更高。
values[]

object (PivotValue)

要包含在数据透视表中的值的列表。
valueLayout

enum (PivotValueLayout)

值应水平（列）还是垂直（行）列出。
dataExecutionStatus

object (DataExecutionStatus)

仅限输出。数据源数据透视表的数据执行状态。
联合字段 source_data。数据透视表数据的来源。source_data 只能是下列其中一项：
source

object (GridRange)

数据透视表从中读取数据的范围。
dataSourceId

string

数据透视表要从中读取数据的数据源的 ID。

GridRange

工作表中的某个范围。所有索引均从零开始。索引是半开区间，即起始索引含边界值，结束索引不含边界值，即 [startIndex, endIndex)。缺少索引表示该边的范围是无限的。

例如，如果 "Sheet1" 是工作表 ID 123456，则：

Sheet1!A1:A1 == sheetId: 123456, startRowIndex: 0, endRowIndex: 1, startColumnIndex: 0, endColumnIndex: 1

Sheet1!A3:B4 == sheetId: 123456, startRowIndex: 2, endRowIndex: 4, startColumnIndex: 0, endColumnIndex: 2

Sheet1!A:B == sheetId: 123456, startColumnIndex: 0, endColumnIndex: 2

Sheet1!A5:B == sheetId: 123456, startRowIndex: 4, startColumnIndex: 0, endColumnIndex: 2

Sheet1 == sheetId: 123456

起始索引始终必须小于或等于结束索引。如果起始索引等于结束索引，则范围为空。空范围通常没有意义，通常在界面中呈现为 #REF!。

JSON 表示法 
{
  "sheetId": integer,
  "startRowIndex": integer,
  "endRowIndex": integer,
  "startColumnIndex": integer,
  "endColumnIndex": integer
}
字段
sheetId

integer

此范围所在的工作表。
startRowIndex

integer

范围的起始行（包括该行），如果无界，则不设置。
endRowIndex

integer

范围的结束行（不含），如果无界，则不设置。
startColumnIndex

integer

范围的起始列（包括该列），如果无界，则不设置。
endColumnIndex

integer

范围的结束列（不含边界值），如果无界，则不设置。

PivotGroup

数据透视表中的单个分组（行或列）。

JSON 表示法 
{
  "showTotals": boolean,
  "valueMetadata": [
    {
      object (PivotGroupValueMetadata)
    }
  ],
  "sortOrder": enum (SortOrder),
  "valueBucket": {
    object (PivotGroupSortValueBucket)
  },
  "repeatHeadings": boolean,
  "label": string,
  "groupRule": {
    object (PivotGroupRule)
  },
  "groupLimit": {
    object (PivotGroupLimit)
  },

  // Union field source can be only one of the following:
  "sourceColumnOffset": integer,
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field source.
}
字段
showTotals

boolean

如果数据透视表应包含此分组的总计，则为 True。
valueMetadata[]

object (PivotGroupValueMetadata)

有关分组中值的元数据。
sortOrder

enum (SortOrder)

此组中值的排序顺序。
valueBucket

object (PivotGroupSortValueBucket)

要按其进行排序的对立数据透视表组的存储分区。如果未指定，则按此组的值进行按字母顺序排序。
repeatHeadings

boolean

如果此数据透视群组中的标题应重复，则为 true。此属性仅适用于行分组，列会忽略此属性。

默认情况下，我们会尽量避免重复标题，即在标题相同的情况下，不显示更高级别的标题。例如，尽管下方的第三行对应于“第一季度（3 月）”，但系统不会显示“第一季度”，因为它与前几行重复。如果将 repeatHeadings 设置为 true，则会导致“2 月”和“3 月”重复显示“第 1 季度”。

+--------------+
| Q1     | Jan |
|        | Feb |
|        | Mar |
+--------+-----+
| Q1 Total     |
+--------------+
label

string

要为行/列组使用的标签（可自定义）。例如，在下表中，行标签为 Region（可重命名为 State），列标签为 Product（可重命名为 Item）。2017 年 12 月之前创建的数据透视表没有标题标签。如果您想向现有数据透视表添加标题标签，请删除现有数据透视表，然后使用相同的参数创建一个新的数据透视表。

+--------------+---------+-------+
| SUM of Units | Product |       |
| Region       | Pen     | Paper |
+--------------+---------+-------+
| New York     |     345 |    98 |
| Oregon       |     234 |   123 |
| Tennessee    |     531 |   415 |
+--------------+---------+-------+
| Grand Total  |    1110 |   636 |
+--------------+---------+-------+
groupRule

object (PivotGroupRule)

要应用于此行/列组的组规则。
groupLimit

object (PivotGroupLimit)

要应用于此数据透视群组的行或列的计数限制。
联合字段 source。数据透视组的数据源。source 只能是下列其中一项：
sourceColumnOffset

integer

此分组所依据的来源范围的列偏移量。

例如，如果来源为 C10:E15，sourceColumnOffset 为 0 表示此组引用的是列 C，而偏移量 1 则引用的是列 D。
dataSourceColumnReference

object (DataSourceColumnReference)

对此分组所依据的数据源列的引用。

PivotGroupValueMetadata

有关数据透视分组中值的元数据。

JSON 表示法 
{
  "value": {
    object (ExtendedValue)
  },
  "collapsed": boolean
}
字段
value

object (ExtendedValue)

元数据对应的计算值。（请注意，formulaValue 无效，因为系统会计算值。）
collapsed

boolean

如果与值对应的数据已收起，则为 true。

SortOrder

排序顺序。

枚举
SORT_ORDER_UNSPECIFIED 默认值，请勿使用。
ASCENDING 升序排列。
DESCENDING 降序排列。

PivotGroupSortValueBucket

有关应使用数据透视组中的哪些值进行排序的信息。

JSON 表示法 
{
  "valuesIndex": integer,
  "buckets": [
    {
      object (ExtendedValue)
    }
  ]
}
字段
valuesIndex

integer

PivotTable.values 列表中的偏移量，此分组中的值应按此偏移量进行排序。
buckets[]

object (ExtendedValue)

确定要从中选择值进行排序的存储分区。

例如，在包含一个行组和两个列组的数据透视表中，行组最多可以列出两个值。第一个值对应于第一个列组中的值，第二个值对应于第二个列组中的值。如果未列出任何值，则表示该行应按各列组的“总计”进行排序。如果列出单个值，则表示使用该分桶的“总计”值。

PivotGroupRule

PivotGroup 上的可选设置，用于为来源数据列中的值定义分桶，而不是对每个单独的值进行细分。您只能为来源数据中的每列添加一个包含组规则的 PivotGroup，但对于任何给定列，您都可以同时添加包含规则的 PivotGroup 和不包含规则的 PivotGroup。

JSON 表示法 
{

  // Union field rule can be only one of the following:
  "manualRule": {
    object (ManualRule)
  },
  "histogramRule": {
    object (HistogramRule)
  },
  "dateTimeRule": {
    object (DateTimeRule)
  }
  // End of list of possible types for union field rule.
}
字段
联合字段 rule。要应用于 PivotGroup 的规则。rule 只能是下列其中一项：
manualRule

object (ManualRule)

一个 ManualRule。
histogramRule

object (HistogramRule)

一个 HistogramRule。
dateTimeRule

object (DateTimeRule)

一个 DateTimeRule。

ManualRule

可让您手动将源数据列中的值整理到您选择的名称对应的存储分区中。例如，按州汇总人口的 pivot 表：

+-------+-------------------+
| State | SUM of Population |
+-------+-------------------+
| AK    |               0.7 |
| AL    |               4.8 |
| AR    |               2.9 |
...
+-------+-------------------+

可以转换为一个数据透视表，通过向手动分组规则提供组列表（例如，groupName = 'Central', items = ['AL', 'AR', 'IA', ...]）来按时区汇总人口。请注意，您也可以通过向源数据添加时区列并调整数据透视表来实现类似的效果。

+-----------+-------------------+
| Time Zone | SUM of Population |
+-----------+-------------------+
| Central   |             106.3 |
| Eastern   |             151.9 |
| Mountain  |              17.4 |
...
+-----------+-------------------+
JSON 表示法 
{
  "groups": [
    {
      object (ManualRuleGroup)
    }
  ]
}
字段
groups[]

object (ManualRuleGroup)

组名称列表以及与每个组名称对应的源数据中的相应项。

ManualRuleGroup

组名称以及应放入此名称组中的来源数据中的项列表。

JSON 表示法 
{
  "groupName": {
    object (ExtendedValue)
  },
  "items": [
    {
      object (ExtendedValue)
    }
  ]
}
字段
groupName

object (ExtendedValue)

组名称，必须是字符串。给定 ManualRule 中的每个组都必须具有唯一的组名称。
items[]

object (ExtendedValue)

应放入此组的来源数据中的项。每个项可以是字符串、数字或布尔值。项最多只能出现在给定 ManualRule 中的一个组中。未出现在任何组中的内容将单独显示。

HistogramRule

可让您将来源数据列中的数值整理到大小不变的分桶中。HistogramRule.start 到 HistogramRule.end 之间的所有值都放入大小为 HistogramRule.interval 的组中。此外，所有低于 HistogramRule.start 的值都放入一个组，所有高于 HistogramRule.end 的值都放入另一个组。只有 HistogramRule.interval 是必需的，不过如果同时提供了 HistogramRule.start 和 HistogramRule.end，则 HistogramRule.start 必须小于 HistogramRule.end。例如，一个包含 50 多行的数据透视表，按年龄段显示平均购买金额：

+-----+-------------------+
| Age | AVERAGE of Amount |
+-----+-------------------+
| 16  |            $27.13 |
| 17  |             $5.24 |
| 18  |            $20.15 |
...
+-----+-------------------+

可以通过应用直方图分组规则（HistogramRule.start 为 25、HistogramRule.interval 为 20 和 HistogramRule.end 为 65）将其转换为如下所示的转换表。

+-------------+-------------------+
| Grouped Age | AVERAGE of Amount |
+-------------+-------------------+
| < 25        |            $19.34 |
| 25-45       |            $31.43 |
| 45-65       |            $35.87 |
| > 65        |            $27.55 |
+-------------+-------------------+
| Grand Total |            $29.12 |
+-------------+-------------------+
JSON 表示法 
{
  "interval": number,
  "start": number,
  "end": number
}
字段
interval

number

创建的存储分区的大小。必须为正值。
start

number

将项放入固定大小的存储分区时所需的最小值。低于 start 的值会归入单个分桶。此字段是可选字段。
end

number

将项放入大小不变的存储分区时的最大值。高于结束值的值会归入一个分桶。此字段是可选字段。

DateTimeRule

让您能够根据日期或时间值的选定部分，将源数据列中的日期时间值整理到多个存储分区中。例如，假设有一个按日期显示销售交易信息的数据透视表：

+----------+--------------+
| Date     | SUM of Sales |
+----------+--------------+
| 1/1/2017 |      $621.14 |
| 2/3/2017 |      $708.84 |
| 5/8/2017 |      $326.84 |
...
+----------+--------------+

应用日期时间组规则（DateTimeRuleType 为 YEAR_MONTH）会生成以下数据透视表。

+--------------+--------------+
| Grouped Date | SUM of Sales |
+--------------+--------------+
| 2017-Jan     |   $53,731.78 |
| 2017-Feb     |   $83,475.32 |
| 2017-Mar     |   $94,385.05 |
...
+--------------+--------------+
JSON 表示法 
{
  "type": enum (DateTimeRuleType)
}
字段
type

enum (DateTimeRuleType)

要应用的日期时间分组类型。

DateTimeRuleType

可用的日期时间分组规则类型。本文档假定电子表格的语言区域为“en-US”，但对于某些规则类型，日期和时间的实际呈现会使用电子表格的语言区域。

枚举
DATE_TIME_RULE_TYPE_UNSPECIFIED 默认类型，请勿使用。
SECOND 按秒（从 0 到 59）对日期进行分组。
MINUTE 按分钟（从 0 到 59）对日期进行分组。
HOUR 使用 24 小时制（从 0 到 23）按小时对日期进行分组。
HOUR_MINUTE 使用 24 小时制按小时和分钟对日期进行分组，例如 19:45。
HOUR_MINUTE_AMPM 使用 12 小时制按小时和分钟对日期进行分组，例如晚上 7:45。上午/下午标识会根据电子表格的语言区域进行翻译。
DAY_OF_WEEK 按星期对日期进行分组，例如星期日。星期几将根据电子表格的语言区域进行翻译。
DAY_OF_YEAR 按一年中的日期（从 1 到 366）对日期进行分组。请注意，2 月 29 日之后的日期在闰年和非闰年中的分桶不同。
DAY_OF_MONTH 按日期（从 1 到 31 的日期）对日期进行分组。
DAY_MONTH 按日期和月份对日期进行分组，例如 11 月 22 日。月份会根据电子表格的语言区域进行翻译。
MONTH 按月份对日期进行分组，例如 11 月。月份会根据电子表格的语言区域进行翻译。
QUARTER 按季度对日期进行分组，例如第 1 季度（表示 1 月至 3 月）。
YEAR 按年份对日期进行分组，例如 2008 年。
YEAR_MONTH 按年份和月份对日期进行分组，例如 2008 年 11 月。月份会根据电子表格的语言区域进行翻译。
YEAR_QUARTER 按年份和季度对日期进行分组，例如 2008 年第 4 季度。
YEAR_MONTH_DAY 按年、月和日对日期进行分组，例如 2008-11-22。

PivotGroupLimit

数据透视组中行或列的计数限制。

JSON 表示法 
{
  "countLimit": integer,
  "applyOrder": integer
}
字段
countLimit

integer

计数限制。
applyOrder

integer

对数据透视表应用组限制的顺序。

数据透视组限制会从较低的顺序号应用到较高的顺序号。订单号会经过归一化处理，变成从 0 开始的连续整数。

对于写入请求，如需完全自定义应用顺序，所有枢轴组限制都应将此字段设置为一个唯一编号。否则，顺序由 PivotTable.rows 列表中的索引决定，然后再由 PivotTable.columns 列表中的索引决定。

PivotFilterCriteria

用于显示/隐藏数据透视表中行的指标。

JSON 表示法 
{
  "visibleValues": [
    string
  ],
  "condition": {
    object (BooleanCondition)
  },
  "visibleByDefault": boolean
}
字段
visibleValues[]

string

应包含的值。此处未列出的值将被排除。
condition

object (BooleanCondition)

必须为 true 的条件，系统才会显示相应值。（visibleValues 不会替换此设置 - 即使某个值已在其中列出，如果不符合条件，该值仍会被隐藏。）

引用 A1 表示法中范围的条件值将相对于数据透视表工作表进行评估。系统会对引用进行绝对处理，因此不会向下填充数据透视表。例如，“数据透视表 1”的条件值为 =A1 时，系统会将其视为 'Pivot Table 1'!$A$1。

您可以通过列标题名称引用数据透视表的来源数据。例如，如果来源数据包含名为“Revenue”（收入）和“Cost”（费用）的列，并且对“Revenue”（收入）列应用了类型为 NUMBER_GREATER 且值为 =Cost 的条件，则仅包含“Revenue”（收入）>“Cost”（费用）的列。
visibleByDefault

boolean

默认情况下值是否可见。如果为 true，系统会忽略 visibleValues，并显示符合 condition（如果指定）的所有值。如果为 false，则显示同时位于 visibleValues 中且符合 condition 的值。

PivotFilterSpec

与特定来源列偏移量关联的数据透视表过滤条件。

JSON 表示法 
{
  "filterCriteria": {
    object (PivotFilterCriteria)
  },

  // Union field source can be only one of the following:
  "columnOffsetIndex": integer,
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field source.
}
字段
filterCriteria

object (PivotFilterCriteria)

列的条件。
联合字段 source。此过滤条件应用到的来源列。source 只能是下列其中一项：
columnOffsetIndex

integer

源范围的列偏移量（从零开始）。
dataSourceColumnReference

object (DataSourceColumnReference)

对数据源列的引用。

PivotValue

对如何计算数据透视表中的值的定义。

JSON 表示法 
{
  "summarizeFunction": enum (PivotValueSummarizeFunction),
  "name": string,
  "calculatedDisplayType": enum (PivotValueCalculatedDisplayType),

  // Union field value can be only one of the following:
  "sourceColumnOffset": integer,
  "formula": string,
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field value.
}
字段
summarizeFunction

enum (PivotValueSummarizeFunction)

用于汇总值的函数。如果设置了 formula，则唯一支持的值是 SUM 和 CUSTOM。如果设置了 sourceColumnOffset，则不支持 CUSTOM。
name

string

要为值使用的名称。
calculatedDisplayType

enum (PivotValueCalculatedDisplayType)

如果指定，则表示应将数据透视表值显示为与其他数据透视表值的计算结果。例如，如果将 calculatedDisplayType 指定为 PERCENT_OF_GRAND_TOTAL，则所有数据透视表值均显示为占总计的百分比。在 Google 表格编辑器中，此设置在数据透视表的“值”部分中称为“显示为”。
联合字段 value。要用于数据透视表中值的数据。必须设置一个值。value 只能是下列其中一项：
sourceColumnOffset

integer

此值读取的源范围的列偏移量。

例如，如果来源为 C10:E15，sourceColumnOffset 为 0 表示此值引用的是 C 列，而偏移量 1 则引用的是 D 列。
formula

string

用于计算值的自定义公式。公式必须以 = 字符开头。
dataSourceColumnReference

object (DataSourceColumnReference)

对此值读取的数据源列的引用。

PivotValueSummarizeFunction

用于汇总数据透视表值的函数。

枚举
PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED 默认值，请勿使用。
SUM 对应于 SUM 函数。
COUNTA 对应于 COUNTA 函数。
COUNT 对应于 COUNT 函数。
COUNTUNIQUE 对应于 COUNTUNIQUE 函数。
AVERAGE 对应于 AVERAGE 函数。
MAX 对应于 MAX 函数。
MIN 对应于 MIN 函数。
MEDIAN 对应于 MEDIAN 函数。
PRODUCT 对应于 PRODUCT 函数。
STDEV 对应于 STDEV 函数。
STDEVP 对应于 STDEVP 函数。
VAR 对应于 VAR 函数。
VARP 对应于 VARP 函数。
CUSTOM 指示应按原样使用公式。仅当已设置 PivotValue.formula 时才有效。
NONE 表示该值已汇总，但未明确指定汇总函数。适用于值已汇总的 Looker 数据源数据透视表。

PivotValueCalculatedDisplayType

用于计算显示的枢轴值的可能方式。

枚举
PIVOT_VALUE_CALCULATED_DISPLAY_TYPE_UNSPECIFIED 默认值，请勿使用。
PERCENT_OF_ROW_TOTAL 以占行总值的百分比显示数据透视表值。
PERCENT_OF_COLUMN_TOTAL 以占列总值的百分比显示数据透视表值。
PERCENT_OF_GRAND_TOTAL 以占总计值的百分比显示数据透视表值。

PivotValueLayout

数据透视值的布局。

枚举
HORIZONTAL 值以水平方式（列）排列。
VERTICAL 值以垂直方式（作为行）排列。

DataSourceTable

数据源表，可让用户将 DataSource 中的数据静态表导入到 Google 表格中。在 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

要返回的行数限制。如果未设置，系统会应用默认限制。如需了解默认值和上限，请参阅 Google 表格编辑器。
dataExecutionStatus

object (DataExecutionStatus)

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

DataSourceTableColumnSelectionType

数据源表列选择类型。

枚举
DATA_SOURCE_TABLE_COLUMN_SELECTION_TYPE_UNSPECIFIED 默认列选择类型，请勿使用。
SELECTED 选择由 columns 字段指定的列。
SYNC_ALL

同步数据源中的所有现有列和日后增加的列。

如果设置，数据源表会在刷新时提取数据源中的所有列。

FilterSpec

与特定列关联的过滤条件。

JSON 表示法 
{
  "filterCriteria": {
    object (FilterCriteria)
  },

  // Union field reference can be only one of the following:
  "columnIndex": integer,
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field reference.
}
字段
filterCriteria

object (FilterCriteria)

列的条件。
联合字段 reference。对过滤后的列的引用。reference 只能是下列其中一项：
columnIndex

integer

列索引（从零开始）。
dataSourceColumnReference

object (DataSourceColumnReference)

对数据源列的引用。

FilterCriteria

用于在过滤条件或过滤视图中显示/隐藏行的要求。

JSON 表示法 
{
  "hiddenValues": [
    string
  ],
  "condition": {
    object (BooleanCondition)
  },
  "visibleBackgroundColor": {
    object (Color)
  },
  "visibleBackgroundColorStyle": {
    object (ColorStyle)
  },
  "visibleForegroundColor": {
    object (Color)
  },
  "visibleForegroundColorStyle": {
    object (ColorStyle)
  }
}
字段
hiddenValues[]

string

应隐藏的值。
condition

object (BooleanCondition)

必须为 true 的条件，系统才会显示相应值。（这不会替换 hiddenValues；如果其中列出了某个值，该值仍会被隐藏。）
visibleBackgroundColor
(deprecated)

object (Color)

要按其过滤的背景填充颜色；系统只会显示具有此填充颜色的单元格。它与 visibleForegroundColor 相互排斥。已废弃：请使用 visibleBackgroundColorStyle。
visibleBackgroundColorStyle

object (ColorStyle)

要按其过滤的背景填充颜色；系统只会显示具有此填充颜色的单元格。此字段与 visibleForegroundColor 互斥，且必须设为 RGB 类型的颜色。如果同时设置了 visibleBackgroundColor，则此字段优先。
visibleForegroundColor
(deprecated)

object (Color)

要按其过滤的前景色；系统仅会显示具有此前景色的单元格。它与 visibleBackgroundColor 相互排斥。已废弃：请使用 visibleForegroundColorStyle。
visibleForegroundColorStyle

object (ColorStyle)

要按其过滤的前景色；系统仅会显示具有此前景色的单元格。此字段与 visibleBackgroundColor 互斥，且必须设为 RGB 类型的颜色。如果同时设置了 visibleForegroundColor，则此字段优先。

SortSpec

与特定列或行关联的排序方式。

JSON 表示法 
{
  "sortOrder": enum (SortOrder),
  "foregroundColor": {
    object (Color)
  },
  "foregroundColorStyle": {
    object (ColorStyle)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },

  // Union field reference can be only one of the following:
  "dimensionIndex": integer,
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field reference.
}
字段
sortOrder

enum (SortOrder)

订单数据应已排序。
foregroundColor
(deprecated)

object (Color)

排序依据的前景颜色；具有此前景颜色的单元格会排序到顶部。它与 backgroundColor 相互排斥。已废弃：请使用 foregroundColorStyle。
foregroundColorStyle

object (ColorStyle)

排序依据的前景颜色；具有此前景颜色的单元格会排序到顶部。与 backgroundColor 相互排斥，且必须是 RGB 类型的颜色。如果同时设置了 foregroundColor，则此字段优先。
backgroundColor
(deprecated)

object (Color)

要按其排序的背景填充颜色；具有此填充颜色的单元格会排序到顶部。它与 foregroundColor 相互排斥。已废弃：请使用 backgroundColorStyle。
backgroundColorStyle

object (ColorStyle)

要按其排序的背景填充颜色；具有此填充颜色的单元格会排序到顶部。与 foregroundColor 相互排斥，且必须是 RGB 类型的颜色。如果同时设置了 backgroundColor，则此字段优先。
联合字段 reference。对已排序维度的引用。reference 只能是下列其中一项：
dimensionIndex

integer

应应用排序的维度。
dataSourceColumnReference

object (DataSourceColumnReference)

对数据源列的引用。

DataSourceFormula

数据源公式。

JSON 表示法 
{
  "dataSourceId": string,
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
字段
dataSourceId

string

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

object (DataExecutionStatus)

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

DimensionProperties

有关维度的属性。

JSON 表示法 
{
  "hiddenByFilter": boolean,
  "hiddenByUser": boolean,
  "pixelSize": integer,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
}
字段
hiddenByFilter

boolean

如果正在过滤此维度，则为 True。此字段为只读字段。
hiddenByUser

boolean

如果此维度被明确隐藏，则为 true。
pixelSize

integer

尺寸的高度（如果是行）或宽度（如果是列），以像素为单位。
developerMetadata[]

object (DeveloperMetadata)

与单行或单列关联的开发者元数据。
dataSourceColumnReference

object (DataSourceColumnReference)

仅限输出。如果已设置，则表示数据源工作表中的列。

ConditionalFormatRule

用于描述条件格式的规则。

JSON 表示法 
{
  "ranges": [
    {
      object (GridRange)
    }
  ],

  // Union field rule can be only one of the following:
  "booleanRule": {
    object (BooleanRule)
  },
  "gradientRule": {
    object (GradientRule)
  }
  // End of list of possible types for union field rule.
}
字段
ranges[]

object (GridRange)

如果条件为 true，则设置格式的范围。所有范围都必须位于同一网格中。
联合字段 rule。用于控制此条件格式的规则，必须设置一个。rule 只能是下列其中一项：
booleanRule

object (BooleanRule)

格式设置为“开启”或“关闭”，具体取决于规则。
gradientRule

object (GradientRule)

格式将因规则中的渐变而异。

BooleanRule

规则可能匹配，也可能不匹配，具体取决于条件。

JSON 表示法 
{
  "condition": {
    object (BooleanCondition)
  },
  "format": {
    object (CellFormat)
  }
}
字段
condition

object (BooleanCondition)

规则的条件。如果条件计算结果为 true，则系统会应用相应格式。
format

object (CellFormat)

要应用的格式。条件格式只能应用部分格式：bold、italic、strikethrough、foreground color 和 background color。

GradientRule

一种规则，用于根据列出的插值点应用渐变色标格格式。与插值点的值相比，单元格的格式会因其内容而异。

JSON 表示法 
{
  "minpoint": {
    object (InterpolationPoint)
  },
  "midpoint": {
    object (InterpolationPoint)
  },
  "maxpoint": {
    object (InterpolationPoint)
  }
}
字段
minpoint

object (InterpolationPoint)

起始插值点。
midpoint

object (InterpolationPoint)

可选的中途插值点。
maxpoint

object (InterpolationPoint)

最终插值点。

InterpolationPoint

渐变条件格式的单个插值点。这些参数会根据所选的颜色、类型和值固定渐变色标尺。

JSON 表示法 
{
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  },
  "type": enum (InterpolationPointType),
  "value": string
}
字段
color
(deprecated)

object (Color)

此插值点应使用的颜色。已废弃：请使用 colorStyle。
colorStyle

object (ColorStyle)

此插值点应使用的颜色。如果同时设置了 color，则此字段优先。
type

enum (InterpolationPointType)

应如何解读该值。
value

string

此插值点使用的值。可以是公式。如果 type 为 MIN 或 MAX，则不使用。

InterpolationPointType

插值点的类型。

枚举
INTERPOLATION_POINT_TYPE_UNSPECIFIED 默认值，请勿使用。
MIN 插值点使用条件格式范围内单元格中的最小值。
MAX 插值点使用条件格式范围内单元格中的最大值。
NUMBER 插值点使用的是 InterpolationPoint.value 中的确切值。
PERCENT

插值点是条件格式范围内所有单元格的给定百分比。如果值为 =(MAX(FLATTEN(range)) * (value / 100)) + (MIN(FLATTEN(range)) * (1 - (value / 100)))，则相当于 NUMBER（在展平时，系统会忽略范围中的错误）。
PERCENTILE 插值点是条件格式范围内所有单元格的给定百分位数。如果值为 =PERCENTILE(FLATTEN(range), value / 100)，则相当于 NUMBER（在展平时，系统会忽略范围中的错误）。

FilterView

过滤视图。

JSON 表示法 
{
  "filterViewId": integer,
  "title": string,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "tableId": string,
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}
字段
filterViewId

integer

过滤条件视图的 ID。
title

string

过滤视图的名称。
range

object (GridRange)

此过滤器视图涵盖的范围。

写入时，只能设置 range、namedRangeId 或 tableId 之一。
namedRangeId

string

此过滤视图所依赖的有名称范围（如果有）。

写入时，只能设置 range、namedRangeId 或 tableId 之一。
tableId

string

此过滤视图所依托的表格（如果有）。

写入时，只能设置 range、namedRangeId 或 tableId 之一。
sortSpecs[]

object (SortSpec)

每列的排序顺序。如果早期规范中的值相同，则使用较新的规范。
criteria
(deprecated)

map (key: integer, value: object (FilterCriteria))

用于显示/隐藏每列值的条件。映射的键是列编号，值是该列的条件。

此字段已弃用，取而代之的是 filterSpecs。
filterSpecs[]

object (FilterSpec)

用于显示/隐藏每列值的过滤条件。

系统会在响应中填充 criteria 和 filterSpecs。如果更新请求中同时指定了这两个字段，则此字段的优先级更高。

ProtectedRange

受保护的范围。

JSON 表示法 
{
  "protectedRangeId": integer,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "tableId": string,
  "description": string,
  "warningOnly": boolean,
  "requestingUserCanEdit": boolean,
  "unprotectedRanges": [
    {
      object (GridRange)
    }
  ],
  "editors": {
    object (Editors)
  }
}
字段
protectedRangeId

integer

受保护范围的 ID。此字段为只读字段。
range

object (GridRange)

要保护的范围。该范围可以是完全无边界的，在这种情况下，它会被视为受保护的工作表。

写入时，只能设置 range、namedRangeId 或 tableId 之一。
namedRangeId

string

此受保护范围所依赖的命名范围（如果有）。

写入时，只能设置 range、namedRangeId 或 tableId 之一。
tableId

string

此受保护范围所依托的表（如果有）。

写入时，只能设置 range、namedRangeId 或 tableId 之一。
description

string

此受保护范围的说明。
warningOnly

boolean

如果此受保护范围在修改时会显示警告，则为 True。基于警告的保护意味着，每位用户都可以修改受保护范围内的数据，但修改时系统会显示警告，要求用户确认修改。

写入时：如果此字段为 true，则系统会忽略 editors。此外，如果此字段从 true 更改为 false，并且未设置 editors 字段（也不包含在字段掩码中），则编辑器将设置为文档中的所有编辑器。
requestingUserCanEdit

boolean

如果请求此受保护范围的用户可以修改受保护区域，则为 true。此字段为只读字段。
unprotectedRanges[]

object (GridRange)

受保护工作表中不受保护的范围的列表。只有受保护的工作表才支持不受保护的范围。
editors

object (Editors)

对受保护范围拥有修改权限的用户和群组。只有对受保护范围和文档拥有编辑权限的用户才能看到此字段。编辑器不支持 warningOnly 保护。

编辑

受保护范围的编辑者。

JSON 表示法 
{
  "users": [
    string
  ],
  "groups": [
    string
  ],
  "domainUsersCanEdit": boolean
}
字段
users[]

string

对受保护范围拥有修改权限的用户的电子邮件地址。
groups[]

string

对受保护范围拥有修改权限的群组的电子邮件地址。
domainUsersCanEdit

boolean

如果文档网域中的任何人对受保护范围都有修改权限，则为 true。网域保护功能仅适用于网域内的文档。

BasicFilter

与工作表关联的默认过滤条件。

JSON 表示法 
{
  "range": {
    object (GridRange)
  },
  "tableId": string,
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}
字段
range

object (GridRange)

过滤条件涵盖的范围。
tableId

string

此过滤器所依托的表（如果有）。写入时，只能设置 range 或 tableId 之一。
sortSpecs[]

object (SortSpec)

每列的排序顺序。如果早期规范中的值相同，则使用较新的规范。
criteria
(deprecated)

map (key: integer, value: object (FilterCriteria))

用于显示/隐藏每列值的条件。映射的键是列编号，值是该列的条件。

此字段已弃用，取而代之的是 filterSpecs。
filterSpecs[]

object (FilterSpec)

每列的过滤条件。

系统会在响应中填充 criteria 和 filterSpecs。如果更新请求中同时指定了这两个字段，则此字段的优先级更高。

EmbeddedChart

嵌入到工作表中的图表。

JSON 表示法 
{
  "chartId": integer,
  "spec": {
    object (ChartSpec)
  },
  "position": {
    object (EmbeddedObjectPosition)
  },
  "border": {
    object (EmbeddedObjectBorder)
  }
}
字段
chartId

integer

图表的 ID。
spec

object (ChartSpec)

图表的规范。
position

object (EmbeddedObjectPosition)

图表的位置。
border

object (EmbeddedObjectBorder)

图表的边框。

ChartSpec

图表的规范。

JSON 表示法 
{
  "title": string,
  "altText": string,
  "titleTextFormat": {
    object (TextFormat)
  },
  "titleTextPosition": {
    object (TextPosition)
  },
  "subtitle": string,
  "subtitleTextFormat": {
    object (TextFormat)
  },
  "subtitleTextPosition": {
    object (TextPosition)
  },
  "fontName": string,
  "maximized": boolean,
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "dataSourceChartProperties": {
    object (DataSourceChartProperties)
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ],
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "hiddenDimensionStrategy": enum (ChartHiddenDimensionStrategy),

  // Union field chart can be only one of the following:
  "basicChart": {
    object (BasicChartSpec)
  },
  "pieChart": {
    object (PieChartSpec)
  },
  "bubbleChart": {
    object (BubbleChartSpec)
  },
  "candlestickChart": {
    object (CandlestickChartSpec)
  },
  "orgChart": {
    object (OrgChartSpec)
  },
  "histogramChart": {
    object (HistogramChartSpec)
  },
  "waterfallChart": {
    object (WaterfallChartSpec)
  },
  "treemapChart": {
    object (TreemapChartSpec)
  },
  "scorecardChart": {
    object (ScorecardChartSpec)
  }
  // End of list of possible types for union field chart.
}
字段
title

string

图表的标题。
altText

string

用于描述图表的替代文本。这通常用于确保可访问性。
titleTextFormat

object (TextFormat)

标题文本格式。不支持删除线、下划线和链接。
titleTextPosition

object (TextPosition)

标题文本的位置。此字段是可选字段。
subtitle

string

图表的副标题。
subtitleTextFormat

object (TextFormat)

字幕文本格式。不支持删除线、下划线和链接。
subtitleTextPosition

object (TextPosition)

副标题文本位置。此字段是可选字段。
fontName

string

默认用于所有图表文本（例如标题、轴标签、图例）的字体的名称。如果为图表的特定部分指定了字体，则该字体会替换此字体名称。
maximized

boolean

设为 true 可使图表填充其呈现的整个空间，并尽可能减少内边距。设为 false 以使用默认内边距。（不适用于地理图表和组织结构图）。
backgroundColor
(deprecated)

object (Color)

整个图表的背景颜色。不适用于组织结构图。已废弃：请使用 backgroundColorStyle。
backgroundColorStyle

object (ColorStyle)

整个图表的背景颜色。不适用于组织结构图。如果同时设置了 backgroundColor，则此字段优先。
dataSourceChartProperties

object (DataSourceChartProperties)

如果存在，该字段包含数据源图表专用属性。
filterSpecs[]

object (FilterSpec)

应用于图表源数据的过滤条件。仅适用于数据源图表。
sortSpecs[]

object (SortSpec)

用于对图表数据进行排序的顺序。仅支持单个排序规范。仅适用于数据源图表。
hiddenDimensionStrategy

enum (ChartHiddenDimensionStrategy)

确定图表将如何使用隐藏的行或列。
联合字段 chart。具体图表规范，必须设置一个值。chart 只能是下列其中一项：
basicChart

object (BasicChartSpec)

基本图表规范，可以是多种图表之一。如需查看此 API 支持的所有图表的列表，请参阅 BasicChartType。
pieChart

object (PieChartSpec)

饼图规范。
bubbleChart

object (BubbleChartSpec)

气泡图规范。
candlestickChart

object (CandlestickChartSpec)

K 线图规范。
orgChart

object (OrgChartSpec)

组织结构图规范。
histogramChart

object (HistogramChartSpec)

直方图规范。
waterfallChart

object (WaterfallChartSpec)

瀑布图规范。
treemapChart

object (TreemapChartSpec)

树形图规范。
scorecardChart

object (ScorecardChartSpec)

统计信息摘要图表规范。

TextPosition

文本的位置设置。

JSON 表示法 
{
  "horizontalAlignment": enum (HorizontalAlign)
}
字段
horizontalAlignment

enum (HorizontalAlign)

相应文本的水平对齐方式设置。

DataSourceChartProperties

数据源图表的属性。

JSON 表示法 
{
  "dataSourceId": string,
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
字段
dataSourceId

string

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

object (DataExecutionStatus)

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

BasicChartSpec

基本图表的规范。如需查看此 API 支持的图表列表，请参阅 BasicChartType。

JSON 表示法 
{
  "chartType": enum (BasicChartType),
  "legendPosition": enum (BasicChartLegendPosition),
  "axis": [
    {
      object (BasicChartAxis)
    }
  ],
  "domains": [
    {
      object (BasicChartDomain)
    }
  ],
  "series": [
    {
      object (BasicChartSeries)
    }
  ],
  "headerCount": integer,
  "threeDimensional": boolean,
  "interpolateNulls": boolean,
  "stackedType": enum (BasicChartStackedType),
  "lineSmoothing": boolean,
  "compareMode": enum (BasicChartCompareMode),
  "totalDataLabel": {
    object (DataLabel)
  }
}
字段
chartType

enum (BasicChartType)

图表的类型。
legendPosition

enum (BasicChartLegendPosition)

图表图例的位置。
axis[]

object (BasicChartAxis)

图表上的轴。
domains[]

object (BasicChartDomain)

此图表所绘制数据的领域。仅支持单个网域。
series[]

object (BasicChartSeries)

此图表所直观呈现的数据。
headerCount

integer

数据中“标题”的行数或列数。如果未设置，Google 表格会根据数据来推断标题的行数。

（请注意，BasicChartAxis.title 可能会替换从标题值推断出的轴标题。）
threeDimensional

boolean

设为 True 可将图表设为 3D 图表。适用于柱形图和柱状图。
interpolateNulls

boolean

如果系列中缺少某些值，图表中可能会出现缺口（例如，折线图中会缺少线段）。如需消除这些空白，请将此值设置为 true。适用于折线图、面积图和组合图表。
stackedType

enum (BasicChartStackedType)

适用于支持垂直堆叠的图表的堆叠类型。适用于面积图、条形图、柱形图、组合图和阶梯面积图。
lineSmoothing

boolean

获取默认情况下应将所有线条渲染为平滑还是直线。适用于折线图。
compareMode

enum (BasicChartCompareMode)

在数据和图表区域上方悬停时，提示和数据突出显示的行为。
totalDataLabel

object (DataLabel)

用于控制是否在堆叠图表中显示额外的数据标签，这些标签会对域轴上每个值的所有堆叠值的总和进行求和。只有当 chartType 为 AREA、BAR、COLUMN、COMBO 或 STEPPED_AREA 之一且 stackedType 为 STACKED 或 PERCENT_STACKED 时，才能设置这些数据标签。此外，对于 COMBO，只有在只有一种可堆叠系列 type 或一种系列比其他系列多，并且其他每个系列不超过一个系列时，才支持此功能。例如，如果图表包含两个堆叠条形系列和一个面积系列，则支持总数据标签。如果图表包含三个条形系列和两个面积系列，则不允许使用总数据标签。无法在 totalDataLabel 上设置 CUSTOM 或 placement。

BasicChartType

图表的直观呈现方式。

枚举
BASIC_CHART_TYPE_UNSPECIFIED 默认值，请勿使用。
BAR 条形图。
LINE 折线图。
AREA 面积图。
COLUMN 柱形图。
SCATTER 散点图。
COMBO 组合图表。
STEPPED_AREA 阶梯面积图。

BasicChartLegendPosition

图表图例应位于何处。

枚举
BASIC_CHART_LEGEND_POSITION_UNSPECIFIED 默认值，请勿使用。
BOTTOM_LEGEND 图例会渲染在图表底部。
LEFT_LEGEND 图例会渲染在图表的左侧。
RIGHT_LEGEND 图例会渲染在图表右侧。
TOP_LEGEND 图例会呈现在图表顶部。
NO_LEGEND 系统不会渲染图例。

BasicChartAxis

图表的轴。一个图表中每个 axis position 不得有多个轴。

JSON 表示法 
{
  "position": enum (BasicChartAxisPosition),
  "title": string,
  "format": {
    object (TextFormat)
  },
  "titleTextPosition": {
    object (TextPosition)
  },
  "viewWindowOptions": {
    object (ChartAxisViewWindowOptions)
  }
}
字段
position

enum (BasicChartAxisPosition)

此轴的位置。
title

string

此轴的标题。如果设置了此属性，则会覆盖从数据标题推断出的任何标题。
format

object (TextFormat)

影视内容的格式。仅当轴未与网域相关联时才有效。不支持链接字段。
titleTextPosition

object (TextPosition)

轴标题文本的位置。
viewWindowOptions

object (ChartAxisViewWindowOptions)

此轴的视图窗口选项。

BasicChartAxisPosition

图表轴的位置。

枚举
BASIC_CHART_AXIS_POSITION_UNSPECIFIED 默认值，请勿使用。
BOTTOM_AXIS 在图表底部呈现的轴。对于大多数图表，这是标准的主轴。对于条形图，这是辅助轴。
LEFT_AXIS 在图表左侧呈现的轴。对于大多数图表，这是辅助轴。对于条形图，这是标准的主轴。
RIGHT_AXIS 在图表右侧呈现的轴。对于大多数图表，这是辅助轴。对于条形图，这是一个不寻常的主轴。

ChartAxisViewWindowOptions

用于定义图表“视图窗口”（例如轴中的可见值）的选项。

JSON 表示法 
{
  "viewWindowMin": number,
  "viewWindowMax": number,
  "viewWindowMode": enum (ViewWindowMode)
}
字段
viewWindowMin

number

此视图窗口中显示的最低数值。如果未设置，则系统会自动确定适合数据的最小值。
viewWindowMax

number

此视图窗口中显示的最大数值。如果未设置，系统会自动确定适合数据的上限值。
viewWindowMode

enum (ViewWindowMode)

视图窗口的模式。

ViewWindowMode

视图窗口的模式。它定义了如何处理视图窗口的最小值和最大值。

枚举
DEFAULT_VIEW_WINDOW_MODE Google 表格编辑器中用于此图表类型的默认视图窗口模式。在大多数情况下，如果设置了默认模式，则该模式等同于 PRETTY。
VIEW_WINDOW_MODE_UNSUPPORTED 请勿使用。表示 API 不支持当前设置的模式。
EXPLICIT 严格遵循最小值和最大值（如果指定）。如果未指定值，则会回退到 PRETTY 值。
PRETTY 选择能让图表看起来美观的最小值和最大值。在此模式下，系统会忽略最小值和最大值。

BasicChartDomain

图表的域名。例如，如果绘制一段时间内的股票价格图表，则此维度就是日期。

JSON 表示法 
{
  "domain": {
    object (ChartData)
  },
  "reversed": boolean
}
字段
domain

object (ChartData)

网域的数据。例如，如果绘制一段时间内的股票价格图表，则此数据表示日期。
reversed

boolean

设为 true 可将域值（横轴）的顺序反转。

ChartData

网域或系列中包含的数据。

JSON 表示法 
{
  "groupRule": {
    object (ChartGroupRule)
  },
  "aggregateType": enum (ChartAggregateType),

  // Union field type can be only one of the following:
  "sourceRange": {
    object (ChartSourceRange)
  },
  "columnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field type.
}
字段
groupRule

object (ChartGroupRule)

根据 ChartData 是否支持数据源图表的网域对数据进行分组的规则。仅适用于数据源图表。
aggregateType

enum (ChartAggregateType)

数据源图表系列的汇总类型。仅适用于数据源图表。
联合字段 type。包含的数据类型，必须设置一个值。type 只能是下列其中一项：
sourceRange

object (ChartSourceRange)

数据的来源范围。
columnReference

object (DataSourceColumnReference)

对数据读取的数据源列的引用。

ChartSourceRange

图表的来源范围。

JSON 表示法 
{
  "sources": [
    {
      object (GridRange)
    }
  ]
}
字段
sources[]

object (GridRange)

系列或网域的数据范围。其中必须有一个维度的长度为 1，并且列表中的所有来源都必须具有长度为 1 的相同维度。网域（如果有）和所有系列必须具有相同数量的来源范围。如果使用多个来源范围，则给定偏移处的来源范围必须在网域和系列中保持顺序且连续。

例如，以下配置有效：

domain sources: A1:A5
series1 sources: B1:B5
series2 sources: D6:D10

domain sources: A1:A5, C10:C12
series1 sources: B1:B5, D10:D12
series2 sources: C1:C5, E10:E12

ChartGroupRule

数据源图表的网域的 ChartData 上的可选设置，用于为网域中的值定义分桶，而不是对每个单独的值进行细分。

例如，在绘制数据源图表时，您可以针对网域（应仅包含数值）指定直方图规则，将其值划分到多个分桶中。图表系列中属于同一分桶的所有值都会基于 aggregateType 进行汇总。

JSON 表示法 
{

  // Union field rule can be only one of the following:
  "dateTimeRule": {
    object (ChartDateTimeRule)
  },
  "histogramRule": {
    object (ChartHistogramRule)
  }
  // End of list of possible types for union field rule.
}
字段
联合字段 rule。要应用于 ChartData 的规则。rule 只能是下列其中一项：
dateTimeRule

object (ChartDateTimeRule)

一个 ChartDateTimeRule。
histogramRule

object (ChartHistogramRule)

ChartHistogramRule

ChartDateTimeRule

让您能够根据日期或时间值的选定部分，将源数据列中的日期时间值整理到多个存储分区中。

JSON 表示法 
{
  "type": enum (ChartDateTimeRuleType)
}
字段
type

enum (ChartDateTimeRuleType)

要应用的日期时间分组类型。

ChartDateTimeRuleType

可用的日期时间分组规则类型。

枚举
CHART_DATE_TIME_RULE_TYPE_UNSPECIFIED 默认类型，请勿使用。
SECOND 按秒（从 0 到 59）对日期进行分组。
MINUTE 按分钟（从 0 到 59）对日期进行分组。
HOUR 使用 24 小时制（从 0 到 23）按小时对日期进行分组。
HOUR_MINUTE 使用 24 小时制按小时和分钟对日期进行分组，例如 19:45。
HOUR_MINUTE_AMPM 使用 12 小时制按小时和分钟对日期进行分组，例如晚上 7:45。上午/下午标识会根据电子表格的语言区域进行翻译。
DAY_OF_WEEK 按星期对日期进行分组，例如星期日。星期几将根据电子表格的语言区域进行翻译。
DAY_OF_YEAR 按一年中的日期（从 1 到 366）对日期进行分组。请注意，2 月 29 日之后的日期在闰年和非闰年中的分桶不同。
DAY_OF_MONTH 按日期（从 1 到 31 的日期）对日期进行分组。
DAY_MONTH 按日期和月份对日期进行分组，例如 11 月 22 日。月份会根据电子表格的语言区域进行翻译。
MONTH 按月份对日期进行分组，例如 11 月。月份会根据电子表格的语言区域进行翻译。
QUARTER 按季度对日期进行分组，例如第 1 季度（表示 1 月至 3 月）。
YEAR 按年份对日期进行分组，例如 2008 年。
YEAR_MONTH 按年份和月份对日期进行分组，例如 2008 年 11 月。月份会根据电子表格的语言区域进行翻译。
YEAR_QUARTER 按年份和季度对日期进行分组，例如 2008 年第 4 季度。
YEAR_MONTH_DAY 按年、月和日对日期进行分组，例如 2008-11-22。

ChartHistogramRule

可让您将来源数据列中的数值整理到大小不变的分桶中。

JSON 表示法 
{
  "minValue": number,
  "maxValue": number,
  "intervalSize": number
}
字段
minValue

number

将项放入分桶时所需的最小值。小于下限的值会归入一个分桶。如果省略，则由最低商品价值决定。
maxValue

number

将项放入存储分区的最大值。大于上限的值会归为一组。如果省略，则由商品价值上限决定。
intervalSize

number

创建的存储分区的大小。必须为正值。

ChartAggregateType

图表系列的汇总类型。

枚举
CHART_AGGREGATE_TYPE_UNSPECIFIED 默认值，请勿使用。
AVERAGE 平均汇总函数。
COUNT 计数汇总函数。
MAX 最大值汇总函数。
MEDIAN 中位数汇总函数。
MIN 最小聚合函数。
SUM 求和汇总函数。

BasicChartSeries

图表中的一个数据系列。例如，如果绘制一段时间内的股票价格图表，则可能存在多个系列，分别对应“开盘价”“最高价”“最低价”和“收盘价”。

JSON 表示法 
{
  "series": {
    object (ChartData)
  },
  "targetAxis": enum (BasicChartAxisPosition),
  "type": enum (BasicChartType),
  "lineStyle": {
    object (LineStyle)
  },
  "dataLabel": {
    object (DataLabel)
  },
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  },
  "pointStyle": {
    object (PointStyle)
  },
  "styleOverrides": [
    {
      object (BasicSeriesDataPointStyleOverride)
    }
  ]
}
字段
series

object (ChartData)

此图表系列中显示的数据。
targetAxis

enum (BasicChartAxisPosition)

用于指定此系列的值范围的小轴。例如，如果绘制一段时间内的股票图表，则可能需要将“成交量”系列固定在右侧，并将价格固定在左侧，因为成交量的规模与价格的规模不同。如果指定的轴不是图表 type 的有效副轴，则会出错。
type

enum (BasicChartType)

此系列的类型。仅当 chartType 为 COMBO 时有效。不同类型会改变系列图表的显示方式。仅支持 LINE、AREA 和 COLUMN。
lineStyle

object (LineStyle)

此系列的线条样式。仅当 chartType 为 AREA、LINE 或 SCATTER 时有效。如果 series chart type 为 AREA 或 LINE，则也支持 COMBO 图表。
dataLabel

object (DataLabel)

此系列图书的数据标签的相关信息。
color
(deprecated)

object (Color)

与此系列相关联的元素（例如条形、线条和点）的颜色。如果为空，则使用默认颜色。已废弃：请使用 colorStyle。
colorStyle

object (ColorStyle)

与此系列相关联的元素（例如条形、线条和点）的颜色。如果为空，则使用默认颜色。如果同时设置了 color，则此字段优先。
pointStyle

object (PointStyle)

与此系列相关联的点的样式。仅当 chartType 为 AREA、LINE 或 SCATTER 时有效。如果 series chart type 为 AREA、LINE 或 SCATTER，则也支持 COMBO 图表。如果为空，则使用默认的点样式。
styleOverrides[]

object (BasicSeriesDataPointStyleOverride)

系列数据点的样式替换设置。

LineStyle

用于描述线条样式的属性。

JSON 表示法 
{
  "width": integer,
  "type": enum (LineDashType)
}
字段
width

integer

线条的粗细（以像素为单位）。
type

enum (LineDashType)

线条的虚线类型。

LineDashType

线条的虚线类型。

枚举
LINE_DASH_TYPE_UNSPECIFIED 默认值，请勿使用。
INVISIBLE 无虚线类型，相当于不可见的线条。
CUSTOM 线条的自定义虚线。目前不支持修改确切的自定义虚线样式。
SOLID 实线。
DOTTED 虚线。
MEDIUM_DASHED 虚线，虚线的长度为“中”。
MEDIUM_DASHED_DOTTED 线条，交替使用“中等”短划线和圆点。
LONG_DASHED 虚线，虚线的长度为“长”。
LONG_DASHED_DOTTED 线条，交替显示“长”短划线和圆点。

DataLabel

一组数据标签的设置。数据标签是显示在数据旁边（例如线图上的数据点）的注释，可提供有关数据代表内容的其他信息，例如图表上该数据点背后值的文本表示法。

JSON 表示法 
{
  "type": enum (DataLabelType),
  "textFormat": {
    object (TextFormat)
  },
  "placement": enum (DataLabelPlacement),
  "customLabelData": {
    object (ChartData)
  }
}
字段
type

enum (DataLabelType)

数据标签的类型。
textFormat

object (TextFormat)

数据标签使用的文本格式。不支持链接字段。
placement

enum (DataLabelPlacement)

数据标签相对于标记数据的位置。
customLabelData

object (ChartData)

要用于自定义标签的数据。仅当 type 设为 CUSTOM 时，才会用到此政策。此数据的长度必须与此数据标签应用到的系列或其他元素的长度相同。此外，如果系列被拆分为多个来源范围，则此来源数据必须来自来源数据中的下一个列。例如，如果系列为 B2:B4,E6:E8，则这些数据必须来自 C2:C4,F6:F8。

DataLabelType

数据标签的类型。

枚举
DATA_LABEL_TYPE_UNSPECIFIED 未指定数据标签类型，系统会根据图表中数据标签的上下文进行解读。
NONE 系统不会显示数据标签。
DATA 数据标签使用系列数据中的值进行显示。
CUSTOM 数据标签使用 customLabelData 指示的自定义数据源中的值进行显示。

DataLabelPlacement

数据标签相对于标记数据的位置。

枚举
DATA_LABEL_PLACEMENT_UNSPECIFIED 呈现位置由渲染程序自动确定。
CENTER 在水平和垂直方向上居中显示在条或列中。
LEFT 位于数据点左侧。
RIGHT 位于数据点右侧。
ABOVE 在数据点上方。
BELOW 数据点下方。
INSIDE_END 位于条或列的底部（如果为正值，则位于顶部；如果为负值，则位于底部）。
INSIDE_BASE 位于底部的条或列内。
OUTSIDE_END 位于条状标签或列的末尾外侧。

PointStyle

图表上点的样式。

JSON 表示法 
{
  "size": number,
  "shape": enum (PointShape)
}
字段
size

number

数据点大小。如果为空，则使用默认大小。
shape

enum (PointShape)

数据点形状。如果为空或未指定，则使用默认形状。

PointShape

点的形状。

枚举
POINT_SHAPE_UNSPECIFIED 默认值。
CIRCLE 圆形。
DIAMOND 菱形。
HEXAGON 六边形。
PENTAGON 五边形。
SQUARE 方形。
STAR 星形。
TRIANGLE 三角形。
X_MARK X 形标记。

BasicSeriesDataPointStyleOverride

单个系列数据点的样式替换设置。

JSON 表示法 
{
  "index": integer,
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  },
  "pointStyle": {
    object (PointStyle)
  }
}
字段
index

integer

系列数据点的索引（从零开始）。
color
(deprecated)

object (Color)

系列数据点的颜色。如果为空，则使用系列默认值。已废弃：请使用 colorStyle。
colorStyle

object (ColorStyle)

系列数据点的颜色。如果为空，则使用系列默认值。如果同时设置了 color，则此字段优先。
pointStyle

object (PointStyle)

系列数据点的点样式。仅当 chartType 为 AREA、LINE 或 SCATTER 时有效。如果 series chart type 为 AREA、LINE 或 SCATTER，则也支持 COMBO 图表。如果为空，则使用系列默认值。

BasicChartStackedType

堆叠图表时，范围（垂直轴）值会叠加显示，而不是从水平轴显示。例如，两个值 20 和 80 将从 0 开始绘制，其中 80 距离水平轴 80 个单位。如果它们是堆叠的，则 80 会从 20 开始渲染，距离水平轴 100 个单位。

枚举
BASIC_CHART_STACKED_TYPE_UNSPECIFIED 默认值，请勿使用。
NOT_STACKED 系列图表不会堆叠。
STACKED 系列值会堆叠显示，每个值从其下方值的顶部开始垂直呈现。
PERCENT_STACKED 垂直堆叠会延伸到图表顶部，值以彼此的百分比形式显示。

BasicChartCompareMode

比较模式类型，用于描述在悬停在数据和图表区域上时，提示和数据突出显示的行为。

枚举
BASIC_CHART_COMPARE_MODE_UNSPECIFIED 默认值，请勿使用。
DATUM 只有聚焦的数据元素会突出显示并显示在提示中。
CATEGORY 系统会突出显示所有具有相同类别（例如网域值）的数据元素，并将其显示在提示中。

PieChartSpec

饼图。

JSON 表示法 
{
  "legendPosition": enum (PieChartLegendPosition),
  "domain": {
    object (ChartData)
  },
  "series": {
    object (ChartData)
  },
  "threeDimensional": boolean,
  "pieHole": number
}
字段
legendPosition

enum (PieChartLegendPosition)

饼图图例的绘制位置。
domain

object (ChartData)

涵盖饼图领域的数据。
series

object (ChartData)

涵盖饼图中唯一系列的数据。
threeDimensional

boolean

如果饼图是三维的，则为 true。
pieHole

number

饼图中空白区域的大小。

PieChartLegendPosition

图表图例应位于何处。

枚举
PIE_CHART_LEGEND_POSITION_UNSPECIFIED 默认值，请勿使用。
BOTTOM_LEGEND 图例会渲染在图表底部。
LEFT_LEGEND 图例会渲染在图表的左侧。
RIGHT_LEGEND 图例会渲染在图表右侧。
TOP_LEGEND 图例会呈现在图表顶部。
NO_LEGEND 系统不会渲染图例。
LABELED_LEGEND 每个饼状图块都附带一个标签。

BubbleChartSpec

气泡图。

JSON 表示法 
{
  "legendPosition": enum (BubbleChartLegendPosition),
  "bubbleLabels": {
    object (ChartData)
  },
  "domain": {
    object (ChartData)
  },
  "series": {
    object (ChartData)
  },
  "groupIds": {
    object (ChartData)
  },
  "bubbleSizes": {
    object (ChartData)
  },
  "bubbleOpacity": number,
  "bubbleBorderColor": {
    object (Color)
  },
  "bubbleBorderColorStyle": {
    object (ColorStyle)
  },
  "bubbleMaxRadiusSize": integer,
  "bubbleMinRadiusSize": integer,
  "bubbleTextStyle": {
    object (TextFormat)
  }
}
字段
legendPosition

enum (BubbleChartLegendPosition)

图表图例的绘制位置。
bubbleLabels

object (ChartData)

包含气泡标签的数据。这些值不必是唯一的。
domain

object (ChartData)

包含气泡 x 值的数据。这些值用于在图表中水平定位气泡。
series

object (ChartData)

包含气泡 y 值的数据。这些值用于垂直定位图表中的气泡。
groupIds

object (ChartData)

包含气泡组 ID 的数据。具有相同组 ID 的所有气泡均以相同的颜色绘制。如果指定了 bubbleSizes，则还必须指定此字段，但可以包含空值。此字段是可选字段。
bubbleSizes

object (ChartData)

包含气泡大小的数据。气泡大小用于绘制彼此相对的不同大小的气泡。如果指定了该字段，则还必须指定 groupIds。此字段是可选字段。
bubbleOpacity

number

气泡的不透明度，介于 0 到 1.0 之间。0 表示完全透明，1 表示完全不透明。
bubbleBorderColor
(deprecated)

object (Color)

气泡边框颜色。已废弃：请使用 bubbleBorderColorStyle。
bubbleBorderColorStyle

object (ColorStyle)

气泡边框颜色。如果同时设置了 bubbleBorderColor，则此字段优先。
bubbleMaxRadiusSize

integer

气泡的最大半径大小（以像素为单位）。如果指定，该字段必须为正值。
bubbleMinRadiusSize

integer

气泡的最小半径大小（以像素为单位）。如果是具体值，该字段必须为正值。
bubbleTextStyle

object (TextFormat)

气泡内文本的格式。不支持删除线、下划线和链接。

BubbleChartLegendPosition

图表图例应位于何处。

枚举
BUBBLE_CHART_LEGEND_POSITION_UNSPECIFIED 默认值，请勿使用。
BOTTOM_LEGEND 图例会渲染在图表底部。
LEFT_LEGEND 图例会渲染在图表的左侧。
RIGHT_LEGEND 图例会渲染在图表右侧。
TOP_LEGEND 图例会呈现在图表顶部。
NO_LEGEND 系统不会渲染图例。
INSIDE_LEGEND 图例会在图表区域内呈现。

CandlestickChartSpec

K 线图。

JSON 表示法 
{
  "domain": {
    object (CandlestickDomain)
  },
  "data": [
    {
      object (CandlestickData)
    }
  ]
}
字段
domain

object (CandlestickDomain)

烛形图的域数据（横轴）。字符串数据将被视为离散标签，其他数据将被视为连续值。
data[]

object (CandlestickData)

K 线图数据。仅支持一个 CandlestickData。

CandlestickDomain

CandlestickChart 的网域。

JSON 表示法 
{
  "data": {
    object (ChartData)
  },
  "reversed": boolean
}
字段
data

object (ChartData)

CandlestickDomain 的数据。
reversed

boolean

设为 true 可将域值（横轴）的顺序反转。

CandlestickData

K 线图数据，每个数据包含系列的最低价、开盘价、收盘价和最高价。

JSON 表示法 
{
  "lowSeries": {
    object (CandlestickSeries)
  },
  "openSeries": {
    object (CandlestickSeries)
  },
  "closeSeries": {
    object (CandlestickSeries)
  },
  "highSeries": {
    object (CandlestickSeries)
  }
}
字段
lowSeries

object (CandlestickSeries)

每个蜡烛图的低值/最小值的范围数据（垂直轴）。这是 K 线下影线的最低点。
openSeries

object (CandlestickSeries)

每个蜡烛图的开盘价/初始值的范围数据（垂直轴）。这是实体烛体的底部。如果小于收盘价，则 K 线为实心，否则，蜡烛将是空心的。
closeSeries

object (CandlestickSeries)

每个蜡烛图的收盘价/最终值的范围数据（垂直轴）。这是实体烛体的顶部。如果大于开盘价，则 K 线为实心。否则，蜡烛将是空心的。
highSeries

object (CandlestickSeries)

每个蜡烛图的最高值的范围数据（垂直轴）。这是 K 线上影线的最高点。

CandlestickSeries

CandlestickData 的系列。

JSON 表示法 
{
  "data": {
    object (ChartData)
  }
}
字段
data

object (ChartData)

CandlestickSeries 的数据。

OrgChartSpec

组织结构图。组织结构图需要在 labels 中包含一组唯一的标签，并且可以选择性地包含 parentLabels 和 tooltips。parentLabels 针对每个节点包含标识父节点的标签。tooltips 针对每个节点包含一个可选的提示。

例如，若要描述一个组织架构，其中 Alice 为首席执行官 (CEO)、Bob 为总裁（向 Alice 汇报）、Cathy 为销售副总裁（也向 Alice 汇报），请将 labels 设置为包含“Alice”“Bob”“Cathy”，将 parentLabels 设置为包含“”“Alice”“Alice”，将 tooltips 设置为包含“CEO”“总裁”“销售副总裁”。

JSON 表示法 
{
  "nodeSize": enum (OrgChartNodeSize),
  "nodeColor": {
    object (Color)
  },
  "nodeColorStyle": {
    object (ColorStyle)
  },
  "selectedNodeColor": {
    object (Color)
  },
  "selectedNodeColorStyle": {
    object (ColorStyle)
  },
  "labels": {
    object (ChartData)
  },
  "parentLabels": {
    object (ChartData)
  },
  "tooltips": {
    object (ChartData)
  }
}
字段
nodeSize

enum (OrgChartNodeSize)

组织架构节点的大小。
nodeColor
(deprecated)

object (Color)

组织结构图节点的颜色。已废弃：请使用 nodeColorStyle。
nodeColorStyle

object (ColorStyle)

组织结构图节点的颜色。如果同时设置了 nodeColor，则此字段优先。
selectedNodeColor
(deprecated)

object (Color)

所选组织结构图节点的颜色。已废弃：请使用 selectedNodeColorStyle。
selectedNodeColorStyle

object (ColorStyle)

所选组织结构图节点的颜色。如果同时设置了 selectedNodeColor，则此字段优先。
labels

object (ChartData)

包含图表中所有节点的标签的数据。标签必须是唯一的。
parentLabels

object (ChartData)

包含相应节点父级标签的数据。空值表示该节点没有父级，是顶级节点。此字段是可选字段。
tooltips

object (ChartData)

包含相应节点的提示的数据。如果值为空，系统将不会为节点显示任何提示。此字段是可选字段。

OrgChartNodeSize

组织架构节点的大小。

枚举
ORG_CHART_LABEL_SIZE_UNSPECIFIED 默认值，请勿使用。
SMALL 组织架构节点的尺寸较小。
MEDIUM 中等组织图节点大小。
LARGE 组织架构节点大小过大。

HistogramChartSpec

直方图。直方图会将数据项分组到多个分箱中，并将每个分箱显示为堆叠项的列。直方图用于显示数据集的分布情况。每列项代表这些项所属的范围。可以自动选择或显式指定分箱数量。

JSON 表示法 
{
  "series": [
    {
      object (HistogramSeries)
    }
  ],
  "legendPosition": enum (HistogramChartLegendPosition),
  "showItemDividers": boolean,
  "bucketSize": number,
  "outlierPercentile": number
}
字段
series[]

object (HistogramSeries)

直方图的系列可以是一系列要分桶的值，也可以是多个系列（每个系列的长度相同），其中包含系列名称以及要为该系列分桶的值。
legendPosition

enum (HistogramChartLegendPosition)

图表图例的位置。
showItemDividers

boolean

是否应在每列中的项之间显示水平分隔线。
bucketSize

number

默认情况下，系统会自动选择分桶大小（单个列中堆叠的值的范围），但您可以在此处替换该大小。例如，如果存储分区大小为 1.5，则存储分区的范围为 0-1.5、1.5-3.0 等。不能为负数。此字段是可选字段。
outlierPercentile

number

离群值百分位数用于确保离群值不会对存储分区大小的计算产生不利影响。例如，将离群值百分位数设置为 0.05 表示在计算分桶时，将排除 5% 的最高值和最低值。这些值仍会包含在图表中，但会添加到第一个或最后一个分桶中，而不是添加到自己的分桶中。必须介于 0.0 到 0.5 之间。

HistogramSeries

包含系列颜色和数据的直方图系列。

JSON 表示法 
{
  "barColor": {
    object (Color)
  },
  "barColorStyle": {
    object (ColorStyle)
  },
  "data": {
    object (ChartData)
  }
}
字段
barColor
(deprecated)

object (Color)

每个分桶中代表此系列的列的颜色。此字段是可选字段。已废弃：请使用 barColorStyle。
barColorStyle

object (ColorStyle)

每个分桶中代表此系列的列的颜色。此字段是可选字段。如果同时设置了 barColor，则此字段优先。
data

object (ChartData)

此直方图系列的数据。

HistogramChartLegendPosition

图表图例应位于何处。

枚举
HISTOGRAM_CHART_LEGEND_POSITION_UNSPECIFIED 默认值，请勿使用。
BOTTOM_LEGEND 图例会渲染在图表底部。
LEFT_LEGEND 图例会渲染在图表的左侧。
RIGHT_LEGEND 图例会渲染在图表右侧。
TOP_LEGEND 图例会呈现在图表顶部。
NO_LEGEND 系统不会渲染图例。
INSIDE_LEGEND 图例会在图表区域内呈现。

WaterfallChartSpec

瀑布图。

JSON 表示法 
{
  "domain": {
    object (WaterfallChartDomain)
  },
  "series": [
    {
      object (WaterfallChartSeries)
    }
  ],
  "stackedType": enum (WaterfallChartStackedType),
  "firstValueIsTotal": boolean,
  "hideConnectorLines": boolean,
  "connectorLineStyle": {
    object (LineStyle)
  },
  "totalDataLabel": {
    object (DataLabel)
  }
}
字段
domain

object (WaterfallChartDomain)

瀑布图的网域数据（横轴）。
series[]

object (WaterfallChartSeries)

此瀑布图所直观呈现的数据。
stackedType

enum (WaterfallChartStackedType)

堆叠类型。
firstValueIsTotal

boolean

设为 true 时，系统会将第一个值解读为总和。
hideConnectorLines

boolean

设置为 true 可隐藏列之间的连接线。
connectorLineStyle

object (LineStyle)

连接线的线条样式。
totalDataLabel

object (DataLabel)

用于控制是否在堆叠图表中显示额外的数据标签，这些标签会对域轴上每个值的所有堆叠值的总和进行求和。stackedType 必须为 STACKED，并且不能在 totalDataLabel 上设置 CUSTOM 或 placement。

WaterfallChartDomain

瀑布图的网域。

JSON 表示法 
{
  "data": {
    object (ChartData)
  },
  "reversed": boolean
}
字段
data

object (ChartData)

WaterfallChartDomain 的数据。
reversed

boolean

设为 true 可将域值（横轴）的顺序反转。

WaterfallChartSeries

瀑布图的单个数据系列。

JSON 表示法 
{
  "data": {
    object (ChartData)
  },
  "positiveColumnsStyle": {
    object (WaterfallChartColumnStyle)
  },
  "negativeColumnsStyle": {
    object (WaterfallChartColumnStyle)
  },
  "subtotalColumnsStyle": {
    object (WaterfallChartColumnStyle)
  },
  "hideTrailingSubtotal": boolean,
  "customSubtotals": [
    {
      object (WaterfallChartCustomSubtotal)
    }
  ],
  "dataLabel": {
    object (DataLabel)
  }
}
字段
data

object (ChartData)

此系列中可视化的数据。
positiveColumnsStyle

object (WaterfallChartColumnStyle)

此系列中所有值为正数的列的样式。
negativeColumnsStyle

object (WaterfallChartColumnStyle)

此系列中所有负值列的样式。
subtotalColumnsStyle

object (WaterfallChartColumnStyle)

此系列中所有小计列的样式。
hideTrailingSubtotal

boolean

设置为 True 可隐藏系列图表末尾的“小计”列。默认情况下，每个系列的末尾都会显示一个小计列。如果将此字段设置为 true，系统会隐藏此系列的此小计列。
customSubtotals[]

object (WaterfallChartCustomSubtotal)

此系列中显示的自定义小计列。定义小计的顺序并不重要。每个数据点只能定义一个小计。
dataLabel

object (DataLabel)

此系列数据标签的相关信息。

WaterfallChartColumnStyle

瀑布图列的样式。

JSON 表示法 
{
  "label": string,
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  }
}
字段
label

string

列图例的标签。
color
(deprecated)

object (Color)

列的颜色。已废弃：请使用 colorStyle。
colorStyle

object (ColorStyle)

列的颜色。如果同时设置了 color，则此字段优先。

WaterfallChartCustomSubtotal

瀑布图系列的自定义小计列。

JSON 表示法 
{
  "subtotalIndex": integer,
  "label": string,
  "dataIsSubtotal": boolean
}
字段
subtotalIndex

integer

系列中数据点的索引（从零开始）。如果 dataIsSubtotal 为 true，则此编号对应的数据点为小计。否则，子总计会显示在此索引对应的数据点后面。系列可以在任意索引处有多个小计，但小计不会影响数据点的索引。例如，如果某个系列有三个数据点，则无论该系列中有多少个子总计或这些子总计与哪些数据点相关联，它们的索引始终为 0、1 和 2。
label

string

小计列的标签。
dataIsSubtotal

boolean

如果 subtotalIndex 中的数据点是小计，则为 true。如果为 false，系统会计算小计并显示在数据点后面。

WaterfallChartStackedType

适用于瀑布图的堆叠类型选项。

枚举
WATERFALL_STACKED_TYPE_UNSPECIFIED 默认值，请勿使用。
STACKED 与同一领域（横轴）值对应的值将垂直堆叠。
SEQUENTIAL 系列图表将沿水平轴展开。

TreemapChartSpec

树状图。

JSON 表示法 
{
  "labels": {
    object (ChartData)
  },
  "parentLabels": {
    object (ChartData)
  },
  "sizeData": {
    object (ChartData)
  },
  "colorData": {
    object (ChartData)
  },
  "textFormat": {
    object (TextFormat)
  },
  "levels": integer,
  "hintedLevels": integer,
  "minValue": number,
  "maxValue": number,
  "headerColor": {
    object (Color)
  },
  "headerColorStyle": {
    object (ColorStyle)
  },
  "colorScale": {
    object (TreemapChartColorScale)
  },
  "hideTooltips": boolean
}
字段
labels

object (ChartData)

包含树状图单元格标签的数据。
parentLabels

object (ChartData)

包含树状图单元格的父标签的数据。
sizeData

object (ChartData)

用于确定每个树形图数据单元格的大小的数据。此数据应为数字。系统不会渲染与非数字数据或缺失数据对应的单元格。如果未指定 colorData，系统还会使用此数据来确定数据单元格的背景颜色。
colorData

object (ChartData)

用于确定每个树状图数据单元格的背景颜色的数据。此字段是可选字段。如果未指定，则系统会使用 sizeData 来确定背景颜色。如果指定，数据应为数字。colorScale 将决定此数据中的值如何映射到数据单元格的背景颜色。
textFormat

object (TextFormat)

图表上所有标签的文本格式。不支持链接字段。
levels

integer

要在树状图图表中显示的数据级别数量。这些等级是互动的，并会显示其标签。如果未指定，则默认值为 2。
hintedLevels

integer

除了要在树状图图表中显示的标记级别之外，其他数据级别的数量。这些等级不可互动，且在显示时不带标签。如果未指定，则默认为 0。
minValue

number

可能的最小数据值。值低于此值的单元格将与值等于此值的单元格具有相同的颜色。如果未指定，则默认为 colorData 中的实际最小值，如果未指定 colorData，则默认为 sizeData 中的最小值。
maxValue

number

可能的最大数据值。值大于此值的单元格将与值等于此值的单元格具有相同的颜色。如果未指定，则默认为 colorData 中的实际最大值，如果未指定 colorData，则为 sizeData 中的最大值。
headerColor
(deprecated)

object (Color)

标题单元格的背景颜色。已废弃：请使用 headerColorStyle。
headerColorStyle

object (ColorStyle)

标题单元格的背景颜色。如果同时设置了 headerColor，则此字段优先。
colorScale

object (TreemapChartColorScale)

树状图图表中数据单元格的颜色比例。系统会根据数据单元格的颜色值为其分配颜色。这些颜色值来自 colorData，如果未指定 colorData，则来自 sizeData。颜色值小于或等于 minValue 的单元格的背景颜色为 minValueColor。颜色值大于或等于 maxValue 的单元格的背景颜色为 maxValueColor。颜色值介于 minValue 和 maxValue 之间的单元格的背景颜色将介于 minValueColor 和 maxValueColor 之间的渐变色，渐变的中间点为 midValueColor。缺少颜色值或颜色值非数字的单元格的背景颜色将为 noDataColor。
hideTooltips

boolean

设为 true 可隐藏提示。

TreemapChartColorScale

树状图的颜色比例。

JSON 表示法 
{
  "minValueColor": {
    object (Color)
  },
  "minValueColorStyle": {
    object (ColorStyle)
  },
  "midValueColor": {
    object (Color)
  },
  "midValueColorStyle": {
    object (ColorStyle)
  },
  "maxValueColor": {
    object (Color)
  },
  "maxValueColorStyle": {
    object (ColorStyle)
  },
  "noDataColor": {
    object (Color)
  },
  "noDataColorStyle": {
    object (ColorStyle)
  }
}
字段
minValueColor
(deprecated)

object (Color)

颜色值小于或等于 minValue 的单元格的背景颜色。如果未指定，则默认为 #dc3912。已废弃：请使用 minValueColorStyle。
minValueColorStyle

object (ColorStyle)

颜色值小于或等于 minValue 的单元格的背景颜色。如果未指定，则默认为 #dc3912。如果同时设置了 minValueColor，则此字段优先。
midValueColor
(deprecated)

object (Color)

颜色值介于 minValue 和 maxValue 之间的单元格的背景颜色。如果未指定，则默认为 #efe6dc。已废弃：请使用 midValueColorStyle。
midValueColorStyle

object (ColorStyle)

颜色值介于 minValue 和 maxValue 之间的单元格的背景颜色。如果未指定，则默认为 #efe6dc。如果同时设置了 midValueColor，则此字段优先。
maxValueColor
(deprecated)

object (Color)

颜色值大于或等于 maxValue 的单元格的背景颜色。如果未指定，则默认为 #109618。已废弃：请使用 maxValueColorStyle。
maxValueColorStyle

object (ColorStyle)

颜色值大于或等于 maxValue 的单元格的背景颜色。如果未指定，则默认为 #109618。如果同时设置了 maxValueColor，则此字段优先。
noDataColor
(deprecated)

object (Color)

没有关联颜色数据的单元格的背景颜色。如果未指定，则默认为 #000000。已废弃：请使用 noDataColorStyle。
noDataColorStyle

object (ColorStyle)

没有关联颜色数据的单元格的背景颜色。如果未指定，则默认为 #000000。如果同时设置了 noDataColor，则此字段优先。

ScorecardChartSpec

统计信息摘要图表。计分卡图表用于在电子表格中突出显示关键绩效指标 (KPI)。统计信息摘要图表可以显示总销售额、平均费用或畅销商品等信息。您可以指定单个数据值，也可以对一组数据进行汇总。您可以突出显示与基准值的百分比差异或绝对差异，例如一段时间内的变化。

JSON 表示法 
{
  "keyValueData": {
    object (ChartData)
  },
  "baselineValueData": {
    object (ChartData)
  },
  "aggregateType": enum (ChartAggregateType),
  "keyValueFormat": {
    object (KeyValueFormat)
  },
  "baselineValueFormat": {
    object (BaselineValueFormat)
  },
  "scaleFactor": number,
  "numberFormatSource": enum (ChartNumberFormatSource),
  "customFormatOptions": {
    object (ChartCustomNumberFormatOptions)
  }
}
字段
keyValueData

object (ChartData)

计分卡键值对的数据。
baselineValueData

object (ChartData)

统计信息摘要基准值的数据。此字段是可选字段。
aggregateType

enum (ChartAggregateType)

计分卡图表中关键图表数据和基准图表数据的汇总类型。数据源图表不支持此字段。对于数据源图表，请改用 keyValueData 或 baselineValueData 的 ChartData.aggregateType 字段。此字段是可选字段。
keyValueFormat

object (KeyValueFormat)

键值的格式设置选项。
baselineValueFormat

object (BaselineValueFormat)

基准值的格式设置选项。只有在指定了 baselineValueData 时，才需要此字段。
scaleFactor

number

用于缩放计分卡键值和基准值的值。例如，系数 10 可用于将图表中的所有值除以 10。此字段是可选字段。
numberFormatSource

enum (ChartNumberFormatSource)

计分卡图表中使用的数字格式来源。此字段是可选字段。
customFormatOptions

object (ChartCustomNumberFormatOptions)

统计信息摘要图表中数字键值/基准值的自定义格式设置选项。仅当 numberFormatSource 设置为 CUSTOM 时才会使用此字段。此字段是可选字段。

KeyValueFormat

键值的格式设置选项。

JSON 表示法 
{
  "textFormat": {
    object (TextFormat)
  },
  "position": {
    object (TextPosition)
  }
}
字段
textFormat

object (TextFormat)

键值对的文本格式选项。不支持链接字段。
position

object (TextPosition)

指定键值的水平文本位置。此字段是可选字段。如果未指定，则使用默认定位。

BaselineValueFormat

基准值的格式设置选项。

JSON 表示法 
{
  "comparisonType": enum (ComparisonType),
  "textFormat": {
    object (TextFormat)
  },
  "position": {
    object (TextPosition)
  },
  "description": string,
  "positiveColor": {
    object (Color)
  },
  "positiveColorStyle": {
    object (ColorStyle)
  },
  "negativeColor": {
    object (Color)
  },
  "negativeColorStyle": {
    object (ColorStyle)
  }
}
字段
comparisonType

enum (ComparisonType)

键值与基准值的比较类型。
textFormat

object (TextFormat)

基准值的文本格式选项。不支持链接字段。
position

object (TextPosition)

指定基准值的水平文本位置。此字段是可选字段。如果未指定，则使用默认定位。
description

string

附加到基准值后面的说明。此字段是可选字段。
positiveColor
(deprecated)

object (Color)

要使用的颜色，如果基准值表示键值的正变化。此字段是可选字段。已废弃：请使用 positiveColorStyle。
positiveColorStyle

object (ColorStyle)

要使用的颜色，如果基准值表示键值的正变化。此字段是可选字段。如果同时设置了 positiveColor，则此字段优先。
negativeColor
(deprecated)

object (Color)

要使用的颜色，如果基准值表示关键值的负值变化。此字段是可选字段。已废弃：请使用 negativeColorStyle。
negativeColorStyle

object (ColorStyle)

要使用的颜色，如果基准值表示关键值的负值变化。此字段是可选字段。如果同时设置了 negativeColor，则此字段优先。

ComparisonType

键值与基准值的比较类型。

枚举
COMPARISON_TYPE_UNDEFINED 默认值，请勿使用。
ABSOLUTE_DIFFERENCE 使用键值与基准值之间的绝对差。
PERCENTAGE_DIFFERENCE 使用键值与基准值之间的百分比差异。

ChartNumberFormatSource

图表属性的数字格式设置来源选项。

枚举
CHART_NUMBER_FORMAT_SOURCE_UNDEFINED 默认值，请勿使用。
FROM_DATA 从数据继承数字格式。
CUSTOM 按 ChartCustomNumberFormatOptions 指定的方式应用自定义格式。

ChartCustomNumberFormatOptions

图表属性的自定义数字格式设置选项。

JSON 表示法 
{
  "prefix": string,
  "suffix": string
}
字段
prefix

string

要附加到图表属性前面的自定义前缀。此字段是可选字段。
suffix

string

要附加到图表属性的自定义后缀。此字段是可选字段。

ChartHiddenDimensionStrategy

确定图表应如何处理已隐藏的来源行。隐藏的行包括手动隐藏的行和被过滤器隐藏的行。

枚举
CHART_HIDDEN_DIMENSION_STRATEGY_UNSPECIFIED 默认值，请勿使用。
SKIP_HIDDEN_ROWS_AND_COLUMNS 图表会跳过隐藏的行和列。
SKIP_HIDDEN_ROWS 图表仅会跳过隐藏的行。
SKIP_HIDDEN_COLUMNS 图表只会跳过隐藏的列。
SHOW_ALL 图表不会跳过任何隐藏的行或列。

EmbeddedObjectPosition

嵌入对象（例如图表）的位置。

JSON 表示法 
{

  // Union field location can be only one of the following:
  "sheetId": integer,
  "overlayPosition": {
    object (OverlayPosition)
  },
  "newSheet": boolean
  // End of list of possible types for union field location.
}
字段
联合字段 location。对象的位置。必须设置一个值。location 只能是下列其中一项：
sheetId

integer

相应工作表。仅当嵌入的对象位于自己的工作表中时才设置。必须是非负数。
overlayPosition

object (OverlayPosition)

对象叠加在网格上的位置。
newSheet

boolean

如果为 true，则嵌入的对象会放置在新的工作表中，系统会为您选择该工作表的 ID。仅在写入时使用。

OverlayPosition

对象在网格上叠加的位置。

JSON 表示法 
{
  "anchorCell": {
    object (GridCoordinate)
  },
  "offsetXPixels": integer,
  "offsetYPixels": integer,
  "widthPixels": integer,
  "heightPixels": integer
}
字段
anchorCell

object (GridCoordinate)

对象锚定的单元格。
offsetXPixels

integer

对象相对于锚点单元格的水平偏移量（以像素为单位）。
offsetYPixels

integer

对象相对于锚点单元格的垂直偏移量（以像素为单位）。
widthPixels

integer

对象的宽度（以像素为单位）。默认值为 600。
heightPixels

integer

对象的高度（以像素为单位）。默认值为 371。

GridCoordinate

工作表中的坐标。所有索引均从零开始。

JSON 表示法 
{
  "sheetId": integer,
  "rowIndex": integer,
  "columnIndex": integer
}
字段
sheetId

integer

此坐标所在的工作表。
rowIndex

integer

坐标的行索引。
columnIndex

integer

坐标的列编号。

EmbeddedObjectBorder

嵌入对象的边框。

JSON 表示法 
{
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  }
}
字段
color
(deprecated)

object (Color)

边框的颜色。已废弃：请使用 colorStyle。
colorStyle

object (ColorStyle)

边框的颜色。如果同时设置了 color，则此字段优先。

BandedRange

工作表中带条纹（交替颜色）的范围。

JSON 表示法 
{
  "bandedRangeId": integer,
  "range": {
    object (GridRange)
  },
  "rowProperties": {
    object (BandingProperties)
  },
  "columnProperties": {
    object (BandingProperties)
  }
}
字段
bandedRangeId

integer

带状范围的 ID。
range

object (GridRange)

这些属性的应用范围。
rowProperties

object (BandingProperties)

行条的属性。这些属性会按行应用于范围内的所有行。必须至少指定 rowProperties 或 columnProperties 中的一个。
columnProperties

object (BandingProperties)

列条的属性。这些属性会按列应用于范围内的所有列。必须至少指定 rowProperties 或 columnProperties 中的一个。

BandingProperties

引用单个维度（行或列）的属性。如果同时设置了 BandedRange.row_properties 和 BandedRange.column_properties，系统会根据以下规则将填充颜色应用于单元格：

例如，第一行的颜色优先于第一列的颜色，但第一列的颜色优先于第二行的颜色。同样，行标题优先于左上角单元格中的列标题，但如果未设置行标题，则列标题优先于第一行颜色。

JSON 表示法 
{
  "headerColor": {
    object (Color)
  },
  "headerColorStyle": {
    object (ColorStyle)
  },
  "firstBandColor": {
    object (Color)
  },
  "firstBandColorStyle": {
    object (ColorStyle)
  },
  "secondBandColor": {
    object (Color)
  },
  "secondBandColorStyle": {
    object (ColorStyle)
  },
  "footerColor": {
    object (Color)
  },
  "footerColorStyle": {
    object (ColorStyle)
  }
}
字段
headerColor
(deprecated)

object (Color)

第一行或第一列的颜色。如果设置此字段，则第一行或第一列会填充此颜色，从第二行或第二列开始，颜色会在 firstBandColor 和 secondBandColor 之间交替。否则，第一行或第一列会填充 firstBandColor，颜色会照常交替。已废弃：请使用 headerColorStyle。
headerColorStyle

object (ColorStyle)

第一行或第一列的颜色。如果设置此字段，则第一行或第一列会填充此颜色，从第二行或第二列开始，颜色会在 firstBandColor 和 secondBandColor 之间交替。否则，第一行或第一列会填充 firstBandColor，颜色会照常交替。如果同时设置了 headerColor，则此字段优先。
firstBandColor
(deprecated)

object (Color)

第一个交替颜色。（必填）已废弃：请使用 firstBandColorStyle。
firstBandColorStyle

object (ColorStyle)

第一个交替颜色。（必填）如果同时设置了 firstBandColor，则此字段优先。
secondBandColor
(deprecated)

object (Color)

第二种交替颜色。（必填）已废弃：请使用 secondBandColorStyle。
secondBandColorStyle

object (ColorStyle)

第二种交替颜色。（必填）如果同时设置了 secondBandColor，则此字段优先。
footerColor
(deprecated)

object (Color)

最后一行或最后一列的颜色。如果未设置此字段，则最后的行或列会填充 firstBandColor 或 secondBandColor，具体取决于前一行或前一列的颜色。已废弃：请使用 footerColorStyle。
footerColorStyle

object (ColorStyle)

最后一行或最后一列的颜色。如果未设置此字段，则最后的行或列会填充 firstBandColor 或 secondBandColor，具体取决于前一行或前一列的颜色。如果同时设置了 footerColor，则此字段优先。

DimensionGroup

工作表中某个行或列范围内的组，可以包含其他组，也可以被其他组包含。您可以在工作表中将组作为一个单元进行收起或展开。

JSON 表示法 
{
  "range": {
    object (DimensionRange)
  },
  "depth": integer,
  "collapsed": boolean
}
字段
range

object (DimensionRange)

此组的存在范围。
depth

integer

组的深度，表示有多少个组的范围完全包含此组的范围。
collapsed

boolean

如果此组处于收起状态，则此字段为 true。如果展开了深度较浅的重叠群组，则收起的群组仍会保持收起状态。

值为 true 并不意味着组中的所有维度都处于隐藏状态，因为维度的可见性可以独立于此组属性而发生变化。不过，更新此属性时，如果此字段设为 true，则其中的所有维度都设为“隐藏”；如果此字段设为 false，则其中的所有维度都设为“可见”。

切片器

工作表中的切片器。

JSON 表示法 
{
  "slicerId": integer,
  "spec": {
    object (SlicerSpec)
  },
  "position": {
    object (EmbeddedObjectPosition)
  }
}
字段
slicerId

integer

切片器的 ID。
spec

object (SlicerSpec)

切片器的规范。
position

object (EmbeddedObjectPosition)

切片器的位置。请注意，只有在现有工作表中才能放置切片器。此外，系统还可以自动调整 Slicer 的宽度和高度，使其保持在允许的范围内。

SlicerSpec

切片器的规格。

JSON 表示法 
{
  "dataRange": {
    object (GridRange)
  },
  "filterCriteria": {
    object (FilterCriteria)
  },
  "columnIndex": integer,
  "applyToPivotTables": boolean,
  "title": string,
  "textFormat": {
    object (TextFormat)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "horizontalAlignment": enum (HorizontalAlign)
}
字段
dataRange

object (GridRange)

切片器的数据范围。
filterCriteria

object (FilterCriteria)

切片器的过滤条件。
columnIndex

integer

应用过滤条件的数据表中列的编号（从零开始）。
applyToPivotTables

boolean

如果过滤条件应应用于数据透视表，则为 True。如果未设置，则默认为 True。
title

string

切片标题。
textFormat

object (TextFormat)

分屏中的标题的文本格式。不支持链接字段。
backgroundColor
(deprecated)

object (Color)

切片器的背景颜色。已废弃：请使用 backgroundColorStyle。
backgroundColorStyle

object (ColorStyle)

切片器的背景颜色。如果同时设置了 backgroundColor，则此字段优先。
horizontalAlignment

enum (HorizontalAlign)

分屏中的标题的水平对齐方式。如果未指定，则默认为 LEFT

表

表格。

JSON 表示法 
{
  "tableId": string,
  "name": string,
  "range": {
    object (GridRange)
  },
  "rowsProperties": {
    object (TableRowsProperties)
  },
  "columnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}
字段
tableId

string

表的 ID。
name

string

表名称。此名称在同一电子表格中的所有表中都是唯一的。
range

object (GridRange)

表格范围。
rowsProperties

object (TableRowsProperties)

表行属性。
columnProperties[]

object (TableColumnProperties)

表列属性。

TableRowsProperties

表格行属性。

JSON 表示法 
{
  "headerColorStyle": {
    object (ColorStyle)
  },
  "firstBandColorStyle": {
    object (ColorStyle)
  },
  "secondBandColorStyle": {
    object (ColorStyle)
  },
  "footerColorStyle": {
    object (ColorStyle)
  }
}
字段
headerColorStyle

object (ColorStyle)

标题行的颜色。如果设置了此字段，标题行将填充指定的颜色。否则，标题行将填充默认颜色。
firstBandColorStyle

object (ColorStyle)

第一个交替颜色。如果设置此字段，则第一个带状行会填充指定的颜色。否则，第一个带状行将填充默认颜色。
secondBandColorStyle

object (ColorStyle)

第二种交替颜色。如果设置此字段，则第二个带状行会填充指定的颜色。否则，第二个带状行将填充默认颜色。
footerColorStyle

object (ColorStyle)

最后一行的颜色。如果未设置此字段，则不会添加页脚，最后一行会填充 firstBandColorStyle 或 secondBandColorStyle，具体取决于上一行的颜色。如果将不带页脚的现有表更新为带页脚，则范围将扩展 1 行。如果更新带有页脚的现有表格并移除页脚，则范围会缩小 1 行。

TableColumnProperties

表格列。

JSON 表示法 
{
  "columnIndex": integer,
  "columnName": string,
  "columnType": enum (ColumnType),
  "dataValidationRule": {
    object (TableColumnDataValidationRule)
  }
}
字段
columnIndex

integer

列索引（从 0 开始）。此编号是相对于表格中的位置而言的，不一定与工作表中的列编号相同。
columnName

string

列名称。
columnType

enum (ColumnType)

列类型。
dataValidationRule

object (TableColumnDataValidationRule)

列数据验证规则。仅适用于下拉菜单列类型。

ColumnType

表中给定列的列类型。

枚举
COLUMN_TYPE_UNSPECIFIED 未指定的列类型。
DOUBLE 数字列类型。
CURRENCY 币种列类型。
PERCENT 百分比列类型。
DATE 日期列类型。
TIME 时间列类型。
DATE_TIME 日期时间列类型。
TEXT 文本列类型。
BOOLEAN 布尔值列类型。
DROPDOWN 下拉菜单列类型。
FILES_CHIP 文件条状标签列类型
PEOPLE_CHIP 人员条状标签列类型
FINANCE_CHIP 财经条状标签列类型
PLACE_CHIP 地点条状标签列类型
RATINGS_CHIP 评分条状标签列类型

TableColumnDataValidationRule

表中某个列的数据验证规则。

JSON 表示法 
{
  "condition": {
    object (BooleanCondition)
  }
}
字段
condition

object (BooleanCondition)

单元格中的数据必须满足的条件。仅当 [BooleanCondition.type] 为 ONE_OF_LIST 时有效。

NamedRange

命名的范围。

JSON 表示法 
{
  "namedRangeId": string,
  "name": string,
  "range": {
    object (GridRange)
  }
}
字段
namedRangeId

string

命名范围的 ID。
name

string

命名范围的名称。
range

object (GridRange)

此值所代表的范围。

DataSource

电子表格中外部数据源的相关信息。

JSON 表示法 
{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}
字段
dataSourceId

string

用于标识数据源的电子表格级唯一 ID。示例：1080547365。
spec

object (DataSourceSpec)

与此电子表格关联的数据源的 DataSourceSpec。
calculatedColumns[]

object (DataSourceColumn)

数据源中的所有计算列。
sheetId

integer

与数据源关联的 Sheet 的 ID。此字段一经设置便无法更改。

创建数据源时，系统还会创建关联的 DATA_SOURCE 工作表；如果未指定此字段，系统会随机生成所创建工作表的 ID。

DataSourceSpec

这会指定数据源的详细信息。例如，对于 BigQuery，此参数用于指定 BigQuery 来源的相关信息。

JSON 表示法 
{
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],

  // Union field spec can be only one of the following:
  "bigQuery": {
    object (BigQueryDataSourceSpec)
  },
  "looker": {
    object (LookerDataSourceSpec)
  }
  // End of list of possible types for union field spec.
}
字段
parameters[]

object (DataSourceParameter)

数据源的参数，用于查询数据源。
联合字段 spec。每种数据源类型的实际规范。spec 只能是下列其中一项：
bigQuery

object (BigQueryDataSourceSpec)

一个 BigQueryDataSourceSpec。
looker

object (LookerDataSourceSpec)

[LookerDatasourceSpec][]。

BigQueryDataSourceSpec

与工作表关联的 BigQuery 数据源的规范。

JSON 表示法 
{
  "projectId": string,

  // Union field spec can be only one of the following:
  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
  // End of list of possible types for union field spec.
}
字段
projectId

string

已启用 BigQuery 且已关联结算账号的 Google Cloud 项目的 ID。对于对数据源执行的任何查询，项目都会产生费用。
联合字段 spec。实际规范。spec 只能是下列其中一项：
querySpec

object (BigQueryQuerySpec)

一个 BigQueryQuerySpec。
tableSpec

object (BigQueryTableSpec)

一个 BigQueryTableSpec。

BigQueryQuerySpec

指定自定义 BigQuery 查询。

JSON 表示法 
{
  "rawQuery": string
}
字段
rawQuery

string

原始查询字符串。

BigQueryTableSpec

指定 BigQuery 表定义。仅允许使用原生表格。

JSON 表示法 
{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}
字段
tableProjectId

string

表所属的 BigQuery 项目的 ID。如果未指定，则假定为 projectId。
tableId

string

BigQuery 表 ID。
datasetId

string

BigQuery 数据集 ID。

LookerDataSourceSpec

Looker 数据源的规范。

JSON 表示法 
{
  "instanceUri": string,
  "model": string,
  "explore": string
}
字段
instanceUri

string

Looker 实例网址。
model

string

Looker 模型的名称。
explore

string

Looker 模型探索的名称。

DataSourceParameter

数据源查询中的参数。借助该参数，用户可以将电子表格中的值传入查询。

JSON 表示法 
{

  // Union field identifier can be only one of the following:
  "name": string
  // End of list of possible types for union field identifier.

  // Union field value can be only one of the following:
  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
  // End of list of possible types for union field value.
}
字段
联合字段 identifier。参数标识符。identifier 只能是下列其中一项：
name

string

指定参数。必须是支持该 DataSource 的有效标识符。例如，BigQuery 标识符。
联合字段 value。参数值。value 只能是下列其中一项：
namedRangeId

string

NamedRange 的 ID。其大小必须为 1x1。
range

object (GridRange)

包含参数值的范围。其尺寸必须为 1x1。

DataSourceRefreshSchedule

安排刷新数据源。

电子表格中的数据源会在一定时间间隔内刷新。您可以点击 Google 表格编辑器中的“安排的刷新”按钮来指定开始时间，但间隔时间固定为 4 小时。例如，如果您指定的开始时间为上午 8 点，则刷新将在每天上午 8 点到中午 12 点之间进行。

JSON 表示法 
{
  "enabled": boolean,
  "refreshScope": enum (DataSourceRefreshScope),
  "nextRun": {
    object (Interval)
  },

  // Union field schedule_config can be only one of the following:
  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
  // End of list of possible types for union field schedule_config.
}
字段
enabled

boolean

如果已启用刷新时间表，则为 true，否则为 false。
refreshScope

enum (DataSourceRefreshScope)

刷新的范围。必须为 ALL_DATA_SOURCES。
nextRun

object (Interval)

仅限输出。下次运行的时间间隔。
联合字段 schedule_config。时间表配置 schedule_config 只能是以下各项之一：
dailySchedule

object (DataSourceRefreshDailySchedule)

每日刷新时间表。
weeklySchedule

object (DataSourceRefreshWeeklySchedule)

每周刷新时间表。
monthlySchedule

object (DataSourceRefreshMonthlySchedule)

每月刷新时间表。

DataSourceRefreshScope

数据源刷新范围。

枚举
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED 默认值，请勿使用。
ALL_DATA_SOURCES 刷新电子表格中的所有数据源及其关联的数据源对象。

DataSourceRefreshDailySchedule

每天在给定时间间隔内刷新数据的时间表。

JSON 表示法 
{
  "startTime": {
    object (TimeOfDay)
  }
}
字段
startTime

object (TimeOfDay)

安排数据源刷新的时间间隔的开始时间。仅使用 hours 部分。时间间隔大小默认为 Google 表格编辑器中的大小。

TimeOfDay

表示一天中的某个时间。日期和时区不重要，或在别处指定。API 可以选择允许闰秒。相关类型为 google.type.Date 和 google.protobuf.Timestamp。

JSON 表示法 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
字段
hours

integer

一天中的时段（采用 24 小时制）。必须大于或等于 0，通常必须小于或等于 23。对于业务结束时间等场景，API 可以选择允许“24:00:00”一值。
minutes

integer

一小时中的分钟数。必须大于或等于 0，小于或等于 59。
seconds

integer

一分钟中的秒数。必须大于或等于 0，通常必须小于或等于 59。如果 API 允许闰秒，则 API 可以允许 60 一值。
nanos

integer

秒数的小数部分（以纳秒为单位）。必须大于或等于 0，且小于或等于 999,999,999。

DataSourceRefreshWeeklySchedule

每周时间表，用于在给定时间间隔内的特定日期刷新数据。

JSON 表示法 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
字段
startTime

object (TimeOfDay)

安排数据源刷新的时间间隔的开始时间。仅使用 hours 部分。时间间隔大小默认为 Google 表格编辑器中的大小。
daysOfWeek[]

enum (DayOfWeek)

刷新的星期几。必须指定至少一天。

DayOfWeek

表示星期几。

枚举
DAY_OF_WEEK_UNSPECIFIED 未指定星期几。
MONDAY 星期一
TUESDAY 星期二
WEDNESDAY 星期三
THURSDAY 星期四
FRIDAY 星期五
SATURDAY 星期六
SUNDAY 星期日

DataSourceRefreshMonthlySchedule

每月时间表，用于在给定时间间隔内的特定日期刷新数据。

JSON 表示法 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
字段
startTime

object (TimeOfDay)

安排数据源刷新的时间间隔的开始时间。仅使用 hours 部分。时间间隔大小默认为 Google 表格编辑器中的大小。
daysOfMonth[]

integer

刷新的日期。仅支持 1-28，对应于第 1 天到第 28 天。必须指定至少一天。

间隔

表示时间间隔，编码为开始时间戳（包括）和结束时间戳（不包括）。

开始时间必须小于或等于结束时间。如果开始时间等于结束时间，则间隔时间为空（不匹配任何时间）。如果同时未指定开始时间和结束时间，则该时间间隔与任何时间都匹配。

JSON 表示法 
{
  "startTime": string,
  "endTime": string
}
字段
startTime

string (Timestamp format)

可选。间隔时段的开始值（含）。

如果指定了此时间间隔，则与此时间间隔匹配的时间戳必须与开始时间相同或晚于开始时间。
endTime

string (Timestamp format)

可选。间隔时段（含端点值）的结束时间。

如果已指定，则与此间隔时间段匹配的时间戳必须在结束时间之前。

方法

batchUpdate

 将一个或多个更新应用于电子表格。

create

 创建电子表格，并返回新创建的电子表格。

get

 返回指定 ID 对应的电子表格。

getByDataFilter

 返回指定 ID 对应的电子表格。