Sheets

ชีต

ชีตในสเปรดชีต

การแสดง JSON 
{
  "properties": {
    object (SheetProperties)
  },
  "data": [
    {
      object (GridData)
    }
  ],
  "merges": [
    {
      object (GridRange)
    }
  ],
  "conditionalFormats": [
    {
      object (ConditionalFormatRule)
    }
  ],
  "filterViews": [
    {
      object (FilterView)
    }
  ],
  "protectedRanges": [
    {
      object (ProtectedRange)
    }
  ],
  "basicFilter": {
    object (BasicFilter)
  },
  "charts": [
    {
      object (EmbeddedChart)
    }
  ],
  "bandedRanges": [
    {
      object (BandedRange)
    }
  ],
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "rowGroups": [
    {
      object (DimensionGroup)
    }
  ],
  "columnGroups": [
    {
      object (DimensionGroup)
    }
  ],
  "slicers": [
    {
      object (Slicer)
    }
  ],
  "tables": [
    {
      object (Table)
    }
  ]
}
ช่อง
properties

object (SheetProperties)

พร็อพเพอร์ตี้ของชีต

data[]

object (GridData)

ข้อมูลในตารางกริด หากเป็นชีตตารางกริด

จํานวนออบเจ็กต์ GridData ที่แสดงผลจะขึ้นอยู่กับจํานวนช่วงในชีตนี้ ตัวอย่างเช่น หากข้อมูลนี้แสดงถึง Sheet1 และมีการขอสเปรดชีตที่มีช่วง Sheet1!A1:C10 และ Sheet1!D15:E20 ข้อมูลกริดแรกจะมี startRow/startColumn ของ 0 ส่วนข้อมูลกริดที่ 2 จะมี startRow 14 (แถวที่ 15 แบบฐาน 0) และ startColumn 3 (คอลัมน์ D แบบฐาน 0)

สำหรับชีต DATA_SOURCE คุณไม่สามารถขอช่วงที่ต้องการได้ เนื่องจาก GridData มีค่าทั้งหมด

merges[]

object (GridRange)

ช่วงที่มีการผสานเข้าด้วยกัน

conditionalFormats[]

object (ConditionalFormatRule)

กฎการจัดรูปแบบตามเงื่อนไขในชีตนี้

filterViews[]

object (FilterView)

มุมมองตัวกรองในชีตนี้

protectedRanges[]

object (ProtectedRange)

ช่วงที่ป้องกันในชีตนี้

basicFilter

object (BasicFilter)

ตัวกรองในชีตนี้ (หากมี)

charts[]

object (EmbeddedChart)

ข้อกําหนดของแผนภูมิทุกรายการในชีตนี้

bandedRanges[]

object (BandedRange)

ช่วงที่มีแถบ (สลับสี) ในชีตนี้

developerMetadata[]

object (DeveloperMetadata)

ข้อมูลเมตาของนักพัฒนาแอปที่เชื่อมโยงกับชีต

rowGroups[]

object (DimensionGroup)

กลุ่มแถวทั้งหมดในสเปรดชีตนี้ โดยจัดเรียงตามลําดับการเพิ่มขึ้นของดัชนีเริ่มต้นของช่วง ตามด้วยลําดับความลึกของกลุ่ม

columnGroups[]

object (DimensionGroup)

กลุ่มคอลัมน์ทั้งหมดในสเปรดชีตนี้ โดยจัดเรียงตามลําดับการเพิ่มขึ้นของดัชนีเริ่มต้นของช่วง ตามด้วยลําดับความลึกของกลุ่ม

slicers[]

object (Slicer)

เครื่องมือแบ่งข้อมูลในชีตนี้

tables[]

object (Table)

ตารางในชีตนี้

SheetProperties

คุณสมบัติของชีต

การแสดง JSON 
{
  "sheetId": integer,
  "title": string,
  "index": integer,
  "sheetType": enum (SheetType),
  "gridProperties": {
    object (GridProperties)
  },
  "hidden": boolean,
  "tabColor": {
    object (Color)
  },
  "tabColorStyle": {
    object (ColorStyle)
  },
  "rightToLeft": boolean,
  "dataSourceSheetProperties": {
    object (DataSourceSheetProperties)
  }
}
ช่อง
sheetId

integer

รหัสของชีต ต้องไม่ติดลบ เมื่อตั้งค่าแล้ว ช่องนี้จะเปลี่ยนแปลงไม่ได้

title

string

ชื่อชีต

index

integer

ดัชนีของชีตภายในสเปรดชีต เมื่อเพิ่มหรืออัปเดตพร็อพเพอร์ตี้ชีต หากยกเว้นช่องนี้ ระบบจะเพิ่มหรือย้ายชีตไปไว้ที่ท้ายรายการชีต เมื่ออัปเดตดัชนีชีตหรือแทรกชีต ระบบจะพิจารณาการย้ายในดัชนี "ก่อนการย้าย" เช่น หากมีชีต 3 ชีต (S1, S2, S3) หากต้องการย้าย S1 ไว้ข้างหน้า S2 จะต้องตั้งค่าดัชนีเป็น 2 ระบบจะไม่สนใจคำขออัปเดตดัชนีชีตหากดัชนีที่ขอเหมือนกับดัชนีปัจจุบันของชีต หรือหากดัชนีใหม่ที่ขอเท่ากับดัชนีชีตปัจจุบัน + 1

