REST Resource: labels

{
  "name": string,
  "id": string,
  "revisionId": string,
  "labelType": enum (LabelType),
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "revisionCreator": {
    object (UserInfo)
  },
  "revisionCreateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "publishTime": string,
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "customer": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedLabelPolicy": {
    object (AppliedLabelPolicy)
  },
  "fields": [
    {
      object (Field)
    }
  ],
  "learnMoreUri": string,
  "lockStatus": {
    object (LockStatus)
  }
}

string

Uniquement en sortie. Nom de ressource du libellé. Se présente sous la forme suivante: labels/{id} ou labels/{id}@{revisionId}, selon la requête. Voir id et revisionId ci-dessous.

string

Uniquement en sortie. Identifiant global unique de ce libellé. L'ID constitue une partie du libellé name, mais contrairement à name, il est cohérent entre les révisions. Correspond à l'expression régulière: ([a-zA-Z0-9])+

string

Uniquement en sortie. ID de révision du libellé. L'ID de révision peut faire partie du libellé name en fonction de la demande émise. Une révision est créée chaque fois que les propriétés révisées d'un libellé sont modifiées. Correspond à l'expression régulière: ([a-zA-Z0-9])+

enum (LabelType)

Obligatoire. Type de libellé.

object (UserInfo)

Uniquement en sortie. Utilisateur ayant créé ce libellé.

string (Timestamp format)

Uniquement en sortie. Heure de création de ce libellé.

object (UserInfo)

Uniquement en sortie. Utilisateur qui a créé cette révision de libellé.

string (Timestamp format)

Uniquement en sortie. Heure de création de la révision du libellé.

object (UserInfo)

Uniquement en sortie. Utilisateur ayant publié ce libellé. Cette valeur n'a aucune signification lorsque le libellé n'est pas publié.

string (Timestamp format)

Uniquement en sortie. Heure de publication de ce libellé. Cette valeur n'a aucune signification lorsque le libellé n'est pas publié.

object (UserInfo)

Uniquement en sortie. Utilisateur qui a désactivé ce libellé. Cette valeur n'a aucune signification lorsque le libellé n'est pas désactivé.

string (Timestamp format)

Uniquement en sortie. Heure à laquelle ce libellé a été désactivé. Cette valeur n'a aucune signification lorsque le libellé n'est pas désactivé.

string

Uniquement en sortie. Client auquel appartient ce libellé. Par exemple: "customers/123abc789".

object (Properties)

Obligatoire. Propriétés de base du libellé.

object (Lifecycle)

Uniquement en sortie. État du cycle de vie du libellé, y compris s'il est publié, s'il est obsolète et si des modifications ont été apportées au brouillon.

object (DisplayHints)

Uniquement en sortie. Affichage de suggestions dans l'interface utilisateur pour l'affichage du libellé.

object (AppliedCapabilities)

Uniquement en sortie. Fonctionnalités associées à ce libellé pour les métadonnées appliquées.

object (SchemaCapabilities)

Uniquement en sortie. Capacités de l'utilisateur pour ce libellé.

object (AppliedLabelPolicy)

Uniquement en sortie. Comportement de ce libellé lorsqu'il est appliqué à des éléments Drive.

object (Field)

Liste des champs par ordre de priorité décroissant.

string

URL personnalisée à présenter aux utilisateurs pour leur permettre d'en savoir plus sur ce libellé et son utilisation.

object (LockStatus)

Uniquement en sortie. État verrouillé de ce libellé.

{
  "person": string
}

string

Identifiant de cet utilisateur, qui peut être utilisé avec l'API People pour obtenir plus d'informations. Par exemple, people/12345678.

{
  "title": string,
  "description": string
}

string

Obligatoire. Titre du libellé.

string

Description du libellé.

{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}

enum (State)

Uniquement en sortie. État de l'objet associé à ce cycle de vie.

boolean

Uniquement en sortie. Indique si l'objet associé à ce cycle de vie comporte des modifications non publiées.

object (DisabledPolicy)

Règle qui régit l'affichage d'un libellé, d'un champ ou d'une sélection de sélection désactivés.

{
  "hideInSearch": boolean,
  "showInApply": boolean
}

boolean

Indique si cet objet désactivé doit être masqué dans le menu de recherche des éléments Drive.

