- JSON 表現
- DataScope
- SearchMethod
- AccountInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- OrgUnitInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- SharedDriveInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- HangoutsChatInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- SitesUrlInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- TeamDriveInfo
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- MailOptions
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- ClientSideEncryptedOption
- DriveOptions
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- HangoutsChatOptions
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- VoiceOptions
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- CalendarOptions
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- AttendeeResponse
検索とエクスポートに使用されるクエリ定義。
JSON 表現 |
---|
{ "corpus": enum ( |
フィールド | |
---|---|
corpus |
検索する Google Workspace サービス。 |
dataScope |
検索するデータソース。 |
searchMethod |
使用する検索方法。 |
method |
検索するエンティティ。このフィールドは searchMethod に代わるもので、共有ドライブをサポートします。searchMethod が TEAM_DRIVE の場合、このフィールドのレスポンスは SHARED_DRIVE になります。 |
terms |
検索結果をフィルタするサービス固有の検索演算子。 |
startTime |
検索クエリの開始時間。GMT で指定します。値は指定された日付の午前 12 時(00:00)に丸められます。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
endTime |
検索クエリの終了時刻。GMT で指定します。値は指定された日付の午前 12 時(00:00)に丸められます。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
teamDriveInfo |
SearchMethod が TEAM_DRIVE の場合は必須です。 |
timeZone |
タイムゾーンの名前。「America/Los_Angeles」などの IANA TZ 名になっているはずです。タイムゾーン名の一覧については、タイムゾーンをご覧ください。Vault でタイムゾーンがどのように使用されるかについて詳しくは、Vault ヘルプセンターをご覧ください。 |
共用体フィールド search_method_field 。必要に応じて、search_method_field を検索するエンティティの詳細を次のいずれかにできます。 |
|
accountInfo |
SearchMethod が ACCOUNT の場合は必須です。 |
orgUnitInfo |
SearchMethod が ORG_UNIT の場合は必須です。 |
sharedDriveInfo |
SearchMethod が SHARED_DRIVE の場合は必須です。 |
hangoutsChatInfo |
SearchMethod が ROOM の場合は必須です。(読み取りのみ) |
sitesUrlInfo |
SearchMethod が SITES_URL の場合は必須です。 |
共用体フィールド corpus_options_field 。特定のサービスに関する追加の検索オプション。corpus_options_field は次のいずれかになります。 |
|
mailOptions |
Gmail の検索固有のオプションを設定する。 |
driveOptions |
ドライブの検索固有のオプションを設定します。 |
hangoutsChatOptions |
Chat の検索固有のオプションを設定する。(読み取りのみ) |
voiceOptions |
音声検索固有のオプションを設定します。 |
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[] |
検索するアカウントのセット。 |
OrgUnitInfo
検索する組織部門
JSON 表現 |
---|
{ "orgUnitId": string } |
フィールド | |
---|---|
orgUnitId |
検索する組織部門の名前(Admin SDK Directory API から指定)。 |
HangoutsChatInfo
検索する Chat スペース
JSON 表現 |
---|
{ "roomId": [ string ] } |
フィールド | |
---|---|
roomId[] |
Chat API によって提供される Chat スペース ID のリスト。リクエストごとに 500 個の Chat スペースからエクスポートできる上限があります。 |
SitesUrlInfo
検索する新しい Google サイトの公開済みサイトの URL
JSON 表現 |
---|
{ "urls": [ string ] } |
フィールド | |
---|---|
urls[] |
公開されているサイトの URL のリストです。 |
TeamDriveInfo
検索するチームドライブ
JSON 表現 |
---|
{ "teamDriveIds": [ string ] } |
フィールド | |
---|---|
teamDriveIds[] |
Drive API で提供されるチームドライブ ID のリスト。 |
MailOptions
Gmail 検索のその他のオプション
JSON 表現 |
---|
{
"excludeDrafts": boolean,
"clientSideEncryptedOption": enum ( |
フィールド | |
---|---|
excludeDrafts |
下書きを除外するには、true に設定します。 |
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 ( |
フィールド | |
---|---|
versionDate |
ドライブ ファイルの現在の版を検索します。ただし、指定した日付の午前 12 時(UTC)より前に保存された最後の版のコンテンツを書き出します。UTC で日付を入力します。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
includeTeamDrives |
チームドライブを含めるには true に設定します。 |
includeSharedDrives |
共有ドライブを含めるには、true に設定します。 |
clientSideEncryptedOption |
Google Workspace クライアントサイド暗号化のコンテンツで暗号化されたコンテンツのみ、暗号化されていないコンテンツのみ、またはその両方を結果に含めるかどうかを設定します。デフォルトは両方です。現在のところドライブでサポートされています。 |
HangoutsChatOptions
Google Chat 検索のその他のオプション
JSON 表現 |
---|
{ "includeRooms": boolean } |
フィールド | |
---|---|
includeRooms |
アカウントまたは組織部門で検索する場合は、true に設定すると会議室が含まれるようになります。 |
VoiceOptions
音声検索のその他のオプション
JSON 表現 |
---|
{
"coveredData": [
enum ( |
フィールド | |
---|---|
coveredData[] |
検索するデータ型 |
CalendarOptions
カレンダー検索のその他のオプション
JSON 表現 |
---|
{
"locationQuery": [
string
],
"peopleQuery": [
string
],
"minusWords": [
string
],
"responseStatuses": [
enum ( |
フィールド | |
---|---|
locationQuery[] |
指定されたセット内のすべての単語が場所に含まれているイベントのみを照合します。文字列に引用符で囲まれたフレーズが含まれている場合、このメソッドでは、場所にそのフレーズを含むイベントのみが照合されます。セット内のエントリは「and」で示されます。 単語の分割の例: ["New Zealand"] と ["New","Zealand"] の比較 |
peopleQuery[] |
指定されたセット内のすべての単語が参加者に含まれているイベントのみが照合されます。セット内のエントリは「and」で示されます。 |
minusWords[] |
タイトル、説明、場所、参加者のいずれかの単語を含んでいないイベントのみが照合されます。セット内のエントリは「OR」で考慮されます。 |
responseStatuses[] |
管理者がこれらの応答のいずれかを行ったイベントのみを照合します。セットが空であるか、ATTENDEE_RESPONSE_UNSPECIFIED が含まれている場合、レスポンスはフィルタされません。 |
versionDate |
カレンダーの予定の現在のバージョンを検索しますが、指定した日付の午前 12 時(UTC)より前に保存された最新のバージョンのコンテンツを書き出します。UTC で日付を入力します。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
AttendeeResponse
招待に対するユーザーの返信。
列挙型 | |
---|---|
ATTENDEE_RESPONSE_UNSPECIFIED |
参加者の回答が指定されていません。これを設定した場合、回答に対するフィルタは行われません。クエリ オプションに含まれる他の参加者の回答はすべて無視されます。 |
ATTENDEE_RESPONSE_NEEDS_ACTION |
参加者は招待されましたが、まだ応答がありません。 |
ATTENDEE_RESPONSE_ACCEPTED |
参加者は出席を予定しています。 |
ATTENDEE_RESPONSE_DECLINED |
参加者は出席する予定がありません。 |
ATTENDEE_RESPONSE_TENTATIVE |
参加者が出席を予定している。 |