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 create Methode für die labels Sammlung. Labels können optional ein oder mehrere Fields enthalten.

Außerdem müssen Sie Folgendes angeben:

• Ein LabelType.

• Einen Label-title über die property Methode.

• 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 im State UNPUBLISHED_DRAFT erstellt. Es muss PUBLISHED sein, damit es für Dateien verwendet werden kann und für Nutzer sichtbar ist. Weitere Informationen finden Sie unter Label lebenszyklus.

Label-Limits

Beim Erstellen und Anwenden von Labels gelten die folgenden Limits:

• Standardlabels: 150
• Felder pro Label: 10
• Von Nutzern angewendete Labels pro Datei: 5

In Labels mit Feldern arbeiten

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 Date format auf „Lang: Monat TT, JJJJ“ oder „Kurz: MM/TT/JJ“ festgelegt 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.

Label veröffentlichen

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

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

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

• 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 die 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, ändert sich der PUBLISHED State des Labels 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

• 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 nicht zulässig, nachdem das Label veröffentlicht wurde:

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