このページは Cloud Translation API によって翻訳されました。

Query

JSON 表現
DataScope
SearchMethod
AccountInfo
- JSON 表現
OrgUnitInfo
- JSON 表現
SharedDriveInfo
- JSON 表現
HangoutsChatInfo
- JSON 表現
SitesUrlInfo
- JSON 表現
TeamDriveInfo
- JSON 表現
MailOptions
- JSON 表現
ClientSideEncryptedOption
DriveOptions
- JSON 表現
HangoutsChatOptions
- JSON 表現
VoiceOptions
- JSON 表現
CalendarOptions
- JSON 表現
AttendeeResponse
GeminiOptions

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

JSON 表現

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`) }, "geminiOptions": { object (`GeminiOptions`) } // End of list of possible types for union field `corpus_options_field`. }

{
  "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)
  },
  "geminiOptions": {
    object (GeminiOptions)
  }
  // End of list of possible types for union field corpus_options_field.
}

フィールド
`corpus`	`enum (CorpusType)` 検索する Google Workspace サービス。
`dataScope`	`enum (DataScope)` 検索するデータソース。
`searchMethod (deprecated)`	`enum (SearchMethod)` このフィールドは 2019 年 6 月 10 日に非推奨になりました。代わりに method を使用してください。このフィールドのサポートは 2020 年 6 月 1 日に終了します。使用する検索方法。
`method`	`enum (SearchMethod)` 検索するエンティティ。このフィールドは、共有ドライブをサポートするために searchMethod に代わるものです。searchMethod が TEAM_DRIVE の場合、このフィールドのレスポンスは SHARED_DRIVE です。
`terms`	`string` 検索結果を絞り込むためのサービス固有の検索演算子。
`startTime`	`string (Timestamp format)` 検索クエリの開始時間。GMT で指定します。値は指定した日の午前 0 時に丸められます。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: `"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"`、`"2014-10-02T15:01:23+05:30"`。
`endTime`	`string (Timestamp format)` 検索クエリの終了時間。GMT で指定します。値は指定した日の午前 0 時に丸められます。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: `"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"`、`"2014-10-02T15:01:23+05:30"`。
`teamDriveInfo (deprecated)`	`object (TeamDriveInfo)` このフィールドは 2019 年 6 月 10 日に非推奨になりました。代わりに SharedDriveInfo を使用してください。このフィールドのサポートは 2020 年 6 月 1 日に終了します。 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)` カレンダー検索に固有のオプションを設定します。
`geminiOptions`	`object (GeminiOptions)` Gemini 検索に固有のオプションを設定します。

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 で指定されたチームドライブ内のデータを検索します。このフィールドは 2019 年 6 月 10 日に非推奨になりました。代わりに SHARED_DRIVE を使用してください。このフィールドのサポートは 2020 年 6 月 1 日に終了します。
`ENTIRE_ORG`	組織内のすべてのアカウントのデータを検索します。Gmail でのみサポートされています。指定した場合、AccountInfo または OrgUnitInfo を指定する必要はありません。
`ROOM`	HangoutsChatInfo で指定された Chat スペース内のメッセージを検索します。
`SITES_URL`	SitesUrlInfo で指定された公開サイトの URL でサイトを検索します。
`SHARED_DRIVE`	SharedDriveInfo で指定された共有ドライブ内のファイルを検索します。

AccountInfo

検索するアカウント

JSON 表現
{ "emails": [ string ] }

フィールド

フィールド
`emails[]`	`string` 検索するアカウントのセット。

emails[]

string

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

OrgUnitInfo

検索する組織部門

JSON 表現
{ "orgUnitId": string }

フィールド

フィールド
`orgUnitId`	`string` Admin SDK Directory API から提供される、検索する組織部門の名前。

orgUnitId

string

Admin SDK Directory API から提供される、検索する組織部門の名前。

SharedDriveInfo

検索する共有ドライブ

JSON 表現
{ "sharedDriveIds": [ string ] }

フィールド

フィールド
`sharedDriveIds[]`	`string` Drive API によって提供される共有ドライブ ID のリスト。

sharedDriveIds[]

string

Drive API によって提供される共有ドライブ ID のリスト。

