REST Resource: customers.analysisQueries

Resource: AnalysisQuery

Defines an analysis query that can be executed within Ads Data Hub.

JSON representation
{
  "name": string,
  "title": string,
  "queryText": string,
  "parameterTypes": {
    string: {
      object(ParameterType)
    },
    ...
  },
  "mergeSpec": {
    object(MergeSpec)
  },
  "queryState": enum(QueryState),
  "updateTime": string,
  "updateEmail": string,
  "createTime": string,
  "createEmail": string,
  "queryShare": [
    {
      object(QueryShare)
    }
  ]
}
Fields
name

string

Name that uniquely identifies a query. It has the form customers/[customerId]/analysisQueries/[resource_id], e.g. 'customers/123/analysisQueries/abcd1234'. The resource ID is generated by the server.

title

string

Query title, which is unique within a single Ads Data Hub customer and query type.

queryText

string

Query text written in Standard SQL. See https://cloud.google.com/bigquery/docs/reference/standard-sql/.

parameterTypes

map (key: string, value: object(ParameterType))

Any additional parameters expected by the query. Maps each argument name to its argument type.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

mergeSpec

object(MergeSpec)

Instructions for row merging. If present, then any rows that would have been dropped for privacy reasons will be combined into a single merged row. The merged row will be included in the final output if the merged row meets privacy requirements.

queryState

enum(QueryState)

Query state.

updateTime

string (Timestamp format)

Time the query was last updated.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

updateEmail

string

Email address of user who last updated the query.

createTime

string (Timestamp format)

Time the query was created.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

createEmail

string

Email address of user who created the query.

queryShare[]

object(QueryShare)

Indicates ways that a query may be shared beyond the owning Ads Data Hub customer.

MergeSpec

Merge instructions for an analysis query result schema.

JSON representation
{
  "columns": {
    string: {
      object(MergeColumn)
    },
    ...
  }
}
Fields
columns

map (key: string, value: object(MergeColumn))

Instructions for merging each column, keyed by name. Any missing columns will be treated as MERGE_TYPE_UNSPECIFIED.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

QueryState

State that determines an analysis query's run mode.

Enums
QUERY_STATE_UNSPECIFIED Query state is unspecified.
RUNNABLE Query is available to be run by the customer.
WHITELISTED Query has been manually reviewed and approved to run without certain runtime privacy checks.

Methods

create

Creates an analysis query for later execution.

delete

Deletes an analysis query.

get

Retrieves the requested analysis query.

list

Lists the analysis queries owned by the specified customer.

patch

Updates an existing analysis query.

start

Starts execution on a stored analysis query.

startTransient

Starts execution on a transient analysis query.

validate

Performs static validation checks on the provided analysis query.