Query

Die für die Suche und den Export verwendete Abfragedefinition.

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, in 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, lautet die Antwort auf dieses Feld SHARED_DRIVE.

terms

string

Dienstspezifische Suchoperatoren zum Filtern von Suchergebnissen.

startTime

string (Timestamp format)

Die Startzeit für die Suchanfrage. Geben Sie GMT an. Der Wert wird am angegebenen Datum auf 00:00 Uhr gerundet.

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

endTime

string (Timestamp format)

Die Endzeit für die Suchanfrage. Geben Sie GMT an. Der Wert wird am angegebenen Datum auf 00:00 Uhr gerundet.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung 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 sein, z. B. „America/Los_Angeles“. Eine Liste der Zeitzonennamen finden Sie unter Zeitzone. Weitere Informationen dazu, wie Zeitzonen in Vault verwendet werden, finden Sie in der Vault-Hilfe.

Union-Feld search_method_field. Falls erforderlich, können für die Entitäten, nach denen search_method_field gesucht werden soll, 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 den Wert SHARED_DRIVE hat.

hangoutsChatInfo

object (HangoutsChatInfo)

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

sitesUrlInfo

object (SitesUrlInfo)

Erforderlich, wenn SearchMethod den Wert SITES_URL hat.

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 suchspezifische Optionen für Gmail festlegen.

driveOptions

object (DriveOptions)

Suchspezifische Optionen für Drive festlegen

hangoutsChatOptions

object (HangoutsChatOptions)

Suchspezifische Optionen für Google Chat festlegen (schreibgeschützt)

voiceOptions

object (VoiceOptions)

Spezifische Optionen für die Sprachsuche festlegen

calendarOptions

object (CalendarOptions)

Suchspezifische Optionen für Google Kalender festlegen

DataScope

Die Datenquelle für die Suche.

Enums
DATA_SCOPE_UNSPECIFIED Keine Datenquelle angegeben.
ALL_DATA Alle verfügbaren Daten.
HELD_DATA Nur Daten, die auf „Hold“ gesetzt sind.
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 Eine Suchmethode muss angegeben werden, andernfalls wird sie abgelehnt.
ACCOUNT Es wird in den Daten der in AccountInfo angegebenen Konten gesucht.
ORG_UNIT Es wird in den Daten aller Konten in der in OrgUnitInfo angegebenen Organisationseinheit gesucht.
TEAM_DRIVE

Die Daten in der Teamablage suchen, die in teamDriveInfo angegeben ist.

ENTIRE_ORG Es wird in den Daten aller Konten in der Organisation gesucht. Wird nur für Gmail unterstützt. Wenn angegeben, müssen Sie AccountInfo oder OrgUnitInfo nicht angeben.
ROOM Es wird nach Nachrichten in den in HangoutsChatInfo angegebenen Chatbereichen gesucht.
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 Gruppe von Konten, in denen gesucht werden soll.

OrgUnitInfo

Die Organisationseinheit, in der gesucht werden soll

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

string

Der Name der Organisationseinheit, in der gesucht werden soll, wie in der Admin SDK Directory API angegeben

SharedDriveInfo

Die zu durchsuchenden geteilten Ablagen

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

string

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

HangoutsChatInfo

Die 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. Pro Anfrage können maximal 500 Chatbereiche exportiert werden.

SitesUrlInfo

Die veröffentlichten Website-URLs des neuen Google Sites, das durchsucht werden soll

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

string

Eine Liste der veröffentlichten Website-URLs.

TeamDriveInfo

Zu durchsuchende Teamablagen

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

string

Liste der IDs der Teamablagen, wie sie von der Drive API bereitgestellt werden

MailOptions

Zusätzliche Optionen für die Gmail-Suche

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

boolean

Geben Sie true an, um Entwürfe auszuschließen.

clientSideEncryptedOption

enum (ClientSideEncryptedOption)

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

ClientSideEncryptedOption

Wenn Ihre Organisation die clientseitige Verschlüsselung von Google Workspace verwendet, wird der Verschlüsselungsstatus der Inhalte angezeigt.

Enums
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED Verschlüsselungsstatus nicht angegeben. Die Ergebnisse enthalten sowohl clientseitig verschlüsselte als auch unverschlüsselte Inhalte.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Sowohl clientseitig verschlüsselte als auch unverschlüsselte Inhalte in die Ergebnisse aufnehmen.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Enthält nur clientseitig verschlüsselte Inhalte.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Geben Sie nur unverschlüsselte Inhalte an.

DriveOptions

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

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

string (Timestamp format)

Es wird nach der aktuellen Version der Drive-Datei gesucht, aber der Inhalt der letzten Version, die vor 00:00 Uhr (UTC) am angegebenen Datum gespeichert wurde, wird exportiert. Geben Sie das Datum in UTC ein.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung 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 einzubeziehen.

includeSharedDrives

boolean

Geben Sie true an, um geteilte Ablagen einzubeziehen.

clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Legen Sie fest, ob die Ergebnisse nur mit der clientseitigen Verschlüsselung von Google Workspace verschlüsselte Inhalte, nur unverschlüsselte Inhalte oder beides enthalten. 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 Suchen nach Konto oder Organisationseinheit den Wert true fest, um Räume einzuschließen.

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 die Ereignisse, deren Ort alle Wörter in der angegebenen Menge enthält. Wenn der String Wortgruppen in Anführungszeichen enthält, sucht diese Methode nur nach Ereignissen, deren Ort die genaue Wortgruppe enthält. Einträge im Satz werden als „und“ betrachtet.

Beispiel für die Wortaufteilung: ["Neuseeland"] vs. ["Neu","Zealand"] "Neuseeland": Es wird nur eine Übereinstimmung mit "Neuseeland und besserer Seeland" gefunden:

peopleQuery[]

string

Stimmt nur mit den Terminen überein, deren Teilnehmer alle Wörter in der angegebenen Menge enthalten. Einträge im Satz werden als „und“ betrachtet.

minusWords[]

string

Stimmt nur mit Terminen überein, die keines der Wörter aus dem angegebenen Satz in Titel, Beschreibung, Ort oder Teilnehmern enthalten. Einträge im Satz werden als „oder“ betrachtet.

responseStatuses[]

enum (AttendeeResponse)

Es werden nur Ereignisse abgeglichen, für die der Treuhänder eine dieser Antworten gegeben hat. Ist der Satz leer oder enthält ATTENDEE_ANSWER_UNSPECIFIED, werden die Antworten nicht gefiltert.

versionDate

string (Timestamp format)

Es wird nach der aktuellen Version des Kalendertermins gesucht, aber der Inhalt der letzten Version, die vor 00:00 Uhr (UTC) am angegebenen Datum gespeichert wurde, wird exportiert. Geben Sie das Datum in UTC ein.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung 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. Ist diese Richtlinie konfiguriert, erfolgt keine Filterung nach Antworten, 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 plant, daran teilzunehmen.
ATTENDEE_RESPONSE_DECLINED Die Person plant nicht, daran teilzunehmen.
ATTENDEE_RESPONSE_TENTATIVE Die teilnehmende Person erwartet ihre Teilnahme.