Query

La definición de consulta utilizada para la búsqueda y la exportación.

Representación 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.
}
Campos
corpus

enum (CorpusType)

El servicio de Google Workspace que se debe buscar.
dataScope

enum (DataScope)

La fuente de datos que se buscará.
searchMethod
(deprecated)

enum (SearchMethod)

Es el método de búsqueda que se usará.
method

enum (SearchMethod)

La entidad que se buscará. Este campo reemplaza a searchMethod para admitir unidades compartidas. Cuando searchMethod es TEAM_DRIVE, la respuesta de este campo es SHARED_DRIVE.
terms

string

Operadores de búsqueda específicos del servicio para filtrar los resultados de la búsqueda
startTime

string (Timestamp format)

La hora de inicio de la búsqueda. Especifica en GMT. El valor se redondea a las 12 a.m. en la fecha especificada.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Es la hora de finalización de la búsqueda. Especifica en GMT. El valor se redondea a las 12 a.m. en la fecha especificada.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

Obligatorio cuando SearchMethod es TEAM_DRIVE.
timeZone

string

El nombre de la zona horaria. Debe ser un nombre de la TZ de la IANA, como “America/Los_Angeles”. Para obtener una lista de los nombres de zonas horarias, consulta Zona horaria. Para obtener más información sobre cómo Vault usa las zonas horarias, consulte el Centro de ayuda de Vault.
Campo de unión search_method_field. Cuando sea necesario, los detalles de las entidades en las que se buscará search_method_field pueden ser solo una de las siguientes opciones:
accountInfo

object (AccountInfo)

Obligatorio cuando SearchMethod es ACCOUNT.
orgUnitInfo

object (OrgUnitInfo)

Obligatorio cuando SearchMethod es ORG_UNIT.
sharedDriveInfo

object (SharedDriveInfo)

Obligatorio cuando SearchMethod es SHARED_DRIVE.
hangoutsChatInfo

object (HangoutsChatInfo)

Obligatorio cuando SearchMethod es ROOM. (solo lectura)
sitesUrlInfo

object (SitesUrlInfo)

Obligatorio cuando SearchMethod es SITES_URL.
Campo de unión corpus_options_field. Opciones de búsqueda adicionales para servicios específicos. Las direcciones (corpus_options_field) solo pueden ser una de las siguientes opciones:
mailOptions

object (MailOptions)

Configura opciones específicas de búsqueda de Gmail.
driveOptions

object (DriveOptions)

Establece opciones específicas de búsqueda de Drive.
hangoutsChatOptions

object (HangoutsChatOptions)

Configura las opciones específicas de la búsqueda de Chat. (solo lectura)
voiceOptions

object (VoiceOptions)

Configura opciones específicas de la Búsqueda por voz.
calendarOptions

object (CalendarOptions)

Establezca opciones específicas para la búsqueda del Calendario.

DataScope

La fuente de datos que se buscará.

Enumeradores
DATA_SCOPE_UNSPECIFIED No se especificó ninguna fuente de datos.
ALL_DATA Todos los datos disponibles
HELD_DATA Solo los datos están retenidos.
UNPROCESSED_DATA Solo los datos que Vault aún no ha procesado. (Solo Gmail y Grupos)

SearchMethod

El tipo de entidad de la búsqueda.

Enumeradores
SEARCH_METHOD_UNSPECIFIED Se debe especificar un método de búsqueda; de lo contrario, se rechazará.
ACCOUNT Busca los datos de las cuentas especificadas en AccountInfo.
ORG_UNIT Busca los datos de todas las cuentas de la unidad organizativa especificada en OrgUnitInfo.
TEAM_DRIVE

Busca los datos de la unidad de equipo especificada en teamDriveInfo.
ENTIRE_ORG Buscar los datos de todas las cuentas de la organización Compatible solo con Gmail. Cuando se especifica, no necesitas especificar AccountInfo o OrgUnitInfo.
ROOM Busca mensajes en los espacios de Chat especificados en HangoutsChatInfo.
SITES_URL Busca sitios mediante las URL publicadas que se especifican en SitesUrlInfo.
SHARED_DRIVE Busca los archivos de las unidades compartidas especificadas en SharedDriveInfo.

AccountInfo

Las cuentas en las que se buscará

Representación JSON 
{
  "emails": [
    string
  ]
}
Campos
emails[]

string

Un conjunto de cuentas para realizar búsquedas.

OrgUnitInfo

La unidad organizativa para buscar

Representación JSON 
{
  "orgUnitId": string
}
Campos
orgUnitId

string

Es el nombre de la unidad organizativa en la que se buscará, tal como lo proporciona la API de Directory del SDK de Admin.

SharedDriveInfo

Las unidades compartidas para buscar

Representación JSON 
{
  "sharedDriveIds": [
    string
  ]
}
Campos
sharedDriveIds[]

string

Una lista de los IDs de unidades compartidas, como lo proporciona la API de Drive

HangoutsChatInfo

Los espacios de Chat para realizar búsquedas

Representación JSON 
{
  "roomId": [
    string
  ]
}
Campos
roomId[]

string

