Method: customers.userListQueries.start

  • This resource allows you to start the execution of a stored user list query and upload the results to a specified Google Ads user list.

  • The method uses a POST HTTP request to a specific URL containing the customer and user list query name.

  • The request body includes a specification for the query execution parameters, the target Google Ads user list ID, and an optional Ads Data Hub customer ID.

  • A successful request returns an Operation instance that can be used to track the query's completion status.

  • The authorization scope https://www.googleapis.com/auth/adsdatahub is required to use this resource.

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