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,

  "accountInfo": {
    object (AccountInfo)
  },
  "orgUnitInfo": {
    object (OrgUnitInfo)
  },
  "sharedDriveInfo": {
    object (SharedDriveInfo)
  },
  "hangoutsChatInfo": {
    object (HangoutsChatInfo)
  },
  "sitesUrlInfo": {
    object (SitesUrlInfo)
  },
  "driveDocumentInfo": {
    object (DriveDocumentInfo)
  }

  "mailOptions": {
    object (MailOptions)
  },
  "driveOptions": {
    object (DriveOptions)
  },
  "hangoutsChatOptions": {
    object (HangoutsChatOptions)
  },
  "voiceOptions": {
    object (VoiceOptions)
  },
  "calendarOptions": {
    object (CalendarOptions)
  },
  "geminiOptions": {
    object (GeminiOptions)
  }
}
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 zu durchsuchende Entität. Dieses Feld ersetzt searchMethod, um geteilte Ablagen zu unterstützen. Wenn searchMethod TEAM_DRIVE ist, lautet die Antwort dieses Felds SHARED_DRIVE.

terms

string

Dienstspezifische Suchoperatoren zum Filtern von Suchergebnissen.

startTime

string (Timestamp format)

Die Startzeit für die Suchanfrage. Geben Sie die Zeit in GMT an. Der Wert wird auf 00:00 Uhr des angegebenen Datums gerundet.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

Die Endzeit für die Suchanfrage. Geben Sie die Zeit in GMT an. Der Wert wird auf 00:00 Uhr des angegebenen Datums gerundet.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

teamDriveInfo
(deprecated)

object (TeamDriveInfo)

Erforderlich, wenn SearchMethod auf TEAM_DRIVE gesetzt ist.

timeZone

string

Der Zeitzonenname. Dieser sollte ein IANA-TZ-Name sein, beispielsweise „America/Los_Angeles“. 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 einer der folgenden Werte sein:
accountInfo

object (AccountInfo)

Erforderlich, wenn SearchMethod ACCOUNT ist.

orgUnitInfo

object (OrgUnitInfo)

Erforderlich, wenn SearchMethod auf ORG_UNIT festgelegt ist.

sharedDriveInfo

object (SharedDriveInfo)

Erforderlich, wenn SearchMethod SHARED_DRIVE ist.

hangoutsChatInfo

object (HangoutsChatInfo)

Erforderlich, wenn SearchMethod auf ROOM festgelegt ist. (schreibgeschützt)

sitesUrlInfo

object (SitesUrlInfo)

Erforderlich, wenn SearchMethod SITES_URL ist.

driveDocumentInfo

object (DriveDocumentInfo)

Erforderlich, wenn SearchMethod DRIVE_DOCUMENT 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)

Legen Sie Gmail-suchspezifische Optionen fest.

driveOptions

object (DriveOptions)

Legen Sie Optionen für die Suche in Drive fest.

hangoutsChatOptions

object (HangoutsChatOptions)

Legen Sie Optionen für die Chat-Suche fest. (schreibgeschützt)

voiceOptions

object (VoiceOptions)

Legen Sie Optionen für die Sprachsuche fest.

calendarOptions

object (CalendarOptions)

Legen Sie suchspezifische Optionen für Google Kalender fest.

geminiOptions

object (GeminiOptions)

Legen Sie Optionen für die Suche mit Gemini fest.

DataScope

Die Quelle der zu durchsuchenden Daten.

Enums
DATA_SCOPE_UNSPECIFIED Es wurde keine Datenquelle angegeben.
ALL_DATA Alle verfügbaren Daten.
HELD_DATA Nur Daten mit Hold.
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, da der Antrag sonst abgelehnt wird.
ACCOUNT Sucht in den Daten der in AccountInfo angegebenen Konten.
ORG_UNIT Es wird in den Daten aller Konten in der Organisationseinheit gesucht, die in OrgUnitInfo angegeben ist.
TEAM_DRIVE

Suchen Sie in den Daten der Teamablage, die in teamDriveInfo angegeben ist.

