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.
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.
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 userListQueries.validate request.
If successful, the response body contains data with the following structure:
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.
[[["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 user list queries using the provided query, Ads Data Hub customer IDs (optional), and execution specifications.\u003c/p\u003e\n"],["\u003cp\u003eSends an HTTP POST request to \u003ccode\u003ehttps://adsdatahub.googleapis.com/v1/{parent=customers/*}/userListQueries:validate\u003c/code\u003e with the query details in the request body.\u003c/p\u003e\n"],["\u003cp\u003eThe response provides information on processed bytes (deprecated) and query performance information if requested.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/adsdatahub\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This outlines a validation process for user list queries via a POST request to `https://adsdatahub.googleapis.com/v1/{parent=customers/*}/userListQueries:validate`. The request includes a `query` object, optional customer IDs (`adsDataCustomerId`, `matchDataCustomerId`), a `spec` object, and an `includePerformanceInfo` flag. The response returns `processedBytes` and `queryPerformanceInfo` if `includePerformanceInfo` is enabled, providing data usage and performance details. This process uses the `https://www.googleapis.com/auth/adsdatahub` authorization scope.\n"],null,["# Method: customers.userListQueries.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.ValidateUserListQueryResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\nPerforms static validation checks on the provided user list query.\n\n### HTTP request\n\n`POST https://adsdatahub.googleapis.com/v1/{parent=customers/*}/userListQueries:validate`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|------------------------------------------------------------------------------|\n| `parent` | `string` 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.userListQueries#UserListQuery) }, \"adsDataCustomerId\": string, \"matchDataCustomerId\": string, \"spec\": { object (/ads-data-hub/marketers/reference/rest/v1/QueryExecutionSpec) }, \"includePerformanceInfo\": boolean } ``` |\n\n| Fields ||\n|----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `query` | `object (`[UserListQuery](/ads-data-hub/marketers/reference/rest/v1/customers.userListQueries#UserListQuery)`)` The query to validate. |\n| `adsDataCustomerId` **(deprecated)** | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` 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. |\n| `matchDataCustomerId` **(deprecated)** | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` 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. |\n| `spec` | `object (`[QueryExecutionSpec](/ads-data-hub/marketers/reference/rest/v1/QueryExecutionSpec)`)` Optional. The duplicated fields inside query_execution_spec will override the fields outside. |\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 userListQueries.validate request.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"processedBytes\": string, \"queryPerformanceInfo\": { object (/ads-data-hub/marketers/reference/rest/v1/QueryPerformanceInfo) } } ``` |\n\n| Fields ||\n|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `processedBytes` **(deprecated)** | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` | This item is deprecated! Deprecated, and use queryPerformanceInfo instead. Bytes of data this query reads. See \u003chttps://cloud.google.com/bigquery/pricing#data\u003e 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. |\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`"]]