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 จากนั้น GridData แรกจะมี startRow / startColumn ของ 0 ส่วน GridData ที่สองจะมี 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)

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)

ค่าในแถว โดยค่าหนึ่งต่อคอลัมน์

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)
    }
  ],

  "booleanRule": {
    object (BooleanRule)
  },
  "gradientRule": {
    object (GradientRule)
  }
}
ช่อง
ranges[]

object (GridRange)

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

ฟิลด์ Union 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

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

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

requestingUserCanEdit

boolean

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

unprotectedRanges[]

object (GridRange)

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

editors

object (Editors)

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

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

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

การแสดง 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 ระบบจะใช้สีเติมกับเซลล์ตามกฎต่อไปนี้

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

การแสดง 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

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

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

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

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

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

integer

รหัสของ Slicer

spec

object (SlicerSpec)

ข้อมูลจำเพาะของ Slicer

position

object (EmbeddedObjectPosition)

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

SlicerSpec

ข้อกำหนดของ Slicer

การแสดง 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)

เกณฑ์การกรองของ Slicer

columnIndex

integer

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

applyToPivotTables

boolean

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

title

string

ชื่อของ Slicer

textFormat

object (TextFormat)

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

backgroundColor
(deprecated)

object (Color)

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

backgroundColorStyle

object (ColorStyle)

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

horizontalAlignment

enum (HorizontalAlign)

การจัดแนวแนวนอนของชื่อใน Slicer หากไม่ได้ระบุไว้ ค่าเริ่มต้นจะเป็น 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