- Representação JSON
- DataScope
- SearchMethod
- AccountInfo
- OrgUnitInfo
- SharedDriveInfo
- HangoutsChatInfo
- SitesUrlInfo
- TeamDriveInfo
- MailOptions
- ClientSideEncryptedOption
- DriveOptions
- HangoutsChatOptions
- VoiceOptions
- CalendarOptions
- AttendeeResponse
A definição da consulta usada para pesquisa e exportação.
Representação JSON |
---|
{ "corpus": enum ( |
Campos | |
---|---|
corpus |
O serviço do Google Workspace para pesquisar. |
dataScope |
A fonte de dados a ser pesquisada. |
searchMethod |
O método de pesquisa a ser usado. |
method |
A entidade a ser pesquisada. Este campo substitui searchMethod para oferecer suporte aos drives compartilhados. Quando searchMethod é TEAM_DRIVE, a resposta desse campo é SHARED_DRIVE. |
terms |
Operadores de pesquisa específicos do serviço para filtrar os resultados da pesquisa |
startTime |
O horário de início da consulta de pesquisa. Especifique em GMT. O valor é arredondado para 0h na data especificada. Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
endTime |
A hora de término da consulta de pesquisa. Especifique em GMT. O valor é arredondado para 0h na data especificada. Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
teamDriveInfo |
Obrigatório quando SearchMethod é TEAM_DRIVE. |
timeZone |
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. Veja mais informações sobre como o Vault usa os fusos horários na Central de Ajuda do Vault. |
Campo de união search_method_field . Quando necessário, os detalhes das entidades para pesquisar search_method_field podem ser apenas um dos seguintes: |
|
accountInfo |
Obrigatório quando SearchMethod é ACCOUNT. |
orgUnitInfo |
Obrigatório quando SearchMethod é ORG_UNIT. |
sharedDriveInfo |
Obrigatório quando SearchMethod é SHARED_DRIVE. |
hangoutsChatInfo |
Obrigatório quando SearchMethod é ROOM. (somente leitura) |
sitesUrlInfo |
Obrigatório quando SearchMethod é SITES_URL. |
Campo de união corpus_options_field . Opções de pesquisa adicionais para serviços específicos. corpus_options_field pode ser apenas de um dos tipos a seguir: |
|
mailOptions |
Defina opções específicas de pesquisa do Gmail. |
driveOptions |
Defina opções específicas de pesquisa do Drive. |
hangoutsChatOptions |
Defina opções específicas de pesquisa no Chat. (somente leitura) |
voiceOptions |
Defina opções específicas da pesquisa por voz. |
calendarOptions |
Defina opções específicas de pesquisa do Google Agenda. |
DataScope
A fonte de dados a ser pesquisada.
Enums | |
---|---|
DATA_SCOPE_UNSPECIFIED |
Nenhuma fonte de dados especificada. |
ALL_DATA |
Todos os dados disponíveis. |
HELD_DATA |
Somente dados em guarda de documentos. |
UNPROCESSED_DATA |
Somente dados ainda não processados pelo Vault. (somente Gmail e Grupos do Google) |
SearchMethod
O tipo de entidade da pesquisa.
Enums | |
---|---|
SEARCH_METHOD_UNSPECIFIED |
É necessário especificar um método de pesquisa. Caso contrário, ele será rejeitado. |
ACCOUNT |
Pesquisa 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. Compatível apenas com o Gmail. Quando definido, você não precisa especificar AccountInfo ou OrgUnitInfo. |
ROOM |
Pesquise mensagens nos espaços do Chat especificados em HangoutsChatInfo. |
SITES_URL |
Pesquise sites pelos URLs dos sites publicados especificados em SitesUrlInfo. |
SHARED_DRIVE |
Pesquise os arquivos nos drives compartilhados especificados em SharedDriveInfo. |
AccountInfo
As contas a serem pesquisadas
Representação JSON |
---|
{ "emails": [ string ] } |
Campos | |
---|---|
emails[] |
Um conjunto de contas para pesquisar. |
OrgUnitInfo
A unidade organizacional a ser pesquisada
Representação JSON |
---|
{ "orgUnitId": string } |
Campos | |
---|---|
orgUnitId |
O nome da unidade organizacional a ser pesquisada, conforme fornecido pela API Admin SDK Directory. |
HangoutsChatInfo
Os espaços do Chat para pesquisar
Representação JSON |
---|
{ "roomId": [ string ] } |
Campos | |
---|---|
roomId[] |
Uma lista de IDs dos 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 pesquisa
Representação JSON |
---|
{ "urls": [ string ] } |
Campos | |
---|---|
urls[] |
Uma lista de URLs de sites publicados. |
TeamDriveInfo
Drives de equipe para pesquisar
Representação JSON |
---|
{ "teamDriveIds": [ string ] } |
Campos | |
---|---|
teamDriveIds[] |
Lista de IDs de Drive de equipe fornecida pela API Drive. |
MailOptions
Outras opções para a pesquisa do Gmail
Representação JSON |
---|
{
"excludeDrafts": boolean,
"clientSideEncryptedOption": enum ( |
Campos | |
---|---|
excludeDrafts |
Defina como true para excluir rascunhos. |
clientSideEncryptedOption |
Especifica se os resultados precisam incluir conteúdo criptografado, não criptografado ou ambos. O padrão é incluir ambos. |
ClientSideEncryptedOption
Caso sua organização use a criptografia do lado do cliente Google Workspace, o status da 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 |
Incluir nos resultados conteúdo criptografado e não criptografado do lado do cliente. |
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED |
Incluir apenas conteúdo criptografado do lado do cliente. |
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED |
Incluir apenas conteúdo não criptografado. |
DriveOptions
Outras opções de pesquisa no Drive
Representação JSON |
---|
{
"versionDate": string,
"includeTeamDrives": boolean,
"includeSharedDrives": boolean,
"clientSideEncryptedOption": enum ( |
Campos | |
---|---|
versionDate |
Pesquisar a versão atual do arquivo do Drive, mas exportar o conteúdo da última versão salva antes de 0h00 (UTC) na data especificada. Insira a data em UTC. Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
includeTeamDrives |
Defina como verdadeiro para incluir o Drive de equipe. |
includeSharedDrives |
Defina como true para incluir drives compartilhados. |
clientSideEncryptedOption |
Defina se os resultados incluem apenas conteúdo criptografado com criptografia do lado do cliente Google Workspace, somente conteúdo não criptografado ou ambos. O padrão é ambos. Atualmente compatível com o Google Drive. |
HangoutsChatOptions
Mais opções para a pesquisa do Google Chat
Representação JSON |
---|
{ "includeRooms": boolean } |
Campos | |
---|---|
includeRooms |
Nas pesquisas por conta ou unidade organizacional, defina como true para incluir as salas. |
VoiceOptions
Outras opções para a pesquisa por voz
Representação JSON |
---|
{
"coveredData": [
enum ( |
Campos | |
---|---|
coveredData[] |
Tipos de dados a serem pesquisados |
CalendarOptions
Mais opções para a pesquisa do Google Agenda
Representação JSON |
---|
{
"locationQuery": [
string
],
"peopleQuery": [
string
],
"minusWords": [
string
],
"responseStatuses": [
enum ( |
Campos | |
---|---|
locationQuery[] |
Corresponde apenas aos eventos cujo local contém todas as palavras do conjunto especificado. Se a string tiver frases entre aspas, esse método só vai corresponder aos eventos cujo local tenha a frase exata. Entradas no conjunto são consideradas em "and". Exemplo de divisão de palavras: ["Nova Zelândia"] vs ["Nova","Zealand"] "Nova Zelândia": correspondido por "Nova e melhor Zelândia": correspondido somente pelo |
peopleQuery[] |
Corresponde apenas aos eventos cujos participantes contêm todas as palavras do conjunto especificado. Entradas no conjunto são consideradas em "and". |
minusWords[] |
Corresponde apenas aos eventos que não contêm nenhuma das palavras no conjunto especificado em título, descrição, local ou participantes. Entradas no conjunto são consideradas em "ou". |
responseStatuses[] |
Corresponde apenas a 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 |
Pesquisar a versão atual do evento do Google Agenda, mas exportar o conteúdo da última versão salva antes de 0h00 (UTC) na data especificada. Insira a data em UTC. Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
AttendeeResponse
Resposta do usuário a um convite.
Enums | |
---|---|
ATTENDEE_RESPONSE_UNSPECIFIED |
Resposta do participante não especificada. Se esta opção estiver definida, nenhuma filtragem nas respostas será aplicada, todas as outras respostas dos participantes que fizerem 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 participar. |
ATTENDEE_RESPONSE_DECLINED |
O participante não pretende participar. |
ATTENDEE_RESPONSE_TENTATIVE |
O participante pretende participar. |