- JSON 表現
- DataScope
- SearchMethod
- AccountInfo
- OrgUnitInfo
- SharedDriveInfo
- HangoutsChatInfo
- SitesUrlInfo
- TeamDriveInfo
- MailOptions
- ClientSideEncryptedOption
- DriveOptions
- HangoutsChatOptions
- VoiceOptions
- CalendarOptions
- AttendeeResponse
検索とエクスポートに使用されるクエリ定義。
JSON 表現 |
---|
{ "corpus": enum ( |
フィールド | |
---|---|
corpus |
検索する Google Workspace サービス。 |
dataScope |
検索するデータソース。 |
searchMethod |
使用する検索メソッド。 |
method |
検索するエンティティ。このフィールドは、共有ドライブをサポートするために searchMethod に置き換わるものです。searchMethod が TEAM_DRIVE の場合、このフィールドのレスポンスは SHARED_DRIVE です。 |
terms |
検索結果をフィルタするサービス固有の検索演算子。 |
startTime |
検索クエリの開始時間。GMT で指定します。値は指定した日付の午前 12 時に四捨五入されます。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
endTime |
検索クエリの終了時間。GMT で指定します。値は指定した日付の午前 12 時に四捨五入されます。 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[] |
チームドライブ ID のリスト(Drive API により指定)。 |
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"] "New Zealand": 「New and better Zealand」の両方に一致: 後のほうにのみ一致 |
peopleQuery[] |
指定されたセットのすべての単語を参加者に含むイベントのみが一致します。セット内のエントリは「AND」で処理されます。 |
minusWords[] |
タイトル、説明、場所、参加者で指定されたセットのいずれの単語も含まない予定にのみ一致します。セット内のエントリは「または」とみなされます。 |
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 |
参加者は参加することを期待しています。 |