REST Resource: matters.holds

Zasób: wstrzymany

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 można było korzystać z zasobów Vault, konto musi mieć wymagane uprawnienia w Vault i dostęp do sprawy. Aby uzyskać dostęp do sprawy, użytkownik konta musi utworzyć tę sprawę, udostępnić ją osobie lub mieć uprawnienie do wyświetlania 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)

Ostatnia modyfikacja 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 zostanie ustawiona, blokada będzie stosowana do określonych kont, a orgUnit musi być pusta.

orgUnit

object (HeldOrgUnit)

Jeśli blokada zostanie skonfigurowana, blokada będzie dotyczyła wszystkich członków jednostki organizacyjnej, a konta muszą być puste. Tę właściwość można zmieniać. W przypadku blokad w Grupach dyskusyjnych ustaw konta.

corpus

enum (CorpusType)

Usługa, która ma zostać przeszukana.

query

object (CorpusQuery)

Opcje dotyczące poszczególnych usług. Jeśli jest ustawiona, CorpusQuery musi pasować do typu CorpusType.

HeldOrgUnit

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

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

string

Stały identyfikator jednostki organizacyjnej podany w pakiecie Admin SDK.

holdTime

string (Timestamp format)

Kiedy jednostka organizacyjna była objęta blokadą. 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 poszczególnymi 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)
  },
  "calendarQuery": {
    object (HeldCalendarQuery)
  }
  // End of list of possible types for union field corpus_query.
}
Pola
Pole sumy corpus_query. Jeśli jest ustawione, wartość musi pasować do typu usługi. corpus_query może mieć tylko jedną z tych wartości:
driveQuery

object (HeldDriveQuery)

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

mailQuery

object (HeldMailQuery)

Opcje blokad Gmaila związane z poszczególnymi usługami. Jeśli jest ustawiona, CorpusType musi mieć wartość MAIL.

groupsQuery

object (HeldGroupsQuery)

Opcje blokad grup dotyczące poszczególnych usług. Jeśli jest ustawiona, CorpusType musi mieć wartość GROUPS.

hangoutsChatQuery

object (HeldHangoutsChatQuery)

Opcje blokad w Google Chat w poszczególnych usługach. Jeśli jest ustawiona, CorpusType musi mieć wartość HANGOUTS_CHAT.

voiceQuery

object (HeldVoiceQuery)

Opcje blokad w Voice specyficzne dla usług. Jeśli jest ustawiona, CorpusType musi mieć wartość VOICE.

calendarQuery

object (HeldCalendarQuery)

Opcje blokad Kalendarza związane z poszczególnymi usługami. Jeśli jest ustawiona, CorpusType musi mieć wartość KALENDARZ.

HeldDriveQuery

Opcje blokad na Dysku.

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

boolean

Aby objąć blokadą pliki z dysków zespołu, ustaw wartość true (prawda).

includeSharedDriveFiles

boolean

Aby objąć blokadą pliki znajdujące się na dyskach współdzielonych, ustaw wartość true (prawda).

HeldMailQuery

Opcje zapytań dotyczących blokad Gmaila.

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

string

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

startTime

string (Timestamp format)

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

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 do godziny 00:00 w wybranym dniu.

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 używane do zawężania zakresu wiadomości objętych blokadą.

startTime

string (Timestamp format)

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

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 do godziny 00:00 w wybranym dniu.

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 Google Chat.

Zapis JSON
{
  "includeRooms": boolean
}
Pola
includeRooms

boolean

Aby uwzględnić wiadomości z pokoi czatu, których użytkownik był członkiem, 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.

HeldCalendarQuery

Ten typ nie zawiera pól.

Opcje blokad Kalendarza.

Metody

addHeldAccounts

Dodaje konta do blokady.

create

Nakłada blokadę w określonej sprawie.

delete

spowoduje usunięcie określonej blokady i zwolnienie kont lub jednostek organizacyjnych objętych blokadą.

get

Pobiera określoną blokadę.

list

Wyświetla listę blokad związanych ze sprawą.

removeHeldAccounts

Powoduje usunięcie określonych kont z blokady.

update

Aktualizuje zakres (jednostkę organizacyjną lub konta) oraz parametry zapytania blokady.