REST Resource: matters.holds

Zasób: Wstrzymane

Blokada. Blokada uniemożliwia określonej usłudze Google Workspace trwałe usunięcie danych z określonych kont lub wszystkich członków jednostki organizacyjnej.

Aby móc korzystać z zasobów Vault, konto musi mieć wymagane uprawnienia w Vault i dostęp do sprawy. Aby uzyskać dostęp do sprawy, konto musi utworzyć sprawę, udostępnić ją lub mieć uprawnienie Wyświetlanie wszystkich spraw.

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

string

Unikalny, stały identyfikator blokady. Przypisana podczas tworzenia.

name

string

Nazwa blokady.

updateTime

string (Timestamp format)

Data ostatniej modyfikacji tej blokady.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

accounts[]

object (HeldAccount)

Jeśli jest skonfigurowana, blokada będzie stosowana do określonych kont, a orgUnit musi być pusta.

orgUnit

object (HeldOrgUnit)

Jeśli jest skonfigurowana, blokada obejmuje wszystkich członków jednostki organizacyjnej, a konta muszą być puste. Ta właściwość jest zmienna. W przypadku blokad w Grupach dyskusyjnych skonfiguruj konta.

corpus

enum (CorpusType)

Usługa do przeszukania.

query

object (CorpusQuery)

Opcje specyficzne dla danej usługi. Jeśli jest ustawiony, CorpusQuery musi pasować do CorpusType.

HeldOrgUnit

Jednostka organizacyjna objęta blokadą. Tej struktury nie można zmienić.

Zapis JSON
{
  "orgUnitId": string,
  "holdTime": string
}
Pola
orgUnitId

string

Niezmienny identyfikator jednostki organizacyjnej podany w pakiecie Admin SDK.

holdTime

string (Timestamp format)

Termin nałożenia blokady na jednostkę organizacyjną. Tej właściwości nie można zmienić.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

CorpusQuery

Opcje blokad związane z usługami.

Zapis JSON
{

  // 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.
}
Pola
Pole sumy corpus_query. Jeśli jest ustawiony, musi być zgodny z typem usługi. corpus_query może mieć tylko jedną z tych wartości:
driveQuery

object (HeldDriveQuery)

Opcje blokad na Dysku dotyczące poszczególnych usług. Jeśli jest ustawiony, CorpusType musi mieć wartość Drive.

mailQuery

object (HeldMailQuery)

Opcje blokad Gmaila dotyczące poszczególnych usług. Jeśli jest ustawiony, CorpusType musi mieć wartość MAIL.

groupsQuery

object (HeldGroupsQuery)

Opcje blokad Grup dyskusyjnych związane z poszczególnymi usługami. Jeśli jest ustawiony, CorpusType musi mieć wartość GROUPS.

hangoutsChatQuery

object (HeldHangoutsChatQuery)

Opcje blokad z Google Chat związane z poszczególnymi usługami. Jeśli jest ustawiony, CorpusType musi mieć wartość HANGOUTS_CHAT.

voiceQuery

object (HeldVoiceQuery)

Opcje blokad Voice w poszczególnych usługach. Jeśli jest ustawiony, CorpusType musi mieć wartość VOICE.

HeldDriveQuery

Opcje blokad na Dysku.

Zapis JSON
{
  "includeTeamDriveFiles": boolean,
  "includeSharedDriveFiles": boolean
}
Pola
includeTeamDriveFiles
(deprecated)

boolean

Aby objąć blokadą pliki z Dysku zespołu, ustaw wartość true.

includeSharedDriveFiles

boolean

Aby objąć blokadą pliki z dysków współdzielonych, ustaw wartość true.

HeldMailQuery

Opcje zapytań dotyczących blokad Gmaila.

Zapis JSON
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Pola
terms

string

Operatory wyszukiwania służące do zawężania zakresu wiadomości objętych blokadą.

startTime

string (Timestamp format)

Czas rozpoczęcia zapytania. Podaj czas GMT. Wartość jest zaokrąglana w określonym dniu do godziny 00:00.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Czas zakończenia zapytania. Podaj czas GMT. Wartość jest zaokrąglana w określonym dniu do godziny 00:00.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

HeldGroupsQuery

Opcje zapytań dotyczących blokad grup.

Zapis JSON
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Pola
terms

string

Operatory wyszukiwania służące do zawężania zakresu wiadomości objętych blokadą.

startTime

string (Timestamp format)

Czas rozpoczęcia zapytania. Podaj czas GMT. Wartość jest zaokrąglana w określonym dniu do godziny 00:00.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Czas zakończenia zapytania. Podaj czas GMT. Wartość jest zaokrąglana w określonym dniu do godziny 00:00.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

HeldHangoutsChatQuery

Opcje blokad z Google Chat.

Zapis JSON
{
  "includeRooms": boolean
}
Pola
includeRooms

boolean

Aby uwzględniać wiadomości w pokojach czatu, do których należy użytkownik, ustaw wartość true.

HeldVoiceQuery

Opcje blokad Voice.

Zapis JSON
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Pola
coveredData[]

enum (VoiceCoveredData)

Lista typów danych objętych blokadą. Pole nie może być puste. Kolejność nie ma znaczenia, a duplikaty są ignorowane.

Metody

addHeldAccounts

Dodaje konta do blokady.

create

Tworzy blokadę w określonej sprawie.

delete

Powoduje usunięcie określonej blokady i zwolnienie objętych nią kont lub jednostki organizacyjnej.

get

Pobiera określoną blokadę.

list

Wyświetla listę blokad w sprawie.

removeHeldAccounts

Powoduje usunięcie z blokady określonych kont.

update

Aktualizuje zakres (jednostki organizacyjne lub konta) i parametry zapytania blokady.