Query

Definicja zapytania używana do wyszukiwania i eksportowania.

Zapis 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.
}
Pola
corpus

enum (CorpusType)

Usługa Google Workspace do wyszukiwania.

dataScope

enum (DataScope)

Źródło danych do przeszukania.

searchMethod
(deprecated)

enum (SearchMethod)

Metoda wyszukiwania, której chcesz użyć.

method

enum (SearchMethod)

Element do wyszukania. To pole zastępuje searchMethod w celu obsługi dysków współdzielonych. Gdy searchMethod ma wartość TEAM_Drive, odpowiedź tego pola to SHARED_Drive.

terms

string

Operatory wyszukiwania specyficzne dla danej usługi – do filtrowania wyników wyszukiwania.

startTime

string (Timestamp format)

Czas rozpoczęcia wyszukiwania. Podaj czas GMT. Wartość jest zaokrąglana w określonym dniu do godziny 00:00.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Czas zakończenia wyszukiwania. Podaj czas GMT. Wartość jest zaokrąglana w określonym dniu do godziny 00:00.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

teamDriveInfo
(deprecated)

object (TeamDriveInfo)

Wymagane, gdy SearchMethod ma wartość team_Drive.

timeZone

string

Nazwa strefy czasowej. Powinna to być nazwa IANA TZ, np. „Ameryka/Los_Angeles”. Listę nazw stref czasowych znajdziesz w sekcji Strefa czasowa. Więcej informacji o tym, jak Vault korzysta ze stref czasowych, znajdziesz w Centrum pomocy Vault.

Pole sumy search_method_field. W razie potrzeby szczegóły elementów do przeszukiwania search_method_field mogą mieć tylko jeden z tych elementów:
accountInfo

object (AccountInfo)

Wymagane, gdy SearchMethod ma wartość ACCOUNT.

orgUnitInfo

object (OrgUnitInfo)

Wymagane, gdy SearchMethod ma wartość ORG_UNIT.

sharedDriveInfo

object (SharedDriveInfo)

Wymagany, gdy SearchMethod ma wartość SHARED_Drive.

hangoutsChatInfo

object (HangoutsChatInfo)

Wymagane, gdy SearchMethod ma wartość ROOM. (tylko do odczytu)

sitesUrlInfo

object (SitesUrlInfo)

Wymagany, gdy SearchMethod ma wartość SITES_URL.

Pole sumy corpus_options_field. Dodatkowe opcje wyszukiwania dla określonych usług. corpus_options_field może mieć tylko jedną z tych wartości:
mailOptions

object (MailOptions)

Ustaw opcje specyficzne dla wyszukiwania w Gmailu.

driveOptions

object (DriveOptions)

Ustaw opcje wyszukiwania na Dysku.

hangoutsChatOptions

object (HangoutsChatOptions)

Ustaw opcje wyszukiwania w Google Chat. (tylko do odczytu)

voiceOptions

object (VoiceOptions)

Ustaw opcje dotyczące wyszukiwania głosowego.

calendarOptions

object (CalendarOptions)

Ustaw opcje specyficzne dla wyszukiwania w Kalendarzu.

DataScope

Źródło danych do przeszukania.

Wartości w polu enum
DATA_SCOPE_UNSPECIFIED Nie określono źródła danych.
ALL_DATA Wszystkie dostępne dane.
HELD_DATA Tylko dane objęte blokadą.
UNPROCESSED_DATA Tylko dane, które nie zostały jeszcze przetworzone przez Vault. (Tylko Gmail i Grupy dyskusyjne)

SearchMethod

Typ jednostki wyszukiwania.

Wartości w polu enum
SEARCH_METHOD_UNSPECIFIED Musisz określić metodę wyszukiwania. W przeciwnym razie zostanie ona odrzucona.
ACCOUNT Przeszukiwanie danych kont podanych w AccountInfo.
ORG_UNIT Przeszukuj dane wszystkich kont w jednostce organizacyjnej określonej w OrgUnitInfo.
TEAM_DRIVE

Wyszukaj dane na Dysku zespołu określone w teamDriveInfo.

ENTIRE_ORG przeszukiwanie danych ze wszystkich kont w organizacji, Obsługiwane tylko w Gmailu. Jeśli go podasz, nie musisz określać właściwości AccountInfo ani OrgUnitInfo.
ROOM Wyszukiwanie wiadomości w pokojach czatu określonych w HangoutsChatInfo.
SITES_URL Wyszukiwanie witryn według opublikowanych adresów URL określonych w funkcji SitesUrlInfo.
SHARED_DRIVE Wyszukaj pliki na dyskach współdzielonych określonych w SharedDriveInfo.

AccountInfo

Konta do przeszukania

Zapis JSON
{
  "emails": [
    string
  ]
}
Pola
emails[]

string

Zestaw kont do przeszukiwania.

OrgUnitInfo

Jednostka organizacyjna do przeszukania

Zapis JSON
{
  "orgUnitId": string
}
Pola
orgUnitId

string

Nazwa jednostki organizacyjnej do przeszukania podana przez interfejs Admin SDK Directory API.

SharedDriveInfo

Dyski współdzielone do przeszukania

Zapis JSON
{
  "sharedDriveIds": [
    string
  ]
}
Pola
sharedDriveIds[]

string

Lista identyfikatorów dysków współdzielonych podana przez interfejs Drive API.

HangoutsChatInfo

pokoje czatu do przeszukania;

Zapis JSON
{
  "roomId": [
    string
  ]
}
Pola
roomId[]

string