sheetType

enum (SheetType)

ประเภทชีต ค่าเริ่มต้นคือ GRID เมื่อตั้งค่าแล้ว ช่องนี้จะเปลี่ยนแปลงไม่ได้

gridProperties

object (GridProperties)

คุณสมบัติเพิ่มเติมของชีตหากชีตนี้เป็นตารางกริด (หากชีตเป็นชีตออบเจ็กต์ซึ่งมีแผนภูมิหรือรูปภาพ ฟิลด์นี้จะไม่มีอยู่) เมื่อเขียน การตั้งค่าพร็อพเพอร์ตี้ตารางกริดในชีตที่ไม่ใช่ตารางกริดจะเป็นข้อผิดพลาด

หากชีตนี้เป็นชีต DATA_SOURCE ช่องนี้จะแสดงผลเท่านั้น แต่จะมีพร็อพเพอร์ตี้ที่แสดงถึงวิธีแสดงผลชีตแหล่งข้อมูลใน UI เช่น rowCount

hidden

boolean

เป็นจริงหากชีตซ่อนอยู่ใน UI เป็นเท็จหากชีตแสดงอยู่

tabColor
(deprecated)

object (Color)

สีของแท็บใน UI เลิกใช้งานแล้ว: ใช้ tabColorStyle

tabColorStyle

object (ColorStyle)

สีของแท็บใน UI หากมีการตั้งค่า tabColor ไว้ด้วย ช่องนี้จะมีลำดับความสำคัญเหนือกว่า

rightToLeft

boolean

จริงหากชีตเป็นชีต RTL แทนที่จะเป็นชีต LTR

dataSourceSheetProperties

object (DataSourceSheetProperties)

เอาต์พุตเท่านั้น หากมี ฟิลด์จะมีพร็อพเพอร์ตี้เฉพาะDATA_SOURCEชีต

SheetType

ประเภทชีต

Enum
SHEET_TYPE_UNSPECIFIED ค่าเริ่มต้น อย่าใช้
GRID ชีตเป็นตารางกริด
OBJECT ชีตไม่มีตารางกริด แต่มีออบเจ็กต์ เช่น แผนภูมิหรือรูปภาพ
DATA_SOURCE ชีตจะเชื่อมต่อกับภายนอก DataSource และแสดงตัวอย่างข้อมูล

GridProperties

คุณสมบัติของตารางกริด

การแสดง JSON 
{
  "rowCount": integer,
  "columnCount": integer,
  "frozenRowCount": integer,
  "frozenColumnCount": integer,
  "hideGridlines": boolean,
  "rowGroupControlAfter": boolean,
  "columnGroupControlAfter": boolean
}
ช่อง
rowCount

integer

จำนวนแถวในตารางกริด

columnCount

integer

จํานวนคอลัมน์ในตารางกริด

frozenRowCount

integer

จำนวนแถวที่ตรึงในตารางกริด

frozenColumnCount

integer

จำนวนคอลัมน์ที่ตรึงในตารางกริด

hideGridlines

boolean

เป็นจริงหากตารางกริดไม่แสดงเส้นตารางกริดใน UI

rowGroupControlAfter

boolean

จริงหากปุ่มเปิด/ปิดการควบคุมการจัดกลุ่มแถวแสดงหลังกลุ่ม

columnGroupControlAfter

boolean

จริงหากปุ่มเปิด/ปิดการควบคุมการจัดกลุ่มคอลัมน์แสดงอยู่หลังกลุ่ม

DataSourceSheetProperties

พร็อพเพอร์ตี้เพิ่มเติมของDATA_SOURCE ชีต

