Other

顏色

代表 RGBA 色域中的顏色。這個表示法旨在簡化各種語言的色彩表示法之間的轉換，而非追求緊湊。舉例來說，這個表示法的欄位可以輕鬆提供給 Java 中的建構函式 java.awt.Color，也可以輕鬆提供給 iOS 中的 UIColor 的 +colorWithRed:green:blue:alpha 方法，而且只要稍加處理，就能輕鬆格式化為 JavaScript 中的 CSS rgba() 字串。

這個參考頁面沒有關於絕對色域的資訊，因此無法解讀 RGB 值，例如 sRGB、Adobe RGB、DCI-P3 和 BT.2020。根據預設，應用程式應採用 sRGB 色域。

需要判斷顏色是否相等時，除非另有說明，否則如果兩個顏色的紅色、綠色、藍色和 Alpha 值各自最多相差 1e-5，實作項目就會將這兩個顏色視為相等。

範例 (Java)：

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

範例 (iOS / Obj-C)：

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

範例 (JavaScript)：

// ...

var protoToCssColor = function(rgbColor) {
   var redFrac = rgbColor.red || 0.0;
   var greenFrac = rgbColor.green || 0.0;
   var blueFrac = rgbColor.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgbColor)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgbColor.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...

JSON 表示法
{ "red": number, "green": number, "blue": number, "alpha": number }

欄位
`red`	`number` 顏色中的紅色量，值介於 [0, 1] 之間。
`green`	`number` 顏色中的綠色量，值介於 [0, 1] 之間。
`blue`	`number` 顏色中的藍色量，值介於 [0, 1] 之間。
`alpha`	`number` 應套用至像素的顏色比例。也就是說，最終像素顏色是由下列方程式定義： `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` 也就是說，值為 1.0 時，顏色為實心；值為 0.0 時，顏色完全透明。這會使用封裝訊息，而非簡單的浮點純量，因此可以區分預設值和未設定的值。如果省略，這個顏色物件會以實心顏色算繪 (如同 Alpha 值已明確設為 1.0)。

ColorStyle

顏色值。

