REST Resource: matters.holds

Resource: Hold

Penangguhan. Pembekuan mencegah layanan Google Workspace yang ditentukan menghapus data untuk akun tertentu atau semua anggota unit organisasi.

Untuk menggunakan resource Vault, akun harus memiliki hak istimewa Vault yang diperlukan dan akses ke kasus. Untuk mengakses suatu masalah, akun harus telah membuat masalah tersebut, telah dibagikan masalah tersebut, atau memiliki hak istimewa Lihat Semua Masalah.

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

string

ID unik dan tidak dapat diubah dari penangguhan. Ditetapkan selama pembuatan.
name

string

Nama penangguhan.
updateTime

string (Timestamp format)

Terakhir kali penangguhan ini diubah.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
accounts[]

object (HeldAccount)

Jika ditetapkan, penangguhan berlaku untuk akun yang ditentukan dan orgUnit harus kosong.
orgUnit

object (HeldOrgUnit)

Jika disetel, penangguhan berlaku untuk semua anggota unit organisasi dan akun harus kosong. Properti ini dapat diubah. Untuk pembekuan Grup, tetapkan akun.
corpus

enum (CorpusType)

Layanan yang akan ditelusuri.
query

object (CorpusQuery)

Opsi khusus layanan. Jika disetel, CorpusQuery harus cocok dengan CorpusType.

HeldOrgUnit

Unit organisasi yang tercakup dalam pembekuan. Struktur ini tidak dapat diubah.

Representasi JSON 
{
  "orgUnitId": string,
  "holdTime": string
}
Kolom
orgUnitId

string

ID unit organisasi yang tidak dapat diubah sebagaimana diberikan oleh Admin SDK.
holdTime

string (Timestamp format)

Kapan unit organisasi ditangguhkan. Properti ini tidak dapat diubah.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

CorpusQuery

Opsi khusus layanan untuk penangguhan.

Representasi JSON 
{

  "driveQuery": {
    object (HeldDriveQuery)
  },
  "mailQuery": {
    object (HeldMailQuery)
  },
  "groupsQuery": {
    object (HeldGroupsQuery)
  },
  "hangoutsChatQuery": {
    object (HeldHangoutsChatQuery)
  },
  "voiceQuery": {
    object (HeldVoiceQuery)
  },
  "calendarQuery": {
    object (HeldCalendarQuery)
  },
  "geminiQuery": {
    object (HeldGeminiQuery)
  }
}
Kolom
Kolom union corpus_query. Jika ditetapkan, nilai ini harus cocok dengan jenis layanan. corpus_query hanya dapat berupa salah satu dari berikut:
driveQuery

object (HeldDriveQuery)

Opsi khusus layanan untuk penangguhan Drive. Jika disetel, CorpusType harus berupa DRIVE.
mailQuery

object (HeldMailQuery)

Opsi khusus layanan untuk pembekuan Gmail. Jika disetel, CorpusType harus berupa MAIL.
groupsQuery

object (HeldGroupsQuery)

Opsi khusus layanan untuk penangguhan Grup. Jika disetel, CorpusType harus berupa GROUPS.
hangoutsChatQuery

object (HeldHangoutsChatQuery)

Opsi khusus layanan untuk pembekuan Chat. Jika disetel, CorpusType harus berupa HANGOUTS_CHAT.
voiceQuery

object (HeldVoiceQuery)

Opsi khusus layanan untuk Penangguhan Voice. Jika disetel, CorpusType harus berupa VOICE.
calendarQuery

object (HeldCalendarQuery)

Opsi khusus layanan untuk penahanan Kalender. Jika disetel, CorpusType harus berupa CALENDAR.
geminiQuery

object (HeldGeminiQuery)

Opsi khusus layanan untuk penangguhan Gemini. Jika disetel, CorpusType harus GEMINI.

HeldDriveQuery

Opsi untuk pembekuan Drive.

Representasi JSON 
{
  "includeTeamDriveFiles": boolean,
  "includeSharedDriveFiles": boolean
}
Kolom
includeTeamDriveFiles
(deprecated)

boolean

Untuk menyertakan file di Drive Tim dalam pembekuan, tetapkan ke benar (true).
includeSharedDriveFiles

boolean

Untuk menyertakan file di drive bersama dalam penangguhan, tetapkan ke true.

HeldMailQuery

Opsi kueri untuk pembekuan Gmail.

Representasi JSON 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Kolom
terms

string

Operator penelusuran yang digunakan untuk menyaring pesan yang tercakup dalam pembekuan.
startTime

string (Timestamp format)

Waktu mulai kueri. Tentukan dalam GMT. Nilai dibulatkan ke pukul 00.00 pada tanggal yang ditentukan.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Waktu berakhir untuk kueri. Tentukan dalam GMT. Nilai dibulatkan ke pukul 00.00 pada tanggal yang ditentukan.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

HeldGroupsQuery

Opsi kueri untuk pembekuan grup.

Representasi JSON 
{
  "terms": string,
  "startTime": string,
  "endTime": string
}
Kolom
terms

string

Operator penelusuran yang digunakan untuk menyaring pesan yang tercakup dalam pembekuan.
startTime

string (Timestamp format)

Waktu mulai kueri. Tentukan dalam GMT. Nilai dibulatkan ke pukul 00.00 pada tanggal yang ditentukan.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Waktu berakhir untuk kueri. Tentukan dalam GMT. Nilai dibulatkan ke pukul 00.00 pada tanggal yang ditentukan.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

HeldHangoutsChatQuery

Opsi untuk pembekuan Chat.

Representasi JSON 
{
  "includeRooms": boolean
}
Kolom
includeRooms

boolean

Untuk menyertakan pesan dalam ruang Chat tempat pengguna menjadi anggota, tetapkan ke benar (true).

HeldVoiceQuery

Opsi untuk penahanan Voice.

Representasi JSON 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Kolom
coveredData[]

enum (VoiceCoveredData)

Daftar jenis data yang tercakup dalam penangguhan. Tidak boleh kosong. Urutan tidak menjadi masalah dan duplikat diabaikan.

HeldCalendarQuery

Jenis ini tidak memiliki kolom.

Opsi untuk penahanan Kalender.

HeldGeminiQuery

Jenis ini tidak memiliki kolom.

Opsi untuk penangguhan Gemini.

Metode

addHeldAccounts

 Menambahkan akun ke pembekuan.

create

 Membuat pembekuan dalam masalah yang ditentukan.

delete

 Menghapus penangguhan yang ditentukan dan melepaskan akun atau unit organisasi yang dicakup oleh penangguhan.

get

 Mendapatkan penangguhan yang ditentukan.

list

 Mencantumkan pembekuan dalam suatu kasus.

removeHeldAccounts

 Menghapus akun tertentu dari penangguhan.

update

 Memperbarui cakupan (unit organisasi atau akun) dan parameter kueri pembekuan.