Cells

CellData

特定儲存格的相關資料。

JSON 表示法
{
  "userEnteredValue": {
    object (ExtendedValue)
  },
  "effectiveValue": {
    object (ExtendedValue)
  },
  "formattedValue": string,
  "userEnteredFormat": {
    object (CellFormat)
  },
  "effectiveFormat": {
    object (CellFormat)
  },
  "hyperlink": string,
  "note": string,
  "textFormatRuns": [
    {
      object (TextFormatRun)
    }
  ],
  "dataValidation": {
    object (DataValidationRule)
  },
  "pivotTable": {
    object (PivotTable)
  },
  "dataSourceTable": {
    object (DataSourceTable)
  },
  "dataSourceFormula": {
    object (DataSourceFormula)
  }
}
欄位
userEnteredValue

object (ExtendedValue)

使用者在儲存格中輸入的值。例如: 1234, 'Hello',或 =NOW() 注意:日期、時間和日期時間會以雙精度浮點數表示 serial number 格式。

effectiveValue

object (ExtendedValue)

儲存格的有效值。對於含有公式的儲存格,這是計算值。對於含有文字的儲存格,這與 userEnteredValue 相同。這是唯讀欄位。

formattedValue

string

儲存格的格式化值。這是使用者看到的值。這是唯讀欄位。

userEnteredFormat

object (CellFormat)

使用者為儲存格輸入的格式。

寫入時,新格式會與現有格式合併。

effectiveFormat

object (CellFormat)

儲存格目前使用的有效格式。包括套用任何條件式格式設定的結果,以及如果儲存格中含有公式,也會計算經過計算的數字格式。如果有效格式是預設格式,系統就不會寫入有效格式。這是唯讀欄位。

note

string

儲存格中的任何記事。

textFormatRuns[]

object (TextFormatRun)

套用至儲存格子區段的 RTF 格式執行作業。執行作業只適用於使用者輸入的字串,不適用於公式、布林值或數字。執行作業的屬性從文字中的特定索引開始,然後持續到下一次執行。除非有明確變更,否則執行作業會繼承儲存格的屬性。

寫入時,新的執行作業會覆寫任何先前的執行作業。撰寫新的 userEnteredValue,系統會清除先前的執行作業。

dataValidation

object (DataValidationRule)

儲存格的資料驗證規則 (如果有的話)。

寫入時,新的資料驗證規則會覆寫所有先前的規則。

pivotTable

object (PivotTable)

固定在這個儲存格的資料透視表。系統會根據資料、分組、篩選器、值等條件,動態計算資料透視表的大小。只有資料透視表左上方的儲存格含有資料透視表定義。其他儲存格會包含樞紐結果的計算值,其採用 effectiveValue 只要使用來自這些領域的 小型資料集訓練即可

dataSourceTable

object (DataSourceTable)

固定在這個儲存格的資料來源表格。系統會根據設定,動態計算資料來源資料表的大小。只有資料來源表格的第一個儲存格包含資料來源表格定義。其他儲存格會包含資料來源表格結果的顯示值 effectiveValue 只要使用來自這些領域的 小型資料集訓練即可

dataSourceFormula

object (DataSourceFormula)

