Menambahkan properti file kustom

Properti file kustom adalah pasangan nilai kunci yang digunakan untuk menyimpan metadata kustom untuk file Google Drive (seperti tag), ID dari penyimpanan data lain, informasi yang dibagikan antar-aplikasi alur kerja, dan sebagainya. Misalnya, Anda dapat menambahkan properti file ke semua dokumen yang dibuat oleh departemen penjualan pada Kuartal 1.

Untuk menambahkan properti yang terlihat oleh semua aplikasi, gunakan kolom properties dari resource files. Untuk menambahkan properti yang dibatasi ke aplikasi Anda, gunakan kolom appProperties dari resource files.

Properti juga dapat digunakan dalam ekspresi penelusuran.

Berikut adalah struktur properti umum yang dapat digunakan untuk menyimpan ID database file Drive pada file.

Drive API v3

"appProperties": {
  "additionalID": "ID",
}

Drive API v2

{
  'key':        'additionalID',
  'value':      'ID',
  'visibility': 'PRIVATE'
}

Bekerja dengan properti file kustom

Bagian ini menjelaskan cara melakukan beberapa tugas terkait properti file kustom yang memengaruhi semua aplikasi.

Menambahkan atau memperbarui properti file kustom

Untuk menambahkan atau memperbarui properti yang terlihat oleh semua aplikasi, gunakan metode files.update untuk menetapkan kolom properties dari resource files.

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
 
{
  "properties": {
    "name": "wrench",
    "mass": "1.3kg",
    "count": "3"
  }
}

Anda juga dapat menambahkan properti kustom ke file menggunakan layanan Drive lanjutan di Google Apps Script. Untuk mengetahui informasi selengkapnya, lihat Menambahkan properti kustom.

Mendapatkan atau mencantumkan properti file kustom

Untuk melihat properti yang terlihat oleh semua aplikasi, gunakan metode files.get untuk mengambil properti file kustom untuk file.

GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=properties

Respons terdiri dari objek properties yang berisi kumpulan key-value pair.

{
  "properties": {
    "name": "wrench",
    "mass": "1.3kg",
    "count": "3"
  }
}

Menghapus properti file kustom

Untuk menghapus nilai properti yang terlihat oleh semua aplikasi, gunakan metode files.update untuk menetapkan kolom properties dari resource files ke null.

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
 
{
  "name": null
}

Untuk melihat perubahan, panggil metode files.get untuk mengambil objek properties untuk file.

{
  "properties": {
    "mass": "1.3kg",
    "count": "3"
  }
}

Batas properti file kustom

Properti kustom memiliki batas berikut:

  • Maksimum 100 properti kustom per file, yang dihitung dari semua sumber.
  • Maksimum 30 properti publik per file, yang dihitung dari semua sumber.
  • Maksimum 30 properti pribadi per file dari satu aplikasi.
  • Maksimum 124 byte per string properti (termasuk kunci dan nilai) dalam encoding UTF-8. Misalnya, properti dengan kunci yang panjangnya 10 karakter hanya dapat memiliki 114 karakter dalam nilai. Demikian pula, properti yang memerlukan 100 karakter untuk nilainya dapat menggunakan hingga 24 karakter untuk kuncinya.

Untuk mengetahui informasi selengkapnya, lihat files resource. Untuk Drive API v2, lihat resource properties.

Mengakses properti file kustom pribadi

Anda hanya dapat mengambil properti pribadi menggunakan kolom appProperties melalui permintaan terautentikasi yang menggunakan token akses yang diperoleh dengan ID klien OAuth 2.0. Anda tidak dapat menggunakan kunci API untuk mengambil properti pribadi.