Desativar, ativar e excluir um rótulo

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

• Desativar um marcador
• Ativar um marcador
• Excluir etiqueta

Desativar um marcador

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 rótulo pela API. O marcador 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 método disable na coleção labels.

Você também precisa especificar:

• Um recurso de rótulo que representa todos os rótulos. 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 marcador antes de permitir o acesso.

Neste exemplo, usamos 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 de 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 propriedade showInApply do método disabledPolicy esteja configurada.

Ativar um marcador

Ao ativar um rótulo desativado, ele é restaurado ao 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 será ativada. Para mais informações, consulte Ciclo de vida do rótulo.

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

Você também precisa especificar:

• Um recurso de rótulo que representa todos os rótulos. 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 marcador antes de permitir o acesso.

Neste exemplo, usamos 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 visualizar e aplicar o marcador aos arquivos usando a API.

Excluir etiqueta

Somente rótulos em rascunho e desativados podem ser excluídos. Quando um marcador é 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ídas e removidas dos arquivos do Drive permanentemente.

Para excluir um marcador, primeiro desative-o e use o método delete.

Você também precisa especificar:

• Um recurso de rótulo que representa todos os rótulos. 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 marcador 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 de revisão do rótulo é incrementado. O marcador não pode ser aplicado, e os marcadores excluídos são removidos com o tempo. Para mais informações, consulte Ciclo de vida do rótulo.