Query

Die Abfragedefinition, die für die Suche und den Export verwendet wird.

JSON-Darstellung 
{
  "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.
}
Felder
corpus

enum (CorpusType)

Der Google Workspace-Dienst, in dem gesucht werden soll.
dataScope

enum (DataScope)

Die Datenquelle, nach der gesucht werden soll.
searchMethod
(deprecated)

enum (SearchMethod)

Die zu verwendende Suchmethode.
method

enum (SearchMethod)

Die Entität, nach der gesucht werden soll. Dieses Feld ersetzt searchMethod, um geteilte Ablagen zu unterstützen. Wenn searchMethod den Wert TEAM_DRIVE hat, ist die Antwort dieses Felds SHARED_DRIVE.
terms

string

Dienstspezifische Suchoperatoren zum Filtern von Suchergebnissen.
startTime

string (Timestamp format)

Die Startzeit der Suchanfrage. Geben Sie dies in GMT an. Der Wert wird am angegebenen Datum auf 12 Uhr gerundet.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Die Endzeit der Suchanfrage. Geben Sie dies in GMT an. Der Wert wird am angegebenen Datum auf 12 Uhr gerundet.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

Erforderlich, wenn SearchMethod den Wert TEAM_DRIVE hat.
timeZone

string

Der Zeitzonenname. Es sollte ein IANA-TZ-Name wie "America/Los_Angeles" sein. Eine Liste der Zeitzonennamen finden Sie unter Zeitzone. Weitere Informationen zur Verwendung von Zeitzonen in Vault finden Sie in der Vault-Hilfe.
Union-Feld search_method_field. Bei Bedarf können die Details der zu durchsuchenden Entitäten search_method_field nur eines der folgenden sein:
accountInfo

object (AccountInfo)

Erforderlich, wenn SearchMethod den Wert ACCOUNT hat.
orgUnitInfo

object (OrgUnitInfo)

Erforderlich, wenn SearchMethod den Wert ORG_UNIT hat.
sharedDriveInfo

object (SharedDriveInfo)

Erforderlich, wenn SearchMethod gleich SHARED_DRIVE ist.
hangoutsChatInfo

object (HangoutsChatInfo)

Erforderlich, wenn SearchMethod den Wert ROOM hat. (schreibgeschützt)
sitesUrlInfo

object (SitesUrlInfo)

Erforderlich, wenn SearchMethod gleich SITES_URL ist.
Union-Feld corpus_options_field. Zusätzliche Suchoptionen für bestimmte Dienste. Für corpus_options_field ist nur einer der folgenden Werte zulässig:
mailOptions

object (MailOptions)

Sie können für die Gmail-Suche spezifische Optionen festlegen.
driveOptions

object (DriveOptions)

Suchspezifische Optionen für Drive festlegen
hangoutsChatOptions

object (HangoutsChatOptions)

Sie können für die Chatsuche spezifische Optionen festlegen. (schreibgeschützt)
voiceOptions

object (VoiceOptions)

Legen Sie spezifische Optionen für die Sprachsuche fest.
calendarOptions

object (CalendarOptions)

Sie können für die Kalendersuche spezifische Optionen festlegen.

DataScope

Die Datenquelle für die Suche.

Enums
DATA_SCOPE_UNSPECIFIED Keine Datenquelle angegeben.
ALL_DATA Alle verfügbaren Daten.
HELD_DATA Nur auf „Hold“ gesetzte Daten.
UNPROCESSED_DATA Nur Daten, die noch nicht von Vault verarbeitet wurden. (nur Gmail und Google Groups)

SearchMethod

Der Entitätstyp für die Suche.

Enums
SEARCH_METHOD_UNSPECIFIED Es muss eine Suchmethode angegeben werden, da sie andernfalls abgelehnt wird.
ACCOUNT Es wird in den Daten der unter AccountInfo angegebenen Konten gesucht.
ORG_UNIT Es wird in den Daten aller Konten in der Organisationseinheit gesucht, die in OrgUnitInfo angegeben ist.
TEAM_DRIVE

