Method: customers.analysisQueries.startTransient

  • The endpoint starts the execution of a transient analysis query, with results written to a specified BigQuery destination table.

  • The process uses an HTTP POST request with a specific URL structure that incorporates gRPC Transcoding syntax.

  • The request requires a parent path parameter specifying the customer executing the query.

  • The request body contains a JSON representation including the query, execution specifications, and the destination table.

  • A successful response body contains an instance of Operation and requires the https://www.googleapis.com/auth/adsdatahub OAuth scope for authorization.

Starts execution on a transient 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/{parent=customers/*}/analysisQueries:startTransient

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Full resource name of the customer executing the query, e.g. 'customers/123'.

Request body

The request body contains data with the following structure:

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

object (AnalysisQuery)

The query to execute.
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.

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