Query

La definizione della query utilizzata per la ricerca e l'esportazione.

Rappresentazione 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.
}
Campi
corpus

enum (CorpusType)

Il servizio Google Workspace per eseguire ricerche.

dataScope

enum (DataScope)

L'origine dati in cui eseguire la ricerca.

searchMethod
(deprecated)

enum (SearchMethod)

Il metodo di ricerca da utilizzare.

method

enum (SearchMethod)

L'entità in cui eseguire la ricerca. Questo campo sostituisce searchMethod per supportare i Drive condivisi. Quando searchMethod è TEAM_Drive, la risposta a questo campo è SHARED_Drive.

terms

string

Operatori di ricerca specifici del servizio per filtrare i risultati.

startTime

string (Timestamp format)

L'ora di inizio della query di ricerca. Specifica in GMT. Il valore viene arrotondato alle 00:00 della data specificata.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

L'ora di fine della query di ricerca. Specifica in GMT. Il valore viene arrotondato alle 00:00 della data specificata.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

teamDriveInfo
(deprecated)

object (TeamDriveInfo)

Obbligatorio quando SearchMethod è TEAM_Drive.

timeZone

string

Il nome del fuso orario. Dovrebbe essere un nome IANA TZ, ad esempio "America/Los_Angeles". Per un elenco dei nomi dei fusi orari, vedi Fuso orario. Per ulteriori informazioni su come Vault utilizza i fusi orari, consulta il Centro assistenza Vault.

Campo unione search_method_field. Quando richiesto, i dettagli delle entità da cercare in search_method_field possono essere solo uno dei seguenti:
accountInfo

object (AccountInfo)

Obbligatorio quando SearchMethod è ACCOUNT.

orgUnitInfo

object (OrgUnitInfo)

Obbligatorio quando SearchMethod è ORG_UNIT.

sharedDriveInfo

object (SharedDriveInfo)

Obbligatorio quando SearchMethod è SHARED_Drive.

hangoutsChatInfo

object (HangoutsChatInfo)

Obbligatorio quando SearchMethod è ROOM. (sola lettura)

sitesUrlInfo

object (SitesUrlInfo)

Obbligatorio quando SearchMethod è SITES_URL.

Campo unione corpus_options_field. Opzioni di ricerca aggiuntive per servizi specifici. corpus_options_field può essere solo uno dei seguenti:
mailOptions

object (MailOptions)

Impostare opzioni specifiche per la ricerca di Gmail.

driveOptions

object (DriveOptions)

Imposta opzioni specifiche per la ricerca di Drive.

hangoutsChatOptions

object (HangoutsChatOptions)

Impostare le opzioni specifiche per la ricerca di Chat. (sola lettura)

voiceOptions

object (VoiceOptions)

Imposta opzioni specifiche per la ricerca vocale.

calendarOptions

object (CalendarOptions)

Impostare opzioni specifiche per la ricerca di Calendar.

DataScope

L'origine dei dati in cui eseguire la ricerca.

Enum
DATA_SCOPE_UNSPECIFIED Nessuna origine dati specificata.
ALL_DATA Tutti i dati disponibili.
HELD_DATA Solo i dati sottoposti a blocco.
UNPROCESSED_DATA Solo i dati non ancora elaborati da Vault. (solo Gmail e Gruppi)

SearchMethod

Il tipo di entità per la ricerca.

Enum
SEARCH_METHOD_UNSPECIFIED È necessario specificare un metodo di ricerca, altrimenti viene rifiutato.
ACCOUNT Cerca i dati degli account specificati in AccountInfo.
ORG_UNIT Cerca i dati di tutti gli account dell'unità organizzativa specificata in OrgUnitInfo.
TEAM_DRIVE

Cerca i dati nel Drive del team specificato in teamDriveInfo.

ENTIRE_ORG Cercare i dati di tutti gli account dell'organizzazione. Supportata solo per Gmail. Se specificato, non devi specificare AccountInfo o OrgUnitInfo.
ROOM Cerca i messaggi negli spazi di Chat specificati in HangoutsChatInfo.
SITES_URL Cerca i siti in base agli URL dei siti pubblicati specificati in SitesUrlInfo.
SHARED_DRIVE Cerca i file nei Drive condivisi specificati in SharedDriveInfo.

AccountInfo

Gli account in cui eseguire la ricerca

Rappresentazione JSON
{
  "emails": [
    string
  ]
}
Campi
emails[]

string

Un insieme di account in cui eseguire ricerche.

OrgUnitInfo

L'unità organizzativa in cui cercare

Rappresentazione JSON
{
  "orgUnitId": string
}
Campi
orgUnitId

string

Il nome dell'unità organizzativa in cui cercare, come fornito dall'API Admin SDK Directory.

SharedDriveInfo

I Drive condivisi in cui cercare

Rappresentazione JSON
{
  "sharedDriveIds": [
    string
  ]
}
Campi
sharedDriveIds[]

string

Un elenco di ID dei Drive condivisi, fornito dall'API Drive.

HangoutsChatInfo

Spazi di Chat in cui cercare

Rappresentazione JSON
{
  "roomId": [
    string
  ]
}
Campi
roomId[]

string

Un elenco di ID degli spazi di Chat, fornito dall'API Chat. Esiste un limite di esportazione da 500 spazi di Chat per richiesta.

