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 zwischen Workflow-Anwendungen geteilt und so weiter. Sie können beispielsweise allen Dokumenten hinzugefügt, die von der Vertriebsabteilung im ersten Quartal generiert wurden.
Um Attribute hinzuzufügen, die für alle Anwendungen sichtbar sind, verwenden Sie das Feld properties der
Ressource files. So fügen Sie Eigenschaften hinzu:
auf Ihre Anwendung beschränkt ist, verwenden Sie das Feld appProperties der Ressource files.
Eigenschaften können auch in der Suche verwendet werden. Ausdrücke
Dies ist die Struktur einer typischen Property, die zum Speichern eines Datenbank-ID der Drive-Datei.
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 Dateieigenschaften ausführen, die wirken sich auf alle Anwendungen aus.
Benutzerdefinierte Dateieigenschaften hinzufügen oder aktualisieren
Um Eigenschaften hinzuzufügen oder zu aktualisieren, die für alle Anwendungen sichtbar sind, verwenden Sie die
files.update-Methode zum Festlegen des
Feld properties von files
.
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
{
"properties": {
"name": "wrench",
"mass": "1.3kg",
"count": "3"
}
}
Sie können einer Datei auch eine benutzerdefinierte Eigenschaft hinzufügen, indem Sie die erweiterten Drive-Dienst in Google Apps Script. Weitere Informationen finden Sie unter Benutzerdefiniertes Element hinzufügen Eigenschaften.
Benutzerdefinierte Dateieigenschaften abrufen oder auflisten
Um Eigenschaften anzuzeigen, die für alle Anwendungen sichtbar sind, verwenden Sie den
files.get-Methode zum Abrufen der
benutzerdefinierte Dateieigenschaften
für die Datei festlegen.
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-Paare.
{
"properties": {
"name": "wrench",
"mass": "1.3kg",
"count": "3"
}
}
Benutzerdefinierte Dateieigenschaften löschen
Um für alle Anwendungen sichtbare Attributwerte zu löschen, verwenden Sie die
files.update-Methode zum Festlegen des
Feld properties von files
Ressource auf null setzen.
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
{
"name": null
}
Rufen Sie zum Anzeigen der Änderung den
files.get-Methode zum Abrufen der
properties-Objekt für die Datei.
{
"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. Beispiel: Eine Property mit einem Schlüssel, der 10 Zeichen lang ist, darf nur 114 Zeichen enthalten. Eine Eigenschaft, die erfordert 100 Zeichen für den Wert und bis zu 24 Zeichen für den .
Weitere Informationen findest du in der files.
. Informationen zur Drive API Version 2 finden Sie in der
properties-Ressource.
Auf private benutzerdefinierte Dateieigenschaften zugreifen
Sie können private Eigenschaften nur mit dem Feld appProperties über
Eine authentifizierte Anfrage, die ein Zugriffstoken verwendet, das mit OAuth 2.0 abgerufen wurde
Client-ID. Es ist nicht möglich, private Properties mit einem API-Schlüssel abzurufen.