- Recurso: rótulo
- LabelType
- UserInfo
- Propriedades
- Ciclo de vida
- Estado
- DisabledPolicy
- DisplayHints
- AppliedCapabilities
- SchemaCapabilities
- AppliedLabelPolicy
- CopyMode
- Campo
- TextOptions
- IntegerOptions
- DateOptions
- DateFormat
- Date
- SelectionOptions
- ListOptions
- Escolha
- Propriedades
- BadgeConfig
- Color
- DisplayHints
- BadgeColors
- SchemaCapabilities
- AppliedCapabilities
- LockStatus
- UserOptions
- Propriedades
- DisplayHints
- SchemaCapabilities
- AppliedCapabilities
- EnabledAppSettings
- EnabledApp
- App
- Métodos
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 ( |
Campos | |
---|---|
name |
Apenas saída. Nome do recurso do rótulo. Será no formato |
id |
Apenas saída. Identificador globalmente exclusivo deste rótulo. O ID faz parte do rótulo |
revisionId |
Apenas saída. ID da revisão do rótulo. O ID da revisão pode fazer parte do rótulo |
labelType |
Obrigatório. O tipo de rótulo. |
creator |
Apenas saída. O usuário que criou o rótulo. |
createTime |
Apenas saída. A hora em que o marcador foi criado. |
revisionCreator |
Apenas saída. O usuário que criou a revisão do rótulo. |
revisionCreateTime |
Apenas saída. O horário em que a revisão do marcador foi criada. |
publisher |
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 |
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 |
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 |
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 |
Apenas saída. O cliente ao qual o rótulo pertence. Por exemplo: "customers/123abc789". |
properties |
Obrigatório. As propriedades básicas do rótulo. |
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 |
Apenas saída. Dicas de exibição da interface para renderizar o rótulo. |
appliedCapabilities |
Apenas saída. Os recursos relacionados a esse rótulo nos metadados aplicados. |
schemaCapabilities |
Apenas saída. Os recursos que o usuário tem nesse marcador. |
appliedLabelPolicy |
Apenas saída. Comportamento desse marcador quando ele é aplicado a itens do Drive. |
fields[] |
Lista de campos em ordem de prioridade decrescente. |
learnMoreUri |
URL personalizado para apresentar aos usuários e permitir que eles saibam mais sobre esse rótulo e como ele deve ser usado. |
lockStatus |
Apenas saída. O LockStatus desse rótulo. |
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 |
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 |
Obrigatório. Título do rótulo. |
description |
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 ( |
Campos | |
---|---|
state |
Apenas saída. O estado do objeto associado a esse ciclo de vida. |
hasUnpublishedChanges |
Apenas saída. Se o objeto associado a esse ciclo de vida tem alterações não publicadas. |
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 | |
---|---|
hideInSearch |
Define se esse objeto desativado será ocultado no menu de pesquisa dos itens do Drive.
|
showInApply |
Indica se o objeto desativado será mostrado no menu de aplicação em itens do Drive.
|
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 |
Se o rótulo precisa ser mostrado na interface como desativado. |
shownInApply |
Esse rótulo precisa ser mostrado no menu de aplicação ao aplicar valores a um item do Drive. |
priority |
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 |
Indica se o usuário pode ler os metadados aplicados relacionados a esse rótulo. |
canApply |
Indica se o usuário pode aplicar esse rótulo a itens. |
canRemove |
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 |
Indica se o usuário pode mudar esse rótulo. |
canDelete |
Indica se o usuário pode excluir esse marcador. O usuário precisa ter permissão e o marcador precisa estar desativado. |
canDisable |
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 |
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 ( |
Campos | |
---|---|
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 ( |
Campos | |
---|---|
id |
Apenas saída. A chave de um campo, exclusiva em um rótulo ou biblioteca. Esse valor é gerado automaticamente. Corresponde à regex: |
queryKey |
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, " |
properties |
As propriedades básicas do campo. |
lifecycle |
Apenas saída. O ciclo de vida desse campo. |
displayHints |
Apenas saída. Dicas de exibição da interface para renderizar um campo. |
schemaCapabilities |
Apenas saída. Os recursos que o usuário tem ao editar esse campo. |
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 |
Apenas saída. O usuário que criou esse campo. |
createTime |
Apenas saída. O horário em que o campo foi criado. |
updater |
Apenas saída. O usuário que modificou esse campo. |
updateTime |
Apenas saída. A hora em que o campo foi atualizado. |
publisher |
Apenas saída. O usuário que publicou esse campo. Esse valor não tem significado quando o campo não está publicado. |
disabler |
Apenas saída. O usuário que desativou esse campo. Esse valor não tem significado quando o campo não está desativado. |
disableTime |
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 |
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 |
Opções de campo de texto. |
integerOptions |
Opções de campo de número inteiro. |
dateOptions |
Opções de campo de data. |
selectionOptions |
Opções de campo de seleção. |
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 |
Apenas saída. O comprimento mínimo válido de valores para o campo de texto. |
maxLength |
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 |
Apenas saída. O valor mínimo válido para o campo de número inteiro. |
maxValue |
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 ( |
Campos | |
---|---|
dateFormatType |
Opção de formatação de data localizada. Os valores dos campos são renderizados nesse formato de acordo com a localidade. |
dateFormat |
Apenas saída. Formato de data ICU. |
minValue |
Apenas saída. Valor mínimo válido (ano, mês, dia). |
maxValue |
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:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
Representação JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
Campos | |
---|---|
year |
Ano da data. Precisa ser de 1 a 9.999 ou 0 para especificar uma data sem ano. |
month |
Mês do ano. Precisa ser de 1 a 12, ou 0 para especificar um ano sem um mês e dia. |
day |
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 ( |
Campos | |
---|---|
listOptions |
Quando especificado, indica que este campo aceita uma lista de valores. Depois que o campo é publicado, isso não pode ser alterado. |
choices[] |
As opções disponíveis para esse campo de seleção. A ordem da lista é consistente e modificada com |
ListOptions
Opções para uma variante com vários valores de um tipo de campo associado.
Representação JSON |
---|
{ "maxEntries": integer } |
Campos | |
---|---|
maxEntries |
Número máximo de entradas permitidas. |
Escolha
Campo de seleção.
Representação JSON |
---|
{ "id": string, "properties": { object ( |
Campos | |
---|---|
id |
O valor exclusivo da escolha. Esse ID é gerado automaticamente. Corresponde à regex: |
properties |
Propriedades básicas da escolha. |
lifecycle |
Apenas saída. Ciclo de vida da escolha. |
displayHints |
Apenas saída. Dicas de exibição da interface para renderizar uma escolha. |
schemaCapabilities |
Apenas saída. Os recursos relacionados a essa opção ao editá-la. |
appliedCapabilities |
Apenas saída. Os recursos relacionados a essa escolha nos metadados aplicados. |
creator |
Apenas saída. O usuário que criou essa opção. |
createTime |
Apenas saída. O horário em que essa escolha foi criada. |
updater |
Apenas saída. O usuário que atualizou essa opção por último. |
updateTime |
Apenas saída. A hora em que a opção foi atualizada pela última vez. |
publisher |
Apenas saída. O usuário que publicou essa opção. Esse valor não tem significado quando a escolha não é publicada. |
publishTime |
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 |
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 |
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 |
Apenas saída. O LockStatus dessa escolha. |
Propriedades
Propriedades básicas da escolha.
Representação JSON |
---|
{
"displayName": string,
"description": string,
"badgeConfig": {
object ( |
Campos | |
---|---|
displayName |
Obrigatório. O texto de exibição a ser mostrado na interface para identificar esse campo. |
description |
A descrição do rótulo. |
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 |
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 ( |
Campos | |
---|---|
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 |
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 |
A quantidade de vermelho na cor como um valor no intervalo [0, 1]. |
green |
A quantidade de verde na cor como um valor no intervalo [0, 1]. |
blue |
A quantidade de azul na cor como um valor no intervalo [0, 1]. |
alpha |
A fração desta cor que deve ser aplicada ao pixel. Ou seja, a cor final do pixel é definida pela equação:
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 ( |
Campos | |
---|---|
disabled |
Se a opção precisa ser mostrada na interface como desativada. |
shownInApply |
Essa opção precisa ser mostrada no menu de aplicação ao aplicar valores a um item do Drive. |
badgeColors |
As cores a serem usadas no selo. Mudança para as cores do Google Material com base no |
darkBadgeColors |
A cor do modo escuro a ser usada para o selo. Mudança para as cores do Google Material com base no |
badgePriority |
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 |
BadgeColors
A cor derivada de BadgeConfig e alterada para a cor recomendada mais próxima com suporte.
Representação JSON |
---|
{ "backgroundColor": { object ( |
Campos | |
---|---|
backgroundColor |
Apenas saída. O plano de fundo do selo que combina com o primeiro plano. |
foregroundColor |
Apenas saída. Plano de fundo do selo que combina com o plano de fundo. |
soloColor |
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 |
Se o usuário pode atualizar essa escolha. |
canDelete |
Indica se o usuário pode excluir essa opção. |
canDisable |
Indica se o usuário pode desativar essa opção. |
canEnable |
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 |
Se o usuário pode ler os metadados aplicados relacionados nos itens. |
canSearch |
Se o usuário pode usar essa opção nas consultas de pesquisa. |
canSelect |
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 |
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 ( |
Campos | |
---|---|
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 |
Obrigatório. O texto de exibição a ser mostrado na interface para identificar esse campo. |
required |
Se o campo precisa ser marcado como obrigatório. |
insertBeforeField |
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 |
Se o campo precisa ser mostrado como obrigatório na interface. |
disabled |
Se o campo precisa ser mostrado na interface como desativado. |
shownInApply |
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 |
Indica se o usuário pode mudar esse campo. |
canDelete |
Indica se o usuário pode excluir esse campo. O usuário precisa ter permissão e o campo precisa estar descontinuado. |
canDisable |
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 |
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 |
Indica se o usuário pode ler os metadados aplicados relacionados nos itens. |
canSearch |
Indica se o usuário pode pesquisar itens do Drive que fazem referência a esse campo. |
canWrite |
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 ( |
Campos | |
---|---|
enabledApps[] |
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 ( |
Campos | |
---|---|
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 |
|
---|---|
|
Cria um novo rótulo. |
|
Exclui permanentemente um rótulo e os metadados relacionados nos itens do Drive. |
|
Atualiza um único rótulo aplicando um conjunto de solicitações de atualização que resultam em uma nova revisão de rascunho. |
|
Desativar um marcador publicado. |
|
Ative um rótulo desativado e restaure o estado publicado dele. |
|
Receber um rótulo pelo nome do recurso. |
|
Lista de rótulos. |
|
Publicar todas as alterações do rascunho no rótulo. |
|
Atualiza o CopyMode de um rótulo. |
|
Atualiza as configurações de app ativadas de um rótulo. |
|
Atualiza as permissões de um rótulo. |