การแสดง JSON 
{
  "dataSourceId": string,
  "columns": [
    {
      object (DataSourceColumn)
    }
  ],
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
ช่อง
dataSourceId

string

รหัสของ DataSource ที่ชีตเชื่อมต่ออยู่

columns[]

object (DataSourceColumn)

คอลัมน์ที่แสดงในชีตซึ่งสอดคล้องกับค่าใน RowData

dataExecutionStatus

object (DataExecutionStatus)

สถานะการเรียกใช้ข้อมูล

GridData

ข้อมูลในตารางกริด รวมถึงข้อมูลเมตาเกี่ยวกับมิติข้อมูล

การแสดง JSON 
{
  "startRow": integer,
  "startColumn": integer,
  "rowData": [
    {
      object (RowData)
    }
  ],
  "rowMetadata": [
    {
      object (DimensionProperties)
    }
  ],
  "columnMetadata": [
    {
      object (DimensionProperties)
    }
  ]
}
ช่อง
startRow

integer

แถวแรกที่ GridData นี้อ้างอิง ซึ่งนับจาก 0

startColumn

integer

คอลัมน์แรกที่ GridData อ้างอิงถึง โดยนับจาก 0

rowData[]

object (RowData)

ข้อมูลในตารางกริด โดยให้มี 1 รายการต่อแถว โดยเริ่มจากแถวใน startRow ค่าใน RowData จะสอดคล้องกับคอลัมน์ที่เริ่มต้นที่ startColumn

rowMetadata[]

object (DimensionProperties)

ข้อมูลเมตาเกี่ยวกับแถวที่ขอในตารางกริด โดยเริ่มจากแถวใน startRow

columnMetadata[]

object (DimensionProperties)

ข้อมูลเมตาเกี่ยวกับคอลัมน์ที่ขอในตารางกริด โดยเริ่มจากคอลัมน์ใน startColumn

RowData

ข้อมูลเกี่ยวกับแต่ละเซลล์ในแถว

การแสดง JSON 
{
  "values": [
    {
      object (CellData)
    }
  ]
}
ช่อง
values[]

object (CellData)

ค่าในแถว โดยให้มี 1 ค่าต่อคอลัมน์

DimensionProperties

พร็อพเพอร์ตี้เกี่ยวกับมิติข้อมูล

การแสดง JSON 
{
  "hiddenByFilter": boolean,
  "hiddenByUser": boolean,
  "pixelSize": integer,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
}
ช่อง
hiddenByFilter

boolean

เป็นจริงหากมีการกรองมิติข้อมูลนี้ ช่องนี้เป็นแบบอ่านอย่างเดียว

hiddenByUser

boolean

จริง หากมิติข้อมูลนี้ซ่อนอยู่อย่างชัดเจน

pixelSize

integer

ความสูง (หากเป็นแถว) หรือความกว้าง (หากเป็นคอลัมน์) ของมิติข้อมูลเป็นพิกเซล

developerMetadata[]

object (DeveloperMetadata)

ข้อมูลเมตาของนักพัฒนาแอปที่เชื่อมโยงกับแถวหรือคอลัมน์เดียว

dataSourceColumnReference

object (DataSourceColumnReference)

เอาต์พุตเท่านั้น หากตั้งค่าไว้ คอลัมน์นี้จะอยู่ในชีตแหล่งข้อมูล

ConditionalFormatRule

กฎที่อธิบายรูปแบบตามเงื่อนไข

การแสดง JSON 
{
  "ranges": [
    {
      object (GridRange)
    }
  ],

  // Union field rule can be only one of the following:
  "booleanRule": {
    object (BooleanRule)
  },
  "gradientRule": {
    object (GradientRule)
  }
  // End of list of possible types for union field rule.
}
ช่อง
ranges[]

object (GridRange)

ช่วงที่มีการจัดรูปแบบหากเงื่อนไขเป็นจริง ช่วงทั้งหมดต้องอยู่ในตารางกริดเดียวกัน

ฟิลด์สหภาพ rule กฎที่ควบคุมการจัดรูปแบบตามเงื่อนไขนี้ต้องกำหนดเพียง 1 รายการเท่านั้น rule ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
booleanRule

object (BooleanRule)

การจัดรูปแบบจะเป็น "เปิด" หรือ "ปิด" ตามกฎ

gradientRule

object (GradientRule)

การจัดรูปแบบจะแตกต่างกันไปตามการไล่ระดับสีในกฎ

BooleanRule

กฎที่อาจหรือไม่ตรงกันโดยขึ้นอยู่กับเงื่อนไข

การแสดง JSON 
{
  "condition": {
    object (BooleanCondition)
  },
  "format": {
    object (CellFormat)
  }
}
ช่อง
condition

object (BooleanCondition)

เงื่อนไขของกฎ หากเงื่อนไขประเมินเป็น "จริง" ระบบจะใช้รูปแบบนั้น

format

object (CellFormat)

รูปแบบที่จะใช้ การจัดรูปแบบตามเงื่อนไขจะใช้ได้กับการจัดรูปแบบชุดย่อยเท่านั้น ซึ่งได้แก่ bold, italic, strikethrough, foreground color และ background color

GradientRule

กฎที่ใช้รูปแบบรูปแบบสีไล่ระดับตามจุดการหาค่าเฉลี่ยระหว่างจุดที่ระบุ รูปแบบของเซลล์จะแตกต่างกันไปตามเนื้อหาของเซลล์นั้นๆ เมื่อเทียบกับค่าของจุดการหาค่าเฉลี่ยระหว่างจุด

การแสดง JSON 
{
  "minpoint": {
    object (InterpolationPoint)
  },
  "midpoint": {
    object (InterpolationPoint)
  },
  "maxpoint": {
    object (InterpolationPoint)
  }
}
ช่อง
minpoint

object (InterpolationPoint)

จุดเริ่มต้นของการประมาณค่าในช่วง

midpoint

object (InterpolationPoint)

จุดการหาค่าเฉลี่ยระหว่างกลาง (ไม่บังคับ)

maxpoint

object (InterpolationPoint)

จุดสุดท้ายของการประมาณ

InterpolationPoint

จุดการหาค่าเฉลี่ยแบบเชิงเส้นจุดเดียวในการจัดรูปแบบตามเงื่อนไขแบบไล่ระดับ ซึ่งจะปักหมุดรูปแบบสีของไล่ระดับตามสี ประเภท และค่าที่เลือก

การแสดง JSON 
{
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  },
  "type": enum (InterpolationPointType),
  "value": string
}
ช่อง
color
(deprecated)

object (Color)

สีที่จุดการหาค่าระหว่างนี้ควรใช้ เลิกใช้งานแล้ว: ใช้ colorStyle

colorStyle

object (ColorStyle)

