Query

A definição de consulta usada para pesquisa e exportação.

Representação 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)
  }
}
Campos
corpus

enum (CorpusType)

O serviço do Google Workspace a ser pesquisado.
dataScope

enum (DataScope)

A fonte de dados a ser pesquisada.
searchMethod
(deprecated)

enum (SearchMethod)

O método de pesquisa a ser usado.
method

enum (SearchMethod)

A entidade a ser pesquisada. Esse campo substitui searchMethod para oferecer suporte a drives compartilhados. Quando searchMethod é TEAM_DRIVE, a resposta desse campo é SHARED_DRIVE.
terms

string

Operadores de pesquisa específicos do serviço para filtrar os resultados da pesquisa.
startTime

string (Timestamp format)

O horário de início da consulta de pesquisa. Especifique em GMT. O valor é arredondado para meia-noite na data especificada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

O horário de término da consulta de pesquisa. Especifique em GMT. O valor é arredondado para meia-noite na data especificada.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

Obrigatório quando SearchMethod é TEAM_DRIVE.
timeZone

string

O nome do fuso horário. Deve ser um nome IANA TZ, como "America/Los_Angeles". Para uma lista de nomes de fusos horários, consulte Fuso horário. Para mais informações sobre como o Vault usa fusos horários, consulte a Central de Ajuda do Vault.
Campo de união search_method_field. Quando necessário, os detalhes das entidades a serem pesquisadas search_method_field podem ser apenas um dos seguintes:
accountInfo

object (AccountInfo)

Obrigatório quando SearchMethod é ACCOUNT.
orgUnitInfo

object (OrgUnitInfo)

Obrigatório quando SearchMethod é ORG_UNIT.
sharedDriveInfo

object (SharedDriveInfo)

Obrigatório quando SearchMethod é SHARED_DRIVE.
hangoutsChatInfo

object (HangoutsChatInfo)

Obrigatório quando SearchMethod é ROOM. (somente leitura)
sitesUrlInfo

object (SitesUrlInfo)

Obrigatório quando SearchMethod é SITES_URL.
driveDocumentInfo

object (DriveDocumentInfo)

Obrigatório quando SearchMethod é DRIVE_DOCUMENT.
Campo de união corpus_options_field. Outras opções de pesquisa para serviços específicos. corpus_options_field pode ser apenas de um dos tipos a seguir:
mailOptions

object (MailOptions)

Defina opções específicas da pesquisa do Gmail.
driveOptions

object (DriveOptions)

Defina opções específicas de pesquisa do Drive.
hangoutsChatOptions

object (HangoutsChatOptions)

Defina opções específicas da pesquisa do Chat. (somente leitura)
voiceOptions

object (VoiceOptions)

Defina opções específicas da Pesquisa por voz.
calendarOptions

object (CalendarOptions)

Defina opções específicas de pesquisa do Google Agenda.
geminiOptions

object (GeminiOptions)

Defina opções específicas da pesquisa do Gemini.

DataScope

A origem dos dados a serem pesquisados.

Tipos enumerados
DATA_SCOPE_UNSPECIFIED Nenhuma fonte de dados especificada.
ALL_DATA Todos os dados disponíveis.
HELD_DATA Somente dados retidos.
UNPROCESSED_DATA Apenas dados que ainda não foram processados pelo Vault. (Somente Gmail e Grupos)

SearchMethod

O tipo de entidade da pesquisa.

Tipos enumerados
SEARCH_METHOD_UNSPECIFIED Um método de pesquisa precisa ser especificado, caso contrário, ele será rejeitado.
ACCOUNT Pesquise os dados das contas especificadas em AccountInfo.
ORG_UNIT Pesquise os dados de todas as contas na unidade organizacional especificada em OrgUnitInfo.
TEAM_DRIVE

