Query

検索とエクスポートに使用されるクエリ定義。

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.
}
フィールド
corpus

enum (CorpusType)

検索する Google Workspace サービス。
dataScope

enum (DataScope)

検索するデータソース。
searchMethod
(deprecated)

enum (SearchMethod)

使用する検索方法。
method

enum (SearchMethod)

検索するエンティティ。このフィールドは searchMethod に代わるもので、共有ドライブをサポートします。searchMethod が TEAM_DRIVE の場合、このフィールドのレスポンスは SHARED_DRIVE になります。
terms

string

検索結果を絞り込むためのサービス固有の検索演算子。
startTime

string (Timestamp format)

検索クエリの開始時間。GMT で指定します。値は指定した日の午前 0 時に丸められます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
endTime

string (Timestamp format)

検索クエリの終了時刻。GMT で指定します。値は指定した日の午前 0 時に丸められます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
teamDriveInfo
(deprecated)

object (TeamDriveInfo)

SearchMethod が TEAM_DRIVE の場合は必須です。
timeZone

string

タイムゾーンの名前。「America/Los_Angeles」などの IANA TZ 名になっているはずです。タイムゾーン名のリストについては、タイムゾーンをご覧ください。Vault でタイムゾーンがどのように使用されるかについて詳しくは、Vault ヘルプセンターをご覧ください。
共用体フィールド search_method_field。必要に応じて、search_method_field を検索するエンティティの詳細は次のいずれかになります。
accountInfo

object (AccountInfo)

SearchMethod が ACCOUNT の場合は必須です。
orgUnitInfo

object (OrgUnitInfo)

SearchMethod が ORG_UNIT の場合は必須です。
sharedDriveInfo

object (SharedDriveInfo)

SearchMethod が SHARED_DRIVE の場合は必須です。
hangoutsChatInfo

object (HangoutsChatInfo)

SearchMethod が ROOM の場合に必須です。（読み取りのみ）
sitesUrlInfo

object (SitesUrlInfo)

SearchMethod が SITES_URL の場合は必須です。
共用体フィールド corpus_options_field。特定のサービス向けの追加の検索オプション。corpus_options_field は次のいずれかになります。
mailOptions

object (MailOptions)

Gmail の検索固有のオプションを設定する。
driveOptions

object (DriveOptions)

ドライブ検索に固有のオプションを設定します。
hangoutsChatOptions

object (HangoutsChatOptions)

チャット検索に固有のオプションを設定します。（読み取りのみ）
voiceOptions

object (VoiceOptions)

音声検索に固有のオプションを設定します。
calendarOptions

object (CalendarOptions)

カレンダー検索固有のオプションを設定します。

DataScope

検索するデータのソース。

列挙型
DATA_SCOPE_UNSPECIFIED データソースが指定されていません。
ALL_DATA 利用可能なすべてのデータ。
HELD_DATA 記録保持対象のデータのみ。
UNPROCESSED_DATA Vault でまだ処理されていないデータのみ。（Gmail と Google グループのみ）

SearchMethod

検索のエンティティ タイプ。

列挙型
SEARCH_METHOD_UNSPECIFIED 検索方法を指定する必要があります。指定しない場合、リクエストは拒否されます。
ACCOUNT AccountInfo で指定されたアカウントのデータを検索します。
ORG_UNIT OrgUnitInfo で指定された組織部門内のすべてのアカウントのデータを検索します。
TEAM_DRIVE

teamDriveInfo で指定されたチームドライブ内のデータを検索します。
ENTIRE_ORG 組織内のすべてのアカウントのデータを検索する。Gmail でのみサポートされています。指定する場合、AccountInfo や OrgUnitInfo を指定する必要はありません。
ROOM HangoutsChatInfo で指定された Chat スペース内のメッセージを検索します。
SITES_URL SitesUrlInfo で指定された公開サイトの URL でサイトを検索します。
SHARED_DRIVE SharedDriveInfo で指定された共有ドライブ内のファイルを検索します。

AccountInfo

検索するアカウント

JSON 表現 
{
  "emails": [
    string
  ]
}
フィールド
emails[]

string

検索するアカウントのセット。

OrgUnitInfo

検索する組織部門

JSON 表現 
{
  "orgUnitId": string
}
フィールド
orgUnitId

string

検索する組織部門の名前（Admin SDK Directory API から指定）。

SharedDriveInfo

検索する共有ドライブ

JSON 表現 
{
  "sharedDriveIds": [
    string
  ]
}
フィールド
sharedDriveIds[]

string

Drive API で提供される共有ドライブ ID のリスト。

HangoutsChatInfo

検索する Chat スペース

JSON 表現 
{
  "roomId": [
    string
  ]
}
フィールド
roomId[]

string

Chat API によって提供される Chat スペース ID のリスト。リクエストごとに 500 個の Chat スペースからエクスポートできる上限があります。

SitesUrlInfo

検索する新しい Google サイトの公開済みサイトの URL

JSON 表現 
{
  "urls": [
    string
  ]
}
フィールド
urls[]