สีที่จุดการหาค่าระหว่างนี้ควรใช้ หากมีการตั้งค่า color ไว้ด้วย ช่องนี้จะมีลำดับความสำคัญเหนือกว่า

type

enum (InterpolationPointType)

วิธีการตีความค่า

value

string

ค่าที่จุดการประมาณค่าในช่วงนี้ใช้ อาจเป็นสูตร ไม่ได้ใช้งานหาก type เป็น MIN หรือ MAX

InterpolationPointType

ประเภทของจุดการหาค่าเฉลี่ยระหว่างจุด

Enum
INTERPOLATION_POINT_TYPE_UNSPECIFIED ค่าเริ่มต้น อย่าใช้
MIN จุดการหาค่าเฉลี่ยใช้ค่าต่ำสุดในเซลล์ในช่วงของรูปแบบเงื่อนไข
MAX จุดการหาค่าเฉลี่ยใช้ค่าสูงสุดในเซลล์ในช่วงของรูปแบบเงื่อนไข
NUMBER จุดการหาค่าเฉลี่ยใช้ค่าใน InterpolationPoint.value ทั้งหมด
PERCENT

จุดการหาค่าเฉลี่ยเชิงเส้นคือเปอร์เซ็นต์ที่ระบุสำหรับเซลล์ทั้งหมดในช่วงของรูปแบบที่มีเงื่อนไข ซึ่งเทียบเท่ากับ NUMBER หากค่าคือ =(MAX(FLATTEN(range)) * (value / 100)) + (MIN(FLATTEN(range)) * (1 - (value / 100))) (ระบบจะละเว้นข้อผิดพลาดในช่วงเมื่อทำการแบนราบ)

PERCENTILE จุดการหาค่าตรงกลางคือเปอร์เซ็นไทล์ที่ระบุสำหรับเซลล์ทั้งหมดในช่วงของรูปแบบที่มีเงื่อนไข ซึ่งเทียบเท่ากับ NUMBER หากค่าคือ =PERCENTILE(FLATTEN(range), value / 100) (ระบบจะละเว้นข้อผิดพลาดในช่วงเมื่อทำการแบนราบ)

FilterView

มุมมองตัวกรอง

การแสดง JSON 
{
  "filterViewId": integer,
  "title": string,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "tableId": string,
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}
ช่อง
filterViewId

integer

รหัสของมุมมองตัวกรอง

title

string

ชื่อของมุมมองตัวกรอง

range

object (GridRange)

ช่วงของมุมมองตัวกรองนี้

เมื่อเขียน คุณจะตั้งค่าได้เพียงตัวเลือกเดียวจากตัวเลือกต่อไปนี้ range หรือ namedRangeId หรือ tableId

namedRangeId

string

ช่วงที่มีชื่อซึ่งมุมมองตัวกรองนี้อิงตาม (หากมี)

เมื่อเขียน คุณจะตั้งค่าได้เพียงตัวเลือกเดียวจากตัวเลือกต่อไปนี้ range หรือ namedRangeId หรือ tableId

tableId

string

ตารางที่รองรับมุมมองตัวกรองนี้ (หากมี)

เมื่อเขียน คุณจะตั้งค่าได้เพียงตัวเลือกเดียวจากตัวเลือกต่อไปนี้ range หรือ namedRangeId หรือ tableId

sortSpecs[]

object (SortSpec)

ลําดับการจัดเรียงต่อคอลัมน์ ระบบจะใช้ข้อมูลจำเพาะที่ใหม่กว่าเมื่อค่าในข้อมูลจำเพาะก่อนหน้านี้เท่ากัน

criteria
(deprecated)

map (key: integer, value: object ( FilterCriteria))

เกณฑ์สําหรับการแสดง/ซ่อนค่าต่อคอลัมน์ คีย์ของแผนที่คือดัชนีคอลัมน์ และค่าคือเกณฑ์สําหรับคอลัมน์นั้น

ช่องนี้เลิกใช้งานแล้วเพื่อใช้ filterSpecs แทน

filterSpecs[]

object (FilterSpec)

เกณฑ์ตัวกรองสําหรับการแสดง/ซ่อนค่าต่อคอลัมน์

ทั้ง criteria และ filterSpecs จะแสดงในคำตอบ หากระบุทั้ง 2 ช่องในคำขออัปเดต ช่องนี้จะมีความสำคัญเหนือกว่า

ProtectedRange

ช่วงที่ป้องกันไว้

การแสดง JSON 
{
  "protectedRangeId": integer,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "tableId": string,
  "description": string,
  "warningOnly": boolean,
  "requestingUserCanEdit": boolean,
  "unprotectedRanges": [
    {
      object (GridRange)
    }
  ],
  "editors": {
    object (Editors)
  }
}
ช่อง
protectedRangeId

integer

รหัสของช่วงที่ป้องกันไว้ ช่องนี้เป็นแบบอ่านอย่างเดียว

range

object (GridRange)

ช่วงที่ป้องกันอยู่ ช่วงอาจไม่มีขอบเขตโดยสมบูรณ์ ซึ่งในกรณีนี้ถือว่าเป็นแผ่นงานที่ป้องกัน

เมื่อเขียน คุณจะตั้งค่าได้เพียงตัวเลือกเดียวจากตัวเลือกต่อไปนี้ range หรือ namedRangeId หรือ tableId

