REST Resource: matters.holds

Ressource: Warteschleife

Eine Vorautorisierung. Mit einem Hold wird verhindert, dass der angegebene Google Workspace-Dienst Daten für bestimmte Konten oder alle Mitglieder einer Organisationseinheit löscht.

Damit das Konto mit Vault-Ressourcen arbeiten kann, muss es die erforderlichen Vault-Berechtigungen haben und Zugriff auf die Angelegenheit haben. Um auf eine Rechtsangelegenheit zugreifen zu können, muss das Konto die Rechtsangelegenheit erstellt oder die Rechtsangelegenheit für das Konto freigegeben worden sein oder der Nutzer 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 Vorautorisierung. Wird bei der Erstellung zugewiesen.
name

string

Der Name der Vorautorisierung.
updateTime

string (Timestamp format)

Das Datum und die Uhrzeit der letzten Änderung dieser Vorautorisierung.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. 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 die Vorautorisierung für die angegebenen Konten und orgUnit muss leer sein.
orgUnit

object (HeldOrgUnit)

Wenn diese Option festgelegt ist, gilt der Hold für alle Mitglieder der Organisationseinheit und accounts muss leer sein. Diese Property ist änderbar. Wählen Sie für Gruppen-Holds Konten aus.
corpus

enum (CorpusType)

Der zu durchsuchende Dienst.
query

object (CorpusQuery)

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

HeldOrgUnit

Die Organisationseinheit, auf die eine Vorabankündigung angewendet wird. 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.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. 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 Vormerkungen.

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 festgelegt, muss dieser mit dem Dienstleistungstyp übereinstimmen. Für corpus_query ist nur einer der folgenden Werte zulässig:
driveQuery

object (HeldDriveQuery)

Dienstspezifische Optionen für Drive-Sperrungen 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 Gruppenbereiche bleiben bestehen. 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.

HeldDriveQuery

Optionen für Holds in Google Drive

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

boolean

Wenn Dateien in Teambereichen in die Sperrung eingeschlossen werden sollen, setzen Sie true.
includeSharedDriveFiles

boolean

Wenn Dateien in geteilten Ablagen in die Sperrung eingeschlossen werden sollen, legen Sie true fest.

HeldMailQuery

Abfrageoptionen für Gmail-Holds

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

string

Die Suchoperatoren, mit denen die Nachrichten, die von der Sperrung betroffen sind, eingegrenzt werden.
startTime

string (Timestamp format)

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

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. 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 der Abfrage. Geben Sie die Zeit in GMT an. Der Wert wird auf 00:00 Uhr des angegebenen Datums gerundet.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. 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 Nachrichten, die von der Sperrung betroffen sind, eingegrenzt werden.
startTime

string (Timestamp format)

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

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. 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 der Abfrage. Geben Sie die Zeit in GMT an. Der Wert wird auf 00:00 Uhr des angegebenen Datums gerundet.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

HeldHangoutsChatQuery

Optionen für Holds in Google Chat

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

boolean

Wenn Nachrichten aus Chatbereichen eingeschlossen werden sollen, in denen der Nutzer Mitglied war, setzen Sie true.

HeldVoiceQuery

Optionen für Voice-Holds

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

enum (VoiceCoveredData)

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

HeldCalendarQuery

Dieser Typ hat keine Felder.

Optionen für Kalenderreservierungen

Methoden

addHeldAccounts

 Konten zu einem Hold hinzufügen

create

 Hiermit wird ein Hold in der betreffenden Rechtsangelegenheit erstellt.

delete

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

get

 Ruft die angegebene Vorautorisierung ab.

list

 Hiermit werden die Holds in einer Rechtsangelegenheit aufgelistet.

removeHeldAccounts

 Entfernt die angegebenen Konten aus einer Sperre.

update

 Aktualisiert den Umfang (Organisationseinheit oder Konten) und die Abfrageparameter eines Holds.