Cells

行動數據

特定儲存格的相關資料。

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() 注意:日期、時間和 DateTimes 會以雙精度 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)),則會設定這個欄位。

儲存格格式

儲存格的格式。

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)

已為儲存格中的文字套用旋轉設定。

數字格式

儲存格的數字格式。

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.  |

文字方向

儲存格文字方向。

列舉
TEXT_DIRECTION_UNSPECIFIED 未指定文字方向。請勿使用。
LEFT_TO_RIGHT 使用者是由左到右的文字方向。
RIGHT_TO_LEFT 由右到左的文字方向是由使用者設定。

HyperlinkDisplayType

是否明確顯示超連結。如未指定,則超連結。

列舉
LINKED 應明確顯示超連結。
PLAIN_TEXT 請勿顯示超連結。

文字旋轉

將文字旋轉至儲存格中的文字。

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,「清單」條件會顯示下拉式選單。

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)

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