REST Resource: matters.holds

Referensi: Pembekuan

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

Untuk menggunakan resource Vault, akun harus memiliki hak istimewa Vault yang diperlukan dan akses ke masalah. Untuk mengakses masalah, akun tersebut harus sudah membuat masalah, membagikan masalah tersebut kepadanya, atau memiliki hak istimewa Melihat 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 yang tidak dapat diubah dari pembekuan. Ditugaskan selama pembuatan.
name

string

Nama pembekuan.
updateTime

string (Timestamp format)

Terakhir kali pembekuan ini diubah.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
accounts[]

object (HeldAccount)

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

object (HeldOrgUnit)

Jika ditetapkan, pembekuan 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 ditetapkan, CorpusQuery harus cocok dengan CorpusType.

HeldOrgUnit

Unit organisasi yang dicakup oleh pembekuan. Struktur ini tidak dapat diubah.

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

string

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

string (Timestamp format)

Saat unit organisasi ditangguhkan. Properti ini tidak dapat diubah.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

CorpusQuery

Opsi khusus layanan untuk pembekuan.

Representasi 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.
}
Kolom
Kolom union corpus_query. Jika ditetapkan, kolom ini harus cocok dengan jenis layanan. corpus_query hanya ada berupa salah satu diantara berikut:
driveQuery

object (HeldDriveQuery)

Opsi khusus layanan untuk pembekuan Drive. Jika ditetapkan, CorpusType harus DRIVE.
mailQuery

object (HeldMailQuery)

Opsi khusus layanan untuk pembekuan Gmail. Jika ditetapkan, CorpusType harus berupa EMAIL.
groupsQuery

object (HeldGroupsQuery)

Opsi khusus layanan untuk pembekuan Grup. Jika ditetapkan, CorpusType harus berupa GROUPS.
hangoutsChatQuery

object (HeldHangoutsChatQuery)

Opsi khusus layanan untuk pembekuan Chat. Jika ditetapkan, CorpusType harus berupa Corpus_CHAT.
voiceQuery

object (HeldVoiceQuery)

Opsi khusus layanan untuk pembekuan Voice. Jika ditetapkan, CorpusType harus VOICE.

HeldDriveQuery

Opsi untuk pembekuan Drive.

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

boolean

Untuk menyertakan file dalam Drive Tim dalam pembekuan, setel ke true.
includeSharedDriveFiles

boolean

Untuk menyertakan file dalam drive bersama dalam pembekuan, 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 dicakup oleh pembekuan.
startTime

string (Timestamp format)

Waktu mulai untuk kueri. Tentukan dalam GMT. Nilai dibulatkan menjadi 00.00 pada tanggal yang ditentukan.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

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

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

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 dicakup oleh pembekuan.
startTime

string (Timestamp format)

Waktu mulai untuk kueri. Tentukan dalam GMT. Nilai dibulatkan menjadi 00.00 pada tanggal yang ditentukan.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

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

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

HeldHangoutsChatQuery

Opsi untuk pembekuan Chat.

Representasi JSON 
{
  "includeRooms": boolean
}
Kolom
includeRooms

boolean

Untuk menyertakan pesan di ruang Chat tempat pengguna menjadi anggota, tetapkan ke true.

HeldVoiceQuery

Opsi untuk pembekuan Voice.

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

enum (VoiceCoveredData)

Daftar jenis data yang dicakup oleh pembekuan. Tidak boleh kosong. Urutan tidak menjadi masalah dan duplikat akan diabaikan.

Metode

addHeldAccounts

 Menambahkan akun ke pembekuan.

create

 Membuat pembekuan dalam masalah yang ditentukan.

delete

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

get

 Mendapatkan pembekuan yang ditentukan.

list

 Mencantumkan pembekuan dalam masalah.

removeHeldAccounts

 Menghapus akun tertentu dari pembekuan.

update

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