REST Resource: labels

Recurso: rótulo

Um marcador define uma taxonomia que pode ser aplicada aos itens do Drive para organizar e pesquisar. Os marcadores podem ser strings simples ou conter campos que descrevem metadados adicionais que podem ser usados para organizar e pesquisar itens do Drive.

Representação 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)
  }
}
Campos
name

string

Apenas saída. Nome do recurso do rótulo. Será no formato labels/{id} ou labels/{id}@{revisionId}, dependendo da solicitação. Consulte id e revisionId abaixo.

id

string

Apenas saída. Identificador globalmente exclusivo deste rótulo. O ID faz parte do rótulo name, mas, ao contrário de name, ele é consistente entre as revisões. Corresponde à regex: ([a-zA-Z0-9])+

revisionId

string

Apenas saída. ID da revisão do rótulo. O ID da revisão pode fazer parte do rótulo name, dependendo da solicitação emitida. Uma nova revisão é criada sempre que as propriedades revisadas de um rótulo são alteradas. Corresponde à regex: ([a-zA-Z0-9])+

labelType

enum (LabelType)

Obrigatório. O tipo de rótulo.

creator

object (UserInfo)

Apenas saída. O usuário que criou o rótulo.

createTime

string (Timestamp format)

Apenas saída. A hora em que o marcador foi criado.

revisionCreator

object (UserInfo)

Apenas saída. O usuário que criou a revisão do rótulo.

revisionCreateTime

string (Timestamp format)

Apenas saída. O horário em que a revisão do marcador foi criada.

publisher

object (UserInfo)

Apenas saída. O usuário que publicou o rótulo. Esse valor não tem significado quando o rótulo não é publicado.

publishTime

string (Timestamp format)

Apenas saída. O horário em que o rótulo foi publicado. Esse valor não tem significado quando o rótulo não é publicado.

disabler

object (UserInfo)

Apenas saída. O usuário que desativou o rótulo. Esse valor não tem significado quando o marcador não está desativado.

disableTime

string (Timestamp format)

Apenas saída. O horário em que o rótulo foi desativado. Esse valor não tem significado quando o marcador não está desativado.

customer

string

Apenas saída. O cliente ao qual o rótulo pertence. Por exemplo: "customers/123abc789".

properties

object (Properties)

Obrigatório. As propriedades básicas do rótulo.

lifecycle

object (Lifecycle)

Apenas saída. O estado do ciclo de vida do rótulo, incluindo se ele foi publicado, descontinuado e se tem alterações de rascunho.

displayHints

object (DisplayHints)

Apenas saída. Dicas de exibição da interface para renderizar o rótulo.

appliedCapabilities

object (AppliedCapabilities)

Apenas saída. Os recursos relacionados a esse rótulo nos metadados aplicados.

schemaCapabilities

object (SchemaCapabilities)

Apenas saída. Os recursos que o usuário tem nesse marcador.

appliedLabelPolicy

object (AppliedLabelPolicy)

Apenas saída. Comportamento desse marcador quando ele é aplicado a itens do Drive.

fields[]

object (Field)

Lista de campos em ordem de prioridade decrescente.

learnMoreUri

string

URL personalizado para apresentar aos usuários e permitir que eles saibam mais sobre esse rótulo e como ele deve ser usado.

lockStatus

object (LockStatus)

Apenas saída. O LockStatus desse rótulo.

enabledAppSettings

object (EnabledAppSettings)

Opcional. As EnabledAppSettings para esse rótulo.

LabelType

O tipo do rótulo.

Enums
LABEL_TYPE_UNSPECIFIED Tipo de marcador desconhecido.
SHARED Os marcadores compartilhados podem ser compartilhados com os usuários para serem aplicados aos itens do Drive.
ADMIN Rótulo de propriedade do administrador. Somente os administradores podem criar e editar. Oferece suporte a alguns recursos exclusivos para administradores.
GOOGLE_APP Um rótulo de propriedade de um aplicativo interno do Google, e não de um cliente. Esses rótulos são somente leitura.

UserInfo

Informações sobre um usuário.

Representação JSON
{
  "person": string
}
Campos
person

string

O identificador desse usuário que pode ser usado com a API People para receber mais informações. Por exemplo, people/12345678.

Propriedades

Propriedades básicas do rótulo.

Representação JSON
{
  "title": string,
  "description": string
}
Campos
title

