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.

REST Resource: customers.crmBasedUserListQueries

  • A CrmBasedUserListQuery defines a query for creating user lists based on customer data within Ads Data Hub.

  • The resource includes fields such as name, title, the query itself written in Standard SQL, and information about its state, creation, and last update.

  • It provides methods to create, delete, retrieve, list, update, and validate these CRM based user list queries.

Resource: CrmBasedUserListQuery

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

JSON representation 
{
 "name": string,
 "title": string,
 "queryText": string,
 "queryState": enum (QueryState ),
 "updateTime": string,
 "updateEmail": string,
 "createTime": string,
 "createEmail": string,
 "queryShare": [
 {
 object (QueryShare )
 }
 ],
 "userList": string
}
Fields
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.
title

string

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

string

Query text written in Standard SQL. See https://cloud.google.com/bigquery/docs/reference/standard-sql/.
queryState

enum (QueryState )

Query state.
updateTime

string (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月02日T15:01:23Z" and "2014年10月02日T15:01:23.045123456Z".
updateEmail

string

Output only. Email address of user who last updated the query.
createTime

string (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月02日T15:01:23Z" and "2014年10月02日T15:01:23.045123456Z".
createEmail

string

Output only. Immutable. 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.
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]

Methods

create

Creates a CRM based user list query for later execution.

delete

Deletes a CRM based user list query.

get

Retrieves the requested CRM based user list query.

list

Lists the CRM based user list queries owned by the specified customer.

patch

Updates an existing CRM based user list query.

validate

Performs static validation checks on the provided CRM based user list query to ensure valid output schema.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024年09月18日 UTC.