REST Resource: matters.holds

Zasób: Hold

Blokada. Blokada uniemożliwia określonej usłudze Google Workspace usunięcie danych z określonych kont lub ze wszystkich kont w jednostce organizacyjnej.

Aby korzystać z zasobów Vault, konto musi mieć wymagane uprawnienia Vault i dostęp do sprawy. Aby uzyskać dostęp do sprawy, konto musi być jej twórcą, musi mieć do niej dostęp 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, niezmienny identyfikator blokady. Przypisany podczas tworzenia.

name

string

Nazwa zablokowania.

updateTime

string (Timestamp format)

Data ostatniej modyfikacji tej blokady.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

accounts[]

object (HeldAccount)

Jeśli jest ustawiona, blokada dotyczy podanych kont, a pole orgUnit musi być puste.

orgUnit

object (HeldOrgUnit)

Jeśli jest ustawiona, blokada dotyczy wszystkich członków jednostki organizacyjnej, a konta muszą być puste. Ta właściwość może ulec zmianie. W przypadku blokad grupowych ustaw konta.

corpus

enum (CorpusType)

Usługa, w której mają być wyszukiwane dane.

query

object (CorpusQuery)

opcje związane z usługą. Jeśli jest ustawiona, wartość atrybutu CorpusQuery musi być zgodna z wartością atrybutu CorpusType.

HeldOrgUnit

Jednostka organizacyjna objęta blokadą. Ta struktura jest niezmienna.

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

string

Niezmienny identyfikator jednostki organizacyjnej podany przez pakiet Admin SDK.

holdTime

string (Timestamp format)

Data, od której jednostka organizacyjna jest objęta blokadą. Tej właściwości nie można zmienić.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

CorpusQuery

opcje dotyczące zablokowanych treści w ramach poszczególnych usług;

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 unii corpus_query. Jeśli jest ustawiony, musi być zgodny z typem usługi. corpus_query może być tylko jednym z tych elementów:
driveQuery

object (HeldDriveQuery)

Opcje dotyczące blokad na Dysku, które są specyficzne dla usługi. Jeśli jest ustawiony, wartość atrybutu CorpusType musi być równa DRIVE.

mailQuery

object (HeldMailQuery)

Opcje blokady Gmaila w zależności od usługi. Jeśli jest ustawiony, wartość atrybutu CorpusType musi być równa MAIL.

groupsQuery

object (HeldGroupsQuery)

Opcje dotyczące Grup dyskusyjnych w ramach poszczególnych usług. Jeśli jest ustawiony, wartość atrybutu CorpusType musi być równa GROUPS.

hangoutsChatQuery

object (HeldHangoutsChatQuery)

Opcje blokad czatu dotyczące konkretnej usługi. Jeśli jest ustawiony, wartość atrybutu CorpusType musi być HANGOUTS_CHAT.

voiceQuery

object (HeldVoiceQuery)

Opcje dotyczące Voice holds dla poszczególnych usług. Jeśli jest ustawiony, wartość atrybutu CorpusType musi być równa VOICE.

calendarQuery

object (HeldCalendarQuery)

Opcje dotyczące blokad w Kalendarzu w przypadku poszczególnych usług. Jeśli jest ustawiony, wartość atrybutu CorpusType musi być równa CALENDAR.

HeldDriveQuery

Opcje blokowania plików na Dysku.

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

boolean

Aby uwzględnić pliki na dyskach zespołowych w zawieszeniu, ustaw wartość na true.

includeSharedDriveFiles

boolean

Aby uwzględnić pliki na dyskach współdzielonych w zawieszeniu, ustaw wartość na true.

HeldMailQuery

Opcje zapytań dotyczących blokad Gmaila.

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

string

operatory wyszukiwania użyte do doprecyzowania wiadomości objętych blokadą.

startTime

string (Timestamp format)

Czas rozpoczęcia zapytania. Podaj czas w strefie GMT. Wartość jest zaokrąglana do godziny 00:00 w nocy określonej daty.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

Czas zakończenia zapytania. Podaj czas w strefie GMT. Wartość jest zaokrąglana do godziny 00:00 w nocy określonej daty.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

HeldGroupsQuery

Opcje zapytań dotyczące blokad grup.

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

string

operatory wyszukiwania użyte do doprecyzowania wiadomości objętych blokadą.

startTime

string (Timestamp format)

Czas rozpoczęcia zapytania. Podaj czas w strefie GMT. Wartość jest zaokrąglana do godziny 00:00 w nocy określonej daty.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

Czas zakończenia zapytania. Podaj czas w strefie GMT. Wartość jest zaokrąglana do godziny 00:00 w nocy określonej daty.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

HeldHangoutsChatQuery

Opcje blokad w Google Chat

Zapis JSON
{
  "includeRooms": boolean
}
Pola
includeRooms

boolean

Aby uwzględnić wiadomości z pokoi czatu, do których należał użytkownik, ustaw wartość na true.

HeldVoiceQuery

Opcje dotyczące wstrzymania połączeń głosowych.

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

enum (VoiceCoveredData)

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

HeldCalendarQuery

Ten typ nie ma pól.

Opcje wstrzymania w Kalendarzu.

Metody

addHeldAccounts

Dodawanie kont do blokady.

create

Tworzy blokadę w określonej sprawie.

delete

Usuwa określoną blokadę i odblokowuje konta lub jednostki organizacyjne objęte blokadą.

get

Pobiera wskazaną blokadę.

list

Wyświetla blokady w sprawie.

removeHeldAccounts

Zwalnia z blokady określone konta.

update

Zmienia zakres (jednostka organizacyjna lub konta) oraz parametry zapytania blokady.