string

Obrigatório. Título do rótulo.

description

string

A descrição do rótulo.

Ciclo de vida

O estado do ciclo de vida de um objeto, como rótulo, campo ou escolha. O ciclo de vida impõe as seguintes transições:

  • UNPUBLISHED_DRAFT (estado inicial)
  • UNPUBLISHED_DRAFT -> PUBLISHED
  • UNPUBLISHED_DRAFT -> (excluído)
  • PUBLISHED -> DISABLED
  • DISABLED -> PUBLISHED
  • DISABLED -> (excluído)

Os estados publicados e desativados têm algumas características distintas:

  • Publicado: alguns tipos de mudanças podem ser feitas em um objeto nesse estado. Nesse caso, hasUnpublishedChanges será verdadeiro. Além disso, alguns tipos de mudanças não são permitidos. Geralmente, qualquer mudança que invalide ou cause novas restrições nos metadados relacionados ao rótulo é rejeitada.
  • Desativado: quando desativado, o DisabledPolicy configurado entra em vigor.
Representação JSON
{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Campos
state

enum (State)

Apenas saída. O estado do objeto associado a esse ciclo de vida.

hasUnpublishedChanges

boolean

Apenas saída. Se o objeto associado a esse ciclo de vida tem alterações não publicadas.

disabledPolicy

object (DisabledPolicy)

A política que governa como mostrar um rótulo, campo ou escolha de seleção desativado.

Estado

O estado do objeto associado a esse ciclo de vida.

Enums
STATE_UNSPECIFIED Estado desconhecido.
UNPUBLISHED_DRAFT O estado inicial de um objeto. Depois de publicado, o objeto não pode mais retornar a esse estado. Depois que um objeto é publicado, alguns tipos de mudanças não são mais permitidos.
PUBLISHED O objeto foi publicado. O objeto pode ter alterações de rascunho não publicadas, conforme indicado por hasUnpublishedChanges.
DISABLED O objeto foi publicado e desativado. O objeto pode ter alterações de rascunho não publicadas, conforme indicado por hasUnpublishedChanges.
DELETED O objeto foi excluído.

DisabledPolicy

A política que governa como tratar um marcador, campo ou escolha de seleção desativado em diferentes contextos.

Representação JSON
{
  "hideInSearch": boolean,
  "showInApply": boolean
}
Campos
showInApply

boolean

Indica se o objeto desativado será mostrado no menu de aplicação em itens do Drive.

  • Quando true, o objeto geralmente é mostrado na interface como desativado e não pode ser selecionado.
  • Quando false, o objeto geralmente fica oculto na interface.

DisplayHints

Dicas de exibição da interface para renderizar o rótulo.

Representação JSON
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}
Campos
disabled

boolean

Se o rótulo precisa ser mostrado na interface como desativado.

shownInApply

boolean

Esse rótulo precisa ser mostrado no menu de aplicação ao aplicar valores a um item do Drive.

priority

string (int64 format)

Ordem para mostrar o rótulo em uma lista.

AppliedCapabilities

Os recursos que um usuário tem nos metadados aplicados a esse rótulo.

Representação JSON
{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}
Campos
canRead

boolean

Indica se o usuário pode ler os metadados aplicados relacionados a esse rótulo.

canApply

boolean

Indica se o usuário pode aplicar esse rótulo a itens.

canRemove

boolean

Indica se o usuário pode remover esse rótulo dos itens.

SchemaCapabilities

Os recursos relacionados a esse rótulo ao editar o rótulo.

Representação JSON
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Campos
canUpdate

boolean

Indica se o usuário pode mudar esse rótulo.

canDelete

boolean

Indica se o usuário pode excluir esse marcador. O usuário precisa ter permissão e o marcador precisa estar desativado.

canDisable

boolean

Indica se o usuário pode desativar esse rótulo. O usuário precisa ter permissão, e o marcador não pode estar desativado.

canEnable

boolean

Indica se o usuário pode ativar esse rótulo. O usuário precisa ter permissão, e o rótulo precisa estar desativado.

AppliedLabelPolicy

Comportamento desse marcador quando ele é aplicado a itens do Drive.

Representação JSON
{
  "copyMode": enum (CopyMode)
}
Campos
copyMode

enum (CopyMode)

Indica como o marcador aplicado e os valores de campo devem ser copiados quando um item do Drive é copiado.

