Benutzerdefinierte Dateieigenschaften sind Schlüssel/Wert-Paare, mit denen benutzerdefinierte Metadaten für eine Google Drive-Datei (z. B. Tags), IDs aus anderen Datenspeichern, Informationen, die zwischen Workflow-Anwendungen geteilt werden, usw. gespeichert werden. So können Sie beispielsweise allen Dokumenten, die im 1. Quartal von der Vertriebsabteilung erstellt wurden, Dateieigenschaften hinzufügen.
Wenn Sie allen Anwendungen sichtbare Properties hinzufügen möchten, verwenden Sie das Feld properties der Ressource files. Wenn Sie auf Ihre App beschränkte Properties hinzufügen möchten, verwenden Sie das Feld appProperties der Ressource files.
Properties können auch in Suchausdrücken verwendet werden.
Das ist die Struktur einer typischen Property, die zum Speichern der Datenbank-ID einer Drive-Datei in der Datei verwendet werden kann.
Drive API Version 3
"appProperties": {
"additionalID": "ID",
}
Drive API Version 2
{
'key': 'additionalID',
'value': 'ID',
'visibility': 'PRIVATE'
}
Mit benutzerdefinierten Dateieigenschaften arbeiten
In diesem Abschnitt wird beschrieben, wie Sie einige Aufgaben im Zusammenhang mit benutzerdefinierten Dateieigenschaften ausführen, die sich auf alle Anwendungen auswirken.
Benutzerdefinierte Dateieigenschaften hinzufügen oder aktualisieren
Wenn Sie für alle Anwendungen sichtbare Properties hinzufügen oder aktualisieren möchten, verwenden Sie die Methode files.update, um das Feld properties der files-Ressource festzulegen.
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
{
"properties": {
"name": "wrench",
"mass": "1.3kg",
"count": "3"
}
}
Sie können einer Datei auch mithilfe des erweiterten Drive-Dienstes in Google Apps Script eine benutzerdefinierte Eigenschaft hinzufügen. Weitere Informationen finden Sie unter Benutzerdefinierte Properties hinzufügen.
Benutzerdefinierte Dateieigenschaften abrufen oder auflisten
Wenn Sie sich Eigenschaften ansehen möchten, die für alle Anwendungen sichtbar sind, verwenden Sie die Methode files.get, um die benutzerdefinierten Dateieigenschaften für die Datei abzurufen.
GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=properties
Die Antwort besteht aus einem properties-Objekt, das eine Sammlung von Schlüssel/Wert-Paaren enthält.
{
"properties": {
"name": "wrench",
"mass": "1.3kg",
"count": "3"
}
}
Benutzerdefinierte Dateieigenschaften löschen
Wenn Sie Attributwerte löschen möchten, die für alle Anwendungen sichtbar sind, setzen Sie mit der Methode files.update das Feld properties der files-Ressource auf null.
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
{
"name": null
}
Wenn Sie die Änderung sehen möchten, rufen Sie die Methode files.get auf, um das properties-Objekt für die Datei abzurufen.
{
"properties": {
"mass": "1.3kg",
"count": "3"
}
}
Einschränkungen bei benutzerdefinierten Dateieigenschaften
Für benutzerdefinierte Properties gelten die folgenden Einschränkungen:
- Maximal 100 benutzerdefinierte Properties pro Datei, Summe aller Quellen.
- Maximal 30 öffentliche Properties pro Datei, zusammengerechnet aus allen Quellen.
- Maximal 30 private Properties pro Datei aus einer einzelnen Anwendung.
- Maximal 124 Byte pro Property-String (einschließlich Schlüssel und Wert) in UTF-8-Codierung. Der Wert einer Property mit einem 10-stelligen Schlüssel kann beispielsweise nur 114 Zeichen lang sein. Für eine Property, für die 100 Zeichen für den Wert erforderlich sind, können bis zu 24 Zeichen für den Schlüssel verwendet werden.
Weitere Informationen finden Sie in der Ressource files. Informationen zur Drive API v2 finden Sie in der Ressource properties.
Auf private benutzerdefinierte Dateieigenschaften zugreifen
Sie können private Properties nur über das Feld appProperties über eine authentifizierte Anfrage abrufen, die ein Zugriffstoken verwendet, das mit einer OAuth 2.0-Client-ID abgerufen wurde. Sie können keine privaten Unterkünfte mit einem API-Schlüssel abrufen.