REST Resource: matters.holds

Ressource: Hold

Ein Hold. Ein Hold verhindert, dass Daten für bestimmte Konten oder alle Mitglieder einer Organisationseinheit im angegebenen Google Workspace-Dienst gelöscht werden.

Damit ein Konto mit Vault-Ressourcen arbeiten kann, muss es die erforderlichen Vault-Berechtigungen und Zugriff auf die Rechtsangelegenheit haben. Damit auf eine Rechtsangelegenheit zugegriffen werden kann, muss das Konto die Rechtsangelegenheit erstellt haben, die Rechtsangelegenheit muss für das Konto freigegeben worden sein oder das Konto muss 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 der Zurückstellung. Wird bei der Erstellung zugewiesen.
name

string

Der Name der Zurückstellung.
updateTime

string (Timestamp format)

Der Zeitpunkt der letzten Änderung dieser Zurückstellung.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
accounts[]

object (HeldAccount)

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

object (HeldOrgUnit)

Wenn der Hold festgelegt ist, gilt er für alle Mitglieder der Organisationseinheit und Konten müssen leer sein. Dieses Attribut ist änderbar. Legen Sie für Gruppen-Holds accounts fest.
corpus

enum (CorpusType)

Der Dienst, in dem gesucht werden soll.
query

object (CorpusQuery)

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

HeldOrgUnit

Die Organisationseinheit, für die eine Aufbewahrungspflicht gilt. Diese Struktur ist unveränderlich.

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

string

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

string (Timestamp format)

Wann die Organisationseinheit auf „Hold“ gesetzt wurde. Dieses Attribut ist unveränderlich.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

CorpusQuery

Dienstspezifische Optionen für Zurückbehaltungen.

JSON-Darstellung 
{

  "driveQuery": {
    object (HeldDriveQuery)
  },
  "mailQuery": {
    object (HeldMailQuery)
  },
  "groupsQuery": {
    object (HeldGroupsQuery)
  },
  "hangoutsChatQuery": {
    object (HeldHangoutsChatQuery)
  },
  "voiceQuery": {
    object (HeldVoiceQuery)
  },
  "calendarQuery": {
    object (HeldCalendarQuery)
  },
  "geminiQuery": {
    object (HeldGeminiQuery)
  }
}
Felder
Union-Feld corpus_query. Wenn festgelegt, muss dieser Wert mit dem Diensttyp übereinstimmen. Für corpus_query ist nur einer der folgenden Werte zulässig:
driveQuery

object (HeldDriveQuery)

Dienstspezifische Optionen für Drive-Sperren. Wenn festgelegt, muss CorpusType DRIVE sein.
mailQuery

object (HeldMailQuery)

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

object (HeldGroupsQuery)

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

object (HeldHangoutsChatQuery)

Dienstspezifische Optionen für Chat-Holds. Wenn festgelegt, muss CorpusType HANGOUTS_CHAT sein.
voiceQuery

object (HeldVoiceQuery)

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

object (HeldCalendarQuery)

Dienstspezifische Optionen für Kalenderreservierungen. Wenn festgelegt, muss CorpusType CALENDAR sein.
geminiQuery

object (HeldGeminiQuery)

Dienstspezifische Optionen für Gemini-Sperren. Wenn festgelegt, muss CorpusType GEMINI sein.

HeldDriveQuery

Optionen für Holds in Google Drive.

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

boolean

Wenn Sie Dateien in Teamablagen in die Aufbewahrungspflicht einbeziehen möchten, setzen Sie den Wert auf true.
includeSharedDriveFiles

boolean

Wenn Dateien in geteilten Ablagen in der Aufbewahrungspflicht enthalten sein sollen, legen Sie den Wert auf true fest.

HeldMailQuery

Abfrageoptionen für Gmail-Holds.

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

string

Die Suchoperatoren, mit denen die von der Aufbewahrungspflicht abgedeckten Nachrichten eingegrenzt werden.
startTime

string (Timestamp format)

Die Startzeit der Abfrage. Geben Sie die Zeit in GMT an. Der Wert wird auf 00:00 Uhr des angegebenen Datums gerundet.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Die Endzeit für die Abfrage. Geben Sie die Zeit in GMT an. Der Wert wird auf 00:00 Uhr des angegebenen Datums gerundet.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

HeldGroupsQuery

Abfrageoptionen für Gruppen-Holds.

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

string

Die Suchoperatoren, mit denen die von der Aufbewahrungspflicht abgedeckten Nachrichten eingegrenzt werden.
startTime

string (Timestamp format)

Die Startzeit der Abfrage. Geben Sie die Zeit in GMT an. Der Wert wird auf 00:00 Uhr des angegebenen Datums gerundet.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Die Endzeit für die Abfrage. Geben Sie die Zeit in GMT an. Der Wert wird auf 00:00 Uhr des angegebenen Datums gerundet.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

HeldHangoutsChatQuery

Optionen für Chat-Holds.

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

boolean

Auf true setzen, um Nachrichten in Chatbereichen einzuschließen, in denen der Nutzer Mitglied war.

HeldVoiceQuery

Optionen für Voice-Holds.

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

enum (VoiceCoveredData)

Eine Liste der Datentypen, die vom Hold abgedeckt werden. Darf nicht leer sein. Die Reihenfolge spielt keine Rolle und Duplikate werden ignoriert.

HeldCalendarQuery

Dieser Typ hat keine Felder.

Optionen für Kalenderreservierungen.

HeldGeminiQuery

Dieser Typ hat keine Felder.

Optionen für Gemini-Sperren

Methoden

addHeldAccounts

 Fügt Konten einem Hold hinzu.

create

 Hiermit wird ein Hold in der angegebenen Rechtsangelegenheit erstellt.

delete

 Entfernt den angegebenen Hold und gibt die Konten oder Organisationseinheiten frei, für die der Hold gilt.

get

 Ruft die angegebene Zurückstellung ab.

list

 Listet die Holds in einer Rechtsangelegenheit auf.

removeHeldAccounts

 Entfernt die angegebenen Konten aus einem Hold.

update

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