Method: customers.analysisQueries.start

  • The operation customers.analysisQueries.start executes a stored analysis query and writes the results to a specified BigQuery destination table.

  • The execution is started via an HTTP POST request to a URL that includes the customer and analysis query name in the path parameters.

  • The request body for starting a query includes the query specification, the destination BigQuery table, and an optional customer ID.

  • The response upon successful execution is an Operation instance, which can be used to track the query's completion status.

  • This operation requires the https://www.googleapis.com/auth/adsdatahub OAuth scope for authorization.

Starts execution on a stored analysis query. The results will be written to the specified BigQuery destination table. The returned operation name can be used to poll for query completion status.

HTTP request

POST https://adsdatahub.googleapis.com/v1/{name=customers/*/analysisQueries/*}:start

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Full resource name, e.g. 'customers/123/analysisQueries/abcd1234'.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "spec": {
    object (QueryExecutionSpec)
  },
  "destTable": string,
  "customerId": string
}
Fields
spec

object (QueryExecutionSpec)

Defines the query execution parameters.
destTable

string

Destination BigQuery table for query results with the format 'project.dataset.table_name'. If specified, the project must be explicitly whitelisted for the customer's ADH account. If project is not specified, uses default project for the provided customer. If neither project nor dataset is specified, uses the default project and dataset.
customerId

string (int64 format)

Optional. Ads Data Hub customer executing the query. If not specified, defaults to the customer that owns the query.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adsdatahub