Benutzerdefinierte Dateieigenschaften sind Schlüssel/Wert-Paare, in denen benutzerdefinierte Metadaten für eine Google Drive-Datei (z. B. Tags), IDs aus anderen Datenspeichern, Informationen, die zwischen Workflowanwendungen geteilt werden, usw. gespeichert werden. Beispielsweise können Sie allen Dokumenten, die von der Vertriebsabteilung im 1. Quartal generiert wurden, Dateieigenschaften hinzufügen.
Verwenden Sie das Feld properties der Ressource files, um Attribute hinzuzufügen, die für alle Anwendungen sichtbar sind. Verwenden Sie das Feld appProperties der Ressource files, um auf Ihre Anwendung eingeschränkte Attribute hinzuzufügen.
Attribute können auch in Suchausdrücken verwendet werden.
Dies ist die Struktur eines typischen Attributs, mit dem die Datenbank-ID einer Drive-Datei in der Datei gespeichert 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 erläutert, wie Sie einige Aufgaben im Zusammenhang mit benutzerdefinierten Dateiattributen ausführen, die alle Anwendungen betreffen.
Benutzerdefinierte Dateieigenschaften hinzufügen oder aktualisieren
Wenn Sie Attribute hinzufügen oder aktualisieren möchten, die für alle Anwendungen sichtbar sind, verwenden Sie die Methode files.update, um das Feld properties der Ressource files 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 mit dem erweiterten Drive-Dienst in Google Apps Script eine benutzerdefinierte Eigenschaft hinzufügen. Weitere Informationen finden Sie unter Benutzerdefinierte Attribute hinzufügen.
Benutzerdefinierte Dateieigenschaften abrufen oder auflisten
Wenn Sie die für alle Anwendungen sichtbaren Attribute aufrufen möchten, verwenden Sie die Methode files.get, um die benutzerdefinierten Dateiattribute 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, verwenden Sie die Methode files.update, um das Feld properties der Ressource files auf null zu setzen.
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
{
"name": null
}
Wenn Sie sich die Änderung ansehen 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 von benutzerdefinierten Dateieigenschaften
Für benutzerdefinierte Eigenschaften gelten die folgenden Limits:
- Maximal 100 benutzerdefinierte Eigenschaften pro Datei aus allen Quellen.
- Maximal 30 öffentliche Properties pro Datei, insgesamt aus allen Quellen.
- Maximal 30 private Properties pro Datei aus einer Anwendung.
- Maximal 124 Byte pro Attributstring (einschließlich Schlüssel und Wert) in UTF-8-Codierung. Ein Attribut mit einem 10 Zeichen langen Schlüssel darf beispielsweise nur 114 Zeichen im Wert enthalten. Ebenso können bei einem Attribut, für das 100 Zeichen als Wert erforderlich sind, bis zu 24 Zeichen für den Schlüssel verwendet werden.
Weitere Informationen finden Sie unter der Ressource files. Informationen zu Drive API v2 finden Sie in der Ressource properties.
Auf private benutzerdefinierte Dateieigenschaften zugreifen
Private Properties können mit dem Feld appProperties nur über eine authentifizierte Anfrage abgerufen werden, die ein Zugriffstoken mit einer OAuth 2.0-Client-ID verwendet. Es ist nicht möglich, private Properties mit einem API-Schlüssel abzurufen.