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( |
Fields | |
---|---|
name |
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 |
Query title, which is unique within a single Ads Data Hub customer and query type. |
queryText |
Query text written in Standard SQL. See https://cloud.google.com/bigquery/docs/reference/standard-sql/. |
parameterTypes |
Any additional parameters expected by the query. Maps each argument name to its argument type. An object containing a list of |
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 |
Query state. |
updateTime |
Time the query was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
updateEmail |
Email address of user who last updated the query. |
createTime |
Time the query was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: |
createEmail |
Email address of user who created the query. |
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( |
Fields | |
---|---|
columns |
Instructions for merging each column, keyed by name. Any missing columns will be treated as MERGE_TYPE_UNSPECIFIED. An object containing a list of |
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 |
|
---|---|
|
Creates an analysis query for later execution. |
|
Deletes an analysis query. |
|
Retrieves the requested analysis query. |
|
Lists the analysis queries owned by the specified customer. |
|
Updates an existing analysis query. |
|
Starts execution on a stored analysis query. |
|
Starts execution on a transient analysis query. |
|
Performs static validation checks on the provided analysis query. |