Pesquise os dados no Drive de equipe especificado em teamDriveInfo.
ENTIRE_ORG Pesquisar os dados de todas as contas na organização. Disponível apenas para o Gmail. Quando especificado, não é necessário especificar AccountInfo ou OrgUnitInfo.
ROOM Pesquisa mensagens nos espaços do Chat especificados em HangoutsChatInfo.
SITES_URL Pesquise sites pelos URLs publicados especificados em SitesUrlInfo.
SHARED_DRIVE Pesquise os arquivos nos drives compartilhados especificados em SharedDriveInfo.
DRIVE_DOCUMENT Recupera os documentos especificados em DriveDocumentInfo.

AccountInfo

As contas a serem pesquisadas

Representação JSON 
{
  "emails": [
    string
  ]
}
Campos
emails[]

string

Um conjunto de contas para pesquisar.

OrgUnitInfo

A unidade organizacional a ser pesquisada

Representação JSON 
{
  "orgUnitId": string
}
Campos
orgUnitId

string

O nome da unidade organizacional a ser pesquisada, conforme fornecido pela API Admin SDK Directory.

SharedDriveInfo

Os drives compartilhados a serem pesquisados.

Representação JSON 
{
  "sharedDriveIds": [
    string
  ]
}
Campos
sharedDriveIds[]

string

Uma lista de IDs de drives compartilhados, conforme fornecido pela API Drive.

HangoutsChatInfo

Os espaços do Chat para pesquisar

Representação JSON 
{
  "roomId": [
    string
  ]
}
Campos
roomId[]

string

Uma lista de IDs de espaços do Chat, conforme fornecido pela API Chat. Há um limite de exportação de 500 espaços do Chat por solicitação.

SitesUrlInfo

Os URLs de sites publicados do novo Google Sites para pesquisar

Representação JSON 
{
  "urls": [
    string
  ]
}
Campos
urls[]

string

Uma lista de URLs de sites publicados.

DriveDocumentInfo

Os documentos do Drive a serem pesquisados.

Representação JSON 
{

  "documentIds": {
    object (DriveDocumentIds)
  }
}
Campos
Campo de união identifier. O formato para recuperar os documentos do Drive. identifier pode ser apenas de um dos tipos a seguir:
documentIds

object (DriveDocumentIds)

Especifique os documentos do Drive por ID.

DriveDocumentIds

Especifique os documentos do Drive por ID.

Representação JSON 
{
  "ids": [
    string
  ]
}
Campos
ids[]

string

Obrigatório. Uma lista de IDs de documentos do Drive.

TeamDriveInfo

Drives de equipe para pesquisar

Representação JSON 
{
  "teamDriveIds": [
    string
  ]
}
Campos
teamDriveIds[]
(deprecated)

string

Lista de IDs de unidades de equipe, conforme fornecido pela API Drive.

MailOptions

Outras opções de pesquisa do Gmail

Representação JSON 
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Campos
excludeDrafts

boolean

Defina como true para excluir rascunhos.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Especifica se os resultados devem incluir conteúdo criptografado, não criptografado ou ambos. O padrão é incluir os dois.

ClientSideEncryptedOption

Se a organização usa a criptografia do lado do cliente do Google Workspace, o status de criptografia do conteúdo

Tipos enumerados
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED Status da criptografia não especificado. Os resultados incluem conteúdo criptografado e não criptografado do lado do cliente.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Incluir conteúdo criptografado do lado do cliente e não criptografado nos resultados.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Inclua apenas conteúdo criptografado do lado do cliente.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Inclua apenas conteúdo não criptografado.

DriveOptions

Outras opções para a pesquisa do Drive.

Representação JSON 
{
  "versionDate": string,
  "includeTeamDrives": boolean,
  "includeSharedDrives": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption),
  "sharedDrivesOption": enum (SharedDrivesOption)
}
Campos
versionDate

string (Timestamp format)

Pesquisar a versão atual do arquivo do Drive, mas exportar o conteúdo da última versão salva antes da 0h00 (UTC) na data especificada. Insira a data em UTC.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
includeTeamDrives
(deprecated)

boolean

Defina como "true" para incluir o Drive de equipe.
includeSharedDrives
(deprecated)

boolean

Defina como true para incluir drives compartilhados.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Defina se os resultados incluem apenas conteúdo criptografado com a criptografia do lado do cliente do Google Workspace, apenas conteúdo não criptografado ou ambos. O padrão é "ambos". No momento, esse recurso está disponível para o Drive.
sharedDrivesOption

