QueryExecutionSpec

JSON representation

The core of a request to execute a query: the query name and parameters. The query that will be executed can be either: 1) a saved query (referenced via queryName) 2) brand new query (fully specified within query). For a query to be executed, valid start and end dates must be provided as well as argument values for all arguments.

JSON representation

JSON representation
{ "startDate": string, "endDate": string, "parameterValues": { string: { object(`ParameterValue`) }, ... }, "timeZone": string, "destTable": string, "jobId": string, "fullCircleCustomerId": string, "roleName": string, "adsDataCustomerId": string, "matchDataCustomerId": string }

{
  "startDate": string,
  "endDate": string,
  "parameterValues": {
    string: {
      object(ParameterValue)
    },
    ...
  },
  "timeZone": string,
  "destTable": string,
  "jobId": string,
  "fullCircleCustomerId": string,
  "roleName": string,
  "adsDataCustomerId": string,
  "matchDataCustomerId": string
}

Fields
`startDate`	`string` The start date (inclusive) of the date range for the query. All data aggregated by the query will be on or after the start date.
`endDate`	`string` The end date (inclusive) of the date range for the query. All data aggregated by the query will be on or before the end date.
`parameterValues`	`map (key: string, value: object (ParameterValue))` Any additional arguments expected by the query. Maps each argument name to its bound value. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`timeZone`	`string` Optional. Time zone to be used for both startDate and endDate. If not specified, defaults to UTC.
`destTable`	`string` BigQuery destination table for query results, of the form "project.dataset.table". The service account for the Ads Data Hub customer must have edit permissions to the BigQuery dataset. If either project or dataset is unspecified, defaults to the customer's default dataset. Unused when calling userQueries.populateUserList.
`jobId`	`string` Optional. Customer-specified job id. This can be used to reference the query using "operations/jobId". If absent, an id will be generated by the server. Returns an error if a job with this id already exists.
`fullCircleCustomerId`	`string (int64 format)` The Ads Data Hub customer that is executing the query. May be absent if the user only has access to one customer account.
`roleName (deprecated)`	`string` Deprecated. Please use ads_data_customer_id and match_data_customer_id. Optional. The role that determines the ads data and match data used in the query. If absent, the adsDataCustomerId and matchDataCustomerId values will determine the data configuration for the query.
`adsDataCustomerId`	`string (int64 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. This field is ignored if roleName is specified.
`matchDataCustomerId`	`string (int64 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 one exists. This field is ignored if roleName is specified.