Query

Definisi kueri yang digunakan untuk penelusuran dan ekspor.

Representasi JSON 
{
  "corpus": enum (CorpusType),
  "dataScope": enum (DataScope),
  "searchMethod": enum (SearchMethod),
  "method": enum (SearchMethod),
  "terms": string,
  "startTime": string,
  "endTime": string,
  "teamDriveInfo": {
    object (TeamDriveInfo)
  },
  "timeZone": string,

  // Union field search_method_field can be only one of the following:
  "accountInfo": {
    object (AccountInfo)
  },
  "orgUnitInfo": {
    object (OrgUnitInfo)
  },
  "sharedDriveInfo": {
    object (SharedDriveInfo)
  },
  "hangoutsChatInfo": {
    object (HangoutsChatInfo)
  },
  "sitesUrlInfo": {
    object (SitesUrlInfo)
  }
  // End of list of possible types for union field search_method_field.

  // Union field corpus_options_field can be only one of the following:
  "mailOptions": {
    object (MailOptions)
  },
  "driveOptions": {
    object (DriveOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatOptions)
  },
  "voiceOptions": {
    object (VoiceOptions)
  },
  "calendarOptions": {
    object (CalendarOptions)
  }
  // End of list of possible types for union field corpus_options_field.
}
Kolom
corpus

enum (CorpusType)

Layanan Google Workspace yang akan digunakan untuk melakukan penelusuran.
dataScope

enum (DataScope)

Sumber data yang akan ditelusuri.
searchMethod
(deprecated)

enum (SearchMethod)

Metode penelusuran yang akan digunakan.
method

enum (SearchMethod)

Entitas yang akan ditelusuri. Kolom ini menggantikan searchMethod untuk mendukung drive bersama. Jika searchMethod adalah TIM_Drive, respons kolom ini adalah SHARED_Drive.
terms

string

Operator penelusuran khusus layanan untuk memfilter hasil penelusuran.
startTime

string (Timestamp format)

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

Stempel waktu dalam 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 kueri penelusuran. Tentukan dalam GMT. Nilai dibulatkan menjadi 00.00 pada tanggal yang ditentukan.

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

object (TeamDriveInfo)

Wajib ada jika SearchMethod adalah TIM_Drive.
timeZone

string

Nama zona waktu. Nama harus berupa nama IANA TZ, seperti "America/Los_Angeles". Untuk daftar nama zona waktu, lihat Zona Waktu. Untuk mengetahui informasi selengkapnya tentang cara Vault menggunakan zona waktu, lihat pusat bantuan Vault.
Kolom union search_method_field. Jika diperlukan, detail entitas untuk menelusuri search_method_field hanya dapat berupa salah satu dari berikut ini:
accountInfo

object (AccountInfo)

Wajib jika SearchMethod adalah ACCOUNT.
orgUnitInfo

object (OrgUnitInfo)

Wajib diisi jika SearchMethod adalah ORG_UNIT.
sharedDriveInfo

object (SharedDriveInfo)

Wajib ada jika SearchMethod adalah SHARED_Drive.
hangoutsChatInfo

object (HangoutsChatInfo)

Wajib jika SearchMethod adalah ROOM. (hanya baca)
sitesUrlInfo

object (SitesUrlInfo)

Wajib ada jika SearchMethod adalah sites_URL.
Kolom union corpus_options_field. Opsi penelusuran tambahan untuk layanan tertentu. corpus_options_field hanya dapat berupa salah satu dari berikut:
mailOptions

object (MailOptions)

Tetapkan opsi khusus penelusuran Gmail.
driveOptions

object (DriveOptions)

Tetapkan opsi khusus penelusuran Drive.
hangoutsChatOptions

object (HangoutsChatOptions)

Tetapkan opsi khusus penelusuran Chat. (hanya baca)
voiceOptions

object (VoiceOptions)

Menetapkan opsi khusus penelusuran Suara.
calendarOptions

object (CalendarOptions)

