Google Sheets API memungkinkan Anda membuat, menghapus, menyalin, dan menghapus sheet, serta mengontrol propertinya. Contoh pada halaman ini mengilustrasikan cara melakukan beberapa operasi Spreadsheet umum dengan Sheets API.
Contoh-contoh ini disajikan dalam bentuk permintaan HTTP dengan bahasa yang netral. Untuk mempelajari cara menerapkan update batch dalam berbagai bahasa menggunakan library klien Google API, lihat Mengupdate spreadsheet.
Dalam contoh ini, placeholder SPREADSHEET_ID dan SHEET_ID
menunjukkan tempat Anda akan memberikan ID tersebut. Anda dapat menemukan ID spreadsheet di URL spreadsheet. Anda bisa mendapatkan
ID sheet menggunakan
metode spreadsheets.get. Rentang ditentukan menggunakan notasi A1. Contoh
rentang adalah Sheet1!A1:D5.
Menambahkan sheet
Contoh kode
spreadsheets.batchUpdate
berikut menunjukkan cara menggunakan
AddSheetRequest
untuk menambahkan sheet ke spreadsheet, sekaligus menetapkan judul, ukuran petak, dan
warna tab.
Responsnya terdiri dari
AddSheetResponse,
yang berisi objek dengan properti sheet yang dibuat (seperti
SHEET_ID-nya).
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
}
}
}
}
]
}
Mengosongkan sheet dari semua nilai dengan mempertahankan formatnya
Contoh kode
spreadsheets.batchUpdate
berikut menunjukkan cara menggunakan
UpdateCellsRequest
untuk menghapus semua nilai dari sheet tanpa mengubah formatnya.
Menentukan kolom
userEnteredValue
tanpa nilai yang sesuai akan ditafsirkan sebagai petunjuk untuk menghapus nilai
dalam rentang. Setelan ini juga dapat digunakan dengan kolom lainnya. Misalnya,
mengubah nilai fields menjadi
userEnteredFormat akan menghapus
semua format yang didukung oleh Sheets API
dari sheet, tetapi membiarkan nilai sel tidak berubah.
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 spreadsheet ke spreadsheet lain
Contoh kode
spreadsheet.sheets.copyTo
berikut menunjukkan cara menyalin satu sheet yang ditentukan oleh SHEET_ID
dari satu spreadsheet ke spreadsheet lain.
Variabel TARGET_SPREADSHEET_ID dalam isi permintaan menentukan
spreadsheet tujuan. Salinan ini mempertahankan semua nilai, format, formula, dan
properti asli lainnya. Judul sheet yang disalin ditetapkan ke "Copy
of [judul sheet asli]".
Respons terdiri dari objek SheetProperties 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
Contoh kode
spreadsheets.batchUpdate
berikut 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
Contoh kode
spreadsheets.get berikut
menunjukkan cara mendapatkan informasi properti sheet
dari spreadsheet, yang ditentukan oleh SHEET_ID
dan SPREADSHEET_ID. Metode ini sering digunakan untuk menentukan metadata sheet dalam spreadsheet tertentu, sehingga operasi tambahan dapat menargetkan sheet tersebut. Parameter kueri fields menentukan bahwa hanya data properti sheet yang akan ditampilkan (bukan data nilai sel atau data yang terkait dengan seluruh spreadsheet).
GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID?&fields=sheets.properties
Respons terdiri dari resource
Spreadsheet, yang berisi objek
Sheet dengan elemen
SheetProperties. Jika kolom respons tertentu 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
}
},
...
],
}