Label erstellen und veröffentlichen

Auf dieser Seite wird beschrieben, wie Sie ein Label erstellen und veröffentlichen.

Label erstellen

Verwenden Sie zum Erstellen eines Labels die Methode create in der Sammlung labels. Labels können optional ein oder mehrere Fields enthalten.

Außerdem müssen Sie Folgendes angeben:

• Ein LabelType.

• Ein title-Label über die Methode property.

• useAdminAccess ist true, um die Administratoranmeldedaten des Nutzers zu verwenden. Der Server überprüft, ob der Nutzer ein Administrator mit der Berechtigung „Labels verwalten“ ist, bevor er Zugriff zulässt.

In diesem Beispiel wird ein Standard-Administratorlabel mit einem angegebenen Titel und ein SelectionOptions Field mit 2 Choices erstellt.

Python

label_body = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
        'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
        'list_options': {},
        'choices': [{
            'properties': {
                'display_name': 'CHOICE_1'
            }
        }, {
            'properties': {
                'display_name': 'CHOICE_2'
            }
        }]
    }
}]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

Node.js

var label = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
    'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
    'list_options': {},
    'choices': [{
        'properties': {
        'display_name': 'CHOICE_1'
        }
    }, {
        'properties': {
        'display_name': 'CHOICE_2'
        }
    }]
    }
}]
};

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

Das Label wird in UNPUBLISHED_DRAFT State erstellt. Sie muss auf PUBLISHED gesetzt sein, damit sie für Dateien verwendet werden kann und für Nutzer sichtbar ist. Weitere Informationen finden Sie unter Label-Lebenszyklus.

Label limits

Für das Erstellen und Anwenden von Labels gelten die folgenden Limits:

• Standardlabels: 150
• Felder pro Label: 10
• Vom Nutzer angewendete Labels pro Datei: 5

Mit Feldern in Labels arbeiten

Field Type	Optionen für Nutzer	Hinweise zu Formaten und Beschränkungen
SelectionOptions	Eine oder mehrere Optionen aus einer Liste auswählen	Es werden maximal 200 Optionen unterstützt. Wie in ListOptions konfiguriert, können maximal 10 Optionen für eine Datei ausgewählt werden.
IntegerOptions	Geben Sie einen numerischen Wert ein	Es sind nur ganze Zahlen zulässig
DateOptions	Kalenderdatum auswählen	Optional: Date format kann auf „Long: Month DD, YYYY“ oder „Short: MM/DD/JJ“ festgelegt werden.
TextOptions	Text in ein Textfeld eingeben	Es sind maximal 100 Zeichen zulässig
UserOptions	Wählen Sie mindestens einen Nutzer aus den Google Workspace-Kontakten aus.	Gemäß der Konfiguration in ListOptions können in einer Datei maximal 10 Nutzereinträge vorhanden sein

Label veröffentlichen

Mit der Labels API können Sie einen fertigen Labelentwurf veröffentlichen.

Verwenden Sie zum Veröffentlichen eines Labels die Methode publish und geben Sie Folgendes an:

• Eine Labelressource, die jedes Label darstellt. Es enthält die Ressourcen Name und ID, eine global eindeutige Kennzeichnung für das Label.

• useAdminAccess ist true, um die Administratoranmeldedaten des Nutzers zu verwenden. Der Server überprüft, ob der Nutzer ein Administrator mit der Berechtigung „Labels verwalten“ ist, bevor er Zugriff zulässt.

In diesem Beispiel wird ID verwendet, um das richtige Label zu identifizieren und zu veröffentlichen.

Python

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

Node.js

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

Nach der Veröffentlichung des Labels wird es in den PUBLISHED State verschoben und die Überarbeitungs-ID des Labels wird erhöht. Das Label ist dann für Nutzer sichtbar und kann auf die Dateien angewendet werden. Weitere Informationen finden Sie unter Label-Lebenszyklus.

Einschränkungen beim Veröffentlichen von Labels

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

• Wenn Sie ein Label veröffentlichen, wird eine neu veröffentlichte Version erstellt. Alle vorherigen Überarbeitungen werden gelöscht. Zuvor veröffentlichte Überarbeitungen werden beibehalten, 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 jede Änderung abgelehnt wird, durch die vorhandene Metadaten, die sich auf das Label beziehen, ungültig gemacht oder neue Einschränkungen ausgelöst werden. So sind beispielsweise die folgenden Änderungen an einem Label nicht mehr zulässig, nachdem das Label veröffentlicht wurde:

  • Das Label wird direkt gelöscht. (Sie muss zuerst deaktiviert und dann gelöscht werden.)
  • Field.FieldType wurde geändert.
  • Bei Aktualisierungen der Feldvalidierungsoptionen werden zuvor akzeptierte Werte abgelehnt.
  • Eine Reduzierung der maximalen Anzahl von Einträgen.