Method: customers.crmBasedUserListQueries.validate

  • This endpoint allows you to perform static validation checks on CRM-based user list queries to ensure a valid output schema.

  • The request requires a parent resource name (e.g., 'customers/123') and the query to validate in the request body.

  • Optionally, you can include performance information by setting includePerformanceInfo to true, which triggers a BigQuery dry run.

  • Successful validation returns a response indicating the validity of the query and optionally performance details if requested.

  • To use this endpoint, you need to authorize your request with the https://www.googleapis.com/auth/adsdatahub scope.

Performs static validation checks on the provided CRM based user list query to ensure valid output schema.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. 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 (CrmBasedUserListQuery)
  },
  "includePerformanceInfo": boolean
}
Fields
query

object (CrmBasedUserListQuery)

Required. The query to validate.
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 crmBasedUserListQueries.validate request.

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

JSON representation 
{
  "queryPerformanceInfo": {
    object (QueryPerformanceInfo)
  }
}
Fields
queryPerformanceInfo

object (QueryPerformanceInfo)

Returned if includePerformanceInfo is true.

Authorization scopes

Requires the following OAuth scope:

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