Créer et publier un libellé

Cette page explique comment créer et publier un libellé.

Créer un libellé

Pour créer un libellé, utilisez la méthode create sur la collection labels. Les étiquettes peuvent éventuellement contenir un ou plusieurs Fields.

Vous devez également spécifier les informations suivantes:

• Un LabelType.

• Un libellé title via la méthode property.

• useAdminAccess est true pour utiliser les identifiants d'administrateur de l'utilisateur. Le serveur vérifie que l'utilisateur est un administrateur disposant du droit "Gérer les étiquettes" avant d'autoriser l'accès.

Cet exemple crée un libellé administrateur standard avec un titre spécifié et un libellé SelectionOptions Field avec 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);
});

Le libellé est créé dans le UNPUBLISHED_DRAFT State. Il doit être PUBLISHED pour être utilisé sur les fichiers et être visible par les utilisateurs. Pour en savoir plus, consultez la section Cycle de vie des étiquettes.

Limites du nombre de libellés

Les limites suivantes s'appliquent lors de la création et de l'application de libellés:

• Libellés standards : 150
• Champs par libellé : 10
• Libellés appliqués par l'utilisateur par fichier : 5

Utiliser les champs dans les libellés

Field Type	Actions possibles	Considérations et limites concernant le format
SelectionOptions	Sélectionnez une ou plusieurs options dans une liste	Le nombre maximal d'options acceptées est de 200 Le nombre maximal de sélections pour un fichier est de 10, tel que configuré dans ListOptions
IntegerOptions	Saisissez une valeur numérique	Seuls les nombres entiers sont acceptés
DateOptions	Sélectionner une date dans le calendrier	(Facultatif) Date format peut être défini sur "Long: Mois JJ, AAAA" ou "Court: MM/JJ/AA".
TextOptions	Saisissez du texte dans une zone de texte	Vous ne pouvez pas dépasser 100 caractères.
UserOptions	Sélectionnez un ou plusieurs utilisateurs dans les contacts Google Workspace.	Le nombre maximal d'entrées utilisateur pour un fichier est de 10, tel que configuré dans ListOptions.

Publier un libellé

L'API Étiquettes vous permet de publier un brouillon de libellé une fois celui-ci terminé.

Pour publier un libellé, utilisez la méthode publish et spécifiez:

• Une ressource d'étiquette qui représente chaque étiquette. Il contient une ressource Name et ID, qui est l'identifiant unique du libellé.

• useAdminAccess est true pour utiliser les identifiants d'administrateur de l'utilisateur. Le serveur vérifie que l'utilisateur est un administrateur disposant du droit "Gérer les étiquettes" avant d'autoriser l'accès.

Cet exemple utilise ID pour identifier et publier le libellé approprié.

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

Une fois le libellé publié, il est déplacé vers le PUBLISHED State, et l'ID de révision du libellé est incrémenté. Le libellé est ensuite visible par les utilisateurs et peut être appliqué aux fichiers. Pour en savoir plus, consultez la section Cycle de vie des étiquettes.

Contraintes lors de la publication d'étiquettes

• Une fois le libellé publié, son état de brouillon d'origine ne peut pas être rétabli. Pour en savoir plus, consultez la section Cycle de vie des étiquettes.

• La publication d'un libellé entraîne la création d'une révision. Toutes les révisions du brouillon précédentes sont supprimées. Les révisions précédemment publiées sont conservées, mais peuvent être supprimées automatiquement si nécessaire.

• Une fois publiées, certaines modifications ne sont plus autorisées. En règle générale, cela signifie que toute modification qui invalide ou déclenche de nouvelles restrictions sur les métadonnées existantes associées au libellé est refusée. Par exemple, les modifications suivantes apportées à un libellé ne sont pas autorisées après la publication de celui-ci:

  • Le libellé est directement supprimé. (Vous devez d'abord la désactiver, puis la supprimer.)
  • Field.FieldType a été modifié.
  • Les mises à jour des options de validation des champs rejettent des éléments précédemment acceptés.
  • Une réduction du nombre maximal d'entrées.