REST Resource: labels

Ressource: Libellé

Un libellé définit une taxonomie qui peut être appliquée aux éléments Drive afin de les organiser et de les rechercher. Les libellés peuvent être des chaînes simples ou contenir des champs qui décrivent des métadonnées supplémentaires pouvant être utilisées pour organiser et rechercher des éléments Drive.

Représentation JSON 
{
  "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)
  },
  "enabledAppSettings": {
    object (EnabledAppSettings)
  }
}
Champs
name

string

Uniquement en sortie. Nom de la ressource du libellé. Il doit être au format labels/{id} ou labels/{id}@{revisionId}, en fonction de la requête. Voir la id et la revisionId ci-dessous.
id

string

Uniquement en sortie. Identifiant unique global de ce libellé. L'ID fait 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])+
revisionId

string

Uniquement en sortie. ID de la révision du libellé. L'ID de révision peut faire partie du libellé name, en fonction de la demande émise. Une nouvelle 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])+
labelType

enum (LabelType)

Obligatoire. Type de libellé.
creator

object (UserInfo)

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

string (Timestamp format)

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

object (UserInfo)

Uniquement en sortie. Utilisateur ayant créé cette révision de libellé.
revisionCreateTime

string (Timestamp format)

Uniquement en sortie. Heure de création de cette révision de libellé.
publisher

object (UserInfo)

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

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é.
disabler

object (UserInfo)

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

string (Timestamp format)

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

string

Uniquement en sortie. Client auquel cette étiquette appartient. Exemple: "customers/123abc789".
properties

object (Properties)

Obligatoire. Propriétés de base de l'étiquette.
lifecycle

object (Lifecycle)

Uniquement en sortie. État du cycle de vie du libellé, y compris s'il est publié, obsolète et s'il comporte des modifications de brouillon.
displayHints

object (DisplayHints)

Uniquement en sortie. L'interface utilisateur affiche des conseils pour le rendu du libellé.
appliedCapabilities

object (AppliedCapabilities)

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

object (SchemaCapabilities)

Uniquement en sortie. Les droits de l'utilisateur sur ce libellé.
appliedLabelPolicy

object (AppliedLabelPolicy)

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

object (Field)

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

string

URL personnalisée à présenter aux utilisateurs pour leur permettre d'en savoir plus sur ce libellé et sur la façon de l'utiliser.
lockStatus

object (LockStatus)

Uniquement en sortie. État de verrouillage de cette étiquette.
enabledAppSettings

object (EnabledAppSettings)

Facultatif. EnabledAppSettings pour 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 aux éléments Drive.
ADMIN Libellé appartenant à l'administrateur. Ne peuvent être créés et modifiés que par les administrateurs. Compatible avec certaines fonctionnalités supplémentaires réservées aux administrateurs.
GOOGLE_APP Libellé appartenant à une application Google interne et non à un client. Ces libellés sont en lecture seule.

UserInfo

Informations sur un utilisateur.

Représentation JSON 
{
  "person": string
}
Champs
person

string

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

string

Obligatoire. Titre du libellé.
description

string

Description de l'étiquette.

Cycle de vie

État du cycle de vie d'un objet, tel qu'un libellé, un champ ou un choix. Le cycle de vie applique les transitions suivantes:

  • UNPUBLISHED_DRAFT (état de démarrage)
  • UNPUBLISHED_DRAFT -> PUBLISHED
  • UNPUBLISHED_DRAFT -> (Supprimé)
  • PUBLISHED -> DISABLED
  • DISABLED -> PUBLISHED
  • DISABLED -> (Supprimé)

Les états "publié" et "désactivé" présentent certaines caractéristiques distinctes:

  • Publié : certains types de modifications peuvent être apportés à un objet dans cet état, auquel cas hasUnpublishedChanges sera vrai. De plus, certains types de modifications ne sont pas autorisés. En règle générale, toute modification qui invaliderait ou entraînerait de nouvelles restrictions sur les métadonnées existantes associées au libellé est refusée.
  • Désactivé : lorsque cette option est désactivée, le DisabledPolicy configuré prend effet.
