- 资源:电子表格
 - SpreadsheetProperties
 - RecalculationInterval
 - CellFormat
 - NumberFormat
 - NumberFormatType
 - 颜色
 - ColorStyle
 - ThemeColorType
 - 边框
 - 边框
 - 样式
 - 内边距
 - HorizontalAlign
 - VerticalAlign
 - WrapStrategy
 - TextDirection
 - TextFormat
 - 链接
 - HyperlinkDisplayType
 - TextRotation
 - IterativeCalculationSettings
 - SpreadsheetTheme
 - ThemeColorPair
 - 工作表
 - SheetProperties
 - SheetType
 - GridProperties
 - DataSourceSheetProperties
 - DataSourceColumn
 - DataSourceColumnReference
 - DataExecutionStatus
 - DataExecutionState
 - DataExecutionErrorCode
 - GridData
 - RowData
 - CellData
 - ExtendedValue
 - ErrorValue
 - ErrorType
 - TextFormatRun
 - DataValidationRule
 - BooleanCondition
 - ConditionType
 - ConditionValue
 - RelativeDate
 - PivotTable
 - GridRange
 - PivotGroup
 - PivotGroupValueMetadata
 - SortOrder
 - PivotGroupSortValueBucket
 - PivotGroupRule
 - ManualRule
 - ManualRuleGroup
 - HistogramRule
 - DateTimeRule
 - DateTimeRuleType
 - PivotGroupLimit
 - PivotFilterCriteria
 - PivotFilterSpec
 - PivotValue
 - PivotValueSummarizeFunction
 - PivotValueCalculatedDisplayType
 - PivotValueLayout
 - DataSourceTable
 - DataSourceTableColumnSelectionType
 - FilterSpec
 - FilterCriteria
 - SortSpec
 - DataSourceFormula
 - ChipRun
 - 条状标签
 - PersonProperties
 - DisplayFormat
 - RichLinkProperties
 - DimensionProperties
 - ConditionalFormatRule
 - BooleanRule
 - GradientRule
 - InterpolationPoint
 - InterpolationPointType
 - FilterView
 - ProtectedRange
 - 编辑者
 - BasicFilter
 - EmbeddedChart
 - ChartSpec
 - TextPosition
 - DataSourceChartProperties
 - BasicChartSpec
 - BasicChartType
 - BasicChartLegendPosition
 - BasicChartAxis
 - BasicChartAxisPosition
 - ChartAxisViewWindowOptions
 - ViewWindowMode
 - BasicChartDomain
 - ChartData
 - ChartSourceRange
 - ChartGroupRule
 - ChartDateTimeRule
 - ChartDateTimeRuleType
 - ChartHistogramRule
 - ChartAggregateType
 - BasicChartSeries
 - LineStyle
 - LineDashType
 - DataLabel
 - DataLabelType
 - DataLabelPlacement
 - PointStyle
 - PointShape
 - BasicSeriesDataPointStyleOverride
 - BasicChartStackedType
 - BasicChartCompareMode
 - PieChartSpec
 - PieChartLegendPosition
 - BubbleChartSpec
 - BubbleChartLegendPosition
 - CandlestickChartSpec
 - CandlestickDomain
 - CandlestickData
 - CandlestickSeries
 - OrgChartSpec
 - OrgChartNodeSize
 - HistogramChartSpec
 - HistogramSeries
 - HistogramChartLegendPosition
 - WaterfallChartSpec
 - WaterfallChartDomain
 - WaterfallChartSeries
 - WaterfallChartColumnStyle
 - WaterfallChartCustomSubtotal
 - WaterfallChartStackedType
 - TreemapChartSpec
 - TreemapChartColorScale
 - ScorecardChartSpec
 - KeyValueFormat
 - BaselineValueFormat
 - ComparisonType
 - ChartNumberFormatSource
 - ChartCustomNumberFormatOptions
 - ChartHiddenDimensionStrategy
 - EmbeddedObjectPosition
 - OverlayPosition
 - GridCoordinate
 - EmbeddedObjectBorder
 - BandedRange
 - BandingProperties
 - DimensionGroup
 - Slicer
 - SlicerSpec
 - 表
 - TableRowsProperties
 - TableColumnProperties
 - ColumnType
 - TableColumnDataValidationRule
 - NamedRange
 - DataSource
 - DataSourceSpec
 - BigQueryDataSourceSpec
 - BigQueryQuerySpec
 - BigQueryTableSpec
 - LookerDataSourceSpec
 - DataSourceParameter
 - DataSourceRefreshSchedule
 - DataSourceRefreshScope
 - DataSourceRefreshDailySchedule
 - TimeOfDay
 - DataSourceRefreshWeeklySchedule
 - DayOfWeek
 - DataSourceRefreshMonthlySchedule
 - 间隔时间
 - 方法
 