Una lista de los IDs de espacios de Chat, como lo proporciona la API de Chat. Hay un límite de exportación de 500 espacios de Chat por solicitud.

SitesUrlInfo

Las URLs publicadas de los sitios de los nuevos sitios de Google que se buscarán

Representación JSON 
{
  "urls": [
    string
  ]
}
Campos
urls[]

string

Es una lista de las URLs de sitios publicadas.

TeamDriveInfo

Unidades de equipo para buscar

Representación JSON 
{
  "teamDriveIds": [
    string
  ]
}
Campos
teamDriveIds[]
(deprecated)

string

Lista de ID de unidades de equipo, proporcionada por la API de Drive.

MailOptions

Opciones adicionales para la búsqueda en Gmail

Representación JSON 
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Campos
excludeDrafts

boolean

Configúralo como true para excluir borradores.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Especifica si los resultados deben incluir contenido encriptado, contenido no encriptado o ambos. La configuración predeterminada incluye ambos.

ClientSideEncryptedOption

Si tu organización usa la encriptación del cliente de Google Workspace, el estado de encriptación del contenido

Enumeradores
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED Estado de encriptación sin especificar. Los resultados incluyen contenido con encriptación del cliente y contenido no encriptado.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Incluye en los resultados contenido con encriptación del cliente y contenido no encriptado.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Incluye solo contenido con encriptación del cliente.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Incluye solo contenido sin encriptar.

DriveOptions

Opciones adicionales para la búsqueda en Drive

Representación JSON 
{
  "versionDate": string,
  "includeTeamDrives": boolean,
  "includeSharedDrives": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Campos
versionDate

string (Timestamp format)

Busca en la versión actual del archivo de Drive, pero exporta el contenido de la última versión guardada antes de las 12:00 a.m. UTC de la fecha especificada. Ingresa la fecha en UTC.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
includeTeamDrives
(deprecated)

boolean

Se establece como verdadero para incluir la unidad de equipo.
includeSharedDrives

boolean

Configúralo como true para incluir unidades compartidas.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Establece si los resultados incluyen solo contenido encriptado con contenido de encriptación del cliente de Google Workspace, solo contenido sin encriptar o ambos. La configuración predeterminada es ambas. Actualmente compatible con Drive.

HangoutsChatOptions

Opciones adicionales para la búsqueda de Google Chat

Representación JSON 
{
  "includeRooms": boolean
}
Campos
includeRooms

boolean

En las búsquedas por cuenta o unidad organizativa, establécelo en true para incluir salas.

VoiceOptions

Opciones adicionales para la búsqueda por voz

Representación JSON 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Campos
coveredData[]

enum (VoiceCoveredData)

Tipos de datos que se buscarán

CalendarOptions

Opciones adicionales para la búsqueda de Calendario

Representación JSON 
{
  "locationQuery": [
    string
  ],
  "peopleQuery": [
    string
  ],
  "minusWords": [
    string
  ],
  "responseStatuses": [
    enum (AttendeeResponse)
  ],
  "versionDate": string
}
Campos
locationQuery[]

string

Coincide solo con aquellos eventos cuya ubicación contenga todas las palabras del conjunto determinado. Si la cadena contiene frases entrecomilladas, este método solo busca coincidencias para los eventos cuya ubicación contiene la frase exacta. Las entradas del conjunto se consideran en "y".

Ejemplo de división de palabras: ["New Zealand"] vs. ["New","Zealand"] "New Zealand": coincide con "Nueva Zelanda y las mejores Zelanda": solo coincide con la posterior
peopleQuery[]

string

Coincide solo con los eventos cuyos asistentes contengan todas las palabras del conjunto determinado. Las entradas del conjunto se consideran en "y".
minusWords[]

string

Coincide solo con aquellos eventos que no contengan ninguna de las palabras del conjunto determinado en el título, la descripción, la ubicación o los asistentes. Las entradas del conjunto se consideran en "o".
responseStatuses[]

enum (AttendeeResponse)

Coincide solo con los eventos para los que el custodio dio una de estas respuestas. Si el conjunto está vacío o contiene ATTENDEE_RESPONSE_UNSPECIFIED, no se filtrarán las respuestas.
versionDate

string (Timestamp format)

Busca la versión actual del evento del Calendario, pero exporta el contenido de la última versión guardada antes de las 12:00 a.m. UTC de la fecha especificada. Ingresa la fecha en UTC.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

AttendeeResponse

Respuesta del usuario a una invitación.

Enumeradores
ATTENDEE_RESPONSE_UNSPECIFIED Respuesta del asistente sin especificar. Si se establece esta opción, no se aplicarán filtros en las respuestas, y se ignorarán todas las demás respuestas de los asistentes que formen parte de las opciones de consulta.
ATTENDEE_RESPONSE_NEEDS_ACTION Se invitó al participante, pero aún no respondió.
ATTENDEE_RESPONSE_ACCEPTED El participante planea asistir.
ATTENDEE_RESPONSE_DECLINED El participante no tiene previsto asistir.
ATTENDEE_RESPONSE_TENTATIVE El participante espera asistir.