{ "batchPath": "batch", "protocol": "rest", "mtlsRootUrl": "https://vault.mtls.googleapis.com/", "servicePath": "", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/ediscovery": { "description": "Manage your eDiscovery data" }, "https://www.googleapis.com/auth/ediscovery.readonly": { "description": "View your eDiscovery data" } } } }, "parameters": { "upload_protocol": { "location": "query", "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "callback": { "location": "query", "type": "string", "description": "JSONP" }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, "quotaUser": { "location": "query", "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, "alt": { "enum": [ "json", "media", "proto" ], "type": "string", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "description": "Data format for response." }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "prettyPrint": { "default": "true", "description": "Returns response with indentations and line breaks.", "type": "boolean", "location": "query" }, "$.xgafv": { "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ], "enum": [ "1", "2" ], "description": "V1 error format.", "type": "string" }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." } }, "documentationLink": "https://developers.google.com/workspace/vault", "resources": { "operations": { "methods": { "get": { "flatPath": "v1/operations/{operationsId}", "parameters": { "name": { "required": true, "description": "The name of the operation resource.", "location": "path", "pattern": "^operations/.*$", "type": "string" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "id": "vault.operations.get", "httpMethod": "GET", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service." }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "parameters": { "name": { "pattern": "^operations$", "required": true, "type": "string", "description": "The name of the operation's parent resource.", "location": "path" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "pageToken": { "location": "query", "description": "The standard list page token.", "type": "string" }, "filter": { "type": "string", "description": "The standard list filter.", "location": "query" }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The standard list page size." } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "httpMethod": "GET", "path": "v1/{+name}", "flatPath": "v1/operations", "id": "vault.operations.list", "response": { "$ref": "ListOperationsResponse" } }, "delete": { "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "required": true, "location": "path", "pattern": "^operations/.*$", "type": "string" } }, "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "httpMethod": "DELETE", "response": { "$ref": "Empty" }, "flatPath": "v1/operations/{operationsId}", "id": "vault.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "parameterOrder": [ "name" ] }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "request": { "$ref": "CancelOperationRequest" }, "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "parameters": { "name": { "location": "path", "pattern": "^operations/.*$", "required": true, "description": "The name of the operation resource to be cancelled.", "type": "string" } }, "id": "vault.operations.cancel", "path": "v1/{+name}:cancel", "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "httpMethod": "POST", "flatPath": "v1/operations/{operationsId}:cancel" } } }, "matters": { "methods": { "delete": { "description": "Deletes the specified matter. Returns the matter with updated state.", "response": { "$ref": "Matter" }, "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "parameterOrder": [ "matterId" ], "httpMethod": "DELETE", "flatPath": "v1/matters/{matterId}", "id": "vault.matters.delete", "parameters": { "matterId": { "location": "path", "description": "The matter ID", "type": "string", "required": true } }, "path": "v1/matters/{matterId}" }, "reopen": { "request": { "$ref": "ReopenMatterRequest" }, "parameters": { "matterId": { "required": true, "description": "The matter ID.", "type": "string", "location": "path" } }, "id": "vault.matters.reopen", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "response": { "$ref": "ReopenMatterResponse" }, "flatPath": "v1/matters/{matterId}:reopen", "path": "v1/matters/{matterId}:reopen", "parameterOrder": [ "matterId" ], "description": "Reopens the specified matter. Returns the matter with updated state.", "httpMethod": "POST" }, "update": { "flatPath": "v1/matters/{matterId}", "description": "Updates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored. Returns the default view of the matter.", "response": { "$ref": "Matter" }, "httpMethod": "PUT", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "path": "v1/matters/{matterId}", "parameters": { "matterId": { "location": "path", "type": "string", "description": "The matter ID.", "required": true } }, "parameterOrder": [ "matterId" ], "request": { "$ref": "Matter" }, "id": "vault.matters.update" }, "close": { "response": { "$ref": "CloseMatterResponse" }, "parameterOrder": [ "matterId" ], "flatPath": "v1/matters/{matterId}:close", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "id": "vault.matters.close", "description": "Closes the specified matter. Returns the matter with updated state.", "path": "v1/matters/{matterId}:close", "parameters": { "matterId": { "location": "path", "required": true, "description": "The matter ID.", "type": "string" } }, "request": { "$ref": "CloseMatterRequest" } }, "addPermissions": { "flatPath": "v1/matters/{matterId}:addPermissions", "httpMethod": "POST", "response": { "$ref": "MatterPermission" }, "request": { "$ref": "AddMatterPermissionsRequest" }, "parameterOrder": [ "matterId" ], "id": "vault.matters.addPermissions", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "description": "Adds an account as a matter collaborator.", "path": "v1/matters/{matterId}:addPermissions", "parameters": { "matterId": { "description": "The matter ID.", "location": "path", "required": true, "type": "string" } } }, "list": { "description": "Lists matters the requestor has access to.", "httpMethod": "GET", "path": "v1/matters", "id": "vault.matters.list", "response": { "$ref": "ListMattersResponse" }, "flatPath": "v1/matters", "parameters": { "state": { "description": "If set, lists only matters with the specified state. The default lists matters of all states.", "enumDescriptions": [ "The matter has no specified state.", "The matter is open.", "The matter is closed.", "The matter is deleted." ], "type": "string", "enum": [ "STATE_UNSPECIFIED", "OPEN", "CLOSED", "DELETED" ], "location": "query" }, "pageToken": { "type": "string", "description": "The pagination token as returned in the response.", "location": "query" }, "pageSize": { "type": "integer", "location": "query", "format": "int32", "description": "The number of matters to return in the response. Default and maximum are 100." }, "view": { "description": "Specifies how much information about the matter to return in response.", "enum": [ "VIEW_UNSPECIFIED", "BASIC", "FULL" ], "location": "query", "enumDescriptions": [ "The amount of detail is unspecified. Same as **BASIC**.", "Returns the matter ID, name, description, and state. Default choice.", "Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/workspace/vault/reference/rest/v1/matters#matterpermission))." ], "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "parameterOrder": [] }, "undelete": { "description": "Undeletes the specified matter. Returns the matter with updated state.", "flatPath": "v1/matters/{matterId}:undelete", "httpMethod": "POST", "response": { "$ref": "Matter" }, "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "id": "vault.matters.undelete", "parameters": { "matterId": { "location": "path", "description": "The matter ID.", "required": true, "type": "string" } }, "request": { "$ref": "UndeleteMatterRequest" }, "path": "v1/matters/{matterId}:undelete", "parameterOrder": [ "matterId" ] }, "removePermissions": { "parameters": { "matterId": { "description": "The matter ID.", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "matterId" ], "id": "vault.matters.removePermissions", "path": "v1/matters/{matterId}:removePermissions", "request": { "$ref": "RemoveMatterPermissionsRequest" }, "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "httpMethod": "POST", "response": { "$ref": "Empty" }, "description": "Removes an account as a matter collaborator.", "flatPath": "v1/matters/{matterId}:removePermissions" }, "create": { "request": { "$ref": "Matter" }, "parameters": {}, "httpMethod": "POST", "path": "v1/matters", "description": "Creates a matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.", "flatPath": "v1/matters", "id": "vault.matters.create", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "response": { "$ref": "Matter" }, "parameterOrder": [] }, "get": { "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "httpMethod": "GET", "path": "v1/matters/{matterId}", "flatPath": "v1/matters/{matterId}", "parameterOrder": [ "matterId" ], "response": { "$ref": "Matter" }, "parameters": { "matterId": { "location": "path", "type": "string", "description": "The matter ID.", "required": true }, "view": { "enum": [ "VIEW_UNSPECIFIED", "BASIC", "FULL" ], "type": "string", "description": "Specifies how much information about the matter to return in the response.", "enumDescriptions": [ "The amount of detail is unspecified. Same as **BASIC**.", "Returns the matter ID, name, description, and state. Default choice.", "Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/workspace/vault/reference/rest/v1/matters#matterpermission))." ], "location": "query" } }, "description": "Gets the specified matter.", "id": "vault.matters.get" }, "count": { "request": { "$ref": "CountArtifactsRequest" }, "parameterOrder": [ "matterId" ], "id": "vault.matters.count", "parameters": { "matterId": { "description": "The matter ID.", "required": true, "type": "string", "location": "path" } }, "path": "v1/matters/{matterId}:count", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "httpMethod": "POST", "flatPath": "v1/matters/{matterId}:count", "description": "Counts the accounts processed by the specified query.", "response": { "$ref": "Operation" } } }, "resources": { "savedQueries": { "methods": { "list": { "path": "v1/matters/{matterId}/savedQueries", "parameters": { "matterId": { "location": "path", "type": "string", "description": "The ID of the matter to get the saved queries for.", "required": true }, "pageSize": { "location": "query", "format": "int32", "type": "integer", "description": "The maximum number of saved queries to return." }, "pageToken": { "description": "The pagination token as returned in the previous response. An empty token means start from the beginning.", "type": "string", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "parameterOrder": [ "matterId" ], "id": "vault.matters.savedQueries.list", "httpMethod": "GET", "flatPath": "v1/matters/{matterId}/savedQueries", "response": { "$ref": "ListSavedQueriesResponse" }, "description": "Lists the saved queries in a matter." }, "delete": { "id": "vault.matters.savedQueries.delete", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "flatPath": "v1/matters/{matterId}/savedQueries/{savedQueryId}", "httpMethod": "DELETE", "parameterOrder": [ "matterId", "savedQueryId" ], "description": "Deletes the specified saved query.", "response": { "$ref": "Empty" }, "parameters": { "savedQueryId": { "type": "string", "location": "path", "description": "ID of the saved query to delete.", "required": true }, "matterId": { "location": "path", "type": "string", "description": "The ID of the matter to delete the saved query from.", "required": true } }, "path": "v1/matters/{matterId}/savedQueries/{savedQueryId}" }, "create": { "request": { "$ref": "SavedQuery" }, "parameters": { "matterId": { "required": true, "type": "string", "description": "The ID of the matter to create the saved query in.", "location": "path" } }, "response": { "$ref": "SavedQuery" }, "flatPath": "v1/matters/{matterId}/savedQueries", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "id": "vault.matters.savedQueries.create", "parameterOrder": [ "matterId" ], "description": "Creates a saved query.", "httpMethod": "POST", "path": "v1/matters/{matterId}/savedQueries" }, "get": { "parameters": { "savedQueryId": { "type": "string", "location": "path", "required": true, "description": "ID of the saved query to retrieve." }, "matterId": { "type": "string", "location": "path", "required": true, "description": "The ID of the matter to get the saved query from." } }, "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "description": "Retrieves the specified saved query.", "response": { "$ref": "SavedQuery" }, "flatPath": "v1/matters/{matterId}/savedQueries/{savedQueryId}", "path": "v1/matters/{matterId}/savedQueries/{savedQueryId}", "id": "vault.matters.savedQueries.get", "parameterOrder": [ "matterId", "savedQueryId" ], "httpMethod": "GET" } } }, "holds": { "methods": { "list": { "parameterOrder": [ "matterId" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "id": "vault.matters.holds.list", "description": "Lists the holds in a matter.", "response": { "$ref": "ListHoldsResponse" }, "flatPath": "v1/matters/{matterId}/holds", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "The pagination token as returned in the response. An empty token means start from the beginning." }, "matterId": { "description": "The matter ID.", "required": true, "type": "string", "location": "path" }, "pageSize": { "location": "query", "format": "int32", "description": "The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as **page_size** = 100.", "type": "integer" }, "view": { "enumDescriptions": [ "Not specified. Defaults to **FULL_HOLD**.", "Returns the hold ID, name, update time, service, and query.", "Returns all details of **BASIC_HOLD** and the entities the hold applies to, such as accounts or organizational unit." ], "type": "string", "location": "query", "description": "The amount of detail to return for a hold.", "enum": [ "HOLD_VIEW_UNSPECIFIED", "BASIC_HOLD", "FULL_HOLD" ] } }, "path": "v1/matters/{matterId}/holds" }, "addHeldAccounts": { "parameterOrder": [ "matterId", "holdId" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "description": "Adds accounts to a hold. Returns a list of accounts that have been successfully added. Accounts can be added only to an existing account-based hold.", "id": "vault.matters.holds.addHeldAccounts", "request": { "$ref": "AddHeldAccountsRequest" }, "response": { "$ref": "AddHeldAccountsResponse" }, "path": "v1/matters/{matterId}/holds/{holdId}:addHeldAccounts", "flatPath": "v1/matters/{matterId}/holds/{holdId}:addHeldAccounts", "parameters": { "matterId": { "type": "string", "required": true, "location": "path", "description": "The matter ID." }, "holdId": { "required": true, "location": "path", "type": "string", "description": "The hold ID." } } }, "delete": { "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "flatPath": "v1/matters/{matterId}/holds/{holdId}", "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "description": "Removes the specified hold and releases the accounts or organizational unit covered by the hold. If the data is not preserved by another hold or retention rule, it might be purged.", "parameters": { "matterId": { "required": true, "type": "string", "description": "The matter ID.", "location": "path" }, "holdId": { "location": "path", "description": "The hold ID.", "type": "string", "required": true } }, "path": "v1/matters/{matterId}/holds/{holdId}", "parameterOrder": [ "matterId", "holdId" ], "id": "vault.matters.holds.delete" }, "removeHeldAccounts": { "id": "vault.matters.holds.removeHeldAccounts", "description": "Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.", "flatPath": "v1/matters/{matterId}/holds/{holdId}:removeHeldAccounts", "response": { "$ref": "RemoveHeldAccountsResponse" }, "httpMethod": "POST", "parameterOrder": [ "matterId", "holdId" ], "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "parameters": { "matterId": { "type": "string", "required": true, "location": "path", "description": "The matter ID." }, "holdId": { "location": "path", "type": "string", "required": true, "description": "The hold ID." } }, "request": { "$ref": "RemoveHeldAccountsRequest" }, "path": "v1/matters/{matterId}/holds/{holdId}:removeHeldAccounts" }, "get": { "path": "v1/matters/{matterId}/holds/{holdId}", "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "id": "vault.matters.holds.get", "parameters": { "view": { "type": "string", "description": "The amount of detail to return for a hold.", "location": "query", "enum": [ "HOLD_VIEW_UNSPECIFIED", "BASIC_HOLD", "FULL_HOLD" ], "enumDescriptions": [ "Not specified. Defaults to **FULL_HOLD**.", "Returns the hold ID, name, update time, service, and query.", "Returns all details of **BASIC_HOLD** and the entities the hold applies to, such as accounts or organizational unit." ] }, "holdId": { "description": "The hold ID.", "location": "path", "type": "string", "required": true }, "matterId": { "description": "The matter ID.", "location": "path", "type": "string", "required": true } }, "description": "Gets the specified hold.", "response": { "$ref": "Hold" }, "parameterOrder": [ "matterId", "holdId" ], "httpMethod": "GET", "flatPath": "v1/matters/{matterId}/holds/{holdId}" }, "create": { "parameters": { "matterId": { "location": "path", "description": "The matter ID.", "type": "string", "required": true } }, "description": "Creates a hold in the specified matter.", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "parameterOrder": [ "matterId" ], "request": { "$ref": "Hold" }, "httpMethod": "POST", "id": "vault.matters.holds.create", "flatPath": "v1/matters/{matterId}/holds", "response": { "$ref": "Hold" }, "path": "v1/matters/{matterId}/holds" }, "update": { "parameters": { "matterId": { "location": "path", "type": "string", "required": true, "description": "The matter ID." }, "holdId": { "location": "path", "type": "string", "description": "The ID of the hold.", "required": true } }, "flatPath": "v1/matters/{matterId}/holds/{holdId}", "id": "vault.matters.holds.update", "description": "Updates the scope (organizational unit or accounts) and query parameters of a hold. You cannot add accounts to a hold that covers an organizational unit, nor can you add organizational units to a hold that covers individual accounts. If you try, the unsupported values are ignored.", "response": { "$ref": "Hold" }, "request": { "$ref": "Hold" }, "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "parameterOrder": [ "matterId", "holdId" ], "path": "v1/matters/{matterId}/holds/{holdId}", "httpMethod": "PUT" } }, "resources": { "accounts": { "methods": { "delete": { "response": { "$ref": "Empty" }, "parameterOrder": [ "matterId", "holdId", "accountId" ], "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}", "httpMethod": "DELETE", "description": "Removes an account from a hold.", "id": "vault.matters.holds.accounts.delete", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "path": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}", "parameters": { "accountId": { "location": "path", "description": "The ID of the account to remove from the hold.", "type": "string", "required": true }, "holdId": { "required": true, "location": "path", "description": "The hold ID.", "type": "string" }, "matterId": { "description": "The matter ID.", "type": "string", "required": true, "location": "path" } } }, "create": { "request": { "$ref": "HeldAccount" }, "response": { "$ref": "HeldAccount" }, "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts", "id": "vault.matters.holds.accounts.create", "parameters": { "holdId": { "location": "path", "type": "string", "description": "The hold ID.", "required": true }, "matterId": { "location": "path", "type": "string", "description": "The matter ID.", "required": true } }, "description": "Adds an account to a hold. Accounts can be added only to a hold that does not have an organizational unit set. If you try to add an account to an organizational unit-based hold, an error is returned.", "path": "v1/matters/{matterId}/holds/{holdId}/accounts", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "httpMethod": "POST", "parameterOrder": [ "matterId", "holdId" ] }, "list": { "parameters": { "holdId": { "required": true, "type": "string", "location": "path", "description": "The hold ID." }, "matterId": { "description": "The matter ID.", "required": true, "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts", "parameterOrder": [ "matterId", "holdId" ], "description": "Lists the accounts covered by a hold. This can list only individually-specified accounts covered by the hold. If the hold covers an organizational unit, use the [Admin SDK](https://developers.google.com/admin-sdk/). to list the members of the organizational unit on hold.", "response": { "$ref": "ListHeldAccountsResponse" }, "path": "v1/matters/{matterId}/holds/{holdId}/accounts", "id": "vault.matters.holds.accounts.list", "httpMethod": "GET" } } } } }, "exports": { "methods": { "delete": { "id": "vault.matters.exports.delete", "flatPath": "v1/matters/{matterId}/exports/{exportId}", "httpMethod": "DELETE", "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "path": "v1/matters/{matterId}/exports/{exportId}", "description": "Deletes an export.", "parameterOrder": [ "matterId", "exportId" ], "parameters": { "matterId": { "type": "string", "description": "The matter ID.", "location": "path", "required": true }, "exportId": { "required": true, "description": "The export ID.", "type": "string", "location": "path" } } }, "list": { "parameterOrder": [ "matterId" ], "id": "vault.matters.exports.list", "path": "v1/matters/{matterId}/exports", "flatPath": "v1/matters/{matterId}/exports", "parameters": { "pageToken": { "type": "string", "description": "The pagination token as returned in the response.", "location": "query" }, "matterId": { "location": "path", "description": "The matter ID.", "type": "string", "required": true }, "pageSize": { "type": "integer", "description": "The number of exports to return in the response.", "format": "int32", "location": "query" } }, "response": { "$ref": "ListExportsResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "description": "Lists details about the exports in the specified matter." }, "get": { "scopes": [ "https://www.googleapis.com/auth/ediscovery", "https://www.googleapis.com/auth/ediscovery.readonly" ], "parameters": { "matterId": { "type": "string", "location": "path", "required": true, "description": "The matter ID." }, "exportId": { "required": true, "type": "string", "description": "The export ID.", "location": "path" } }, "description": "Gets an export.", "path": "v1/matters/{matterId}/exports/{exportId}", "response": { "$ref": "Export" }, "id": "vault.matters.exports.get", "parameterOrder": [ "matterId", "exportId" ], "flatPath": "v1/matters/{matterId}/exports/{exportId}", "httpMethod": "GET" }, "create": { "path": "v1/matters/{matterId}/exports", "scopes": [ "https://www.googleapis.com/auth/ediscovery" ], "httpMethod": "POST", "id": "vault.matters.exports.create", "parameters": { "matterId": { "type": "string", "required": true, "location": "path", "description": "The matter ID." } }, "response": { "$ref": "Export" }, "parameterOrder": [ "matterId" ], "description": "Creates an export.", "flatPath": "v1/matters/{matterId}/exports", "request": { "$ref": "Export" } } } } } } }, "title": "Google Vault API", "baseUrl": "https://vault.googleapis.com/", "rootUrl": "https://vault.googleapis.com/", "ownerName": "Google", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "ownerDomain": "google.com", "version_module": true, "kind": "discovery#restDescription", "name": "vault", "discoveryVersion": "v1", "canonicalName": "Vault", "description": "Retention and eDiscovery for Google Workspace. 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. For example, to download an export, an account needs the **Manage Exports** privilege and the matter shared with them. ", "revision": "20261006", "fullyEncodeReservedExpansion": true, "schemas": { "ListHeldAccountsResponse": { "id": "ListHeldAccountsResponse", "properties": { "accounts": { "type": "array", "items": { "$ref": "HeldAccount" }, "description": "The held accounts on a hold." } }, "description": "Returns a list of the accounts covered by a hold.", "type": "object" }, "RemoveHeldAccountsRequest": { "id": "RemoveHeldAccountsRequest", "properties": { "accountIds": { "type": "array", "description": "The account IDs of the accounts to remove from the hold.", "items": { "type": "string" } } }, "description": "Remove a list of accounts from a hold.", "type": "object" }, "AddMatterPermissionsRequest": { "description": "Add an account with the permission specified. The role cannot be owner. If an account already has a role in the matter, the existing role is overwritten.", "id": "AddMatterPermissionsRequest", "type": "object", "properties": { "sendEmails": { "type": "boolean", "description": "To send a notification email to the added account, set to **true**. To not send a notification email, set to **false**." }, "matterPermission": { "description": "The account and its role to add.", "$ref": "MatterPermission" }, "ccMe": { "description": "Only relevant if **sendEmails** is **true**. To CC the requestor in the email message, set to **true**. To not CC requestor, set to **false**.", "type": "boolean" } } }, "HeldMailQuery": { "id": "HeldMailQuery", "type": "object", "description": "Query options for Gmail holds.", "properties": { "terms": { "description": "The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.", "type": "string" }, "startTime": { "type": "string", "description": "The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.", "format": "google-datetime" }, "endTime": { "description": "The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.", "format": "google-datetime", "type": "string" } } }, "AccountInfo": { "id": "AccountInfo", "description": "The accounts to search", "type": "object", "properties": { "emails": { "items": { "type": "string" }, "type": "array", "description": "A set of accounts to search." } } }, "OrgUnitInfo": { "type": "object", "id": "OrgUnitInfo", "description": "The organizational unit to search", "properties": { "orgUnitId": { "type": "string", "description": "The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/)." } } }, "GroupsExportOptions": { "type": "object", "id": "GroupsExportOptions", "properties": { "exportFormat": { "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", "ICS", "XML", "JSON" ], "description": "The file format for exported messages.", "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", "Export as ICS. Only available for Calendar.", "Export as XML. Only available for Gemini.", "Export as JSON. Only available for Gemini in Workpace." ], "type": "string" } }, "description": "Options for Groups exports." }, "CancelOperationRequest": { "type": "object", "properties": {}, "id": "CancelOperationRequest", "description": "The request message for Operations.CancelOperation." }, "HangoutsChatExportOptions": { "description": "Options for Chat exports.", "type": "object", "id": "HangoutsChatExportOptions", "properties": { "exportFormat": { "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", "Export as ICS. Only available for Calendar.", "Export as XML. Only available for Gemini.", "Export as JSON. Only available for Gemini in Workpace." ], "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", "ICS", "XML", "JSON" ], "description": "The file format for exported messages.", "type": "string" } } }, "AccountCount": { "properties": { "count": { "type": "string", "description": "The number of results (messages or files) found for this account.", "format": "int64" }, "account": { "$ref": "UserInfo", "description": "Account owner." } }, "description": "The results count for each account.", "id": "AccountCount", "type": "object" }, "GeminiExportOptions": { "properties": { "exportFormat": { "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", "Export as ICS. Only available for Calendar.", "Export as XML. Only available for Gemini.", "Export as JSON. Only available for Gemini in Workpace." ], "description": "The file format for exported messages.", "type": "string", "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", "ICS", "XML", "JSON" ] } }, "description": "The options for Gemini exports.", "type": "object", "id": "GeminiExportOptions" }, "CountArtifactsMetadata": { "description": "Long running operation metadata for CountArtifacts.", "type": "object", "properties": { "query": { "$ref": "Query", "description": "The search query from the request." }, "endTime": { "format": "google-datetime", "description": "End time of count operation. Available when operation is done.", "type": "string" }, "startTime": { "type": "string", "format": "google-datetime", "description": "Creation time of count operation." }, "matterId": { "type": "string", "description": "The matter ID of the associated matter." } }, "id": "CountArtifactsMetadata" }, "SharedDriveInfo": { "type": "object", "id": "SharedDriveInfo", "properties": { "sharedDriveIds": { "type": "array", "description": "A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).", "items": { "type": "string" } } }, "description": "The shared drives to search" }, "MailOptions": { "id": "MailOptions", "properties": { "clientSideEncryptedOption": { "enumDescriptions": [ "Encryption status unspecified. Results include both client-side encrypted and non-encrypted content.", "Include both client-side encrypted and unencrypted content in results.", "Include client-side encrypted content only.", "Include unencrypted content only." ], "enum": [ "CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED", "CLIENT_SIDE_ENCRYPTED_OPTION_ANY", "CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED", "CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED" ], "description": "Specifies whether the results should include encrypted content, unencrypted content, or both. Defaults to including both.", "type": "string" }, "excludeDrafts": { "description": "Set to **true** to exclude drafts.", "type": "boolean" } }, "description": "Additional options for Gmail search", "type": "object" }, "Empty": { "description": "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); }", "properties": {}, "type": "object", "id": "Empty" }, "GeminiOptions": { "properties": {}, "id": "GeminiOptions", "type": "object", "description": "Additional options for Gemini search" }, "HeldVoiceQuery": { "id": "HeldVoiceQuery", "properties": { "coveredData": { "items": { "enum": [ "COVERED_DATA_UNSPECIFIED", "TEXT_MESSAGES", "VOICEMAILS", "CALL_LOGS" ], "type": "string", "enumDescriptions": [ "Covered data unspecified.", "Voice text messages.", "Voicemails and their transcripts.", "Call logs." ] }, "description": "A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.", "type": "array" } }, "type": "object", "description": "Options for Voice holds." }, "Status": { "type": "object", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", "properties": { "code": { "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer" }, "message": { "type": "string", "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." }, "details": { "type": "array", "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" } } } }, "ListExportsResponse": { "id": "ListExportsResponse", "type": "object", "properties": { "exports": { "description": "The list of exports.", "type": "array", "items": { "$ref": "Export" } }, "nextPageToken": { "description": "Page token to retrieve the next page of results in the list.", "type": "string" } }, "description": "The exports for a matter." }, "ListSavedQueriesResponse": { "type": "object", "description": "Definition of the response for method ListSaveQuery.", "id": "ListSavedQueriesResponse", "properties": { "savedQueries": { "items": { "$ref": "SavedQuery" }, "description": "List of saved queries.", "type": "array" }, "nextPageToken": { "description": "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.", "type": "string" } } }, "MailExportOptions": { "properties": { "useNewExport": { "type": "boolean", "description": "To use the new export system, set to **true**." }, "exportLinkedDriveFiles": { "type": "boolean", "description": "Optional. To enable exporting linked Drive files, set to **true**." }, "showConfidentialModeContent": { "type": "boolean", "description": "To export confidential mode content, set to **true**." }, "exportFormat": { "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", "Export as ICS. Only available for Calendar.", "Export as XML. Only available for Gemini.", "Export as JSON. Only available for Gemini in Workpace." ], "type": "string", "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", "ICS", "XML", "JSON" ], "description": "The file format for exported messages." } }, "type": "object", "id": "MailExportOptions", "description": "Options for Gmail exports." }, "VoiceOptions": { "type": "object", "description": "Additional options for Voice search", "id": "VoiceOptions", "properties": { "coveredData": { "description": "Datatypes to search", "items": { "enumDescriptions": [ "Covered data unspecified.", "Voice text messages.", "Voicemails and their transcripts.", "Call logs." ], "type": "string", "enum": [ "COVERED_DATA_UNSPECIFIED", "TEXT_MESSAGES", "VOICEMAILS", "CALL_LOGS" ] }, "type": "array" } } }, "Export": { "id": "Export", "properties": { "stats": { "description": "Output only. Details about the export progress and size.", "$ref": "ExportStats" }, "name": { "type": "string", "description": "The export name. Don't use special characters (~!$'(),;@:/?) in the name, they can prevent you from downloading exports." }, "createTime": { "type": "string", "description": "Output only. The time when the export was created.", "format": "google-datetime" }, "exportOptions": { "$ref": "ExportOptions", "description": "Additional export options." }, "query": { "description": "The query parameters used to create the export.", "$ref": "Query" }, "id": { "description": "Output only. The generated export ID.", "type": "string" }, "cloudStorageSink": { "$ref": "CloudStorageSink", "description": "Output only. The sink for export files in Cloud Storage." }, "requester": { "$ref": "UserInfo", "description": "Output only. The requester of the export." }, "status": { "description": "Output only. The status of the export.", "type": "string", "enum": [ "EXPORT_STATUS_UNSPECIFIED", "COMPLETED", "FAILED", "IN_PROGRESS" ], "enumDescriptions": [ "The status is unspecified.", "The export completed.", "The export failed.", "The export is in progress." ] }, "parentExportId": { "readOnly": true, "description": "Output only. Identifies the parent export that spawned this child export. This is only set on child exports.", "type": "string" }, "matterId": { "description": "Output only. The matter ID.", "type": "string" } }, "description": "An export. 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.", "type": "object" }, "CloseMatterRequest": { "description": "Close a matter by ID.", "properties": {}, "id": "CloseMatterRequest", "type": "object" }, "SavedQuery": { "id": "SavedQuery", "type": "object", "description": "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.", "properties": { "displayName": { "description": "The name of the saved query.", "type": "string" }, "matterId": { "description": "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.", "type": "string" }, "savedQueryId": { "description": "A unique identifier for the saved query.", "type": "string" }, "query": { "$ref": "Query", "description": "The search parameters of the saved query." }, "createTime": { "format": "google-datetime", "type": "string", "description": "Output only. The server-generated timestamp when the saved query was created." } } }, "MatterPermission": { "description": "Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.", "properties": { "role": { "description": "The user's role for the matter.", "enum": [ "ROLE_UNSPECIFIED", "COLLABORATOR", "OWNER" ], "type": "string", "enumDescriptions": [ "No role assigned.", "A collaborator on the matter.", "The owner of the matter." ] }, "accountId": { "type": "string", "description": "The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/)." } }, "id": "MatterPermission", "type": "object" }, "ExportStats": { "type": "object", "description": "Progress information for an export.", "properties": { "totalArtifactCount": { "type": "string", "description": "The number of messages or files to be exported.", "format": "int64" }, "sizeInBytes": { "description": "The size of export in bytes.", "type": "string", "format": "int64" }, "exportedArtifactCount": { "description": "The number of messages or files already processed for export.", "format": "int64", "type": "string" } }, "id": "ExportStats" }, "DriveDocumentInfo": { "description": "The Drive documents to search.", "type": "object", "properties": { "documentIds": { "description": "Specify Drive documents by document ID.", "$ref": "DriveDocumentIds" } }, "id": "DriveDocumentInfo" }, "CloudStorageSink": { "type": "object", "description": "Export sink for Cloud Storage files.", "properties": { "files": { "items": { "$ref": "CloudStorageFile" }, "type": "array", "description": "Output only. The exported files in Cloud Storage." } }, "id": "CloudStorageSink" }, "GroupsCountResult": { "id": "GroupsCountResult", "description": "Groups specific count metrics.", "type": "object", "properties": { "accountCountErrors": { "items": { "$ref": "AccountCountError" }, "description": "Error occurred when querying these accounts.", "type": "array" }, "accountCounts": { "type": "array", "items": { "$ref": "AccountCount" }, "description": "Subtotal count per matching account that have more than zero messages." }, "queriedAccountsCount": { "type": "string", "description": "Total number of accounts involved in this count operation.", "format": "int64" }, "nonQueryableAccounts": { "description": "When **DataScope** is **HELD_DATA**, these accounts in the request are not queried because they are not on hold. For other data scope, this field is not set.", "items": { "type": "string" }, "type": "array" }, "matchingAccountsCount": { "description": "Total number of accounts that can be queried and have more than zero messages.", "type": "string", "format": "int64" } } }, "AddHeldAccountsRequest": { "type": "object", "id": "AddHeldAccountsRequest", "properties": { "emails": { "items": { "type": "string" }, "description": "A comma-separated list of the emails of the accounts to add to the hold. Specify either **emails** or **account_ids**, but not both.", "type": "array" }, "accountIds": { "type": "array", "description": "A comma-separated list of the account IDs of the accounts to add to the hold. Specify either **emails** or **account_ids**, but not both.", "items": { "type": "string" } } }, "description": "Add a list of accounts to a hold." }, "VoiceExportOptions": { "properties": { "exportFormat": { "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", "ICS", "XML", "JSON" ], "type": "string", "description": "The file format for exported text messages.", "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", "Export as ICS. Only available for Calendar.", "Export as XML. Only available for Gemini.", "Export as JSON. Only available for Gemini in Workpace." ] } }, "type": "object", "id": "VoiceExportOptions", "description": "The options for Voice exports." }, "Hold": { "type": "object", "properties": { "orgUnit": { "description": "If set, the hold applies to all members of the organizational unit and **accounts** must be empty. This property is mutable. For Groups holds, set **accounts**.", "$ref": "HeldOrgUnit" }, "name": { "type": "string", "description": "The name of the hold." }, "holdId": { "type": "string", "description": "The unique immutable ID of the hold. Assigned during creation." }, "accounts": { "type": "array", "description": "If set, the hold applies to the specified accounts and **orgUnit** must be empty.", "items": { "$ref": "HeldAccount" } }, "query": { "$ref": "CorpusQuery", "description": "Service-specific options. If set, **CorpusQuery** must match **CorpusType**." }, "corpus": { "type": "string", "enumDescriptions": [ "No service specified.", "Drive, including Meet and Sites.", "For search, Gmail and classic Hangouts. For holds, Gmail only.", "Groups.", "For export, Google Chat only. For holds, Google Chat and classic Hangouts.", "Google Voice.", "Calendar.", "Gemini." ], "description": "The service to be searched.", "enum": [ "CORPUS_TYPE_UNSPECIFIED", "DRIVE", "MAIL", "GROUPS", "HANGOUTS_CHAT", "VOICE", "CALENDAR", "GEMINI" ] }, "updateTime": { "description": "The last time this hold was modified.", "format": "google-datetime", "type": "string" } }, "id": "Hold", "description": "A hold. A hold prevents the specified Google Workspace service from purging data for specific accounts or all members of an organizational unit. 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." }, "DriveOptions": { "description": "Additional options for Drive search.", "properties": { "versionDate": { "description": "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.", "type": "string", "format": "google-datetime" }, "includeSharedDrives": { "type": "boolean", "description": "Set to **true** to include shared drives.", "deprecated": true }, "includeTeamDrives": { "description": "Set to true to include Team Drive.", "deprecated": true, "type": "boolean" }, "sharedDrivesOption": { "enum": [ "SHARED_DRIVES_OPTION_UNSPECIFIED", "NOT_INCLUDED", "INCLUDED_IF_ACCOUNT_IS_NOT_A_MEMBER", "INCLUDED" ], "enumDescriptions": [ "No shared drive option specified.", "If a resource is in a shared drive, it isn't included in the search.", "Shared drive resources are only included in instances where the account is a collaborator on a resource but they are not a member of the shared drive. This maps to the *\"Included only if documents shared directly (not due to shared drive membership)\"* option in the Vault UI. (Previously \"include_shared_drives\" off)", "Resources in shared drives are included in the search. (Previously \"include_shared_drives\" on)" ], "description": "Optional. Options to include or exclude documents in shared drives. We recommend using this field over include_shared_drives. This field overrides include_shared_drives and include_team_drives when set.", "type": "string" }, "clientSideEncryptedOption": { "enumDescriptions": [ "Encryption status unspecified. Results include both client-side encrypted and non-encrypted content.", "Include both client-side encrypted and unencrypted content in results.", "Include client-side encrypted content only.", "Include unencrypted content only." ], "type": "string", "description": "Set whether the results include only content encrypted with [Google Workspace Client-side encryption](https://support.google.com/a?p=cse_ov) content, only unencrypted content, or both. Defaults to both. Currently supported for Drive.", "enum": [ "CLIENT_SIDE_ENCRYPTED_OPTION_UNSPECIFIED", "CLIENT_SIDE_ENCRYPTED_OPTION_ANY", "CLIENT_SIDE_ENCRYPTED_OPTION_ENCRYPTED", "CLIENT_SIDE_ENCRYPTED_OPTION_UNENCRYPTED" ] } }, "id": "DriveOptions", "type": "object" }, "ListHoldsResponse": { "properties": { "holds": { "type": "array", "description": "The list of holds.", "items": { "$ref": "Hold" } }, "nextPageToken": { "description": "Page token to retrieve the next page of results in the list. If this is empty, then there are no more holds to list.", "type": "string" } }, "id": "ListHoldsResponse", "description": "The holds for a matter.", "type": "object" }, "MailCountResult": { "type": "object", "description": "Gmail and classic Hangouts-specific count metrics.", "id": "MailCountResult", "properties": { "nonQueryableAccounts": { "description": "When **DataScope** is **HELD_DATA** and when account emails are passed in explicitly, the list of accounts in the request that are not queried because they are not on hold in the matter. For other data scopes, this field is not set.", "type": "array", "items": { "type": "string" } }, "accountCounts": { "type": "array", "items": { "$ref": "AccountCount" }, "description": "Subtotal count per matching account that have more than zero messages." }, "queriedAccountsCount": { "format": "int64", "description": "Total number of accounts involved in this count operation.", "type": "string" }, "matchingAccountsCount": { "format": "int64", "type": "string", "description": "Total number of accounts that can be queried and have more than zero messages." }, "accountCountErrors": { "description": "Errors occurred when querying these accounts.", "type": "array", "items": { "$ref": "AccountCountError" } } } }, "Operation": { "type": "object", "id": "Operation", "properties": { "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "error": { "$ref": "Status", "description": "The error result of the operation in case of failure or cancellation." }, "response": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" }, "done": { "type": "boolean", "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available." }, "metadata": { "type": "object", "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } } }, "description": "This resource represents a long-running operation that is the result of a network API call." }, "DriveDocumentIds": { "type": "object", "description": "Specify Drive documents by document ID.", "properties": { "ids": { "description": "Required. A list of Drive document IDs.", "type": "array", "items": { "type": "string" } } }, "id": "DriveDocumentIds" }, "HeldAccount": { "type": "object", "id": "HeldAccount", "properties": { "holdTime": { "format": "google-datetime", "type": "string", "description": "Output only. When the account was put on hold." }, "lastName": { "description": "Output only. The last name of the account holder.", "type": "string" }, "firstName": { "type": "string", "description": "Output only. The first name of the account holder." }, "email": { "type": "string", "description": "The primary email address of the account. If used as an input, this takes precedence over **accountId**." }, "accountId": { "description": "The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).", "type": "string" } }, "description": "An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. 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." }, "HeldCalendarQuery": { "description": "Options for Calendar holds.", "id": "HeldCalendarQuery", "properties": {}, "type": "object" }, "CalendarExportOptions": { "properties": { "exportFormat": { "type": "string", "description": "The file format for exported text messages.", "enumDescriptions": [ "No export format specified.", "Export as MBOX. Only available for Gmail, Groups, Hangouts and Voice.", "Export as PST. Only available for Gmail, Groups, Hangouts, Voice and Calendar.", "Export as ICS. Only available for Calendar.", "Export as XML. Only available for Gemini.", "Export as JSON. Only available for Gemini in Workpace." ], "enum": [ "EXPORT_FORMAT_UNSPECIFIED", "MBOX", "PST", "ICS", "XML", "JSON" ] } }, "type": "object", "id": "CalendarExportOptions", "description": "The options for Calendar exports." }, "SitesUrlInfo": { "properties": { "urls": { "type": "array", "description": "A list of published site URLs.", "items": { "type": "string" } } }, "type": "object", "description": "The published site URLs of new Google Sites to search", "id": "SitesUrlInfo" }, "HeldHangoutsChatQuery": { "properties": { "includeRooms": { "type": "boolean", "description": "To include messages in Chat spaces the user was a member of, set to **true**." } }, "type": "object", "id": "HeldHangoutsChatQuery", "description": "Options for Chat holds." }, "HeldDriveQuery": { "properties": { "includeSharedDriveFiles": { "description": "To include files in shared drives in the hold, set to **true**.", "type": "boolean" }, "includeTeamDriveFiles": { "description": "To include files in Team Drives in the hold, set to **true**.", "deprecated": true, "type": "boolean" } }, "id": "HeldDriveQuery", "description": "Options for Drive holds.", "type": "object" }, "CountArtifactsRequest": { "id": "CountArtifactsRequest", "properties": { "view": { "description": "Sets the granularity of the count results.", "enumDescriptions": [ "Default. Same as **TOTAL_COUNT**.", "Response includes counts of the total accounts, queried accounts, matching accounts, non-queryable accounts, and queried account errors.", "Response includes the same details as **TOTAL_COUNT**, plus additional account breakdown." ], "type": "string", "enum": [ "COUNT_RESULT_VIEW_UNSPECIFIED", "TOTAL_COUNT", "ALL" ] }, "query": { "$ref": "Query", "description": "The search query." } }, "description": "Count artifacts request.", "type": "object" }, "HangoutsChatInfo": { "id": "HangoutsChatInfo", "description": "The Chat spaces to search", "properties": { "roomId": { "items": { "type": "string" }, "type": "array", "description": "A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/workspace/chat). There is a limit of exporting from 500 Chat spaces per request." } }, "type": "object" }, "CorpusQuery": { "properties": { "voiceQuery": { "description": "Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**.", "$ref": "HeldVoiceQuery" }, "hangoutsChatQuery": { "$ref": "HeldHangoutsChatQuery", "description": "Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**." }, "geminiQuery": { "$ref": "HeldGeminiQuery", "description": "Service-specific options for Gemini holds. If set, **CorpusType** must be **GEMINI**." }, "groupsQuery": { "$ref": "HeldGroupsQuery", "description": "Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**." }, "calendarQuery": { "$ref": "HeldCalendarQuery", "description": "Service-specific options for Calendar holds. If set, **CorpusType** must be **CALENDAR**." }, "mailQuery": { "description": "Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**.", "$ref": "HeldMailQuery" }, "driveQuery": { "$ref": "HeldDriveQuery", "description": "Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**." } }, "description": "Service-specific options for holds.", "id": "CorpusQuery", "type": "object" }, "Matter": { "description": "Represents a matter. 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.", "id": "Matter", "type": "object", "properties": { "description": { "description": "An optional description for the matter.", "type": "string" }, "state": { "enumDescriptions": [ "The matter has no specified state.", "The matter is open.", "The matter is closed.", "The matter is deleted." ], "enum": [ "STATE_UNSPECIFIED", "OPEN", "CLOSED", "DELETED" ], "description": "The state of the matter.", "type": "string" }, "matterPermissions": { "description": "Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.", "type": "array", "items": { "$ref": "MatterPermission" } }, "matterId": { "type": "string", "description": "The matter ID, which is generated by the server. Leave blank when creating a matter." }, "matterRegion": { "enumDescriptions": [ "The region is unspecified. Defaults to ANY.", "Any region.", "United States region.", "Europe region." ], "enum": [ "MATTER_REGION_UNSPECIFIED", "ANY", "US", "EUROPE" ], "description": "Optional. The requested data region for the matter.", "type": "string" }, "name": { "type": "string", "description": "The name of the matter." } } }, "HeldOrgUnit": { "id": "HeldOrgUnit", "description": "The organizational unit covered by a hold. This structure is immutable.", "properties": { "holdTime": { "format": "google-datetime", "description": "When the organizational unit was put on hold. This property is immutable.", "type": "string" }, "orgUnitId": { "type": "string", "description": "The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/)." } }, "type": "object" }, "AddHeldAccountsResponse": { "id": "AddHeldAccountsResponse", "type": "object", "properties": { "responses": { "type": "array", "description": "The list of responses, in the same order as the batch request.", "items": { "$ref": "AddHeldAccountResult" } } }, "description": "Response for batch create held accounts." }, "ReopenMatterResponse": { "properties": { "matter": { "description": "The updated matter, with state **OPEN**.", "$ref": "Matter" } }, "type": "object", "id": "ReopenMatterResponse", "description": "Response to a ReopenMatterRequest." }, "CountArtifactsResponse": { "description": "Definition of the response for method CountArtifacts.", "id": "CountArtifactsResponse", "type": "object", "properties": { "totalCount": { "format": "int64", "description": "Total count of messages.", "type": "string" }, "mailCountResult": { "description": "Count metrics for Gmail and classic Hangouts.", "$ref": "MailCountResult" }, "groupsCountResult": { "$ref": "GroupsCountResult", "description": "Count metrics for Groups." } } }, "ListOperationsResponse": { "type": "object", "description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "operations": { "items": { "$ref": "Operation" }, "type": "array", "description": "A list of operations that matches the specified filter in the request." }, "unreachable": { "type": "array", "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" } } } }, "UserInfo": { "id": "UserInfo", "type": "object", "description": "User's information.", "properties": { "email": { "description": "The email address of the user.", "type": "string" }, "displayName": { "type": "string", "description": "The displayed name of the user." } } }, "Query": { "id": "Query", "type": "object", "properties": { "corpus": { "description": "The Google Workspace service to search.", "type": "string", "enumDescriptions": [ "No service specified.", "Drive, including Meet and Sites.", "For search, Gmail and classic Hangouts. For holds, Gmail only.", "Groups.", "For export, Google Chat only. For holds, Google Chat and classic Hangouts.", "Google Voice.", "Calendar.", "Gemini." ], "enum": [ "CORPUS_TYPE_UNSPECIFIED", "DRIVE", "MAIL", "GROUPS", "HANGOUTS_CHAT", "VOICE", "CALENDAR", "GEMINI" ] }, "dataScope": { "description": "The data source to search.", "type": "string", "enumDescriptions": [ "No data source specified.", "All available data.", "Only data on hold.", "Only data not yet processed by Vault. (Gmail and Groups only)" ], "enum": [ "DATA_SCOPE_UNSPECIFIED", "ALL_DATA", "HELD_DATA", "UNPROCESSED_DATA" ] }, "hangoutsChatOptions": { "description": "Set Chat search-specific options. (read-only)", "$ref": "HangoutsChatOptions" }, "driveDocumentInfo": { "description": "Required when **SearchMethod** is **DRIVE_DOCUMENT**.", "$ref": "DriveDocumentInfo" }, "geminiOptions": { "$ref": "GeminiOptions", "description": "Set Gemini search-specific options." }, "driveOptions": { "description": "Set Drive search-specific options.", "$ref": "DriveOptions" }, "hangoutsChatInfo": { "$ref": "HangoutsChatInfo", "description": "Required when **SearchMethod** is **ROOM**. (read-only)" }, "voiceOptions": { "description": "Set Voice search-specific options.", "$ref": "VoiceOptions" }, "teamDriveInfo": { "deprecated": true, "$ref": "TeamDriveInfo", "description": "Required when **SearchMethod** is **TEAM_DRIVE**." }, "timeZone": { "description": "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).", "type": "string" }, "method": { "description": "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**.", "enumDescriptions": [ "A search method must be specified or else it is rejected.", "Search the data of the accounts specified in [AccountInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#accountinfo).", "Search the data of all accounts in the organizational unit specified in [OrgUnitInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#orgunitinfo).", "Search the data in the Team Drive specified in **team_drive_info**.", "Search the data of all accounts in the organization. Supported only for Gmail. When specified, you don't need to specify **AccountInfo** or **OrgUnitInfo**.", "Search messages in the Chat spaces specified in [HangoutsChatInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#hangoutschatinfo).", "Search for sites by the published site URLs specified in [SitesUrlInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#sitesurlinfo).", "Search the files in the shared drives specified in [SharedDriveInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#shareddriveinfo).", "Retrieve the documents specified in DriveDocumentInfo." ], "enum": [ "SEARCH_METHOD_UNSPECIFIED", "ACCOUNT", "ORG_UNIT", "TEAM_DRIVE", "ENTIRE_ORG", "ROOM", "SITES_URL", "SHARED_DRIVE", "DRIVE_DOCUMENT" ], "enumDeprecated": [ false, false, false, true, false, false, false, false, false ], "type": "string" }, "orgUnitInfo": { "description": "Required when **SearchMethod** is **ORG_UNIT**.", "$ref": "OrgUnitInfo" }, "calendarOptions": { "description": "Set Calendar search-specific options.", "$ref": "CalendarOptions" }, "terms": { "type": "string", "description": "Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results." }, "accountInfo": { "$ref": "AccountInfo", "description": "Required when **SearchMethod** is **ACCOUNT**." }, "searchMethod": { "enumDeprecated": [ false, false, false, true, false, false, false, false, false ], "deprecated": true, "enumDescriptions": [ "A search method must be specified or else it is rejected.", "Search the data of the accounts specified in [AccountInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#accountinfo).", "Search the data of all accounts in the organizational unit specified in [OrgUnitInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#orgunitinfo).", "Search the data in the Team Drive specified in **team_drive_info**.", "Search the data of all accounts in the organization. Supported only for Gmail. When specified, you don't need to specify **AccountInfo** or **OrgUnitInfo**.", "Search messages in the Chat spaces specified in [HangoutsChatInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#hangoutschatinfo).", "Search for sites by the published site URLs specified in [SitesUrlInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#sitesurlinfo).", "Search the files in the shared drives specified in [SharedDriveInfo](https://developers.google.com/workspace/vault/reference/rest/v1/Query#shareddriveinfo).", "Retrieve the documents specified in DriveDocumentInfo." ], "enum": [ "SEARCH_METHOD_UNSPECIFIED", "ACCOUNT", "ORG_UNIT", "TEAM_DRIVE", "ENTIRE_ORG", "ROOM", "SITES_URL", "SHARED_DRIVE", "DRIVE_DOCUMENT" ], "description": "The search method to use.", "type": "string" }, "startTime": { "type": "string", "format": "google-datetime", "description": "The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date." }, "mailOptions": { "$ref": "MailOptions", "description": "Set Gmail search-specific options." }, "endTime": { "description": "The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.", "format": "google-datetime", "type": "string" }, "sharedDriveInfo": { "description": "Required when **SearchMethod** is **SHARED_DRIVE**.", "$ref": "SharedDriveInfo" }, "sitesUrlInfo": { "$ref": "SitesUrlInfo", "description": "Required when **SearchMethod** is **SITES_URL**." } }, "description": "The query definition used for search and export." }, "RemoveMatterPermissionsRequest": { "type": "object", "description": "Remove an account as a matter collaborator.", "id": "RemoveMatterPermissionsRequest", "properties": { "accountId": { "type": "string", "description": "The account ID." } } }, "AccountCountError": { "type": "object", "properties": { "errorType": { "enum": [ "ERROR_TYPE_UNSPECIFIED", "WILDCARD_TOO_BROAD", "TOO_MANY_TERMS", "LOCATION_UNAVAILABLE", "UNKNOWN", "DEADLINE_EXCEEDED" ], "description": "Account query error.", "enumDescriptions": [ "Default.", "Permanent - prefix terms expanded to too many query terms.", "Permanent - query contains too many terms.", "Transient - data in transit between storage replicas, temporarily unavailable.", "Unrecognized error.", "Deadline exceeded when querying the account." ], "type": "string" }, "account": { "$ref": "UserInfo", "description": "Account owner." } }, "id": "AccountCountError", "description": "An error that occurred when querying a specific account" }, "AddHeldAccountResult": { "id": "AddHeldAccountResult", "description": "The status of each account creation, and the **HeldAccount**, if successful.", "type": "object", "properties": { "status": { "description": "Reports the request status. If it failed, returns an error message.", "$ref": "Status" }, "account": { "description": "Returned when the account was successfully created.", "$ref": "HeldAccount" } } }, "DriveExportOptions": { "id": "DriveExportOptions", "properties": { "includeAccessInfo": { "type": "boolean", "description": "To include access level information for users with [indirect access](https://support.google.com/vault/answer/6099459#metadata) to files, set to **true**." } }, "description": "Options for Drive exports.", "type": "object" }, "TeamDriveInfo": { "description": "Team Drives to search", "properties": { "teamDriveIds": { "type": "array", "deprecated": true, "description": "List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).", "items": { "type": "string" } } }, "id": "TeamDriveInfo", "deprecated": true, "type": "object" }, "CloudStorageFile": { "properties": { "size": { "description": "The export file size.", "format": "int64", "type": "string" }, "md5Hash": { "type": "string", "description": "The md5 hash of the file." }, "bucketName": { "description": "The name of the Cloud Storage bucket for the export file. You can use this value in the Cloud Storage [JSON API](https://cloud.google.com/storage/docs/json_api) or [XML API](https://cloud.google.com/storage/docs/xml-api), but not to list the bucket contents. Instead, you can [get individual export files](https://cloud.google.com/storage/docs/json_api/v1/objects/get) by object name.", "type": "string" }, "objectName": { "description": "The name of the Cloud Storage object for the export file. You can use this value in the Cloud Storage [JSON API](https://cloud.google.com/storage/docs/json_api) or [XML API](https://cloud.google.com/storage/docs/xml-api).", "type": "string" } }, "description": "The export file in Cloud Storage", "type": "object", "id": "CloudStorageFile" }, "ReopenMatterRequest": { "description": "Reopen a matter by ID.", "type": "object", "properties": {}, "id": "ReopenMatterRequest" }, "ListMattersResponse": { "id": "ListMattersResponse", "description": "Provides the list of matters.", "type": "object", "properties": { "matters": { "items": { "$ref": "Matter" }, "description": "List of matters.", "type": "array" }, "nextPageToken": { "description": "Page token to retrieve the next page of results in the list.", "type": "string" } } }, "HeldGroupsQuery": { "id": "HeldGroupsQuery", "description": "Query options for group holds.", "type": "object", "properties": { "startTime": { "type": "string", "format": "google-datetime", "description": "The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date." }, "terms": { "type": "string", "description": "The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold." }, "endTime": { "format": "google-datetime", "description": "The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.", "type": "string" } } }, "HeldGeminiQuery": { "description": "Options for Gemini holds.", "properties": {}, "type": "object", "id": "HeldGeminiQuery" }, "UndeleteMatterRequest": { "type": "object", "id": "UndeleteMatterRequest", "description": "Undelete a matter by ID.", "properties": {} }, "ExportOptions": { "description": "Additional options for exports", "properties": { "mailOptions": { "description": "Options for Gmail exports.", "$ref": "MailExportOptions" }, "groupsOptions": { "description": "Options for Groups exports.", "$ref": "GroupsExportOptions" }, "voiceOptions": { "description": "Options for Voice exports.", "$ref": "VoiceExportOptions" }, "calendarOptions": { "$ref": "CalendarExportOptions", "description": "Option available for Calendar export." }, "geminiOptions": { "$ref": "GeminiExportOptions", "description": "Option available for Gemini export." }, "region": { "type": "string", "description": "The requested data region for the export.", "enum": [ "EXPORT_REGION_UNSPECIFIED", "ANY", "US", "EUROPE" ], "enumDescriptions": [ "The region is unspecified. Defaults to ANY.", "Any region.", "United States region.", "Europe region." ] }, "hangoutsChatOptions": { "description": "Options for Chat exports.", "$ref": "HangoutsChatExportOptions" }, "driveOptions": { "description": "Options for Drive exports.", "$ref": "DriveExportOptions" } }, "id": "ExportOptions", "type": "object" }, "CalendarOptions": { "type": "object", "properties": { "locationQuery": { "description": "Matches only those events whose location contains all of the words in the given set. If the string contains quoted phrases, this method only matches those events whose location contain the exact phrase. Entries in the set are considered in \"and\". Word splitting example: [\"New Zealand\"] vs [\"New\",\"Zealand\"] \"New Zealand\": matched by both \"New and better Zealand\": only matched by the later", "type": "array", "items": { "type": "string" } }, "peopleQuery": { "type": "array", "description": "Matches only those events whose attendees contain all of the words in the given set. Entries in the set are considered in \"and\".", "items": { "type": "string" } }, "versionDate": { "format": "google-datetime", "description": "Search the current version of the Calendar event, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.", "type": "string" }, "responseStatuses": { "type": "array", "description": "Matches only events for which the custodian gave one of these responses. If the set is empty or contains ATTENDEE_RESPONSE_UNSPECIFIED there will be no filtering on responses.", "items": { "enumDescriptions": [ "Attendee response unspecified. If this is set no filtering on responses will be done, all other attendee responses that are part of the query options are ignored.", "The participant has been invited but has not responded yet.", "The participant plans to attend.", "The participant does not plan to attend.", "The participant expects to possibly attend." ], "enum": [ "ATTENDEE_RESPONSE_UNSPECIFIED", "ATTENDEE_RESPONSE_NEEDS_ACTION", "ATTENDEE_RESPONSE_ACCEPTED", "ATTENDEE_RESPONSE_DECLINED", "ATTENDEE_RESPONSE_TENTATIVE" ], "type": "string" } }, "minusWords": { "description": "Matches only those events that do not contain any of the words in the given set in title, description, location, or attendees. Entries in the set are considered in \"or\".", "items": { "type": "string" }, "type": "array" } }, "id": "CalendarOptions", "description": "Additional options for Calendar search" }, "CloseMatterResponse": { "type": "object", "description": "Response to a CloseMatterRequest.", "id": "CloseMatterResponse", "properties": { "matter": { "description": "The updated matter, with state **CLOSED**.", "$ref": "Matter" } } }, "HangoutsChatOptions": { "type": "object", "id": "HangoutsChatOptions", "properties": { "includeRooms": { "type": "boolean", "description": "For searches by account or organizational unit, set to **true** to include rooms." } }, "description": "Additional options for Google Chat search" }, "RemoveHeldAccountsResponse": { "properties": { "statuses": { "type": "array", "description": "A list of statuses for the deleted accounts. Results have the same order as the request.", "items": { "$ref": "Status" } } }, "description": "Response for batch delete held accounts.", "id": "RemoveHeldAccountsResponse", "type": "object" } }, "basePath": "", "version": "v1", "id": "vault:v1" }