CopyMode

Indica como o marcador aplicado e os valores de campo devem ser copiados quando um item do Drive é copiado.

Enums
COPY_MODE_UNSPECIFIED Modo de cópia não especificado.
DO_NOT_COPY O rótulo aplicado e os valores de campo não são copiados por padrão quando o item do Drive a que ele é aplicado é copiado.
ALWAYS_COPY O marcador aplicado e os valores de campo são sempre copiados quando o item do Drive a que ele é aplicado é copiado. Somente administradores podem usar esse modo.
COPY_APPLIABLE O marcador aplicado e os valores de campo são copiados se o marcador puder ser aplicado pelo usuário que está fazendo a cópia.

Campo

Define um campo com um nome de exibição, tipo de dados e outras opções de configuração. Esse campo define o tipo de metadados que podem ser definidos em um item do Drive.

Representação 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.
}
Campos
id

string

Apenas saída. A chave de um campo, exclusiva em um rótulo ou biblioteca.

Esse valor é gerado automaticamente. Corresponde à regex: ([a-zA-Z0-9])+

queryKey

string

Apenas saída. A chave a ser usada ao criar consultas de pesquisa do Drive para encontrar arquivos com base nos valores definidos para esse campo. Por exemplo, "{queryKey} > 2001-01-01".

properties

object (Properties)

As propriedades básicas do campo.

lifecycle

object (Lifecycle)

Apenas saída. O ciclo de vida desse campo.

displayHints

object (DisplayHints)

Apenas saída. Dicas de exibição da interface para renderizar um campo.

schemaCapabilities

object (SchemaCapabilities)

Apenas saída. Os recursos que o usuário tem ao editar esse campo.

appliedCapabilities

object (AppliedCapabilities)

Apenas saída. Os recursos que o usuário tem nesse campo e o valor dele quando o marcador é aplicado aos itens do Drive.

creator

object (UserInfo)

Apenas saída. O usuário que criou esse campo.

createTime

string (Timestamp format)

Apenas saída. O horário em que o campo foi criado.

updater

object (UserInfo)

Apenas saída. O usuário que modificou esse campo.

updateTime

string (Timestamp format)

Apenas saída. A hora em que o campo foi atualizado.

publisher

object (UserInfo)

Apenas saída. O usuário que publicou esse campo. Esse valor não tem significado quando o campo não está publicado.

disabler

object (UserInfo)

Apenas saída. O usuário que desativou esse campo. Esse valor não tem significado quando o campo não está desativado.

disableTime

string (Timestamp format)

Apenas saída. O horário em que esse campo foi desativado. Esse valor não tem significado quando o campo não está desativado.

lockStatus

object (LockStatus)

Apenas saída. O LockStatus deste campo.

Campo de união type. O tipo de dados e as opções desse campo. Depois de publicado, o tipo de dados não pode ser alterado. type pode ser apenas de um dos tipos a seguir:
textOptions

object (TextOptions)

Opções de campo de texto.

integerOptions

object (IntegerOptions)

Opções de campo de número inteiro.

dateOptions

object (DateOptions)

Opções de campo de data.

selectionOptions

object (SelectionOptions)

Opções de campo de seleção.

userOptions

object (UserOptions)

Opções de campo do usuário.

TextOptions

Opções para o tipo de campo de texto.

Representação JSON
{
  "minLength": integer,
  "maxLength": integer
}
Campos
minLength

integer

Apenas saída. O comprimento mínimo válido de valores para o campo de texto.

maxLength

integer

Apenas saída. O comprimento máximo válido de valores para o campo de texto.

IntegerOptions

Opções para o tipo de campo "Integer".

Representação JSON
{
  "minValue": string,
  "maxValue": string
}
Campos
minValue

string (int64 format)

Apenas saída. O valor mínimo válido para o campo de número inteiro.

maxValue

string (int64 format)

Apenas saída. O valor máximo válido para o campo de número inteiro.

DateOptions

Opções para o tipo de campo de data.

Representação JSON
{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}
Campos
dateFormatType

enum (DateFormat)

Opção de formatação de data localizada. Os valores dos campos são renderizados nesse formato de acordo com a localidade.

dateFormat

string

Apenas saída. Formato de data ICU.

minValue

object (Date)

Apenas saída. Valor mínimo válido (ano, mês, dia).

maxValue

object (Date)