Sie können die Daten in der geteilten Ablage durchsuchen, die in teamDriveInfo angegeben ist.
ENTIRE_ORG Es wird in den Daten aller Konten in der Organisation gesucht. Diese Einstellung wird nur für Gmail unterstützt. Wenn angegeben, müssen Sie AccountInfo oder OrgUnitInfo nicht angeben.
ROOM Nachrichten in den in HangoutsChatInfo angegebenen Chatbereichen suchen
SITES_URL Suchen Sie anhand der veröffentlichten Website-URLs, die in SitesUrlInfo angegeben sind, nach Websites.
SHARED_DRIVE Die Dateien in den geteilten Ablagen suchen, die unter SharedDriveInfo angegeben sind.

AccountInfo

Zu durchsuchende Konten

JSON-Darstellung 
{
  "emails": [
    string
  ]
}
Felder
emails[]

string

Eine Reihe von Konten, die durchsucht werden sollen.

OrgUnitInfo

Die zu suchende Organisationseinheit

JSON-Darstellung 
{
  "orgUnitId": string
}
Felder
orgUnitId

string

Der Name der zu suchenden Organisationseinheit, wie von der Admin SDK Directory API bereitgestellt.

SharedDriveInfo

Die zu suchenden geteilten Ablagen

JSON-Darstellung 
{
  "sharedDriveIds": [
    string
  ]
}
Felder
sharedDriveIds[]

string

Eine Liste der IDs geteilter Ablagen, wie von der Drive API bereitgestellt.

HangoutsChatInfo

Chatbereiche, in denen gesucht werden soll

JSON-Darstellung 
{
  "roomId": [
    string
  ]
}
Felder
roomId[]

string

Eine Liste der IDs der Chatbereiche, wie von der Chat API bereitgestellt. Der Export ist pro Anfrage auf 500 Chatbereiche beschränkt.

SitesUrlInfo

Die veröffentlichten Website-URLs der zu durchsuchenden neuen Google Sites-Websites

JSON-Darstellung 
{
  "urls": [
    string
  ]
}
Felder
urls[]

string

Eine Liste der veröffentlichten Website-URLs.

TeamDriveInfo

Geteilte Ablagen für die Suche

JSON-Darstellung 
{
  "teamDriveIds": [
    string
  ]
}
Felder
teamDriveIds[]
(deprecated)

string

Liste der IDs von Teamablagen gemäß der Drive API.

MailOptions

Zusätzliche Optionen für die Gmail-Suche

JSON-Darstellung 
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Felder
excludeDrafts

boolean

Setzen Sie den Wert auf true, um Entwürfe auszuschließen.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Gibt an, ob die Ergebnisse verschlüsselten, unverschlüsselten oder beides enthalten sollen. Standardmäßig sind beide enthalten.

ClientSideEncryptedOption

Wenn Ihre Organisation die clientseitige Verschlüsselung von Google Workspace verwendet: der Verschlüsselungsstatus der Inhalte

Enums
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED Verschlüsselungsstatus nicht angegeben. Die Ergebnisse umfassen sowohl clientseitig verschlüsselte als auch unverschlüsselte Inhalte.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Sie können sowohl clientseitig verschlüsselte als auch unverschlüsselte Inhalte in die Ergebnisse einbeziehen.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Nur clientseitig verschlüsselte Inhalte einschließen.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Verwenden Sie nur unverschlüsselte Inhalte.

DriveOptions

Zusätzliche Optionen für die Drive-Suche