• Lorsqu'elle est définie sur false, l'objet est généralement affiché dans l'interface utilisateur comme désactivé, mais il apparaît dans les résultats de recherche lorsque vous recherchez des éléments Drive.
• Si la valeur est true, l'objet est généralement masqué dans l'interface utilisateur lors de la recherche d'éléments Drive.

boolean

Indique si cet objet désactivé doit être affiché dans le menu "Appliquer" des éléments Drive.

• Lorsque la valeur est true, l'objet est généralement affiché dans l'interface utilisateur comme désactivé et ne peut pas être sélectionné.
• Lorsqu'elle est définie sur false, l'objet est généralement masqué dans l'interface utilisateur.

{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}

boolean

Indique si le libellé doit être désactivé dans l'interface utilisateur.

boolean

Ce libellé doit être masqué dans le menu de recherche lorsque vous recherchez des éléments Drive.

boolean

Ce libellé doit s'afficher dans le menu "Appliquer" lorsque vous appliquez des valeurs à un élément Drive.

string (int64 format)

Ordre d'affichage du libellé dans une liste.

{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}

boolean

Indique si l'utilisateur peut lire les métadonnées appliquées associées à ce libellé.

boolean

Indique si l'utilisateur peut appliquer ce libellé aux éléments.

boolean

Indique si l'utilisateur peut supprimer ce libellé des éléments.

{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}

boolean

Indique si l'utilisateur peut modifier ce libellé.

boolean

Indique si l'utilisateur peut supprimer ce libellé. L'utilisateur doit disposer de l'autorisation requise et le libellé doit être désactivé.

boolean

Indique si l'utilisateur peut désactiver ce libellé. L'utilisateur doit disposer d'une autorisation et ce libellé ne doit pas déjà être désactivé.

boolean

Indique si l'utilisateur peut activer ce libellé. L'utilisateur doit disposer de l'autorisation, et ce libellé doit être désactivé.

{
  "copyMode": enum (CopyMode)
}

enum (CopyMode)

Indique comment le libellé et les valeurs de champ appliqués doivent être copiés lorsqu'un élément Drive est copié.

{
  "id": string,
  "queryKey": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "updater": {
    object (UserInfo)
  },
  "updateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "lockStatus": {
    object (LockStatus)
  },

  // Union field type can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type.
}

string

Uniquement en sortie. Clé d'un champ, unique au sein d'un libellé ou d'une bibliothèque.

Cette valeur est générée automatiquement. Correspond à l'expression régulière: ([a-zA-Z0-9])+

string

Uniquement en sortie. Clé à utiliser lors de la création de requêtes de recherche Drive pour trouver des fichiers en fonction des valeurs définies pour ce champ dans les fichiers. Par exemple, "{queryKey} > 2001-01-01".

object (Properties)

Propriétés de base du champ.

object (Lifecycle)

Uniquement en sortie. Cycle de vie de ce champ.

object (DisplayHints)

Uniquement en sortie. Conseils pour afficher un champ dans l'interface utilisateur

object (SchemaCapabilities)

Uniquement en sortie. Les droits dont dispose l'utilisateur lorsqu'il modifie ce champ.

object (AppliedCapabilities)

Uniquement en sortie. Capacités de l'utilisateur sur ce champ et sa valeur lorsque le libellé est appliqué à des éléments Drive.

object (UserInfo)

Uniquement en sortie. Utilisateur qui a créé ce champ.

string (Timestamp format)

Uniquement en sortie. Heure de création de ce champ.

object (UserInfo)

Uniquement en sortie. Utilisateur qui a modifié ce champ.

string (Timestamp format)

Uniquement en sortie. Heure de mise à jour de ce champ.

object (UserInfo)

Uniquement en sortie. Utilisateur ayant publié ce champ. Cette valeur n'a aucune signification si le champ n'est pas publié.

object (UserInfo)

Uniquement en sortie. Utilisateur ayant désactivé ce champ. Cette valeur n'a aucune signification lorsque le champ n'est pas désactivé.

string (Timestamp format)

Uniquement en sortie. Heure à laquelle ce champ a été désactivé. Cette valeur n'a aucune signification lorsque le champ n'est pas désactivé.

object (LockStatus)

Uniquement en sortie. LockStatus de ce champ.

object (TextOptions)