string

公開済みのサイトの URL のリスト。

TeamDriveInfo

検索するチームドライブ

JSON 表現 
{
  "teamDriveIds": [
    string
  ]
}
フィールド
teamDriveIds[]
(deprecated)

string

Drive API によって提供される Team Drive ID のリスト。

MailOptions

Gmail 検索のその他のオプション

JSON 表現 
{
  "excludeDrafts": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
フィールド
excludeDrafts

boolean

下書きを除外するには、true に設定します。
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

検索結果に含めるコンテンツ（暗号化されたコンテンツ、暗号化されていないコンテンツ、またはその両方）を指定します。デフォルトでは両方を含める。

ClientSideEncryptedOption

組織で Google Workspace クライアントサイド暗号化を使用している場合、コンテンツの暗号化ステータス

列挙型
CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED 暗号化ステータスが指定されていません。結果には、クライアントサイド暗号化されたコンテンツと暗号化されていないコンテンツの両方が含まれます。
CLIENT_SIDE_ENCRYPTED_OPTION_ANY 検索結果には、クライアントサイド暗号化コンテンツと暗号化されていないコンテンツの両方を含めます。
CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED クライアントサイド暗号化コンテンツのみを含めます。
CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED 暗号化されていないコンテンツのみを含めます。

DriveOptions

ドライブ検索のその他のオプション

JSON 表現 
{
  "versionDate": string,
  "includeTeamDrives": boolean,
  "includeSharedDrives": boolean,
  "clientSideEncryptedOption": enum (ClientSideEncryptedOption)
}
フィールド
versionDate

string (Timestamp format)

ドライブ ファイルの最新の版を検索しますが、指定した日付の午前 0 時（UTC）より前に保存された最新の版のコンテンツを書き出します。UTC の日付を入力します。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
includeTeamDrives
(deprecated)

boolean

チームドライブを含めるには true に設定します。
includeSharedDrives

boolean

共有ドライブを含めるには、true に設定します。
clientSideEncryptedOption

enum (ClientSideEncryptedOption)

Google Workspace クライアントサイド暗号化のコンテンツで暗号化されたコンテンツのみ、暗号化されていないコンテンツのみ、またはその両方を結果に含めるかどうかを設定します。デフォルトは両方です。現在、ドライブでサポートされています。

HangoutsChatOptions

Google Chat 検索のその他のオプション

JSON 表現 
{
  "includeRooms": boolean
}
フィールド
includeRooms

boolean

アカウントまたは組織部門で検索する場合は、true に設定すると会議室が含まれるようになります。

VoiceOptions

音声検索のその他のオプション

JSON 表現 
{
  "coveredData": [
    enum (VoiceCoveredData)
  ]
}
フィールド
coveredData[]

enum (VoiceCoveredData)

検索するデータ型

CalendarOptions

カレンダー検索のその他のオプション

JSON 表現 
{
  "locationQuery": [
    string
  ],
  "peopleQuery": [
    string
  ],
  "minusWords": [
    string
  ],
  "responseStatuses": [
    enum (AttendeeResponse)
  ],
  "versionDate": string
}
フィールド
locationQuery[]

string

指定されたセット内のすべての単語が場所に含まれるイベントのみが一致とみなされます。文字列に引用符で囲まれたフレーズが含まれている場合、このメソッドは、場所にそのフレーズを含むイベントのみを照合します。セット内のエントリは「かつ」とみなされます。

単語の分割の例: ["New Zealand"] と ["New","Zealand"] の比較
peopleQuery[]

string

指定されたセット内のすべての単語が参加者に含まれているイベントのみが照合されます。セット内のエントリは「and」で示されます。
minusWords[]

string

タイトル、説明、場所、参加者のいずれかの単語を含んでいないイベントのみが照合されます。セット内のエントリは「OR」で考慮されます。
responseStatuses[]

enum (AttendeeResponse)

管理者がこれらの応答のいずれかを行ったイベントのみを照合します。セットが空であるか、ATTENDEE_RESPONSE_UNSPECIFIED が含まれている場合、レスポンスはフィルタされません。
versionDate

string (Timestamp format)

カレンダーの予定の現在のバージョンを検索しますが、指定した日付の午前 12 時（UTC）より前に保存された最新のバージョンのコンテンツを書き出します。UTC で日付を入力します。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

AttendeeResponse

招待に対するユーザーの返信。

列挙型
ATTENDEE_RESPONSE_UNSPECIFIED 参加者の回答が指定されていません。これを設定すると、回答のフィルタリングは行われず、クエリ オプションの一部である他のすべての参加者の回答は無視されます。
ATTENDEE_RESPONSE_NEEDS_ACTION 参加者は招待されましたが、まだ応答がありません。
ATTENDEE_RESPONSE_ACCEPTED 参加者は出席を予定しています。
ATTENDEE_RESPONSE_DECLINED 参加者が参加する予定がない。
ATTENDEE_RESPONSE_TENTATIVE 参加者は参加を想定しています。