Label erstellen und veröffentlichen

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

Labels erstellen

Verwenden Sie zum Erstellen eines Labels die Methode create für die Sammlung labels. Labels können optional ein 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 zulässt.

In diesem Beispiel wird ein Standard-Administratorlabel mit einem angegebenen Titel und einem SelectionOptions Field mit zwei 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 der UNPUBLISHED_DRAFT State erstellt. Sie muss PUBLISHED für die Verwendung in Dateien und für Nutzer sichtbar sein. Weitere Informationen finden Sie unter Label-Lebenszyklus.

Label-Beschränkungen

Beim Erstellen und Anwenden von Labels gelten die folgenden Limits:

• Standardlabels – 150
• Felder pro Label: 10
• Von Nutzern 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 sind maximal 200 Optionen zulässig. Für ein Feld können maximal 10 Optionen ausgewählt werden, wie in ListOptions konfiguriert.
IntegerOptions	Numerischen Wert eingeben	Es können nur ganze Zahlen eingegeben werden.
DateOptions	Kalenderdatum auswählen	Optional: Date format kann auf „Lang: Monat TT, JJJJ“ oder „Kurz: MM/TT/JJ“ eingestellt werden.
TextOptions	Text in einem Textfeld eingeben	Es können maximal 100 Zeichen eingegeben werden.
UserOptions	Wählen Sie einen oder mehrere Nutzer aus den Google Workspace-Kontakten aus.	Die maximale Anzahl von Nutzereinträgen für eine Datei beträgt 10, wie in ListOptions konfiguriert.

Label veröffentlichen

Mit der Labels API können Sie ein Label veröffentlichen, sobald es fertig ist.

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

• Eine Label-Ressource, die jedes Label darstellt. Sie enthält eine Ressource Name und ID, eine global eindeutige Kennung für das Label.

• 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 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);
});

Sobald das Label veröffentlicht wurde, wird es in 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

• Sobald ein Label veröffentlicht wurde, kann es nicht mehr in den ursprünglichen Entwurfszustand zurückversetzt werden. Weitere Informationen finden Sie unter Label-Lebenszyklus.

• Wenn Sie ein Label veröffentlichen, wird eine neu veröffentlichte Version erstellt. Alle vorherigen Entwurfsversionen 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 das, dass jede Änderung abgelehnt wird, die vorhandene Metadaten im Zusammenhang mit dem Label ungültig macht oder neue Einschränkungen auslöst. Die folgenden Änderungen an einem Label sind beispielsweise nach der Veröffentlichung des Labels nicht zulässig:

  • Das Label wird direkt gelöscht. Sie muss zuerst deaktiviert und dann gelöscht werden.
  • Die Field.FieldType hat sich geändert.
  • Durch Änderungen an den Optionen zur Feldvalidierung wird etwas abgelehnt, das zuvor akzeptiert wurde.
  • Die maximale Anzahl der Einträge wird reduziert.