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,

  // 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)
  },
  "driveDocumentInfo": {
    object (DriveDocumentInfo)
  }
  // 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)
  },
  "geminiOptions": {
    object (GeminiOptions)
  }
  // End of list of possible types for union field corpus_options_field.
}
Campos
corpus

enum (CorpusType)

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

enum (DataScope)

A origem 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 0h da data especificada.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" 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 0h da data especificada.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" 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 for 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)

Definir opções específicas de pesquisa do Gmail.
driveOptions

object (DriveOptions)

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

object (HangoutsChatOptions)

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

object (VoiceOptions)

Definir opções específicas da pesquisa por voz.
calendarOptions

object (CalendarOptions)

Definir opções específicas de pesquisa da Agenda.
geminiOptions

object (GeminiOptions)

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

DataScope

A origem dos dados a serem pesquisados.

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

SearchMethod

O tipo de entidade da pesquisa.

Enums
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 Pesquise os dados de todas as contas da organização. Suporte apenas para o Gmail. Quando especificado, não é necessário especificar AccountInfo ou OrgUnitInfo.
ROOM Pesquise 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 a serem pesquisados

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 dos novos sites do Google a serem pesquisados

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 
{

  // Union field identifier can be only one of the following:
  "documentIds": {
    object (DriveDocumentIds)
  }
  // End of list of possible types for union field identifier.
}
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 pelo ID.

DriveDocumentIds

Especifique os documentos do Drive pelo 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 Team Drive, conforme fornecido pela API Drive.

MailOptions

Outras opções para a 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 sua organização usar a criptografia do lado do cliente do Google Workspace, o status de criptografia do conteúdo

Enums
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 Inclua conteúdo criptografado e não criptografado do lado do cliente 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 RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" 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 Google Workspace, apenas conteúdo não criptografado ou ambos. O padrão é os dois. No momento, o suporte é para o Drive.
sharedDrivesOption

enum (SharedDrivesOption)

Opcional. Opções para incluir ou excluir documentos em drives compartilhados. Recomendamos o uso desse 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 ser incluído.

Enums
SHARED_DRIVES_OPTION_UNSPECIFIED Nenhuma opção de drive compartilhado especificada.
NOT_INCLUDED Se um recurso estiver em um drive compartilhado, ele não vai aparecer nos resultados da pesquisa.
INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER Os recursos de drive compartilhado são incluídos apenas em casos em que a conta é colaboradora de um recurso, mas não é membro do drive compartilhado. Isso é mapeado para a 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" estava desativado)
INCLUDED Os recursos em drives compartilhados são incluídos na pesquisa. (Antes "includeSharedDrives" ativado)

HangoutsChatOptions

Opções adicionais para a pesquisa no 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 da Pesquisa por voz

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

enum (VoiceCoveredData)

Tipos de dados a serem pesquisados

CalendarOptions

Outras opções de pesquisa da 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 fornecido. Se a string contiver frases entre aspas, esse método só vai corresponder aos eventos cujo local contiver a frase exata. As entradas no conjunto são consideradas em "e".

Exemplo de divisão de palavras: ["Nova Zelândia"] vs ["Nova","Zelândia"] "Nova Zelândia": corresponde a "Nova e melhor Zelândia": corresponde apenas ao último
peopleQuery[]

string

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

string

Corresponde apenas aos eventos que não contêm nenhuma das palavras do 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)

Representa apenas eventos para os quais 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 RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" 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.

Enums
ATTENDEE_RESPONSE_UNSPECIFIED A resposta do participante não foi especificada. Se essa opção estiver definida, nenhuma filtragem será feita nas respostas, e todas as outras respostas dos participantes que fazem parte das opções de consulta serão ignoradas.
ATTENDEE_RESPONSE_NEEDS_ACTION O participante recebeu o convite, mas ainda não respondeu.
ATTENDEE_RESPONSE_ACCEPTED O participante planeja participar.
ATTENDEE_RESPONSE_DECLINED O participante não pretende participar.
ATTENDEE_RESPONSE_TENTATIVE O participante espera participar.

GeminiOptions

Esse tipo não tem campos.

Outras opções de pesquisa do Gemini