This is legacy documentation, and may not be complete. To see the latest documentation, if you are a marketer, refer to theMarketerssite. If you are a measurement partner, refer to theMeasurement Partnerssite.
Starts execution on a stored user list query. The results uploaded to the specified Google Ads user list. The returned operation name can be used to poll for query completion status.
HTTP request
POST https://adsdatahub.googleapis.com/v1/{name=customers/*/userListQueries/*}:start
[[["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 of a stored user list query and uploads the results to a specified Google Ads user list.\u003c/p\u003e\n"],["\u003cp\u003eUsers can track query completion status via the returned operation name.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires specifying the query execution parameters, Google Ads user list ID, and optionally, the Ads Data Hub customer ID.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful execution returns an Operation object detailing the status and outcome.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/adsdatahub\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document details the process of initiating a user list query in Google Ads Data Hub. A POST request is sent to a specific URL containing the user list query's name. The request body includes query execution parameters (`spec`), a Google Ads user list ID (`userListId`), and an optional customer ID (`customerId`). The query results are uploaded to the specified Google Ads user list. Upon success, an Operation object is returned, indicating the query's status. It also requires OAuth authorization with the `https://www.googleapis.com/auth/adsdatahub` scope.\n"],null,["# Method: customers.userListQueries.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 user list query. The results uploaded to the specified Google Ads user list. 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/*/userListQueries/*}: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/userListQueries/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) }, \"userListId\": string, \"customerId\": string } ``` |\n\n| Fields ||\n|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `spec` | `object (`[QueryExecutionSpec](/ads-data-hub/reference/rest/v1/QueryExecutionSpec)`)` Defines the query execution parameters. |\n| `userListId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Google Ads user list ID. Note that the user list must be managed by the Ads Data Hub customer executing the query. |\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`"]]
