Desativar, ativar e excluir um rótulo

Nesta página, descrevemos como executar essas tarefas que envolvem rótulos:

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

Desativar um rótulo

Desativar 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 marcador pela API. O rótulo ainda vai aparecer onde já foi aplicado e nos resultados da pesquisa. Um rótulo desativado pode ser excluído.

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

Também é necessário especificar:

  • Um recurso Rótulo que representa cada rótulo. Ele contém um recurso Name e ID, que é um identificador globalmente exclusivo do 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.

Neste exemplo, o ID é usado 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 de revisão do rótulo é incrementado. Os usuários podem aplicar o rótulo usando a API. No entanto, um rótulo desativado não é mostrado em uma interface, a menos que a propriedade showInApply do método disabledPolicy esteja configurada.

Ativar um marcador

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

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

Também é necessário especificar:

  • Um recurso Rótulo que representa cada rótulo. Ele contém um recurso Name e ID, que é um identificador globalmente exclusivo do 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 de revisão do rótulo é incrementado. Os usuários podem ver e aplicar o marcador aos arquivos usando a API.

Excluir um rótulo

Somente marcadores de rascunho e desativados podem ser excluídos. Quando um marcador é excluído, todas as instâncias em que ele foi aplicado, incluindo os valores de campo correspondentes inseridos pelos usuários, são excluídos e removidos permanentemente desses arquivos do Drive.

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

Também é necessário especificar:

  • Um recurso Rótulo que representa cada rótulo. Ele contém um recurso Name e ID, que é um identificador globalmente exclusivo do 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.

Neste exemplo, o ID é usado 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 de revisão do rótulo é incrementado. Não é possível aplicar o rótulo, e os rótulos excluídos são limpos em algum momento. Para mais informações, consulte Ciclo de vida do rótulo.