Optional. Specific linked Ads Data Hub customer ID to use for validating ads data and temp table access. Defaults to all the linked customers. Deprecated. Use the adsDataCustomerId inside query_execution_spec.
Optional. Specific linked Ads Data Hub customer ID to use for validating match data and temp table access. Defaults to all the linked customers. Deprecated. Use the match_table_customer_id inside query_execution_spec.
Optional. The duplicated fields inside query_execution_spec will override the fields outside.
includePerformanceInfo
boolean
Optional. If true, call BigQuery to dry run the query to collect some performance info. It may take longer compared to only validating the query. The startDate, endDate and parameters inside query_execution_spec need to be set for the dry run.
Response body
Response to a analysisQueries.validate request.
If successful, the response body contains data with the following structure:
Deprecated, and use queryPerformanceInfo instead. Bytes of data this query reads. See https://cloud.google.com/bigquery/pricing#data for details on how this is calculated. Returned if includePerformanceInfo is true. We round the processedBytes to MB, and then convert it to bytes. -1 means we couldn't fetch it for this query.
Filtered row summary that would be used when the query is executed: the rows that are not sufficiently aggregated are dropped from the result, filtered row summary describes how to summarize these rows. For details see https://developers.google.com/ads-data-hub/guides/filtered-row-summary.
Additional warnings from validation, if any. This may include use of deprecated fields or features, or privacy anti-patterns in the query. These warnings will not block query execution, but should be considered for best results.
Additional information from validation, if any. This may include helpful information or warnings, such as privacy anti-patterns in the query. It will not block query execution, but should be considered for best results.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eValidates analysis queries before execution to ensure correctness and identify potential issues.\u003c/p\u003e\n"],["\u003cp\u003eAccepts an AnalysisQuery object, optional execution specifications, and performance info request in the request body.\u003c/p\u003e\n"],["\u003cp\u003eProvides validation results, including performance information, filtered row summaries, and warnings or errors in the response.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/adsdatahub\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document details the process for validating an analysis query via a POST request to `https://adsdatahub.googleapis.com/v1/{parent=customers/*}/analysisQueries:validate`. The request body must include a `query` object for validation, and optionally `spec` and `includePerformanceInfo`. The response body contains validation details such as `queryPerformanceInfo`, `filteredRowSummary`, `status`, and the deprecated `processedBytes`. This method checks a static validation and requires the `https://www.googleapis.com/auth/adsdatahub` scope for authorization.\n"],null,["# Method: customers.analysisQueries.validate\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 - [JSON representation](#body.ValidateAnalysisQueryResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\nPerforms static validation checks on the provided analysis query.\n\n### HTTP request\n\n`POST https://adsdatahub.googleapis.com/v1/{parent=customers/*}/analysisQueries:validate`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|------------------------------------------------------------------------------|\n| `parent` | `string` The parent resource name that owns the query, e.g. 'customers/123'. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"query\": { object (/ads-data-hub/marketers/reference/rest/v1/customers.analysisQueries#AnalysisQuery) }, \"adsDataCustomerId\": string, \"matchDataCustomerId\": string, \"spec\": { object (/ads-data-hub/marketers/reference/rest/v1/QueryExecutionSpec) }, \"includePerformanceInfo\": boolean } ``` |\n\n| Fields ||\n|----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `query` | `object (`[AnalysisQuery](/ads-data-hub/marketers/reference/rest/v1/customers.analysisQueries#AnalysisQuery)`)` The query to validate. |\n| `adsDataCustomerId` **(deprecated)** | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Optional. Specific linked Ads Data Hub customer ID to use for validating ads data and temp table access. Defaults to all the linked customers. Deprecated. Use the adsDataCustomerId inside query_execution_spec. |\n| `matchDataCustomerId` **(deprecated)** | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Optional. Specific linked Ads Data Hub customer ID to use for validating match data and temp table access. Defaults to all the linked customers. Deprecated. Use the match_table_customer_id inside query_execution_spec. |\n| `spec` | `object (`[QueryExecutionSpec](/ads-data-hub/marketers/reference/rest/v1/QueryExecutionSpec)`)` Optional. The duplicated fields inside query_execution_spec will override the fields outside. |\n| `includePerformanceInfo` | `boolean` Optional. If true, call BigQuery to dry run the query to collect some performance info. It may take longer compared to only validating the query. The startDate, endDate and parameters inside query_execution_spec need to be set for the dry run. |\n\n### Response body\n\nResponse to a analysisQueries.validate request.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"processedBytes\": string, \"queryPerformanceInfo\": { object (/ads-data-hub/marketers/reference/rest/v1/QueryPerformanceInfo) }, \"filteredRowSummary\": { object (/ads-data-hub/marketers/reference/rest/v1/customers.analysisQueries#FilteredRowSummary) }, \"warningsStatus\": [ { object (/ads-data-hub/marketers/reference/rest/v1/operations#Status) } ], \"status\": [ { object (/ads-data-hub/marketers/reference/rest/v1/operations#Status) } ] } ``` |\n\n| Fields ||\n|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `processedBytes` **(deprecated)** | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` | This item is deprecated! Deprecated, and use queryPerformanceInfo instead. Bytes of data this query reads. See \u003chttps://cloud.google.com/bigquery/pricing#data\u003e for details on how this is calculated. Returned if includePerformanceInfo is true. We round the processedBytes to MB, and then convert it to bytes. -1 means we couldn't fetch it for this query. |\n| `queryPerformanceInfo` | `object (`[QueryPerformanceInfo](/ads-data-hub/marketers/reference/rest/v1/QueryPerformanceInfo)`)` Returned if includePerformanceInfo is true. |\n| `filteredRowSummary` | `object (`[FilteredRowSummary](/ads-data-hub/marketers/reference/rest/v1/customers.analysisQueries#FilteredRowSummary)`)` Filtered row summary that would be used when the query is executed: the rows that are not sufficiently aggregated are dropped from the result, filtered row summary describes how to summarize these rows. For details see \u003chttps://developers.google.com/ads-data-hub/guides/filtered-row-summary\u003e. |\n| `warningsStatus[]` **(deprecated)** | `object (`[Status](/ads-data-hub/marketers/reference/rest/v1/operations#Status)`)` | Deprecated. Use status instead. Additional warnings from validation, if any. This may include use of deprecated fields or features, or privacy anti-patterns in the query. These warnings will not block query execution, but should be considered for best results. |\n| `status[]` | `object (`[Status](/ads-data-hub/marketers/reference/rest/v1/operations#Status)`)` Additional information from validation, if any. This may include helpful information or warnings, such as privacy anti-patterns in the query. It will not block query execution, but should be considered for best results. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adsdatahub`"]]