Aggiungere proprietà di file personalizzate

Le proprietà dei file personalizzate sono coppie chiave-valore utilizzate per archiviare metadati personalizzati per un file Google Drive (ad esempio tag), ID di altri archivi di dati, informazioni condivise tra le applicazioni del flusso di lavoro e così via. Ad esempio, puoi aggiungere proprietà ai 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 l'ID database di un file di Drive nel file.

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

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

Utilizzare le proprietà di file personalizzate

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

Aggiungere o aggiornare proprietà di file personalizzate

Per aggiungere o aggiornare le proprietà visibili a tutte le applicazioni, utilizza il metodo files.update per impostare il campo properties 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 Drive avanzato in Google Apps Script. Per ulteriori informazioni, vedi Aggiungere proprietà personalizzate.

Visualizzare o elencare le proprietà di file personalizzate

Per visualizzare le proprietà visibili a tutte le applicazioni, utilizza il metodo files.get per recuperare le proprietà personalizzate del 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à di file personalizzate

Per eliminare i valori delle proprietà visibili a tutte le applicazioni, utilizza il metodo files.update per impostare il campo properties 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à di file personalizzate

Le proprietà personalizzate presentano i seguenti limiti:

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

Per saperne di più, consulta la risorsa files. Per l'API Drive v2, consulta la risorsa properties.

Accedere alle proprietà di file personalizzate private

Puoi recuperare le proprietà private solo utilizzando il campo appProperties 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.