Aggiungere proprietà di file personalizzate

Le proprietà di file personalizzate sono coppie chiave/valore utilizzate per archiviare metadati personalizzati per un file di Google Drive (ad esempio i tag), ID di altri datastore, informazioni condivise tra le applicazioni del flusso di lavoro e così via. Ad esempio, puoi aggiungere 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à limitato alla tua app, usa il campo appProperties della risorsa files.

Le proprietà possono essere utilizzate anche nella ricerca espressioni.

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

API Drive v3

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

API Drive v2

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

Utilizzo delle proprietà di file personalizzate

Questa sezione spiega come eseguire alcune attività relative alle proprietà dei file personalizzati 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 la files.update per impostare il metodo Campo properties di files risorsa.

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 le opzioni avanzate Servizio Drive in Google Apps Script. Per ulteriori informazioni, vedi Aggiunta di segmenti di pubblico proprietà.

Ottieni o elenca proprietà di file personalizzate

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

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

La risposta è composta da un oggetto properties che contiene un insieme di coppie chiave-valore.

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

Elimina proprietà file personalizzate

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

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

Limiti delle proprietà dei file personalizzate

Le proprietà personalizzate hanno i seguenti limiti:

  • È consentito un massimo di 100 proprietà personalizzate per file, con un totale di tutte le origini.
  • È consentito un massimo di 30 proprietà pubbliche per file, con un totale di tutte le origini.
  • Un massimo di 30 proprietà private per file da qualsiasi applicazione.
  • Massimo 124 byte per stringa di proprietà (inclusi chiave e valore) in Codifica UTF-8. Ad esempio, una proprietà con una chiave di 10 caratteri. può contenere solo 114 caratteri. Analogamente, una proprietà richiede 100 caratteri per il valore può utilizzare fino a 24 caratteri per chiave.

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

Accedi alle proprietà dei file personalizzate private

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