Tấm
Một trang tính trong bảng tính.
Biểu diễn dưới dạng JSON |
---|
{ "properties": { object ( |
Các trường | |
---|---|
properties
|
Các thuộc tính của trang tính. |
data[]
|
Dữ liệu trong lưới, nếu đây là trang tính lưới.
Số lượng đối tượng GridData được trả về phụ thuộc vào số lượng dải ô được yêu cầu trên trang tính này. Ví dụ: nếu giá trị này đại diện cho
Đối với trang tính |
merges[]
|
Dải ô được hợp nhất với nhau. |
conditionalFormats[]
|
Quy tắc định dạng có điều kiện trong trang tính này. |
filterViews[]
|
Các chế độ xem bộ lọc trong trang tính này. |
protectedRanges[]
|
Các dải ô được bảo vệ trong trang tính này. |
basicFilter
|
Bộ lọc trên trang tính này, nếu có. |
charts[]
|
Quy cách của mỗi biểu đồ trên trang tính này. |
bandedRanges[]
|
Dải màu (màu sắc thay đổi) nằm trên trang tính này. |
developerMetadata[]
|
Siêu dữ liệu nhà phát triển liên kết với một trang tính. |
rowGroups[]
|
Tất cả các nhóm hàng trên trang tính này, được sắp xếp theo thứ tự tăng dần chỉ số bắt đầu dải ô, rồi theo chiều sâu của nhóm. |
columnGroups[]
|
Tất cả các nhóm cột trên trang tính này, được sắp xếp theo chỉ số bắt đầu của phạm vi, rồi tăng theo chiều sâu của nhóm. |
slicers[]
|
Các bộ cắt trên trang tính này. |
Thuộc tính trang tính
Thuộc tính của trang tính.
Biểu diễn dưới dạng JSON |
---|
{ "sheetId": integer, "title": string, "index": integer, "sheetType": enum ( |
Các trường | |
---|---|
sheetId
|
Mã trang tính. Phải là số không âm. Không thể thay đổi trường này sau khi đã đặt. |
title
|
Tên trang tính. |
index
|
Chỉ mục của trang tính trong bảng tính. Khi thêm hoặc cập nhật thuộc tính trang tính, nếu trường này bị loại trừ thì trang tính sẽ được thêm hoặc di chuyển đến cuối danh sách trang tính. Khi cập nhật chỉ mục trang tính hoặc chèn trang tính, chuyển động được xem xét trong các chỉ mục "trước khi di chuyển". Ví dụ: nếu có ba trang tính (S1, S2, S3) để di chuyển S1 trước S2, chỉ mục sẽ phải được đặt thành 2. Yêu cầu cập nhật chỉ mục trang tính sẽ bị bỏ qua nếu chỉ mục được yêu cầu giống với chỉ mục hiện tại của trang tính hoặc nếu chỉ mục mới được yêu cầu bằng chỉ mục trang tính hiện tại + 1. |
sheetType
|
Loại trang tính. Giá trị mặc định là |
gridProperties
|
Các thuộc tính bổ sung của trang tính nếu trang tính này là một lưới. (Nếu trang tính là một trang tính đối tượng, có chứa biểu đồ hoặc hình ảnh, thì trường này sẽ không có.) Khi viết, bạn không nên đặt thuộc tính lưới trên trang tính không phải lưới.
Nếu trang tính này là trang tính |
tabColor
|
Màu sắc của thẻ trong giao diện người dùng. Không dùng nữa: Sử dụng |
tabColorStyle
|
Màu sắc của thẻ trong giao diện người dùng. Nếu bạn cũng đặt |
rightToLeft
|
Đúng nếu trang tính là một trang tính RTL thay vì một trang LTR. |
dataSourceSheetProperties
|
Chỉ đầu ra. Nếu có, trường này chứa các thuộc tính dành riêng cho trang tính |
Loại trang tính
Loại trang tính.
Enum | |
---|---|
SHEET_TYPE_UNSPECIFIED
|
Giá trị mặc định, không sử dụng. |
GRID
|
Trang tính là một lưới. |
OBJECT
|
Trang tính không có lưới và thay vào đó có một đối tượng như biểu đồ hoặc hình ảnh. |
DATA_SOURCE
|
Trang tính này kết nối với một DataSource bên ngoài và cho thấy bản xem trước của dữ liệu.
|
Thuộc tính lưới
Thuộc tính của lưới.
Biểu diễn dưới dạng JSON |
---|
{ "rowCount": integer, "columnCount": integer, "frozenRowCount": integer, "frozenColumnCount": integer, "hideGridlines": boolean, "rowGroupControlAfter": boolean, "columnGroupControlAfter": boolean } |
Các trường | |
---|---|
rowCount
|
Số hàng trong lưới. |
columnCount
|
Số cột trong lưới. |
frozenRowCount
|
Số hàng được cố định trong lưới. |
frozenColumnCount
|
Số cột được cố định trong lưới. |
hideGridlines
|
Đúng nếu lưới không hiển thị đường lưới trong giao diện người dùng. |
rowGroupControlAfter
|
Đúng nếu nút bật/tắt chức năng kiểm soát nhóm hàng hiển thị sau nhóm. |
columnGroupControlAfter
|
Đúng nếu nút bật/tắt kiểm soát nhóm cột hiển thị sau nhóm. |
Thuộc tính bảng nguồn dữ liệu
Các thuộc tính bổ sung của trang tính DATA_SOURCE
.
Biểu diễn dưới dạng JSON |
---|
{ "dataSourceId": string, "columns": [ { object ( |
Các trường | |
---|---|
dataSourceId
|
Mã của
|
columns[]
|
Các cột hiển thị trên trang tính, tương ứng với các giá trị trong |
dataExecutionStatus
|
Trạng thái thực thi dữ liệu. |
Dữ liệu lưới
Dữ liệu trong lưới cũng như siêu dữ liệu về thứ nguyên.
Biểu diễn dưới dạng JSON |
---|
{ "startRow": integer, "startColumn": integer, "rowData": [ { object ( |
Các trường | |
---|---|
startRow
|
Hàng đầu tiên mà GridData này tham chiếu đến, không dựa trên cơ sở dữ liệu. |
startColumn
|
Cột đầu tiên mà GridData này tham chiếu đến, không dựa vào dữ liệu. |
rowData[]
|
Dữ liệu trong lưới, một hàng cho mỗi hàng, bắt đầu bằng hàng trong startRow. Các giá trị trong RowData sẽ tương ứng với cột bắt đầu tại |
rowMetadata[]
|
Siêu dữ liệu về các hàng được yêu cầu trong lưới, bắt đầu bằng hàng trong |
columnMetadata[]
|
Siêu dữ liệu về các cột được yêu cầu trong lưới, bắt đầu bằng cột trong |
Dữ liệu hàng
Dữ liệu về mỗi ô trong một hàng.
Biểu diễn dưới dạng JSON |
---|
{
"values": [
{
object (
|
Các trường | |
---|---|
values[]
|
Giá trị trong hàng, một giá trị trên mỗi cột. |
Thuộc tính phương diện
Thuộc tính về một tham số.
Biểu diễn dưới dạng JSON |
---|
{ "hiddenByFilter": boolean, "hiddenByUser": boolean, "pixelSize": integer, "developerMetadata": [ { object ( |
Các trường | |
---|---|
pixelSize
|
Chiều cao (nếu hàng) hoặc chiều rộng (nếu là cột) của tham số tính bằng pixel. |
developerMetadata[]
|
Siêu dữ liệu dành cho nhà phát triển liên kết với một hàng hoặc cột duy nhất. |
dataSourceColumnReference
|
Chỉ đầu ra. Nếu được đặt thì đây sẽ là một cột trong trang tính nguồn dữ liệu. |
Định dạng có điều kiện
Quy tắc mô tả một định dạng có điều kiện.
Biểu diễn dưới dạng JSON |
---|
{ "ranges": [ { object ( |
Các trường | |
---|---|
ranges[]
|
Dải ô được định dạng nếu điều kiện là đúng. Tất cả dải ô phải nằm trên cùng một lưới. |
Trường nhóm rule . Quy tắc kiểm soát định dạng có điều kiện này phải đặt chính xác một định dạng.
rule chỉ có thể là một trong những loại sau đây:
|
|
booleanRule
|
Định dạng có trạng thái là "bật" hoặc "tắt" theo quy tắc. |
gradientRule
|
Định dạng sẽ thay đổi dựa trên độ dốc trong quy tắc. |
Quy tắc Boolean
Quy tắc có thể phù hợp hoặc không phù hợp, tùy thuộc vào điều kiện.
Biểu diễn dưới dạng JSON |
---|
{ "condition": { object ( |
Các trường | |
---|---|
condition
|
Điều kiện của quy tắc. Nếu điều kiện cho kết quả là đúng, định dạng sẽ được áp dụng. |
format
|
Định dạng sẽ áp dụng. Tính năng định dạng có điều kiện chỉ có thể áp dụng một số định dạng: |
GradientRule
Quy tắc áp dụng định dạng thang màu gradient, dựa trên các điểm nội suy được liệt kê. Định dạng của một ô sẽ thay đổi dựa trên nội dung của ô đó so với giá trị của các điểm nội suy.
Biểu diễn dưới dạng JSON |
---|
{ "minpoint": { object ( |
Các trường | |
---|---|
minpoint
|
Điểm bắt đầu nội suy. |
midpoint
|
Một điểm nội suy giữa chừng (không bắt buộc). |
maxpoint
|
Điểm nội suy cuối cùng. |
Điểm nội suy
Một điểm nội suy duy nhất trên định dạng có điều kiện tô chuyển tiếp. Các điểm này ghim thang màu gradient theo màu, loại và giá trị đã chọn.
Biểu diễn dưới dạng JSON |
---|
{ "color": { object ( |
Các trường | |
---|---|
color
|
Màu của điểm nội suy này. Không dùng nữa: Sử dụng |
colorStyle
|
Màu của điểm nội suy này. Nếu bạn cũng đặt |
type
|
Cách diễn giải giá trị. |
value
|
Giá trị mà điểm nội suy này sử dụng. Có thể là công thức. Không được dùng nếu |
Loại điểm nội suy
Loại điểm nội suy.
Enum | |
---|---|
INTERPOLATION_POINT_TYPE_UNSPECIFIED
|
Không sử dụng giá trị mặc định. |
MIN
|
Điểm nội suy sử dụng giá trị nhỏ nhất trong các ô nằm trong dải của định dạng có điều kiện. |
MAX
|
Điểm nội suy sử dụng giá trị lớn nhất trong các ô nằm trong dải của định dạng có điều kiện. |
NUMBER
|
Điểm nội suy sử dụng chính xác giá trị trong InterpolationPoint.value .
|
PERCENT
|
Điểm nội suy là tỷ lệ phần trăm cho trước trên tất cả các ô trong dải của định dạng có điều kiện. Giá trị này tương đương với |
PERCENTILE
|
Điểm nội suy là phân vị đã cho trên tất cả các ô thuộc dải có định dạng có điều kiện. Giá trị này tương đương với NUMBER nếu giá trị là: =PERCENTILE(FLATTEN(range), value / 100) (trong đó các lỗi trong dải ô bị bỏ qua khi làm phẳng).
|
Chế độ xem bộ lọc
Chế độ xem bộ lọc.
Biểu diễn dưới dạng JSON |
---|
{ "filterViewId": integer, "title": string, "range": { object ( |
Các trường | |
---|---|
filterViewId
|
ID của chế độ xem bộ lọc. |
title
|
Tên của chế độ xem bộ lọc. |
range
|
Phạm vi bao phủ của chế độ xem bộ lọc này.
Khi viết, bạn chỉ có thể đặt một trong số các thuộc tính |
namedRangeId
|
Dải ô được đặt tên mà chế độ xem bộ lọc này hỗ trợ, nếu có.
Khi viết, bạn chỉ có thể đặt một trong số các thuộc tính |
sortSpecs[]
|
Thứ tự sắp xếp mỗi cột. Thông số sau được sử dụng khi các giá trị bằng nhau trong thông số kỹ thuật trước đó. |
criteria
|
Tiêu chí hiển thị/ẩn giá trị trên mỗi cột. Khóa của bản đồ là chỉ mục cột và giá trị là tiêu chí cho cột đó.
Trường này không còn được sử dụng và thay bằng |
filterSpecs[]
|
Tiêu chí lọc để hiện/ẩn giá trị trên mỗi cột.
Cả
|
Phạm vi bảo vệ
Dải ô được bảo vệ.
Biểu diễn dưới dạng JSON |
---|
{ "protectedRangeId": integer, "range": { object ( |
Các trường | |
---|---|
protectedRangeId
|
Mã của dải ô được bảo vệ. Đây là trường chỉ đọc. |
range
|
Dải ô đang được bảo vệ. Dải ô có thể không bị ràng buộc hoàn toàn, trong trường hợp này được coi là trang tính được bảo vệ.
Khi viết, bạn chỉ có thể đặt một trong số các thuộc tính |
namedRangeId
|
Dải ô được đặt tên mà dải ô được bảo vệ này hỗ trợ, nếu có.
Khi viết, bạn chỉ có thể đặt một trong số các thuộc tính |
description
|
Mô tả của dải ô được bảo vệ này. |
warningOnly
|
Đúng nếu dải ô được bảo vệ này hiển thị cảnh báo khi chỉnh sửa. Biện pháp bảo vệ dựa trên cảnh báo có nghĩa là mọi người dùng đều có thể chỉnh sửa dữ liệu trong dải ô được bảo vệ, ngoại trừ việc chỉnh sửa sẽ nhắc nhở một cảnh báo yêu cầu người dùng xác nhận chỉnh sửa.
Khi viết: nếu trường này là true, thì |
requestingUserCanEdit
|
Đúng nếu người dùng yêu cầu dải ô được bảo vệ này có thể chỉnh sửa khu vực được bảo vệ. Đây là trường chỉ đọc. |
unprotectedRanges[]
|
Danh sách các dải ô không được bảo vệ trong một trang tính được bảo vệ. Dải ô không được bảo vệ chỉ được hỗ trợ trên trang tính được bảo vệ. |
editors
|
Người dùng và nhóm có quyền chỉnh sửa dải ô được bảo vệ. Trường này chỉ hiển thị với người dùng có quyền chỉnh sửa dải ô được bảo vệ và tài liệu. Trình chỉnh sửa không được hỗ trợ với chức năng bảo vệ |
Trình chỉnh sửa
Người chỉnh sửa dải ô được bảo vệ.
Biểu diễn dưới dạng JSON |
---|
{ "users": [ string ], "groups": [ string ], "domainUsersCanEdit": boolean } |
Các trường | |
---|---|
users[]
|
Địa chỉ email của người dùng có quyền chỉnh sửa dải ô được bảo vệ. |
groups[]
|
Địa chỉ email của nhóm có quyền chỉnh sửa đối với dải ô được bảo vệ. |
domainUsersCanEdit
|
Đúng nếu bất kỳ ai trong miền của tài liệu đều có quyền chỉnh sửa dải ô được bảo vệ. Bảo vệ miền chỉ được hỗ trợ trên các tài liệu trong miền. |
Bộ lọc cơ bản
Bộ lọc mặc định được liên kết với một trang tính.
Biểu diễn dưới dạng JSON |
---|
{ "range": { object ( |
Các trường | |
---|---|
range
|
Dải ô mà bộ lọc bao phủ. |
sortSpecs[]
|
Thứ tự sắp xếp mỗi cột. Thông số sau được sử dụng khi các giá trị bằng nhau trong thông số kỹ thuật trước đó. |
criteria
|
Tiêu chí hiển thị/ẩn giá trị trên mỗi cột. Khóa của bản đồ là chỉ mục cột và giá trị là tiêu chí cho cột đó.
Trường này không còn được sử dụng và thay bằng |
filterSpecs[]
|
Tiêu chí lọc mỗi cột.
Cả
|
Dải băng
Dải dải (màu thay thế) trong một trang tính.
Biểu diễn dưới dạng JSON |
---|
{ "bandedRangeId": integer, "range": { object ( |
Các trường | |
---|---|
bandedRangeId
|
Mã của dải ô. |
range
|
Dải ô mà các thuộc tính này được áp dụng. |
rowProperties
|
Thuộc tính cho các dải hàng. Các thuộc tính này được áp dụng trên cơ sở từng hàng trong tất cả các hàng trong dải ô. Bạn phải chỉ định ít nhất một trong các thuộc tính sau: |
columnProperties
|
Thuộc tính cho các dải cột. Các thuộc tính này được áp dụng trên cơ sở từng cột trong tất cả các cột trong dải ô. Bạn phải chỉ định ít nhất một trong các thuộc tính sau: |
Thuộc tính dải
Thuộc tính giới thiệu một thứ nguyên (hàng hoặc cột). Nếu bạn đặt cả BandedRange.row_properties
và BandedRange.column_properties
, màu tô sẽ được áp dụng cho các ô theo quy tắc sau:
-
headerColor
vàfooterColor
được ưu tiên hơn màu dải. -
firstBandColor
được ưu tiên hơnsecondBandColor
. -
rowProperties
được ưu tiên hơncolumnProperties
.
Ví dụ: màu hàng đầu tiên được ưu tiên hơn màu cột đầu tiên, nhưng màu cột đầu tiên được ưu tiên hơn màu hàng thứ hai. Tương tự, tiêu đề hàng sẽ được ưu tiên hơn tiêu đề cột trong ô trên cùng bên trái nhưng tiêu đề cột sẽ được ưu tiên hơn màu hàng đầu tiên nếu tiêu đề hàng không được đặt.
Biểu diễn dưới dạng JSON |
---|
{ "headerColor": { object ( |
Các trường | |
---|---|
headerColor
|
Màu của hàng hoặc cột đầu tiên. Nếu bạn đặt trường này, hàng hoặc cột đầu tiên sẽ được tô bằng màu này và các màu thay thế trong khoảng từ
|
headerColorStyle
|
Màu của hàng hoặc cột đầu tiên. Nếu bạn đặt trường này, hàng hoặc cột đầu tiên sẽ được tô bằng màu này và các màu thay thế trong khoảng từ
|
firstBandColor
|
Màu đầu tiên xen kẽ. (Bắt buộc) Ngừng sử dụng: Sử dụng |
firstBandColorStyle
|
Màu đầu tiên xen kẽ. (Bắt buộc) Nếu bạn cũng đặt |
secondBandColor
|
Màu thứ hai thay thế. (Bắt buộc) Ngừng sử dụng: Sử dụng |
secondBandColorStyle
|
Màu thứ hai thay thế. (Bắt buộc) Nếu bạn cũng đặt |
footerColor
|
Màu của hàng hoặc cột cuối cùng. Nếu bạn không đặt trường này, thì hàng hoặc cột cuối cùng sẽ được điền bằng |
footerColorStyle
|
Màu của hàng hoặc cột cuối cùng. Nếu bạn không đặt trường này, thì hàng hoặc cột cuối cùng sẽ được điền bằng |
Nhóm thứ nguyên
Một nhóm trên một khoảng thời gian của các hàng hoặc cột trên một trang tính, có thể chứa hoặc được chứa trong các nhóm khác. Một nhóm có thể được thu gọn hoặc mở rộng dưới dạng một đơn vị trên trang tính.
Biểu diễn dưới dạng JSON |
---|
{
"range": {
object (
|
Các trường | |
---|---|
range
|
Dải ô mà nhóm này tồn tại. |
depth
|
Độ sâu của nhóm, đại diện cho số lượng nhóm có phạm vi chứa toàn bộ phạm vi của nhóm này. |
collapsed
|
Trường này đúng nếu nhóm này được thu gọn. Nhóm thu gọn vẫn được thu gọn nếu nhóm chồng chéo ở độ sâu nông hơn. Giá trị thực không ngụ ý rằng tất cả các phương diện trong nhóm đều bị ẩn vì một phương diện có thể thay đổi độc lập với tài sản nhóm này. Tuy nhiên, khi bạn cập nhật thuộc tính này, tất cả các phương diện trong trường này sẽ bị ẩn nếu trường này là true, hoặc được đặt để hiển thị nếu trường này là false. |
Bộ cắt
Một bộ cắt trong một trang tính.
Biểu diễn dưới dạng JSON |
---|
{ "slicerId": integer, "spec": { object ( |
Các trường | |
---|---|
slicerId
|
Mã của bộ cắt. |
spec
|
Thông số kỹ thuật của bộ cắt. |
position
|
Vị trí của bộ cắt. Lưu ý rằng bộ cắt chỉ có thể được định vị trên trang tính hiện có. Ngoài ra, bạn có thể tự động điều chỉnh chiều rộng và chiều cao của bộ cắt để cho phép nằm trong giới hạn cho phép. |
SlicerSpec
Thông số kỹ thuật của một bộ cắt.
Biểu diễn dưới dạng JSON |
---|
{ "dataRange": { object ( |
Các trường | |
---|---|
dataRange
|
Phạm vi dữ liệu của bộ cắt. |
filterCriteria
|
Tiêu chí lọc của bộ cắt. |
columnIndex
|
Chỉ mục cột số 0 trong bảng dữ liệu mà bộ lọc được áp dụng. |
applyToPivotTables
|
True nếu bộ lọc sẽ áp dụng cho bảng tổng hợp. Nếu bạn không đặt chính sách này, thì giá trị mặc định sẽ là |
title
|
Tiêu đề của bộ cắt. |
textFormat
|
Định dạng văn bản của tiêu đề trong bộ cắt. Trường liên kết không được hỗ trợ. |
backgroundColor
|
Màu nền của bộ cắt. Không dùng nữa: Sử dụng |
backgroundColorStyle
|
Màu nền của bộ cắt. Nếu bạn cũng đặt |
horizontalAlignment
|
Căn chỉnh ngang của tiêu đề trong bộ cắt. Nếu không xác định, giá trị mặc định sẽ là |