ENTIRE_ORG Die Daten aller Konten in der Organisation durchsuchen Nur für Gmail unterstützt. Wenn Sie AccountInfo oder OrgUnitInfo nicht angeben.
ROOM Nachrichten in den in HangoutsChatInfo angegebenen Chat-Gruppenbereichen suchen.
SITES_URL Suchen Sie nach Websites anhand der veröffentlichten Website-URLs, die in SitesUrlInfo angegeben sind.
SHARED_DRIVE Suchen Sie in den in SharedDriveInfo angegebenen geteilten Ablagen nach Dateien.
DRIVE_DOCUMENT Die in „DriveDocumentInfo“ angegebenen Dokumente abrufen.

AccountInfo

Die zu durchsuchenden Konten

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

string

Eine Reihe von Konten, die durchsucht werden sollen.

OrgUnitInfo

Die Organisationseinheit, in der gesucht werden soll

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

string

Der Name der Organisationseinheit, nach der gesucht werden soll, wie von der Admin SDK Directory API bereitgestellt.

SharedDriveInfo

Die geteilten Ablagen, in denen gesucht werden soll

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

string

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

HangoutsChatInfo

Die zu durchsuchenden Chatbereiche

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

string

Eine Liste der IDs von Google Chat-Bereichen, wie sie von der Chat API bereitgestellt werden. Pro Anfrage können maximal 500 Chatbereiche exportiert werden.

SitesUrlInfo

Die veröffentlichten Website-URLs der neuen Google Sites-Websites, nach denen gesucht werden soll

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

string

Eine Liste mit veröffentlichten Website-URLs.

DriveDocumentInfo

Die Google Drive-Dokumente, in denen gesucht werden soll.

JSON-Darstellung
{

  "documentIds": {
    object (DriveDocumentIds)
  }
}
Felder
Union-Feld identifier. Das Format, in dem die Drive-Dokumente abgerufen werden sollen. Für identifier ist nur einer der folgenden Werte zulässig:
documentIds

object (DriveDocumentIds)

Geben Sie Drive-Dokumente anhand der Dokument-ID an.

DriveDocumentIds

Geben Sie Drive-Dokumente anhand der Dokument-ID an.

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

string

Erforderlich. Eine Liste mit Drive-Dokument-IDs.

TeamDriveInfo

Zu durchsuchende Teamablagen

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

string

Liste der Team Drive-IDs, wie von der Drive API bereitgestellt.

MailOptions

Zusätzliche Optionen für die Gmail-Suche

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

boolean

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

clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Gibt an, ob die Ergebnisse verschlüsselte, unverschlüsselte oder beide Arten von Inhalten enthalten sollen. Standardmäßig sind beide enthalten.

ClientSideEncryptedOption

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

Enums
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED Der Verschlüsselungsstatus ist nicht angegeben. Die Ergebnisse umfassen sowohl clientseitig verschlüsselte als auch nicht verschlüsselte Inhalte.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Sowohl clientseitig verschlüsselte als auch unverschlüsselte Inhalte in die Ergebnisse einbeziehen
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Nur clientseitig verschlüsselte Inhalte einbeziehen
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Nur unverschlüsselte Inhalte einfügen.

DriveOptions

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

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

string (Timestamp format)

Die aktuelle Version der Drive-Datei wird durchsucht, aber der Inhalt der vor 00:00 Uhr UTC des angegebenen Datums zuletzt gespeicherten Version wird exportiert. Geben Sie das Datum in UTC ein.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

includeTeamDrives
(deprecated)

boolean

Auf „true“ setzen, um Teamablagen einzuschließen.

includeSharedDrives
(deprecated)

boolean

Auf true setzen, um geteilte Ablagen einzubeziehen.

clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Legen Sie fest, ob die Ergebnisse nur Inhalte enthalten sollen, die mit der clientseitigen Verschlüsselung von Google Workspace verschlüsselt wurden, nur unverschlüsselte Inhalte oder beides. Standardmäßig sind beide aktiviert. Wird derzeit für Drive unterstützt.

sharedDrivesOption

enum (SharedDrivesOption)

