Aggiungere proprietà di file personalizzate

Le proprietà file personalizzate sono coppie chiave-valore utilizzate per archiviare metadati personalizzati per un file di Google Drive (ad esempio i tag), ID di altri data store, informazioni condivise tra applicazioni di flusso di lavoro e così via. Ad esempio, puoi aggiungere proprietà file a tutti i documenti generati dal reparto vendite nel primo trimestre.

Per aggiungere proprietà visibili a tutte le applicazioni, utilizza il campo properties della risorsa files. Per aggiungere proprietà limitate alla tua app, utilizza il campo appProperties della risorsa files.

Le proprietà possono essere utilizzate anche nelle espressioni di ricerca.

Questa è la struttura di una proprietà tipica che potrebbe essere utilizzata per archiviare nel file l'ID database di un file di Drive.

API Drive v3

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

API Drive v2

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

Utilizzare le proprietà dei file personalizzate

La sezione spiega come eseguire alcune attività relative alle proprietà dei file personalizzate che interessano tutte le applicazioni.

Aggiungere o aggiornare le proprietà dei file personalizzate

Per aggiungere o aggiornare le proprietà visibili a tutte le applicazioni, utilizza il metodo files.update per impostare il properties campo della risorsa files.

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

Puoi anche aggiungere una proprietà personalizzata a un file utilizzando il servizio avanzato di Drive in Google Apps Script. Per ulteriori informazioni, consulta Aggiunta di proprietà personalizzate.

Recupera o elenca le proprietà dei file personalizzati

Per visualizzare le proprietà visibili a tutte le applicazioni, utilizza il metodo files.get per recuperare le proprietà del file personalizzate per il file.

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

La risposta è costituita da un oggetto properties che contiene una raccolta di coppie chiave-valore.

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

Eliminare le proprietà dei file personalizzate

Per eliminare i valori delle proprietà visibili a tutte le applicazioni, utilizza il metodo files.update per impostare il properties campo della risorsa files su null.

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

Per visualizzare la modifica, chiama il metodo files.get per recuperare l'oggetto properties per il file.

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

Limiti delle proprietà dei file personalizzate

Le proprietà personalizzate hanno i seguenti limiti:

  • Massimo 100 proprietà personalizzate per file, totalizzate da tutte le origini.
  • Massimo 30 proprietà pubbliche per file, totalizzate da tutte le origini.
  • Massimo 30 proprietà private per file da qualsiasi applicazione.
  • Massimo 124 byte per stringa di proprietà (incluse chiave e valore) in codifica UTF-8. Ad esempio, una proprietà con una chiave di 10 caratteri può avere solo 114 caratteri nel valore. Analogamente, una proprietà che richiede 100 caratteri per il valore può utilizzare fino a 24 caratteri per la chiave.

Per ulteriori informazioni, consulta la risorsa files. Per l'API Drive 2, consulta la risorsa properties.

Accedere a proprietà di file personalizzate private

Puoi recuperare le proprietà private utilizzando il campo appProperties solo tramite una richiesta autenticata che utilizza un token di accesso ottenuto con un ID client OAuth 2.0. Non puoi utilizzare una chiave API per recuperare proprietà private.