- 资源:电子表格
- 电子表格属性
- 重新计算间隔
- 单元格格式
- 数字格式
- 数字格式类型
- 颜色
- 颜色样式
- ThemeColorType
- 边框
- 边框
- 样式
- 内边距
- HorizontalAlign
- 纵向对齐
- 封装策略
- 文字方向
- 文本格式
- 链接
- 超链接显示类型
- 文本旋转
- IterativeCalculationSettings
- 电子表格主题
- ThemeColorPair
- 表格
- SheetProperties
- 工作表类型
- GridProperties
- DataSourceSheetProperties
- DataSourceColumn
- DataSourceColumnReference
- DataExecutionStatus
- DataExecutionState
- DataExecutionErrorCode
- GridData
- RowData
- CellData
- ExtendedValue
- 错误值
- 错误类型
- TextFormatRun
- DataValidationRule
- 布尔值条件
- 条件类型
- 条件值
- 相对日期
- 数据透视表
- GridRange
- 数据透视组
- PivotGroupValueMetadata
- 排序顺序
- PivotGroupSortValueBucket
- PivotGroupRule
- ManualRule
- ManualRuleGroup
- 直方图
- DateTimeRule
- DateTimeRuleType
- PivotGroupLimit
- PivotFilterCriteria
- PivotFilterSpec
- 数据透视值
- PivotValueSummarizeFunction
- PivotValueCalculatedDisplayType
- 数据透视值布局
- DataSourceTable
- DataSourceTableColumnSelectionType
- FilterSpec
- FilterCriteria
- 排序规范
- DataSourceFormula
- DimensionProperties
- ConditionalFormatRule
- BooleanRule
- GDententRule
- InterpolationPoint
- InterpolationPointType
- FilterView
- ProtectedRange
- 编辑器
- 基本过滤条件
- 嵌入式图表
- 图表规范
- 文字位置
- DataSourceChartProperties
- BasicChartSpec
- BasicChartType
- BasicChartLegendPosition
- BasicChartAxis
- BasicChartAxisPosition
- ChartAxisViewWindowOptions
- ViewWindowMode
- BasicChartDomain
- 图表数据
- ChartSourceRange
- ChartGroupRule
- ChartDateTimeRule(图表规则)
- ChartDateTimeRuleType
- ChartHistogramRule
- 图表汇总类型
- BasicChartSeries
- LineStyle
- LineDashType
- DataLabel
- DataLabelType
- DataLabelPlacement
- PointStyle
- PointShape
- BasicSeriesDataPointStyleOverride
- BasicChartStackedType
- 基本图表比较模式
- PieChartSpec
- PieChartLegendPosition
- BubbleChartSpec
- BubbleChartLegendPosition
- CandlestickChartSpec
- CandlestickDomain
- CandlestickData
- KanddlestickSeries
- OrgChartSpec
- OrgChartNodeSize
- 直方图
- 直方图系列
- 直方图
- WaterfallChartSpec
- WaterfallChartDomain
- WaterfallChartSeries
- WaterfallChartColumnStyle
- WaterfallChartCustomSubtotal
- WaterfallChartStackedType
- TreemapChartSpec
- TreemapChartColorScale
- ScorecardChartSpec
- KeyValueFormat
- BaselineValueFormat
- 比较类型
- ChartNumberFormatSource
- ChartCustomNumberFormatOptions
- 图表隐藏的维度策略
- 嵌入式对象位置
- OverlayPosition
- GridCoordinate
- 嵌入式对象边界
- BandedRange
- BandingProperties
- 维度组
- Slicer
- SlicerSpec
- NamedRange
- 数据源
- DataSourceSpec
- BigQueryDataSourceSpec
- BigQueryQuerySpec
- BigQueryTableSpec
- DataSourceParameter
- DataSourceRefreshSchedule
- DataSourceRefreshScope
- DataSourceRefreshDailySchedule
- 时段
- DataSourceRefresh 每周时间表
- DayOfWeek
- DataSourceRefreshMonthlySchedule
- 间隔时间
- 方法
资源:电子表格
代表电子表格的资源。
JSON 表示法 |
---|
{ "spreadsheetId": string, "properties": { object ( |
字段 | |
---|---|
spreadsheetId |
电子表格的 ID。此字段为只读字段。 |
properties |
电子表格的整体属性。 |
sheets[] |
属于电子表格的工作表。 |
namedRanges[] |
在电子表格中定义的已命名范围。 |
spreadsheetUrl |
电子表格的网址。此字段为只读字段。 |
developerMetadata[] |
与电子表格相关联的开发者元数据。 |
dataSources[] |
与电子表格相关联的外部数据源的列表。 |
dataSourceSchedules[] |
仅供输出。数据源刷新时间表的列表。 |
电子表格属性
电子表格的属性。
JSON 表示法 |
---|
{ "title": string, "locale": string, "autoRecalc": enum ( |
字段 | |
---|---|
title |
电子表格的标题。 |
locale |
电子表格的语言区域,格式为:
注意:更新此字段时,并非所有语言区域/语言都受支持。 |
autoRecalc |
重新计算易变函数之前需要等待的时间。 |
timeZone |
电子表格的时区,采用 CLDR 格式,例如 |
defaultFormat |
电子表格中所有单元格的默认格式。如果单元格的格式等于此默认格式,系统将不会设置 |
iterativeCalculationSettings |
确定循环引用是否以及如何通过迭代计算解析。此字段缺失表示循环引用会导致计算错误。 |
spreadsheetTheme |
应用于电子表格的主题。 |
重新计算间隔
枚举可能的重新计算间隔选项。
枚举 | |
---|---|
RECALCULATION_INTERVAL_UNSPECIFIED |
默认值。不得使用此值。 |
ON_CHANGE |
每次更改时,易变函数都会更新。 |
MINUTE |
每分钟都会更新易变函数。 |
HOUR |
易变函数会在每次更改时更新,并且每小时更新一次。 |
IterativeCalculationSettings
用于控制如何使用迭代计算解析循环依赖项的设置。
JSON 表示法 |
---|
{ "maxIterations": integer, "convergenceThreshold": number } |
字段 | |
---|---|
maxIterations |
启用迭代计算后,要执行的计算轮数上限。 |
convergenceThreshold |
如果启用了迭代计算,并且连续结果相差小于此阈值,则计算轮次将停止。 |
电子表格主题
代表电子表格主题
JSON 表示法 |
---|
{
"primaryFontFamily": string,
"themeColors": [
{
object ( |
字段 | |
---|---|
primaryFontFamily |
主要字体系列的名称。 |
themeColors[] |
电子表格主题颜色对。如需更新,您必须提供所有主题颜色对。 |
主题颜色配对
用于将电子表格主题颜色类型映射到其所表示的具体颜色的一对颜色。
JSON 表示法 |
---|
{ "colorType": enum ( |
字段 | |
---|---|
colorType |
电子表格主题颜色的类型。 |
color |
与主题颜色类型对应的具体颜色。 |
命名范围
已命名的范围。
JSON 表示法 |
---|
{
"namedRangeId": string,
"name": string,
"range": {
object ( |
字段 | |
---|---|
namedRangeId |
命名范围的 ID。 |
name |
命名范围的名称。 |
range |
所代表的范围。 |
DataSource
电子表格中外部数据源的相关信息。
JSON 表示法 |
---|
{ "dataSourceId": string, "spec": { object ( |
字段 | |
---|---|
dataSourceId |
用于标识数据源的电子表格范围的唯一 ID。示例:1080547365。 |
spec |
与此电子表格关联的数据源的 |
calculatedColumns[] |
数据源中的所有计算列。 |
sheetId |
与数据源关联的 创建数据源时,系统还会创建关联的 |
数据源
用于指定数据源的详细信息。例如,对于 BigQuery,此字段会指定 BigQuery 来源的相关信息。
JSON 表示法 |
---|
{ "parameters": [ { object ( |
字段 | |
---|---|
parameters[] |
数据源的参数,在查询数据源时使用。 |
联合字段 spec 。每种数据源类型的实际规范。spec 只能是下列其中一项: |
|
bigQuery |
|
BigQueryDataSourceSpec
连接到工作表的 BigQuery 数据源的规范。
JSON 表示法 |
---|
{ "projectId": string, // Union field |
字段 | |
---|---|
projectId |
启用了 BigQuery 且关联了结算帐号的 Google Cloud 项目的 ID。对于针对数据源执行的任何查询,您需要为项目支付费用。 |
联合字段 spec 。实际规格。spec 只能是下列其中一项: |
|
querySpec |
|
tableSpec |
|
BigQuery 查询规范
指定自定义 BigQuery 查询。
JSON 表示法 |
---|
{ "rawQuery": string } |
字段 | |
---|---|
rawQuery |
原始查询字符串。 |
BigQueryTableSpec
指定 BigQuery 表定义。只允许使用原生表。
JSON 表示法 |
---|
{ "tableProjectId": string, "tableId": string, "datasetId": string } |
字段 | |
---|---|
tableProjectId |
表所属的 BigQuery 项目的 ID。如果未指定,则假定为 |
tableId |
BigQuery 表 ID。 |
datasetId |
BigQuery 数据集 ID。 |
DataSourceParameter
数据源查询中的参数。该参数可让用户将电子表格中的值传入查询中。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 identifier 。参数标识符。identifier 只能是下列其中一项: |
|
name |
已命名的参数。必须是支持它的 |
联合字段 value 。参数值。value 只能是下列其中一项: |
|
namedRangeId |
|
range |
包含参数值的范围。其尺寸必须为 1x1。 |
数据源刷新时间表
数据源刷新计划。
电子表格中的数据源会按一定的时间间隔刷新。您可以在 Google 表格编辑器中点击“定时刷新”按钮来指定开始时间,但间隔为 4 小时。例如,如果您指定开始时间是上午 8 点,则刷新操作会在每天早上 8 点到中午 12 点之间进行。
JSON 表示法 |
---|
{ "enabled": boolean, "refreshScope": enum ( |
字段 | |
---|---|
enabled |
如果启用了刷新时间表,则为 true,否则为 false。 |
refreshScope |
刷新范围。必须为 |
nextRun |
仅供输出。下次运行的时间间隔。 |
联合字段 schedule_config 。时间表配置“schedule_config ”只能是下列其中一项: |
|
dailySchedule |
每日刷新时间表。 |
weeklySchedule |
每周刷新时间表。 |
monthlySchedule |
每月刷新时间表。 |
数据源刷新范围
数据源刷新范围。
枚举 | |
---|---|
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 和 999999999 之间的数字。 |
DataSourceRefresh 每周时间表
让数据在给定时间间隔内在特定日期刷新的每周时间表。
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 的电子表格。 |