Required. Full resource name of the location, such as projects/{project}/locations/{location}.
Request body
The request body contains data with the following structure:
JSON representation
{// Union field data_source can be only one of the following:"websiteDataSource": {object (WebsiteDataSource)},"fileDataSource": {object (FileDataSource)}// End of list of possible types for union field data_source.}
Fields
Union field data_source. Data source for which we are estimating its size. data_source can be only one of the following:
User provided URI pattern. For example, foo.com/bar/*.
exactMatch
boolean
Whether we infer the generated URI or use the exact provided one.
exclusive
boolean
Whether the pattern is exclusive or not. If set to true, the pattern is considered exclusive. If unset or set to false, the pattern is considered inclusive by default.
FileDataSource
Data source contains files either in Cloud Storage or BigQuery.
JSON representation
{// Union field source can be only one of the following:"gcsSource": {object (GcsSource)},"bigquerySource": {object (BigQuerySource)}// End of list of possible types for union field source.}
Fields
Union field source. Which source contains the files to be used. source can be only one of the following:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThis API endpoint estimates the data size for a customer, using the \u003ccode\u003ePOST\u003c/code\u003e method on the provided URL.\u003c/p\u003e\n"],["\u003cp\u003eThe request body allows for specifying the data source, which can be either \u003ccode\u003ewebsiteDataSource\u003c/code\u003e or \u003ccode\u003efileDataSource\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ewebsiteDataSource\u003c/code\u003e requires at least one URI pattern to crawl, and it allows up to 10 patterns.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003efileDataSource\u003c/code\u003e supports file inputs from either Cloud Storage or BigQuery.\u003c/p\u003e\n"],["\u003cp\u003eAccess to this endpoint requires the \u003ccode\u003ediscoveryengine.locations.estimateDataSize\u003c/code\u003e IAM permission and the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.estimateDataSize\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [WebsiteDataSource](#WebsiteDataSource)\n - [JSON representation](#WebsiteDataSource.SCHEMA_REPRESENTATION)\n- [EstimatorUriPattern](#EstimatorUriPattern)\n - [JSON representation](#EstimatorUriPattern.SCHEMA_REPRESENTATION)\n- [FileDataSource](#FileDataSource)\n - [JSON representation](#FileDataSource.SCHEMA_REPRESENTATION)\n\nEstimates the data size to be used by a customer.\n\n### HTTP request\n\n`POST https://discoveryengine.googleapis.com/v1alpha/{location=projects/*/locations/*}:estimateDataSize`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/generative-ai-app-builder/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `location` resource:\n\n- `discoveryengine.locations.estimateDataSize`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs).\n\nWebsiteDataSource\n-----------------\n\nData source is a set of website patterns that we crawl to get the total number of websites.\n\nEstimatorUriPattern\n-------------------\n\nURI patterns that we use to crawl.\n\nFileDataSource\n--------------\n\nData source contains files either in Cloud Storage or BigQuery."]]