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 libellés peuvent contenir un ou plusieurs Fields.

Vous devez également spécifier les éléments suivants:

• Un LabelType.

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

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

Cet exemple crée une étiquette d'administrateur standard avec un titre spécifié et un SelectionOptions Field avec deux 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 UNPUBLISHED_DRAFT State. Il doit être PUBLISHED pour être utilisé sur les fichiers et visible par les utilisateurs. Pour en savoir plus, consultez la section Cycle de vie des libellés.

Limites des 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 étiquette : 10
• Libellés appliqués par l'utilisateur par fichier : 5

Utiliser des champs dans les libellés

Field Type	Actions possibles	Remarques sur le format et limites
SelectionOptions	Sélectionner une ou plusieurs options dans une liste	Nombre maximal d'options acceptées : 200 Nombre maximal de sélections pour un fichier : 10, comme configuré dans ListOptions
IntegerOptions	Saisir une valeur numérique	Seuls les nombres entiers sont acceptés.
DateOptions	Sélectionner une date de calendrier	(Facultatif) Vous pouvez définir Date format sur "Long: Mois JJ, AAAA" ou "Court: MM/JJ/AA".
TextOptions	Saisir du texte dans une zone de texte	Le nombre maximal de caractères est de 100.
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, comme configuré dans ListOptions.

Publier un libellé

L'API Labels vous permet de publier un brouillon de libellé une fois qu'il est terminé.

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

• Ressource de libellé représentant chaque libellé. Il contient une ressource Name et ID, qui est un identifiant unique global pour le libellé.

• useAdminAccess est true pour utiliser les identifiants administrateur de l'utilisateur. Le serveur vérifie que l'utilisateur est un administrateur disposant du droit "Gérer les libellés" 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 PUBLISHED State et son ID de révision est incrémenté. Le libellé est alors visible par les utilisateurs et peut être appliqué aux fichiers. Pour en savoir plus, consultez la section Cycle de vie des libellés.

Contraintes lors de la publication de libellés

• Une fois publié, un libellé ne peut plus revenir à son état de brouillon d'origine. Pour en savoir plus, consultez la section Cycle de vie des libellés.

• La publication d'une étiquette crée une nouvelle révision. Toutes les révisions précédentes de la version brouillon sont supprimées. Les versions 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 rejetée. Par exemple, les modifications suivantes apportées à une étiquette ne sont pas autorisées une fois l'étiquette publiée:

  • Le libellé est directement supprimé. (Il doit d'abord être désactivé, puis supprimé.)
  • Le Field.FieldType est modifié.
  • Les modifications apportées aux options de validation des champs rejettent un élément précédemment accepté.
  • Réduction du nombre maximal d'entrées.