JSON 表示法
{ // Union field `kind` can be only one of the following: "rgbColor": { object (`Color`) }, "themeColor": enum (`ThemeColorType`) // End of list of possible types for union field `kind`. }

欄位

欄位
聯集欄位 `kind`。顏色值的種類。 `kind` 只能是下列其中一項：
`rgbColor`	`object (Color)` RGB 顏色。一般來說，系統不支援 `Color` 物件中的 `alpha` 值。
`themeColor`	`enum (ThemeColorType)` 主題顏色。

聯集欄位 kind。顏色值的種類。 kind 只能是下列其中一項：

rgbColor

object (Color)

RGB 顏色。一般來說，系統不支援 Color 物件中的 alpha 值。

themeColor

enum (ThemeColorType)

主題顏色。

ThemeColorType

主題顏色類型。

SpreadsheetProperties 包含 SpreadsheetTheme ，可將這些主題顏色類型對應至具體顏色。

列舉
`THEME_COLOR_TYPE_UNSPECIFIED`	未指定主題顏色
`TEXT`	代表主要文字顏色
`BACKGROUND`	代表主要背景顏色
`ACCENT1`	代表第一個強調色
`ACCENT2`	代表第二個強調色
`ACCENT3`	代表第三個強調色
`ACCENT4`	代表第四個強調色
`ACCENT5`	代表第五個強調色
`ACCENT6`	代表第六個強調色
`LINK`	代表超連結使用的顏色

HorizontalAlign

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

列舉
`HORIZONTAL_ALIGN_UNSPECIFIED`	未指定水平對齊方式。請勿使用此屬性。
`LEFT`	文字會明確靠左對齊儲存格。
`CENTER`	文字會明確對齊儲存格中央。
`RIGHT`	文字會明確靠右對齊儲存格。

TextFormat

儲存格中一段文字的格式。如果沒有值，表示未指定該欄位。

JSON 表示法

JSON 表示法
{ "foregroundColor": { object (`Color`) }, "foregroundColorStyle": { object (`ColorStyle`) }, "fontFamily": string, "fontSize": integer, "bold": boolean, "italic": boolean, "strikethrough": boolean, "underline": boolean, "link": { object (`Link`) } }

{
  "foregroundColor": {
    object (Color)
  },
  "foregroundColorStyle": {
    object (ColorStyle)
  },
  "fontFamily": string,
  "fontSize": integer,
  "bold": boolean,
  "italic": boolean,
  "strikethrough": boolean,
  "underline": boolean,
  "link": {
    object (Link)
  }
}

欄位
`foregroundColor (deprecated)`	`object (Color)` 這個項目已淘汰！文字的前景顏色。已淘汰：請改用 `foregroundColorStyle`。
`foregroundColorStyle`	`object (ColorStyle)` 文字的前景顏色。如果同時設定了 `foregroundColor`，系統會優先採用這個欄位。
`fontFamily`	`string` 字型系列。
`fontSize`	`integer` 字型大小。
`bold`	`boolean` 如果文字為粗體，則為 True。
`italic`	`boolean` 如果文字為斜體，則為 True。
`strikethrough`	`boolean` 如果文字有刪除線，則為 True。
`underline`	`boolean` 如果文字加上底線，則為 True。
`link`	`object (Link)` 文字的連結目的地 (如有)。在 `TextFormatRun` 中設定連結欄位，會清除儲存格的現有連結，或在相同要求中設定的儲存格層級連結。設定連結後，文字前景顏色會設為預設連結顏色，且文字會加上底線。如果這些欄位在同一個要求中經過修改，系統會使用這些值，而非連結預設值。

連結

外部或本機參照。

JSON 表示法
{ // Union field `destination` can be only one of the following: "uri": string // End of list of possible types for union field `destination`. }

欄位

欄位
聯集欄位 `destination`。連結目的地。 `destination` 只能是下列其中一項：
`uri`	`string` 連結 ID。

聯集欄位 destination。連結目的地。 destination 只能是下列其中一項：

uri

string

連結 ID。

DataSourceColumn

資料來源中的資料欄。

JSON 表示法
{ "reference": { object (`DataSourceColumnReference`) }, "formula": string }

欄位

欄位
`reference`	`object (DataSourceColumnReference)` 資料欄參照。
`formula`	`string` 計算結果欄的公式。

reference

object (DataSourceColumnReference)

資料欄參照。

formula

string

計算結果欄的公式。

DataSourceColumnReference

參照資料來源資料欄的專屬 ID。

JSON 表示法
{ "name": string }

欄位

欄位
`name`	`string` 資料欄的顯示名稱。在資料來源中不得重複。

name

string

資料欄的顯示名稱。在資料來源中不得重複。

DataExecutionStatus

資料執行狀態。

系統會建立資料執行作業，將資料來源物件與 DataSource 的最新資料同步。這項作業通常會排定在背景執行，您可以檢查其 state，判斷執行作業是否完成。

在下列幾種情況下，系統會觸發資料執行作業：

Adding a data source 建立相關聯的資料來源工作表，以及將資料從資料來源同步至工作表的資料執行作業。
Updating a data source 會建立資料執行程序，以類似的方式重新整理相關聯的資料來源工作表。
您可以傳送 refresh request ，明確重新整理一或多個資料來源物件。

JSON 表示法
{ "state": enum (`DataExecutionState`), "errorCode": enum (`DataExecutionErrorCode`), "errorMessage": string, "lastRefreshTime": string }

欄位
`state`	`enum (DataExecutionState)` 資料執行的狀態。
`errorCode`	`enum (DataExecutionErrorCode)` 錯誤代碼。
`errorMessage`	`string` 錯誤訊息，可能為空白。
`lastRefreshTime`	`string (Timestamp format)` 取得上次成功重新整理資料的時間。

DataExecutionState

資料執行狀態的列舉。

列舉
`DATA_EXECUTION_STATE_UNSPECIFIED`	預設值，請勿使用。
`NOT_STARTED`	資料執行作業尚未開始。
`RUNNING`	資料執行程序已啟動並正在執行。
`CANCELLING`	系統目前正在取消資料執行作業。
`SUCCEEDED`	資料執行作業已順利完成。
`FAILED`	資料執行程序已完成，但發生錯誤。

DataExecutionErrorCode

資料執行錯誤代碼的列舉。

列舉
`DATA_EXECUTION_ERROR_CODE_UNSPECIFIED`	預設值，請勿使用。
`TIMED_OUT`	資料執行作業逾時。
`TOO_MANY_ROWS`	資料執行作業傳回的列數超出上限。
`TOO_MANY_COLUMNS`	資料執行結果傳回的欄數超過上限。
`TOO_MANY_CELLS`	資料執行結果傳回的儲存格數量超出上限。
`ENGINE`	後端資料執行引擎 (例如 BigQuery) 傳回錯誤。詳情請參閱 `errorMessage`。
`PARAMETER_INVALID`	您提供的一或多個資料來源參數無效。
`UNSUPPORTED_DATA_TYPE`	資料執行結果傳回不支援的資料類型。
`DUPLICATE_COLUMN_NAMES`	資料執行結果傳回重複的欄名或別名。
`INTERRUPTED`	資料執行作業中斷。請稍後再重新整理。
`CONCURRENT_QUERY`	資料執行作業目前正在進行中，完成前無法重新整理。
`OTHER`	其他錯誤。
`TOO_MANY_CHARS_PER_CELL`	資料執行結果傳回的值超過單一儲存格允許的字元數上限。
`DATA_NOT_FOUND`	找不到資料來源參照的資料庫。*/
`PERMISSION_DENIED`	使用者無權存取資料來源參照的資料庫。
`MISSING_COLUMN_ALIAS`	資料執行結果傳回缺少別名的欄。
`OBJECT_NOT_FOUND`	資料來源物件不存在。
`OBJECT_IN_ERROR_STATE`	資料來源物件目前處於錯誤狀態，如要強制重新整理，請在 `RefreshDataSourceRequest` 中將 `force` 設為 `RefreshDataSourceRequest`。
`OBJECT_SPEC_INVALID`	資料來源物件規格無效。
`DATA_EXECUTION_CANCELLED`	資料執行作業已取消。

ExtendedValue

試算表儲存格可擁有的值類型。

JSON 表示法

JSON 表示法
{ // Union field `value` can be only one of the following: "numberValue": number, "stringValue": string, "boolValue": boolean, "formulaValue": string, "errorValue": { object (`ErrorValue`) } // End of list of possible types for union field `value`. }

{

  // Union field value can be only one of the following:
  "numberValue": number,
  "stringValue": string,
  "boolValue": boolean,
  "formulaValue": string,
  "errorValue": {
    object (ErrorValue)
  }
  // End of list of possible types for union field value.
}

欄位
聯集欄位 `value`。儲存格中的值類型。如果未設定任何欄位，儲存格就不會有資料。 `value` 只能是下列其中一項：
`numberValue`	`number` 表示雙精度浮點數值。注意：日期、時間和日期時間會以 `SERIAL_NUMBER` 格式表示為雙精度浮點數。
`stringValue`	`string` 代表字串值。開頭單引號不計入。舉例來說，如果使用者在 UI 中輸入 `'123` ，這會以 `stringValue` 的 `"123"`表示。
`boolValue`	`boolean` 表示布林值。
`formulaValue`	`string` 代表公式。
`errorValue`	`object (ErrorValue)` 代表錯誤。這是唯讀欄位。

ErrorValue

儲存格發生錯誤。

JSON 表示法
{ "type": enum (`ErrorType`), "message": string }

欄位

欄位
`type`	`enum (ErrorType)` 錯誤類型。
`message`	`string` 含有錯誤相關資訊的訊息 (以試算表地區設定顯示)。

type

enum (ErrorType)

錯誤類型。

message

string

含有錯誤相關資訊的訊息 (以試算表地區設定顯示)。

ErrorType

錯誤類型。

列舉
`ERROR_TYPE_UNSPECIFIED`	預設錯誤類型，請勿使用。
`ERROR`	對應於 `#ERROR!` 錯誤。
`NULL_VALUE`	對應於 `#NULL!` 錯誤。
`DIVIDE_BY_ZERO`	對應於 `#DIV/0` 錯誤。
`VALUE`	對應於 `#VALUE!` 錯誤。
`REF`	對應於 `#REF!` 錯誤。
`NAME`	對應於 `#NAME?` 錯誤。
`NUM`	對應於 `#NUM!` 錯誤。
`N_A`	對應於 `#N/A` 錯誤。
`LOADING`	對應於 `Loading...` 狀態。

BooleanCondition

可評估為 true 或 false 的條件。條件式格式設定、資料驗證和篩選器中的條件都會使用 BooleanCondition。

JSON 表示法
{ "type": enum (`ConditionType`), "values": [ { object (`ConditionValue`) } ] }

欄位

欄位
`type`	`enum (ConditionType)` 條件類型。
`values[]`	`object (ConditionValue)` 條件的值。支援的值數量取決於 `condition type`。有些支援零個值，有些支援一或兩個值，而 `ConditionType.ONE_OF_LIST` 則支援任意數量的值。

type

enum (ConditionType)

條件類型。

values[]

object (ConditionValue)

條件的值。支援的值數量取決於 condition type。有些支援零個值，有些支援一或兩個值，而 ConditionType.ONE_OF_LIST 則支援任意數量的值。

ConditionType

條件類型。

列舉
`CONDITION_TYPE_UNSPECIFIED`	預設值，請勿使用。
`NUMBER_GREATER`	儲存格的值必須大於條件的值。資料驗證、條件式格式設定和篩選器都支援這項功能。需要單一 `ConditionValue`。
`NUMBER_GREATER_THAN_EQ`	儲存格的值必須大於或等於條件的值。資料驗證、條件式格式設定和篩選器都支援這項功能。需要單一 `ConditionValue`。
`NUMBER_LESS`	儲存格的值必須小於條件的值。資料驗證、條件式格式設定和篩選器都支援這項功能。需要單一 `ConditionValue`。
`NUMBER_LESS_THAN_EQ`	儲存格的值必須小於或等於條件的值。資料驗證、條件式格式設定和篩選器都支援這項功能。需要單一 `ConditionValue`。
`NUMBER_EQ`	儲存格的值必須等於條件的值。資料驗證、條件式格式設定和篩選器都支援這項功能。非資料來源物件的資料驗證、條件式格式和篩選器需要單一 `ConditionValue`，資料來源物件的篩選器則需要至少一個 `ConditionValue`。
`NUMBER_NOT_EQ`	儲存格的值不得等於條件的值。資料驗證、條件式格式設定和篩選器都支援這項功能。非資料來源物件的資料驗證、條件式格式和篩選器需要單一 `ConditionValue`，資料來源物件的篩選器則需要至少一個 `ConditionValue`。
`NUMBER_BETWEEN`	儲存格的值必須介於兩個條件值之間。資料驗證、條件式格式設定和篩選器都支援這項功能。需要兩個 `ConditionValues`。
`NUMBER_NOT_BETWEEN`	儲存格的值不得介於兩個條件值之間。資料驗證、條件式格式設定和篩選器都支援這項功能。需要兩個 `ConditionValues`。
`TEXT_CONTAINS`	儲存格的值必須包含條件的值。資料驗證、條件式格式設定和篩選器都支援這項功能。需要單一 `ConditionValue`。
`TEXT_NOT_CONTAINS`	儲存格的值不得包含條件的值。資料驗證、條件式格式設定和篩選器都支援這項功能。需要單一 `ConditionValue`。
`TEXT_STARTS_WITH`	儲存格的值開頭必須是條件的值。條件式格式設定和篩選器都支援這項功能。需要單一 `ConditionValue`。
`TEXT_ENDS_WITH`	儲存格的值結尾必須是條件的值。條件式格式設定和篩選器都支援這項功能。需要單一 `ConditionValue`。
`TEXT_EQ`	儲存格的值必須與條件的值完全相同。資料驗證、條件式格式設定和篩選器都支援這項功能。非資料來源物件的資料驗證、條件式格式和篩選器需要單一 `ConditionValue`，資料來源物件的篩選器則需要至少一個 `ConditionValue`。
`TEXT_IS_EMAIL`	儲存格的值必須是有效的電子郵件地址。支援資料驗證。不需要 `ConditionValues`。
`TEXT_IS_URL`	儲存格的值必須是有效的網址。支援資料驗證。不需要 `ConditionValues`。
`DATE_EQ`	儲存格的值必須與條件的值是同一天。資料驗證、條件式格式設定和篩選器都支援這項功能。非資料來源物件的資料驗證、條件式格式和篩選器需要單一 `ConditionValue`，資料來源物件的篩選器則需要至少一個 `ConditionValue`。
`DATE_BEFORE`	儲存格的值必須早於條件值中的日期。資料驗證、條件式格式設定和篩選器都支援這項功能。需要單一 `ConditionValue`，可以是 `relative date`。
`DATE_AFTER`	儲存格的值必須晚於條件值日期。資料驗證、條件式格式設定和篩選器都支援這項功能。需要單一 `ConditionValue`，可以是 `relative date`。
`DATE_ON_OR_BEFORE`	儲存格的值必須等於或早於條件值。支援資料驗證。需要單一 `ConditionValue`，可以是 `relative date`。
`DATE_ON_OR_AFTER`	儲存格的值必須等於或晚於條件值。支援資料驗證。需要單一 `ConditionValue`，可以是 `relative date`。
`DATE_BETWEEN`	儲存格的值必須介於兩個條件值的日期之間。支援資料驗證。需要兩個 `ConditionValues`。
`DATE_NOT_BETWEEN`	儲存格的值必須不在這兩個條件值的日期範圍內。支援資料驗證。需要兩個 `ConditionValues`。
`DATE_IS_VALID`	儲存格的值必須是日期。支援資料驗證。不需要 `ConditionValues`。
`ONE_OF_RANGE`	儲存格的值必須列在條件值的範圍內。支援資料驗證。需要單一 `ConditionValue`，且值必須是 A1 標記中的有效範圍。
`ONE_OF_LIST`	儲存格的值必須在條件值清單中。支援資料驗證。支援任意數量的 `condition values`，清單中的每個項目各一個。值不支援公式。
`BLANK`	儲存格的值必須為空白。條件式格式設定和篩選器都支援這項功能。不需要 `ConditionValues`。
`NOT_BLANK`	儲存格的值不得為空白。條件式格式設定和篩選器都支援這項功能。不需要 `ConditionValues`。
`CUSTOM_FORMULA`	條件的公式必須評估為 True。資料驗證、條件式格式設定和篩選器都支援這項功能。資料來源試算表篩選器不支援這項功能。需要單一 `ConditionValue`。
`BOOLEAN`	儲存格的值必須為 TRUE/FALSE，或位於條件值清單中。支援資料驗證。顯示為儲存格核取方塊。支援零、一或兩個 `ConditionValues`。如果沒有值，表示儲存格必須為 TRUE 或 FALSE，其中 TRUE 會顯示為已勾選，FALSE 則顯示為未勾選。如果儲存格含有該值，系統會將其顯示為已勾選；如果儲存格空白，則會顯示為未勾選。如果提供兩個值，則儲存格含有第一個值時會顯示為已勾選，含有第二個值時則會顯示為未勾選。舉例來說，["Yes","No"] 表示儲存格的值為「Yes」時會顯示勾選方塊，值為「No」時則顯示未勾選方塊。
`TEXT_NOT_EQ`	儲存格的值必須與條件值完全不同。資料來源物件支援篩選器。至少需要一個 `ConditionValue`。
`DATE_NOT_EQ`	儲存格的值必須與條件值完全不同。資料來源物件支援篩選器。至少需要一個 `ConditionValue`。
`FILTER_EXPRESSION`	儲存格的值必須符合指定的模式。需要單一 `ConditionValue`。

ConditionValue

條件的值。

JSON 表示法
{ // Union field `value` can be only one of the following: "relativeDate": enum (`RelativeDate`), "userEnteredValue": string // End of list of possible types for union field `value`. }

欄位

欄位
聯集欄位 `value`。條件的值，必須設定一個。 `value` 只能是下列其中一項：
`relativeDate`	`enum (RelativeDate)` 相對日期 (以目前日期為準)。只有在 `type` 為 `DATE_BEFORE`、 `DATE_AFTER`、 `DATE_ON_OR_BEFORE` 或 `DATE_ON_OR_AFTER` 時，資料驗證不支援相對日期。這類函式僅支援條件式格式設定和條件式篩選器。
`userEnteredValue`	`string` 條件依據的值。系統會剖析該值，就像使用者在儲存格中輸入內容一樣。系統支援公式，且公式開頭必須為「=」或「+」。`=`

聯集欄位 value。條件的值，必須設定一個。 value 只能是下列其中一項：

relativeDate

enum (RelativeDate)

相對日期 (以目前日期為準)。只有在 type 為 DATE_BEFORE、 DATE_AFTER、 DATE_ON_OR_BEFORE 或 DATE_ON_OR_AFTER 時，

資料驗證不支援相對日期。這類函式僅支援條件式格式設定和條件式篩選器。

userEnteredValue

string

條件依據的值。系統會剖析該值，就像使用者在儲存格中輸入內容一樣。系統支援公式，且公式開頭必須為「=」或「+」。=

RelativeDate

控制日期條件的評估方式。

列舉
`RELATIVE_DATE_UNSPECIFIED`	預設值，請勿使用。
`PAST_YEAR`	該值為今天的日期減去一年。
`PAST_MONTH`	這個值是今天前一個月。
`PAST_WEEK`	這個值是今天前一週。
`YESTERDAY`	此值為昨天。
`TODAY`	值為今天。
`TOMORROW`	值為明天。

GridRange

工作表中的範圍。所有索引都是從零開始。索引為半開放，也就是包含開始索引，但不包含結束索引 - [startIndex, endIndex)。缺少的索引表示該側的範圍不受限制。

舉例來說，如果 "Sheet1" 是工作表 ID 123456，則：

Sheet1!A1:A1 == sheetId: 123456, startRowIndex: 0, endRowIndex: 1, startColumnIndex: 0, endColumnIndex: 1

Sheet1!A3:B4 == sheetId: 123456, startRowIndex: 2, endRowIndex: 4, startColumnIndex: 0, endColumnIndex: 2

Sheet1!A:B == sheetId: 123456, startColumnIndex: 0, endColumnIndex: 2

Sheet1!A5:B == sheetId: 123456, startRowIndex: 4, startColumnIndex: 0, endColumnIndex: 2

Sheet1 == sheetId: 123456

開始索引必須小於或等於結束索引。如果起始索引等於結束索引，範圍就是空白。空範圍通常沒有意義，且通常會在 UI 中以 #REF! 顯示。

JSON 表示法
{ "sheetId": integer, "startRowIndex": integer, "endRowIndex": integer, "startColumnIndex": integer, "endColumnIndex": integer }

欄位
`sheetId`	`integer` 這個範圍所在的工作表。
`startRowIndex`	`integer` 範圍的起始列 (含)，或未設定 (無界限)。
`endRowIndex`	`integer` 範圍的結尾列 (不含)，或未設定 (如果沒有界限)。
`startColumnIndex`	`integer` 範圍的開始資料欄 (含)，或未設定 (如果範圍沒有界限)。
`endColumnIndex`	`integer` 範圍的結尾欄 (不含)，或未設定 (如果沒有界線)。

SortOrder

排列順序。

列舉
`SORT_ORDER_UNSPECIFIED`	預設值，請勿使用。
`ASCENDING`	遞增排序。
`DESCENDING`	遞減排序。

FilterSpec

與特定資料欄相關聯的篩選條件。

JSON 表示法

JSON 表示法
{ "filterCriteria": { object (`FilterCriteria`) }, // Union field `reference` can be only one of the following: "columnIndex": integer, "dataSourceColumnReference": { object (`DataSourceColumnReference`) } // End of list of possible types for union field `reference`. }

{
  "filterCriteria": {
    object (FilterCriteria)
  },

  // Union field reference can be only one of the following:
  "columnIndex": integer,
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field reference.
}

欄位
`filterCriteria`	`object (FilterCriteria)` 資料欄的條件。
聯集欄位 `reference`。參照已篩選的資料欄。 `reference` 只能是下列其中一項：
`columnIndex`	`integer` 從零開始的資料欄索引。
`dataSourceColumnReference`	`object (DataSourceColumnReference)` 參照資料來源資料欄。

FilterCriteria

篩選器或篩選器檢視畫面中顯示或隱藏資料列的條件。

JSON 表示法

JSON 表示法
{ "hiddenValues": [ string ], "condition": { object (`BooleanCondition`) }, "visibleBackgroundColor": { object (`Color`) }, "visibleBackgroundColorStyle": { object (`ColorStyle`) }, "visibleForegroundColor": { object (`Color`) }, "visibleForegroundColorStyle": { object (`ColorStyle`) } }

{
  "hiddenValues": [
    string
  ],
  "condition": {
    object (BooleanCondition)
  },
  "visibleBackgroundColor": {
    object (Color)
  },
  "visibleBackgroundColorStyle": {
    object (ColorStyle)
  },
  "visibleForegroundColor": {
    object (Color)
  },
  "visibleForegroundColorStyle": {
    object (ColorStyle)
  }
}

欄位
`hiddenValues[]`	`string` 應隱藏的值。
`condition`	`object (BooleanCondition)` 必須符合的條件，系統才會顯示值。`true`(這不會覆寫 `hiddenValues`，如果該處列出值，系統仍會隱藏。)
`visibleBackgroundColor (deprecated)`	`object (Color)` 這個項目已淘汰！要篩選的背景填滿顏色，系統只會顯示具有這個填滿顏色的儲存格。與 `visibleForegroundColor` 互斥。已淘汰：請改用 `visibleBackgroundColorStyle`。
`visibleBackgroundColorStyle`	`object (ColorStyle)` 要篩選的背景填滿顏色，系統只會顯示具有這個填滿顏色的儲存格。這個欄位與 `visibleForegroundColor` 互斥，且必須設為 RGB 類型的顏色。如果同時設定了 `visibleBackgroundColor`，系統會優先採用這個欄位。
`visibleForegroundColor (deprecated)`	`object (Color)` 這個項目已淘汰！要篩選的前景顏色，系統只會顯示具有這個前景顏色的儲存格。與 `visibleBackgroundColor` 互斥。已淘汰：請改用 `visibleForegroundColorStyle`。
`visibleForegroundColorStyle`	`object (ColorStyle)` 要篩選的前景顏色，系統只會顯示具有這個前景顏色的儲存格。這個欄位與 `visibleBackgroundColor` 互斥，且必須設為 RGB 類型的顏色。如果同時設定了 `visibleForegroundColor`，系統會優先採用這個欄位。

SortSpec

與特定欄或列相關聯的排序順序。

JSON 表示法

JSON 表示法
{ "sortOrder": enum (`SortOrder`), "foregroundColor": { object (`Color`) }, "foregroundColorStyle": { object (`ColorStyle`) }, "backgroundColor": { object (`Color`) }, "backgroundColorStyle": { object (`ColorStyle`) }, // Union field `reference` can be only one of the following: "dimensionIndex": integer, "dataSourceColumnReference": { object (`DataSourceColumnReference`) } // End of list of possible types for union field `reference`. }

{
  "sortOrder": enum (SortOrder),
  "foregroundColor": {
    object (Color)
  },
  "foregroundColorStyle": {
    object (ColorStyle)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },

  // Union field reference can be only one of the following:
  "dimensionIndex": integer,
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
  // End of list of possible types for union field reference.
}

欄位
`sortOrder`	`enum (SortOrder)` 訂單資料應經過排序。
`foregroundColor (deprecated)`	`object (Color)` 這個項目已淘汰！要排序的前景顏色；具有這個前景顏色的儲存格會排序至頂端。與 `backgroundColor` 互斥。已淘汰：請改用 `foregroundColorStyle`。
`foregroundColorStyle`	`object (ColorStyle)` 要排序的前景顏色；具有這個前景顏色的儲存格會排序至頂端。與 `backgroundColor` 互斥，且必須是 RGB 類型的顏色。如果同時設定了 `foregroundColor`，系統會優先採用這個欄位。
`backgroundColor (deprecated)`	`object (Color)` 這個項目已淘汰！要用來排序的背景填滿顏色；具有這個填滿顏色的儲存格會排序至頂端。與 `foregroundColor` 互斥。已淘汰：請改用 `backgroundColorStyle`。
`backgroundColorStyle`	`object (ColorStyle)` 要用來排序的背景填滿顏色；具有這個填滿顏色的儲存格會排序至頂端。與 `foregroundColor` 互斥，且必須是 RGB 類型的顏色。如果同時設定了 `backgroundColor`，系統會優先採用這個欄位。
聯集欄位 `reference`。參照已排序的維度。 `reference` 只能是下列其中一項：
`dimensionIndex`	`integer` 要套用排序的維度。
`dataSourceColumnReference`	`object (DataSourceColumnReference)` 參照資料來源資料欄。

EmbeddedObjectPosition

嵌入物件 (例如圖表) 的位置。

JSON 表示法

JSON 表示法
{ // Union field `location` can be only one of the following: "sheetId": integer, "overlayPosition": { object (`OverlayPosition`) }, "newSheet": boolean // End of list of possible types for union field `location`. }

{

  // Union field location can be only one of the following:
  "sheetId": integer,
  "overlayPosition": {
    object (OverlayPosition)
  },
  "newSheet": boolean
  // End of list of possible types for union field location.
}

欄位
聯集欄位 `location`。物件的位置。必須設定一個值。 `location` 只能是下列其中一項：
`sheetId`	`integer` 工作表。只有在內嵌物件位於獨立工作表時，才需要設定這個屬性。不得為負值。
`overlayPosition`	`object (OverlayPosition)` 物件在格線上的疊加位置。
`newSheet`	`boolean` 如果為 true，內嵌物件會放在系統為您選擇 ID 的新工作表上。僅在撰寫時使用。

OverlayPosition

物件在格線上的疊加位置。

JSON 表示法
{ "anchorCell": { object (`GridCoordinate`) }, "offsetXPixels": integer, "offsetYPixels": integer, "widthPixels": integer, "heightPixels": integer }

欄位
`anchorCell`	`object (GridCoordinate)` 物件錨定的儲存格。
`offsetXPixels`	`integer` 物件與錨定儲存格的水平偏移量 (以像素為單位)。
`offsetYPixels`	`integer` 物件與錨定儲存格的垂直偏移量 (以像素為單位)。
`widthPixels`	`integer` 物件的寬度，以像素為單位。預設值為 600。
`heightPixels`	`integer` 物件的高度 (以像素為單位)。預設值為 371。

GridCoordinate

試算表中的座標。所有索引都是從零開始。

JSON 表示法
{ "sheetId": integer, "rowIndex": integer, "columnIndex": integer }

欄位

欄位
`sheetId`	`integer` 這個座標所在的工作表。
`rowIndex`	`integer` 座標的資料列索引。
`columnIndex`	`integer` 座標的欄索引。

sheetId

integer

這個座標所在的工作表。

rowIndex

integer

座標的資料列索引。

columnIndex

integer

座標的欄索引。

Other 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

顏色

ColorStyle

ThemeColorType

HorizontalAlign

TextFormat

連結

DataSourceColumn

DataSourceColumnReference

DataExecutionStatus

DataExecutionState

DataExecutionErrorCode

ExtendedValue

ErrorValue

ErrorType

BooleanCondition

ConditionType

ConditionValue

RelativeDate

GridRange

SortOrder

FilterSpec

FilterCriteria

SortSpec

EmbeddedObjectPosition

OverlayPosition

GridCoordinate

Other