namedRangeId

string

ช่วงที่มีชื่อซึ่งใช้สำรองข้อมูลของช่วงที่ป้องกันไว้นี้ (หากมี)

เมื่อเขียน คุณจะตั้งค่าได้เพียงตัวเลือกเดียวจากตัวเลือกต่อไปนี้ range หรือ namedRangeId หรือ tableId

tableId

string

ตารางที่สำรองข้อมูลของช่วงที่ป้องกันไว้นี้ (หากมี)

เมื่อเขียน คุณจะตั้งค่าได้เพียงตัวเลือกเดียวจากตัวเลือกต่อไปนี้ range หรือ namedRangeId หรือ tableId

description

string

คำอธิบายของช่วงที่ป้องกันไว้นี้

warningOnly

boolean

จริงหากช่วงที่ได้รับการป้องกันนี้จะแสดงคำเตือนเมื่อแก้ไข การปกป้องตามคำเตือนหมายความว่าผู้ใช้ทุกคนจะแก้ไขข้อมูลในช่วงที่ได้รับการปกป้องได้ ยกเว้นการแก้ไขจะแสดงคำเตือนเพื่อขอให้ผู้ใช้ยืนยันการแก้ไข

เมื่อเขียนว่า if this field is true, then editors ระบบจะไม่สนใจ นอกจากนี้ หากเปลี่ยนช่องนี้จาก "จริง" เป็น "เท็จ" และไม่ได้ตั้งค่าช่อง editors (หรือไม่ได้รวมไว้ในมาสก์ช่อง) ระบบจะตั้งค่าผู้แก้ไขเป็น "ผู้แก้ไขทั้งหมดในเอกสาร"

requestingUserCanEdit

boolean

จริงหากผู้ใช้ที่ขอช่วงที่ได้รับการป้องกันนี้สามารถแก้ไขพื้นที่ที่ได้รับการป้องกันได้ ช่องนี้เป็นแบบอ่านอย่างเดียว

unprotectedRanges[]

object (GridRange)

รายการช่วงที่ไม่ได้ป้องกันภายในชีตที่ป้องกันไว้ ระบบรองรับช่วงที่ไม่ป้องกันในชีตที่มีการป้องกันเท่านั้น

editors

object (Editors)

ผู้ใช้และกลุ่มที่มีสิทธิ์แก้ไขช่วงที่ได้รับการป้องกัน ช่องนี้จะแสดงต่อผู้ใช้ที่มีสิทธิ์แก้ไขช่วงที่ได้รับการป้องกันและเอกสารเท่านั้น ระบบไม่รองรับเครื่องมือแก้ไขที่มีwarningOnly protection

เครื่องมือแก้ไข

ผู้แก้ไขช่วงที่ป้องกันไว้

การแสดง JSON 
{
  "users": [
    string
  ],
  "groups": [
    string
  ],
  "domainUsersCanEdit": boolean
}
ช่อง
users[]

string

อีเมลของผู้ใช้ที่มีสิทธิ์แก้ไขช่วงที่ป้องกันไว้

groups[]

string

อีเมลของกลุ่มที่มีสิทธิ์แก้ไขช่วงที่ได้รับการป้องกัน

domainUsersCanEdit

boolean

จริงหากทุกคนในโดเมนของเอกสารมีสิทธิ์แก้ไขช่วงที่ได้รับการป้องกัน ระบบรองรับการป้องกันโดเมนในเอกสารภายในโดเมนเท่านั้น

BasicFilter

ฟิลเตอร์เริ่มต้นที่เชื่อมโยงกับชีต

การแสดง JSON 
{
  "range": {
    object (GridRange)
  },
  "tableId": string,
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}
ช่อง
range

object (GridRange)

ช่วงของตัวกรอง

tableId

string

ตารางที่รองรับตัวกรองนี้ (หากมี) เมื่อเขียน คุณจะตั้งค่าได้เพียงค่าเดียวจากค่าต่อไปนี้ range หรือ tableId

sortSpecs[]

object (SortSpec)

ลําดับการจัดเรียงต่อคอลัมน์ ระบบจะใช้ข้อมูลจำเพาะที่ใหม่กว่าเมื่อค่าในข้อมูลจำเพาะก่อนหน้านี้เท่ากัน

criteria
(deprecated)

map (key: integer, value: object ( FilterCriteria))

เกณฑ์สําหรับการแสดง/ซ่อนค่าต่อคอลัมน์ คีย์ของแผนที่คือดัชนีคอลัมน์ และค่าคือเกณฑ์สําหรับคอลัมน์นั้น

ช่องนี้เลิกใช้งานแล้วเพื่อใช้ filterSpecs แทน

filterSpecs[]

object (FilterSpec)

เกณฑ์ตัวกรองต่อคอลัมน์

ทั้ง criteria และ filterSpecs จะแสดงในคำตอบ หากระบุทั้ง 2 ช่องในคำขออัปเดต ช่องนี้จะมีความสำคัญเหนือกว่า

BandedRange

ช่วงที่มีแถบ (สลับสี) ในชีต

การแสดง JSON 
{
  "bandedRangeId": integer,
  "bandedRangeReference": string,
  "range": {
    object (GridRange)
  },
  "rowProperties": {
    object (BandingProperties)
  },
  "columnProperties": {
    object (BandingProperties)
  }
}
ช่อง
bandedRangeId