SitesUrlInfo

Gli URL dei siti pubblicati della nuova versione di Google Sites in cui eseguire la ricerca

Rappresentazione JSON
{
  "urls": [
    string
  ]
}
Campi
urls[]

string

Un elenco di URL dei siti pubblicati.

TeamDriveInfo

Drive del team per eseguire ricerche

Rappresentazione JSON
{
  "teamDriveIds": [
    string
  ]
}
Campi
teamDriveIds[]
(deprecated)

string

Elenco di ID dei Drive del team, come fornito dall'API Drive.

MailOptions

Opzioni aggiuntive per la ricerca di Gmail

Rappresentazione JSON
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Campi
excludeDrafts

boolean

Impostalo su true per escludere le bozze.

clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Specifica se i risultati devono includere contenuti criptati, contenuti non criptati o entrambi. Per impostazione predefinita, vengono inclusi entrambi.

ClientSideEncryptedOption

Se la tua organizzazione utilizza la crittografia lato client di Google Workspace, lo stato della crittografia dei contenuti.

Enum
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED Stato crittografia non specificato. I risultati includono sia i contenuti con crittografia lato client sia quelli non criptati.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Includi nei risultati sia contenuti con crittografia lato client sia contenuti non criptati.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Includi solo contenuti con crittografia lato client.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Includi solo contenuti non criptati.

DriveOptions

Opzioni aggiuntive per la ricerca di Drive

Rappresentazione JSON
{
  "versionDate": string,
  "includeTeamDrives": boolean,
  "includeSharedDrives": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Campi
versionDate

string (Timestamp format)

Cerca nella versione corrente del file di Drive, ma esporta i contenuti dell'ultima versione salvata prima delle ore 00:00 UTC della data specificata. Inserisci la data nel fuso orario UTC.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

includeTeamDrives
(deprecated)

boolean

Impostalo su true per includere il Drive del team.

includeSharedDrives

boolean

Impostalo su true per includere i Drive condivisi.

clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Scegli se i risultati devono includere solo contenuti criptati con contenuti della crittografia lato client di Google Workspace, solo contenuti non criptati o entrambi. Il valore predefinito è entrambi. Attualmente supportato per Drive.

HangoutsChatOptions

Opzioni aggiuntive per la ricerca in Google Chat

Rappresentazione JSON
{
  "includeRooms": boolean
}
Campi
includeRooms

boolean

Per le ricerche per account o unità organizzativa, imposta su true per includere le stanze virtuali.

VoiceOptions

Opzioni aggiuntive per la ricerca vocale

Rappresentazione JSON
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Campi
coveredData[]

enum (VoiceCoveredData)

Tipi di dati in cui cercare

CalendarOptions

Opzioni aggiuntive per la ricerca in Calendar

Rappresentazione JSON
{
  "locationQuery": [
    string
  ],
  "peopleQuery": [
    string
  ],
  "minusWords": [
    string
  ],
  "responseStatuses": [
    enum (AttendeeResponse)
  ],
  "versionDate": string
}
Campi
locationQuery[]

string

Corrisponde solo agli eventi la cui località contiene tutte le parole dell'insieme specificato. Se la stringa contiene frasi racchiuse tra virgolette, questo metodo genera corrispondenze solo per gli eventi il cui percorso contiene la frase esatta. Le voci nel set vengono considerate in "and".

Esempio di suddivisione delle parole: ["Nuova Zelanda"] rispetto a ["Nuova","Zealand"] "Nuova Zelanda": corrisponde sia a "Nuova Zelanda sia a quella migliore": corrisponde solo alla successiva

peopleQuery[]

string

Corrisponde solo agli eventi i cui partecipanti contengono tutte le parole del set specificato. Le voci nel set vengono considerate in "and".

minusWords[]

string

Corrisponde solo agli eventi che non contengono nessuna delle parole nell'insieme dato nel titolo, nella descrizione, nel luogo o nei partecipanti. Le voci nel set vengono considerate in "or".

responseStatuses[]

enum (AttendeeResponse)

Corrisponde solo agli eventi per cui il custode ha dato una di queste risposte. Se l'insieme è vuoto o contiene ATTENDEE_ANSWER_UNSPECIFIED, non ci saranno filtri sulle risposte.

versionDate

string (Timestamp format)

Cerca nella versione corrente dell'evento di Calendar, ma esporta i contenuti dell'ultima versione salvata prima delle ore 00:00 UTC della data specificata. Inserisci la data nel fuso orario UTC.

Un timestamp nel formato RFC3339 UTC "Zulu" con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

AttendeeResponse

Risposta dell'utente a un invito.

Enum
ATTENDEE_RESPONSE_UNSPECIFIED Risposta del partecipante non specificata. Se questa impostazione è impostata, non verranno applicati filtri alle risposte, tutte le altre risposte dei partecipanti che fanno parte delle opzioni della query verranno ignorate.
ATTENDEE_RESPONSE_NEEDS_ACTION Il partecipante è stato invitato, ma non ha ancora risposto.
ATTENDEE_RESPONSE_ACCEPTED Il partecipante prevede di partecipare.
ATTENDEE_RESPONSE_DECLINED Il partecipante non ha intenzione di partecipare.
ATTENDEE_RESPONSE_TENTATIVE Il partecipante si aspetta di partecipare.