Desativar, ativar e excluir um rótulo

Nesta página, descrevemos como realizar estas tarefas envolvendo rótulos:

• Desativar um rótulo
• Ativar um rótulo
• Excluir um rótulo

Desativar um rótulo

A desativação de um rótulo resulta em uma nova revisão publicada desativada com base na revisão publicada atual. Se houver uma revisão de rascunho, uma nova revisão de rascunho desativada será criada com base na revisão de rascunho mais recente. As revisões de rascunho mais antigas são excluídas. Para mais informações, consulte Ciclo de vida do rótulo.

Depois de desativado, os usuários ainda podem aplicar esse rótulo pela API. O rótulo ainda aparece nos locais em que já foi aplicado e nos resultados da pesquisa. Um rótulo desativado pode ser excluído.

Para desativar um rótulo publicado, use o disable método na labels coleção.

Você também precisa especificar:

• Um recurso de rótulo que representa cada rótulo. Ele contém um Name e um ID de recurso, que é um identificador globalmente exclusivo para o rótulo.

• useAdminAccess é true para usar as credenciais de administrador do usuário. O servidor verifica se o usuário é um administrador do rótulo antes de permitir o acesso.

Este exemplo usa o ID para desativar o rótulo correto.

Python

service.labels().disable(
name='labels/ID',
body={
  'use_admin_access': True
}).execute()

Node.js

service.labels.disable({
  'resource': {
    'use_admin_access': true
},
'name': 'labels/ID'
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

O rótulo tem o State de DISABLED e o ID da revisão do rótulo é incrementado. Os usuários podem aplicar o rótulo pela API. No entanto, um rótulo desativado não é mostrado em uma interface, a menos que a showInApply propriedade do disabledPolicy método esteja configurada.

Ativar um rótulo

A ativação de um rótulo desativado restaura o estado publicado. Isso resulta em uma nova revisão publicada com base na revisão publicada desativada atual. Se houver uma revisão de rascunho desativada, uma nova revisão será criada com base nesse rascunho e ativada. Para mais informações, consulte Ciclo de vida do rótulo.

Para ativar um rótulo desativado, use o enable método.

Você também precisa especificar:

• Um recurso de rótulo que representa cada rótulo. Ele contém um Name e um ID de recurso, que é um identificador globalmente exclusivo para o rótulo.

• useAdminAccess é true para usar as credenciais de administrador do usuário. O servidor verifica se o usuário é um administrador do rótulo antes de permitir o acesso.

Este exemplo usa o ID para ativar o rótulo correto.

Python

service.labels().enable(
name='labels/ID',
body={
  'use_admin_access': True
}).execute()

Node.js

service.labels.enable({
  'resource': {
    'use_admin_access': true
},
'name': 'labels/ID'
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

O rótulo tem o State de PUBLISHED e o ID da revisão do rótulo é incrementado. Os usuários podem visualizar e aplicar o rótulo aos arquivos pela API.

Excluir um rótulo

Somente rótulos de rascunho e desativados podem ser excluídos. Quando um rótulo é excluído, todas as instâncias em que ele foi aplicado antes, inclusive os valores de campo correspondentes digitados pelos usuários, são excluídos e removidos dos arquivos do Drive permanentemente.

Para excluir um rótulo, primeiro é preciso desativá-lo e usar o delete método.

Você também precisa especificar:

• Um recurso de rótulo que representa cada rótulo. Ele contém um Name e um ID de recurso, que é um identificador globalmente exclusivo para o rótulo.

• useAdminAccess é true para usar as credenciais de administrador do usuário. O servidor verifica se o usuário é um administrador do rótulo antes de permitir o acesso.

Este exemplo usa o ID para excluir o rótulo correto.

Python

response = service.labels().delete(
  name='labels/ID',
  useAdminAccess=True).execute()

Node.js

service.labels.delete({
  'name': 'labels/ID',
  'use_admin_access': true
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

O rótulo tem o State de DELETED e o ID da revisão do rótulo é incrementado. O rótulo não pode ser aplicado, e os rótulos excluídos são removidos. Para mais informações, consulte Ciclo de vida do rótulo.