type AdWordsConversionTracker (v201806)

A conversion tracker created through AdWords Conversion Tracking.


Namespace
https://adwords.google.com/api/adwords/cm/v201806

Field

ConversionTracker (inherited)

id

xsd:long

ID of this conversion tracker, null when creating a new one.

There are some system-defined conversion trackers that are available for all customers to use. See ConversionTrackerService.mutate for more information about how to modify these types.

  • 179 - Calls from Ads
  • 214 - Android Downloads
  • 239 - Store Visits

This field can be selected using the value "Id".
This field can be filtered on.
This field is read only and will be ignored when sent to the API for the following Operators: ADD.

originalConversionTypeId

xsd:long

The ID of the original conversion type on which this ConversionType is based. This is used to facilitate a connection between an existing shared conversion type (e.g. Calls from ads) and an advertiser-specific conversion type. This may only be specified for ADD operations, and can never be modified once a ConversionType is created.

This field can be selected using the value "OriginalConversionTypeId".
This field can be filtered on.
This field is read only and will be ignored when sent to the API for the following Operators: SET.

name

xsd:string

Name of this conversion tracker.

This field can be selected using the value "Name".
This field can be filtered on.
This field is required and should not be null when it is contained within Operators : ADD.

status

ConversionTracker.Status

Status of this conversion tracker.


Enumerations
ENABLED
Visits to the conversion page will be recorded.
DISABLED
Visits to the conversion page will not be recorded.
HIDDEN
Conversions will be recorded, but the conversion tracker will not appear in the UI.

This field can be selected using the value "Status".
This field can be filtered on.

category

ConversionTracker.Category

The category of conversion that is being tracked.


Enumerations
DEFAULT
PAGE_VIEW
PURCHASE
SIGNUP
LEAD
REMARKETING
DOWNLOAD
Download is applicable only to AppConversion types, and is an error to use in conjunction with other types. AppConversions must use download only if they also specify AppConversion.appConversionType as DOWNLOAD or FIRST_OPEN. If any other appConversionType is used, then some other category besides DOWNLOAD must be used.

This field can be selected using the value "Category".
This field can be filtered on.

googleEventSnippet

xsd:string

The event snippet that works with the global site tag to track actions that should be counted as conversions. Returns an empty string if the conversion tracker does not use snippets.

This field can be selected using the value "GoogleEventSnippet".
This field can be filtered on.
This field is read only and will be ignored when sent to the API.

googleGlobalSiteTag

xsd:string

The global site tag that adds visitors to your basic remarketing lists and sets new cookies on your domain, which will store information about the ad click that brought a user to your website. Returns an empty string if the conversion tracker does not use snippets.

This field can be selected using the value "GoogleGlobalSiteTag".
This field can be filtered on.
This field is read only and will be ignored when sent to the API.

dataDrivenModelStatus

DataDrivenModelStatus

The status of the data-driven attribution model for the conversion type.


Enumerations
UNKNOWN
The data driven model status is unknown.
AVAILABLE
A data driven model is available.
STALE
The data driven model is stale. It hasn't been updated for at least 7 days. It is still being used, but will become expired if it does not get updated for 30 days.
EXPIRED
The data driven model expired. It hasn't been updated for at least 30 days and cannot be used. Most commonly this is because there haven't been the required number of events in a recent 30-day period.
NEVER_GENERATED
A data driven model has never been generated. Most commonly this is because there has never been the required number of events in any 30-day period.

This field can be selected using the value "DataDrivenModelStatus".
This field can be filtered on.
This field is read only and will be ignored when sent to the API.

conversionTypeOwnerCustomerId

xsd:long

The external customer ID of the conversion type owner, or 0 if this is a system-defined conversion type. Only the conversion type owner may edit properties of the conversion type.

This field can be selected using the value "ConversionTypeOwnerCustomerId".
This field can be filtered on.
This field is read only and will be ignored when sent to the API.

viewthroughLookbackWindow

xsd:int

Lookback window for view-through conversions in days. This is the length of time in which a conversion without a click can be attributed to an impression.

This field can be selected using the value "ViewthroughLookbackWindow".
This field can be filtered on.
This field must be between 1 and 30, inclusive.

ctcLookbackWindow

xsd:int

The click-through conversion (ctc) lookback window is the maximum number of days between the time a conversion event happens and the previous corresponding ad click.

Conversion events that occur more than this many days after the click are ignored.

This field is only editable for Adwords Conversions and Upload Conversions, but has a system defined default for other types of conversions. The allowed range of values for this window depends on the type of conversion and may expand, but 1-90 days is the currently allowed range.

This field can be selected using the value "CtcLookbackWindow".
This field can be filtered on.

countingType

ConversionDeduplicationMode

How to count events for this conversion tracker. If countingType is MANY_PER_CLICK, then all conversion events are counted. If countingType is ONE_PER_CLICK, then only the first conversion event of this type following a given click will be counted. More information is available at https://support.google.com/adwords/answer/3438531