Représentation JSON 
{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Champs
state

enum (State)

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

boolean

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

object (DisabledPolicy)

Règle qui régit l'affichage d'un libellé, d'un champ ou d'une option 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 plus revenir à cet état. Une fois un objet publié, certains types de modifications ne sont plus autorisés.
PUBLISHED L'objet a été publié. L'objet peut contenir des modifications non publiées, comme indiqué par hasUnpublishedChanges.
DISABLED L'objet a été publié et a depuis été désactivé. L'objet peut contenir des modifications non publiées, comme indiqué par hasUnpublishedChanges.
DELETED L'objet a été supprimé.

DisabledPolicy

Règle qui régit le traitement d'un libellé, d'un champ ou d'un choix de sélection désactivés dans différents contextes.

Représentation JSON 
{
  "hideInSearch": boolean,
  "showInApply": boolean
}
Champs
showInApply

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é comme désactivé dans l'interface utilisateur et ne peut pas être sélectionné.
  • Si false, l'objet est généralement masqué dans l'UI.

DisplayHints

L'interface utilisateur affiche des conseils pour le rendu du libellé.

Représentation JSON 
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}
Champs
disabled

boolean

Indique si le libellé doit être affiché comme désactivé dans l'UI.
shownInApply

boolean

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

string (int64 format)

Ordre d'affichage du libellé dans une liste.

AppliedCapabilities

Les fonctionnalités dont dispose un utilisateur sur les métadonnées appliquées à ce libellé.

Représentation JSON 
{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}
Champs
canRead

boolean

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

boolean

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

boolean

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

SchemaCapabilities

Fonctionnalités associées à ce libellé lors de sa modification.

Représentation JSON 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Champs
canUpdate

boolean

Indique si l'utilisateur peut modifier ce libellé.
canDelete

boolean

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

boolean

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

boolean

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 (CopyMode)
}
Champs
copyMode

enum (CopyMode)

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

CopyMode

Indique comment le libellé appliqué et les valeurs des champs 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 des champs appliqués ne sont pas copiés lorsque l'élément Drive auquel ils sont appliqués est copié.
ALWAYS_COPY Le libellé appliqué et les valeurs des champs 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é appliqué et les valeurs de champ sont copiés si l'utilisateur qui effectue la copie peut appliquer le libellé.

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éfini sur un élément Drive.

Représentation JSON 
{
  "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.
}
Champs
id

string

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

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

string

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

object (Properties)

Propriétés de base du champ.
lifecycle

object (Lifecycle)

Uniquement en sortie. Cycle de vie de ce champ.
displayHints

object (DisplayHints)

Uniquement en sortie. Conseils d'affichage de l'UI pour l'affichage d'un champ.
schemaCapabilities

object (SchemaCapabilities)

Uniquement en sortie. Les droits de cet utilisateur lorsqu'il modifie ce champ.
appliedCapabilities

object (AppliedCapabilities)

Uniquement en sortie. Les droits de cet utilisateur sur ce champ et sa valeur lorsque le libellé est appliqué aux éléments Drive.
creator

object (UserInfo)

Uniquement en sortie. Utilisateur ayant créé ce champ.
createTime

string (Timestamp format)

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

object (UserInfo)

Uniquement en sortie. Utilisateur ayant modifié ce champ.
updateTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle ce champ a été mis à jour.
publisher

object (UserInfo)

Uniquement en sortie. Utilisateur qui a publié ce champ. Cette valeur n'a aucune signification lorsque le champ n'est pas publié.
disabler

object (UserInfo)

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

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é.
lockStatus

object (LockStatus)

Uniquement en sortie. État de verrouillage de ce champ.
Champ d'union type. Type de données et options de ce champ. Une fois publié, le type de données ne peut plus être modifié. type ne peut être qu'un des éléments suivants :
textOptions

object (TextOptions)

Options du champ de texte.
integerOptions

object (IntegerOptions)

Options de champ d'entier.
dateOptions

object (DateOptions)

Options du champ de date.
selectionOptions

object (SelectionOptions)

