新增自訂檔案屬性

自訂檔案屬性是一種鍵/值組合，用來儲存自訂檔案的自訂中繼資料。 Google 雲端硬碟檔案 (例如標記)、其他資料儲存庫的 ID、資訊 以此類推。例如，您可以新增 屬性加入銷售部門在第 1 季產生的所有文件。

如要新增所有應用程式都能看見的屬性，請使用properties files 資源。如何新增資源 僅限您的應用程式，請使用 files 資源的 appProperties 欄位。

屬性也可用於搜尋 運算式。

這是一般屬性的結構，可能用來儲存 雲端硬碟檔案的資料庫 ID。

Drive API 第 3 版

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

Drive API 第 2 版

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

使用自訂檔案屬性

本節會說明如何執行幾項自訂檔案屬性相關工作， 會影響所有應用程式

新增或更新自訂檔案屬性

如要新增或更新所有應用程式都能看見的屬性，請使用 files.update 方法來設定 files 的 properties 欄位 資源。

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

您也可以使用進階選項，在檔案中加入自訂屬性 Google Apps Script 中的雲端硬碟服務。若需更多資訊，請參閲 新增自訂項目 資源

取得或列出自訂檔案屬性

如要查看所有應用程式都能查看的屬性，請使用 files.get 方法，以便擷取 自訂檔案屬性。

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

回應由 properties 物件組成，該物件包含集合 鍵/值組合

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

刪除自訂檔案屬性

如要刪除所有應用程式可見的屬性值，請使用 files.update 方法來設定 files 的 properties 欄位 設為空值

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

如要查看變更，請呼叫 files.get 方法，以便擷取 properties 物件。

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

自訂檔案屬性的限制

自訂屬性有以下限制：

  • 每個檔案最多可加入 100 個自訂屬性，所有來源加起來。
  • 每個檔案最多 30 個公開屬性 (從所有來源加總)。
  • 任何單一應用程式中的個別檔案最多可以有 30 個私有屬性。
  • 每個屬性字串 (包括鍵和值) 最多 124 個位元組： 使用 UTF-8 編碼。例如，某個屬性的鍵長度為 10 個字元 值最多只能有 114 個字元。同樣地，如果資源會 的參數值最多為 100 個字元， 鍵。

詳情請參閱 files 資源。如果是 Drive API v2，請參閱 properties 資源。

存取私人自訂檔案屬性

您只能透過以下方式使用 appProperties 欄位擷取不公開屬性： 使用透過 OAuth 2.0 取得的存取權杖的已驗證要求 用戶端 ID。您無法使用 API 金鑰擷取不公開屬性。