Gerenciar retenções

As retenções preservam os dados por tempo indeterminado para cumprir as obrigações legais ou de preservação. Geralmente, as guardas de documentos são aplicadas a um ou mais usuários para garantir que os dados potencialmente relevantes não sejam excluídos até que o caso não esteja mais ativo.

Se um usuário sujeito a uma guarda de documentos excluir os dados retidos, eles serão removidos da visualização do usuário, mas serão preservados no Vault. Enquanto a guarda de documentos estiver em vigor, um administrador do Vault poderá pesquisar e exportar esses dados.

As retenções têm os seguintes componentes:

• Um serviço: o aplicativo responsável pelos dados que serão retidos. O serviço pode ser definido como "E-mail", "Drive" ou "Grupos".
• Um escopo: as entidades cobertas pela guarda de documentos. O escopo pode ser definido como uma ou mais contas de usuário ou como uma unidade organizacional.
• Opções adicionais (opcional): os detalhes específicos (consultas de pesquisa ou opções de configuração) usados para restringir os dados que serão retidos no escopo definido. As opções incluem:
  • e-mail, Grupos: consulta de pesquisa para restringir a guarda de documentos
  • Drive: inclui os drives compartilhados na guarda de documentos

Para usar os recursos do Vault, a conta precisa ter os privilégios necessários do Vault e o acesso ao caso. Para acessar um caso, a conta precisa ter criado o caso, ter o caso compartilhado com ele ou ter o privilégio Ver todos os casos.

Observação: antes de criar uma guarda de documentos, você precisa ter um caso.

Criar uma guarda de documentos para e-mails de contas de usuários específicas com uma consulta de pesquisa

O exemplo a seguir mostra como uma retenção chamada "Minhas primeiras contas de e-mail retidas" é criada para:

• Serviço: mail
• Entidade: contas de usuário "user1" e "user2"
• Outras opções: consulta de pesquisa "to:[e-mail]"

Recupere IDs de contas de usuários de AdminSdk. Observe que a HeldAccount pode receber o ID da conta ou o e-mail. Se ambos forem fornecidos, o e-mail será usado e o ID da conta será ignorado.

Java

HeldMailQuery mailQuery = new HeldMailQuery().setTerms("to:[e-mail]");
List accounts = Lists.newArrayList();
accounts.add(new HeldAccount().setAccountId(user1accountId));
accounts.add(new HeldAccount().setEmail(user2Email));
Hold hold = new Hold()
    .setName("My First mail Accounts Hold")
    .setCorpus("MAIL");
    .setQuery(new CorpusQuery().setMailQuery(mailQuery))
    .setAccounts(accounts);
Hold createdHold = client.matters().holds().create(matterId, hold).execute();
  

Python

def create_hold_mail_accounts(service, matter_id, account_id):
    mail_query = {'terms': 'to:[e-mail]'}
    accounts = [
        {'accountId': user1_account_id},
        {'email': user2_email}
    ]
    wanted_hold = {
        'name': 'My First mail Accounts Hold',
        'corpus': 'MAIL',
        'query': {
            'mailQuery': mail_query
        },
        'accounts': accounts
    }
    return service.matters().holds().create(
        matterId=matter_id, body=wanted_hold).execute()

Crie uma guarda de documentos para o Drive em uma unidade organizacional e inclua o conteúdo do drive compartilhado

O exemplo a seguir mostra como uma guarda de documentos chamada "My First Drive OU Hold" é criada para:

• Serviço: Drive
• Entidade: unidade organizacional "Finanças" (o ID da UO é capturado em orgUnitId)
• Outras opções: incluir drives compartilhados de que os usuários nesta unidade organizacional fazem parte.

Recupere IDs de UO em AdminSdk.

Java

HeldOrgUnit orgUnit = new HeldOrgUnit().setOrgUnitId(orgUnitId);
// Include shared drives content.
HeldDriveQuery driveQuery = new HeldDriveQuery().setIncludeSharedDriveFiles(true);
// Create the hold.
Hold hold = new Hold()
    .setName("My First Drive OU Hold")
    .setCorpus("DRIVE")
    .setQuery(new CorpusQuery().setDriveQuery(driveQuery))
    .setOrgUnit(orgUnit);
Hold createdHold = client.matters().holds().create(matterId, hold).execute();
return createdHold;

Python

def create_hold_drive_org(service, matter_id, org_unit_id):
    drive_query = {'includeSharedDriveFiles': True}
    org_unit = {'orgUnitId': org_unit_id}
    wanted_hold = {
        'name': 'My First Drive OU Hold',
        'corpus': 'DRIVE',
        'orgUnit': org_unit,
        'query': {
            'driveQuery': drive_query
        }
    }
    return service.matters().holds().create(
        matterId=matter_id, body=wanted_hold).execute()

Criar uma guarda de documentos para Grupos em contas de grupo específicas com período

