Dokumen ini menjelaskan dasar-dasar penggunaan resource
spreadsheets.values.
Spreadsheet dapat memiliki beberapa sheet, dengan setiap sheet memiliki sejumlah baris
atau kolom. Sel adalah lokasi
di persimpangan baris dan kolom tertentu, dan mungkin berisi nilai
data. Google Sheets API menyediakan resource spreadsheets.values untuk memungkinkan pembacaan dan penulisan nilai.
Jika Anda perlu menyisipkan baris atau memperbarui pemformatan dan properti lainnya dalam
sheet, Anda harus menggunakan
metode
batchUpdate
dari resource
spreadsheets,
seperti yang dijelaskan dalam Memperbarui spreadsheet.
Metode resource
Resource
spreadsheets.values
menyediakan metode berikut untuk membaca dan menulis nilai, masing-masing untuk
tugas tertentu:
| Akses rentang | Membaca | Menulis |
|---|---|---|
| Rentang tunggal | spreadsheets.values.get |
spreadsheets.values.update |
| Beberapa rentang | spreadsheets.values.batchGet |
spreadsheets.values.batchUpdate |
| Menambahkan | spreadsheets.values.append |
Secara umum, sebaiknya gabungkan beberapa pembacaan atau update dengan metode
batchGet dan batchUpdate (masing-masing), karena hal ini meningkatkan efisiensi.
Anda dapat menemukan contoh kode dari setiap metode ini di halaman contoh Pembacaan dasar dan Penulisan dasar. Untuk melihat semua contoh kode, lihat halaman ringkasan contoh.
Membaca nilai sel
Untuk membaca nilai data dari sheet, Anda memerlukan ID spreadsheet dan notasi A1 untuk rentang. Menentukan rentang tanpa ID sheet (A1:B2)
berarti permintaan dijalankan di sheet pertama dalam spreadsheet. Untuk mengetahui informasi selengkapnya tentang ID spreadsheet dan notasi A1, lihat Ringkasan Google Sheets API.
Beberapa parameter kueri opsional mengontrol format output:
| Parameter format | Nilai default |
|---|---|
majorDimension |
BARIS |
valueRenderOption |
FORMATTED_VALUE |
dateTimeRenderOption |
SERIAL_NUMBER |
Perhatikan bahwa Anda hanya boleh menggunakan dateTimeRenderOption jika valueRenderOption
bukan FORMATTED_VALUE.
Tidak ada batasan eksplisit untuk jumlah data yang ditampilkan. Error tidak menampilkan data. Baris dan kolom kosong di akhir tidak disertakan.
Metode pengambilan tunggal dan batch dijelaskan di bagian berikut. Untuk contoh kode lainnya dari operasi baca dasar, lihat Membaca dasar.
Membaca nilai dari satu rentang
Untuk membaca satu rentang nilai dari spreadsheet, gunakan permintaan
spreadsheets.values.get:
Apps Script
Java
JavaScript
Node.js
PHP
Python
Ruby
Respons terhadap permintaan ini ditampilkan sebagai objek
ValueRange
yang merupakan bagian dari
spreadsheets.values
resource.
Membaca nilai dari beberapa rentang
Untuk membaca beberapa rentang nilai yang tidak berurutan dari spreadsheet, gunakan permintaan
spreadsheets.values.batchGet
yang memungkinkan Anda menentukan beberapa rentang yang akan diambil:
Apps Script
Java
JavaScript
Node.js
PHP
Python
Ruby
Respons terhadap permintaan ini ditampilkan sebagai objek
BatchGetValuesResponse
yang berisi spreadsheetId dan daftar objek
ValueRange.
Menulis nilai sel
Untuk menulis ke sheet, Anda memerlukan ID spreadsheet, rentang sel dalam notasi A1, dan data yang ingin Anda tulis dalam objek isi permintaan yang sesuai. Untuk mengetahui informasi selengkapnya tentang ID spreadsheet dan notasi A1, lihat Ringkasan Google Sheets API.
Beberapa parameter kueri mengontrol cara data ditulis dan cara respons diformat:
| Parameter tulis | Nilai default |
|---|---|
valueInputOption |
(Wajib) |
includeValuesInResponse |
false |
responseValueRenderOption |
FORMATTED_VALUE |
responseDateTimeRenderOption |
SERIAL_NUMBER |
Parameter valueInputOption yang diperlukan mengontrol cara penafsiran data input. (Untuk update batch, parameter ini ditentukan dalam
isi permintaan.) Opsi yang didukung dijelaskan dalam tabel berikut:
ValueInputOption |
Deskripsi |
|---|---|
RAW |
Input tidak diuraikan dan dimasukkan sebagai string. Misalnya, input "=1+2" menempatkan string, bukan formula, "=1+2" di sel. (Nilai non-string seperti boolean atau angka selalu ditangani sebagai RAW.) |
USER_ENTERED |
Input diuraikan persis seperti jika dimasukkan ke UI Spreadsheet. Misalnya, "1 Mar 2016" menjadi tanggal, dan "=1+2" menjadi formula. Format juga dapat disimpulkan, sehingga "$100.15" menjadi angka dengan format mata uang. |
Perhatikan bahwa Anda hanya boleh menggunakan responseDateTimeRenderOption jika
responseValueRenderOption bukan FORMATTED_VALUE.
Metode pembaruan tunggal dan batch dijelaskan di bagian berikut. Untuk contoh kode operasi tulis dasar lainnya, lihat Penulisan dasar.
Menulis nilai ke rentang tunggal
Untuk menulis data ke satu rentang, gunakan permintaan
spreadsheets.values.update:
Apps Script
Java
JavaScript
Node.js
PHP
Python
Ruby
Isi permintaan update harus berupa objek
ValueRange, meskipun satu-satunya kolom yang wajib diisi adalah values. Jika range ditentukan, nilai tersebut
harus cocok dengan rentang di URL. Di ValueRange, Anda dapat secara opsional menentukan
majorDimension-nya.
Secara default, ROWS digunakan. Jika COLUMNS ditentukan, setiap array dalam akan ditulis ke kolom, bukan baris.
Saat memperbarui, nilai tanpa data akan dilewati. Untuk menghapus data, gunakan string
kosong (""). Anda juga dapat menghapus nilai dari beberapa rentang tanpa menggantinya
menggunakan metode
spreadsheets.values.batchClear.
Jika Anda menggunakan metadata developer, lihat panduan metadata developer untuk mengetahui informasi tentang penggunaan filter data guna membaca, memperbarui, atau menghapus nilai dengan metode spreadsheets.values.batchGetByDataFilter, spreadsheets.values.batchUpdateByDataFilter, dan spreadsheets.values.batchClearByDataFilter.
Menulis nilai ke beberapa rentang
Jika ingin menulis beberapa rentang yang tidak berurutan, Anda dapat menggunakan permintaan
spreadsheets.values.batchUpdate:
Apps Script
Java
JavaScript
Node.js
PHP
Python
Ruby
Isi permintaan kumpulan update harus berupa objek
BatchUpdateValuesRequest, yang berisi ValueInputOption dan daftar objek
ValueRange (satu untuk setiap rentang yang ditulis). Setiap objek ValueRange menentukan
range, majorDimension, dan data inputnya sendiri.
Tambahkan nilai
Untuk menambahkan data setelah tabel data dalam sheet, gunakan permintaan
spreadsheets.values.append:
Apps Script
Java
JavaScript
Node.js
PHP
Python
Ruby
Isi permintaan update harus berupa objek
ValueRange, meskipun satu-satunya kolom yang wajib diisi adalah values. Jika range ditentukan, nilai tersebut
harus cocok dengan rentang di URL. Di ValueRange, Anda dapat secara opsional menentukan
majorDimension-nya.
Secara default, ROWS digunakan. Jika COLUMNS ditentukan, setiap array dalam akan ditulis ke kolom, bukan baris.
Rentang input digunakan untuk menelusuri data yang ada dan menemukan "tabel" dalam rentang tersebut. Nilai ditambahkan ke baris berikutnya dalam tabel, dimulai dengan
kolom pertama tabel. Misalnya, pertimbangkan Sheet1 yang terlihat seperti:
| A | B | C | D | E | |
| 1 | x | y | z | ||
| 2 | x | y | z | ||
| 3 | |||||
| 4 | x | y | |||
| 5 | y | z | |||
| 6 | x | y | z | ||
| 7 |
Ada dua tabel dalam sheet: A1:C2, dan B4:D6. Nilai yang ditambahkan akan
dimulai dari B7 untuk semua input range berikut:
Sheet1, karena akan memeriksa semua data dalam sheet dan menentukan bahwa tabel diB4:D6adalah tabel terakhir.B4atauC5:D5, karena keduanya ada di tabelB4:D6.B2:D4, karena tabel terakhir dalam rentang adalah tabelB4:D6(meskipun tabel tersebut juga berisi tabelA1:C2).A3:G10, karena tabel terakhir dalam rentang adalah tabelB4:D6(meskipun dimulai sebelum dan berakhir setelahnya).
Input range berikut tidak akan mulai menulis pada B7:
A1akan mulai menulis padaA3, karena ada di tabelA1:C2.E4akan mulai menulis diE4, karena tidak ada dalam tabel. (A4juga akan mulai menulis diA4karena alasan yang sama.)
Selain itu, Anda dapat memilih apakah Anda ingin menimpa data yang ada setelah
tabel atau menyisipkan baris baru untuk data baru. Secara default, input akan menimpa data
setelah tabel. Untuk menulis data baru ke dalam baris baru, gunakan
InsertDataOption
dan tentukan insertDataOption=INSERT_ROWS.
Untuk mempelajari lebih lanjut batas sel dan baris di Spreadsheet, lihat File yang dapat Anda simpan di Google Drive.