资源:电子表格
表示电子表格的资源。
| JSON 表示法 | 
|---|
{ "spreadsheetId": string, "properties": { object (  | 
              
| 字段 | |
|---|---|
spreadsheetId | 
                
                   
 电子表格的 ID。此字段为只读字段。  | 
              
properties | 
                
                   
 电子表格的整体属性。  | 
              
sheets[] | 
                
                   
 电子表格中的工作表。  | 
              
namedRanges[] | 
                
                   
 电子表格中定义的命名范围。  | 
              
spreadsheetUrl | 
                
                   
 电子表格的网址。此字段为只读字段。  | 
              
developerMetadata[] | 
                
                   
 与电子表格关联的开发者元数据。  | 
              
dataSources[] | 
                
                   
 与电子表格关联的外部数据源的列表。  | 
              
dataSourceSchedules[] | 
                
                   
 仅限输出。数据源刷新时间表列表。  | 
              
SpreadsheetProperties
电子表格的属性。
| JSON 表示法 | 
|---|
{ "title": string, "locale": string, "autoRecalc": enum (  | 
              
| 字段 | |
|---|---|
title | 
                
                   
 电子表格的标题。  | 
              
locale | 
                
                   
 电子表格的语言区域,采用以下某种格式: 
 注意:更新此字段时,并非所有语言区域/语言都受支持。  | 
              
autoRecalc | 
                
                   
 在重新计算易失性函数之前等待的时间。  | 
              
timeZone | 
                
                   
 电子表格的时区,采用 CLDR 格式,例如   | 
              
defaultFormat | 
                
                   
 电子表格中所有单元格的默认格式。如果单元格的格式与此默认格式相同,则不会设置   | 
              
iterativeCalculationSettings | 
                
                   
 确定是否以及如何通过迭代计算来解析循环引用。如果缺少此字段,则表示循环引用会导致计算错误。  | 
              
spreadsheetTheme | 
                
                   
 应用于电子表格的主题。  | 
              
importFunctionsExternalUrlAccessAllowed | 
                
                   
 是否允许图片和导入函数访问外部网址。仅当值为 true 时才可读取。如果为 false,您可以将其设置为 true。如果管理员启用了许可名单功能,系统会绕过此值,并始终返回 true。  | 
              
RecalculationInterval
枚举可能的重算间隔选项。
| 枚举 | |
|---|---|
RECALCULATION_INTERVAL_UNSPECIFIED | 
                默认值。不得使用此值。 | 
ON_CHANGE | 
                易变函数会在每次发生更改时更新。 | 
MINUTE | 
                易变函数会在每次更改和每分钟更新一次。 | 
HOUR | 
                易变函数会在每次更改和每小时更新一次。 | 
IterativeCalculationSettings
用于控制如何通过迭代计算来解析循环依赖项的设置。
| JSON 表示法 | 
|---|
{ "maxIterations": integer, "convergenceThreshold": number }  | 
              
| 字段 | |
|---|---|
maxIterations | 
                
                   
 启用迭代计算时,要执行的计算轮次数上限。  | 
              
convergenceThreshold | 
                
                   
 启用迭代计算后,如果连续结果的差值低于此阈值,计算轮次将停止。  | 
              
SpreadsheetTheme
表示电子表格主题
| JSON 表示法 | 
|---|
{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object ( | 
              
| 字段 | |
|---|---|
primaryFontFamily | 
                
                   
 主字体系列的名称。  | 
              
themeColors[] | 
                
                   
 电子表格主题颜色对。如需进行更新,您必须提供所有主题颜色对。  | 
              
ThemeColorPair
将电子表格主题颜色类型映射到其代表的具体颜色的对。
| JSON 表示法 | 
|---|
{ "colorType": enum (  | 
              
| 字段 | |
|---|---|
colorType | 
                
                   
 电子表格主题颜色的类型。  | 
              
color | 
                
                   
 与主题颜色类型对应的具体颜色。  | 
              
NamedRange
命名的范围。
| JSON 表示法 | 
|---|
{
  "namedRangeId": string,
  "name": string,
  "range": {
    object ( | 
              
| 字段 | |
|---|---|
namedRangeId | 
                
                   
 命名范围的 ID。  | 
              
name | 
                
                   
 命名范围的名称。  | 
              
range | 
                
                   
 此值所代表的范围。  | 
              
DataSource
电子表格中外部数据源的相关信息。
| JSON 表示法 | 
|---|
{ "dataSourceId": string, "spec": { object (  | 
              
| 字段 | |
|---|---|
dataSourceId | 
                
                   
 用于标识数据源的电子表格级唯一 ID。示例:1080547365。  | 
              
spec | 
                
                   
 与此电子表格关联的数据源的   | 
              
calculatedColumns[] | 
                
                   
 数据源中的所有计算列。  | 
              
sheetId | 
                
                   
 与数据源关联的  创建数据源时,系统还会创建关联的   | 
              
DataSourceSpec
这会指定数据源的详细信息。例如,对于 BigQuery,此参数用于指定 BigQuery 来源的相关信息。
| JSON 表示法 | 
|---|
{ "parameters": [ { object (  | 
              
| 字段 | |
|---|---|
parameters[] | 
                
                   
 数据源的参数,用于查询数据源。  | 
              
联合字段 spec。每种数据源类型的实际规范。spec 只能是下列其中一项: | 
              |
bigQuery | 
                
                   
  | 
              
looker | 
                
                   
 [LookerDatasourceSpec][]。  | 
              
BigQueryDataSourceSpec
与工作表关联的 BigQuery 数据源的规范。
| JSON 表示法 | 
|---|
{ "projectId": string, // Union field  | 
              
| 字段 | |
|---|---|
projectId | 
                
                   
 已启用 BigQuery 且已关联结算账号的 Google Cloud 项目的 ID。对于对数据源执行的任何查询,项目都会产生费用。  | 
              
联合字段 spec。实际规范。spec 只能是下列其中一项: | 
              |
querySpec | 
                
                   
  | 
              
tableSpec | 
                
                   
  | 
              
BigQueryQuerySpec
指定自定义 BigQuery 查询。
| JSON 表示法 | 
|---|
{ "rawQuery": string }  | 
              
| 字段 | |
|---|---|
rawQuery | 
                
                   
 原始查询字符串。  | 
              
BigQueryTableSpec
指定 BigQuery 表定义。仅允许使用原生表格。
| JSON 表示法 | 
|---|
{ "tableProjectId": string, "tableId": string, "datasetId": string }  | 
              
| 字段 | |
|---|---|
tableProjectId | 
                
                   
 表所属的 BigQuery 项目的 ID。如果未指定,则假定为   | 
              
tableId | 
                
                   
 BigQuery 表 ID。  | 
              
datasetId | 
                
                   
 BigQuery 数据集 ID。  | 
              
LookerDataSourceSpec
Looker 数据源的规范。
| JSON 表示法 | 
|---|
{ "instanceUri": string, "model": string, "explore": string }  | 
              
| 字段 | |
|---|---|
instanceUri | 
                
                   
 Looker 实例网址。  | 
              
model | 
                
                   
 Looker 模型的名称。  | 
              
explore | 
                
                   
 Looker 模型探索的名称。  | 
              
DataSourceParameter
数据源查询中的参数。借助该参数,用户可以将电子表格中的值传入查询。
| JSON 表示法 | 
|---|
{ // Union field  | 
              
| 字段 | |
|---|---|
联合字段 identifier。参数标识符。identifier 只能是下列其中一项: | 
              |
name | 
                
                   
 指定参数。必须是支持该   | 
              
联合字段 value。参数值。value 只能是下列其中一项: | 
              |
namedRangeId | 
                
                   
 
  | 
              
range | 
                
                   
 包含参数值的范围。其尺寸必须为 1x1。  | 
              
DataSourceRefreshSchedule
安排刷新数据源。
电子表格中的数据源会在一定时间间隔内刷新。您可以点击 Google 表格编辑器中的“安排的刷新”按钮来指定开始时间,但间隔时间固定为 4 小时。例如,如果您指定的开始时间为上午 8 点,则刷新将在每天上午 8 点到中午 12 点之间进行。
| JSON 表示法 | 
|---|
{ "enabled": boolean, "refreshScope": enum (  | 
              
| 字段 | |
|---|---|
enabled | 
                
                   
 如果已启用刷新时间表,则为 true,否则为 false。  | 
              
refreshScope | 
                
                   
 刷新的范围。必须为   | 
              
nextRun | 
                
                   
 仅限输出。下次运行的时间间隔。  | 
              
联合字段 schedule_config。时间表配置 schedule_config 只能是以下各项之一: | 
              |
dailySchedule | 
                
                   
 每日刷新时间表。  | 
              
weeklySchedule | 
                
                   
 每周刷新时间表。  | 
              
monthlySchedule | 
                
                   
 每月刷新时间表。  | 
              
DataSourceRefreshScope
数据源刷新范围。
| 枚举 | |
|---|---|
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED | 
                默认值,请勿使用。 | 
ALL_DATA_SOURCES | 
                刷新电子表格中的所有数据源及其关联的数据源对象。 | 
DataSourceRefreshDailySchedule
每天在给定时间间隔内刷新数据的时间表。
| JSON 表示法 | 
|---|
{
  "startTime": {
    object ( | 
              
| 字段 | |
|---|---|
startTime | 
                
                   
 安排数据源刷新的时间间隔的开始时间。仅使用   | 
              
TimeOfDay
表示一天中的某个时间。日期和时区不重要,或在别处指定。API 可以选择允许闰秒。相关类型为 google.type.Date 和 google.protobuf.Timestamp。
| JSON 表示法 | 
|---|
{ "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer }  | 
              
| 字段 | |
|---|---|
hours | 
                
                   
 一天中的时段(采用 24 小时制)。必须大于或等于 0,通常必须小于或等于 23。对于业务结束时间等场景,API 可以选择允许“24:00:00”一值。  | 
              
minutes | 
                
                   
 一小时中的分钟数。必须大于或等于 0,小于或等于 59。  | 
              
seconds | 
                
                   
 一分钟中的秒数。必须大于或等于 0,通常必须小于或等于 59。如果 API 允许闰秒,则 API 可以允许 60 一值。  | 
              
nanos | 
                
                   
 秒数的小数部分(以纳秒为单位)。必须大于或等于 0,且小于或等于 999,999,999。  | 
              
DataSourceRefreshWeeklySchedule
每周时间表,用于在给定时间间隔内的特定日期刷新数据。
| JSON 表示法 | 
|---|
{ "startTime": { object (  | 
              
| 字段 | |
|---|---|
startTime | 
                
                   
 安排数据源刷新的时间间隔的开始时间。仅使用   | 
              
daysOfWeek[] | 
                
                   
 刷新的日期。必须指定至少一天。  | 
              
DayOfWeek
表示星期几。
| 枚举 | |
|---|---|
DAY_OF_WEEK_UNSPECIFIED | 
                未指定星期几。 | 
MONDAY | 
                星期一 | 
TUESDAY | 
                星期二 | 
WEDNESDAY | 
                星期三 | 
THURSDAY | 
                星期四 | 
FRIDAY | 
                星期五 | 
SATURDAY | 
                星期六 | 
SUNDAY | 
                星期日 | 
DataSourceRefreshMonthlySchedule
每月时间表,用于在给定时间间隔内的特定日期刷新数据。
| JSON 表示法 | 
|---|
{
  "startTime": {
    object ( | 
              
| 字段 | |
|---|---|
startTime | 
                
                   
 安排数据源刷新的时间间隔的开始时间。仅使用   | 
              
daysOfMonth[] | 
                
                   
 刷新的日期。仅支持 1-28,对应于第 1 天到第 28 天。必须指定至少一天。  | 
              
间隔
表示时间间隔,编码为开始时间戳(包括)和结束时间戳(不包括)。
开始时间必须小于或等于结束时间。如果开始时间等于结束时间,则间隔时间为空(不匹配任何时间)。如果同时未指定开始时间和结束时间,则该时间间隔与任何时间都匹配。
| JSON 表示法 | 
|---|
{ "startTime": string, "endTime": string }  | 
              
| 字段 | |
|---|---|
startTime | 
                
                   
 可选。间隔时段的开始值(含)。 如果指定了此时间间隔,则与此时间间隔匹配的时间戳必须与开始时间相同或晚于开始时间。  | 
              
endTime | 
                
                   
 可选。间隔时段(含端点值)的结束时间。 如果已指定,则与此间隔时段匹配的时间戳必须在结束时间之前。  | 
              
方法 | 
            |
|---|---|
                
 | 
              将一个或多个更新应用于电子表格。 | 
                
 | 
              创建电子表格,并返回新创建的电子表格。 | 
                
 | 
              返回指定 ID 对应的电子表格。 | 
                
 | 
              返回指定 ID 对应的电子表格。 |