Menetapkan opsi khusus penelusuran Kalender.

DataScope

Sumber data yang akan ditelusuri.

Enum
DATA_SCOPE_UNSPECIFIED Tidak ada sumber data yang ditentukan.
ALL_DATA Semua data yang tersedia.
HELD_DATA Hanya data yang dibekukan.
UNPROCESSED_DATA Hanya data yang belum diproses oleh Vault. (Khusus Gmail dan Grup)

SearchMethod

Jenis entitas untuk penelusuran.

Enum
SEARCH_METHOD_UNSPECIFIED Metode penelusuran harus ditentukan atau akan ditolak.
ACCOUNT Telusuri data akun yang ditentukan di AccountInfo.
ORG_UNIT Menelusuri data semua akun di unit organisasi yang ditentukan dalam OrgUnitInfo.
TEAM_DRIVE

Telusuri data di Drive Tim yang ditentukan dalam teamDriveInfo.
ENTIRE_ORG Telusuri data semua akun di organisasi. Hanya didukung untuk Gmail. Jika ditentukan, Anda tidak perlu menentukan AccountInfo atau OrgUnitInfo.
ROOM Menelusuri pesan di ruang Chat yang ditentukan di HangoutsChatInfo.
SITES_URL Telusuri situs berdasarkan URL situs yang dipublikasikan yang ditentukan di SitesUrlInfo.
SHARED_DRIVE Telusuri file di drive bersama yang ditentukan di SharedDriveInfo.

AccountInfo

Akun yang ditelusuri

Representasi JSON 
{
  "emails": [
    string
  ]
}
Kolom
emails[]

string

Kumpulan akun yang akan ditelusuri.

OrgUnitInfo

Unit organisasi yang akan ditelusuri

Representasi JSON 
{
  "orgUnitId": string
}
Kolom
orgUnitId

string

Nama unit organisasi yang akan ditelusuri, seperti yang diberikan oleh Admin SDK Directory API.

SharedDriveInfo

Drive bersama untuk melakukan penelusuran

Representasi JSON 
{
  "sharedDriveIds": [
    string
  ]
}
Kolom
sharedDriveIds[]

string

Daftar ID drive bersama, sebagaimana diberikan oleh Drive API.

HangoutsChatInfo

Ruang Chat yang akan ditelusuri

Representasi JSON 
{
  "roomId": [
    string
  ]
}
Kolom
roomId[]

string

Daftar ID ruang Chat, sebagaimana disediakan oleh Chat API. Ada batas ekspor dari 500 ruang Chat per permintaan.

SitesUrlInfo

URL situs yang dipublikasikan dari Google Sites baru yang akan ditelusuri

Representasi JSON 
{
  "urls": [
    string
  ]
}
Kolom
urls[]

string

Daftar URL situs yang dipublikasikan.

TeamDriveInfo

Drive Tim untuk menelusuri

Representasi JSON 
{
  "teamDriveIds": [
    string
  ]
}
Kolom
teamDriveIds[]
(deprecated)

string

Daftar ID Team Drive, seperti yang disediakan oleh Drive API.

MailOptions

Opsi tambahan untuk penelusuran Gmail

Representasi JSON 
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Kolom
excludeDrafts

boolean

Tetapkan ke true untuk mengecualikan draf.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Menentukan apakah hasil harus menyertakan konten terenkripsi, konten yang tidak dienkripsi, atau keduanya. Secara default, menyertakan keduanya.

ClientSideEncryptedOption

Jika organisasi Anda menggunakan Enkripsi sisi klien Google Workspace, status enkripsi konten

Enum
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED Status enkripsi belum ditentukan. Hasilnya mencakup konten terenkripsi sisi klien dan konten yang tidak dienkripsi.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Sertakan konten terenkripsi dan tidak terenkripsi sisi klien dalam hasil.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Sertakan konten terenkripsi sisi klien saja.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Hanya sertakan konten yang tidak dienkripsi.

