Dokumen ini menjelaskan cara membuat dan mengelola spreadsheet di Google Spreadsheet menggunakan Google Sheets API.
Membuat spreadsheet
Untuk membuat file di Spreadsheet, gunakan metode
create pada resource
spreadsheets tanpa parameter.
Saat Anda membuat file, metode ini akan menampilkan resource spreadsheets. Resource yang ditampilkan berisi spreadsheetId, properties, daftar sheets, dan spreadsheetUrl.
Contoh kode berikut menunjukkan cara membuat spreadsheet kosong dengan judul tertentu.
Apps Script
Java
JavaScript
Node.js
PHP
Python
Ruby
Mengatur spreadsheet di folder Google Drive
Secara default, spreadsheet yang dibuat akan disimpan ke folder root pengguna di Google Drive.
Jika Anda ingin menyimpan spreadsheet ke folder Drive tertentu, gunakan metode berikut:
Setelah file spreadsheet dibuat, pindahkan ke folder tertentu menggunakan metode
updatepadafilesresource Google Drive API. Untuk mengetahui informasi selengkapnya, lihat Memindahkan file antar- folder.Tambahkan spreadsheet kosong ke folder menggunakan metode
createpada resourcefilesDrive API, dengan menentukanapplication/vnd.google-apps.spreadsheetsebagaimimeType. Untuk mengetahui informasi selengkapnya tentang cara membuat file, lihat Membuat file di folder tertentu. Untuk mengetahui informasi selengkapnya tentang jenis MIME, lihat Jenis MIME yang didukung Google Workspace dan Google Drive.
Untuk salah satu alternatif, Anda harus menambahkan cakupan Drive API yang sesuai untuk mengotorisasi panggilan.
Jika aplikasi Anda menggunakan Akun Layanan, Akun Layanan tersebut akan memiliki spreadsheet yang dibuat. File ini kemudian berada di penyimpanan Drive khusus Akun Layanan. File tidak akan muncul dalam akun penyimpanan Drive lainnya kecuali jika dibagikan secara eksplisit. Untuk mengetahui informasi selengkapnya, lihat Kepemilikan file.
Untuk memindahkan atau membuat file dalam folder drive bersama, lihat Menerapkan dukungan drive bersama.
Untuk mempelajari lebih lanjut batas sel dan baris di Google Spreadsheet, lihat File yang dapat Anda simpan di Google Drive.
Mendapatkan spreadsheet
Untuk mendapatkan spreadsheet, gunakan metode
get pada resource
spreadsheets dengan parameter jalur spreadsheetId.
Metode ini menampilkan file sebagai instance resource spreadsheets. Secara default, data dalam spreadsheet tidak ditampilkan. Resource yang ditampilkan berisi struktur dan metadata spreadsheet, termasuk properti spreadsheet (seperti judul, lokalitas, dan zona waktu) serta beberapa informasi sheet mendetail (seperti pemformatan dan rentang yang dilindungi).
Untuk menyertakan data dalam resource spreadsheets, gunakan dua metode berikut:
Tentukan mask kolom yang mencantumkan kolom yang dipilih dengan menetapkan
fieldsparameter sistem.Tetapkan parameter kueri boolean
includeGridDataketrue. Jika mask kolom ditetapkan, parameterincludeGridDataakan diabaikan.
Saat Anda menggunakan spreadsheet besar, sebaiknya buat kueri hanya untuk kolom spreadsheet tertentu yang Anda butuhkan. Metode get menampilkan semua data yang terkait dengan spreadsheet, sehingga kueri umum untuk spreadsheet besar dapat berjalan lambat. Misalnya, untuk membaca angka 100 dari sel, spreadsheets.get akan menampilkan nilai sel beserta metadata (seperti nama font, ukuran, dll.) sehingga menghasilkan payload JSON besar yang lambat diuraikan. Sebagai perbandingan, panggilan serupa ke values.get hanya menampilkan nilai sel tertentu sehingga menghasilkan respons yang jauh lebih ringan dan cepat.
Untuk mengetahui informasi selengkapnya tentang resource spreadsheets.values, termasuk
spreadsheets.values.get
dan
spreadsheets.values.batchGet,
lihat dokumen berikut:
Mencantumkan spreadsheet
Sheets API tidak menawarkan metode untuk mencantumkan spreadsheet bagi pengguna yang diautentikasi.
Untuk mengambil daftar spreadsheet, Anda dapat menggunakan metode
list Drive API pada resource
files, dengan menentukan
application/vnd.google-apps.spreadsheet sebagai
mimeType:
HTTP
GET https://www.googleapis.com/drive/v3/files?q=mimeType='application/vnd.google-apps.spreadsheet'
cURL
curl -X GET "https://www.googleapis.com/drive/v3/files?q=mimeType='application/vnd.google-apps.spreadsheet'" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Accept: application/json"
Ganti ACCESS_TOKEN dengan token akses yang memberikan akses ke API.
Penggunaan metode files.list untuk mencantumkan spreadsheet pengguna memerlukan cakupan Drive API yang
dibatasi.
Topik terkait
Berikut beberapa langkah yang dapat Anda coba:
Untuk memperbarui spreadsheet, lihat Memperbarui spreadsheet.
Untuk menggunakan smart chip, lihat Smart chips.
Untuk menggunakan metadata developer, lihat Membaca, menulis, dan menelusuri metadata.