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 dibagikan di antara aplikasi alur kerja, dan seterusnya. Misalnya, Anda dapat menambahkan properti ke semua dokumen yang dibuat oleh departemen penjualan pada Q1.

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

Properti juga dapat digunakan di penelusuran ekspresi.

Ini adalah struktur properti umum yang mungkin digunakan untuk menyimpan ID database file Drive pada file.

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

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

Bekerja dengan properti file kustom

Bagian ini menjelaskan cara melakukan beberapa tugas terkait properti {i>file<i} khusus 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 kolom files resource Anda

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID

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

Anda juga dapat menambahkan properti khusus ke file menggunakan Layanan Drive di Google Apps Script. Untuk informasi selengkapnya, lihat Menambahkan khusus properti.

Mendapatkan atau membuat daftar properti file kustom

Untuk melihat properti yang terlihat oleh semua aplikasi, gunakan Metode files.get untuk mengambil properti file khusus untuk file tersebut.

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

Respons terdiri dari objek properties yang berisi kumpulan pasangan nilai kunci.

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

Menghapus properti file kustom

Untuk menghapus nilai properti yang dapat dilihat oleh semua aplikasi, gunakan Metode files.update untuk menetapkan Kolom properties dari kolom files resource ke null.

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID

{
  "name": null
}

Untuk melihat perubahan, panggil metode 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 khusus per file, dijumlahkan dari semua sumber.
• Maksimum 30 properti publik per file, yang dijumlahkan dari semua sumber.
• Maksimum 30 properti pribadi per file dari satu aplikasi.
• Maksimum 124 byte per string properti (termasuk kunci dan nilai) di Encoding UTF-8. Misalnya, properti dengan kunci yang memiliki 10 karakter hanya dapat memiliki 114 karakter. Demikian pula, properti yang memerlukan 100 karakter agar nilai dapat menggunakan hingga 24 karakter untuk tombol.

Untuk informasi selengkapnya, lihat files. resource Anda Untuk Drive API v2, lihat Referensi 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 OAuth 2.0 dengan ID klien. Anda tidak dapat menggunakan kunci API untuk mengambil properti pribadi.