This is legacy documentation, and may not be complete. To see the latest documentation, if you are a marketer, refer to the Marketers site. If you are a measurement partner, refer to the Measurement Partners site.
Output only. Immutable. 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.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateEmail
string
Output only. Email address of user who last updated the query.
Output only. Immutable. Time the query was created.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
createEmail
string
Output only. Immutable. Email address of user who created the query.
[[["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\u003e\u003ccode\u003eUserListQuery\u003c/code\u003e defines a query that can be executed within Ads Data Hub to generate user lists.\u003c/p\u003e\n"],["\u003cp\u003eThe query includes details like name, title, query text, parameters, and state, along with timestamps and user information.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage user list queries through various methods, such as creating, deleting, retrieving, listing, updating, and executing them.\u003c/p\u003e\n"],["\u003cp\u003eQueries can be shared, and they are associated with Ads Data Hub user lists for population.\u003c/p\u003e\n"]]],["The `UserListQuery` resource defines a query within Ads Data Hub, including its `name`, `title`, and `queryText`. It stores information like `parameterTypes`, `queryState`, `updateTime`, `updateEmail`, `createTime`, `createEmail`, `queryShare`, and associated `userList`. Key actions involve creating, deleting, retrieving, listing, patching, starting, starting transient, and validating user list queries. The query also stores metadata on creation, updates, and sharing.\n"],null,["# REST Resource: customers.userListQueries\n\n- [Resource: UserListQuery](#UserListQuery)\n - [JSON representation](#UserListQuery.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: UserListQuery\n-----------------------\n\nDefines a user list query that can be executed within Ads Data Hub.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"title\": string, \"queryText\": string, \"parameterTypes\": { string: { object (/ads-data-hub/reference/rest/v1/ParameterType) }, ... }, \"queryState\": enum (/ads-data-hub/reference/rest/v1/QueryState), \"updateTime\": string, \"updateEmail\": string, \"createTime\": string, \"createEmail\": string, \"queryShare\": [ { object (/ads-data-hub/reference/rest/v1/QueryShare) } ], \"userList\": [ string ] } ``` |\n\n| Fields ||\n|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Immutable. 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. |\n| `title` | `string` Query title, which is unique within a single Ads Data Hub customer and query type. |\n| `queryText` | `string` Query text. |\n| `parameterTypes` | `map (key: string, value: object (`[ParameterType](/ads-data-hub/reference/rest/v1/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\" }`. |\n| `queryState` | `enum (`[QueryState](/ads-data-hub/reference/rest/v1/QueryState)`)` Query state. |\n| `updateTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` Output only. Time the query was last updated. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n| `updateEmail` | `string` Output only. Email address of user who last updated the query. |\n| `createTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` Output only. Immutable. Time the query was created. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n| `createEmail` | `string` Output only. Immutable. Email address of user who created the query. |\n| `queryShare[]` | `object (`[QueryShare](/ads-data-hub/reference/rest/v1/QueryShare)`)` Indicates ways that a query may be shared beyond the owning Ads Data Hub customer. |\n| `userList[]` | `string` Output only. The Ads Data Hub user list resource that can be populated by this user list query. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|\n| ### [create](/ads-data-hub/reference/rest/v1/customers.userListQueries/create) | Creates a user list query for later execution. |\n| ### [delete](/ads-data-hub/reference/rest/v1/customers.userListQueries/delete) | Deletes a user list query. |\n| ### [get](/ads-data-hub/reference/rest/v1/customers.userListQueries/get) | Retrieves the requested user list query. |\n| ### [list](/ads-data-hub/reference/rest/v1/customers.userListQueries/list) | Lists the user list queries owned by the specified customer. |\n| ### [patch](/ads-data-hub/reference/rest/v1/customers.userListQueries/patch) | Updates an existing user list query. |\n| ### [start](/ads-data-hub/reference/rest/v1/customers.userListQueries/start) | Starts execution on a stored user list query. |\n| ### [startTransient](/ads-data-hub/reference/rest/v1/customers.userListQueries/startTransient)` ` **(deprecated)** | Starts execution on a transient user list query. |\n| ### [validate](/ads-data-hub/reference/rest/v1/customers.userListQueries/validate) | Performs static validation checks on the provided user list query. |"]]