Apenas saída. Valor máximo válido (ano, mês, dia).

DateFormat

Opções de formato de data localizadas.

Enums
DATE_FORMAT_UNSPECIFIED Formato de data não especificado.
LONG_DATE Inclui o nome completo do mês. Por exemplo, 12 de janeiro de 1999 (d/M/y)
SHORT_DATE Representação curta e numérica. Por exemplo, 13/12/99 (M/d/y)

Data

Representa uma data inteira ou parcial do calendário, como um aniversário. A hora do dia e o fuso horário são especificados em outro lugar ou são insignificantes. A data é referente ao calendário gregoriano. Isso pode representar uma das seguintes opções:

  • uma data completa, com valores de ano, mês e dia diferentes de zero;
  • um mês e dia, com um ano zero (por exemplo, uma data comemorativa);
  • um ano sozinho, com um mês zero e um dia zero;
  • um ano e mês, com um dia zero (por exemplo, uma data de validade de cartão de crédito).

Tipos relacionados:

Representação JSON
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Ano da data. Precisa ser de 1 a 9.999 ou 0 para especificar uma data sem ano.

month

integer

Mês do ano. Precisa ser de 1 a 12, ou 0 para especificar um ano sem um mês e dia.

day

integer

Dia do mês. Precisa ser de 1 a 31 e válido para o ano e o mês, ou 0 para especificar um ano sozinho ou um ano e mês em que o dia não é significativo.

SelectionOptions

Opções para o tipo de campo de seleção.

Representação JSON
{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}
Campos
listOptions

object (ListOptions)

Quando especificado, indica que este campo aceita uma lista de valores. Depois que o campo é publicado, isso não pode ser alterado.

choices[]

object (Choice)

As opções disponíveis para esse campo de seleção. A ordem da lista é consistente e modificada com insertBeforeChoice.

ListOptions

Opções para uma variante com vários valores de um tipo de campo associado.

Representação JSON
{
  "maxEntries": integer
}
Campos
maxEntries

integer

Número máximo de entradas permitidas.

Escolha

Campo de seleção.

Representação 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)
  }
}
Campos
id

string

O valor exclusivo da escolha. Esse ID é gerado automaticamente. Corresponde à regex: ([a-zA-Z0-9_])+.

properties

object (Properties)

Propriedades básicas da escolha.

lifecycle

object (Lifecycle)

Apenas saída. Ciclo de vida da escolha.

displayHints

object (DisplayHints)

Apenas saída. Dicas de exibição da interface para renderizar uma escolha.

schemaCapabilities

object (SchemaCapabilities)

Apenas saída. Os recursos relacionados a essa opção ao editá-la.

appliedCapabilities

object (AppliedCapabilities)

Apenas saída. Os recursos relacionados a essa escolha nos metadados aplicados.

creator

object (UserInfo)

Apenas saída. O usuário que criou essa opção.

createTime

string (Timestamp format)

Apenas saída. O horário em que essa escolha foi criada.

updater

object (UserInfo)

Apenas saída. O usuário que atualizou essa opção por último.

updateTime

string (Timestamp format)

Apenas saída. A hora em que a opção foi atualizada pela última vez.

publisher

object (UserInfo)

Apenas saída. O usuário que publicou essa opção. Esse valor não tem significado quando a escolha não é publicada.

publishTime

string (Timestamp format)

Apenas saída. O horário em que a escolha foi publicada. Esse valor não tem significado quando a escolha não é publicada.

disabler

object (UserInfo)

Apenas saída. O usuário que desativou essa opção. Esse valor não tem significado quando a opção não está desativada.

disableTime

string (Timestamp format)

Apenas saída. O período em que essa opção foi desativada. Esse valor não tem significado quando a escolha não está desativada.

lockStatus

object (LockStatus)

Apenas saída. O LockStatus dessa escolha.

Propriedades

Propriedades básicas da escolha.

Representação JSON
{
  "displayName": string,
  "description": string,
  "badgeConfig": {
    object (BadgeConfig)
  },
  "insertBeforeChoice": string
}
Campos
displayName

string

Obrigatório. O texto de exibição a ser mostrado na interface para identificar esse campo.

description

string

A descrição do rótulo.

badgeConfig

object (BadgeConfig)

A configuração do selo para essa escolha. Quando definido, o rótulo que é proprietário dessa escolha é considerado um "rótulo com selo".

