Method: customers.userListQueries.start
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
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Full resource name, e.g. 'customers/123/userListQueries/abcd1234'.
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"spec": {
object (QueryExecutionSpec)
},
"userListId": string,
"customerId": string
} |
| Fields |
spec |
object (QueryExecutionSpec)
Defines the query execution parameters.
|
userListId |
string (int64 format)
Google Ads user list ID. Note that the user list must be managed by the Ads Data Hub customer executing the query.
|
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["Starts execution of a stored user list query and uploads the results to a specified Google Ads user list."],["Users can track query completion status via the returned operation name."],["The request requires specifying the query execution parameters, Google Ads user list ID, and optionally, the Ads Data Hub customer ID."],["The response returns an Operation object indicating the status of the request."],["Authorization requires the `https://www.googleapis.com/auth/adsdatahub` scope."]]],["This content outlines how to start a user list query execution in Google Ads Data Hub. A POST request is sent to the specified URL, including the resource `name` as a path parameter. The request body requires a JSON object containing the `spec` (query execution parameters), `userListId`, and optionally `customerId`. Upon success, it returns an `Operation` instance. The process uses gRPC Transcoding and requires OAuth scope `https://www.googleapis.com/auth/adsdatahub`. The query result will be uploaded to the specified user list.\n"]]
