Method: userQueries.patch

Updates an existing user query.

HTTP request

PATCH https://fullcirclequery.googleapis.com/v2/userQueries/{query.queryName}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
query.queryName

string

Query's unique name.

Request body

The request body contains data with the following structure:

JSON representation
{
  "query": {
    "queryName": string,
    "queryText": string,
    "parameterTypes": {
      object
    },
    "mergeSpec": {
      object(MergeSpec)
    },
    "isGlobal": boolean,
    "queryState": enum(QueryState),
    "queryVersion": enum(QueryVersion),
    "lastUpdatedMillis": string,
    "lastUpdateEmail": string,
    "creatorEmail": string,
    "whitelistMode": enum(WhitelistMode),
    "queryShare": [
      {
        object(QueryShare)
      }
    ]
  },
  "customerId": string
}
Fields
query.queryText

string

Query text.

query.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" }.

query.mergeSpec

object(MergeSpec)

Instructions for row merging. If present, then any rows that would have been dropped for privacy will be combined into one. This will be included in the result if the merged row meets privacy restrictions.

query.isGlobal

boolean

True if the query is defined as global; otherwise the query can be used only by a particular customer (or set of customers).

query.queryState

enum(QueryState)

This field defines whether a query is still in development. If it is in development, it should not be executable except by admin user.

query.queryVersion

enum(QueryVersion)

Define what version of the api query must be run in.

query.lastUpdatedMillis

string (int64 format)

Timestamp for when query was last updated.

query.lastUpdateEmail

string

Email address of who last updated the query.

query.creatorEmail

string

Email address of who created the query.

customerId

string (int64 format)

The Ads Data Hub customer that owns the query.

Response body

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

Authorization Scopes

Requires one of the following OAuth scopes:

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