JSON-Darstellung 
{
  "versionDate": string,
  "includeTeamDrives": boolean,
  "includeSharedDrives": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Felder
versionDate

string (Timestamp format)

Sie können in der aktuellen Version der Drive-Datei suchen, aber den Inhalt der Version exportieren, die vor 00:00 Uhr (UTC) am angegebenen Datum gespeichert wurde. Gib das Datum in UTC ein.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
includeTeamDrives
(deprecated)

boolean

Geben Sie "true" an, um die geteilte Ablage einzuschließen.
includeSharedDrives

boolean

Setzen Sie den Wert auf true, um geteilte Ablagen einzubeziehen.
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Legen Sie fest, ob die Ergebnisse nur Inhalte enthalten, die mit der clientseitigen Verschlüsselung von Google Workspace verschlüsselt sind, nur unverschlüsselte Inhalte oder beides. Die Standardeinstellung ist beide. Wird derzeit für Google Drive unterstützt.

HangoutsChatOptions

Zusätzliche Optionen für die Google Chat-Suche

JSON-Darstellung 
{
  "includeRooms": boolean
}
Felder
includeRooms

boolean

Legen Sie für Suchanfragen nach Konto oder Organisationseinheit true fest, damit auch Chatrooms berücksichtigt werden.

VoiceOptions

Zusätzliche Optionen für die Sprachsuche

JSON-Darstellung 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Felder
coveredData[]

enum (VoiceCoveredData)

Zu durchsuchende Datentypen

CalendarOptions

Zusätzliche Optionen für die Kalendersuche

JSON-Darstellung 
{
  "locationQuery": [
    string
  ],
  "peopleQuery": [
    string
  ],
  "minusWords": [
    string
  ],
  "responseStatuses": [
    enum (AttendeeResponse)
  ],
  "versionDate": string
}
Felder
locationQuery[]

string

Findet nur Ereignisse, deren Ort alle Wörter in der angegebenen Gruppe enthält. Wenn der String Wortgruppen in Anführungszeichen enthält, gleicht diese Methode nur Ereignisse ab, deren Position die genaue Wortgruppe enthält. Einträge in der Gruppe werden in „und“ berücksichtigt.

Beispiel für die Wortaufteilung: ["Neuseeland"] vs. ["Neuseeland"] "Neuseeland": Übereinstimmung mit "Neuseeland und besserem See": nur Übereinstimmung mit dem späteren
peopleQuery[]

string

Findet nur Termine, deren Teilnehmer alle Wörter in der angegebenen Gruppe enthalten. Einträge in der Gruppe werden in „und“ berücksichtigt.
minusWords[]

string

Findet nur Termine, die keines der Wörter aus dem angegebenen Satz aus Titel, Beschreibung, Ort oder Teilnehmern enthalten. Einträge in der Gruppe werden in „oder“ behandelt.
responseStatuses[]

enum (AttendeeResponse)

Es werden nur Ereignisse abgeglichen, für die der Verwahrer eine dieser Antworten gegeben hat. Wenn der Satz leer ist oder ATTENDEE_RESPONSE_UNSPECIFIED enthält, werden die Antworten nicht gefiltert.
versionDate

string (Timestamp format)

Es wird in der aktuellen Version des Kalendertermins gesucht, aber Sie können den Inhalt der Version exportieren, die am angegebenen Datum vor 00:00 Uhr (UTC) gespeichert ist. Gib das Datum in UTC ein.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

AttendeeResponse

Nutzerantwort auf eine Einladung.

Enums
ATTENDEE_RESPONSE_UNSPECIFIED Antwort des Teilnehmers nicht angegeben. Wenn diese Richtlinie konfiguriert ist, werden Antworten nicht gefiltert. Alle anderen Teilnehmerantworten, die Teil der Abfrageoptionen sind, werden ignoriert.
ATTENDEE_RESPONSE_NEEDS_ACTION Der Teilnehmer wurde eingeladen, hat aber noch nicht geantwortet.
ATTENDEE_RESPONSE_ACCEPTED Die Person möchte teilnehmen.
ATTENDEE_RESPONSE_DECLINED Die Person plant nicht, daran teilzunehmen.
ATTENDEE_RESPONSE_TENTATIVE Die teilnehmende Person rechnet damit, dass sie möglicherweise teilnehmen wird.