- 资源:电子表格
- 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
- DimensionProperties
- ConditionalFormatRule
- BooleanRule
- GradientRule
- InterpolationPoint
- InterpolationPointType
- FilterView
- ProtectedRange
- 编辑者
- BasicFilterBasicFilter
- EmbeddedChart
- ChartSpec
- TextPosition
- DataSourceChartProperties
- BasicChartSpec
- BasicChartType
- BasicChartLegendPosition
- BasicChartAxis
- BasicChartAxisPosition
- ChartAxisViewWindowOptions
- ViewWindowMode
- BasicChartDomainBasicChartDomain
- 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
- BaselineValueFormatBaselineValueFormat
- ComparisonType
- ChartNumberFormatSource
- ChartCustomNumberFormatOptions
- ChartHiddenDimensionStrategy
- EmbeddedObjectPosition
- OverlayPosition
- GridCoordinate
- EmbeddedObjectBorder
- BandedRange
- BandingProperties
- DimensionGroup
- 截剪器
- SlicerSpec
- NamedRange
- DataSource
- DataSourceSpec
- BigQueryDataSourceSpec
- BigQueryQuerySpec
- BigQueryTableSpec
- 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。 |
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 |
|
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。 |
DataSourceParameter
数据源查询中的参数。该参数允许用户将电子表格中的值传入查询中。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 identifier 。参数标识符。identifier 只能是下列其中一项: |
|
name |
命名参数。必须是支持此属性的 |
联合字段 value 。参数值。value 只能是下列其中一项: |
|
namedRangeId |
|
range |
包含参数值的范围。其尺寸必须为 1x1。 |
DataSourceRefreshSchedule
刷新数据源的时间安排。
电子表格中的数据源会在一定的时间间隔内刷新。您可以通过点击表格编辑器中的“计划刷新”按钮来指定开始时间,但间隔固定为 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 和 999999999 之间的数字。 |
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 号。必须至少指定一天。 |
间隔时间
表示时间间隔,编码为时间戳开始(含)和时间戳结束(不含)。
开始时间必须小于或等于结束时间。如果开始时间与结束时间相同,则间隔为空(不匹配时间)。如果未指定 start 和 end,则间隔在任何时间都匹配。
JSON 表示法 |
---|
{ "startTime": string, "endTime": string } |
字段 | |
---|---|
startTime |
可选。间隔的开始值(含)。 如果指定,则与此间隔匹配的时间戳必须与开始时间相同或晚于开始时间。 |
endTime |
可选。间隔时间结束(不含)。 如果指定,则与此间隔匹配的时间戳必须位于结束日期之前。 |
方法 |
|
---|---|
|
对电子表格应用一项或多项更新。 |
|
创建电子表格,返回新创建的电子表格。 |
|
返回具有指定 ID 的电子表格。 |
|
返回具有指定 ID 的电子表格。 |