- Recurso: rótulo
- LabelType
- UserInfo
- Propriedades
- Ciclo de vida
- Estado
- DisabledPolicy
- DisplayHints
- AppliedCapabilities
- SchemaCapabilities
- AppliedLabelPolicy
- CopyMode
- Campo
- TextOptions
- IntegerOptions
- DateOptions
- DateFormat
- SelectionOptions
- ListOptions
- Opção
- Propriedades
- BadgeConfig
- DisplayHints
- BadgeColors
- SchemaCapabilities
- AppliedCapabilities
- LockStatus (link em inglês)
- UserOptions
- Propriedades
- DisplayHints
- SchemaCapabilities
- AppliedCapabilities
- Métodos
Recurso: identificador
Um marcador define uma taxonomia que pode ser aplicada aos itens do Drive para organizar e pesquisar itens. Os marcadores podem ser strings simples ou conter campos com mais metadados 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á na forma de: |
id |
Apenas saída. Identificador globalmente exclusivo desse rótulo. O ID compõe 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 este marcador. |
createTime |
Apenas saída. Hora em que este marcador foi criado. |
revisionCreator |
Apenas saída. O usuário que criou esta revisão de marcador. |
revisionCreateTime |
Apenas saída. A hora em que esta revisão de marcador foi criada. |
publisher |
Apenas saída. O usuário que publicou este marcador. Esse valor não tem significado quando o rótulo não é publicado. |
publishTime |
Apenas saída. A hora em que este marcador foi publicado. Esse valor não tem significado quando o rótulo não é publicado. |
disabler |
Apenas saída. O usuário que desativou este marcador. Esse valor não tem significado quando o rótulo não está desativado. |
disableTime |
Apenas saída. Hora em que este marcador foi desativado. Esse valor não tem significado quando o rótulo não está desativado. |
customer |
Apenas saída. O cliente a que este 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, foi descontinuado e tem mudanças no rascunho. |
displayHints |
Apenas saída. Dicas de exibição da interface para renderizar o rótulo. |
appliedCapabilities |
Apenas saída. Os recursos relacionados a este rótulo nos metadados aplicados. |
schemaCapabilities |
Apenas saída. Os recursos que o usuário tem nesse marcador. |
appliedLabelPolicy |
Apenas saída. Comportamento deste marcador quando aplicado a itens do Google Drive. |
fields[] |
Lista de campos em ordem de prioridade decrescente. |
learnMoreUri |
URL personalizado a ser apresentado aos usuários para que eles saibam mais sobre este rótulo e como ele deve ser usado. |
lockStatus |
Apenas saída. O LockStatus deste marcador. |
LabelType
O tipo desse rótulo.
Enums | |
---|---|
LABEL_TYPE_UNSPECIFIED |
Tipo de rótulo desconhecido. |
SHARED |
É possível compartilhar marcadores compartilhados com os usuários para aplicar a itens do Drive. |
ADMIN |
Rótulo do administrador. Podem ser criados e editados apenas pelos administradores. Compatível com alguns outros recursos exclusivos para administradores. |
UserInfo
São 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 obter 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 |
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 aplica as seguintes transições:
UNPUBLISHED_DRAFT
(estado inicial)UNPUBLISHED_DRAFT
->PUBLISHED
UNPUBLISHED_DRAFT
-> (excluído)PUBLISHED
->DISABLED
DISABLED
->PUBLISHED
DISABLED
-> (excluído)
Os estados publicado e desativado têm algumas características diferentes:
- 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 alterações não são permitidos. Geralmente, qualquer alteração que invalide ou cause novas restrições nos metadados existentes 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 este ciclo de vida. |
hasUnpublishedChanges |
Apenas saída. Indica se o objeto associado a esse ciclo de vida tem mudanças não publicadas. |
disabledPolicy |
A política que determina como mostrar um marcador, campo ou opção de seleção desativado. |
Estado
O estado do objeto associado a este ciclo de vida.
Enums | |
---|---|
STATE_UNSPECIFIED |
Estado desconhecido. |
UNPUBLISHED_DRAFT |
O estado inicial de um objeto. Uma vez publicado, o objeto não pode retornar a esse estado. Depois que um objeto é publicado, determinados 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, desde então, foi 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 rege como tratar uma opção de marcador, campo ou seleção desativada em diferentes contextos.
Representação JSON |
---|
{ "hideInSearch": boolean, "showInApply": boolean } |
Campos | |
---|---|
hideInSearch |
Define se este objeto desativado será ocultado no menu de pesquisa para itens do Drive.
|
showInApply |
Define se o objeto desativado será exibido no menu "Aplicar" nos 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 |
Este marcador aparece no menu "Aplicar" quando os valores são aplicados a um item do Drive. |
priority |
Ordem de exibição do rótulo em uma lista. |
AppliedCapabilities
Os recursos que um usuário tem nos metadados aplicados desse marcador.
Representação JSON |
---|
{ "canRead": boolean, "canApply": boolean, "canRemove": boolean } |
Campos | |
---|---|
canRead |
Define se o usuário pode ler os metadados aplicados relacionados a esse rótulo. |
canApply |
Define se o usuário pode aplicar este marcador aos itens. |
canRemove |
Define se o usuário pode remover esse rótulo dos itens. |
SchemaCapabilities
Os recursos relacionados ao marcador ao editá-lo.
Representação JSON |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
Campos | |
---|---|
canUpdate |
Define se o usuário pode alterar esse identificador. |
canDelete |
Define se o usuário pode excluir este identificador. O usuário precisa ter permissão, e o marcador precisa estar desativado. |
canDisable |
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. |
canEnable |
Define se o usuário pode ativar esse rótulo. O usuário precisa ter permissão, e esse marcador precisa estar desativado. |
AppliedLabelPolicy
Comportamento deste marcador quando aplicado a itens do Google Drive.
Representação JSON |
---|
{
"copyMode": enum ( |
Campos | |
---|---|
copyMode |
Indica como os valores de marcador e campo aplicados precisam ser copiados quando um item do Drive é copiado. |
CopyMode
Indica como os valores de marcador e campo aplicados precisam ser copiados quando um item do Drive é copiado.
Enums | |
---|---|
COPY_MODE_UNSPECIFIED |
Modo de cópia não especificado. |
DO_NOT_COPY |
Por padrão, os valores de marcador e de campo aplicados não são copiados quando o item do Drive ao qual são aplicados é copiado. |
ALWAYS_COPY |
Os valores do marcador e do campo aplicados são sempre copiados quando o item do Google Drive ao qual são aplicados é copiado. Esse modo só pode ser usado pelos administradores. |
COPY_APPLIABLE |
Os valores do marcador e do campo aplicados serão copiados se o marcador puder ser aplicado pelo usuário que fez a cópia. |
Campo
Define um campo que tem um nome de exibição, tipo de dados e outras opções de configuração. Este 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 dentro de um rótulo ou biblioteca. Esse valor é gerado automaticamente. Corresponde ao 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 este campo em arquivos. Por exemplo, " |
properties |
As propriedades básicas do campo. |
lifecycle |
Apenas saída. O ciclo de vida deste 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 este campo. |
appliedCapabilities |
Apenas saída. Os recursos que o usuário tem neste campo e o valor quando o marcador é aplicado a itens do Drive. |
creator |
Apenas saída. O usuário que criou esse campo. |
createTime |
Apenas saída. A hora em que este campo foi criado. |
updater |
Apenas saída. O usuário que modificou este campo. |
updateTime |
Apenas saída. A hora em que este 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 este campo. Esse valor não tem significado quando o campo não está desativado. |
disableTime |
Apenas saída. Hora 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 deste campo. Depois de publicados, não é possível mudar o tipo dos dados. 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 do campo de seleção. |
userOptions |
Opções do 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 tamanho mínimo válido dos valores para o campo de texto. |
maxLength |
Apenas saída. O tamanho máximo válido dos valores para o campo de texto. |
IntegerOptions
Opções para o tipo de campo "Inteiro".
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 do campo 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 válido máximo (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 (MMMM d, y) |
SHORT_DATE |
Representação curta, numérica. Por exemplo, 13/12/99 (M/d/yy) |
SelectionOptions
Opções para o tipo de campo de seleção.
Representação JSON |
---|
{ "listOptions": { object ( |
Campos | |
---|---|
listOptions |
Quando especificado, indica que este campo é compatível com uma lista de valores. Depois que o campo for publicado, não será possível mudar isso. |
choices[] |
As opções disponíveis para este 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 |
O número máximo de entradas permitido. |
Opções
Escolha do campo de seleção.
Representação JSON |
---|
{ "id": string, "properties": { object ( |
Campos | |
---|---|
id |
O valor exclusivo da escolha. Esse ID é gerado automaticamente. Corresponde ao 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 esta 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 escolha. |
createTime |
Apenas saída. A hora em que essa escolha foi criada. |
updater |
Apenas saída. O usuário que atualizou esta opção por último. |
updateTime |
Apenas saída. Hora em que essa opção foi atualizada pela última vez. |
publisher |
Apenas saída. O usuário que publicou essa escolha. Esse valor não tem significado quando a escolha não é publicada. |
publishTime |
Apenas saída. A hora em que essa 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. A hora em que a opção foi desativada. Esse valor não tem significado quando a opção 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 que identifica esse campo. |
description |
A descrição deste rótulo. |
badgeConfig |
A configuração do selo para esta escolha. Quando definido, o rótulo proprietário dessa opção é considerado um "rótulo com selo". |
insertBeforeChoice |
Apenas entrada. Insira ou mova esta opção antes da opção indicada. Se estiver vazia, 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. |
priorityOverride |
Substituir a prioridade global padrão deste selo. Quando definida como 0, a heurística de prioridade padrão é usada. |
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 deve ser mostrada na interface como desativada. |
shownInApply |
Essa opção aparece no menu "Aplicar" quando os valores são aplicados a um item do Drive. |
badgeColors |
As cores a serem usadas no selo. Mudamos para as cores do Material Design do Google com base no |
darkBadgeColors |
A cor do modo escuro a ser usada no selo. Mudamos para as cores do Material Design do Google com base no |
badgePriority |
A prioridade deste selo. Usado para comparar e classificar vários selos. Um número menor significa que o selo deve aparecer primeiro. Quando não há uma configuração de selos, esse valor é 0. Caso contrário, ele será definido como |
BadgeColors
A cor derivada de BadgeConfig e alterada para a cor recomendada mais próxima.
Representação JSON |
---|
{ "backgroundColor": { object ( |
Campos | |
---|---|
backgroundColor |
Apenas saída. Plano de fundo do selo que combina com o primeiro plano. |
foregroundColor |
Apenas saída. Primeiro selo 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 à escolha ao editá-la.
Representação JSON |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
Campos | |
---|---|
canUpdate |
Define se o usuário pode atualizar essa escolha. |
canDelete |
Define se o usuário pode excluir esta opção. |
canDisable |
Define se o usuário pode desativar essa opção. |
canEnable |
Define se o usuário pode ativar esta opção. |
AppliedCapabilities
Os recursos relacionados a essa escolha nos metadados aplicados.
Representação JSON |
---|
{ "canRead": boolean, "canSearch": boolean, "canSelect": boolean } |
Campos | |
---|---|
canRead |
Define se o usuário pode ler os metadados aplicados relacionados aos itens. |
canSearch |
Define se o usuário pode usar essa opção em consultas de pesquisa. |
canSelect |
Define 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 marcador pode ser bloqueado implicitamente, mesmo que não seja o alvo direto de um LabelLock. Nesse caso, o campo é definido como "false". |
UserOptions
Opções para o tipo de campo do usuário.
Representação JSON |
---|
{
"listOptions": {
object ( |
Campos | |
---|---|
listOptions |
Quando especificado, indica que este campo é compatível com uma lista de valores. Depois que o campo for publicado, não será possível mudar isso. |
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 que identifica esse campo. |
required |
Se o campo deve ser marcado como obrigatório. |
insertBeforeField |
Apenas entrada. Insira ou mova este campo para 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 deve ser exibido como obrigatório na interface. |
disabled |
Define se o campo precisa ser mostrado na interface como desativado. |
shownInApply |
Este campo aparece no menu "Aplicar" quando os valores são aplicados a um item do Drive. |
SchemaCapabilities
Os recursos relacionados a este campo durante a edição.
Representação JSON |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
Campos | |
---|---|
canUpdate |
Define se o usuário pode alterar esse campo. |
canDelete |
Define se o usuário pode excluir este campo. O usuário precisa ter permissão, e o uso do campo precisa ser descontinuado. |
canDisable |
Define se o usuário pode desativar esse campo. O usuário precisa ter permissão, e esse campo não pode estar desativado. |
canEnable |
Define se o usuário pode ativar este campo. O usuário precisa ter permissão, e esse campo precisa estar desativado. |
AppliedCapabilities
Os recursos relacionados a este campo nos metadados aplicados.
Representação JSON |
---|
{ "canRead": boolean, "canSearch": boolean, "canWrite": boolean } |
Campos | |
---|---|
canRead |
Define se o usuário pode ler os metadados aplicados relacionados aos itens. |
canSearch |
Define se o usuário pode pesquisar itens do Drive que façam referência a este campo. |
canWrite |
Define se o usuário pode definir este campo em itens do Drive. |
Métodos |
|
---|---|
|
Cria um novo rótulo. |
|
Exclui permanentemente um marcador e os metadados relacionados nos itens do Drive. |
|
Atualiza um único marcador aplicando um conjunto de solicitações de atualização, resultando em uma nova revisão de rascunho. |
|
Desativar um marcador publicado. |
|
Ativar e restaurar um identificador desativado para o estado publicado. |
|
Receba um rótulo pelo nome do recurso. |
|
Rótulos de lista. |
|
Publique todas as mudanças de rascunho no marcador. |
|
Atualiza o CopyMode de um marcador. |
|
Atualiza as permissões de um marcador. |