Enumerations
ONE_PER_CLICK
Number of clicks that get at least one conversion.
MANY_PER_CLICK
Total number of conversions per click.

This field can be selected using the value "CountingType".
This field can be filtered on.

defaultRevenueValue

xsd:double

The value to use when the tag for this conversion tracker sends conversion events without values. This value is applied on the server side, and is applicable to all ConversionTracker subclasses.

See also the corresponding ConversionTracker.defaultRevenueCurrencyCode, and see ConversionTracker.alwaysUseDefaultRevenueValue for details about when this value is used.

This field can be selected using the value "DefaultRevenueValue".
This field can be filtered on.
This field must be between 0 and 1000000000000, inclusive.

defaultRevenueCurrencyCode

xsd:string

The currency code to use when the tag for this conversion tracker sends conversion events without currency codes. This code is applied on the server side, and is applicable to all ConversionTracker subclasses. It must be a valid ISO4217 3-character code, such as USD.

This code is used if the code in the tag is not supplied or is unsupported, or if ConversionTracker.alwaysUseDefaultRevenueValue is set to true. If this default code is not set the currency code of the account is used as the default code.

Set the default code to XXX in order to specify that this conversion type does not have units of a currency (that is, it is unitless). In this case no currency conversion will occur even if a currency code is set in the tag.

This field can be selected using the value "DefaultRevenueCurrencyCode".
This field can be filtered on.

alwaysUseDefaultRevenueValue

xsd:boolean

Controls whether conversion event values and currency codes are taken from the tag snippet or from ConversionTracker.defaultRevenueValue and ConversionTracker.defaultRevenueCurrencyCode. If alwaysUseDefaultRevenueValue is true, then conversion events will always use defaultRevenueValue and defaultRevenueCurrencyCode, even if the tag has supplied a value and/or code when reporting the conversion event. If alwaysUseDefaultRevenueValue is false, then defaultRevenueValue and defaultRevenueCurrencyCode are only used if the tag does not supply a value, or the tag's value is unparseable.

This field can be selected using the value "AlwaysUseDefaultRevenueValue".
This field can be filtered on.

excludeFromBidding

xsd:boolean

Whether this conversion tracker should be excluded from the "Conversions" columns in reports.

If true, the conversion tracker will not be counted towards Conversions. If false, it will be counted in Conversions. This is the default.

Either way, conversions will still be counted in the "AllConversions" columns in reports.

This field can be selected using the value "ExcludeFromBidding".
This field can be filtered on.

attributionModelType

AttributionModelType

Attribution models describing how to distribute credit for a particular conversion across potentially many prior interactions. See https://support.google.com/adwords/answer/6259715 for more information about attribution modeling in AdWords.


Enumerations
UNKNOWN
LAST_CLICK
Attributes all credit for a conversion to its last click.
FIRST_CLICK
Attributes all credit for a conversion to its first click.
LINEAR
Attributes credit for a conversion equally across all of its clicks.
TIME_DECAY
Attributes exponentially more credit for a conversion to its more recent clicks (half-life is 1 week).
U_SHAPED
Attributes 40% of the credit for a conversion to its first and last clicks. Remaining 20% is evenly distributed across all other clicks.
DATA_DRIVEN
Flexible model that uses machine learning to determine the appropriate distribution of credit among clicks.

This field can be selected using the value "AttributionModelType".

mostRecentConversionDate

xsd:string

The date of the most recent ad click that led to a conversion of this conversion type.

This date is in the advertiser's defined time zone.

This field can be selected using the value "MostRecentConversionDate".
This field is read only and will be ignored when sent to the API.

lastReceivedRequestTime

xsd:string

The last time a conversion tag for this conversion type successfully fired and was seen by AdWords. This firing event may not have been the result of an attributable conversion (ex: because the tag was fired from a browser that did not previously click an ad from the appropriate advertiser).

This datetime is in UTC, not the advertiser's time zone.

This field can be selected using the value "LastReceivedRequestTime".
This field is read only and will be ignored when sent to the API.

ConversionTracker.Type

xsd:string

Indicates that this instance is a subtype of ConversionTracker. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead.

AdWordsConversionTracker

trackingCodeType

AdWordsConversionTracker.Tr...

Tracking code to use for the conversion type.


Enumerations
WEBPAGE
The snippet that is fired as a result of a website page loading.
WEBPAGE_ONCLICK
The snippet contains a JavaScript function which fires the tag. This function is typically called from an onClick handler added to a link or button element on the page.
CLICK_TO_CALL
For embedding on a (mobile) webpage. The snippet contains a JavaScript function which fires the tag. This function is typically called from an onClick handler added to a link or button element on the page that also instructs a mobile device to dial the advertiser's phone number.

This field can be selected using the value "TrackingCodeType".
This field can be filtered on.

Send feedback about...

AdWords API
AdWords API
Need help? Visit our support page.