This is legacy documentation, and may not be complete. To see the latest documentation, if you are a marketer, refer to the Marketers site. If you are a measurement partner, refer to the Measurement Partners site.
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\u003eValidates CRM-based user list queries to ensure a valid output schema, using the parent resource name.\u003c/p\u003e\n"],["\u003cp\u003eAccepts a request body containing the query and an optional flag to include performance information.\u003c/p\u003e\n"],["\u003cp\u003eReturns performance details if requested, providing insights into query execution.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/adsdatahub\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes gRPC Transcoding for communication and adheres to specific data structures for requests and responses.\u003c/p\u003e\n"]]],["This document details how to validate a CRM-based user list query using a POST request to the specified URL. The request requires a `parent` path parameter (e.g., 'customers/123') and a request body including a `query` object and an optional `includePerformanceInfo` boolean. A successful response includes `queryPerformanceInfo` if performance info is requested. This request needs authorization via 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/reference/rest/v1/customers.crmBasedUserListQueries#CrmBasedUserListQuery) }, \"includePerformanceInfo\": boolean } ``` |\n\n| Fields ||\n|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `query` | `object (`[CrmBasedUserListQuery](/ads-data-hub/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/reference/rest/v1/QueryPerformanceInfo) } } ``` |\n\n| Fields ||\n|------------------------|---------------------------------------------------------------------------------------------------------------------------------------|\n| `queryPerformanceInfo` | `object (`[QueryPerformanceInfo](/ads-data-hub/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`"]]