O exemplo a seguir mostra como uma retenção chamada "Minha primeira guarda de grupo" é criada para:

• Serviço: grupos
• Entidade: contas "group1" e "group2"
• Outras opções: reter apenas mensagens com datas de envio entre "startTime" e "endTime"

Recupere IDs de contas de grupos do AdminSdk.

Java

String APRIL_2_2017_GMT = "2017-04-02T00:00:00Z"; // See below for format*.
 
List accounts = Lists.newArrayList();
accounts.add(new HeldAccount().setAccountId(accountId));
accounts.add(new HeldAccount().setAccountId(accountId2));
HeldGroupsQuery groupQuery = new HeldGroupsQuery();
// Restrict by sent date.
groupQuery.setStartTime(APRIL_2_2017_GMT);
groupQuery.setEndTime(APRIL_2_2017_GMT);
// create the hold
Hold hold = new Hold()
    .setName("My First Group Hold")
    .setCorpus("GROUPS")
    .setQuery(new CorpusQuery().setGroupsQuery(groupQuery));
    hold.setAccounts(accounts);
Hold createdHold = client.matters().holds().create(matterId, hold).execute();
 

Python

def create_hold_groups_date_range(service, matter_id, group_account_id):
    groups_query = {
        'startTime': '2017-04-02T00:00:00Z', # See below for format*
        'endTime': '2017-04-02T00:00:00Z'
    }
    accounts = [{'accountId': group_account_id}]
    wanted_hold = {
        'name': 'My First Group Hold',
        'corpus': 'GROUPS',
        'query': {
            'groupsQuery': groups_query
        },
        'accounts': accounts
    }
    return service.matters().holds().create(
        matterId=matter_id, body=wanted_hold).execute()
 

• Formato do carimbo de data/hora. Além disso, start/endTimes são convertidos para GMT e arredondados para o início da data especificada.

Consultar e modificar guardas de documentos atuais

O exemplo a seguir mostra como listar todas as contas incluídas em uma guarda de documentos:

Java

client.matters().holds().accounts().list(matterId, holdId).execute().getAccounts();

Python

# If no accounts are on hold, ['accounts'] will raise an error.
def list_held_accounts(service, matter_id, hold_id):
    return service.matters().holds().accounts().list(
        matterId=matter_id, holdId=hold_id).execute()['accounts'] 

O exemplo a seguir mostra como adicionar e remover uma conta de uma guarda de documentos:

Java

// Add an account by id.
client
        .matters()
        .holds()
        .accounts()
        .create(matterId, holdId, new HeldAccount().setAccountId(accountId))
        .execute();
// Remove an account by id.
client.matters().holds().accounts().delete(matterId, holdId, accountId).execute();

String email = "[e-mail]";
// Add an account by email.
client
        .matters()
        .holds()
        .accounts()
        .create(matterId, holdId, new HeldAccount().setEmail(email))
        .execute();

Python

 
def add_held_account(service, matter_id, hold_id, account_id):
    held_account = {'accountId': account_id}
    return service.matters().holds().accounts().create(
        matterId=matter_id, holdId=hold_id, body=held_account).execute()

def remove_held_account(service, matter_id, hold_id, account_id):
    return service.matters().holds().accounts().delete(
        matterId=matter_id, holdId=hold_id, accountId=account_id).execute()

def add_held_account(service, matter_id, hold_id, email):
    held_account = {'email': email}
    return service.matters().holds().accounts().create(
        matterId=matter_id, holdId=hold_id, body=held_account).execute()
 

O exemplo abaixo mostra como modificar a UO em uma UO existente:

Java

Hold hold = client.matters().holds().get(matterId, holdId).execute();
hold.getOrgUnit().setOrgUnitId(newOrgUnitId);
Hold modifiedHold = client.matters().holds().update(matterId, holdId, hold).execute();
return modifiedHold;
 

Python

def update_hold_ou(service, matter_id, hold_id, org_unit_id):
    current_hold = get_hold(matter_id, hold_id)
    current_hold['orgUnit'] = {'orgUnitId': org_unit_id}
    return service.matters().holds().update(
        matterId=matter_id, holdId=hold_id, body=current_hold).execute() 

O exemplo a seguir mostra como listar todas as guardas de documentos de um caso:

Java

 
String matterId = "Matter Id";


// List all holds.
List holdsList = 
    client.matters().holds().list(matterId).execute().getHolds();

// Paginate on holds.
ListHoldsResponse response = client
        .matters()
        .holds()
        .list(matterId)
        .setPageSize(10)
        .execute();

String nextPageToken = response.getNextPageToken();
if (nextPageToken != null) {
    client
        .matters()
        .holds()
        .list(matterId)
        .setPageSize(10)
        .setPageToken(nextPageToken)
        .execute();
}
  

Python

# This can paginate in the same manner as with matters.
def list_holds(service, matter_id):
    return service.matters().holds().list(matterId=matter_id).execute()