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)
  },
  "geminiInWorkspaceOptions": {
    object (GeminiInWorkspaceOptions)
  }
}
Felder
corpus

enum (CorpusType)

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

enum (DataScope)

Die Datenquelle, die durchsucht 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 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 festgelegt ist.
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 zur Verwendung von Zeitzonen in Vault finden Sie in der Vault-Hilfe.
Gibt bei Bedarf die Details der zu suchenden Entitäten an. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
accountInfo

object (AccountInfo)

Erforderlich, wenn SearchMethod auf ACCOUNT festgelegt ist.
orgUnitInfo

object (OrgUnitInfo)

Erforderlich, wenn SearchMethod auf ORG_UNIT festgelegt ist.
sharedDriveInfo

object (SharedDriveInfo)

Erforderlich, wenn SearchMethod auf SHARED_DRIVE festgelegt ist.
hangoutsChatInfo

object (HangoutsChatInfo)

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

object (SitesUrlInfo)

Erforderlich, wenn SearchMethod auf SITES_URL festgelegt ist.
driveDocumentInfo

object (DriveDocumentInfo)

Erforderlich, wenn SearchMethod auf DRIVE_DOCUMENT gesetzt ist.
Ende der sich gegenseitig ausschließenden Felder.
Zusätzliche Suchoptionen für bestimmte Dienste. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
mailOptions

object (MailOptions)

Legen Sie Gmail-spezifische Suchoptionen fest.
driveOptions

object (DriveOptions)

Suchspezifische Optionen für Google Drive festlegen
hangoutsChatOptions

object (HangoutsChatOptions)

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

object (VoiceOptions)

Legen Sie Optionen für die Sprachsuche fest.
calendarOptions

object (CalendarOptions)

Legen Sie die suchspezifischen Optionen für Google Kalender fest.
geminiOptions

object (GeminiOptions)

Suchspezifische Optionen für die Gemini App festlegen.
geminiInWorkspaceOptions

object (GeminiInWorkspaceOptions)

Suchspezifische Optionen für Gemini in Workspace festlegen.
Ende der sich gegenseitig ausschließenden Felder.

DataScope

Die Datenquelle, die durchsucht werden soll.

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 Es muss eine Suchmethode angegeben werden, sonst wird die Anfrage abgelehnt.
ACCOUNT Durchsucht die Daten der in AccountInfo angegebenen Konten.
ORG_UNIT Die Daten aller Konten in der in OrgUnitInfo angegebenen Organisationseinheit werden durchsucht.
TEAM_DRIVE

Die Daten in der in teamDriveInfo angegebenen geteilten Ablage werden durchsucht.
ENTIRE_ORG In den Daten aller Konten in der Organisation suchen. Wird nur für Gmail unterstützt. Wenn Sie diese Option angeben, müssen Sie AccountInfo oder OrgUnitInfo nicht angeben.
ROOM Nachrichten in den Google Chat-Bereichen suchen, die in HangoutsChatInfo angegeben sind.
SITES_URL Suchen Sie nach Websites anhand der veröffentlichten Website-URLs, die in SitesUrlInfo angegeben sind.
SHARED_DRIVE In den Dateien in den geteilten Ablagen suchen, die in SharedDriveInfo angegeben sind.
DRIVE_DOCUMENT Ruft die in DriveDocumentInfo angegebenen Dokumente ab.

AccountInfo

Die zu durchsuchenden Konten

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

string

Eine Reihe von Konten, die durchsucht werden sollen.

OrgUnitInfo

Die zu durchsuchende Organisationseinheit

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

string

Der Name der Organisationseinheit, die durchsucht 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 Chatbereiche, in denen gesucht werden soll

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

string

Eine Liste der IDs von Chatbereichen, die 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, die durchsucht werden sollen

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

string

Eine Liste der URLs veröffentlichter Websites.

DriveDocumentInfo

Die Drive-Dokumente, die durchsucht werden sollen.

JSON-Darstellung 
{

  "documentIds": {
    object (DriveDocumentIds)
  }
}
Felder
Das Format, in dem die Drive-Dokumente abgerufen werden sollen. Im Folgenden finden Sie eine Liste der Felder, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
documentIds

object (DriveDocumentIds)

Geben Sie Drive-Dokumente nach Dokument-ID an.
Ende der sich gegenseitig ausschließenden Felder.

DriveDocumentIds

Geben Sie Drive-Dokumente nach Dokument-ID an.

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

string

Erforderlich. Eine Liste der Drive-Dokument-IDs.

TeamDriveInfo

Zu durchsuchende Teamablagen

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

string

Liste der IDs der geteilten Ablagen, 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

Legen Sie true fest, 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 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 Verschlüsselungsstatus nicht angegeben. Die Ergebnisse enthalten 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 einschließen.

DriveOptions

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

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

string (Timestamp format)

In der aktuellen Version der Drive-Datei suchen, aber den Inhalt der vor 00:00 Uhr UTC des angegebenen Datums zuletzt gespeicherten Version exportieren. 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

Legen Sie „true“ fest, um die geteilte Ablage einzuschließen.
includeSharedDrives
(deprecated)

boolean

Setzen Sie diesen Wert auf true, 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 sollen. Die Standardeinstellung ist „Beide“. 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 Keine Option für geteilte Ablagen angegeben.
NOT_INCLUDED Wenn eine Ressource in einer geteilten Ablage ist, wird sie nicht in die Suche einbezogen.
INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER Ressourcen in geteilten Ablagen werden nur berücksichtigt, wenn das Konto ein Mitbearbeiter einer Ressource ist, aber kein Mitglied der geteilten Ablage. 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. (Früher „includeSharedDrives“ aktiviert)

HangoutsChatOptions

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

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

boolean

Legen Sie bei der Suche nach Konto oder Organisationseinheit den Wert true fest, um Chatrooms 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 Suche in Google Kalender

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

string

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

Beispiel für Worttrennung: ["New Zealand"] im Vergleich zu ["New","Zealand"] "New Zealand": stimmt mit beiden überein "New and better Zealand": stimmt nur mit dem zweiten überein
peopleQuery[]

string

Es werden nur Termine angezeigt, deren Teilnehmer alle Wörter im angegebenen Satz enthalten. Einträge im Set werden mit „und“ verknüpft.
minusWords[]

string

Es werden nur Termine gefunden, die keines der Wörter aus der angegebenen Gruppe im Titel, in der Beschreibung, im Ort oder in den Teilnehmern enthalten. Einträge in der Gruppe werden mit „oder“ verknüpft.
responseStatuses[]

enum (AttendeeResponse)

Ordnet nur Termine zu, für die der Custodian eine dieser Antworten gesendet hat. Wenn die Gruppe leer ist oder ATTENDEE_RESPONSE_UNSPECIFIED enthält, werden die Antworten nicht gefiltert.
versionDate

string (Timestamp format)

In der aktuellen Version des Kalendertermins suchen, aber den Inhalt der vor 00:00 Uhr UTC des angegebenen Datums zuletzt gespeicherten Version exportieren. 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

Antwort des Nutzers auf eine Einladung.

Enums
ATTENDEE_RESPONSE_UNSPECIFIED Antwort des Teilnehmers nicht angegeben. Wenn diese Option festgelegt ist, werden die Antworten nicht gefiltert. 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 möchte teilnehmen.
ATTENDEE_RESPONSE_DECLINED Der Teilnehmer plant nicht, teilzunehmen.
ATTENDEE_RESPONSE_TENTATIVE Der Teilnehmer wird möglicherweise teilnehmen.

GeminiOptions

Dieser Typ hat keine Felder.

Zusätzliche Optionen für die Suche in der Gemini App

GeminiInWorkspaceOptions

Dieser Typ hat keine Felder.

Zusätzliche Optionen für die Suche mit Gemini in Workspace