insertBeforeChoice

string

Somente entrada. Insira ou mova essa opção antes da opção indicada. Se estiver vazio, a opção será colocada no final da lista.

BadgeConfig

Status do selo do rótulo.

Representação JSON
{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}
Campos
color

object (Color)

A cor do selo. Quando não especificado, nenhum selo é renderizado. As cores de plano de fundo, primeiro plano e solo (modo claro e escuro) definidas aqui são alteradas na interface do Drive para a cor recomendada mais próxima com suporte.

priorityOverride

string (int64 format)

Substitua a prioridade global padrão desse selo. Quando definido como 0, a heurística de prioridade padrão é usada.

Cor

Representa uma cor no espaço de cores RGBA. Essa representação foi projetada para simplificar a conversão de e para representações de cores em vários idiomas em vez de compactação. Por exemplo, os campos dessa representação podem ser fornecidos de forma simples ao construtor de java.awt.Color em Java. Eles também podem ser fornecidos de forma simples ao método +colorWithRed:green:blue:alpha do UIColor no iOS. Com um pouco de trabalho, eles podem ser formatados facilmente em uma string rgba() do CSS em JavaScript.

Esta página de referência não tem informações sobre o espaço de cores absoluto que precisa ser usado para interpretar o valor RGB, por exemplo, sRGB, Adobe RGB, DCI-P3 e BT.2020. Por padrão, os aplicativos usam o espaço de cores sRGB.

Quando a igualdade de cores precisa ser decidida, as implementações, a menos que documentadas de outra forma, tratam duas cores como iguais se todos os valores de vermelho, verde, azul e alfa diferirem no máximo em 1e-5.

Exemplo (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();
 }
 // ...

Exemplo (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;
}
// ...

Exemplo (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('');
};

// ...
Representação JSON
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
Campos
red

number

A quantidade de vermelho na cor como um valor no intervalo [0, 1].

green

number

A quantidade de verde na cor como um valor no intervalo [0, 1].

blue

number

A quantidade de azul na cor como um valor no intervalo [0, 1].

alpha

number

A fração desta cor que deve ser aplicada ao pixel. Ou seja, a cor final do pixel é definida pela equação:

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

Isto significa que um valor de 1,0 corresponde a uma cor sólida, enquanto um valor de 0,0 corresponde a uma cor completamente transparente. Esse recurso usa uma mensagem de wrapper, em vez de um escalar flutuante simples, para que seja possível distinguir entre um valor padrão e o valor que está sendo desativado. Se omitido, esse objeto de cor será renderizado como uma cor sólida, como se o valor alfa tivesse sido explicitamente informado com um valor de 1,0.

DisplayHints

Dicas de exibição da interface para renderizar uma opção.

Representação JSON
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}
Campos
disabled

boolean

Se a opção precisa ser mostrada na interface como desativada.

shownInApply

boolean

Essa opção precisa ser mostrada no menu de aplicação ao aplicar valores a um item do Drive.

badgeColors

object (BadgeColors)

As cores a serem usadas no selo. Mudança para as cores do Google Material com base no properties.badge_config.color escolhido.

darkBadgeColors

object (BadgeColors)

A cor do modo escuro a ser usada para o selo. Mudança para as cores do Google Material com base no properties.badge_config.color escolhido.

badgePriority

string (int64 format)

A prioridade desse selo. Usado para comparar e classificar entre vários selos. Um número menor significa que o selo precisa ser mostrado primeiro. Quando uma configuração de selo não estiver presente, o valor será 0. Caso contrário, ele será definido como BadgeConfig.priority_override ou a heurística padrão, que prefere a data de criação do rótulo e a prioridade do campo e da opção.

BadgeColors

A cor derivada de BadgeConfig e alterada para a cor recomendada mais próxima com suporte.

Representação JSON
{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}
Campos
backgroundColor

object (Color)

Apenas saída. O plano de fundo do selo que combina com o primeiro plano.

foregroundColor

object (Color)

Apenas saída. Plano de fundo do selo que combina com o plano de fundo.

soloColor

object (Color)

Apenas saída. Cor que pode ser usada para texto sem plano de fundo.

SchemaCapabilities

Os recursos relacionados a essa escolha ao editar a opção.

Representação JSON
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Campos
canUpdate

boolean

Se o usuário pode atualizar essa escolha.

canDelete

boolean

