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,

  "accountInfo": {
    object (AccountInfo)
  },
  "orgUnitInfo": {
    object (OrgUnitInfo)
  },
  "sharedDriveInfo": {
    object (SharedDriveInfo)
  },
  "hangoutsChatInfo": {
    object (HangoutsChatInfo)
  },
  "sitesUrlInfo": {
    object (SitesUrlInfo)
  },
  "driveDocumentInfo": {
    object (DriveDocumentInfo)
  }

  "mailOptions": {
    object (MailOptions)
  },
  "driveOptions": {
    object (DriveOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatOptions)
  },
  "voiceOptions": {
    object (VoiceOptions)
  },
  "calendarOptions": {
    object (CalendarOptions)
  },
  "geminiOptions": {
    object (GeminiOptions)
  },
  "geminiInWorkspaceOptions": {
    object (GeminiInWorkspaceOptions)
  }
}
Kolom
corpus

enum (CorpusType)

Layanan Google Workspace yang akan ditelusuri.
dataScope

enum (DataScope)

Sumber data yang akan ditelusuri.
searchMethod
(deprecated)

enum (SearchMethod)

Metode penelusuran yang akan digunakan.
method

enum (SearchMethod)

Entity yang akan ditelusuri. Kolom ini menggantikan searchMethod untuk mendukung drive bersama. Jika searchMethod adalah TEAM_DRIVE, respons kolom ini adalah SHARED_DRIVE.
terms

string

Operator penelusuran khusus layanan untuk memfilter hasil penelusuran.
startTime

string (Timestamp format)

Waktu mulai untuk kueri penelusuran. Tentukan dalam GMT. Nilai dibulatkan ke pukul 12.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 akhir untuk kueri penelusuran. Tentukan dalam GMT. Nilai dibulatkan ke pukul 12.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".
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

Wajib ada jika SearchMethod adalah TEAM_DRIVE.
timeZone

string

Nama zona waktu. Nama ini harus berupa nama TZ IANA, seperti "America/Los_Angeles". Untuk mengetahui daftar nama zona waktu, lihat Zona Waktu. Untuk mengetahui informasi selengkapnya tentang cara Vault menggunakan zona waktu, lihat pusat bantuan Vault.
Menentukan detail entitas yang akan ditelusuri, jika diperlukan. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
accountInfo

object (AccountInfo)

Wajib diisi jika SearchMethod adalah ACCOUNT.
orgUnitInfo

object (OrgUnitInfo)

Wajib jika SearchMethod adalah ORG_UNIT.
sharedDriveInfo

object (SharedDriveInfo)

Wajib diisi jika SearchMethod adalah SHARED_DRIVE.
hangoutsChatInfo

object (HangoutsChatInfo)

Wajib ada jika SearchMethod adalah ROOM. (hanya baca)
sitesUrlInfo

object (SitesUrlInfo)

Wajib jika SearchMethod adalah SITES_URL.
driveDocumentInfo

object (DriveDocumentInfo)

Wajib ada jika SearchMethod adalah DRIVE_DOCUMENT.
Akhir kolom yang saling eksklusif.
Opsi penelusuran tambahan untuk layanan tertentu. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
mailOptions

object (MailOptions)

Menetapkan opsi khusus penelusuran Gmail.
driveOptions

object (DriveOptions)

Menetapkan opsi khusus penelusuran Drive.
hangoutsChatOptions

object (HangoutsChatOptions)

Menetapkan opsi khusus penelusuran Chat. (hanya baca)
voiceOptions

object (VoiceOptions)

Menetapkan opsi khusus Penelusuran suara.
calendarOptions

object (CalendarOptions)

Menetapkan opsi khusus penelusuran Kalender.
geminiOptions

object (GeminiOptions)

Menetapkan opsi khusus penelusuran aplikasi Gemini.
geminiInWorkspaceOptions

object (GeminiInWorkspaceOptions)

Menetapkan opsi khusus penelusuran Gemini di Workspace.
Akhir kolom yang saling eksklusif.

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 entity untuk penelusuran.

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

Menelusuri data di Drive Tim yang ditentukan di teamDriveInfo.
ENTIRE_ORG Menelusuri 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 Menelusuri situs berdasarkan URL situs yang dipublikasikan yang ditentukan di SitesUrlInfo.
SHARED_DRIVE Menelusuri file di drive bersama yang ditentukan di SharedDriveInfo.
DRIVE_DOCUMENT Mengambil dokumen yang ditentukan di DriveDocumentInfo.

AccountInfo

Akun yang akan 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 disediakan oleh Admin SDK Directory API.

SharedDriveInfo

Drive bersama yang akan ditelusuri

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

string

Daftar ID drive bersama, seperti yang disediakan oleh Drive API.

HangoutsChatInfo

Ruang Chat yang akan ditelusuri

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

