QueryExecutionSpec

  • QueryExecutionSpec defines parameters for executing queries, including date ranges, time zones, and optional customer IDs for data sources.

  • Users can provide additional parameters using parameterValues, and optionally specify a jobId for the operation.

  • QueryPrivacyMode offers options like DIFFERENCE_CHECKS and NOISE to enhance privacy during query execution.

  • The adsDataCustomerId and matchDataCustomerId fields allow users to link specific data sources for their queries.

Defines the query execution parameters.

JSON representation 
{
  "adsDataCustomerId": string,
  "matchDataCustomerId": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "timeZone": string,
  "parameterValues": {
    string: {
      object (ParameterValue)
    },
    ...
  },
  "jobId": string,
  "privacyMode": enum (QueryPrivacyMode)
}
Fields
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.
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 applicable.
startDate

object (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.
endDate

object (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.
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.
parameterValues

map (key: string, value: object (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" }.
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.
privacyMode

enum (QueryPrivacyMode)

Optional. Type of privacy protections to apply to query.

QueryPrivacyMode

Defines types of privacy checks applied to a query.

Enums
QUERY_PRIVACY_MODE_UNSPECIFIED Unspecified mode. Not allowed for aggregation queries.
DIFFERENCE_CHECKS Apply difference checks to query.
NOISE Apply noise to query.