Indica se o usuário pode excluir essa opção.

canDisable

boolean

Indica se o usuário pode desativar essa opção.

canEnable

boolean

Indica se o usuário pode ativar essa opção.

AppliedCapabilities

Os recursos relacionados a essa escolha nos metadados aplicados.

Representação JSON
{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}
Campos
canRead

boolean

Se o usuário pode ler os metadados aplicados relacionados nos itens.

canSelect

boolean

Indica se o usuário pode selecionar essa opção em um item.

LockStatus

Contém informações sobre se um componente de rótulo deve ser considerado bloqueado.

Representação JSON
{
  "locked": boolean
}
Campos
locked

boolean

Apenas saída. Indica se esse componente de rótulo é o destino (direto) de um LabelLock. Um componente de rótulo pode ser bloqueado implicitamente, mesmo que não seja o destino direto de um LabelLock. Nesse caso, esse campo é definido como falso.

UserOptions

Opções para o tipo de campo do usuário.

Representação JSON
{
  "listOptions": {
    object (ListOptions)
  }
}
Campos
listOptions

object (ListOptions)

Quando especificado, indica que esse campo aceita uma lista de valores. Depois que o campo é publicado, isso não pode ser alterado.

Propriedades

As propriedades básicas do campo.

Representação JSON
{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}
Campos
displayName

string

Obrigatório. O texto de exibição a ser mostrado na interface para identificar esse campo.

required

boolean

Se o campo precisa ser marcado como obrigatório.

insertBeforeField

string

Somente entrada. Insira ou mova esse campo antes do campo indicado. Se estiver vazio, o campo será colocado no final da lista.

DisplayHints

Dicas de exibição da interface para renderizar um campo.

Representação JSON
{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}
Campos
required

boolean

Se o campo precisa ser mostrado como obrigatório na interface.

disabled

boolean

Se o campo precisa ser mostrado na interface como desativado.

shownInApply

boolean

Esse campo precisa ser mostrado no menu de aplicação ao aplicar valores a um item do Drive.

SchemaCapabilities

Os recursos relacionados a esse campo ao editá-lo.

Representação JSON
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
Campos
canUpdate

boolean

Indica se o usuário pode mudar esse campo.

canDelete

boolean

Indica se o usuário pode excluir esse campo. O usuário precisa ter permissão e o campo precisa estar descontinuado.

canDisable

boolean

Indica se o usuário pode desativar esse campo. O usuário precisa ter permissão, e o campo não pode estar desativado.

canEnable

boolean

Indica se o usuário pode ativar esse campo. O usuário precisa ter permissão e esse campo precisa estar desativado.

AppliedCapabilities

Os recursos relacionados a esse campo nos metadados aplicados.

Representação JSON
{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}
Campos
canRead

boolean

Indica se o usuário pode ler os metadados aplicados relacionados nos itens.

canWrite

boolean

Indica se o usuário pode definir esse campo em itens do Drive.

EnabledAppSettings

Descreve os apps do Workspace em que o rótulo pode ser usado.

Representação JSON
{
  "enabledApps": [
    {
      object (EnabledApp)
    }
  ]
}
Campos
enabledApps[]

object (EnabledApp)

Opcional. Lista de apps em que o rótulo pode ser usado.

EnabledApp

Um app em que o rótulo pode ser usado.

Representação JSON
{
  "app": enum (App)
}
Campos
app

enum (App)

Opcional. O nome do app.

App

Conjunto de apps do Workspace em que os rótulos podem ser usados.

Enums
APP_UNSPECIFIED Não especificado
DRIVE e organização do Drive.
GMAIL Gmail

Métodos

create

Cria um novo rótulo.

delete

Exclui permanentemente um rótulo e os metadados relacionados nos itens do Drive.

delta

Atualiza um único rótulo aplicando um conjunto de solicitações de atualização que resultam em uma nova revisão de rascunho.

disable

Desativar um marcador publicado.

enable

Ative um rótulo desativado e restaure o estado publicado dele.

get

Receber um rótulo pelo nome do recurso.

list

Lista de rótulos.

publish

Publicar todas as alterações do rascunho no rótulo.

updateLabelCopyMode

Atualiza o CopyMode de um rótulo.

updateLabelEnabledAppSettings

Atualiza as configurações de app ativadas de um rótulo.

updatePermissions

Atualiza as permissões de um rótulo.