Method: customers.userListQueries.validate

Performs static validation checks on the provided user list query.

HTTP request

POST https://adsdatahub.googleapis.com/v1/{parent=customers/*}/userListQueries: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 (UserListQuery)
  },
  "adsDataCustomerId": string,
  "matchDataCustomerId": string,
  "spec": {
    object (QueryExecutionSpec)
  },
  "includePerformanceInfo": boolean
}
Fields
query

object (UserListQuery)

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

If successful, the response body contains data with the following structure:

Response to a userListQueries.validate request.

JSON representation
{
  "processedBytes": string,
  "queryPerformanceInfo": {
    object (QueryPerformanceInfo)
  }
}
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.

queryPerformanceInfo

object (QueryPerformanceInfo)

Returned if includePerformanceInfo is true.

Authorization Scopes

Requires the following OAuth scope:

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