Google Sheets API memungkinkan Anda membuat, membersihkan, menyalin, dan menghapus sheet, dan juga mengontrol propertinya. Contoh di halaman ini menggambarkan bagaimana Anda bisa mencapai beberapa operasi Spreadsheet umum dengan Sheets API.
Contoh ini disajikan dalam bentuk permintaan HTTP untuk memilih bahasa netral. Untuk mempelajari cara mengimplementasikan update secara batch dalam berbagai bahasa menggunakan library klien Google API, lihat Memperbarui di spreadsheet.
Dalam contoh ini, placeholder SPREADSHEET_ID
dan SHEET_ID
menunjukkan di mana Anda akan memberikan ID tersebut. Anda dapat menemukan spreadsheet
ID di URL spreadsheet. Anda bisa mendapatkan
sheet ID dengan menggunakan
Metode spreadsheets.get
. Tujuan
rentang ditentukan menggunakan notasi A1. Channel
contohnya adalah Sheet1!A1:D5.
Menambahkan sheet
Hal berikut
spreadsheets.batchUpdate
contoh kode menunjukkan cara menggunakan
AddSheetRequest
untuk menambahkan {i>sheet<i} ke {i>spreadsheet<i}, sembari
mengatur judul, ukuran {i>grid<i}, dan
warna tab.
Respons terdiri dari
AddSheetResponse
,
yang berisi objek dengan properti sheet yang dibuat (seperti
SHEET_ID
).
Protokol permintaan ditampilkan di bawah ini.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID
:batchUpdate
{ "requests": [ { "addSheet": { "properties": { "title": "Deposits", "gridProperties": { "rowCount": 20, "columnCount": 12 }, "tabColor": { "red": 1.0, "green": 0.3, "blue": 0.4 } } } } ] }
Menghapus sheet dari semua nilai dengan mempertahankan format
Hal berikut
spreadsheets.batchUpdate
contoh kode menunjukkan cara menggunakan
UpdateCellsRequest
untuk menghapus semua nilai dari {i>sheet<i} tanpa mengubah formatnya.
Menentukan
Kolom userEnteredValue
tanpa nilai yang sesuai akan ditafsirkan sebagai instruksi untuk menghapus nilai
dalam rentang tersebut. Setelan ini juga dapat digunakan dengan kolom lainnya. Misalnya,
mengubah nilai fields
menjadi
userEnteredFormat
menghapus
semua format yang didukung oleh Sheets API
dari {i>sheet<i}, tetapi membiarkan nilai
selnya tidak diubah.
Protokol permintaan ditampilkan di bawah ini.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID
:batchUpdate
{
"requests": [
{
"updateCells": {
"range": {
"sheetId": SHEET_ID
},
"fields": "userEnteredValue"
}
}
]
}
Menyalin sheet dari satu {i>spreadsheet<i} ke {i>spreadsheet<i} lainnya
Hal berikut
spreadsheet.sheets.copyTo
contoh kode menunjukkan cara menyalin satu sheet yang ditentukan oleh SHEET_ID
dari satu {i>spreadsheet<i}
ke {i>spreadsheet <i}yang lain.
Variabel TARGET_SPREADSHEET_ID
dalam isi permintaan menentukan
{i>spreadsheet <i}tujuan. Salinan tersebut mempertahankan semua nilai, format, formula, dan
properti lain dari aslinya. Judul sheet yang disalin ditetapkan ke "Copy
dari [judul sheet asli]".
Respons terdiri dari
SheetProperties
objek yang menjelaskan properti sheet yang dibuat.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID
/sheets/SHEET_ID
:copyTo
{
"destinationSpreadsheetId": "TARGET_SPREADSHEET_ID
"
}
Menghapus sheet
Hal berikut
spreadsheets.batchUpdate
contoh kode menunjukkan cara menggunakan
DeleteSheetRequest
untuk menghapus sheet yang ditentukan oleh SHEET_ID
.
Protokol permintaan ditampilkan di bawah ini.
POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID
:batchUpdate
{
"requests": [
{
"deleteSheet": {
"sheetId": SHEET_ID
}
}
]
}
Membaca data sheet
Hal berikut
Contoh kode spreadsheets.get
menunjukkan cara mendapatkan informasi properti sheet
dari spreadsheet, yang ditentukan oleh SHEET_ID
dan SPREADSHEET_ID
. Metode ini sering digunakan untuk menentukan
metadata lembar dalam {i>spreadsheet<i} tertentu, sehingga operasi tambahan dapat
menargetkan lembar
tersebut. Parameter kueri fields
hanya menentukan properti sheet
data harus ditampilkan (bukan data nilai sel atau data yang terkait dengan
seluruh {i>spreadsheet<i}).
GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID
?&fields=sheets.properties
Respons terdiri dari
Spreadsheet
, yang berisi
Objek Sheet
dengan
SheetProperties
yang kurang penting. Jika kolom respons yang diberikan ditetapkan ke nilai default, kolom tersebut akan dihilangkan
dari respons.
{
"sheets": [
{
"properties": {
"sheetId": SHEET_ID
,
"title": "Sheet1",
"index": 0,
"sheetType": "GRID",
"gridProperties": {
"rowCount": 100,
"columnCount": 20,
"frozenRowCount": 1
}
"tabColor": {
"blue": 1.0
}
},
...
],
}