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)

僅供輸出。資料來源重新整理時間表清單。

試算表屬性

試算表的屬性,

JSON 表示法
{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  }
}
欄位
title

string

試算表的標題。

locale

string

試算表的語言代碼,格式如下:

  • ISO 639-1 語言代碼,例如 en

  • 如果沒有 ISO 639-1 代碼,請使用 fil 等 ISO 639-2 語言代碼

  • 結合 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)

主題已套用至試算表。

重新計算間隔

可能的重新計算間隔選項的列舉。

列舉
RECALCULATION_INTERVAL_UNSPECIFIED 預設值。這個值不可使用。
ON_CHANGE 變動的函式會在每次變更時更新。
MINUTE 易變函式每週或每分鐘都會更新。
HOUR 易變函式會隨每次變更及每小時更新。

IterativeCalculationSettings

控制疊代依附元件計算方式的設定。

JSON 表示法
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
欄位
maxIterations

integer

啟用反覆運算時,要進行計算的計算次數上限。

convergenceThreshold

number

啟用疊代計算後,連續結果與此門檻值不同時,就會停止計算。

試算表主題

代表試算表主題

JSON 表示法
{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object (ThemeColorPair)
    }
  ]
}
欄位
primaryFontFamily

string

主要字型系列的名稱。

themeColors[]

object (ThemeColorPair)

試算表主題顏色配對。如要更新,您必須提供所有主題顏色組合。

主題色彩配對

一對試算表主題顏色,對應至該顏色代表的具體顏色。

JSON 表示法
{
  "colorType": enum (ThemeColorType),
  "color": {
    object (ColorStyle)
  }
}
欄位
colorType

enum (ThemeColorType)

試算表主題顏色的類型。

color

object (ColorStyle)

與主題顏色類型對應的具體顏色。

已命名範圍

已命名範圍。

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。

資料來源規格

這會指定資料來源的詳細資料。以 BigQuery 為例,這會指定 BigQuery 來源的相關資訊。

JSON 表示法
{
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],

  // Union field spec can be only one of the following:
  "bigQuery": {
    object (BigQueryDataSourceSpec)
  }
  // End of list of possible types for union field spec.
}
欄位
parameters[]

object (DataSourceParameter)

資料來源的參數,在查詢資料來源時使用。

聯集欄位 spec。每個資料來源類型的實際規格。spec 只能是下列其中一項:
bigQuery

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec

BigQuery 資料來源規格

已連結至工作表的 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

BigQuery 查詢規格

指定自訂 BigQuery 查詢。

JSON 表示法
{
  "rawQuery": string
}
欄位
rawQuery

string

原始查詢字串。

BigQuery 資料表規格

指定 BigQuery 資料表定義。只允許原生資料表

JSON 表示法
{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}
欄位
tableProjectId

string

資料表所屬的 BigQuery 專案 ID。如未指定,系統會採用 projectId

tableId

string

BigQuery 資料表 ID。

datasetId

string

BigQuery 資料集 ID。

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。

資料來源重新整理時間表

排定重新整理資料來源。

試算表中的資料來源會在時間間隔內重新整理。您可以按一下試算表編輯器中的 [定時重新整理] 按鈕來指定開始時間,不過時間間隔會固定於 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

如果已啟用重新整理時間表,則傳回 True,否則傳回 False。

refreshScope

enum (DataSourceRefreshScope)

重新整理範圍,必須為 ALL_DATA_SOURCES

nextRun

object (Interval)

僅供輸出。下次跑步的時間間隔。

聯集欄位 schedule_config。排程設定 schedule_config 只能採用下列其中一種設定:
dailySchedule

object (DataSourceRefreshDailySchedule)

每日重新整理時間表。

weeklySchedule

object (DataSourceRefreshWeeklySchedule)

每週重新整理時間表。

monthlySchedule

object (DataSourceRefreshMonthlySchedule)

每月的重新整理時間表。

資料來源重新整理範圍

資料來源重新整理範圍。

列舉
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED 預設值,請勿使用。
ALL_DATA_SOURCES 在試算表中重新整理所有資料來源及其相關聯的資料來源物件。

DataSourceRefreshDailySchedule

資料每天在指定的時間間隔重新整理。

JSON 表示法
{
  "startTime": {
    object (TimeOfDay)
  }
}
欄位
startTime

object (TimeOfDay)

資料來源重新整理排程的時間間隔開始時間。僅使用 hours 部分。試算表編輯器中的時間間隔預設為預設值。

TimeOfDay

代表一天中的時間。日期和時區並不需要指定,或是在其他位置上指定。API 可選擇允許閏秒。相關類型為 google.type.Dategoogle.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)

一週的哪幾天要重新整理。必須至少指定一天。

星期幾

代表一週中的某一天。

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

DataSourceRefreshMonthSchedule

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

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 的試算表。