Options du champ de sélection.
userOptions

object (UserOptions)

Options du champ "Utilisateur".

TextOptions

Options pour le type de champ de texte.

Représentation JSON 
{
  "minLength": integer,
  "maxLength": integer
}
Champs
minLength

integer

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

integer

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

string (int64 format)

Uniquement en sortie. Valeur minimale valide pour le champ entier.
maxValue

string (int64 format)

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

DateOptions

Options pour le type de champ de date.

Représentation JSON 
{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}
Champs
dateFormatType

enum (DateFormat)

Option de formatage de la date localisée. Les valeurs des champs sont affichées dans ce format en fonction de leurs paramètres régionaux.
dateFormat

string

Uniquement en sortie. Format de date ICU.
minValue

object (Date)

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

object (Date)

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

DateFormat

Options de format de date localisées.

Enums
DATE_FORMAT_UNSPECIFIED Format de date non spécifié.
LONG_DATE Inclut le nom complet du mois. Par exemple, 12 janvier 1999 (MMMM d, y)
SHORT_DATE Représentation numérique courte. Exemple : 13/12/99 (M/d/a)

Date

Représente une date du calendrier entière ou partielle, par exemple un anniversaire. L'heure de la journée et le fuseau horaire sont spécifiés ailleurs, ou ne sont pas significatifs. La date est donnée selon le calendrier grégorien. Il peut s'agir de l'un des éléments suivants:

  • Une date complète, avec des valeurs non nulles pour l'année, le mois et le jour.
  • un mois et un jour, avec une année nulle (par exemple, un anniversaire) ;
  • une année seule, avec un mois et un jour nuls ;
  • Une année et un mois, avec un jour zéro (par exemple, la date d'expiration d'une carte de crédit).

Types associés:

Représentation JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Champs
year

integer

Année de la date. Elle doit être comprise entre 1 et 9999, ou égale à 0 si vous spécifiez une date sans année.
month

integer

Mois d'une année. Il doit être compris entre 1 et 12, ou égal à 0 pour spécifier une année sans mois ni jour.
day

integer

Jour d'un mois. Il doit être compris entre 1 et 31, et valide pour l'année et le mois, ou égal à 0 pour spécifier une année seule, ou une année et un mois où le jour n'est pas significatif.

SelectionOptions

Options pour le type de champ de sélection.

Représentation JSON 
{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}
Champs
listOptions

object (ListOptions)

Lorsqu'il est spécifié, indique que ce champ accepte une liste de valeurs. Une fois le champ publié, vous ne pouvez plus le modifier.
choices[]

object (Choice)

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

ListOptions

Options pour une variante à valeurs multiples d'un type de champ associé.

Représentation JSON 
{
  "maxEntries": integer
}
Champs
maxEntries

integer

Nombre maximal d'entrées autorisé.

Choix

Choix du champ de sélection.

Représentation JSON 
{
  "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)
  }
}
Champs
id

string

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

object (Properties)

Propriétés de base du choix.
lifecycle

object (Lifecycle)

Uniquement en sortie. Cycle de vie du choix.
displayHints

object (DisplayHints)

Uniquement en sortie. L'UI affiche des indices pour l'affichage d'un choix.
schemaCapabilities

object (SchemaCapabilities)

Uniquement en sortie. Fonctionnalités associées à cette option lorsque vous la modifiez.
appliedCapabilities

object (AppliedCapabilities)

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

object (UserInfo)

Uniquement en sortie. Utilisateur ayant créé ce choix.
createTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle ce choix a été créé.
updater

object (UserInfo)

Uniquement en sortie. Utilisateur qui a modifié ce choix pour la dernière fois.
updateTime

string (Timestamp format)

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

object (UserInfo)

Uniquement en sortie. Utilisateur qui a publié ce choix. Cette valeur n'a aucune signification lorsque le choix n'est pas publié.
publishTime

string (Timestamp format)

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

object (UserInfo)

Uniquement en sortie. Utilisateur qui a désactivé cette option. Cette valeur n'a aucune signification lorsque l'option n'est pas désactivée.
disableTime

