Benutzerdefinierte Dateieigenschaften hinzufügen

Benutzerdefinierte Dateieigenschaften sind Schlüssel/Wert-Paare, mit denen benutzerdefinierte Metadaten für eine Google Drive-Datei gespeichert werden, z. B. Tags, IDs aus anderen Datenspeichern oder Informationen, die zwischen Workflowanwendungen geteilt werden. So können Sie beispielsweise allen Dokumenten, die im ersten Quartal von der Vertriebsabteilung erstellt wurden, Dateieigenschaften hinzufügen.

Wenn Sie Eigenschaften hinzufügen möchten, die für alle Anwendungen sichtbar sind, verwenden Sie das Feld properties der Ressource files. Wenn Sie Eigenschaften hinzufügen möchten, die auf Ihre App beschränkt sind, verwenden Sie das Feld appProperties der Ressource files.

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

Dies ist die Struktur einer typischen Property, die zum Speichern der Datenbank-ID einer Drive-Datei in der Datei verwendet werden kann.

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

{
  '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 Eigenschaften 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 eine benutzerdefinierte Eigenschaft hinzufügen, indem Sie den erweiterten Drive-Dienst in Google Apps Script verwenden. Weitere Informationen finden Sie unter Benutzerdefinierte Eigenschaften hinzufügen.

Benutzerdefinierte Dateieigenschaften abrufen oder auflisten

Wenn Sie Eigenschaften aufrufen 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 Eigenschaftswerte 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
}

Rufen Sie zum Ansehen der Änderung die Methode files.get auf, um das properties-Objekt für die Datei abzurufen.

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

Einschränkungen für benutzerdefinierte Dateieigenschaften

Für benutzerdefinierte Eigenschaften gelten die folgenden Limits:

• Maximal 100 benutzerdefinierte Properties pro Datei, insgesamt aus allen Quellen.
• Maximal 30 öffentliche Properties pro Datei, insgesamt aus allen Quellen.
• Maximal 30 private Properties pro Datei aus einer beliebigen Anwendung.
• Maximal 124 Byte pro Eigenschaftsstring (einschließlich Schlüssel und Wert) in UTF‑8-Codierung. Ein Attribut mit einem Schlüssel, der 10 Zeichen lang ist, kann beispielsweise nur einen Wert mit 114 Zeichen haben. Entsprechend kann für den Schlüssel eines Attributs, dessen Wert 100 Zeichen erfordert, eine Länge von bis zu 24 Zeichen 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 mit einer authentifizierten Anfrage abrufen, für die ein Zugriffstoken verwendet wird, das mit einer OAuth 2.0-Client-ID abgerufen wurde. Sie können keinen API-Schlüssel verwenden, um private Properties abzurufen.