REST Resource: labels

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

string

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

string

Apenas saída. É o identificador global exclusivo desse rótulo. O ID compõe parte do rótulo name, mas, diferentemente de name, ele é consistente entre as revisões. Corresponde ao regex: ([a-zA-Z0-9])+

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 ao regex: ([a-zA-Z0-9])+

enum (LabelType)

Obrigatório. O tipo de rótulo.

object (UserInfo)

Apenas saída. O usuário que criou este marcador.

string (Timestamp format)

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

object (UserInfo)

Apenas saída. O usuário que criou esta revisão de marcador.

string (Timestamp format)

Apenas saída. A hora em que esta revisão de rótulo foi criada.

object (UserInfo)

Apenas saída. O usuário que publicou este marcador. Esse valor não terá significado quando o rótulo não estiver publicado.

string (Timestamp format)

Apenas saída. A hora em que este marcador foi publicado. Esse valor não terá significado quando o rótulo não estiver publicado.

object (UserInfo)

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

string (Timestamp format)

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

string

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

object (Properties)

Obrigatório. Propriedades básicas do rótulo.

object (Lifecycle)

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

object (DisplayHints)

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

object (AppliedCapabilities)

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

object (SchemaCapabilities)

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

object (AppliedLabelPolicy)

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

object (Field)

Lista de campos em ordem de prioridade decrescente.

string

URL personalizado a ser apresentado aos usuários para que eles saibam mais sobre o marcador e como ele deve ser usado.

object (LockStatus)

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

{
  "person": string
}

string

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

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

string

Obrigatório. Título do marcador.

string

A descrição do rótulo.

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

enum (State)

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

boolean

Apenas saída. Indica se o objeto associado a esse ciclo de vida tem mudanças não publicadas.

object (DisabledPolicy)

A política que rege como mostrar um marcador, um campo ou uma opção de seleção desativado.

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

boolean

Define se o objeto desativado será ocultado no menu de pesquisa para itens do Drive.

• Quando false, o objeto geralmente aparece na interface como desativado, mas aparece nos resultados da pesquisa ao pesquisar itens do Drive.
• Quando true, o objeto geralmente fica oculto na interface ao pesquisar itens do Drive.

boolean

Indica se este objeto desativado será mostrado no menu "Aplicar" nos 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.

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

boolean

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

boolean

Este marcador deve estar oculto no menu de pesquisa ao pesquisar itens do Drive.

boolean

Este marcador é exibido no menu "Aplicar" ao aplicar valores a um item do Drive.

string (int64 format)

Ordem para exibir o rótulo em uma lista.

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

boolean

Define se o usuário pode ler os metadados aplicados relacionados ao marcador.

boolean

Define se o usuário pode aplicar esse rótulo aos itens.

boolean

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

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

boolean

Define se o usuário pode alterar o rótulo.

boolean

Define se o usuário pode excluir o rótulo. O usuário precisa ter permissão, e o marcador precisa ser desativado.

boolean

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

boolean

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

{
  "copyMode": enum (CopyMode)
}

enum (CopyMode)

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

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

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

string

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

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

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 este campo. Por exemplo, "{queryKey} > 2001-01-01".

object (Properties)

Propriedades básicas do campo.

object (Lifecycle)

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

object (DisplayHints)

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

object (SchemaCapabilities)

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

object (AppliedCapabilities)

Apenas saída. Os recursos que esse usuário tem neste campo e o valor correspondente quando o marcador é aplicado a itens do Drive.

object (UserInfo)

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

string (Timestamp format)

Apenas saída. Hora em que este campo foi criado.

object (UserInfo)

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

string (Timestamp format)

Apenas saída. Hora em que este campo foi atualizado.

object (UserInfo)

Apenas saída. O usuário que publicou este campo. Esse valor não terá significado quando o campo não estiver publicado.

object (UserInfo)

Apenas saída. O usuário que desativou este campo. Esse valor não terá significado quando o campo não estiver desativado.

string (Timestamp format)

Apenas saída. Hora em que este campo foi desativado. Esse valor não terá significado quando o campo não estiver desativado.

object (LockStatus)

Apenas saída. O LockStatus deste campo.

object (TextOptions)

Opções de campo de texto.

object (IntegerOptions)

Opções de campo de números inteiros.

object (DateOptions)

Opções do campo de data.

object (SelectionOptions)

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

object (UserOptions)

Opções do campo do usuário.

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

integer

Apenas saída. O tamanho mínimo válido dos valores do campo de texto.

integer

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

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