Lista identyfikatorów pokoi czatu podana przez interfejs Chat API. Na prośbę można wyeksportować dane z maksymalnie 500 pokoi czatu.

SitesUrlInfo

adresy URL opublikowanych witryn w nowych Witrynach Google do przeszukania;

Zapis JSON
{
  "urls": [
    string
  ]
}
Pola
urls[]

string

Lista adresów URL opublikowanych witryn.

TeamDriveInfo

Dyski zespołu do przeszukania

Zapis JSON
{
  "teamDriveIds": [
    string
  ]
}
Pola
teamDriveIds[]
(deprecated)

string

Lista identyfikatorów Dysku zespołu udostępnionych przez Drive API.

MailOptions

Dodatkowe opcje wyszukiwania w Gmailu

Zapis JSON
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
Pola
excludeDrafts

boolean

Aby wykluczyć wersje robocze, ustaw wartość true (prawda).

clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Określa, czy wyniki mają zawierać treść zaszyfrowaną, niezaszyfrowaną czy obie te treści. Domyślnie uwzględniane są obie te wartości.

ClientSideEncryptedOption

stan szyfrowania treści, jeśli Twoja organizacja korzysta z szyfrowania po stronie klienta Google Workspace;

Wartości w polu enum
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED Nie określono stanu szyfrowania. Wyniki obejmują zarówno treści zaszyfrowane po stronie klienta, jak i niezaszyfrowane.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY Uwzględnij w wynikach treści zarówno zaszyfrowane po stronie klienta, jak i niezaszyfrowane.
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Uwzględniaj tylko treści zaszyfrowane po stronie klienta.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Uwzględnij tylko treść niezaszyfrowaną.

DriveOptions

Dodatkowe opcje wyszukiwania na Dysku

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

string (Timestamp format)

Przeszukuj bieżącą wersję pliku na Dysku, ale eksportuj zawartość ostatniej wersji zapisanej przed godziną 00:00 czasu UTC określonego dnia. Wpisz datę w strefie czasowej UTC.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

includeTeamDrives
(deprecated)

boolean

Aby uwzględnić Dysk zespołu, ustaw wartość true (prawda).

includeSharedDrives

boolean

Aby uwzględnić dyski współdzielone, ustaw wartość true.

clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Określ, czy wyniki mają zawierać tylko treści zaszyfrowane za pomocą szyfrowania po stronie klienta Google Workspace, tylko treści niezaszyfrowane czy oba te rodzaje treści. Wartość domyślna to obie. Obecnie obsługiwany dla Dysku.

HangoutsChatOptions

Dodatkowe opcje wyszukiwania w Google Chat

Zapis JSON
{
  "includeRooms": boolean
}
Pola
includeRooms

boolean

W przypadku wyszukiwania według konta lub jednostki organizacyjnej ustaw wartość true, aby uwzględnić sale.

VoiceOptions

Dodatkowe opcje wyszukiwania głosowego

Zapis JSON
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
Pola
coveredData[]

enum (VoiceCoveredData)

Typy danych do przeszukania

CalendarOptions

Dodatkowe opcje wyszukiwania w Kalendarzu

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

string

Dopasowuje tylko te zdarzenia, których lokalizacja zawiera wszystkie słowa z danego zestawu. Jeśli ciąg zawiera wyrażenia cytowane, ta metoda dopasowuje tylko te zdarzenia, których lokalizacja zawiera dokładne wyrażenie. Wpisy w zestawie są uwzględniane w argumencie „and”.

Przykład podziału słów: ["Nowa Zelandia"] vs. ["Nowa","Zealand"] "Nowa Zelandia": dopasowanie wyrażenia „Nowa i lepsza Zelandia”: dopasowane tylko przez

peopleQuery[]

string

Dopasowuje tylko te wydarzenia, których uczestnicy zawierają wszystkie słowa z danego zestawu. Wpisy w zestawie są uwzględniane w argumencie „and”.

minusWords[]

string

Dopasowuje tylko te wydarzenia, które nie zawierają żadnego ze słów w danym zestawie w tytule, opisie, lokalizacji lub uczestnikach. Pozycje w zestawie są uwzględniane w elemencie „lub”.

responseStatuses[]

enum (AttendeeResponse)

Dopasowuje tylko zdarzenia, na które opiekun udzielił jednej z tych odpowiedzi. Jeśli zestaw jest pusty lub zawiera ciąg ATTENDEE_odpowiedź_UNSPECIFIED, odpowiedzi nie będą filtrowane.

versionDate

string (Timestamp format)

Przeszukuje bieżącą wersję wydarzenia w Kalendarzu, ale wyeksportuj zawartość ostatniej wersji zapisanej przed godziną 00:00 czasu UTC w wybranym dniu. Wpisz datę w strefie czasowej UTC.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

AttendeeResponse

Odpowiedź użytkownika na zaproszenie.

Wartości w polu enum
ATTENDEE_RESPONSE_UNSPECIFIED Nie określono odpowiedzi uczestnika. Jeśli ta zasada jest skonfigurowana, odpowiedzi nie są filtrowane. Wszystkie pozostałe odpowiedzi uczestników, które są częścią opcji zapytań, są ignorowane.
ATTENDEE_RESPONSE_NEEDS_ACTION Uczestnik został zaproszony, ale jeszcze nie odpowiedział.
ATTENDEE_RESPONSE_ACCEPTED Uczestnik planuje wziąć udział.
ATTENDEE_RESPONSE_DECLINED Uczestnik nie planuje wziąć udziału.
ATTENDEE_RESPONSE_TENTATIVE Uczestnik oczekuje, że weźmie udział w wydarzeniu.