This is legacy documentation, and may not be complete. To see the latest documentation, if you are a marketer, refer to the Marketers site. If you are a measurement partner, refer to the Measurement Partners site.
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
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eStarts execution on a stored analysis query and writes results to a specified BigQuery destination table.\u003c/p\u003e\n"],["\u003cp\u003eThe request body defines query execution parameters, the destination BigQuery table, and the executing customer ID.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes an operation name for tracking query completion status.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/adsdatahub\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This describes initiating a stored analysis query execution. A `POST` request is sent to a specified URL, including the analysis query's resource name. The request body defines the query execution parameters (`spec`), the BigQuery destination table (`destTable`), and an optional customer ID (`customerId`). Successful execution returns an `Operation` instance, and it needs `https://www.googleapis.com/auth/adsdatahub` scope. The destination table format should be 'project.dataset.table_name'.\n"],null,["# Method: customers.analysisQueries.start\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\nStarts 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.\n\n### HTTP request\n\n`POST https://adsdatahub.googleapis.com/v1/{name=customers/*/analysisQueries/*}:start`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-----------------------------------------------------------------------------|\n| `name` | `string` Full resource name, e.g. 'customers/123/analysisQueries/abcd1234'. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"spec\": { object (/ads-data-hub/reference/rest/v1/QueryExecutionSpec) }, \"destTable\": string, \"customerId\": string } ``` |\n\n| Fields ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `spec` | `object (`[QueryExecutionSpec](/ads-data-hub/reference/rest/v1/QueryExecutionSpec)`)` Defines the query execution parameters. |\n| `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. |\n| `customerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Optional. Ads Data Hub customer executing the query. If not specified, defaults to the customer that owns the query. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/ads-data-hub/reference/rest/v1/operations#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adsdatahub`"]]