string (Timestamp format)

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

object (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 (BadgeConfig)
  },
  "insertBeforeChoice": string
}
Champs
displayName

string

Obligatoire. Texte à afficher dans l'UI pour identifier ce champ.
description

string

Description de ce libellé.
badgeConfig

object (BadgeConfig)

Configuration du badge pour ce choix. Lorsque cette valeur est définie, le libellé propriétaire de ce choix est considéré comme un "libellé avec badge".
insertBeforeChoice

string

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

BadgeConfig

État du badge du libellé.

Représentation JSON 
{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}
Champs
color

object (Color)

Couleur du badge. Si ce champ n'est pas spécifié, aucun badge ne s'affiche. Les couleurs d'arrière-plan, d'avant-plan et de solo (mode clair et sombre) définies ici sont remplacées dans l'interface utilisateur de Drive par la couleur recommandée la plus proche.
priorityOverride

string (int64 format)

Remplace la priorité globale par défaut de ce badge. Si la valeur est définie sur 0, l'heuristique de priorité par défaut est utilisée.

Couleur

Représente une couleur dans l'espace colorimétrique RVBA. Cette représentation est conçue pour simplifier la conversion entre les représentations de couleurs dans différentes langues plutôt que de privilégier la compacité. Par exemple, les champs de cette représentation peuvent être facilement fournis au constructeur de java.awt.Color en Java. Ils peuvent également être facilement fournis à la méthode +colorWithRed:green:blue:alpha de UIColor sur iOS. De plus, avec un peu de travail, ils peuvent facilement être mis en forme dans une chaîne rgba() CSS en JavaScript.

Cette page de référence ne contient pas d'informations sur l'espace colorimétrique absolu à utiliser pour interpréter la valeur RVB (par exemple, sRVB, Adobe RVB, DCI-P3 et BT.2020). Par défaut, les applications doivent partir du principe qu'il s'agit de l'espace colorimétrique sRVB.

Lorsqu'il faut déterminer l'égalité des couleurs, les implémentations, sauf indication contraire dans la documentation, considèrent deux couleurs comme égales si toutes leurs valeurs de rouge, de vert, de bleu et d'alpha diffèrent chacune d'au plus 1e-5.

Exemple (Java) :

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

Exemple (iOS/Obj-C) :

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

Exemple (JavaScript) :

// ...

var protoToCssColor = function(rgb_color) {
   var redFrac = rgb_color.red || 0.0;
   var greenFrac = rgb_color.green || 0.0;
   var blueFrac = rgb_color.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgb_color)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgb_color.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...
Représentation JSON 
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
Champs
red

number

Quantité de rouge dans la couleur en tant que valeur dans l'intervalle [0, 1].
green

number

Quantité de vert dans la couleur en tant que valeur dans l'intervalle [0, 1].
blue

number

Quantité de bleu dans la couleur en tant que valeur dans l'intervalle [0, 1].
alpha

number

Fraction de cette couleur à appliquer au pixel. En d'autres termes, la couleur finale du pixel est définie par l'équation :

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

Cela signifie qu'une valeur de 1,0 correspond à une couleur solide, tandis qu'une valeur de 0,0 correspond à une couleur complètement transparente. Un message wrapper est utilisé à la place d'une simple valeur scalaire flottante afin qu'il soit possible de distinguer une valeur par défaut de la valeur non définie. En cas d'omission, cet objet de couleur est affiché en tant que couleur solide (comme si la valeur alpha avait été explicitement fournie avec une valeur de 1,0).

DisplayHints

L'UI affiche des indices pour l'affichage d'une option.

Représentation JSON 
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}
Champs
disabled

boolean

Indique si l'option doit être affichée comme désactivée dans l'UI.
shownInApply

boolean

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

object (BadgeColors)

Couleurs à utiliser pour le badge. Les couleurs Google Material ont été remplacées en fonction de l'properties.badge_config.color choisie.
darkBadgeColors

object (BadgeColors)

Couleur du badge en mode sombre. Les couleurs Google Material ont été remplacées en fonction de l'properties.badge_config.color choisie.
badgePriority

