1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="vault_v1.html">Google Vault API</a> . <a href="vault_v1.matters.html">matters</a> . <a href="vault_v1.matters.savedQueries.html">savedQueries</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(matterId, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a saved query.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(matterId, savedQueryId, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes the specified saved query.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(matterId, savedQueryId, x__xgafv=None)</a></code></p> 88<p class="firstline">Retrieves the specified saved query.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists the saved queries in a matter.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="close">close()</code> 98 <pre>Close httplib2 connections.</pre> 99</div> 100 101<div class="method"> 102 <code class="details" id="create">create(matterId, body=None, x__xgafv=None)</code> 103 <pre>Creates a saved query. 104 105Args: 106 matterId: string, The ID of the matter to create the saved query in. (required) 107 body: object, The request body. 108 The object takes the form of: 109 110{ # The definition of a saved query. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. 111 "createTime": "A String", # Output only. The server-generated timestamp when the saved query was created. 112 "displayName": "A String", # The name of the saved query. 113 "matterId": "A String", # Output only. The matter ID of the matter the saved query is saved in. The server does not use this field during create and always uses matter ID in the URL. 114 "query": { # The query definition used for search and export. # The search parameters of the saved query. 115 "accountInfo": { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**. 116 "emails": [ # A set of accounts to search. 117 "A String", 118 ], 119 }, 120 "corpus": "A String", # The Google Workspace service to search. 121 "dataScope": "A String", # The data source to search. 122 "driveOptions": { # Additional options for Drive search # Set Drive search-specific options. 123 "includeSharedDrives": True or False, # Set to **true** to include shared drives. 124 "includeTeamDrives": True or False, # Set to true to include Team Drive. 125 "versionDate": "A String", # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC. 126 }, 127 "endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. 128 "hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only) 129 "roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat). 130 "A String", 131 ], 132 }, 133 "hangoutsChatOptions": { # Additional options for Google Chat search # Set Chat search-specific options. (read-only) 134 "includeRooms": True or False, # For searches by account or organizational unit, set to **true** to include rooms. 135 }, 136 "mailOptions": { # Additional options for Gmail search # Set Gmail search-specific options. 137 "excludeDrafts": True or False, # Set to **true** to exclude drafts. 138 }, 139 "method": "A String", # The entity to search. This field replaces **searchMethod** to support shared drives. When **searchMethod** is **TEAM_DRIVE**, the response of this field is **SHARED_DRIVE**. 140 "orgUnitInfo": { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**. 141 "orgUnitId": "A String", # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/). 142 }, 143 "searchMethod": "A String", # The search method to use. 144 "sharedDriveInfo": { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**. 145 "sharedDriveIds": [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive). 146 "A String", 147 ], 148 }, 149 "startTime": "A String", # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. 150 "teamDriveInfo": { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**. 151 "teamDriveIds": [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive). 152 "A String", 153 ], 154 }, 155 "terms": "A String", # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results. 156 "timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For a list of time zone names, see [Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For more information about how Vault uses time zones, see [the Vault help center](https://support.google.com/vault/answer/6092995#time). 157 "voiceOptions": { # Additional options for Voice search # Set Voice search-specific options. 158 "coveredData": [ # Datatypes to search 159 "A String", 160 ], 161 }, 162 }, 163 "savedQueryId": "A String", # A unique identifier for the saved query. 164} 165 166 x__xgafv: string, V1 error format. 167 Allowed values 168 1 - v1 error format 169 2 - v2 error format 170 171Returns: 172 An object of the form: 173 174 { # The definition of a saved query. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. 175 "createTime": "A String", # Output only. The server-generated timestamp when the saved query was created. 176 "displayName": "A String", # The name of the saved query. 177 "matterId": "A String", # Output only. The matter ID of the matter the saved query is saved in. The server does not use this field during create and always uses matter ID in the URL. 178 "query": { # The query definition used for search and export. # The search parameters of the saved query. 179 "accountInfo": { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**. 180 "emails": [ # A set of accounts to search. 181 "A String", 182 ], 183 }, 184 "corpus": "A String", # The Google Workspace service to search. 185 "dataScope": "A String", # The data source to search. 186 "driveOptions": { # Additional options for Drive search # Set Drive search-specific options. 187 "includeSharedDrives": True or False, # Set to **true** to include shared drives. 188 "includeTeamDrives": True or False, # Set to true to include Team Drive. 189 "versionDate": "A String", # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC. 190 }, 191 "endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. 192 "hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only) 193 "roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat). 194 "A String", 195 ], 196 }, 197 "hangoutsChatOptions": { # Additional options for Google Chat search # Set Chat search-specific options. (read-only) 198 "includeRooms": True or False, # For searches by account or organizational unit, set to **true** to include rooms. 199 }, 200 "mailOptions": { # Additional options for Gmail search # Set Gmail search-specific options. 201 "excludeDrafts": True or False, # Set to **true** to exclude drafts. 202 }, 203 "method": "A String", # The entity to search. This field replaces **searchMethod** to support shared drives. When **searchMethod** is **TEAM_DRIVE**, the response of this field is **SHARED_DRIVE**. 204 "orgUnitInfo": { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**. 205 "orgUnitId": "A String", # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/). 206 }, 207 "searchMethod": "A String", # The search method to use. 208 "sharedDriveInfo": { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**. 209 "sharedDriveIds": [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive). 210 "A String", 211 ], 212 }, 213 "startTime": "A String", # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. 214 "teamDriveInfo": { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**. 215 "teamDriveIds": [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive). 216 "A String", 217 ], 218 }, 219 "terms": "A String", # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results. 220 "timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For a list of time zone names, see [Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For more information about how Vault uses time zones, see [the Vault help center](https://support.google.com/vault/answer/6092995#time). 221 "voiceOptions": { # Additional options for Voice search # Set Voice search-specific options. 222 "coveredData": [ # Datatypes to search 223 "A String", 224 ], 225 }, 226 }, 227 "savedQueryId": "A String", # A unique identifier for the saved query. 228}</pre> 229</div> 230 231<div class="method"> 232 <code class="details" id="delete">delete(matterId, savedQueryId, x__xgafv=None)</code> 233 <pre>Deletes the specified saved query. 234 235Args: 236 matterId: string, The ID of the matter to delete the saved query from. (required) 237 savedQueryId: string, ID of the saved query to delete. (required) 238 x__xgafv: string, V1 error format. 239 Allowed values 240 1 - v1 error format 241 2 - v2 error format 242 243Returns: 244 An object of the form: 245 246 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 247}</pre> 248</div> 249 250<div class="method"> 251 <code class="details" id="get">get(matterId, savedQueryId, x__xgafv=None)</code> 252 <pre>Retrieves the specified saved query. 253 254Args: 255 matterId: string, The ID of the matter to get the saved query from. (required) 256 savedQueryId: string, ID of the saved query to retrieve. (required) 257 x__xgafv: string, V1 error format. 258 Allowed values 259 1 - v1 error format 260 2 - v2 error format 261 262Returns: 263 An object of the form: 264 265 { # The definition of a saved query. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. 266 "createTime": "A String", # Output only. The server-generated timestamp when the saved query was created. 267 "displayName": "A String", # The name of the saved query. 268 "matterId": "A String", # Output only. The matter ID of the matter the saved query is saved in. The server does not use this field during create and always uses matter ID in the URL. 269 "query": { # The query definition used for search and export. # The search parameters of the saved query. 270 "accountInfo": { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**. 271 "emails": [ # A set of accounts to search. 272 "A String", 273 ], 274 }, 275 "corpus": "A String", # The Google Workspace service to search. 276 "dataScope": "A String", # The data source to search. 277 "driveOptions": { # Additional options for Drive search # Set Drive search-specific options. 278 "includeSharedDrives": True or False, # Set to **true** to include shared drives. 279 "includeTeamDrives": True or False, # Set to true to include Team Drive. 280 "versionDate": "A String", # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC. 281 }, 282 "endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. 283 "hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only) 284 "roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat). 285 "A String", 286 ], 287 }, 288 "hangoutsChatOptions": { # Additional options for Google Chat search # Set Chat search-specific options. (read-only) 289 "includeRooms": True or False, # For searches by account or organizational unit, set to **true** to include rooms. 290 }, 291 "mailOptions": { # Additional options for Gmail search # Set Gmail search-specific options. 292 "excludeDrafts": True or False, # Set to **true** to exclude drafts. 293 }, 294 "method": "A String", # The entity to search. This field replaces **searchMethod** to support shared drives. When **searchMethod** is **TEAM_DRIVE**, the response of this field is **SHARED_DRIVE**. 295 "orgUnitInfo": { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**. 296 "orgUnitId": "A String", # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/). 297 }, 298 "searchMethod": "A String", # The search method to use. 299 "sharedDriveInfo": { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**. 300 "sharedDriveIds": [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive). 301 "A String", 302 ], 303 }, 304 "startTime": "A String", # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. 305 "teamDriveInfo": { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**. 306 "teamDriveIds": [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive). 307 "A String", 308 ], 309 }, 310 "terms": "A String", # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results. 311 "timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For a list of time zone names, see [Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For more information about how Vault uses time zones, see [the Vault help center](https://support.google.com/vault/answer/6092995#time). 312 "voiceOptions": { # Additional options for Voice search # Set Voice search-specific options. 313 "coveredData": [ # Datatypes to search 314 "A String", 315 ], 316 }, 317 }, 318 "savedQueryId": "A String", # A unique identifier for the saved query. 319}</pre> 320</div> 321 322<div class="method"> 323 <code class="details" id="list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None)</code> 324 <pre>Lists the saved queries in a matter. 325 326Args: 327 matterId: string, The ID of the matter to get the saved queries for. (required) 328 pageSize: integer, The maximum number of saved queries to return. 329 pageToken: string, The pagination token as returned in the previous response. An empty token means start from the beginning. 330 x__xgafv: string, V1 error format. 331 Allowed values 332 1 - v1 error format 333 2 - v2 error format 334 335Returns: 336 An object of the form: 337 338 { # Definition of the response for method ListSaveQuery. 339 "nextPageToken": "A String", # Page token to retrieve the next page of results in the list. If this is empty, then there are no more saved queries to list. 340 "savedQueries": [ # List of saved queries. 341 { # The definition of a saved query. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. 342 "createTime": "A String", # Output only. The server-generated timestamp when the saved query was created. 343 "displayName": "A String", # The name of the saved query. 344 "matterId": "A String", # Output only. The matter ID of the matter the saved query is saved in. The server does not use this field during create and always uses matter ID in the URL. 345 "query": { # The query definition used for search and export. # The search parameters of the saved query. 346 "accountInfo": { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**. 347 "emails": [ # A set of accounts to search. 348 "A String", 349 ], 350 }, 351 "corpus": "A String", # The Google Workspace service to search. 352 "dataScope": "A String", # The data source to search. 353 "driveOptions": { # Additional options for Drive search # Set Drive search-specific options. 354 "includeSharedDrives": True or False, # Set to **true** to include shared drives. 355 "includeTeamDrives": True or False, # Set to true to include Team Drive. 356 "versionDate": "A String", # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC. 357 }, 358 "endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. 359 "hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only) 360 "roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat). 361 "A String", 362 ], 363 }, 364 "hangoutsChatOptions": { # Additional options for Google Chat search # Set Chat search-specific options. (read-only) 365 "includeRooms": True or False, # For searches by account or organizational unit, set to **true** to include rooms. 366 }, 367 "mailOptions": { # Additional options for Gmail search # Set Gmail search-specific options. 368 "excludeDrafts": True or False, # Set to **true** to exclude drafts. 369 }, 370 "method": "A String", # The entity to search. This field replaces **searchMethod** to support shared drives. When **searchMethod** is **TEAM_DRIVE**, the response of this field is **SHARED_DRIVE**. 371 "orgUnitInfo": { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**. 372 "orgUnitId": "A String", # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/). 373 }, 374 "searchMethod": "A String", # The search method to use. 375 "sharedDriveInfo": { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**. 376 "sharedDriveIds": [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive). 377 "A String", 378 ], 379 }, 380 "startTime": "A String", # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date. 381 "teamDriveInfo": { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**. 382 "teamDriveIds": [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive). 383 "A String", 384 ], 385 }, 386 "terms": "A String", # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results. 387 "timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For a list of time zone names, see [Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For more information about how Vault uses time zones, see [the Vault help center](https://support.google.com/vault/answer/6092995#time). 388 "voiceOptions": { # Additional options for Voice search # Set Voice search-specific options. 389 "coveredData": [ # Datatypes to search 390 "A String", 391 ], 392 }, 393 }, 394 "savedQueryId": "A String", # A unique identifier for the saved query. 395 }, 396 ], 397}</pre> 398</div> 399 400<div class="method"> 401 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 402 <pre>Retrieves the next page of results. 403 404Args: 405 previous_request: The request for the previous page. (required) 406 previous_response: The response from the request for the previous page. (required) 407 408Returns: 409 A request object that you can call 'execute()' on to request the next 410 page. Returns None if there are no more items in the collection. 411 </pre> 412</div> 413 414</body></html>