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

  • 如果沒有 639-1 代碼，則採用 ISO 639-2 語言代碼，例如 fil

  • 由 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。如果管理員已啟用許可清單功能，系統會略過這個值，並一律傳回「是」。

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

  // 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。參數 ID。identifier 只能是下列其中一項：
name

string

已命名參數。必須是支援該函式的 DataSource 的合法 ID。例如 BigQuery ID。
聯集欄位 value。參數值。value 只能是下列其中一項：
namedRangeId

string

NamedRange 的 ID。大小必須為 1x1。
range

object (GridRange)

包含參數值的範圍。大小必須為 1x1。

DataSourceRefreshSchedule

安排重新整理資料來源的時間。

試算表中的資料來源會在一段時間內更新。如要指定開始時間，請點選試算表編輯器中的 [安排重新整理時間] 按鈕，但時間間隔固定為 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

如果已啟用重新整理時間表，則為「是」；否則傳回「否」。
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 部分。時間間隔的預設大小在試算表編輯器中。

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 允許閏秒，則可允許值為 60。
nanos

integer

秒數的小數，以奈秒表示。值必須介於 0 到 999,999,999 之間。

DataSourceRefreshWeeklySchedule

系統每週都會根據指定時間間隔，更新特定日期的資料。

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

object (TimeOfDay)

排定資料來源重新整理作業的時間間隔開始時間。只使用 hours 部分。時間間隔的預設大小在試算表編輯器中。
daysOfWeek[]

enum (DayOfWeek)

一週中要重新整理的天數。至少須指定一天。

DayOfWeek

代表星期幾。

列舉
DAY_OF_WEEK_UNSPECIFIED 未指定星期幾。
MONDAY 星期一
TUESDAY 週二
WEDNESDAY 週三
THURSDAY 週四
FRIDAY Friday (週五)
SATURDAY Saturday (週六)
SUNDAY 星期日

DataSourceRefreshMonthlySchedule

資料每月按照指定時間間隔在當月的特定日期重新整理。

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

object (TimeOfDay)

排定資料來源重新整理作業的時間間隔開始時間。只使用 hours 部分。時間間隔的預設大小在試算表編輯器中。
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 的試算表。