Home Guides Reference Samples Support Policies Vendors

Method: userQueries.populateUserList

Starts execution for a stored user list query. The resulting users will be added to the user list with the specified userListId. The returned operation Operation.name can be used to poll for status, wait for completion, or cancel the operation.

HTTP request

POST https://fullcirclequery.googleapis.com/v2/userQueries/{userQueryName}:populateUserList

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
userQueryName

string

The name of the user query to execute.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "querySpec": {
    object (QueryExecutionSpec)
  },
  "userListId": string
}
Fields
querySpec

object (QueryExecutionSpec)

The query parameter specification used for execution.

userListId

string (int64 format)

Add users to this user list. The user list must be owned by the Ads Data Hub customer executing the query.

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/adsdatahub
  • https://www.googleapis.com/auth/xapi.zoo