- Ressource: Libellé
- LabelType
- UserInfo
- Propriétés
- Cycle de vie
- État
- DisabledPolicy
- DisplayHints
- AppliedCapabilities
- SchemaCapabilities
- AppliedLabelPolicy
- CopyMode
- Champ
- TextOptions
- IntegerOptions
- DateOptions
- DateFormat
- SelectionOptions
- ListOptions
- Choix
- Propriétés
- BadgeConfig
- DisplayHints
- BadgeColors
- SchemaCapabilities
- AppliedCapabilities
- LockStatus
- UserOptions
- Propriétés
- DisplayHints
- SchemaCapabilities
- AppliedCapabilities
- Méthodes
Ressource: Libellé
Un libellé définit une taxonomie qui peut être appliquée aux éléments Drive pour organiser et rechercher des éléments. Les libellés peuvent être de simples chaînes ou contenir des champs décrivant des métadonnées supplémentaires qui permettent d'organiser et de rechercher des éléments Drive.
Représentation JSON |
---|
{ "name": string, "id": string, "revisionId": string, "labelType": enum ( |
Champs | |
---|---|
name |
Uniquement en sortie. Nom de ressource du libellé. Se présente sous la forme suivante: |
id |
Uniquement en sortie. Identifiant global unique de ce libellé. L'ID constitue une partie du libellé |
revisionId |
Uniquement en sortie. ID de révision du libellé. L'ID de révision peut faire partie du libellé |
labelType |
Obligatoire. Type de libellé. |
creator |
Uniquement en sortie. Utilisateur ayant créé ce libellé. |
createTime |
Uniquement en sortie. Heure de création de ce libellé. |
revisionCreator |
Uniquement en sortie. Utilisateur qui a créé cette révision de libellé. |
revisionCreateTime |
Uniquement en sortie. Heure de création de la révision du libellé. |
publisher |
Uniquement en sortie. Utilisateur ayant publié ce libellé. Cette valeur n'a aucune signification lorsque le libellé n'est pas publié. |
publishTime |
Uniquement en sortie. Heure de publication de ce libellé. Cette valeur n'a aucune signification lorsque le libellé n'est pas publié. |
disabler |
Uniquement en sortie. Utilisateur qui a désactivé ce libellé. Cette valeur n'a aucune signification lorsque le libellé n'est pas désactivé. |
disableTime |
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é. |
customer |
Uniquement en sortie. Client auquel appartient ce libellé. Par exemple: "customers/123abc789". |
properties |
Obligatoire. Propriétés de base du libellé. |
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. |
displayHints |
Uniquement en sortie. Affichage de suggestions dans l'interface utilisateur pour l'affichage du libellé. |
appliedCapabilities |
Uniquement en sortie. Fonctionnalités associées à ce libellé pour les métadonnées appliquées. |
schemaCapabilities |
Uniquement en sortie. Capacités de l'utilisateur pour ce libellé. |
appliedLabelPolicy |
Uniquement en sortie. Comportement de ce libellé lorsqu'il est appliqué à des éléments Drive. |
fields[] |
Liste des champs par ordre de priorité décroissant. |
learnMoreUri |
URL personnalisée à présenter aux utilisateurs pour leur permettre d'en savoir plus sur ce libellé et son utilisation. |
lockStatus |
Uniquement en sortie. État verrouillé de ce libellé. |
LabelType
Type de ce libellé.
Enums | |
---|---|
LABEL_TYPE_UNSPECIFIED |
Type de libellé inconnu. |
SHARED |
Vous pouvez partager des libellés avec des utilisateurs pour les appliquer à des éléments Drive. |
ADMIN |
Libellé appartenant à l'administrateur. Seuls les administrateurs peuvent les créer et les modifier. Compatible avec d'autres fonctionnalités réservées aux administrateurs. |
UserInfo
Informations sur un utilisateur.
Représentation JSON |
---|
{ "person": string } |
Champs | |
---|---|
person |
Identifiant de cet utilisateur, qui peut être utilisé avec l'API People pour obtenir plus d'informations. Par exemple, people/12345678. |
Propriétés
Propriétés de base du libellé.
Représentation JSON |
---|
{ "title": string, "description": string } |
Champs | |
---|---|
title |
Obligatoire. Titre du libellé. |
description |
Description du libellé. |
Cycle de vie
État du cycle de vie d'un objet (étiquette, champ ou choix, par exemple). Le cycle de vie applique les transitions suivantes:
UNPUBLISHED_DRAFT
(état de départ)UNPUBLISHED_DRAFT
->PUBLISHED
UNPUBLISHED_DRAFT
-> (Supprimé)PUBLISHED
->DISABLED
DISABLED
->PUBLISHED
DISABLED
-> (Supprimé)
Les états "Publié" et "Désactivé" présentent des caractéristiques distinctes:
- Publié : certains types de modifications peuvent être apportés à un objet dans cet état, auquel cas
hasUnpublishedChanges
est défini sur "true". En outre, certains types de modifications ne sont pas autorisés. En règle générale, toute modification susceptible d'invalider ou de provoquer de nouvelles restrictions pour les métadonnées existantes associées au libellé est refusée. - Désactivé : lorsque cette option est désactivée, la configuration
DisabledPolicy
est appliquée.
Représentation JSON |
---|
{ "state": enum ( |
Champs | |
---|---|
state |
Uniquement en sortie. État de l'objet associé à ce cycle de vie. |
hasUnpublishedChanges |
Uniquement en sortie. Indique si l'objet associé à ce cycle de vie comporte des modifications non publiées. |
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. |
État
État de l'objet associé à ce cycle de vie.
Enums | |
---|---|
STATE_UNSPECIFIED |
État inconnu. |
UNPUBLISHED_DRAFT |
État initial d'un objet. Une fois publié, l'objet ne peut jamais revenir à cet état. Une fois qu'un objet est publié, certains types de modifications ne sont plus autorisés. |
PUBLISHED |
L'objet a été publié. L'objet peut présenter des brouillons non publiés, comme indiqué par hasUnpublishedChanges . |
DISABLED |
L'objet a été publié et a été désactivé depuis. L'objet peut présenter des brouillons non publiés, comme indiqué par hasUnpublishedChanges . |
DELETED |
L'objet a été supprimé. |
DisabledPolicy
Règle qui régit comment traiter un libellé, un champ ou un choix de sélection désactivé dans différents contextes.
Représentation JSON |
---|
{ "hideInSearch": boolean, "showInApply": boolean } |
Champs | |
---|---|
hideInSearch |
Indique si cet objet désactivé doit être masqué dans le menu de recherche des éléments Drive.
|
showInApply |
Indique si cet objet désactivé doit être affiché dans le menu "Appliquer" des éléments Drive.
|
DisplayHints
Affichage de suggestions dans l'interface utilisateur pour l'affichage du libellé.
Représentation JSON |
---|
{ "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean, "priority": string } |
Champs | |
---|---|
disabled |
Indique si le libellé doit être désactivé dans l'interface utilisateur. |
shownInApply |
Ce libellé doit s'afficher dans le menu "Appliquer" lorsque vous appliquez des valeurs à un élément Drive. |
priority |
Ordre d'affichage du libellé dans une liste. |
AppliedCapabilities
Autorisations dont dispose un utilisateur sur les métadonnées appliquées à ce libellé.
Représentation JSON |
---|
{ "canRead": boolean, "canApply": boolean, "canRemove": boolean } |
Champs | |
---|---|
canRead |
Indique si l'utilisateur peut lire les métadonnées appliquées associées à ce libellé. |
canApply |
Indique si l'utilisateur peut appliquer ce libellé aux éléments. |
canRemove |
Indique si l'utilisateur peut supprimer ce libellé des éléments. |
SchemaCapabilities
Fonctionnalités associées à ce libellé lors de sa modification.
Représentation JSON |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
Champs | |
---|---|
canUpdate |
Indique si l'utilisateur peut modifier ce libellé. |
canDelete |
Indique si l'utilisateur peut supprimer ce libellé. L'utilisateur doit disposer de l'autorisation requise et le libellé doit être désactivé. |
canDisable |
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é. |
canEnable |
Indique si l'utilisateur peut activer ce libellé. L'utilisateur doit disposer de l'autorisation, et ce libellé doit être désactivé. |
AppliedLabelPolicy
Comportement de ce libellé lorsqu'il est appliqué à des éléments Drive.
Représentation JSON |
---|
{
"copyMode": enum ( |
Champs | |
---|---|
copyMode |
Indique comment le libellé et les valeurs de champ appliqués doivent être copiés lorsqu'un élément Drive est copié. |
CopyMode
Indique comment le libellé et les valeurs de champ appliqués doivent être copiés lorsqu'un élément Drive est copié.
Enums | |
---|---|
COPY_MODE_UNSPECIFIED |
Mode de copie non spécifié. |
DO_NOT_COPY |
Par défaut, le libellé et les valeurs de champ ne sont pas copiés lorsque l'élément Drive auquel il est appliqué est copié. |
ALWAYS_COPY |
Le libellé et les valeurs de champ sont toujours copiés lorsque l'élément Drive auquel il est appliqué est copié. Seuls les administrateurs peuvent utiliser ce mode. |
COPY_APPLIABLE |
Le libellé et les valeurs de champ appliqués sont copiés si le libellé est applicable par l'utilisateur qui effectue la copie. |
Champ
Définit un champ avec un nom à afficher, un type de données et d'autres options de configuration. Ce champ définit le type de métadonnées pouvant être définies pour un élément Drive.
Représentation JSON |
---|
{ "id": string, "queryKey": string, "properties": { object ( |
Champs | |
---|---|
id |
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: |
queryKey |
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, " |
properties |
Propriétés de base du champ. |
lifecycle |
Uniquement en sortie. Cycle de vie de ce champ. |
displayHints |
Uniquement en sortie. Conseils pour afficher un champ dans l'interface utilisateur |
schemaCapabilities |
Uniquement en sortie. Les droits dont dispose l'utilisateur lorsqu'il modifie ce champ. |
appliedCapabilities |
Uniquement en sortie. Capacités de l'utilisateur sur ce champ et sa valeur lorsque le libellé est appliqué à des éléments Drive. |
creator |
Uniquement en sortie. Utilisateur qui a créé ce champ. |
createTime |
Uniquement en sortie. Heure de création de ce champ. |
updater |
Uniquement en sortie. Utilisateur qui a modifié ce champ. |
updateTime |
Uniquement en sortie. Heure de mise à jour de ce champ. |
publisher |
Uniquement en sortie. Utilisateur ayant publié ce champ. Cette valeur n'a aucune signification si le champ n'est pas publié. |
disabler |
Uniquement en sortie. Utilisateur ayant désactivé ce champ. Cette valeur n'a aucune signification lorsque le champ n'est pas désactivé. |
disableTime |
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é. |
lockStatus |
Uniquement en sortie. LockStatus de ce champ. |
Champ d'union type . Type de données et options de ce champ. Une fois publiée, le type de données ne peut plus être modifié. type ne peut être qu'un des éléments suivants : |
|
textOptions |
Options des champs de texte. |
integerOptions |
Options de champ de nombre entier. |
dateOptions |
Options du champ de date. |
selectionOptions |
Options du champ de sélection. |
userOptions |
Options du champ utilisateur. |
TextOptions
Options pour le type de champ "Texte".
Représentation JSON |
---|
{ "minLength": integer, "maxLength": integer } |
Champs | |
---|---|
minLength |
Uniquement en sortie. Longueur minimale valide des valeurs pour le champ de texte. |
maxLength |
Uniquement en sortie. Longueur maximale valide des valeurs pour le champ de texte. |
IntegerOptions
Options pour le type de champ "Entier".
Représentation JSON |
---|
{ "minValue": string, "maxValue": string } |
Champs | |
---|---|
minValue |
Uniquement en sortie. Valeur minimale valide pour le champ de nombre entier. |
maxValue |
Uniquement en sortie. Valeur maximale valide pour le champ de nombre entier. |
DateOptions
Options pour le type de champ "Date".
Représentation JSON |
---|
{ "dateFormatType": enum ( |
Champs | |
---|---|
dateFormatType |
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. |
dateFormat |
Uniquement en sortie. Format de date ICU. |
minValue |
Uniquement en sortie. Valeur minimale valide (année, mois, jour). |
maxValue |
Uniquement en sortie. Valeur valide maximale (année, mois, jour). |
DateFormat
Options de format de date localisé
Enums | |
---|---|
DATE_FORMAT_UNSPECIFIED |
Format de date non spécifié. |
LONG_DATE |
Inclut le nom complet du mois. Exemple : 12 janvier 1999 (d MMMM y) |
SHORT_DATE |
Représentation courte, numérique. Par exemple, 13/12/99 (M/d/aa) |
SelectionOptions
Options pour le type de champ de sélection.
Représentation JSON |
---|
{ "listOptions": { object ( |
Champs | |
---|---|
listOptions |
Si spécifié, indique que ce champ accepte une liste de valeurs. Une fois le champ publié, vous ne pouvez plus le modifier. |
choices[] |
Options disponibles pour ce champ de sélection. L'ordre de la liste est cohérent et modifié avec |
ListOptions
Options pour une variante à valeurs multiples d'un type de champ associé.
Représentation JSON |
---|
{ "maxEntries": integer } |
Champs | |
---|---|
maxEntries |
Nombre maximal d'entrées autorisé. |
Choix
Choix du champ de sélection.
Représentation JSON |
---|
{ "id": string, "properties": { object ( |
Champs | |
---|---|
id |
Valeur unique du choix. Cet ID est généré automatiquement. Correspond à l'expression régulière: |
properties |
Propriétés de base du choix. |
lifecycle |
Uniquement en sortie. Cycle de vie du choix. |
displayHints |
Uniquement en sortie. Affichage de suggestions dans l'interface utilisateur pour le rendu d'un choix. |
schemaCapabilities |
Uniquement en sortie. Les fonctionnalités associées à cette option lorsque vous la modifiez. |
appliedCapabilities |
Uniquement en sortie. Fonctionnalités associées à ce choix pour les métadonnées appliquées. |
creator |
Uniquement en sortie. Utilisateur qui a créé ce choix. |
createTime |
Uniquement en sortie. Heure de création de ce choix. |
updater |
Uniquement en sortie. L'utilisateur qui a modifié ce choix en dernier. |
updateTime |
Uniquement en sortie. Heure de la dernière mise à jour de ce choix. |
publisher |
Uniquement en sortie. Utilisateur ayant publié ce choix. Cette valeur n'a aucune signification si le choix n'est pas publié. |
publishTime |
Uniquement en sortie. Heure de publication de ce choix. Cette valeur n'a aucune signification si le choix n'est pas publié. |
disabler |
Uniquement en sortie. Utilisateur ayant désactivé ce choix. Cette valeur n'a aucune signification si l'option n'est pas désactivée. |
disableTime |
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. |
lockStatus |
Uniquement en sortie. État de verrouillage de ce choix. |
Propriétés
Propriétés de base du choix.
Représentation JSON |
---|
{
"displayName": string,
"description": string,
"badgeConfig": {
object ( |
Champs | |
---|---|
displayName |
Obligatoire. Texte à afficher dans l'interface utilisateur permettant d'identifier ce champ. |
description |
Description de ce libellé. |
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". |
insertBeforeChoice |
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. |
BadgeConfig
État du badge du libellé.
Représentation JSON |
---|
{
"color": {
object ( |
Champs | |
---|---|
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. |
priorityOverride |
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. |
DisplayHints
Affichage de suggestions dans l'interface utilisateur pour l'affichage d'une option.
Représentation JSON |
---|
{ "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean, "badgeColors": { object ( |
Champs | |
---|---|
disabled |
Indique si l'option doit être désactivée dans l'interface utilisateur. |
shownInApply |
Cette option doit s'afficher dans le menu "Appliquer" lorsque vous appliquez des valeurs à un élément Drive. |
badgeColors |
Couleurs à utiliser pour le badge. Remplacement des couleurs de Material par Google en fonction des |
darkBadgeColors |
Couleur du mode sombre à utiliser pour le badge. Remplacement des couleurs de Material par Google en fonction des |
badgePriority |
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 |
BadgeColors
Couleur dérivée de BadgeConfig et remplacée par la couleur compatible recommandée la plus proche.
Représentation JSON |
---|
{ "backgroundColor": { object ( |
Champs | |
---|---|
backgroundColor |
Uniquement en sortie. Arrière-plan du badge associé au premier plan. |
foregroundColor |
Uniquement en sortie. Badge avec un premier plan associé à l'arrière-plan. |
soloColor |
Uniquement en sortie. Couleur pouvant être utilisée pour le texte sans arrière-plan. |
SchemaCapabilities
Fonctionnalités associées à ce choix lors de sa modification.
Représentation JSON |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
Champs | |
---|---|
canUpdate |
Indique si l'utilisateur peut modifier ce choix. |
canDelete |
Indique si l'utilisateur peut supprimer cette sélection. |
canDisable |
Indique si l'utilisateur peut désactiver ce choix. |
canEnable |
Indique si l'utilisateur peut activer ce choix. |
AppliedCapabilities
Fonctionnalités associées à ce choix pour les métadonnées appliquées.
Représentation JSON |
---|
{ "canRead": boolean, "canSearch": boolean, "canSelect": boolean } |
Champs | |
---|---|
canRead |
Indique si l'utilisateur peut lire les métadonnées appliquées associées aux éléments. |
canSearch |
Indique si l'utilisateur peut utiliser ce choix dans les requêtes de recherche. |
canSelect |
Indique si l'utilisateur peut sélectionner cette option pour un élément. |
LockStatus
Contient des informations indiquant si un composant de libellé doit être considéré comme verrouillé.
Représentation JSON |
---|
{ "locked": boolean } |
Champs | |
---|---|
locked |
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". |
UserOptions
Options pour le type de champ utilisateur.
Représentation JSON |
---|
{
"listOptions": {
object ( |
Champs | |
---|---|
listOptions |
Si spécifié, indique que ce champ accepte une liste de valeurs. Une fois le champ publié, vous ne pouvez plus le modifier. |
Propriétés
Propriétés de base du champ.
Représentation JSON |
---|
{ "displayName": string, "required": boolean, "insertBeforeField": string } |
Champs | |
---|---|
displayName |
Obligatoire. Texte à afficher dans l'interface utilisateur permettant d'identifier ce champ. |
required |
Indique si le champ doit être marqué comme obligatoire. |
insertBeforeField |
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. |
DisplayHints
Conseils pour afficher un champ dans l'interface utilisateur
Représentation JSON |
---|
{ "required": boolean, "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean } |
Champs | |
---|---|
required |
Indique si le champ doit être affiché comme requis dans l'interface utilisateur. |
disabled |
Indique si le champ doit être désactivé dans l'interface utilisateur. |
shownInApply |
Ce champ doit être affiché dans le menu "Appliquer" lorsque vous appliquez des valeurs à un élément Drive. |
SchemaCapabilities
Capacités associées à ce champ lors de la modification du champ.
Représentation JSON |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
Champs | |
---|---|
canUpdate |
Indique si l'utilisateur peut modifier ce champ. |
canDelete |
Indique si l'utilisateur peut supprimer ce champ. L'utilisateur doit disposer d'une autorisation, et ce champ doit être obsolète. |
canDisable |
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é. |
canEnable |
Indique si l'utilisateur peut activer ce champ. L'utilisateur doit disposer de l'autorisation, et ce champ doit être désactivé. |
AppliedCapabilities
Capacités associées à ce champ pour les métadonnées appliquées.
Représentation JSON |
---|
{ "canRead": boolean, "canSearch": boolean, "canWrite": boolean } |
Champs | |
---|---|
canRead |
Indique si l'utilisateur peut lire les métadonnées appliquées associées aux éléments. |
canSearch |
Indique si l'utilisateur peut rechercher des éléments Drive faisant référence à ce champ. |
canWrite |
Indique si l'utilisateur peut définir ce champ dans des éléments Drive. |
Méthodes |
|
---|---|
|
Crée un libellé. |
|
Supprime définitivement un libellé et les métadonnées associées sur les éléments Drive. |
|
Met à jour un seul libellé en appliquant un ensemble de demandes de mise à jour, ce qui génère un nouveau brouillon de révision. |
|
Désactiver un libellé publié |
|
Activer un libellé désactivé et le restaurer à son état de publication |
|
Permet d'obtenir un libellé à partir de son nom de ressource. |
|
Listez les libellés. |
|
Publiez toutes les modifications apportées au brouillon vers le libellé. |
|
Met à jour l'CopyMode d'un libellé. |
|
Met à jour les autorisations d'un libellé. |