enum (SharedDrivesOption)

Opcional. Opções para incluir ou excluir documentos em drives compartilhados. Recomendamos usar esse campo em vez de "includeSharedDrives". Esse campo substitui "includeSharedDrives" e "includeTeamDrives" quando definido.

SharedDrivesOption

Opção sobre o tipo de documentos do drive compartilhado a serem incluídos.

Tipos enumerados
SHARED_DRIVES_OPTION_UNSPECIFIED Nenhuma opção de drive compartilhado especificada.
NOT_INCLUDED Se um recurso estiver em um drive compartilhado, ele não será incluído na pesquisa.
INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER Os recursos do drive compartilhado só são incluídos quando a conta é colaboradora de um recurso, mas não é participante do drive compartilhado. Isso corresponde à opção Incluído apenas se os documentos forem compartilhados diretamente (e não por conta da participação no drive compartilhado) na interface do Vault. (Antes, "includeSharedDrives" desativado)
INCLUDED Os recursos em drives compartilhados são incluídos na pesquisa. (Antes, "includeSharedDrives" ativado)

HangoutsChatOptions

Outras opções para a pesquisa do Google Chat

Representação JSON 
{
  "includeRooms": boolean
}
Campos
includeRooms

boolean

Para pesquisas por conta ou unidade organizacional, defina como true para incluir salas.

VoiceOptions

Outras opções para a pesquisa por voz

Representação JSON 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Campos
coveredData[]

enum (VoiceCoveredData)

Tipos de dados para pesquisar

CalendarOptions

Outras opções de pesquisa na Agenda

Representação JSON 
{
  "locationQuery": [
    string
  ],
  "peopleQuery": [
    string
  ],
  "minusWords": [
    string
  ],
  "responseStatuses": [
    enum (AttendeeResponse)
  ],
  "versionDate": string
}
Campos
locationQuery[]

string

Corresponde apenas aos eventos cujo local contém todas as palavras no conjunto especificado. Se a string contiver frases entre aspas, esse método só vai corresponder aos eventos cujo local contenha a frase exata. As entradas no conjunto são consideradas em "e".

Exemplo de divisão de palavras: ["New Zealand"] x ["New","Zealand"] "New Zealand": correspondência com "New and better Zealand": correspondência apenas com o último
peopleQuery[]

string

Corresponde apenas aos eventos em que os participantes contêm todas as palavras do conjunto especificado. As entradas no conjunto são consideradas em "e".
minusWords[]

string

Corresponde apenas aos eventos que não contêm nenhuma das palavras no conjunto especificado no título, na descrição, no local ou nos participantes. As entradas no conjunto são consideradas em "ou".
responseStatuses[]

enum (AttendeeResponse)

Corresponde apenas a eventos em que o custodiante deu uma dessas respostas. Se o conjunto estiver vazio ou contiver ATTENDEE_RESPONSE_UNSPECIFIED, não haverá filtragem nas respostas.
versionDate

string (Timestamp format)

Pesquisar a versão atual do evento do Google Agenda, mas exportar o conteúdo da última versão salva antes da 0h00 (UTC) na data especificada. Insira a data em UTC.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

AttendeeResponse

Resposta do usuário a um convite.

Tipos enumerados
ATTENDEE_RESPONSE_UNSPECIFIED Resposta do participante não especificada. Se essa opção for definida, nenhuma filtragem será feita nas respostas. Todas as outras respostas dos participantes que fazem parte das opções de consulta serão ignoradas.
ATTENDEE_RESPONSE_NEEDS_ACTION O participante foi convidado, mas ainda não respondeu.
ATTENDEE_RESPONSE_ACCEPTED O participante planeja comparecer.
ATTENDEE_RESPONSE_DECLINED O participante não planeja comparecer.
ATTENDEE_RESPONSE_TENTATIVE O participante espera poder comparecer.

GeminiOptions

Esse tipo não tem campos.

Outras opções de pesquisa do Gemini