REST Resource: customers.analysisQueries

  • The AnalysisQuery resource defines an analysis query that can be executed within Ads Data Hub, with fields for name, title, query text, parameter types, merge specifications (deprecated), query state, and timestamps.

  • FilteredRowSummary is used to define how to combine rows dropped for privacy reasons into a single merged row, replacing the deprecated MergeSpec.

  • ColumnSummaryRule provides merge instructions for a single output column within a FilteredRowSummary.

  • SummaryType and MergeType (deprecated) specify the supported operations for column merging, such as unspecified, constant, or sum.

  • The API provides methods to create, delete, get, list, patch, start, start transient, and validate analysis queries.

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)
    }
  ],

  // Union field filtered_row can be only one of the following:
  "filteredRowSummary": {
    object (FilteredRowSummary)
  },
  "generateFilteredRowSummaryAutomatically": boolean
  // End of list of possible types for union field filtered_row.
}
Fields
name

string

Output only. Immutable. 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
(deprecated)

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 in the final output if the merged row meets privacy requirements.
queryState

enum (QueryState)

Query state.
updateTime

string (Timestamp format)

Output only. Time the query was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateEmail

string

Output only. Email address of user who last updated the query.
createTime

string (Timestamp format)

Output only. Immutable. Time the query was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
createEmail

string

Output only. Immutable. 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.
Union field filtered_row. Instructions for row merging. filtered_row can be only one of the following:
filteredRowSummary

object (FilteredRowSummary)

Define how to combine rows dropped for privacy reasons into a single merged row. The merged row will be included in the final output if the merged row meets privacy requirements.
generateFilteredRowSummaryAutomatically

boolean

If true, a filtered row summary is generated automatically.

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" }.

MergeColumn

Merge instructions for a single output column.

JSON representation 
{
  "type": enum (MergeType),
  "value": {
    object (ParameterValue)
  }
}
Fields
type

enum (MergeType)

Method used to combine the values for the column.
value

object (ParameterValue)

The constant value to use (only valid for CONSTANT merge type).

MergeType

All supported operations for column merging.

Enums
MERGE_TYPE_UNSPECIFIED Unspecified merge type. The merged column value will be NULL.
CONSTANT Replace merged column value with the given constant.
SUM Take the sum of the merged column values.

FilteredRowSummary

Merge instructions for an analysis query result schema.

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

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

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

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

ColumnSummaryRule

Merge instructions for a single output column.

JSON representation 
{
  "type": enum (SummaryType),
  "value": {
    object (ParameterValue)
  }
}
Fields
type

enum (SummaryType)

Method used to combine the values for the column.
value

object (ParameterValue)

The constant value to use (only valid for CONSTANT summary type).

SummaryType

All supported operations for column merging.

Enums
SUMMARY_TYPE_UNSPECIFIED Unspecified summary type. The summary column value will be NULL.
CONSTANT Replace merged column value with the given constant.
SUM Take the sum of the merged column values.

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.