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, w której chcesz przeprowadzić wyszukiwanie.
dataScope

enum (DataScope)

Źródło danych, które chcesz przeszukać.
searchMethod
(deprecated)

enum (SearchMethod)

Metoda wyszukiwania.
method

enum (SearchMethod)

Element do przeszukania. To pole zastępuje searchMethod w celu obsługi dysków współdzielonych. Gdy właściwość searchMethod ma wartość TEAM_Drive, odpowiedź w tym polu to SHARED_Drive.
terms

string

Operatory wyszukiwania związane z poszczególnymi usługami, które służą do filtrowania wyników wyszukiwania.
startTime

string (Timestamp format)

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

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową 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 do godziny 00:00 w wybranym dniu.

Sygnatura czasowa w formacie UTC „Zulu” zdefiniowanym w dokumencie RFC 3339, z dokładnością do nanosekund i maksymalnie 9 miejsc po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

Wymagane, gdy parametr SearchMethod ma wartość TEAM_DRIVE.
timeZone

string

Nazwa strefy czasowej. Powinna to być nazwa IANA TZ, na przykład „America/Los_Angeles”. Listę nazw stref czasowych znajdziesz w sekcji Strefa czasowa. Więcej informacji o tym, jak Vault używa stref czasowych, znajdziesz w Centrum pomocy Vault.
Pole unii search_method_field. Jeśli wymagane jest wyszukiwanie w search_method_field, szczegółowe informacje o elementach mogą zawierać tylko jeden z tych elementów:
accountInfo

object (AccountInfo)

Wymagany, gdy SearchMethod ma wartość ACCOUNT.
orgUnitInfo

object (OrgUnitInfo)

Wymagane, gdy wartość atrybutu SearchMethod to ORG_UNIT.
sharedDriveInfo

object (SharedDriveInfo)

Wymagane, gdy atrybut SearchMethod ma wartość SHARED_DRIVE.
hangoutsChatInfo

object (HangoutsChatInfo)

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

object (SitesUrlInfo)

Wymagany, gdy SearchMethod ma wartość SITES_URL.
Pole unii corpus_options_field. dodatkowe opcje wyszukiwania w przypadku niektórych usług. corpus_options_field może mieć tylko jedną z tych wartości:
mailOptions

object (MailOptions)

Ustaw opcje wyszukiwania związane z Gmailem.
driveOptions

object (DriveOptions)

Skonfiguruj opcje Dysku związane z wyszukiwaniem.
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 związane z wyszukiwaniem 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 zablokowane.
UNPROCESSED_DATA Tylko dane, które nie zostały jeszcze przetworzone przez Vault. (tylko Gmail i Grupy dyskusyjne)

SearchMethod

Typ elementu do wyszukiwania.

Wartości w polu enum
SEARCH_METHOD_UNSPECIFIED Musisz określić metodę wyszukiwania, w przeciwnym razie reklama zostanie odrzucona.
ACCOUNT Przeszuka dane kont określonych we AccountInfo.
ORG_UNIT Przeszuka dane wszystkich kont w jednostce organizacyjnej określonej we właściwości OrgUnitInfo.
TEAM_DRIVE

Wyszukaj dane na Dysku zespołu określonym w teamDriveInfo.
ENTIRE_ORG przeszukiwanie danych na wszystkich kontach w organizacji, Obsługiwane tylko w Gmailu. W tym przypadku nie musisz określać właściwości AccountInfo ani OrgUnitInfo.
ROOM Wyszukiwanie wiadomości w pokojach czatu określonych w HangoutsChatInfo.
SITES_URL Szukaj witryn na podstawie opublikowanych adresów URL określonych w SitesUrlInfo.
SHARED_DRIVE Wyszukaj pliki na dyskach współdzielonych określonych we właściwości SharedDriveInfo.

AccountInfo

Konta, które mają być przeszukane

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

string

Zbiór kont do przeszukania.

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 przeszukiwania

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

string

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

HangoutsChatInfo

Pokoje czatu do przeszukiwania

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

string

Lista identyfikatorów pokojów czatu podana przez interfejs Chat API. Limit eksportowania z 500 pokojów czatu na prośbę.

SitesUrlInfo

Adresy URL opublikowanych witryn w nowej wersji Witryn Google do przeszukiwania

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

string

Lista adresów URL opublikowanych stron internetowych.

TeamDriveInfo

Dyski zespołu do przeszukiwania

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

string

Lista identyfikatorów Dysku zespołu udostępniona przez interfejs 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ą obejmować treści zaszyfrowane, nieszyfrowane czy oba rodzaje. Domyślnie uwzględniane są obie te wartości.

ClientSideEncryptedOption

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

Wartości w polu enum
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED Stan szyfrowania nieokreślony. Wyniki obejmują zarówno treści zaszyfrowane po stronie klienta, jak i niezaszyfrowane.
CLIENT_SIDE_ENCRYPTED_OPTION_ANY uwzględniać w wynikach zarówno treści zaszyfrowane po stronie klienta, jak i niezaszyfrowane;
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED Uwzględnij tylko treści zaszyfrowane po stronie klienta.
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED Uwzględniaj tylko treści niezaszyfrowane.

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 i wyeksportuj zawartość ostatniej wersji zapisanej przed godziną 00:00 czasu UTC w wybranym dniu. Wpisz datę w strefie czasowej UTC.

Sygnatura czasowa w formacie UTC „Zulu” zdefiniowanym w dokumencie RFC 3339, z dokładnością do nanosekund i maksymalnie 9 miejsc po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
includeTeamDrives
(deprecated)

boolean

Ustaw wartość Prawda, aby uwzględnić Dysk zespołu.
includeSharedDrives

boolean

Aby uwzględnić dyski współdzielone, ustaw wartość na 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 rodzaje. Domyślnie są zaznaczone oba pola. Obecnie obsługiwane na 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 wyszukiwania

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 zbioru. Jeśli ciąg znaków zawiera cudzysłów, ta metoda pasuje tylko do tych zdarzeń, których lokalizacja zawiera dokładne wyrażenie. Wpisy w zestawie są umieszczane w operatorze „i”.

Przykład dzielenia słów: ["Nowa Zelandia"] vs ["Nowa","Zelandia"] „Nowa Zelandia”: pasuje do obu słów „Nowa i lepsza Zelandia”: pasuje tylko do drugiego
peopleQuery[]

string

Dopasowuje tylko te wydarzenia, których uczestnicy zawierają wszystkie słowa w podanym zestawie. Wpisy w zestawie są umieszczane w operatorze „i”.
minusWords[]

string

Dopasowuje tylko te wydarzenia, które nie zawierają żadnego ze słów w podanym zestawie w tytule, opisie, lokalizacji ani uczestnikach. Wpisy w zbiorze są traktowane jako „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_Response_UNSPECIFIED, filtrowanie nie będzie stosowane.
versionDate

string (Timestamp format)

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

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową 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 Nieokreślona odpowiedź uczestnika. Jeśli ta opcja jest ustawiona, odpowiedzi nie będą filtrowane, a wszystkie inne odpowiedzi uczestników, które są częścią opcji zapytania, zostaną zignorowane.
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ęcia udziału.
ATTENDEE_RESPONSE_TENTATIVE Uczestnik spodziewa się uczestniczyć w wydarzeniu.