Label

Un libellé.

Représentation JSON
{
  "resourceName": string,
  "status": enum (LabelStatus),
  "textLabel": {
    object (TextLabel)
  },
  "id": string,
  "name": string
}
Champs
resourceName

string

Immuable. Nom de la ressource. Les noms de ressources de libellé sont au format suivant: customers/{customerId}/labels/{label_id}.

status

enum (LabelStatus)

Uniquement en sortie. État du libellé. Lecture seule.

textLabel

object (TextLabel)

Type de libellé affichant du texte sur un arrière-plan de couleur.

id

string (int64 format)

Uniquement en sortie. ID du libellé. Lecture seule.

name

string

Nom du libellé.

Ce champ est obligatoire. Il ne doit pas être vide lors de la création d'un libellé.

La longueur de cette chaîne doit être comprise entre 1 et 80, inclus.

LabelStatus

États possibles d'une étiquette.

Enums
UNSPECIFIED Non spécifié.
UNKNOWN Utilisé uniquement pour la valeur renvoyée. Représente la valeur inconnue dans cette version.
ENABLED Le libellé est activé.
REMOVED Le libellé est supprimé.

TextLabel

Type de libellé affichant du texte sur un arrière-plan de couleur.

Représentation JSON
{
  "backgroundColor": string,
  "description": string
}
Champs
backgroundColor

string

Couleur d'arrière-plan du libellé au format hexadécimal. Cette chaîne doit correspondre à l'expression régulière '^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Remarque: La couleur d'arrière-plan peut ne pas être visible pour les comptes administrateur.

description

string

Brève description du libellé. La longueur de l'élément ne doit pas dépasser 200 caractères.