string (int64 format)

Priorité de ce badge. Permet de comparer et de trier plusieurs badges. Un nombre inférieur signifie que le badge doit être affiché en premier. Si aucune configuration de badges n'est définie, ce champ est défini sur 0. Sinon, cette valeur sera définie 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.

BadgeColors

La couleur dérivée de BadgeConfig a été remplacée par la couleur recommandée la plus proche.

Représentation JSON 
{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}
Champs
backgroundColor

object (Color)

Uniquement en sortie. Arrière-plan du badge qui s'associe au premier plan.
foregroundColor

object (Color)

Uniquement en sortie. Premier plan du badge associé à l'arrière-plan.
soloColor

object (Color)

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

boolean

Indique si l'utilisateur peut modifier ce choix.
canDelete

boolean

Indique si l'utilisateur peut supprimer ce choix.
canDisable

boolean

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

boolean

Indique si l'utilisateur peut activer ce choix.

AppliedCapabilities

Fonctionnalités associées à ce choix sur les métadonnées appliquées.

Représentation JSON 
{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}
Champs
canRead

boolean

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

boolean

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

LockStatus

Indique si un composant de libellé doit être considéré comme verrouillé.

Représentation JSON 
{
  "locked": boolean
}
Champs
locked

boolean

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

UserOptions

Options pour le type de champ utilisateur.

Représentation JSON 
{
  "listOptions": {
    object (ListOptions)
  }
}
Champs
listOptions

object (ListOptions)

Lorsqu'il est 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

string

Obligatoire. Texte à afficher dans l'UI pour identifier ce champ.
required

boolean

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

string

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

DisplayHints

Conseils d'affichage de l'UI pour l'affichage d'un champ.

Représentation JSON 
{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}
Champs
required

boolean

Indique si le champ doit être affiché comme obligatoire dans l'UI.
disabled

boolean

Indique si le champ doit être affiché comme désactivé dans l'UI.
shownInApply

boolean

Ce champ doit s'afficher dans le menu d'application lorsque vous appliquez des valeurs à un élément Drive.

SchemaCapabilities

Fonctionnalités associées à ce champ lors de sa modification.

Représentation JSON 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Champs
canUpdate

boolean

Indique si l'utilisateur peut modifier ce champ.
canDelete

boolean

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

boolean

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

boolean

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

AppliedCapabilities

Fonctionnalités associées à ce champ sur les métadonnées appliquées.

Représentation JSON 
{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}
Champs
canRead

boolean

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

boolean

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

EnabledAppSettings

Décrit les applications Workspace dans lesquelles le libellé peut être utilisé.

Représentation JSON 
{
  "enabledApps": [
    {
      object (EnabledApp)
    }
  ]
}
Champs
enabledApps[]

object (EnabledApp)

Facultatif. Liste des applications dans lesquelles le libellé peut être utilisé.

EnabledApp

Application dans laquelle le libellé peut être utilisé.

Représentation JSON 
{
  "app": enum (App)
}
Champs
app

enum (App)

Facultatif. Nom de l'application.

Application

Ensemble des applications Workspace dans lesquelles les libellés peuvent être utilisés.

Enums
APP_UNSPECIFIED Non spécifié
DRIVE Drive.
GMAIL Gmail

Méthodes

create

 Crée un libellé.

delete

 Supprime définitivement un libellé et les métadonnées associées sur les éléments Drive.

delta

 Met à jour une seule étiquette en appliquant un ensemble de requêtes de mise à jour, ce qui génère une nouvelle version provisoire.

disable

 Désactiver un libellé publié

enable

 Activez une étiquette désactivée et rétablissez son état publié.

get

 Obtenez une étiquette par son nom de ressource.

list

 Liste des libellés.

publish

 Publiez toutes les modifications apportées au brouillon du libellé.

updateLabelCopyMode

 Met à jour le CopyMode d'un libellé.

updateLabelEnabledAppSettings

 Met à jour les EabledAppSettings d'un libellé.

updatePermissions

 Met à jour les autorisations d'un libellé.