Desativar, ativar e excluir um marcador

Este documento descreve como realizar estas tarefas envolvendo marcadores:

• Desativar um marcador
• Ativar um marcador
• Excluir um marcador

Desativar um marcador

A desativação de um marcador 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 marcador.

Depois de desativado, os usuários ainda podem aplicar esse marcador pela API Google Drive Labels. O marcador ainda aparece onde já foi aplicado e nos resultados da pesquisa. Um marcador desativado pode ser excluído.

Para desativar um marcador publicado, use o disable método no recurso labels.

Você também precisa especificar:

• Um recurso labels que representa o marcador. Ele contém um name e um id, que é um identificador globalmente exclusivo do marcador.

• O parâmetro de consulta useAdminAccess é definido como true para usar as credenciais de administrador do usuário. Antes de permitir o acesso, o servidor verifica se o usuário tem os privilégios de administrador "Gerenciar marcadores de classificação Labels " necessários.

O exemplo de código a seguir mostra como usar o id do marcador para desativar o marcador correto:

Python

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

Node.js

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

Substitua ID pelo ID do marcador a ser desativado.

O marcador tem o State de DISABLED e o ID de revisão do marcador é incrementado. Os usuários podem aplicar o marcador pela API Drive Labels. No entanto, um marcador desativado não é mostrado em uma interface, a menos que o showInApply campo do DisabledPolicy objeto esteja configurado.

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 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 marcador.

Para ativar um marcador desativado, use o enable método no recurso labels.

Você também precisa especificar:

• Um recurso labels que representa o marcador. Ele contém um name e um id, que é um identificador globalmente exclusivo do marcador.

• O parâmetro de consulta useAdminAccess é definido como true para usar as credenciais de administrador do usuário. Antes de permitir o acesso, o servidor verifica se o usuário tem os privilégios de administrador "Gerenciar marcadores de classificação Labels " necessários.

O exemplo de código a seguir mostra como usar o id do marcador para ativar o marcador correto:

Python

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

Node.js

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

Substitua ID pelo ID do marcador a ser ativado.

O marcador tem o State de PUBLISHED e o ID de revisão do marcador é incrementado. Os usuários podem visualizar e aplicar o marcador aos arquivos pela API Drive Labels.

Excluir um marcador

Somente marcadores de 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ídos e removidos dos arquivos do Drive permanentemente.

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

Você também precisa especificar:

• Um recurso labels que representa o marcador. Ele contém um name e um id, que é um identificador globalmente exclusivo do marcador.

• O parâmetro de consulta useAdminAccess é definido como true para usar as credenciais de administrador do usuário. Antes de permitir o acesso, o servidor verifica se o usuário tem os privilégios de administrador "Gerenciar marcadores de classificação Labels " necessários.

O exemplo de código a seguir mostra como usar o id do marcador para excluir o marcador correto:

Python

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

Node.js

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

Substitua ID pelo ID do marcador a ser excluído.

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