REST Resource: spreadsheets

资源：Spreadsheet

表示电子表格的资源。

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

string

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

object (SpreadsheetProperties)

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

object (Sheet)

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

object (NamedRange)

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

string

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

object (DeveloperMetadata)

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

object (DataSource)

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

object (DataSourceRefreshSchedule)

仅限输出。数据源刷新时间表的列表。
comments[]

object (CommentThread)

与电子表格关联的评论会话。
commentsViewMode

enum (CommentsViewMode)

仅限输出。应用于电子表格的评论视图模式。

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 易变函数会在每次更改时以及每小时更新一次。

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)

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

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)
    }
  ],

  "bigQuery": {
    object (BigQueryDataSourceSpec)
  },
  "looker": {
    object (LookerDataSourceSpec)
  }
}
字段
parameters[]

object (DataSourceParameter)

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

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec。
looker

object (LookerDataSourceSpec)

[LookerDatasourceSpec][]。

BigQueryDataSourceSpec

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

JSON 表示法 
{
  "projectId": string,

  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
}
字段
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 表示法 
{

  "name": string

  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
}
字段
联合字段 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)
  },

  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
}
字段
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)

可选。时间间隔的结束时间（不含）。

如果指定，则与此时间间隔匹配的时间戳必须早于结束时间。

CommentThread

表示电子表格中的单个评论串。

JSON 表示法 
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  "plainTextQuote": string
}
字段
commentId

string

评论线程的唯一 ID。
anchorId

string

相应线程所关联的工作表中 CommentAnchor 的 ID。
headPost

object (Post)

相应帖子串中的第一篇帖子。
replies[]

object (Post)

对主帖的回复。
status

enum (Status)

相应问题串是未结还是已解决。
联合字段 quote。创建评论时文档中的引用文本。quote 只能是下列其中一项：
plainTextQuote

string

创建评论时电子表格中的引用文本，格式为纯文本。

帖子

表示评论串中的单个帖子。

JSON 表示法 
{
  "postId": string,
  "content": string,
  "contentHtml": string,
  "author": {
    object (PostAuthor)
  },
  "createTime": string,
  "updateTime": string,
  "deleted": boolean,
  "fromImportedSpreadsheet": boolean,
  "fromCopiedSpreadsheet": boolean,
  "assigneeEmail": string,
  "commentAction": enum (CommentActionType)
}
字段
postId

string

仅限输出。帖子的唯一 ID。
content

string

帖子的内容。

如果 commentAction 不是 RESOLVE 或 REOPEN，则必须为非空值。

此文本内容的处理方式与在 Google 表格编辑器中创建的注释类似。在格式设置、通知等方面，它将具有类似的行为。

不得超过 2048 个 UTF-8 代码单元。
contentHtml

string

仅限输出。相应帖子的内容（以 HTML 格式表示）。
author

object (PostAuthor)

仅限输出。创建帖子的用户。
createTime

string (Timestamp format)

仅限输出。帖子的创建时间。
updateTime

string (Timestamp format)

仅限输出。相应帖子上次更新的时间。
deleted

boolean

仅限输出。相应帖子是否已删除。如果值为 true，则 content 和 author 字段将为空。
fromImportedSpreadsheet

boolean

仅限输出。相应帖子是否来自导入的电子表格。调用者无法直接设置此字段。
fromCopiedSpreadsheet

boolean

仅限输出。相应帖子是否来自复制的电子表格。调用者无法直接设置此字段。
assigneeEmail

string

可选。作为此帖子的一部分，新分配给相应主题的用户电子邮件地址。

如果出现以下情况，则返回 400 无效请求错误：
commentAction

enum (CommentActionType)

在创建帖子时采取的操作。

PostAuthor

表示评论帖子的作者。

JSON 表示法 
{
  "displayName": string,
  "me": boolean,
  "anonymous": boolean,
  "user": string
}
字段
displayName

string

用户的显示名称。如果作者是匿名，则可能不存在。
me

boolean

用户是否为发出请求的经过身份验证的用户。
anonymous

boolean

用户是否为匿名用户。
user

string

帖子作者用户的资源名称，也可用于在 Google People API 中标识用户。格式：users/{user}。如果匿名字段为 true，或者帖子来自导入的电子表格，则不会填充此字段。

CommentActionType

针对评论串中的回复采取的操作。

枚举
COMMENT_ACTION_TYPE_UNSPECIFIED 默认值。此值未使用。
NO_COMMENT_ACTION_CHANGE 此帖子中未发生任何操作变化。
RESOLVE 此帖子解决了相应问题串。
REOPEN 此帖子会重新打开相应主题串。

状态

评论串的状态选项。

枚举
STATUS_UNSPECIFIED 默认值。此值未使用。
OPEN 评论串处于打开状态。
RESOLVED 评论串已解决。

CommentsViewMode

应用于电子表格的评论查看模式，用于指明是否包含评论。它提供了用于读取包含或不包含评论和评论锚点的电子表格的选项。

枚举
COMMENTS_VIEW_MODE_UNSPECIFIED 未指定 CommentsViewMode；应用 COMMENTS_VIEW_MODE_OMITTED。
COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS 应用于返回的电子表格的 CommentsViewMode 取决于用户的当前访问权限级别。如果用户仅拥有查看权限，则应用 COMMENTS_VIEW_MODE_OMITTED。否则，系统会应用 COMMENTS_VIEW_MODE_INCLUDED。
COMMENTS_VIEW_MODE_OMITTED 返回的电子表格已省略评论。
COMMENTS_VIEW_MODE_INCLUDED

返回的电子表格包含评论。

如果用户没有查看评论的权限，则使用此模式检索电子表格的请求将返回 403 错误。

方法

batchUpdate

 对电子表格应用一项或多项更新。

create

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

get

 返回具有指定 ID 的电子表格。

getByDataFilter

 返回具有指定 ID 的电子表格。