僅供輸出。儲存格資料來源公式的相關資訊。如果 userEnteredValue 這個公式參照了 DATA_SOURCE 工作表 (例如 =SUM(DataSheet!Column)

CellFormat

儲存格的格式。

JSON 表示法
{
  "numberFormat": {
    object (NumberFormat)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "borders": {
    object (Borders)
  },
  "padding": {
    object (Padding)
  },
  "horizontalAlignment": enum (HorizontalAlign),
  "verticalAlignment": enum (VerticalAlign),
  "wrapStrategy": enum (WrapStrategy),
  "textDirection": enum (TextDirection),
  "textFormat": {
    object (TextFormat)
  },
  "hyperlinkDisplayType": enum (HyperlinkDisplayType),
  "textRotation": {
    object (TextRotation)
  }
}
欄位
numberFormat

object (NumberFormat)

說明應以何種方式向使用者顯示數字值的格式。

backgroundColor
(deprecated)

object (Color)

儲存格的背景顏色。已淘汰:使用 backgroundColorStyle

backgroundColorStyle

object (ColorStyle)

儲存格的背景顏色。如果 backgroundColor 也會設定這個欄位,這個欄位的優先順序最高。

borders

object (Borders)

儲存格的框線。

padding

object (Padding)

儲存格的邊框間距。

horizontalAlignment

enum (HorizontalAlign)

儲存格中值的水平對齊方式。

verticalAlignment

enum (VerticalAlign)

儲存格中值的垂直對齊方式。

wrapStrategy

enum (WrapStrategy)

儲存格中值的包裝策略。

textDirection

enum (TextDirection)

儲存格中的文字方向。

textFormat

object (TextFormat)

儲存格中的文字格式 (除非是採用格式覆寫)。在這裡設定儲存格層級連結會清除儲存格現有的連結。在 TextFormatRun 的優先順序高於儲存格層級連結。

textRotation

object (TextRotation)

所選文字的旋轉角度會套用至儲存格中的文字。

NumberFormat

儲存格的數字格式。

JSON 表示法
{
  "type": enum (NumberFormatType),
  "pattern": string
}
欄位
type

enum (NumberFormatType)

數字格式的類型。寫入時,必須設定這個欄位。

pattern

string

用於格式化的模式字串。如果未設定,系統就會視需要使用根據使用者語言代碼建立的預設模式 (適用於指定類型)。詳情請參閱 日期和數字格式指南 參閱相關文章,進一步瞭解支援的模式。

NumberFormatType

儲存格的數字格式。本說明文件將語言代碼假設為 en_US,但實際格式取決於試算表的語言代碼。

列舉
NUMBER_FORMAT_TYPE_UNSPECIFIED 這個數字格式並非取決於儲存格內容,請勿明確使用此功能。
TEXT 設定文字格式,例如 1000.12
NUMBER 數字格式設定,例如 1,000.12
PERCENT 百分比格式設定,例如 10.12%
CURRENCY 貨幣格式設定,例如: $1,000.12
DATE 日期格式設定,例如 9/26/2008
TIME 時間格式設定,例如 3:59:00 PM
DATE_TIME 日期 + 時間格式設定,例如 9/26/08 15:59:00
SCIENTIFIC 科學數字格式設定,例如: 1.01E+03

框線

儲存格的框線。

JSON 表示法
{
  "top": {
    object (Border)
  },
  "bottom": {
    object (Border)
  },
  "left": {
    object (Border)
  },
  "right": {
    object (Border)
  }
}
欄位
top

object (Border)

儲存格的上框線。

bottom

object (Border)

儲存格的下框線。

left

object (Border)

儲存格的左框線。

right

object (Border)

儲存格的右側框線。

框線

儲存格框線。

JSON 表示法
{
  "style": enum (Style),
  "width": integer,
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  }
}
欄位
style

enum (Style)

邊框的樣式。

width
(deprecated)

integer

邊框的寬度 (以像素為單位)。已淘汰;寬度取決於「樣式」] 欄位。

color
(deprecated)

object (Color)

邊框的顏色。已淘汰:使用 colorStyle

colorStyle

object (ColorStyle)

邊框的顏色。如果 color 也會設定這個欄位,這個欄位的優先順序最高。

風格

框線的樣式。

列舉
STYLE_UNSPECIFIED 未指定樣式。請勿使用此屬性。
DOTTED 邊框為虛線。
DASHED 邊框為虛線。
SOLID 邊框為細線。
SOLID_MEDIUM 邊框為中型實線。
SOLID_THICK 邊框為粗線。
NONE 無框線。僅在更新框線時才使用。
DOUBLE 邊框為兩條實線。

邊框間距

儲存格周圍的邊框間距量,以像素為單位。更新邊框間距時,必須指定所有欄位。

JSON 表示法
{
  "top": integer,
  "right": integer,
  "bottom": integer,
  "left": integer
}
欄位
top

integer

儲存格的上邊框間距。

right

integer

儲存格的右側邊框間距。

bottom

integer

儲存格的底部邊框間距。

left

integer

儲存格的左側邊框間距。

VerticalAlign

儲存格中文字的垂直對齊方式。

列舉
VERTICAL_ALIGN_UNSPECIFIED 未指定垂直對齊方式。請勿使用此屬性。
TOP 文字會明確對齊儲存格頂端。
MIDDLE 文字會明確對齊儲存格中間。
BOTTOM 文字會明確對齊儲存格底部。

WrapStrategy

如何自動換行。

列舉
WRAP_STRATEGY_UNSPECIFIED 預設值,不使用。
OVERFLOW_CELL

大於儲存格寬度的行會在下一個儲存格中寫入,只要該儲存格為空白即可。如果下一個儲存格的值為非空白,此行為與 CLIP。除非使用者手動插入新的一行,否則文字不會自動換行。範例:

| First sentence. |
| Manual newline that is very long. <- Text continues into next cell
| Next newline.   |
LEGACY_WRAP

這項包裝策略代表舊版 Google 試算表的包裝策略,將長度超過一行的字詞截斷,而非截斷。這項策略不適用於部分平台,且即將停用。範例:

| Cell has a |
| loooooooooo| <- Word is clipped.
| word.      |
CLIP

