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

Außerdem müssen Sie Folgendes angeben:

  • Ein LabelType.

  • Ein Label title bis zum property-Methode.

  • useAdminAccess ist true, um die Administratoranmeldedaten des Nutzers zu verwenden. Die über die Option „Labels verwalten“ bestätigen, dass der Nutzer ein Administrator ist Privileg bevor du den Zugriff erlaubst.

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

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 erstellt. State Muss PUBLISHED sein für die Verwendung in Dateien und für Nutzer sichtbar sein. Weitere Informationen finden Sie unter Label hinzufügen. 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 Die maximale Anzahl der unterstützten Optionen beträgt 200
Gemäß der Konfiguration in ListOptions können für eine Datei maximal 10 ausgewählte Elemente 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 das publish und geben Sie Folgendes an:

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

  • useAdminAccess ist true, um die Administratoranmeldedaten des Nutzers zu verwenden. Die über die Option „Labels verwalten“ bestätigen, dass der Nutzer ein Administrator ist Privileg bevor du den Zugriff erlaubst.

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 den PUBLISHED verschoben State und die Überarbeitung des Labels Die ID wird erhöht. Das Label ist dann für Nutzer sichtbar und kann auf -Dateien. Weitere Informationen finden Sie unter Label hinzufügen. 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 Weitere Informationen finden Sie unter Labellebenszyklus.

  • Wenn Sie ein Label veröffentlichen, wird eine neu veröffentlichte Version erstellt. Vorheriger Entwurf Überarbeitungen gelöscht. Bereits veröffentlichte Überarbeitungen werden beibehalten, werden bei Bedarf automatisch gelöscht.

  • Nach der Veröffentlichung sind einige Änderungen nicht mehr zulässig. Im Allgemeinen bedeutet dies, alle Änderungen, die bestehende Einschränkungen ungültig machen oder neue mit dem Label verbundene Metadaten abgelehnt werden. Beispiel: Änderungen an einem Label sind nach der Veröffentlichung des Labels nicht zulässig:

    • Das Label wird direkt gelöscht. (Es muss zuerst deaktiviert werden, dann deleted.)
    • Field.FieldType wurde geändert.
    • Aktualisierungen an den Optionen zur Feldvalidierung lehnen vorhergehende Ergebnisse ab akzeptiert.
    • Eine Reduzierung der maximalen Anzahl von Einträgen.