REST Resource: customers.userListQueries

Resource: UserListQuery

Defines a user list query that can be executed within Ads Data Hub.

JSON representation
{
  "name": string,
  "title": string,
  "queryText": string,
  "parameterTypes": {
    string: {
      object(ParameterType)
    },
    ...
  },
  "updateTime": string,
  "updateEmail": string,
  "createTime": string,
  "createEmail": string,
  "queryShare": [
    {
      object(QueryShare)
    }
  ]
}
Fields
name

string

Name that uniquely identifies a query. It has the form customers/[customerId]/userListQueries/[resource_id], e.g. 'customers/123/userListQueries/abcd1234'. The resource ID is generated by the server.

title

string

Query title, which is unique within a single Ads Data Hub customer and query type.

queryText

string

Query text.

parameterTypes

map (key: string, value: object(ParameterType))

Any additional parameters expected by the query. Maps each argument name to its argument type.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

updateTime

string (Timestamp format)

Time the query was last updated.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

updateEmail

string

Email address of user who last updated the query.

createTime

string (Timestamp format)

Time the query was created.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

createEmail

string

Email address of user who created the query.

queryShare[]

object(QueryShare)

Indicates ways that a query may be shared beyond the owning Ads Data Hub customer.

Methods

create

Creates a user list query for later execution.

delete

Deletes a user list query.

get

Retrieves the requested user list query.

list

Lists the user list queries owned by the specified customer.

patch

Updates an existing user list query.

start

Starts execution on a stored user list query.

startTransient

Starts execution on a transient user list query.

validate

Performs static validation checks on the provided user list query.