REST Resource: matters.holds

Ressource: Hold

Ein Hold. Ein Hold verhindert, dass der angegebene Google Workspace-Dienst Daten für bestimmte Konten oder alle Mitglieder einer Organisationseinheit dauerhaft löscht.

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 mit dem Konto erstellt oder für sie freigegeben sein oder über die Berechtigung Alle Rechtsangelegenheiten abrufen verfügen.

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 bei 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 einer Auflösung im Nanosekundenbereich 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 orgUnit muss leer sein.
orgUnit

object (HeldOrgUnit)

Wenn ein Hold festgelegt ist, gilt der Hold für alle Mitglieder der Organisationseinheit und Konten müssen leer sein. Dieses Attribut ist änderbar. 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 der 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)

Wann die Organisationseinheit auf „Hold“ gesetzt wurde. Diese Eigenschaft ist unveränderlich.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich 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)
  },
  "calendarQuery": {
    object (HeldCalendarQuery)
  }
  // End of list of possible types for union field corpus_query.
}
Felder
Union-Feld corpus_query. Wenn dieser Wert festgelegt ist, muss er mit dem Diensttyp übereinstimmen. 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 auf DRIVE gesetzt sein.
mailQuery

object (HeldMailQuery)

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

object (HeldGroupsQuery)

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

object (HeldHangoutsChatQuery)

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

object (HeldVoiceQuery)

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

object (HeldCalendarQuery)

Dienstspezifische Optionen für Kalender-Holds. Wenn festgelegt, muss CorpusType auf KALENDER festgelegt sein.

HeldDriveQuery

Optionen für Drive-Holds.

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

boolean

Wenn Sie Dateien aus Teamablagen in den Hold aufnehmen möchten, legen Sie den Wert auf true fest.
includeSharedDriveFiles

boolean

Wenn Sie Dateien aus geteilten Ablagen in den Hold aufnehmen möchten, 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, die vom Hold abgedeckt werden.
startTime

string (Timestamp format)

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

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

string (Timestamp format)

Die Endzeit der Abfrage. Geben Sie dies in GMT an. Der Wert wird am angegebenen Datum auf 12 Uhr gerundet.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich 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, die vom Hold abgedeckt werden.
startTime

string (Timestamp format)

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

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

string (Timestamp format)

Die Endzeit der Abfrage. Geben Sie dies in GMT an. Der Wert wird am angegebenen Datum auf 12 Uhr gerundet.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich 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

Legen Sie für den Wert true fest, wenn Nachrichten in Chatbereichen angezeigt werden sollen, in denen der Nutzer Mitglied war.

HeldVoiceQuery

Optionen für Holds in Google Voice.

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

enum (VoiceCoveredData)

Eine Liste der vom Hold abgedeckten Datentypen. Sollte nicht leer sein. Die Reihenfolge spielt keine Rolle und Duplikate werden ignoriert.

HeldCalendarQuery

Dieser Typ hat keine Felder.

Optionen für Kalender-Holds.

Methoden

addHeldAccounts

 Damit werden Konten zu einem Hold hinzugefügt.

create

 Erstellt einen Hold in der angegebenen Rechtsangelegenheit.

delete

 Der angegebene Hold wird entfernt und die Konten oder die Organisationseinheit, die vom Hold betroffen sind, werden freigegeben.

get

 Ruft den angegebenen Hold 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 Abfrageparameter eines Holds.