Sheet
Sheet dalam spreadsheet.
| Representasi JSON |
|---|
{ "properties": { object ( |
| Kolom | |
|---|---|
properties
|
Properti sheet. |
data[]
|
Data dalam petak, jika ini adalah sheet petak.
Jumlah objek GridData yang ditampilkan bergantung pada jumlah rentang yang diminta di sheet ini. Misalnya, jika ini merepresentasikan
Untuk
|
merges[]
|
Rentang yang digabungkan. |
conditionalFormats[]
|
Aturan format bersyarat dalam sheet ini. |
filterViews[]
|
Tampilan filter dalam sheet ini. |
protectedRanges[]
|
Rentang yang dilindungi dalam sheet ini. |
basicFilter
|
Filter pada sheet ini, jika ada. |
charts[]
|
Spesifikasi setiap diagram di sheet ini. |
bandedRanges[]
|
Rentang berjalur (warna alternatif) pada sheet ini. |
developerMetadata[]
|
Metadata developer yang terkait dengan sheet. |
rowGroups[]
|
Semua grup baris di sheet ini, diurutkan berdasarkan indeks awal rentang yang meningkat, lalu berdasarkan kedalaman grup. |
columnGroups[]
|
Semua grup kolom di sheet ini, diurutkan berdasarkan indeks awal rentang yang meningkat, lalu berdasarkan kedalaman grup. |
slicers[]
|
Pengiris di sheet ini. |
tables[]
|
Tabel di sheet ini. |
SheetProperties
Properti sheet.
| Representasi JSON |
|---|
{ "sheetId": integer, "title": string, "index": integer, "sheetType": enum ( |
| Kolom | |
|---|---|
sheetId
|
ID sheet. Tidak boleh negatif. Kolom ini tidak dapat diubah setelah ditetapkan. |
title
|
Nama sheet. |
index
|
Indeks sheet dalam spreadsheet. Saat menambahkan atau memperbarui properti sheet, jika kolom ini dikecualikan, sheet akan ditambahkan atau dipindahkan ke akhir daftar sheet. Saat memperbarui indeks sheet atau menyisipkan sheet, pergerakan dipertimbangkan dalam indeks "sebelum pemindahan". Misalnya, jika ada tiga sheet (S1, S2, S3) untuk memindahkan S1 ke depan S2, indeks harus ditetapkan ke 2. Permintaan pembaruan indeks sheet diabaikan jika indeks yang diminta identik dengan indeks sheet saat ini atau jika indeks baru yang diminta sama dengan indeks sheet saat ini + 1. |
sheetType
|
Jenis sheet. Nilai defaultnya adalah
|
gridProperties
|
Properti tambahan sheet jika sheet ini adalah petak. (Jika sheet adalah sheet objek, yang berisi diagram atau gambar, kolom ini tidak akan ada.) Saat menulis, akan terjadi error jika Anda menetapkan properti petak pada sheet non-petak.
Jika sheet ini adalah
sheet |
tabColor
|
Warna tab di UI. Tidak digunakan lagi: Gunakan
|
tabColorStyle
|
Warna tab di UI. Jika
|
rightToLeft
|
Benar jika sheet adalah sheet RTL, bukan sheet LTR. |
dataSourceSheetProperties
|
Hanya output. Jika ada, kolom ini berisi
|
SheetType
Jenis sheet.
| Enum | |
|---|---|
SHEET_TYPE_UNSPECIFIED
|
Nilai default, jangan gunakan. |
GRID
|
Sheet adalah petak. |
OBJECT
|
Sheet tidak memiliki petak dan memiliki objek seperti diagram atau gambar. |
DATA_SOURCE
|
Sheet terhubung dengan
DataSource
dan menampilkan pratinjau data.
|
GridProperties
Properti petak.
| Representasi JSON |
|---|
{ "rowCount": integer, "columnCount": integer, "frozenRowCount": integer, "frozenColumnCount": integer, "hideGridlines": boolean, "rowGroupControlAfter": boolean, "columnGroupControlAfter": boolean } |
| Kolom | |
|---|---|
rowCount
|
Jumlah baris dalam petak. |
columnCount
|
Jumlah kolom dalam petak. |
frozenRowCount
|
Jumlah baris yang dibekukan dalam petak. |
frozenColumnCount
|
Jumlah kolom yang dibekukan dalam petak. |
hideGridlines
|
Benar jika petak tidak menampilkan garis petak di UI. |
rowGroupControlAfter
|
Benar (True) jika tombol kontrol pengelompokan baris ditampilkan setelah grup. |
columnGroupControlAfter
|
Benar (True) jika tombol kontrol pengelompokan kolom ditampilkan setelah grup. |
DataSourceSheetProperties
Properti tambahan
lembar DATA_SOURCE.
| Representasi JSON |
|---|
{ "dataSourceId": string, "columns": [ { object ( |
| Kolom | |
|---|---|
dataSourceId
|
ID
|
columns[]
|
Kolom yang ditampilkan di sheet, sesuai dengan nilai di
|
dataExecutionStatus
|
Status eksekusi data. |
GridData
Data dalam petak, serta metadata tentang dimensi.
| Representasi JSON |
|---|
{ "startRow": integer, "startColumn": integer, "rowData": [ { object ( |
| Kolom | |
|---|---|
startRow
|
Baris pertama yang dirujuk GridData ini, berbasis nol. |
startColumn
|
Kolom pertama yang dirujuk GridData ini, berbasis nol. |
rowData[]
|
Data dalam petak, satu entri per baris, dimulai dengan baris di startRow. Nilai dalam RowData akan sesuai dengan kolom yang dimulai dari
|
rowMetadata[]
|
Metadata tentang baris yang diminta dalam petak, dimulai dengan baris di
|
columnMetadata[]
|
Metadata tentang kolom yang diminta dalam petak, dimulai dengan kolom di
|
RowData
Data tentang setiap sel dalam baris.
| Representasi JSON |
|---|
{
"values": [
{
object ( |
| Kolom | |
|---|---|
values[]
|
Nilai dalam baris, satu per kolom. |
DimensionProperties
Properti tentang dimensi.
| Representasi JSON |
|---|
{ "hiddenByFilter": boolean, "hiddenByUser": boolean, "pixelSize": integer, "developerMetadata": [ { object ( |
| Kolom | |
|---|---|
pixelSize
|
Tinggi (jika baris) atau lebar (jika kolom) dimensi dalam piksel. |
developerMetadata[]
|
Metadata developer yang terkait dengan satu baris atau kolom. |
dataSourceColumnReference
|
Hanya output. Jika disetel, ini adalah kolom di sheet sumber data. |
ConditionalFormatRule
Aturan yang menjelaskan format bersyarat.
| Representasi JSON |
|---|
{ "ranges": [ { object ( |
| Kolom | |
|---|---|
ranges[]
|
Rentang yang diformat jika kondisinya benar. Semua rentang harus berada di petak yang sama. |
Kolom gabungan
rule. Aturan yang mengontrol format bersyarat ini, tepatnya satu yang harus ditetapkan.
rule
hanya dapat berupa salah satu dari berikut:
|
|
booleanRule
|
Pemformatan "aktif" atau "nonaktif" sesuai dengan aturan. |
gradientRule
|
Pemformatan akan bervariasi berdasarkan gradien dalam aturan. |
BooleanRule
Aturan yang mungkin cocok atau tidak, bergantung pada kondisinya.
| Representasi JSON |
|---|
{ "condition": { object ( |
| Kolom | |
|---|---|
condition
|
Kondisi aturan. Jika kondisi bernilai benar, format akan diterapkan. |
format
|
Format yang akan diterapkan. Pemformatan bersyarat hanya dapat menerapkan subset pemformatan:
|
GradientRule
Aturan yang menerapkan format skala warna gradien, berdasarkan titik interpolasi yang tercantum. Format sel akan bervariasi berdasarkan isinya dibandingkan dengan nilai titik interpolasi.
| Representasi JSON |
|---|
{ "minpoint": { object ( |
| Kolom | |
|---|---|
minpoint
|
Titik interpolasi awal. |
midpoint
|
Titik interpolasi di tengah opsional. |
maxpoint
|
Titik interpolasi akhir. |
InterpolationPoint
Satu titik interpolasi pada format bersyarat gradien. Pin ini menyematkan skala warna gradien sesuai dengan warna, jenis, dan nilai yang dipilih.
| Representasi JSON |
|---|
{ "color": { object ( |
| Kolom | |
|---|---|
color
|
Warna yang harus digunakan titik interpolasi ini. Tidak digunakan lagi: Gunakan
|
colorStyle
|
Warna yang harus digunakan titik interpolasi ini. Jika
|
type
|
Cara nilai harus ditafsirkan. |
value
|
Nilai yang digunakan titik interpolasi ini. Dapat berupa formula. Tidak digunakan jika
|
InterpolationPointType
Jenis titik interpolasi.
| Enum | |
|---|---|
INTERPOLATION_POINT_TYPE_UNSPECIFIED
|
Nilai default, jangan gunakan. |
MIN
|
Titik interpolasi menggunakan nilai minimum dalam sel di seluruh rentang format bersyarat. |
MAX
|
Titik interpolasi menggunakan nilai maksimum dalam sel di seluruh rentang format bersyarat. |
NUMBER
|
Titik interpolasi menggunakan nilai yang sama persis di
InterpolationPoint.value.
|
PERCENT
|
Titik interpolasi adalah persentase yang diberikan di semua sel dalam rentang format bersyarat. Ini setara dengan
|
PERCENTILE
|
Titik interpolasi adalah persentil tertentu di semua sel dalam rentang format bersyarat. Ini setara dengan
NUMBER
jika nilainya adalah:
=PERCENTILE(FLATTEN(range), value / 100)
(dengan error dalam rentang diabaikan saat meratakan).
|
FilterView
Tampilan filter. Untuk mengetahui informasi selengkapnya, lihat Mengelola visibilitas data dengan filter.
| Representasi JSON |
|---|
{ "filterViewId": integer, "title": string, "range": { object ( |
| Kolom | |
|---|---|
filterViewId
|
ID tampilan filter. |
title
|
Nama tampilan filter. |
range
|
Rentang yang dicakup oleh tampilan filter ini.
Saat menulis, hanya satu dari
|
namedRangeId
|
Rentang bernama yang mendukung tampilan filter ini, jika ada.
Saat menulis, hanya satu dari
|
tableId
|
Tabel yang mendukung tampilan filter ini, jika ada.
Saat menulis, hanya satu dari
|
sortSpecs[]
|
Urutan pengurutan per kolom. Spesifikasi selanjutnya digunakan jika nilai sama dalam spesifikasi sebelumnya. |
criteria
|
Kriteria untuk menampilkan/menyembunyikan nilai per kolom. Kunci peta adalah indeks kolom, dan nilainya adalah kriteria untuk kolom tersebut.
Kolom ini tidak digunakan lagi dan digantikan dengan
|
filterSpecs[]
|
Kriteria filter untuk menampilkan atau menyembunyikan nilai per kolom.
Baik
|
ProtectedRange
Rentang dilindungi.
| Representasi JSON |
|---|
{ "protectedRangeId": integer, "range": { object ( |
| Kolom | |
|---|---|
protectedRangeId
|
ID rentang yang dilindungi. Kolom ini bersifat hanya baca. |
range
|
Rentang yang dilindungi. Rentang dapat sepenuhnya tidak terikat, yang dalam hal ini dianggap sebagai sheet yang dilindungi.
Saat menulis, hanya salah satu dari
|
namedRangeId
|
Rentang bernama yang mendukung rentang terlindungi ini, jika ada.
Saat menulis, hanya salah satu dari
|
tableId
|
Tabel yang mendukung rentang yang dilindungi ini, jika ada.
Saat menulis, hanya salah satu dari
|
description
|
Deskripsi rentang yang dilindungi ini. |
warningOnly
|
Benar (True) jika rentang yang dilindungi ini akan menampilkan peringatan saat diedit. Perlindungan berbasis peringatan berarti setiap pengguna dapat mengedit data dalam rentang yang dilindungi, kecuali pengeditan akan memunculkan peringatan yang meminta pengguna untuk mengonfirmasi pengeditan.
Saat menulis: jika kolom ini benar, maka
|
requestingUserCanEdit
|
Benar (True) jika pengguna yang meminta rentang terlindungi ini dapat mengedit area terlindungi. Kolom ini bersifat hanya baca. |
unprotectedRanges[]
|
Daftar rentang yang tidak dilindungi dalam sheet yang dilindungi. Rentang yang tidak dilindungi hanya didukung di sheet yang dilindungi. |
editors
|
Pengguna dan grup dengan akses edit ke rentang yang dilindungi. Kolom ini hanya dapat dilihat oleh pengguna dengan akses edit ke rentang yang dilindungi dan dokumen. Editor tidak didukung dengan
perlindungan |
Editor
Editor rentang dilindungi.
| Representasi JSON |
|---|
{ "users": [ string ], "groups": [ string ], "domainUsersCanEdit": boolean } |
| Kolom | |
|---|---|
users[]
|
Alamat email pengguna dengan akses edit ke rentang yang dilindungi. |
groups[]
|
Alamat email grup dengan akses edit ke rentang terlindungi. |
domainUsersCanEdit
|
Benar jika siapa pun di domain dokumen memiliki akses edit ke rentang yang dilindungi. Perlindungan domain hanya didukung pada dokumen dalam domain. |
BasicFilter
Filter default yang terkait dengan sheet. Untuk mengetahui informasi selengkapnya, lihat Mengelola visibilitas data dengan filter.
| Representasi JSON |
|---|
{ "range": { object ( |
| Kolom | |
|---|---|
range
|
Rentang yang dicakup filter. |
tableId
|
Tabel yang mendukung filter ini, jika ada. Saat menulis, hanya salah satu dari
|
sortSpecs[]
|
Urutan pengurutan per kolom. Spesifikasi selanjutnya digunakan jika nilai sama dalam spesifikasi sebelumnya. |
criteria
|
Kriteria untuk menampilkan/menyembunyikan nilai per kolom. Kunci peta adalah indeks kolom, dan nilainya adalah kriteria untuk kolom tersebut.
Kolom ini tidak digunakan lagi dan digantikan dengan
|
filterSpecs[]
|
Kriteria filter per kolom.
Baik
|
BandedRange
Rentang berjalur (warna alternatif) dalam sheet.
| Representasi JSON |
|---|
{ "bandedRangeId": integer, "bandedRangeReference": string, "range": { object ( |
| Kolom | |
|---|---|
bandedRangeId
|
ID rentang berband. Jika tidak disetel, lihat
|
bandedRangeReference
|
Hanya output. Referensi rentang berjalur, digunakan untuk mengidentifikasi ID yang tidak didukung oleh
|
range
|
Rentang tempat properti ini diterapkan. |
rowProperties
|
Properti untuk rentang baris. Properti ini diterapkan baris demi baris di seluruh baris dalam rentang. Setidaknya salah satu dari
|
columnProperties
|
Properti untuk rentang kolom. Properti ini diterapkan berdasarkan kolom demi kolom di seluruh kolom dalam rentang. Setidaknya salah satu dari
|
BandingProperties
Properti yang merujuk satu dimensi (baris atau kolom). Jika
BandedRange.row_properties
dan
BandedRange.column_properties
ditetapkan, warna pengisi diterapkan ke sel sesuai dengan aturan berikut:
-
headerColordanfooterColordiprioritaskan daripada warna band. -
firstBandColorlebih diprioritaskan daripadasecondBandColor. -
rowPropertieslebih diprioritaskan daripadacolumnProperties.
Misalnya, warna baris pertama lebih diprioritaskan daripada warna kolom pertama, tetapi warna kolom pertama lebih diprioritaskan daripada warna baris kedua. Demikian pula, header baris lebih diprioritaskan daripada header kolom di sel kiri atas, tetapi header kolom lebih diprioritaskan daripada warna baris pertama jika header baris tidak ditetapkan.
| Representasi JSON |
|---|
{ "headerColor": { object ( |
| Kolom | |
|---|---|
headerColor
|
Warna baris atau kolom pertama. Jika kolom ini ditetapkan, baris atau kolom pertama akan diisi dengan warna ini dan warna akan bergantian antara
|
headerColorStyle
|
Warna baris atau kolom pertama. Jika kolom ini ditetapkan, baris atau kolom pertama akan diisi dengan warna ini dan warna akan bergantian antara
|
firstBandColor
|
Warna pertama yang bergantian. (Wajib) Tidak digunakan lagi: Gunakan
|
firstBandColorStyle
|
Warna pertama yang bergantian. (Wajib) Jika
|
secondBandColor
|
Warna kedua yang bergantian. (Wajib) Tidak digunakan lagi: Gunakan
|
secondBandColorStyle
|
Warna kedua yang bergantian. (Wajib) Jika
|
footerColor
|
Warna baris atau kolom terakhir. Jika kolom ini tidak disetel, baris atau kolom terakhir akan diisi dengan
|
footerColorStyle
|
Warna baris atau kolom terakhir. Jika kolom ini tidak disetel, baris atau kolom terakhir akan diisi dengan
|
DimensionGroup
Grup di atas interval baris atau kolom pada sheet, yang dapat berisi atau berada dalam grup lain. Grup dapat diciutkan atau diperluas sebagai satu unit di sheet.
| Representasi JSON |
|---|
{
"range": {
object ( |
| Kolom | |
|---|---|
range
|
Rentang waktu keberadaan grup ini. |
depth
|
Kedalaman grup, yang menunjukkan jumlah grup yang memiliki rentang yang sepenuhnya berisi rentang grup ini. |
collapsed
|
Kolom ini bernilai benar (true) jika grup ini diciutkan. Grup yang diciutkan akan tetap diciutkan jika grup yang tumpang-tindih pada kedalaman yang lebih dangkal diluaskan. Nilai benar tidak menyiratkan bahwa semua dimensi dalam grup disembunyikan, karena visibilitas dimensi dapat berubah secara independen dari properti grup ini. Namun, saat properti ini diperbarui, semua dimensi di dalamnya akan disetel ke tersembunyi jika kolom ini benar, atau disetel ke terlihat jika kolom ini salah. |
Pengiris
Pengiris dalam sheet.
| Representasi JSON |
|---|
{ "slicerId": integer, "spec": { object ( |
| Kolom | |
|---|---|
slicerId
|
ID pengiris. |
spec
|
Spesifikasi pengiris. |
position
|
Posisi pengiris. Perhatikan bahwa pengiris hanya dapat ditempatkan di sheet yang ada. Selain itu, lebar dan tinggi pengiris dapat disesuaikan secara otomatis agar tetap berada dalam batas yang diizinkan. |
SlicerSpec
Spesifikasi pengiris.
| Representasi JSON |
|---|
{ "dataRange": { object ( |
| Kolom | |
|---|---|
dataRange
|
Rentang data pemotong. |
filterCriteria
|
Kriteria pemfilteran pengiris. |
columnIndex
|
Indeks kolom berbasis nol dalam tabel data tempat filter diterapkan. |
applyToPivotTables
|
Benar jika filter harus diterapkan ke tabel pivot. Jika tidak disetel, defaultnya adalah
|
title
|
Judul pengiris. |
textFormat
|
Format teks judul dalam pengiris. Kolom link tidak didukung. |
backgroundColor
|
Warna latar belakang pengirisan. Tidak digunakan lagi: Gunakan
|
backgroundColorStyle
|
Warna latar belakang pengirisan. Jika
|
horizontalAlignment
|
Perataan horizontal judul dalam pengiris. Jika tidak ditentukan, setelan defaultnya adalah
|
Tabel
Tabel.
| Representasi JSON |
|---|
{ "tableId": string, "name": string, "range": { object ( |
| Kolom | |
|---|---|
tableId
|
ID tabel. |
name
|
Nama tabel. ID ini unik untuk semua tabel dalam spreadsheet yang sama. |
range
|
Rentang tabel. |
rowsProperties
|
Properti baris tabel. |
columnProperties[]
|
Properti kolom tabel. |
TableRowsProperties
Properti baris tabel.
| Representasi JSON |
|---|
{ "headerColorStyle": { object ( |
| Kolom | |
|---|---|
headerColorStyle
|
Warna baris header. Jika kolom ini ditetapkan, baris header akan diisi dengan warna yang ditentukan. Jika tidak, baris header akan diisi dengan warna default. |
firstBandColorStyle
|
Warna pertama yang bergantian. Jika kolom ini ditetapkan, baris berjalur pertama akan diisi dengan warna yang ditentukan. Jika tidak, baris yang dikelompokkan pertama akan diisi dengan warna default. |
secondBandColorStyle
|
Warna kedua yang bergantian. Jika kolom ini ditetapkan, baris berjalur kedua akan diisi dengan warna yang ditentukan. Jika tidak, baris kedua yang dikelompokkan akan diisi dengan warna default. |
footerColorStyle
|
Warna baris terakhir. Jika kolom ini tidak ditetapkan, footer tidak akan ditambahkan, baris terakhir akan diisi dengan
|
TableColumnProperties
Kolom tabel.
| Representasi JSON |
|---|
{ "columnIndex": integer, "columnName": string, "columnType": enum ( |
| Kolom | |
|---|---|
columnIndex
|
Indeks kolom berbasis 0. Indeks ini relatif terhadap posisinya dalam tabel dan tidak harus sama dengan indeks kolom dalam sheet. |
columnName
|
Nama kolom. |
columnType
|
Jenis kolom. |
dataValidationRule
|
Aturan validasi data kolom. Hanya ditetapkan untuk jenis kolom dropdown. |
ColumnType
Jenis kolom untuk kolom tertentu dalam tabel.
| Enum | |
|---|---|
COLUMN_TYPE_UNSPECIFIED
|
Jenis kolom tidak ditentukan. |
DOUBLE
|
Jenis kolom angka. |
CURRENCY
|
Jenis kolom mata uang. |
PERCENT
|
Jenis kolom persentase. |
DATE
|
Jenis kolom tanggal. |
TIME
|
Jenis kolom waktu. |
DATE_TIME
|
Jenis kolom tanggal dan waktu. |
TEXT
|
Jenis kolom teks. |
BOOLEAN
|
Jenis kolom boolean. |
DROPDOWN
|
Jenis kolom dropdown. |
FILES_CHIP
|
Jenis kolom chip file |
PEOPLE_CHIP
|
Jenis kolom chip orang |
FINANCE_CHIP
|
Jenis kolom chip keuangan |
PLACE_CHIP
|
Jenis kolom chip tempat |
RATINGS_CHIP
|
Jenis kolom chip rating |
TableColumnDataValidationRule
Aturan validasi data untuk kolom dalam tabel.
| Representasi JSON |
|---|
{
"condition": {
object ( |
| Kolom | |
|---|---|
condition
|
Kondisi yang harus dipenuhi oleh data dalam sel. Hanya valid jika [BooleanCondition.type] adalah ONE_OF_LIST. |