DriveOptions

Opsi tambahan untuk penelusuran Drive

Representasi JSON 
{
  "versionDate": string,
  "includeTeamDrives": boolean,
  "includeSharedDrives": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Kolom
versionDate

string (Timestamp format)

Menelusuri versi file Drive saat ini, tetapi mengekspor konten versi terakhir yang disimpan sebelum pukul 00.00 UTC pada tanggal yang ditentukan. Masukkan tanggal dalam UTC.

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".
includeTeamDrives
(deprecated)

boolean

Tetapkan ke true untuk menyertakan Drive Tim.
includeSharedDrives

boolean

Tetapkan ke true untuk menyertakan drive bersama.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Tetapkan apakah hasil hanya menyertakan konten yang dienkripsi dengan konten Enkripsi sisi klien Google Workspace, hanya konten yang tidak dienkripsi, atau keduanya. Setelan defaultnya adalah keduanya. Saat ini didukung untuk Drive.

HangoutsChatOptions

Opsi tambahan untuk penelusuran Google Chat

Representasi JSON 
{
  "includeRooms": boolean
}
Kolom
includeRooms

boolean

Untuk penelusuran menurut akun atau unit organisasi, tetapkan ke true untuk menyertakan ruang.

VoiceOptions

Opsi tambahan untuk Penelusuran suara

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

enum (VoiceCoveredData)

Jenis data yang akan ditelusuri

CalendarOptions

Opsi tambahan untuk penelusuran Kalender

Representasi JSON 
{
  "locationQuery": [
    string
  ],
  "peopleQuery": [
    string
  ],
  "minusWords": [
    string
  ],
  "responseStatuses": [
    enum (AttendeeResponse)
  ],
  "versionDate": string
}
Kolom
locationQuery[]

string

Hanya mencocokkan peristiwa yang lokasinya berisi semua kata dalam kumpulan yang ditentukan. Jika string berisi frasa kutipan, metode ini hanya cocok dengan peristiwa yang lokasinya berisi frasa yang sama persis. Entri dalam set dianggap dalam "dan".

Contoh pemisahan kata: ["New Zealand"] vs ["New","Zealand"] "New Zealand": cocok dengan keduanya "New and better Zealand": hanya cocok dengan yang terakhir
peopleQuery[]

string

Hanya mencocokkan peristiwa yang pesertanya berisi semua kata dalam kumpulan yang diberikan. Entri dalam set dianggap dalam "dan".
minusWords[]

string

Hanya cocok dengan acara yang tidak berisi kata apa pun dari kumpulan yang ditentukan dalam judul, deskripsi, lokasi, atau peserta. Entri dalam kumpulan dianggap dalam "atau".
responseStatuses[]

enum (AttendeeResponse)

Hanya cocok dengan acara yang penjaganya memberikan salah satu respons ini. Jika kumpulan tersebut kosong atau berisi BYOD_RESPONSE_UNSPECIFIED, respons tidak akan difilter.
versionDate

string (Timestamp format)

Telusuri versi peristiwa Kalender saat ini, tetapi ekspor konten versi terakhir yang disimpan sebelum pukul 00.00 UTC pada tanggal yang ditentukan. Masukkan tanggal dalam UTC.

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

AttendeeResponse

Respons pengguna terhadap undangan.

Enum
ATTENDEE_RESPONSE_UNSPECIFIED Respons peserta belum ditentukan. Jika disetel, pemfilteran pada respons tidak akan dilakukan, semua respons tamu lainnya yang merupakan bagian dari opsi kueri akan diabaikan.
ATTENDEE_RESPONSE_NEEDS_ACTION Peserta telah diundang tetapi belum menanggapi.
ATTENDEE_RESPONSE_ACCEPTED Peserta berencana untuk hadir.
ATTENDEE_RESPONSE_DECLINED Peserta tidak berencana untuk hadir.
ATTENDEE_RESPONSE_TENTATIVE Peserta berharap untuk hadir.