HangoutsChatInfo

検索する Chat スペース

JSON 表現
{ "roomId": [ string ] }

フィールド

フィールド
`roomId[]`	`string` Chat API によって提供される Chat スペース ID のリスト。リクエストごとにエクスポートできる Chat スペースは 500 個までです。

roomId[]

string

Chat API によって提供される Chat スペース ID のリスト。リクエストごとにエクスポートできる Chat スペースは 500 個までです。

SitesUrlInfo

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

JSON 表現
{ "urls": [ string ] }

フィールド

フィールド
`urls[]`	`string` 公開済みのサイトの URL のリスト。

urls[]

string

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

TeamDriveInfo

検索するチームドライブ

JSON 表現
{ "teamDriveIds": [ string ] }

フィールド

フィールド
`teamDriveIds[] (deprecated)`	`string` このフィールドは 2019 年 6 月 10 日に非推奨になりました。代わりに sharedDriveIds を使用してください。このフィールドのサポートは 2020 年 6 月 1 日に終了します。 Drive API によって提供されるチームドライブ ID のリスト。

teamDriveIds[]
(deprecated)

string

Drive API によって提供されるチームドライブ ID のリスト。

MailOptions

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

JSON 表現
{ "excludeDrafts": boolean, "clientSideEncryptedOption": enum (`ClientSideEncryptedOption`) }

フィールド

フィールド
`excludeDrafts`	`boolean` 下書きを除外するには、true に設定します。
`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 の日付を入力します。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: `"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"`、`"2014-10-02T15:01:23+05:30"`。
`includeTeamDrives (deprecated)`	`boolean` このフィールドは 2019 年 6 月 10 日に非推奨になりました。代わりに includeSharedDrives を使用してください。このフィールドのサポートは 2020 年 6 月 1 日に終了します。チームドライブを含めるには true に設定します。
`includeSharedDrives (deprecated)`	`boolean` このフィールドは 2025 年 1 月 15 日に非推奨となりました。代わりに sharedDrivesOption を使用してください。このフィールドのサポートは 2026 年 1 月 15 日に終了します。共有ドライブを含めるには、true に設定します。
`clientSideEncryptedOption`	`enum (ClientSideEncryptedOption)` 結果に Google Workspace クライアントサイド暗号化で暗号化されたコンテンツのみを含めるか、暗号化されていないコンテンツのみを含めるか、両方を含めるかを設定します。デフォルトは両方です。現在、ドライブでサポートされています。

HangoutsChatOptions

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

JSON 表現
{ "includeRooms": boolean }

フィールド

フィールド
`includeRooms`	`boolean` アカウントまたは組織部門で検索する場合は、チャットルームを検索対象に含めるように true に設定します。

includeRooms

boolean

アカウントまたは組織部門で検索する場合は、チャットルームを検索対象に含めるように true に設定します。

VoiceOptions

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

JSON 表現
{ "coveredData": [ enum (`VoiceCoveredData`) ] }

フィールド

フィールド
`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"] 「New Zealand」: 両方に一致、「New and better Zealand」: 後者にのみ一致
`peopleQuery[]`	`string` 指定されたセット内のすべての単語が参加者に含まれるイベントのみが一致とみなされます。セット内のエントリは「かつ」とみなされます。
`minusWords[]`	`string` タイトル、説明、場所、参加者に指定されたセットの単語が含まれていないイベントのみが一致します。セット内のエントリは「または」とみなされます。
`responseStatuses[]`	`enum (AttendeeResponse)` 管理者がこれらの回答のいずれかを提供したイベントのみを照合します。セットが空であるか、ATTENDEE_RESPONSE_UNSPECIFIED が含まれている場合、回答はフィルタされません。
`versionDate`	`string (Timestamp format)` カレンダーイベントの最新の版を検索しますが、指定した日付の午前 12 時（UTC）より前に保存された最新の版のコンテンツを書き出します。UTC の日付を入力します。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: `"2014-10-02T15:01:23Z"`、`"2014-10-02T15:01:23.045123456Z"`、`"2014-10-02T15:01:23+05:30"`。

AttendeeResponse

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

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

GeminiOptions

この型にはフィールドがありません。

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