string (int64 format)

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

string (int64 format)

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

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

enum (DateFormat)

Opção de formatação de data localizada. Os valores de campo são renderizados neste formato de acordo com a localidade.

string

Apenas saída. Formato de data ICU.

object (Date)

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

object (Date)

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

{
  "year": integer,
  "month": integer,
  "day": integer
}

integer

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

integer

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

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.

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

object (ListOptions)

Quando especificado, indica que esse campo aceita uma lista de valores. Depois que o campo for publicado, não será possível alterá-lo.

object (Choice)

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

{
  "maxEntries": integer
}

integer

Número máximo de entradas permitidas.

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

string

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

object (Properties)

Propriedades básicas da escolha.

object (Lifecycle)

Apenas saída. Ciclo de vida da escolha.

object (DisplayHints)

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

object (SchemaCapabilities)

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

object (AppliedCapabilities)

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

object (UserInfo)

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

string (Timestamp format)

Apenas saída. A hora em que essa opção foi criada.

object (UserInfo)

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

string (Timestamp format)

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

object (UserInfo)

Apenas saída. O usuário que publicou esta opção. Esse valor não terá significado quando a escolha não estiver publicada.

string (Timestamp format)

Apenas saída. A hora em que esta opção foi publicada. Esse valor não terá significado quando a escolha não estiver publicada.

object (UserInfo)

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

string (Timestamp format)

Apenas saída. A hora em que esta opção foi desativada. Esse valor não tem significado quando a opção não está desativada.

object (LockStatus)

Apenas saída. O LockStatus dessa escolha.

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

string

Obrigatório. O texto de exibição a ser exibido na interface que identifica esse campo.

string

A descrição deste rótulo.

object (BadgeConfig)

A configuração do selo para essa opção. Quando definido, o marcador que possui essa escolha é considerado um "marcador com selo".

string

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

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

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 compatível mais próxima.

string (int64 format)

Substituir a prioridade global padrão deste selo. Quando definida como 0, a heurística de prioridade padrão é usada.

{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}

number

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

number

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

number

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

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 é renderizado como uma cor sólida (como se o valor alfa tivesse recebido explicitamente o valor 1,0).

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

boolean

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

boolean

Essa opção deve estar oculta no menu de pesquisa ao pesquisar itens do Drive.

boolean

Esta opção aparece no menu "Aplicar" ao aplicar valores a um item do Drive.

object (BadgeColors)

As cores que serão usadas no selo. Alteradas para as cores do Google Material com base na properties.badge_config.color escolhida.

object (BadgeColors)

É a cor no modo escuro que será usada no selo. Alteradas para as cores do Google Material com base na properties.badge_config.color escolhida.

string (int64 format)

A prioridade do selo. Usado para comparar e classificar entre vários selos. Um número menor significa que o selo deve ser exibido primeiro. Quando não houver uma configuração de selo, esse valor será 0. Caso contrário, ele será definido como BadgeConfig.priority_override ou a heurística padrão, que dá preferência à data de criação do rótulo e à prioridade do campo e da opção.

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

object (Color)

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

object (Color)

Apenas saída. Selo em primeiro plano que combina com o plano de fundo.

object (Color)

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

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

boolean

Define se o usuário pode atualizar essa opção.

boolean

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

boolean

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

boolean

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

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

boolean

Define se o usuário pode ler metadados aplicados relacionados aos itens.

boolean

Define se o usuário pode usar essa opção em consultas de pesquisa.

boolean

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

{
  "locked": boolean
}

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 "false".

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

object (ListOptions)

Quando especificado, indica que esse campo oferece suporte a uma lista de valores. Depois que o campo for publicado, não será possível alterá-lo.

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

string

Obrigatório. O texto de exibição a ser exibido na interface que identifica esse campo.

boolean

Se o campo deve ser marcado como obrigatório.

string

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

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

boolean

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

boolean

Se o campo deve ser mostrado na interface como desativado.

boolean

Esse campo deve ficar oculto no menu de pesquisa ao pesquisar itens do Drive.

boolean

Este campo é mostrado no menu "Aplicar" ao aplicar valores a um item do Drive.

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

boolean

Define se o usuário pode alterar esse campo.

boolean

Define se o usuário pode excluir esse campo. O usuário precisa ter permissão, e o campo precisa estar obsoleto.

boolean

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

boolean

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

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

boolean

Define se o usuário pode ler metadados aplicados relacionados aos itens.

boolean

Define se o usuário pode pesquisar itens do Drive que fazem referência a este campo.

boolean

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