REST Resource: matters.holds

Ressource : Hold

Une obligation de conservation. Une obligation de conservation empêche le service Google Workspace spécifié de supprimer les données de comptes spécifiques ou de tous les membres d'une unité organisationnelle.

Pour travailler avec les ressources Vault, le compte doit disposer des droits Vault requis et avoir accès à l'affaire. Pour accéder à un litige, le compte doit l'avoir créé, l'avoir partagé avec lui ou disposer du droit Afficher tous les litiges.

Représentation JSON 
{
  "holdId": string,
  "name": string,
  "updateTime": string,
  "accounts": [
    {
      object (HeldAccount)
    }
  ],
  "orgUnit": {
    object (HeldOrgUnit)
  },
  "corpus": enum (CorpusType),
  "query": {
    object (CorpusQuery)
  }
}
Champs
holdId

string

Identifiant unique et immuable de la retenue. Attribué lors de la création.
name

string

Nom de l'obligation de conservation.
updateTime

string (Timestamp format)

Date de la dernière modification de cette retenue.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
accounts[]

object (HeldAccount)

Si elle est définie, l'obligation de conservation s'applique aux comptes spécifiés et orgUnit doit être vide.
orgUnit

object (HeldOrgUnit)

Si elle est définie, l'obligation de conservation s'applique à tous les membres de l'unité organisationnelle et le champ Comptes doit être vide. Cette propriété est modifiable. Pour les obligations de conservation appliquées aux groupes, définissez les comptes.
corpus

enum (CorpusType)

Service à rechercher.
query

object (CorpusQuery)

Options spécifiques au service. Si elle est définie, CorpusQuery doit correspondre à CorpusType.

HeldOrgUnit

Unité organisationnelle concernée par une obligation de conservation. Cette structure est immuable.

Représentation JSON 
{
  "orgUnitId": string,
  "holdTime": string
}
Champs
orgUnitId

string

ID immuable de l'unité organisationnelle fourni par le SDK Admin.
holdTime

string (Timestamp format)

Date à laquelle l'obligation de conservation a été appliquée à l'unité organisationnelle. Cette propriété est immuable.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

CorpusQuery

Options spécifiques aux services pour les reports.

Représentation JSON 
{

  "driveQuery": {
    object (HeldDriveQuery)
  },
  "mailQuery": {
    object (HeldMailQuery)
  },
  "groupsQuery": {
    object (HeldGroupsQuery)
  },
  "hangoutsChatQuery": {
    object (HeldHangoutsChatQuery)
  },
  "voiceQuery": {
    object (HeldVoiceQuery)
  },
  "calendarQuery": {
    object (HeldCalendarQuery)
  },
  "geminiQuery": {
    object (HeldGeminiQuery)
  }
}
Champs
Champ d'union corpus_query. Si cette valeur est définie, elle doit correspondre au type de service. corpus_query ne peut être qu'un des éléments suivants :
driveQuery

object (HeldDriveQuery)

Options spécifiques au service pour les suspensions Drive. Si elle est définie, CorpusType doit être DRIVE.
mailQuery

object (HeldMailQuery)

Options spécifiques au service pour les procédures de préservation à titre conservatoire Gmail. Si elle est définie, CorpusType doit être MAIL.
groupsQuery

object (HeldGroupsQuery)

Options spécifiques aux services pour les suspensions de groupes. Si elle est définie, CorpusType doit être GROUPS.
hangoutsChatQuery

object (HeldHangoutsChatQuery)

Options spécifiques au service pour les obligations de conservation Chat. Si la valeur est définie, CorpusType doit être HANGOUTS_CHAT.
voiceQuery

object (HeldVoiceQuery)

Options spécifiques au service pour les suspensions de compte Voice. Si elle est définie, CorpusType doit être VOICE.
calendarQuery

object (HeldCalendarQuery)

Options spécifiques au service pour les retenues dans Agenda. Si elle est définie, CorpusType doit être CALENDAR.
geminiQuery

object (HeldGeminiQuery)

Options spécifiques aux services pour les suspensions Gemini. Si elle est définie, CorpusType doit être GEMINI.

HeldDriveQuery

Options pour les obligations de conservation Drive.

Représentation JSON 
{
  "includeTeamDriveFiles": boolean,
  "includeSharedDriveFiles": boolean
}
Champs
includeTeamDriveFiles
(deprecated)

boolean

Définissez la valeur sur true pour inclure les fichiers des Drive d'équipe dans la conservation.
includeSharedDriveFiles

boolean

Définissez la valeur sur true pour inclure les fichiers des Drive partagés dans la conservation.

HeldMailQuery

Options de requête pour les procédures de préservation à titre conservatoire Gmail.

Représentation JSON 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Champs
terms

string

Les opérateurs de recherche utilisés pour affiner les messages couverts par l'obligation de conservation.
startTime

string (Timestamp format)

Heure de début de la requête. Spécifiez-le en GMT. La valeur est arrondie à minuit à la date spécifiée.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Heure de fin de la requête. Spécifiez-le en GMT. La valeur est arrondie à minuit à la date spécifiée.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

HeldGroupsQuery

Options de requête pour les procédures de préservation à titre conservatoire appliquées aux groupes.

Représentation JSON 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Champs
terms

string

Les opérateurs de recherche utilisés pour affiner les messages couverts par l'obligation de conservation.
startTime

string (Timestamp format)

Heure de début de la requête. Spécifiez-le en GMT. La valeur est arrondie à minuit à la date spécifiée.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Heure de fin de la requête. Spécifiez-le en GMT. La valeur est arrondie à minuit à la date spécifiée.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

HeldHangoutsChatQuery

Options pour les procédures de préservation à titre conservatoire dans Chat.

Représentation JSON 
{
  "includeRooms": boolean
}
Champs
includeRooms

boolean

Définissez la valeur sur true pour inclure les messages des espaces Chat dont l'utilisateur était membre.

HeldVoiceQuery

Options pour les mises en attente vocales.

Représentation JSON 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Champs
coveredData[]

enum (VoiceCoveredData)

Liste des types de données concernés par la conservation. Ne doit pas être vide. L'ordre n'a pas d'importance et les doublons sont ignorés.

HeldCalendarQuery

Ce type ne comporte aucun champ.

Options pour les réservations dans Agenda.

HeldGeminiQuery

Ce type ne comporte aucun champ.

Options pour les suspensions Gemini.

Méthodes

addHeldAccounts

 Ajoute des comptes à une obligation de conservation.

create

 Crée une obligation de conservation dans le litige spécifié.

delete

 Supprime l'obligation de conservation spécifiée et libère les comptes ou l'unité organisationnelle concernés.

get

 Récupère la retenue spécifiée.

list

 Répertorie les obligations de conservation dans un litige.

removeHeldAccounts

 Supprime les comptes spécifiés d'une procédure de préservation à titre conservatoire.

update

 Met à jour le champ d'application (unité organisationnelle ou comptes) et les paramètres de requête d'une obligation de conservation.