integer

รหัสของช่วงที่มีแถบ หากไม่ได้ตั้งค่า ให้ดูที่ bandedRangeReference

bandedRangeReference

string

เอาต์พุตเท่านั้น การอ้างอิงช่วงแบบเป็นกลุ่ม ซึ่งใช้เพื่อระบุรหัสที่ bandedRangeId ไม่รองรับ

range

object (GridRange)

ช่วงที่มีการใช้พร็อพเพอร์ตี้เหล่านี้

rowProperties

object (BandingProperties)

พร็อพเพอร์ตี้ของแถบแถว พร็อพเพอร์ตี้เหล่านี้จะมีผลทีละแถวตลอดทั้งแถวในช่วงที่เลือก ต้องระบุ rowProperties หรือ columnProperties อย่างน้อย 1 รายการ

columnProperties

object (BandingProperties)

พร็อพเพอร์ตี้สำหรับแถบคอลัมน์ พร็อพเพอร์ตี้เหล่านี้จะมีผลกับแต่ละคอลัมน์ในคอลัมน์ทั้งหมดของช่วง ต้องระบุ rowProperties หรือ columnProperties อย่างน้อย 1 รายการ

BandingProperties

พร็อพเพอร์ตี้ที่อ้างอิงมิติข้อมูลเดียว (แถวหรือคอลัมน์) หากตั้งค่าทั้ง BandedRange.row_properties และ BandedRange.column_properties ระบบจะใช้สีเติมกับเซลล์ตามกฎต่อไปนี้

เช่น สีแถวแรกจะมีความสําคัญเหนือกว่าสีคอลัมน์แรก แต่สีคอลัมน์แรกจะมีความสําคัญเหนือกว่าสีแถวที่ 2 ในทํานองเดียวกัน ส่วนหัวแถวจะมีลําดับความสําคัญเหนือกว่าส่วนหัวคอลัมน์ในเซลล์ซ้ายบน แต่ส่วนหัวคอลัมน์จะมีลําดับความสําคัญเหนือกว่าสีแถวแรกหากไม่ได้ตั้งค่าส่วนหัวแถว

การแสดง JSON 
{
  "headerColor": {
    object (Color)
  },
  "headerColorStyle": {
    object (ColorStyle)
  },
  "firstBandColor": {
    object (Color)
  },
  "firstBandColorStyle": {
    object (ColorStyle)
  },
  "secondBandColor": {
    object (Color)
  },
  "secondBandColorStyle": {
    object (ColorStyle)
  },
  "footerColor": {
    object (Color)
  },
  "footerColorStyle": {
    object (ColorStyle)
  }
}
ช่อง
headerColor
(deprecated)

object (Color)

สีของแถวหรือคอลัมน์แรก หากตั้งค่าช่องนี้ ระบบจะเติมแถวหรือคอลัมน์แรกด้วยสีนี้ และสีจะสลับกันระหว่าง firstBandColor กับ secondBandColor โดยเริ่มจากแถวหรือคอลัมน์ที่ 2 มิเช่นนั้น ระบบจะเติมแถวหรือคอลัมน์แรกด้วย firstBandColor แล้วสลับสีตามปกติ เลิกใช้งานแล้ว: ใช้ headerColorStyle

headerColorStyle

object (ColorStyle)

สีของแถวหรือคอลัมน์แรก หากตั้งค่าช่องนี้ ระบบจะเติมแถวหรือคอลัมน์แรกด้วยสีนี้ และสีจะสลับกันระหว่าง firstBandColor กับ secondBandColor โดยเริ่มจากแถวหรือคอลัมน์ที่ 2 มิเช่นนั้น ระบบจะเติมแถวหรือคอลัมน์แรกด้วย firstBandColor แล้วสลับสีตามปกติ หากมีการตั้งค่า headerColor ไว้ด้วย ช่องนี้จะมีลำดับความสำคัญเหนือกว่า

firstBandColor
(deprecated)

object (Color)

สีแรกที่สลับ (ต้องระบุ) เลิกใช้งานแล้ว: ใช้ firstBandColorStyle

firstBandColorStyle

object (ColorStyle)

สีแรกที่สลับ (ต้องระบุ) หากมีการตั้งค่า firstBandColor ไว้ด้วย ช่องนี้จะมีความสำคัญเหนือกว่า

secondBandColor
(deprecated)

object (Color)

สีที่ 2 ที่สลับกัน (ต้องระบุ) เลิกใช้งานแล้ว: ใช้ secondBandColorStyle

secondBandColorStyle

object (ColorStyle)

สีที่ 2 ที่สลับกัน (ต้องระบุ) หากมีการตั้งค่า secondBandColor ไว้ด้วย ช่องนี้จะมีความสำคัญเหนือกว่า

footerColor
(deprecated)

object (Color)

สีของแถวหรือคอลัมน์สุดท้าย หากไม่ได้ตั้งค่าช่องนี้ ระบบจะเติมแถวหรือคอลัมน์สุดท้ายด้วย firstBandColor หรือ secondBandColor ทั้งนี้ขึ้นอยู่กับสีของแถวหรือคอลัมน์ก่อนหน้า เลิกใช้งานแล้ว: ใช้ footerColorStyle