Options des champs de texte.

object (IntegerOptions)

Options de champ de nombre entier.

object (DateOptions)

Options du champ de date.

object (SelectionOptions)

Options du champ de sélection.

object (UserOptions)

Options du champ utilisateur.

{
  "minLength": integer,
  "maxLength": integer
}

integer

Uniquement en sortie. Longueur minimale valide des valeurs pour le champ de texte.

integer

Uniquement en sortie. Longueur maximale valide des valeurs pour le champ de texte.

{
  "minValue": string,
  "maxValue": string
}

string (int64 format)

Uniquement en sortie. Valeur minimale valide pour le champ de nombre entier.

string (int64 format)

Uniquement en sortie. Valeur maximale valide pour le champ de nombre entier.

{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}

enum (DateFormat)

Option de mise en forme des dates localisées. Les valeurs des champs sont affichées dans ce format en fonction de leurs paramètres régionaux.

string

Uniquement en sortie. Format de date ICU.

object (Date)

Uniquement en sortie. Valeur minimale valide (année, mois, jour).

object (Date)

Uniquement en sortie. Valeur valide maximale (année, mois, jour).

{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}

object (ListOptions)

Si spécifié, indique que ce champ accepte une liste de valeurs. Une fois le champ publié, vous ne pouvez plus le modifier.

object (Choice)

Options disponibles pour ce champ de sélection. L'ordre de la liste est cohérent et modifié avec insertBeforeChoice.

{
  "maxEntries": integer
}

integer

Nombre maximal d'entrées autorisé.

{
  "id": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "updater": {
    object (UserInfo)
  },
  "updateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "publishTime": string,
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "lockStatus": {
    object (LockStatus)
  }
}

string

Valeur unique du choix. Cet ID est généré automatiquement. Correspond à l'expression régulière: ([a-zA-Z0-9_])+.

object (Properties)

Propriétés de base du choix.

object (Lifecycle)

Uniquement en sortie. Cycle de vie du choix.

object (DisplayHints)

Uniquement en sortie. Affichage de suggestions dans l'interface utilisateur pour le rendu d'un choix.

object (SchemaCapabilities)

Uniquement en sortie. Les fonctionnalités associées à cette option lorsque vous la modifiez.

object (AppliedCapabilities)

Uniquement en sortie. Fonctionnalités associées à ce choix pour les métadonnées appliquées.

object (UserInfo)

Uniquement en sortie. Utilisateur qui a créé ce choix.

string (Timestamp format)

Uniquement en sortie. Heure de création de ce choix.

object (UserInfo)

Uniquement en sortie. L'utilisateur qui a modifié ce choix en dernier.

string (Timestamp format)

Uniquement en sortie. Heure de la dernière mise à jour de ce choix.

object (UserInfo)

Uniquement en sortie. Utilisateur ayant publié ce choix. Cette valeur n'a aucune signification si le choix n'est pas publié.

string (Timestamp format)

Uniquement en sortie. Heure de publication de ce choix. Cette valeur n'a aucune signification si le choix n'est pas publié.

object (UserInfo)

Uniquement en sortie. Utilisateur ayant désactivé ce choix. Cette valeur n'a aucune signification si l'option n'est pas désactivée.

string (Timestamp format)

Uniquement en sortie. Heure à laquelle ce choix a été désactivé. Cette valeur n'a aucune signification si cette option n'est pas désactivée.

object (LockStatus)

Uniquement en sortie. État de verrouillage de ce choix.

{
  "displayName": string,
  "description": string,
  "badgeConfig": {
    object (BadgeConfig)
  },
  "insertBeforeChoice": string
}

string

Obligatoire. Texte à afficher dans l'interface utilisateur permettant d'identifier ce champ.

string

Description de ce libellé.

object (BadgeConfig)

Configuration du badge pour ce choix. Lorsque cette option est définie, la maison de disques associée à ce choix est considérée comme un "libellé avec badge".

string

Uniquement en entrée. Insérez ou déplacez ce choix avant le choix indiqué. S'il est vide, l'option est placée à la fin de la liste.

{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}

object (Color)

Couleur du badge Si aucune valeur n'est spécifiée, aucun badge n'est affiché. Les couleurs d'arrière-plan, de premier plan et seule (mode clair et sombre) définies ici sont remplacées par la couleur compatible recommandée la plus proche dans l'interface utilisateur Drive.

