Benutzerdefinierte Dateieigenschaften hinzufügen

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

Verwenden Sie das properties Feld der files Ressource, um Eigenschaften hinzuzufügen, die für alle Anwendungen sichtbar sind. Verwenden Sie das Feld appProperties der Ressource files, um Eigenschaften hinzuzufügen, die auf Ihre App beschränkt sind.

Eigenschaften können auch in Such ausdrücken verwendet werden.

Dies ist die Struktur einer typischen Eigenschaft, mit der die Datenbank-ID einer Drive-Datei in der Datei gespeichert werden kann.

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

{
  '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 sich auf alle Anwendungen auswirken.

Benutzerdefinierte Dateieigenschaften hinzufügen oder aktualisieren

Verwenden Sie die files.update Methode, um das properties Feld der files Ressource festzulegen, wenn Sie Eigenschaften hinzufügen oder aktualisieren möchten, die für alle Anwendungen sichtbar sind.

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

Verwenden Sie die files.get Methode, um die benutzerdefinierten Dateieigenschaften für die Datei abzurufen, wenn Sie Eigenschaften aufrufen möchten, die für alle Anwendungen sichtbar sind.

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

Verwenden Sie die files.update Methode, um das properties Feld der files Ressource auf null zu setzen, wenn Sie Eigenschaftswerte löschen möchten, die für alle Anwendungen sichtbar sind.

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID

{
  "name": null
}

Rufen Sie die files.get Methode auf, um das properties Objekt für die Datei abzurufen und die Änderung zu sehen.

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

Einschränkungen für benutzerdefinierte Dateieigenschaften

Für benutzerdefinierte Eigenschaften gelten die folgenden Einschränkungen:

• Maximal 100 benutzerdefinierte Eigenschaften pro Datei, insgesamt aus allen Quellen.
• Maximal 30 öffentliche Eigenschaften pro Datei, insgesamt aus allen Quellen.
• Maximal 30 private Eigenschaften pro Datei aus einer Anwendung.
• Maximal 124 Byte pro Eigenschaftsstring (einschließlich Schlüssel und Wert) in UTF-8-Codierung. Eine Eigenschaft mit einem 10 Zeichen langen Schlüssel kann beispielsweise nur 114 Zeichen im Wert haben. Ebenso kann eine Eigenschaft, die 100 Zeichen für den Wert benötigt, bis zu 24 Zeichen für den Schlüssel verwenden.

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

Auf private benutzerdefinierte Dateieigenschaften zugreifen

Sie können private Eigenschaften nur über das Feld appProperties mit einer authentifizierten 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 Eigenschaften abzurufen.