footerColorStyle

object (ColorStyle)

สีของแถวหรือคอลัมน์สุดท้าย หากไม่ได้ตั้งค่าช่องนี้ ระบบจะเติมแถวหรือคอลัมน์สุดท้ายด้วย firstBandColor หรือ secondBandColor ทั้งนี้ขึ้นอยู่กับสีของแถวหรือคอลัมน์ก่อนหน้า หากมีการตั้งค่า footerColor ไว้ด้วย ช่องนี้จะมีลำดับความสำคัญเหนือกว่า

DimensionGroup

กลุ่มในช่วงของแถวหรือคอลัมน์ในชีต ซึ่งอาจมีหรืออยู่ในกลุ่มอื่นๆ คุณยุบหรือขยายกลุ่มเป็นหน่วยในชีตได้

การแสดง JSON 
{
  "range": {
    object (DimensionRange)
  },
  "depth": integer,
  "collapsed": boolean
}
ช่อง
range

object (DimensionRange)

ช่วงของกลุ่มนี้

depth

integer

ความลึกของกลุ่ม ซึ่งแสดงจํานวนกลุ่มที่มีช่วงซึ่งรวมช่วงของกลุ่มนี้ไว้ทั้งหมด

collapsed

boolean

ช่องนี้จะมีค่าเป็น True หากกลุ่มนี้ยุบอยู่ กลุ่มที่ยุบจะยังคงยุบอยู่หากมีการขยายกลุ่มที่ทับซ้อนกันในระดับความลึกที่ตื้นกว่า

ค่า "จริง" ไม่ได้หมายความว่ามิติข้อมูลทั้งหมดภายในกลุ่มจะซ่อนอยู่ เนื่องจากระดับการมองเห็นของมิติข้อมูลจะเปลี่ยนแปลงได้โดยไม่ขึ้นอยู่กับพร็อพเพอร์ตี้กลุ่มนี้ อย่างไรก็ตาม เมื่อมีการอัปเดตพร็อพเพอร์ตี้นี้ ระบบจะตั้งค่ามิติข้อมูลทั้งหมดภายในเป็น "ซ่อน" หากช่องนี้เป็น "จริง" หรือตั้งค่าเป็น "แสดง" หากช่องนี้เป็น "เท็จ"

ตัวควบคุมตัวกรอง

ตัวแบ่งส่วนในชีต

การแสดง JSON 
{
  "slicerId": integer,
  "spec": {
    object (SlicerSpec)
  },
  "position": {
    object (EmbeddedObjectPosition)
  }
}
ช่อง
slicerId

integer

รหัสของเครื่องมือแบ่งส่วน

spec

object (SlicerSpec)

ข้อกําหนดของเครื่องแบ่ง

position

object (EmbeddedObjectPosition)

ตำแหน่งของตัวแบ่ง โปรดทราบว่าคุณสามารถวางตัวแบ่งส่วนได้ในชีตที่มีอยู่เท่านั้น นอกจากนี้ ระบบยังปรับความกว้างและความสูงของตัวแบ่งส่วนโดยอัตโนมัติเพื่อให้อยู่ภายในขีดจำกัดที่อนุญาต

SlicerSpec

ข้อกำหนดของโปรแกรมแบ่ง

