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]/crmBasedUserListQueries/[resource_id], e.g. 'customers/123/crmBasedUserListQueries/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.
Indicates ways that a query may be shared beyond the owning Ads Data Hub customer.
userList
string
Output only. The Ads Data Hub user list resource that can be populated by this CRM based user list query. The resource name has the form: customers/[customerId]/userLists/[userListId]
[[["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\u003eDefines a CRM based user list query that can be executed within Ads Data Hub.\u003c/p\u003e\n"],["\u003cp\u003eProvides details on the query's structure, including name, title, text, state, and timestamps.\u003c/p\u003e\n"],["\u003cp\u003eOutlines the available methods for managing CRM based user list queries, such as create, delete, get, list, patch, and validate.\u003c/p\u003e\n"],["\u003cp\u003eIncludes information about query sharing and its association with Ads Data Hub user lists.\u003c/p\u003e\n"]]],["The document details the `CrmBasedUserListQuery` resource within Ads Data Hub, used to define and execute queries for CRM-based user lists. Key information includes the query's `name`, `title`, `queryText` (Standard SQL), `queryState`, creation/update timestamps and emails, `queryShare` settings, and associated `userList`. Available actions include: `create`, `delete`, `get`, `list`, `patch`, and `validate`, allowing for query management and validation.\n"],null,["# REST Resource: customers.crmBasedUserListQueries\n\n- [Resource: CrmBasedUserListQuery](#CrmBasedUserListQuery)\n - [JSON representation](#CrmBasedUserListQuery.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: CrmBasedUserListQuery\n-------------------------------\n\nDefines a CRM based user list query that can be executed within Ads Data Hub.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"title\": string, \"queryText\": string, \"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\\]/crmBasedUserListQueries/\\[resource_id\\], e.g. 'customers/123/crmBasedUserListQueries/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 written in Standard SQL. See \u003chttps://cloud.google.com/bigquery/docs/reference/standard-sql/\u003e. |\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 CRM based user list query. The resource name has the form: customers/\\[customerId\\]/userLists/\\[userListId\\] |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|\n| ### [create](/ads-data-hub/reference/rest/v1/customers.crmBasedUserListQueries/create) | Creates a CRM based user list query for later execution. |\n| ### [delete](/ads-data-hub/reference/rest/v1/customers.crmBasedUserListQueries/delete) | Deletes a CRM based user list query. |\n| ### [get](/ads-data-hub/reference/rest/v1/customers.crmBasedUserListQueries/get) | Retrieves the requested CRM based user list query. |\n| ### [list](/ads-data-hub/reference/rest/v1/customers.crmBasedUserListQueries/list) | Lists the CRM based user list queries owned by the specified customer. |\n| ### [patch](/ads-data-hub/reference/rest/v1/customers.crmBasedUserListQueries/patch) | Updates an existing CRM based user list query. |\n| ### [validate](/ads-data-hub/reference/rest/v1/customers.crmBasedUserListQueries/validate) | Performs static validation checks on the provided CRM based user list query to ensure valid output schema. |"]]