Benutzerdefinierte Dateieigenschaften hinzufügen

Benutzerdefinierte Dateieigenschaften sind Schlüssel/Wert-Paare, mit denen benutzerdefinierte Metadaten für eine Google Drive-Datei (z. B. Tags), IDs aus anderen Datenspeichern, zwischen Workflowanwendungen geteilte Informationen usw. gespeichert werden. Beispielsweise können Sie Dateieigenschaften allen Dokumenten hinzufügen, die von der Vertriebsabteilung in Q1 generiert wurden.

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 Ihrer Anwendung eingeschränkte Attribute hinzuzufügen.

Attribute können auch in Suchausdrücken verwendet werden.

Dies ist die Struktur einer typischen Property, mit der 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 benutzerdefinierte Aufgaben im Zusammenhang mit 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, legen Sie mit der Methode files.update das Feld properties der Ressource files fest.

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
{
  "properties": {
    "name": "wrench",
    "mass": "1.3kg",
    "count": "3"
  }
}

Mit dem erweiterten Drive-Dienst in Google Apps Script können Sie einer Datei auch benutzerdefinierte Eigenschaften 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 ansehen 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, setzen Sie mit der Methode files.update das Feld properties der Ressource files 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 Objekt properties für die Datei abzurufen.

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

Einschränkungen von benutzerdefinierten Dateieigenschaften

Für benutzerdefinierte Eigenschaften gelten folgende Einschränkungen:

  • Maximal 100 benutzerdefinierte Eigenschaften pro Datei, insgesamt 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. Beispielsweise kann ein Attribut mit einem Schlüssel, der 10 Zeichen lang ist, nur 114 Zeichen im Wert enthalten. Ebenso kann ein Attribut, das 100 Zeichen für den Wert erfordert, bis zu 24 Zeichen für den Schlüssel verwenden.

Weitere Informationen finden Sie in der Ressource files. Informationen zur Drive API v2 finden Sie in der Ressource properties.

Auf Eigenschaften privater benutzerdefinierter Dateien zugreifen

Private Properties lassen sich mit dem Feld appProperties nur über eine authentifizierte Anfrage abrufen, die ein Zugriffstoken verwendet, das mit einer OAuth 2.0-Client-ID abgerufen wurde. Sie können keinen API-Schlüssel verwenden, um private Attribute abzurufen.