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. Linked Ads Data Hub customer ID that owns the ads data used in the query. If absent, then the query will be run using the ads data owned by the Ads Data Hub customer running the query.
Optional. Linked Ads Data Hub customer ID that owns the match data for the query. If absent, then the query will be run using the match data owned by the Ads Data Hub customer ID running the query, if applicable.
The start date (inclusive) for the query. Reserved keyword: A user-defined parameter with this name will be ignored and replaced with the values from the QueryExecutionSpec.
The end date (inclusive) for the query. Reserved keyword: A user-defined parameter with this name will be ignored and replaced with the values from the QueryExecutionSpec.
timeZone
string
Optional. The time zone for the query start and end dates. If not specified, defaults to 'UTC'. Reserved keyword: A user-defined parameter with this name will be ignored and replaced with the values from the QueryExecutionSpec.
Any additional parameters expected by the query. Maps each parameter name to its bound value.
An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
jobId
string
Optional. Job ID for the query operation. The resulting operation will have the name "operations/[jobId]", e.g. "operations/job_123". If an operation with the same job ID already exists, this will result in an error. If absent, a job ID will be generated by the server.
[[["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\u003e\u003ccode\u003eQueryExecutionSpec\u003c/code\u003e defines parameters for executing queries, including date ranges, time zones, and optional customer IDs for data sources.\u003c/p\u003e\n"],["\u003cp\u003eUsers can provide additional parameters using \u003ccode\u003eparameterValues\u003c/code\u003e, and optionally specify a \u003ccode\u003ejobId\u003c/code\u003e for the operation.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eQueryPrivacyMode\u003c/code\u003e offers options like \u003ccode\u003eDIFFERENCE_CHECKS\u003c/code\u003e and \u003ccode\u003eNOISE\u003c/code\u003e to enhance privacy during query execution.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eadsDataCustomerId\u003c/code\u003e and \u003ccode\u003ematchDataCustomerId\u003c/code\u003e fields allow users to link specific data sources for their queries.\u003c/p\u003e\n"]]],["The document defines parameters for query execution, including `adsDataCustomerId` and `matchDataCustomerId` to specify data sources. It mandates `startDate` and `endDate` for the query period, `timeZone`, and optional parameters through `parameterValues`. A `jobId` can be set, otherwise one is generated. `privacyMode`, either `DIFFERENCE_CHECKS` or `NOISE`, dictates privacy measures; `QUERY_PRIVACY_MODE_UNSPECIFIED` is not allowed for aggregation queries.\n"],null,["- [JSON representation](#SCHEMA_REPRESENTATION)\n- [QueryPrivacyMode](#QueryPrivacyMode)\n\nDefines the query execution parameters.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"adsDataCustomerId\": string, \"matchDataCustomerId\": string, \"startDate\": { object (/ads-data-hub/reference/rest/v1/Date) }, \"endDate\": { object (/ads-data-hub/reference/rest/v1/Date) }, \"timeZone\": string, \"parameterValues\": { string: { object (/ads-data-hub/reference/rest/v1/ParameterValue) }, ... }, \"jobId\": string, \"privacyMode\": enum (/ads-data-hub/reference/rest/v1/QueryExecutionSpec#QueryPrivacyMode) } ``` |\n\n| Fields ||\n|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `adsDataCustomerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Optional. Linked Ads Data Hub customer ID that owns the ads data used in the query. If absent, then the query will be run using the ads data owned by the Ads Data Hub customer running the query. |\n| `matchDataCustomerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Optional. Linked Ads Data Hub customer ID that owns the match data for the query. If absent, then the query will be run using the match data owned by the Ads Data Hub customer ID running the query, if applicable. |\n| `startDate` | `object (`[Date](/ads-data-hub/reference/rest/v1/Date)`)` The start date (inclusive) for the query. Reserved keyword: A user-defined parameter with this name will be ignored and replaced with the values from the QueryExecutionSpec. |\n| `endDate` | `object (`[Date](/ads-data-hub/reference/rest/v1/Date)`)` The end date (inclusive) for the query. Reserved keyword: A user-defined parameter with this name will be ignored and replaced with the values from the QueryExecutionSpec. |\n| `timeZone` | `string` Optional. The time zone for the query start and end dates. If not specified, defaults to 'UTC'. Reserved keyword: A user-defined parameter with this name will be ignored and replaced with the values from the QueryExecutionSpec. |\n| `parameterValues` | `map (key: string, value: object (`[ParameterValue](/ads-data-hub/reference/rest/v1/ParameterValue)`))` Any additional parameters expected by the query. Maps each parameter name to its bound value. An object containing a list of `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |\n| `jobId` | `string` Optional. Job ID for the query operation. The resulting operation will have the name \"operations/\\[jobId\\]\", e.g. \"operations/job_123\". If an operation with the same job ID already exists, this will result in an error. If absent, a job ID will be generated by the server. |\n| `privacyMode` | `enum (`[QueryPrivacyMode](/ads-data-hub/reference/rest/v1/QueryExecutionSpec#QueryPrivacyMode)`)` Optional. Type of privacy protections to apply to query. |\n\nQueryPrivacyMode Defines types of privacy checks applied to a query.\n\n| Enums ||\n|----------------------------------|--------------------------------------------------------|\n| `QUERY_PRIVACY_MODE_UNSPECIFIED` | Unspecified mode. Not allowed for aggregation queries. |\n| `DIFFERENCE_CHECKS` | Apply difference checks to query. |\n| `NOISE` | Apply noise to query. |"]]
