Menggunakan mask kolom

Mask kolom adalah cara bagi pemanggil API untuk mencantumkan kolom yang harus ditampilkan atau diperbarui oleh permintaan. Dengan menggunakan FieldMask, API dapat menghindari pekerjaan yang tidak perlu dan meningkatkan performa. Mask kolom digunakan untuk metode baca dan update di Google Spreadsheet API.

Membaca dengan mask kolom

Spreadsheet dapat berukuran besar, dan sering kali Anda tidak memerlukan setiap bagian dari resource Spreadsheet yang ditampilkan oleh permintaan baca. Anda dapat membatasi apa yang ditampilkan dalam respons Sheets API, menggunakan parameter URL fields. Untuk mendapatkan performa terbaik, secara eksplisit cantumkan hanya kolom yang Anda butuhkan dalam balasan.

Format parameter kolom sama dengan encoding JSON FieldMask. Intinya, beberapa kolom berbeda dipisahkan dengan tanda koma, dan sub-kolom dipisah dengan tanda titik. Nama kolom dapat ditentukan dalam camelCase atau separated_by_underscores. Agar praktis, beberapa sub-kolom dari jenis yang sama dapat dicantumkan dalam tanda kurung.

Contoh permintaan spreadsheets.get berikut menggunakan mask kolom sheets.properties(sheetId,title,sheetType,gridProperties) untuk hanya mengambil ID sheet, judul, SheetType, dan GridProperties objek SheetProperties di semua sheet dalam spreadsheet:

GET https://sheets.googleapis.com/v4/spreadsheets/spreadsheetId?fields=sheets.properties(sheetId,title,sheetType,gridProperties)

Respons terhadap panggilan metode ini adalah objek Spreadsheet yang berisi komponen yang diminta di mask kolom. Perhatikan bahwa sheetType=OBJECT tidak berisi gridProperties:

{
  "sheets": [
    {
      "properties": {
        "sheetId": SHEET_ID,
        "title": "TITLE",
        "sheetType": "GRID",
        "gridProperties": {
          "rowCount": 1000,
          "columnCount": 25
        }
      }
    },
    {
      "properties": {
        "sheetId": SHEET_ID,
        "title": "TITLE",
        "sheetType": "OBJECT"
      }
    }
  ]
}

Memperbarui dengan mask kolom

Terkadang, Anda hanya perlu mengupdate kolom tertentu dalam objek sambil mempertahankan kolom lainnya. Permintaan pembaruan di dalam operasi spreadsheets.batchUpdate menggunakan mask kolom untuk memberi tahu API kolom mana yang diubah. Permintaan update mengabaikan kolom apa pun yang tidak ditentukan dalam mask kolom, sehingga nilai saat ini tidak berubah.

Anda juga dapat membatalkan setelan kolom dengan tidak menetapkannya di pesan yang diupdate, tetapi menambahkan kolom ke mask. Tindakan ini akan menghapus nilai apa pun yang sebelumnya ada di kolom.

Sintaksis untuk mask kolom update sama dengan mask kolom baca.

Mask kolom * diperlakukan seperti karakter pengganti dan merupakan singkatan untuk menentukan setiap kolom dalam pesan. Sintaksis karakter pengganti dapat menghasilkan hasil yang tidak diinginkan jika API diupdate pada masa mendatang, karena kolom hanya baca dan kolom yang baru ditambahkan dapat menyebabkan error. Untuk aplikasi produksi, selalu cantumkan kolom tertentu yang sedang diperbarui di mask kolom dan hindari penggunaan karakter pengganti *.

Contoh berikut menggunakan AddSheetRequest untuk menambahkan sheet baru berjenis Grid, membekukan baris pertama, dan mewarnai tab sheet baru menjadi merah:

POST https://sheets.googleapis.com/v1/spreadsheets/spreadsheetId:batchUpdate

{
  "spreadsheetId": "SPREADSHEET_ID",
  "replies": [
    {
      "addSheet": {
        "properties": {
          "sheetId": SHEET_ID,
          "title": "TITLE",
          "index": 6,
          "sheetType": "GRID",
          "gridProperties": {
            "rowCount": 1000,
            "columnCount": 26,
            "frozenRowCount": 1
          },
          "tabColor": {
            "red": 0.003921569
          },
          "tabColorStyle": {
            "rgbColor": {
              "red": 0.003921569
            }
          }
        }
      }
    }
  ]
}