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:
[[["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\u003eThis endpoint allows you to perform static validation checks on CRM-based user list queries to ensure a valid output schema.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a parent resource name (e.g., 'customers/123') and the query to validate in the request body.\u003c/p\u003e\n"],["\u003cp\u003eOptionally, you can include performance information by setting \u003ccode\u003eincludePerformanceInfo\u003c/code\u003e to true, which triggers a BigQuery dry run.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful validation returns a response indicating the validity of the query and optionally performance details if requested.\u003c/p\u003e\n"],["\u003cp\u003eTo use this endpoint, you need to authorize your request with the \u003ccode\u003ehttps://www.googleapis.com/auth/adsdatahub\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document details how to validate a CRM-based user list query. It uses a `POST` HTTP request to the specified URL, including a `parent` path parameter (e.g., `customers/123`). The request body requires a `query` object and optionally a boolean `includePerformanceInfo`. The response body, when successful, contains `queryPerformanceInfo` if the boolean was `true`. Access to this operation requires the `https://www.googleapis.com/auth/adsdatahub` OAuth scope.\n"],null,["# Method: customers.crmBasedUserListQueries.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.ValidateCrmBasedUserListQueryResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\nPerforms static validation checks on the provided CRM based user list query to ensure valid output schema.\n\n### HTTP request\n\n`POST https://adsdatahub.googleapis.com/v1/{parent=customers/*}/crmBasedUserListQueries:validate`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------|\n| `parent` | `string` Required. 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.crmBasedUserListQueries#CrmBasedUserListQuery) }, \"includePerformanceInfo\": boolean } ``` |\n\n| Fields ||\n|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `query` | `object (`[CrmBasedUserListQuery](/ads-data-hub/marketers/reference/rest/v1/customers.crmBasedUserListQueries#CrmBasedUserListQuery)`)` Required. The query to validate. |\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 crmBasedUserListQueries.validate request.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------|\n| ``` { \"queryPerformanceInfo\": { object (/ads-data-hub/marketers/reference/rest/v1/QueryPerformanceInfo) } } ``` |\n\n| Fields ||\n|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| `queryPerformanceInfo` | `object (`[QueryPerformanceInfo](/ads-data-hub/marketers/reference/rest/v1/QueryPerformanceInfo)`)` Returned if includePerformanceInfo is true. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adsdatahub`"]]
