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 einen oder mehrere Fields enthalten.

Außerdem müssen Sie Folgendes angeben:

• Ein LabelType.

• Ein Label title über die Methode property.

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

In diesem Beispiel wird ein Standard-Administratorlabel mit einem angegebenen Titel und ein SelectionOptions Field-Label 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 im UNPUBLISHED_DRAFT State erstellt. Er muss PUBLISHED sein, damit er mit 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	Wählen Sie eine oder mehrere Optionen aus einer Liste aus	Es werden maximal 200 Optionen unterstützt. Für eine Datei können maximal 10 Optionen ausgewählt werden, wie in ListOptions konfiguriert
IntegerOptions	Numerischen Wert eingeben	Es werden nur ganze Zahlen unterstützt
DateOptions	Kalenderdatum auswählen	Optional: Date format kann auf „Lang: Monat TT, JJJJ“ oder „Kurz: MM/TT/JJ“ festgelegt werden
TextOptions	Text in ein Textfeld eingeben	Es werden maximal 100 Zeichen unterstützt
UserOptions	Wählen Sie einen oder mehrere Nutzer aus den Google Workspace-Kontakten aus.	Für eine Datei sind gemäß der Konfiguration in ListOptions maximal 10 Nutzereinträge zulässig

Labels veröffentlichen

Mit der Labels API können Sie einen Entwurfslabel veröffentlichen, sobald er abgeschlossen ist.

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, die eine global eindeutige Kennzeichnung für das Label darstellen.

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

In diesem Beispiel wird das ID verwendet, um das richtige Label zu ermitteln 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);
});

Sobald das Label veröffentlicht ist, wird es in das PUBLISHED-State verschoben und die Überarbeitungs-ID des Labels 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

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

• Beim Veröffentlichen eines Labels wird eine neu veröffentlichte Überarbeitung erstellt. Alle vorherigen Überarbeitungen werden gelöscht. Zuvor veröffentlichte Überarbeitungen werden zwar beibehalten, werden aber bei Bedarf automatisch gelöscht.

• Nach der Veröffentlichung sind einige Änderungen nicht mehr zulässig. Im Allgemeinen bedeutet dies, dass jede Änderung, die vorhandene Metadaten im Zusammenhang mit dem Label ungültig macht oder neue Einschränkungen auslöst, abgelehnt wird. Beispielsweise sind die folgenden Änderungen an einem Label nach seiner Veröffentlichung nicht zulässig:

  • Das Label wird direkt gelöscht. Sie muss zuerst deaktiviert und dann gelöscht werden.
  • Field.FieldType wird geändert.
  • Bei Updates der Optionen für die Feldvalidierung werden zuvor akzeptierte Elemente abgelehnt.
  • Eine Reduzierung der maximalen Anzahl von Einträgen.