Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.conversionCustomVariables

Resource: ConversionCustomVariable

A conversion custom variable See "About custom variables for conversions" at https://support.google.com/google-ads/answer/9964350

JSON representation
{
  "resourceName": string,
  "id": string,
  "name": string,
  "tag": string,
  "status": enum (ConversionCustomVariableStatus),
  "ownerCustomer": string
}
Fields
resourceName

string

Immutable. The resource name of the conversion custom variable. Conversion custom variable resource names have the form:

customers/{customerId}/conversionCustomVariables/{conversion_custom_variable_id}

id

string (int64 format)

Output only. The ID of the conversion custom variable.

name

string

Required. The name of the conversion custom variable. Name should be unique. The maximum length of name is 100 characters. There should not be any extra spaces before and after.

tag

string

Required. Immutable. The tag of the conversion custom variable. It is used in the event snippet and sent to Google Ads along with conversion pings. For conversion uploads in Google Ads API, the resource name of the conversion custom variable is used. Tag should be unique. The maximum size of tag is 100 bytes. There should not be any extra spaces before and after. Currently only lowercase letters, numbers and underscores are allowed in the tag.

status

enum (ConversionCustomVariableStatus)

The status of the conversion custom variable for conversion event accrual.

ownerCustomer

string

Output only. The resource name of the customer that owns the conversion custom variable.

ConversionCustomVariableStatus

Possible statuses of a conversion custom variable.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ACTIVATION_NEEDED

The conversion custom variable is pending activation and will not accrue stats until set to ENABLED.

This status can't be used in CREATE and UPDATE requests.

ENABLED The conversion custom variable is enabled and will accrue stats.
PAUSED The conversion custom variable is paused and will not accrue stats until set to ENABLED again.

Methods

get

Returns the requested conversion custom variable.

mutate

Creates or updates conversion custom variables.