Method: customers.analysisQueries.validate

  • The validate method performs static validation checks on a provided analysis query using a POST request to the specified Ads Data Hub API endpoint.

  • The request includes a path parameter for the parent resource name and a request body containing the query, optional customer IDs, execution specifications, and a boolean to include performance information.

  • The response body includes information on processed bytes (deprecated), query performance, a filtered row summary, and status messages or warnings.

  • Authorization for this method requires the https://www.googleapis.com/auth/adsdatahub OAuth scope.

Performs static validation checks on the provided analysis query.

HTTP request

POST https://adsdatahub.googleapis.com/v1/{parent=customers/*}/analysisQueries:validate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The parent resource name that owns the query, e.g. 'customers/123'.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "query": {
    object (AnalysisQuery)
  },
  "adsDataCustomerId": string,
  "matchDataCustomerId": string,
  "spec": {
    object (QueryExecutionSpec)
  },
  "includePerformanceInfo": boolean
}
Fields
query

object (AnalysisQuery)

The query to validate.
adsDataCustomerId
(deprecated)

string (int64 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.
matchDataCustomerId
(deprecated)

string (int64 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.
spec

object (QueryExecutionSpec)

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:

JSON representation 
{
  "processedBytes": string,
  "queryPerformanceInfo": {
    object (QueryPerformanceInfo)
  },
  "filteredRowSummary": {
    object (FilteredRowSummary)
  },
  "warningsStatus": [
    {
      object (Status)
    }
  ],
  "status": [
    {
      object (Status)
    }
  ]
}
Fields
processedBytes
(deprecated)

string (int64 format)

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.
queryPerformanceInfo

object (QueryPerformanceInfo)

Returned if includePerformanceInfo is true.
filteredRowSummary

object (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 https://developers.google.com/ads-data-hub/guides/filtered-row-summary.
warningsStatus[]
(deprecated)

object (Status)

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.
status[]

object (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.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub