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,

  "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)
  }
}
フィールド
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 で指定します。値は、指定した日付の午前 12 時に丸められます。

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 で指定します。値は、指定した日付の午前 12 時に丸められます。

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)

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

string

タイムゾーンの名前。IANA TZ 名（「America/Los_Angeles」など）にする必要があります。タイムゾーン名の一覧については、タイムゾーンをご覧ください。Vault でのタイムゾーンの使用方法について詳しくは、Vault ヘルプセンターをご覧ください。
必要に応じて、検索するエンティティの詳細を指定します。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
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 の場合は必須。
driveDocumentInfo

object (DriveDocumentInfo)

SearchMethod が DRIVE_DOCUMENT の場合は必須。
相互に排他的なフィールドの終了。
特定のサービスに関する追加の検索オプション。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
mailOptions

object (MailOptions)

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

object (DriveOptions)

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

object (HangoutsChatOptions)

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

object (VoiceOptions)

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

object (CalendarOptions)

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

object (GeminiOptions)

Gemini アプリの検索固有のオプションを設定します。
geminiInWorkspaceOptions

object (GeminiInWorkspaceOptions)

Gemini in Workspace の検索固有のオプションを設定します。
相互に排他的なフィールドの終了。

DataScope

検索対象のデータソース。

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

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 で指定された共有ドライブ内のファイルを検索します。
DRIVE_DOCUMENT DriveDocumentInfo で指定されたドキュメントを取得します。

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 のリスト。1 回のリクエストでエクスポートできる Chat スペースの数は 500 個までです。

SitesUrlInfo

検索対象となる新しい Google サイトの公開サイト URL

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

string

公開されているサイトの URL のリスト。

DriveDocumentInfo

検索対象のドライブ ドキュメント。

JSON 表現 
{

  "documentIds": {
    object (DriveDocumentIds)
  }
}
フィールド
ドライブ ドキュメントを取得する形式。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
documentIds

object (DriveDocumentIds)

ドライブのドキュメントをドキュメント ID で指定します。
相互に排他的なフィールドの終了。

DriveDocumentIds

ドライブのドキュメントをドキュメント ID で指定します。

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

string

必須。ドライブのドキュメント ID のリスト。

TeamDriveInfo

検索対象のチームドライブ

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

string

Drive API で提供されるチームドライブ 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),
  "sharedDrivesOption": enum (SharedDrivesOption)
}
フィールド
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"。
includeTeamDrives
(deprecated)

boolean

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

boolean

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

enum (ClientSideEncryptedOption)

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

enum (SharedDrivesOption)

省略可。共有ドライブ内のドキュメントを含めるか除外するかを選択するオプション。includeSharedDrives よりもこのフィールドを使用することをおすすめします。このフィールドを設定すると、includeSharedDrives と includeTeamDrives がオーバーライドされます。

SharedDrivesOption

含める共有ドライブのドキュメントの種類に関するオプション。

列挙型
SHARED_DRIVES_OPTION_UNSPECIFIED 共有ドライブのオプションが指定されていません。
NOT_INCLUDED リソースが共有ドライブ内にある場合、検索には含まれません。
INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER 共有ドライブのリソースは、アカウントがリソースの共同編集者であり、共有ドライブのメンバーではない場合にのみ含まれます。これは、Vault UI の [ドキュメントが直接共有されている場合のみ含める（共有ドライブのメンバーである場合は含めない）] オプションに対応しています。（以前は「includeSharedDrives」がオフ）
INCLUDED 共有ドライブ内のリソースが検索対象に含まれます。（以前は「includeSharedDrives」がオン）

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

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

単語分割の例: ["New Zealand"] と ["New","Zealand"] "New Zealand": 両方に一致 "New and better Zealand": 後者にのみ一致
peopleQuery[]

string

参加者に指定されたセットのすべての単語が含まれているイベントのみが一致します。セット内のエントリは「AND」で考慮されます。
minusWords[]

string

タイトル、説明、場所、参加者に、指定した一連の単語のいずれも含まれていない予定のみが一致します。セット内のエントリは「OR」と見なされます。
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 アプリ検索の追加オプション

GeminiInWorkspaceOptions

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

Gemini in Workspace の検索に関するその他のオプション