- Representación JSON
- DataScope
- SearchMethod
- AccountInfo
- OrgUnitInfo
- SharedDriveInfo
- HangoutsChatInfo
- SitesUrlInfo
- TeamDriveInfo
- MailOptions
- ClientSideEncryptedOption
- DriveOptions
- HangoutsChatOptions
- VoiceOptions
- CalendarOptions
- AttendeeResponse
La definición de la consulta que se usa para la búsqueda y la exportación.
Representación JSON |
---|
{ "corpus": enum ( |
Campos | |
---|---|
corpus |
El servicio de Google Workspace para realizar búsquedas. |
dataScope |
La fuente de datos en la que se buscará. |
searchMethod |
El método de búsqueda que se usará. |
method |
La entidad que se va a buscar. Este campo reemplaza a searchMethod para admitir unidades compartidas. Cuando searchMethod es TEAM_Drive, la respuesta de este campo es SHARED_Drive. |
terms |
Operadores de búsqueda específicos del servicio para filtrar los resultados de la búsqueda |
startTime |
Hora de inicio de la búsqueda. Especifícalo en GMT. El valor se redondea a las 12 a.m. de la fecha especificada. Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
endTime |
Indica la hora de finalización de la búsqueda. Especifícalo en GMT. El valor se redondea a las 12 a.m. de la fecha especificada. Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
teamDriveInfo |
Es obligatorio cuando SearchMethod es TEAM_Drive. |
timeZone |
El nombre de la zona horaria. Debe ser un nombre TZ de 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 es necesario, los detalles de las entidades para buscar search_method_field pueden ser solo uno de los siguientes: |
|
accountInfo |
Es obligatorio cuando SearchMethod es ACCOUNT. |
orgUnitInfo |
Obligatorio cuando SearchMethod es ORG_UNIT. |
sharedDriveInfo |
Es obligatorio cuando SearchMethod es SHARED_Drive. |
hangoutsChatInfo |
Es obligatorio cuando SearchMethod es ROOM. (solo lectura) |
sitesUrlInfo |
Es 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 |
Establece las opciones específicas de búsqueda de Gmail. |
driveOptions |
Establece las opciones específicas de búsqueda de Drive. |
hangoutsChatOptions |
Establece opciones específicas de búsqueda en Chat. (solo lectura) |
voiceOptions |
Establece opciones específicas de la búsqueda por voz. |
calendarOptions |
Establece opciones específicas para la búsqueda de Calendario. |
DataScope
Es la fuente de los datos que se buscarán.
Enumeraciones | |
---|---|
DATA_SCOPE_UNSPECIFIED |
No se especificó ninguna fuente de datos. |
ALL_DATA |
Todos los datos disponibles. |
HELD_DATA |
Solo los datos están en espera. |
UNPROCESSED_DATA |
Solo los datos que Vault aún no haya procesado. (Solo Gmail y Grupos) |
SearchMethod
El tipo de entidad para la búsqueda.
Enumeraciones | |
---|---|
SEARCH_METHOD_UNSPECIFIED |
Debes 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 que se especifica en teamDriveInfo. |
ENTIRE_ORG |
Buscar los datos de todas las cuentas de la organización Compatible solo con Gmail. Si lo especificas, no es necesario que especifiques AccountInfo ni 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 que se especificaron en SharedDriveInfo. |
AccountInfo
Las cuentas en las que se buscará
Representación JSON |
---|
{ "emails": [ string ] } |
Campos | |
---|---|
emails[] |
Un conjunto de cuentas para realizar búsquedas. |
OrgUnitInfo
La unidad organizativa en la que se realizará la búsqueda
Representación JSON |
---|
{ "orgUnitId": string } |
Campos | |
---|---|
orgUnitId |
Es el nombre de la unidad organizativa que se buscará, tal como lo proporciona la API de Directory del SDK de Admin. |
HangoutsChatInfo
Los espacios de Chat en los que se realizará la búsqueda
Representación JSON |
---|
{ "roomId": [ string ] } |
Campos | |
---|---|
roomId[] |
Una lista de IDs de espacios de Chat, como los proporciona la API de Chat Existe un límite para exportar desde 500 espacios de Chat por solicitud. |
SitesUrlInfo
Las URLs de los sitios publicados de los nuevos sitios de Google en los que se realizará la búsqueda
Representación JSON |
---|
{ "urls": [ string ] } |
Campos | |
---|---|
urls[] |
Una lista de las URLs publicadas de los sitios |
TeamDriveInfo
Unidades de equipo para realizar búsquedas
Representación JSON |
---|
{ "teamDriveIds": [ string ] } |
Campos | |
---|---|
teamDriveIds[] |
Lista de IDs de unidades de equipo, que proporciona la API de Drive. |
MailOptions
Opciones adicionales para la búsqueda de Gmail
Representación JSON |
---|
{
"excludeDrafts": boolean,
"clientSideEncryptedOption": enum ( |
Campos | |
---|---|
excludeDrafts |
Configúralo como true para excluir borradores. |
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
Enumeraciones | |
---|---|
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 contenido con encriptación del cliente y no encriptado en los resultados. |
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED |
Incluye solo contenido con encriptación del cliente. |
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED |
Incluye solo contenido no encriptado. |
DriveOptions
Opciones adicionales para la búsqueda en Drive
Representación JSON |
---|
{
"versionDate": string,
"includeTeamDrives": boolean,
"includeSharedDrives": boolean,
"clientSideEncryptedOption": enum ( |
Campos | |
---|---|
versionDate |
Busca la versión actual del archivo de Drive, pero exporta el contenido de la última versión que se guardó 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 una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
includeTeamDrives |
Se establece como verdadero para incluir la unidad de equipo. |
includeSharedDrives |
Configúralo como true para incluir las unidades compartidas. |
clientSideEncryptedOption |
Establece si los resultados incluyen solo contenido encriptado con encriptación del cliente de Google Workspace, solo contenido no encriptado o ambos. La configuración predeterminada es ambos. Actualmente compatible con Drive. |
HangoutsChatOptions
Opciones adicionales para la búsqueda de Google Chat
Representación JSON |
---|
{ "includeRooms": boolean } |
Campos | |
---|---|
includeRooms |
En el caso de las búsquedas por cuenta o por unidad organizativa, establécelo en true para incluir salas. |
VoiceOptions
Opciones adicionales para la búsqueda por voz
Representación JSON |
---|
{
"coveredData": [
enum ( |
Campos | |
---|---|
coveredData[] |
Tipos de datos para buscar |
CalendarOptions
Opciones adicionales para la búsqueda del Calendario
Representación JSON |
---|
{
"locationQuery": [
string
],
"peopleQuery": [
string
],
"minusWords": [
string
],
"responseStatuses": [
enum ( |
Campos | |
---|---|
locationQuery[] |
Coincide solo con los eventos cuya ubicación contiene todas las palabras del conjunto determinado. Si la cadena contiene frases entrecomilladas, este método solo hace coincidir 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 "New and Better Zealand": solo coincide con la siguiente |
peopleQuery[] |
Coincide solo con aquellos eventos cuyos asistentes contienen todas las palabras del conjunto determinado. Las entradas del conjunto se consideran en "y". |
minusWords[] |
Coincide solo con los eventos que no contienen 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[] |
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 aplicarán filtros en las respuestas. |
versionDate |
Busca la versión actual del evento del Calendario, pero exporta el contenido de la última versión que se guardó 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 una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
AttendeeResponse
Respuesta del usuario a una invitación.
Enumeraciones | |
---|---|
ATTENDEE_RESPONSE_UNSPECIFIED |
Respuesta de los asistentes no especificada. Si esta opción está configurada, no se aplicará ningún filtro a las respuestas, por lo que se ignorarán todas las respuestas de los asistentes que formen parte de las opciones de consulta. |
ATTENDEE_RESPONSE_NEEDS_ACTION |
Se invitó al participante, pero aún no ha respondido. |
ATTENDEE_RESPONSE_ACCEPTED |
El participante planea asistir. |
ATTENDEE_RESPONSE_DECLINED |
El participante no planea asistir. |
ATTENDEE_RESPONSE_TENTATIVE |
El participante espera asistir. |