Optional. Optionen zum Ein- oder Ausschließen von Dokumenten in geteilten Ablagen. Wir empfehlen, dieses Feld anstelle von „includeSharedDrives“ zu verwenden. Wenn dieses Feld festgelegt ist, werden „includeSharedDrives“ und „includeTeamDrives“ überschrieben.

SharedDrivesOption

Option für den Typ der Dokumente aus geteilten Ablagen, die einbezogen werden sollen.

Enums
SHARED_DRIVES_OPTION_UNSPECIFIED Es wurde keine Option für geteilte Ablagen angegeben.
NOT_INCLUDED Wenn sich eine Ressource in einer geteilten Ablage befindet, wird sie nicht in die Suche einbezogen.
INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER Ressourcen aus geteilten Ablagen werden nur berücksichtigt, wenn das Konto ein Mitbearbeiter einer Ressource, aber kein Mitglied der geteilten Ablage ist. Dies entspricht der Option Nur eingeschlossen, wenn Dokumente direkt freigegeben wurden (nicht aufgrund der Mitgliedschaft in einer geteilten Ablage) in der Vault-Benutzeroberfläche. (Bisher „includeSharedDrives“ deaktiviert)
INCLUDED Ressourcen in geteilten Ablagen werden in die Suche einbezogen. (Bisher „includeSharedDrives“ auf)

HangoutsChatOptions

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

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

boolean

Bei Suchanfragen nach Konto oder Organisationseinheit auf true setzen, um Chatrooms einzubeziehen.

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 Suche in Google Kalender

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

string

Es werden nur Ereignisse berücksichtigt, deren Standort alle Wörter im angegebenen Set enthält. Wenn der String in Anführungszeichen gesetzte Wortgruppen enthält, werden mit dieser Methode nur Ereignisse abgeglichen, deren Standort die genaue Wortgruppe enthält. Einträge im Set werden mit „und“ verknüpft.

Beispiel für das Aufteilen von Wörtern: ["Neuseeland"] im Vergleich zu ["Neu","Seeland"] „Neuseeland“: wird von beiden abgeglichen „Neu und besser Seeland“: wird nur von der zweiten Variante abgeglichen

peopleQuery[]

string

Es werden nur Ereignisse berücksichtigt, deren Teilnehmer alle Wörter im angegebenen Set enthalten. Einträge im Set werden mit „und“ verknüpft.

minusWords[]

string

Entspricht nur den Ereignissen, die keines der Wörter im angegebenen Set in Titel, Beschreibung, Ort oder Teilnehmern enthalten. Einträge im Set werden mit „oder“ verknüpft.

responseStatuses[]

enum (AttendeeResponse)

Ordnet nur Termine zu, für die der Verwahrer eine dieser Antworten gegeben hat. Wenn die Menge leer ist oder ATTENDEE_RESPONSE_UNSPECIFIED enthält, werden keine Antworten gefiltert.

versionDate

string (Timestamp format)

Es wird in der aktuellen Version des Kalendertermins gesucht, aber der Inhalt der vor 00:00 Uhr UTC des angegebenen Datums zuletzt gespeicherten Version wird exportiert. Geben Sie das Datum in UTC ein.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

AttendeeResponse

Nutzerantwort auf eine Einladung.

Enums
ATTENDEE_RESPONSE_UNSPECIFIED Die Antwort des Teilnehmers ist nicht angegeben. Wenn diese Option festgelegt ist, werden Antworten nicht gefiltert und alle anderen Antworten von Teilnehmern, die Teil der Abfrageoptionen sind, werden ignoriert.
ATTENDEE_RESPONSE_NEEDS_ACTION Der Teilnehmer wurde eingeladen, hat aber noch nicht geantwortet.
ATTENDEE_RESPONSE_ACCEPTED Der Teilnehmer plant, teilzunehmen.
ATTENDEE_RESPONSE_DECLINED Der Teilnehmer plant nicht, teilzunehmen.
ATTENDEE_RESPONSE_TENTATIVE Der Teilnehmer erwartet, dass er möglicherweise teilnehmen wird.

GeminiOptions

Dieser Typ hat keine Felder.

Zusätzliche Optionen für die Suche mit Gemini