REST Resource: matters.holds

Zasób: Hold

blokadę, Blokada uniemożliwia określonej usłudze Google Workspace usunięcie danych z konkretnych kont lub 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ą, mieć ją udostępnioną 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 blokady.
updateTime

string (Timestamp format)

Ostatnia modyfikacja tego wstrzymania.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. 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 ta opcja jest ustawiona, blokada dotyczy określonych kont, a pole orgUnit musi być puste.
orgUnit

object (HeldOrgUnit)

Jeśli jest ustawiona, blokada dotyczy wszystkich członków jednostki organizacyjnej, a pole konta musi być puste. Tę właściwość można zmieniać. W przypadku blokad dotyczących Grup dyskusyjnych ustaw konta.
corpus

enum (CorpusType)

Usługa, w której ma być przeprowadzane wyszukiwanie.
query

object (CorpusQuery)

Opcje specyficzne dla usługi. Jeśli ten parametr jest ustawiony, CorpusQuery musi być zgodny z parametrem 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)

Kiedy jednostka organizacyjna została objęta blokadą. Tej właściwości nie można zmienić.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. 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 wstrzymania dotyczące konkretnych usług.

Zapis JSON 
{

  "driveQuery": {
    object (HeldDriveQuery)
  },
  "mailQuery": {
    object (HeldMailQuery)
  },
  "groupsQuery": {
    object (HeldGroupsQuery)
  },
  "hangoutsChatQuery": {
    object (HeldHangoutsChatQuery)
  },
  "voiceQuery": {
    object (HeldVoiceQuery)
  },
  "calendarQuery": {
    object (HeldCalendarQuery)
  },
  "geminiQuery": {
    object (HeldGeminiQuery)
  }
}
Pola
Pole zbiorcze corpus_query. Jeśli to pole jest ustawione, musi być zgodne z typem usługi. corpus_query może mieć tylko jedną z tych wartości:
driveQuery

object (HeldDriveQuery)

Opcje dotyczące zawieszeń Dysku specyficzne dla usługi. Jeśli jest ustawiony, atrybut CorpusType musi mieć wartość DRIVE.
mailQuery

object (HeldMailQuery)

Opcje blokad Gmaila dotyczące konkretnych usług. Jeśli jest ustawiony, atrybut CorpusType musi mieć wartość MAIL.
groupsQuery

object (HeldGroupsQuery)

Opcje dotyczące blokad w Grupach dyskusyjnych. Jeśli ten atrybut jest ustawiony, CorpusType musi mieć wartość GROUPS.
hangoutsChatQuery

object (HeldHangoutsChatQuery)

Opcje blokad dotyczące Google Chat. Jeśli ten parametr jest ustawiony, wartość CorpusType musi być równa HANGOUTS_CHAT.
voiceQuery

object (HeldVoiceQuery)

Opcje dotyczące wstrzymania połączenia w usłudze Voice. Jeśli ten parametr jest ustawiony, CorpusType musi mieć wartość VOICE.
calendarQuery

object (HeldCalendarQuery)

Opcje dotyczące rezerwacji w Kalendarzu. Jeśli jest ustawiony, atrybut CorpusType musi mieć wartość CALENDAR.
geminiQuery

object (HeldGeminiQuery)

Opcje dotyczące wstrzymania Gemini w poszczególnych usługach. Jeśli ten parametr jest ustawiony, CorpusType musi mieć wartość GEMINI.

HeldDriveQuery

Opcje blokad z Dysku.

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

boolean

Aby uwzględnić w zawieszeniu pliki z dysków zespołowych, ustaw wartość true.
includeSharedDriveFiles

boolean

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

HeldMailQuery

Opcje zapytań dotyczące 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 w GMT. Wartość jest zaokrąglana do godziny 00:00 w określonym dniu.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. 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 formacie GMT. Wartość jest zaokrąglana do godziny 00:00 w określonym dniu.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. 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 grupy.

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 formacie GMT. Wartość jest zaokrąglana do godziny 00:00 w określonym dniu.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. 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 formacie GMT. Wartość jest zaokrąglana do godziny 00:00 w określonym dniu.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. 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ść true.

HeldVoiceQuery

Opcje dotyczące wstrzymania głosu.

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

enum (VoiceCoveredData)

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

HeldCalendarQuery

Ten typ nie ma pól.

Opcje rezerwacji w Kalendarzu.

HeldGeminiQuery

Ten typ nie ma pól.

Opcje dotyczące blokad Gemini.

Metody

addHeldAccounts

 Dodaje konta do blokady.

create

 Tworzy blokadę w danej sprawie.

delete

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

get

 Pobiera określoną blokadę.

list

 Wyświetla listę blokad w sprawie.

removeHeldAccounts

 Usuwa z blokady określone konta.

update

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