REST Resource: matters.holds

Ressource: Hold

Ein Hold. Durch einen Hold wird verhindert, dass über den angegebenen Google Workspace-Dienst Daten für bestimmte Konten oder alle Mitglieder einer Organisationseinheit dauerhaft gelöscht werden.

Damit Sie mit Vault-Ressourcen arbeiten können, muss das Konto die erforderlichen Vault-Berechtigungen und Zugriff auf die Rechtsangelegenheit haben. Damit Sie auf eine Rechtsangelegenheit zugreifen können, muss sie über das Konto erstellt worden sein, für die Rechtsangelegenheit freigegeben worden sein oder die Berechtigung Alle Rechtsangelegenheiten abrufen haben.

JSON-Darstellung 
{
  "holdId": string,
  "name": string,
  "updateTime": string,
  "accounts": [
    {
      object (HeldAccount)
    }
  ],
  "orgUnit": {
    object (HeldOrgUnit)
  },
  "corpus": enum (CorpusType),
  "query": {
    object (CorpusQuery)
  }
}
Felder
holdId

string

Die eindeutige unveränderliche ID des Holds. Wird während der Erstellung zugewiesen.
name

string

Der Name des Holds.
updateTime

string (Timestamp format)

Der Zeitpunkt, zu dem dieser Hold zuletzt geändert wurde.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
accounts[]

object (HeldAccount)

Wenn festgelegt, gilt der Hold für die angegebenen Konten und die orgUnit muss leer sein.
orgUnit

object (HeldOrgUnit)

Wenn festgelegt, gilt der Hold für alle Mitglieder der Organisationseinheit und die Konten müssen leer sein. Dieses Attribut kann geändert werden. Legen Sie für Google Groups-Holds Konten fest.
corpus

enum (CorpusType)

Der Dienst, nach dem gesucht werden soll.
query

object (CorpusQuery)

Dienstspezifische Optionen. Wenn festgelegt, muss CorpusQuery mit CorpusType übereinstimmen.

HeldOrgUnit

Die Organisationseinheit, für die ein Hold gilt. Diese Struktur ist unveränderlich.

JSON-Darstellung 
{
  "orgUnitId": string,
  "holdTime": string
}
Felder
orgUnitId

string

Die unveränderliche ID der Organisationseinheit, die vom Admin SDK bereitgestellt wird.
holdTime

string (Timestamp format)

Zeitpunkt, zu dem die Organisationseinheit auf „Hold“ gesetzt wurde. Dieses Attribut ist unveränderlich.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

CorpusQuery

Dienstspezifische Optionen für Holds.

JSON-Darstellung 
{

  // Union field corpus_query can be only one of the following:
  "driveQuery": {
    object (HeldDriveQuery)
  },
  "mailQuery": {
    object (HeldMailQuery)
  },
  "groupsQuery": {
    object (HeldGroupsQuery)
  },
  "hangoutsChatQuery": {
    object (HeldHangoutsChatQuery)
  },
  "voiceQuery": {
    object (HeldVoiceQuery)
  }
  // End of list of possible types for union field corpus_query.
}
Felder
Union-Feld corpus_query. Wenn festgelegt, muss dies dem Diensttyp entsprechen. Für corpus_query ist nur einer der folgenden Werte zulässig:
driveQuery

object (HeldDriveQuery)

Dienstspezifische Optionen für Drive-Holds. Wenn festgelegt, muss CorpusType den Wert DRIVE haben.
mailQuery

object (HeldMailQuery)

Dienstspezifische Optionen für Gmail-Holds. Wenn festgelegt, muss CorpusType MAIL sein.
groupsQuery

object (HeldGroupsQuery)

Dienstspezifische Optionen für Google Groups-Holds. Wenn festgelegt, muss CorpusType GROUPS sein.
hangoutsChatQuery

object (HeldHangoutsChatQuery)

Dienstspezifische Optionen für Chat-Holds. Wenn dieser Wert festgelegt ist, muss CorpusType den Wert HANGOUTS_CHAT haben.
voiceQuery

object (HeldVoiceQuery)

Dienstspezifische Optionen für Voice-Holds. Wenn festgelegt, muss CorpusType auf VOICE gesetzt sein.

HeldDriveQuery

Optionen für Drive-Holds.

JSON-Darstellung 
{
  "includeTeamDriveFiles": boolean,
  "includeSharedDriveFiles": boolean
}
Felder
includeTeamDriveFiles
(deprecated)

boolean

Wenn Sie Dateien aus geteilten Ablagen im Hold einschließen möchten, setzen Sie den Wert auf true.
includeSharedDriveFiles

boolean

Damit Dateien in geteilten Ablagen im Hold berücksichtigt werden, setzen Sie den Wert auf true.

HeldMailQuery

Abfrageoptionen für Gmail-Holds.

JSON-Darstellung 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Felder
terms

string

Die Suchoperatoren, mit denen die Nachrichten gefiltert werden, für die ein Hold gilt.
startTime

string (Timestamp format)

Die Startzeit für die Abfrage. Geben Sie GMT an. Der Wert wird am angegebenen Datum auf 00:00 Uhr gerundet.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Die Endzeit für die Abfrage. Geben Sie GMT an. Der Wert wird am angegebenen Datum auf 00:00 Uhr gerundet.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

HeldGroupsQuery

Abfrageoptionen für Gruppen-Holds.

JSON-Darstellung 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Felder
terms

string

Die Suchoperatoren, mit denen die Nachrichten gefiltert werden, für die ein Hold gilt.
startTime

string (Timestamp format)

Die Startzeit für die Abfrage. Geben Sie GMT an. Der Wert wird am angegebenen Datum auf 00:00 Uhr gerundet.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Die Endzeit für die Abfrage. Geben Sie GMT an. Der Wert wird am angegebenen Datum auf 00:00 Uhr gerundet.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

HeldHangoutsChatQuery

Optionen für Chat-Holds.

JSON-Darstellung 
{
  "includeRooms": boolean
}
Felder
includeRooms

boolean

Wenn Sie Nachrichten in Chatbereichen einschließen möchten, in denen der Nutzer Mitglied war, legen Sie den Wert auf true fest.

HeldVoiceQuery

Optionen für Voice-Holds.

JSON-Darstellung 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Felder
coveredData[]

enum (VoiceCoveredData)

Eine Liste der Datentypen, für die der Hold gilt. Sollte nicht leer sein. Die Reihenfolge ist unerheblich und Duplikate werden ignoriert.

Methoden

addHeldAccounts

 Fügt einem Hold Konten hinzu.

create

 Erstellt einen Hold in der angegebenen Rechtsangelegenheit.

delete

 Der angegebene Hold wird entfernt und die Konten oder die Organisationseinheit, für die er gilt, freigegeben.

get

 Ruft den angegebenen Hold ab.

list

 Hier werden die Holds für eine Rechtsangelegenheit aufgelistet.

removeHeldAccounts

 Die angegebenen Konten werden aus einem Hold entfernt.

update

 Aktualisiert den Geltungsbereich (Organisationseinheit oder Konten) und die Suchparameter eines Holds.