Method: customers.analysisQueries.start

  • The API call starts the execution of a stored analysis query, writing results to a specified BigQuery table.

  • The HTTP request uses a POST method with a URL following gRPC Transcoding syntax.

  • The request requires a name path parameter representing the full resource name of the analysis query.

  • The request body includes parameters like spec, destTable, and optional customerId to define query execution and destination.

  • A successful response returns an Operation instance, and authorization requires the https://www.googleapis.com/auth/adsdatahub scope.

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