การแสดง JSON 
{
  "dataRange": {
    object (GridRange)
  },
  "filterCriteria": {
    object (FilterCriteria)
  },
  "columnIndex": integer,
  "applyToPivotTables": boolean,
  "title": string,
  "textFormat": {
    object (TextFormat)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "horizontalAlignment": enum (HorizontalAlign)
}
ช่อง
dataRange

object (GridRange)

ช่วงข้อมูลของตัวควบคุมตัวกรอง

filterCriteria

object (FilterCriteria)

เกณฑ์การกรองของตัวแบ่งส่วน

columnIndex

integer

ดัชนีคอลัมน์แบบนับจาก 0 ในตารางข้อมูลที่มีการใช้ตัวกรอง

applyToPivotTables

boolean

เป็นจริงหากตัวกรองควรใช้กับตาราง Pivot หากไม่ได้ตั้งค่าไว้ ระบบจะใช้ True เป็นค่าเริ่มต้น

title

string

ชื่อของเครื่องมือแบ่งส่วน

textFormat

object (TextFormat)

รูปแบบข้อความของชื่อในเครื่องมือแบ่งข้อมูล ไม่รองรับช่องลิงก์

backgroundColor
(deprecated)

object (Color)

สีพื้นหลังของตัวแบ่งส่วน เลิกใช้งานแล้ว: ใช้ backgroundColorStyle

backgroundColorStyle

object (ColorStyle)

สีพื้นหลังของตัวแบ่งส่วน หากมีการตั้งค่า backgroundColor ไว้ด้วย ช่องนี้จะมีลำดับความสำคัญเหนือกว่า

horizontalAlignment

enum (HorizontalAlign)

การจัดแนวชื่อในแนวนอนของตัวแบ่งส่วน หากไม่ได้ระบุไว้ ค่าเริ่มต้นจะเป็น LEFT

ตาราง

ตาราง

การแสดง JSON 
{
  "tableId": string,
  "name": string,
  "range": {
    object (GridRange)
  },
  "rowsProperties": {
    object (TableRowsProperties)
  },
  "columnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}
ช่อง
tableId

string

รหัสของตาราง

name

string

ชื่อตาราง ซึ่งจะไม่ซ้ำกันสำหรับตารางทั้งหมดในสเปรดชีตเดียวกัน

range

object (GridRange)

ช่วงตาราง

rowsProperties

object (TableRowsProperties)

พร็อพเพอร์ตี้แถวของตาราง

columnProperties[]

object (TableColumnProperties)

คุณสมบัติของคอลัมน์ตาราง

TableRowsProperties

พร็อพเพอร์ตี้แถวของตาราง

การแสดง JSON 
{
  "headerColorStyle": {
    object (ColorStyle)
  },
  "firstBandColorStyle": {
    object (ColorStyle)
  },
  "secondBandColorStyle": {
    object (ColorStyle)
  },
  "footerColorStyle": {
    object (ColorStyle)
  }
}
ช่อง
headerColorStyle

object (ColorStyle)

สีของแถวส่วนหัว หากตั้งค่าช่องนี้ ระบบจะเติมแถวส่วนหัวด้วยสีที่ระบุ ไม่เช่นนั้น ระบบจะเติมแถวส่วนหัวด้วยสีเริ่มต้น

firstBandColorStyle

object (ColorStyle)

สีแรกที่สลับ หากตั้งค่าช่องนี้ ระบบจะเติมแถวที่มีแถบสีแรกด้วยสีที่ระบุ มิเช่นนั้น ระบบจะเติมแถวแรกที่มีแถบสีด้วยสีเริ่มต้น

secondBandColorStyle

object (ColorStyle)

สีที่ 2 ที่สลับกัน หากตั้งค่าช่องนี้ ระบบจะเติมแถวที่ 2 ของแถบด้วยสีที่ระบุ มิเช่นนั้น ระบบจะเติมแถวที่มีแถบสีที่ 2 ด้วยสีเริ่มต้น

footerColorStyle

object (ColorStyle)

สีของแถวสุดท้าย หากไม่ได้ตั้งค่าช่องนี้ ระบบจะไม่เพิ่มส่วนท้าย แถวสุดท้ายจะแสดงค่า firstBandColorStyle หรือ secondBandColorStyle ทั้งนี้ขึ้นอยู่กับสีของแถวก่อนหน้า หากอัปเดตตารางที่มีอยู่ซึ่งไม่มีส่วนท้ายให้มีส่วนท้าย ระบบจะขยายช่วงขึ้น 1 แถว หากอัปเดตตารางที่มีอยู่ซึ่งมีส่วนท้ายและนำส่วนท้ายออก ช่วงจะลดลง 1 แถว

TableColumnProperties

คอลัมน์ของตาราง

การแสดง JSON 
{
  "columnIndex": integer,
  "columnName": string,
  "columnType": enum (ColumnType),
  "dataValidationRule": {
    object (TableColumnDataValidationRule)
  }
}
ช่อง
columnIndex

integer

ดัชนีคอลัมน์แบบ 0 ดัชนีนี้สัมพันธ์กับตําแหน่งในตาราง และไม่จำเป็นต้องเหมือนกับดัชนีคอลัมน์ในชีต

columnName

string

ชื่อคอลัมน์

columnType

enum (ColumnType)

ประเภทคอลัมน์

dataValidationRule

object (TableColumnDataValidationRule)

กฎการตรวจสอบข้อมูลของคอลัมน์ กำหนดไว้สำหรับประเภทคอลัมน์แบบเลื่อนลงเท่านั้น

ColumnType

ประเภทคอลัมน์ของคอลัมน์หนึ่งๆ ในตาราง

Enum
COLUMN_TYPE_UNSPECIFIED ประเภทคอลัมน์ที่ไม่ได้ระบุ
DOUBLE ประเภทคอลัมน์ตัวเลข
CURRENCY ประเภทคอลัมน์สกุลเงิน
PERCENT ประเภทคอลัมน์เปอร์เซ็นต์
DATE ประเภทคอลัมน์วันที่
TIME ประเภทคอลัมน์เวลา
DATE_TIME ประเภทคอลัมน์วันที่และเวลา
TEXT ประเภทคอลัมน์ข้อความ
BOOLEAN ประเภทคอลัมน์บูลีน
DROPDOWN ประเภทคอลัมน์แบบเลื่อนลง
FILES_CHIP ประเภทคอลัมน์ชิปไฟล์
PEOPLE_CHIP ประเภทคอลัมน์ชิปบุคคล
FINANCE_CHIP ประเภทคอลัมน์ชิปการเงิน
PLACE_CHIP ประเภทคอลัมน์ชิปสถานที่
RATINGS_CHIP ประเภทคอลัมน์ชิปการให้คะแนน

TableColumnDataValidationRule

กฎการตรวจสอบข้อมูลสำหรับคอลัมน์ในตาราง

การแสดง JSON 
{
  "condition": {
    object (BooleanCondition)
  }
}
ช่อง
condition

object (BooleanCondition)

เงื่อนไขที่ข้อมูลในเซลล์ต้องตรงกัน ใช้ได้เฉพาะในกรณีที่ [BooleanCondition.type] เป็น ONE_OF_LIST