string

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

SitesUrlInfo

URL situs yang dipublikasikan dari Google Sites baru untuk ditelusuri

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

string

Daftar URL situs yang dipublikasikan.

DriveDocumentInfo

Dokumen Drive yang akan ditelusuri.

Representasi JSON 
{

  "documentIds": {
    object (DriveDocumentIds)
  }
}
Kolom
Format untuk mengambil dokumen Drive. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
documentIds

object (DriveDocumentIds)

Tentukan dokumen Drive berdasarkan ID dokumen.
Akhir kolom yang saling eksklusif.

DriveDocumentIds

Tentukan dokumen Drive berdasarkan ID dokumen.

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

string

Wajib. Daftar ID dokumen Drive.

TeamDriveInfo

Drive Bersama yang akan ditelusuri

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

string

Daftar ID Drive Tim, 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 tidak terenkripsi, atau keduanya. Defaultnya adalah menyertakan keduanya.

ClientSideEncryptedOption

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

Enum
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED Status enkripsi tidak ditentukan. Hasilnya mencakup konten terenkripsi sisi klien dan konten yang tidak dienkripsi.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Sertakan konten terenkripsi sisi klien dan konten yang tidak dienkripsi dalam hasil.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Hanya sertakan konten terenkripsi sisi klien.
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),
  "sharedDrivesOption": enum (SharedDrivesOption)
}
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.

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

boolean

Tetapkan ke benar (true) untuk menyertakan Drive Tim.
includeSharedDrives
(deprecated)

boolean

Tetapkan ke true untuk menyertakan drive bersama.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

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

enum (SharedDrivesOption)

Opsional. Opsi untuk menyertakan atau mengecualikan dokumen di drive bersama. Sebaiknya gunakan kolom ini daripada includeSharedDrives. Kolom ini menggantikan includeSharedDrives dan includeTeamDrives jika ditetapkan.

SharedDrivesOption

Opsi jenis dokumen drive bersama yang akan disertakan.

Enum
SHARED_DRIVES_OPTION_UNSPECIFIED Tidak ada opsi drive bersama yang ditentukan.
NOT_INCLUDED Jika resource berada di drive bersama, resource tersebut tidak disertakan dalam penelusuran.
INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER Resource drive bersama hanya disertakan dalam instance tempat akun menjadi kolaborator pada resource, tetapi bukan anggota drive bersama. Opsi ini dipetakan ke opsi "Hanya disertakan jika dokumen dibagikan secara langsung (bukan karena keanggotaan drive bersama)" di UI Vault. (Sebelumnya "includeSharedDrives" nonaktif)
INCLUDED Resource di drive bersama disertakan dalam penelusuran. (Sebelumnya "includeSharedDrives" diaktifkan)

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 acara yang lokasinya berisi semua kata dalam kumpulan yang diberikan. Jika string berisi frasa yang dikutip, metode ini hanya mencocokkan acara yang lokasinya berisi frasa yang sama persis. Entri dalam kumpulan dipertimbangkan dalam "dan".

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

string

Hanya mencocokkan acara yang pesertanya berisi semua kata dalam kumpulan yang diberikan. Entri dalam kumpulan dipertimbangkan dalam "dan".
minusWords[]

string

Hanya mencocokkan acara yang tidak berisi kata apa pun dalam kumpulan yang diberikan di judul, deskripsi, lokasi, atau tamu. Entri dalam kumpulan dipertimbangkan dalam "or".
responseStatuses[]

enum (AttendeeResponse)

Hanya mencocokkan peristiwa dengan kustodian yang memberikan salah satu respons ini. Jika set kosong atau berisi ATTENDEE_RESPONSE_UNSPECIFIED, tidak akan ada pemfilteran pada respons.
versionDate

string (Timestamp format)

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

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".

AttendeeResponse

Respons pengguna terhadap undangan.

Enum
ATTENDEE_RESPONSE_UNSPECIFIED Respons tamu tidak ditentukan. Jika ini ditetapkan, tidak ada pemfilteran pada respons yang akan dilakukan, semua respons peserta lain yang merupakan bagian dari opsi kueri akan diabaikan.
ATTENDEE_RESPONSE_NEEDS_ACTION Peserta telah diundang, tetapi belum merespons.
ATTENDEE_RESPONSE_ACCEPTED Peserta berencana untuk hadir.
ATTENDEE_RESPONSE_DECLINED Peserta tidak berencana untuk hadir.
ATTENDEE_RESPONSE_TENTATIVE Peserta mungkin akan hadir.

GeminiOptions

Jenis ini tidak memiliki kolom.

Opsi tambahan untuk penelusuran aplikasi Gemini

GeminiInWorkspaceOptions

Jenis ini tidak memiliki kolom.

Opsi tambahan untuk penelusuran Gemini di Workspace