Label erstellen und veröffentlichen

In diesem Dokument wird beschrieben, wie Sie mit der Google Drive Labels API Labels erstellen und veröffentlichen.

Labels erstellen

Verwenden Sie zum Erstellen eines Labels die create Methode für die labels Ressource. Labels können optional ein oder mehrere Field Objekte enthalten.

Außerdem müssen Sie Folgendes angeben:

Das folgende Codebeispiel zeigt, wie Sie mit der create Methode ein Standard-Administratorlabel mit einem bestimmten Titel und einem SelectionOptions Field mit zwei Choice Objekten erstellen.

Python

label_body = {
    'labelType': 'ADMIN',
    'properties': {
        'title': 'TITLE'
    },
    'fields': [{
        'properties': {
            'displayName': 'DISPLAY_NAME'
        },
        'selectionOptions': {
            'listOptions': {},
            'choices': [{
                'properties': {
                    'displayName': 'CHOICE_1'
                }
            }, {
                'properties': {
                    'displayName': 'CHOICE_2'
                }
            }]
        }
    }]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

Node.js

var label = {
  'labelType': 'ADMIN',
  'properties': {
    'title': 'TITLE'
  },
  'fields': [{
    'properties': {
      'displayName': 'DISPLAY_NAME'
    },
    'selectionOptions': {
      'listOptions': {},
      'choices': [{
        'properties': {
          'displayName': 'CHOICE_1'
        }
      }, {
        'properties': {
          'displayName': 'CHOICE_2'
        }
      }]
    }
  }]
};

service.labels.create({
  requestBody: label,
  useAdminAccess: true
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

Ersetzen Sie Folgendes:

  • TITLE: Der Titel des Labels.
  • DISPLAY_NAME: Der Anzeigename des Feldes.
  • CHOICE_1: Die erste Auswahl im Feld SelectionOptions.
  • CHOICE_2: Die zweite Auswahl im SelectionOptions Feld.

Das Label wird im State UNPUBLISHED_DRAFT erstellt. Das Label muss PUBLISHED sein, damit es für Nutzer sichtbar ist und für Dateien verwendet werden kann. Weitere Informationen finden Sie unter Lebenszyklus von Labels.

Label-Limits

Beim Erstellen und Anwenden von Labels gelten die folgenden Limits:

  • Standard labels: 150
  • Felder pro Label: 10

Mit Feldern in Labels arbeiten

In der folgenden Tabelle werden die Feldtypen beschrieben, die Sie einem Label hinzufügen können, wie Nutzer mit ihnen interagieren und welche Formatüberlegungen und Limits gelten:

Field Type Optionen für Nutzer Hinweise zu Formaten und Beschränkungen
SelectionOptions Eine oder mehrere Optionen aus einer Liste auswählen Die maximale Anzahl der unterstützten Optionen beträgt 200
Die maximale Anzahl der Auswahlen für eine Datei beträgt 10, wie in ListOptions konfiguriert.
IntegerOptions Einen numerischen Wert eingeben Es werden nur ganze Zahlen unterstützt.
DateOptions Ein Kalenderdatum auswählen Optional kann DateFormat auf "Long: Month DD, YYYY" oder "Short: MM/DD/YY" gesetzt werden.
TextOptions Text in ein Textfeld eingeben Die maximale Anzahl der unterstützten Zeichen beträgt 100.
UserOptions Einen oder mehrere Nutzer aus den Google Workspace-Kontakten auswählen Die maximale Anzahl der Nutzereinträge für eine Datei beträgt 10, wie in ListOptions konfiguriert.

Labels veröffentlichen

Mit der Drive Labels API können Sie ein Label im Entwurfsstatus veröffentlichen, sobald es fertig ist. Das Label ist dann für Nutzer sichtbar und kann auf Dateien angewendet werden.

Verwenden Sie zum Veröffentlichen eines Labels die publish Methode für die labels Ressource und geben Sie Folgendes an:

Das folgende Codebeispiel zeigt, wie Sie die id des Labels verwenden, um das richtige Label zu identifizieren und zu veröffentlichen.

Python

service.labels().publish(
    name='labels/ID',
    body={
        'useAdminAccess': True
    }
).execute()

Node.js

service.labels.publish({
  name: 'labels/ID',
  requestBody: {
    useAdminAccess: true
  }
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

Ersetzen Sie ID durch die ID des zu veröffentlichenden Labels.

Sobald das Label veröffentlicht wurde, wird es in den PUBLISHED State verschoben und die Revisions-ID des Labels wird erhöht. Das Label ist dann für Nutzer sichtbar und kann auf Dateien angewendet werden. Weitere Informationen finden Sie unter Label lebenszyklus.

Einschränkungen beim Veröffentlichen von Labels

Beachten Sie beim Vorbereiten der Veröffentlichung von Labels die folgenden Einschränkungen:

  • Nach der Veröffentlichung kann ein Label nicht mehr in den ursprünglichen Entwurfsstatus zurückversetzt werden. Weitere Informationen finden Sie unter Lebenszyklus von Labels.

  • Beim Veröffentlichen eines Labels wird eine neue veröffentlichte Revision erstellt. Alle vorherigen Entwurfsrevisionen werden gelöscht. Zuvor veröffentlichte Revisionen bleiben erhalten, können aber bei Bedarf automatisch gelöscht werden.

  • Nach der Veröffentlichung sind einige Änderungen nicht mehr zulässig. Im Allgemeinen bedeutet dies, dass alle Änderungen abgelehnt werden, die vorhandene Metadaten im Zusammenhang mit dem Label ungültig machen oder neue Einschränkungen auslösen. Die folgenden Änderungen an einem Label sind beispielsweise nach der Veröffentlichung nicht zulässig:

    • Das Label wird direkt gelöscht. Es muss zuerst deaktiviert und dann gelöscht werden.
    • Der Field.FieldType wird geändert.
    • Durch Aktualisierungen der Validierungsoptionen für Field wird etwas abgelehnt, das zuvor akzeptiert wurde.
    • Eine Reduzierung der maximalen Anzahl von Einträgen.