系統會將超過儲存格寬度的線條裁剪。除非使用者手動插入新的一行,否則文字不會自動換行。範例:

| First sentence. |
| Manual newline t| <- Text is clipped
| Next newline.   |
WRAP

長度超過一行的字詞會納入字元層級,而不會被截斷。範例:

| Cell has a |
| loooooooooo| <- Word is broken.
| ong word.  |

TextDirection

儲存格中的文字方向。

列舉
TEXT_DIRECTION_UNSPECIFIED 未指定文字方向。請勿使用此屬性。
LEFT_TO_RIGHT 使用者已設定從左到右的文字方向。
RIGHT_TO_LEFT 使用者已設定從右到左的文字方向。

HyperlinkDisplayType

是否明確算繪超連結。若未指定,系統會連結超連結。

列舉
LINKED 超連結必須明確顯示。
PLAIN_TEXT 不應算繪超連結。

TextRotation

所選文字的旋轉角度會套用至儲存格中的文字。

JSON 表示法
{

  // Union field type can be only one of the following:
  "angle": integer,
  "vertical": boolean
  // End of list of possible types for union field type.
}
欄位
聯集欄位 type。旋轉的類型,垂直或角度。 type 只能為下列其中一項:
angle

integer

標準方向與所需螢幕方向之間的角度。以度為單位的測量結果。有效值介於 -90 到 90 之間。正角度向上傾斜。

注意:如果 LTR 文字方向正角為逆時針方向,則 RTL 會按順時針方向移動。

vertical

boolean

設為 true 時,文字會由上到下顯示,但個別字元的方向則維持不變。例如:

| V |
| e |
| r |
| t |
| i |
| c |
| a |
| l |

TextFormatRun

文字格式的執行。此執行作業的格式會持續進行,直到下次執行索引開始索引為止。更新時,須設定所有欄位。

JSON 表示法
{
  "startIndex": integer,
  "format": {
    object (TextFormat)
  }
}
欄位
startIndex

integer

此執行作業從零開始的字元索引,以 UTF-16 程式碼單位表示。

format

object (TextFormat)

這項執行作業的格式。未提供的值會沿用儲存格的格式。

DataValidationRule

資料驗證規則。

JSON 表示法
{
  "condition": {
    object (BooleanCondition)
  },
  "inputMessage": string,
  "strict": boolean,
  "showCustomUi": boolean
}
欄位
condition

object (BooleanCondition)

儲存格中的資料必須符合的條件。

inputMessage

string

在儲存格中新增資料時向使用者顯示的訊息。

strict

boolean

如果無效資料應遭拒,則為 True。

showCustomUi

boolean

如果應根據條件種類自訂 UI,則為「true」。如果為 true,則顯示「清單」條件就會顯示下拉式選單

DataSourceTable

資料來源資料表,可讓使用者從 DataSource 轉換為試算表這些功能也稱為「擷取」。

JSON 表示法
{
  "dataSourceId": string,
  "columnSelectionType": enum (DataSourceTableColumnSelectionType),
  "columns": [
    {
      object (DataSourceColumnReference)
    }
  ],
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ],
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "rowLimit": integer,
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
欄位
dataSourceId

string

與資料來源資料表相關聯的資料來源 ID。

columnSelectionType

enum (DataSourceTableColumnSelectionType)

用來選取資料來源資料表資料欄的類型。預設為 SELECTED

columns[]

object (DataSourceColumnReference)

已為資料來源資料表選取的資料欄。 columnSelectionType 必須是 SELECTED

filterSpecs[]

object (FilterSpec)

資料來源表格中的篩選器規格。

sortSpecs[]

object (SortSpec)

排序資料來源表格中的規格。資料來源表格的結果是按照排序規格排序。

rowLimit

integer

要傳回的列數上限。如果未設定,系統會套用預設限制。如要瞭解預設和上限,請參閱試算表編輯器。

dataExecutionStatus

object (DataExecutionStatus)

僅供輸出。資料執行狀態。

DataSourceTableColumnSelectionType

資料來源表格的資料欄選取類型。

列舉
DATA_SOURCE_TABLE_COLUMN_SELECTION_TYPE_UNSPECIFIED 預設欄選取類型 (不使用)。
SELECTED 選取指定的資料欄 columns ] 欄位。
SYNC_ALL

同步處理資料來源中目前和日後的所有資料欄。

如果已設定,資料來源表格會在重新整理時擷取資料來源中的所有資料欄。

DataSourceFormula

資料來源公式。

JSON 表示法
{
  "dataSourceId": string,
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
欄位
dataSourceId

string

與公式相關聯的資料來源 ID。

dataExecutionStatus

object (DataExecutionStatus)

僅供輸出。資料執行狀態。