string (int64 format)

Remplace la priorité globale par défaut de ce badge. Lorsque ce paramètre est défini sur 0, l'heuristique de priorité par défaut est utilisée.

{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}

boolean

Indique si l'option doit être désactivée dans l'interface utilisateur.

boolean

Cette option doit être masquée dans le menu de recherche lorsque vous recherchez des éléments Drive.

boolean

Cette option doit s'afficher dans le menu "Appliquer" lorsque vous appliquez des valeurs à un élément Drive.

object (BadgeColors)

Couleurs à utiliser pour le badge. Remplacement des couleurs de Material par Google en fonction des properties.badge_config.color choisis.

object (BadgeColors)

Couleur du mode sombre à utiliser pour le badge. Remplacement des couleurs de Material par Google en fonction des properties.badge_config.color choisis.

string (int64 format)

Priorité de ce badge. Utilisé pour comparer et trier plusieurs badges. Plus le nombre est faible, plus le badge doit s'afficher. Si aucune configuration de badge n'est présente, la valeur est 0. Sinon, il sera défini sur BadgeConfig.priority_override ou sur l'heuristique par défaut qui privilégie la date de création du libellé, ainsi que la priorité du champ et de l'option.

{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}

object (Color)

Uniquement en sortie. Arrière-plan du badge associé au premier plan.

object (Color)

Uniquement en sortie. Badge avec un premier plan associé à l'arrière-plan.

object (Color)

Uniquement en sortie. Couleur pouvant être utilisée pour le texte sans arrière-plan.

{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}

boolean

Indique si l'utilisateur peut modifier ce choix.

boolean

Indique si l'utilisateur peut supprimer cette sélection.

boolean

Indique si l'utilisateur peut désactiver ce choix.

boolean

Indique si l'utilisateur peut activer ce choix.

{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}

boolean

Indique si l'utilisateur peut lire les métadonnées appliquées associées aux éléments.

boolean

Indique si l'utilisateur peut utiliser ce choix dans les requêtes de recherche.

boolean

Indique si l'utilisateur peut sélectionner cette option pour un élément.

{
  "locked": boolean
}

boolean

Uniquement en sortie. Indique si ce composant de libellé est la cible (directe) d'un LabelLock. Un composant d'étiquette peut être verrouillé implicitement, même s'il n'est pas la cible directe d'un élément LabelLock. Dans ce cas, ce champ est défini sur "false".

{
  "listOptions": {
    object (ListOptions)
  }
}

object (ListOptions)

Si spécifié, indique que ce champ accepte une liste de valeurs. Une fois le champ publié, vous ne pouvez plus le modifier.

{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}

string

Obligatoire. Texte à afficher dans l'interface utilisateur permettant d'identifier ce champ.

boolean

Indique si le champ doit être marqué comme obligatoire.

string

Uniquement en entrée. Insérez ou déplacez ce champ avant le champ indiqué. S'il est vide, le champ est placé à la fin de la liste.

{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}

boolean

Indique si le champ doit être affiché comme requis dans l'interface utilisateur.

boolean

Indique si le champ doit être désactivé dans l'interface utilisateur.

boolean

Ce champ doit être masqué dans le menu de recherche lorsque vous recherchez des éléments Drive.

boolean

Ce champ doit être affiché dans le menu "Appliquer" lorsque vous appliquez des valeurs à un élément Drive.

{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}

boolean

Indique si l'utilisateur peut modifier ce champ.

boolean

Indique si l'utilisateur peut supprimer ce champ. L'utilisateur doit disposer d'une autorisation, et ce champ doit être obsolète.

boolean

Indique si l'utilisateur peut désactiver ce champ. L'utilisateur doit disposer d'une autorisation, et ce champ ne doit pas déjà être désactivé.

boolean

Indique si l'utilisateur peut activer ce champ. L'utilisateur doit disposer de l'autorisation, et ce champ doit être désactivé.

{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}

boolean

Indique si l'utilisateur peut lire les métadonnées appliquées associées aux éléments.

boolean

Indique si l'utilisateur peut rechercher des éléments Drive faisant référence à ce champ.

boolean

Indique si l'utilisateur peut définir ce champ dans des éléments Drive.