Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdWords.v201809.ConversionTracker Class Reference

An abstract Conversion base class. More...

Inheritance diagram for Google.Api.Ads.AdWords.v201809.ConversionTracker:
Google.Api.Ads.AdWords.v201809.AdCallMetricsConversion Google.Api.Ads.AdWords.v201809.AdWordsConversionTracker Google.Api.Ads.AdWords.v201809.AppConversion Google.Api.Ads.AdWords.v201809.UploadCallConversion Google.Api.Ads.AdWords.v201809.UploadConversion Google.Api.Ads.AdWords.v201809.WebsiteCallMetricsConversion

Classes

class  Fields
 List of all supported fields for the ConversionTracker class. More...
 
class  FilterableFields
 List of all supported filterable fields for the ConversionTracker class. More...
 
class  SelectableFields
 List of all supported selectable fields for the ConversionTracker class. More...
 

Properties

long id [get, set]
 ID of this conversion tracker, More...
 
bool idSpecified [get, set]
 
long originalConversionTypeId [get, set]
 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. More...
 
bool originalConversionTypeIdSpecified [get, set]
 
string name [get, set]
 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 More...
 
ConversionTrackerStatus status [get, set]
 Status of this conversion tracker. This field can be selected using the value "Status".This field can be filtered on. More...
 
bool statusSpecified [get, set]
 
ConversionTrackerCategory category [get, set]
 The category of conversion that is being tracked. This field can be selected using the value "Category".This field can be filtered on. More...
 
bool categorySpecified [get, set]
 
string googleEventSnippet [get, set]
 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. More...
 
string googleGlobalSiteTag [get, set]
 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. More...
 
DataDrivenModelStatus dataDrivenModelStatus [get, set]
 The status of the data-driven attribution model for the conversion type. 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. More...
 
bool dataDrivenModelStatusSpecified [get, set]
 
long conversionTypeOwnerCustomerId [get, set]
 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. More...
 
bool conversionTypeOwnerCustomerIdSpecified [get, set]
 
int viewthroughLookbackWindow [get, set]
 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. More...
 
bool viewthroughLookbackWindowSpecified [get, set]
 
int ctcLookbackWindow [get, set]
 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. More...
 
bool ctcLookbackWindowSpecified [get, set]
 
ConversionDeduplicationMode countingType [get, set]
 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 This field can be selected using the value "CountingType".This field can be filtered on. More...
 
bool countingTypeSpecified [get, set]
 
double defaultRevenueValue [get, set]
 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. More...
 
bool defaultRevenueValueSpecified [get, set]
 
string defaultRevenueCurrencyCode [get, set]
 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. More...
 
bool alwaysUseDefaultRevenueValue [get, set]
 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. More...
 
bool alwaysUseDefaultRevenueValueSpecified [get, set]
 
bool excludeFromBidding [get, set]
 Whether this conversion tracker should be excluded from the "Conversions" columns in reports. More...
 
bool excludeFromBiddingSpecified [get, set]
 
AttributionModelType attributionModelType [get, set]
 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. This field can be selected using the value "AttributionModelType". More...
 
bool attributionModelTypeSpecified [get, set]
 
string mostRecentConversionDate [get, set]
 The date of the most recent ad click that led to a conversion of this conversion type. More...
 
string lastReceivedRequestTime [get, set]
 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). More...
 
string ConversionTrackerType [get, set]
 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. More...
 

Detailed Description

An abstract Conversion base class.

Property Documentation

bool Google.Api.Ads.AdWords.v201809.ConversionTracker.alwaysUseDefaultRevenueValue
getset

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.

bool Google.Api.Ads.AdWords.v201809.ConversionTracker.alwaysUseDefaultRevenueValueSpecified
getset

true, if a value is specified for alwaysUseDefaultRevenueValue, false otherwise.

AttributionModelType Google.Api.Ads.AdWords.v201809.ConversionTracker.attributionModelType
getset

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. This field can be selected using the value "AttributionModelType".

bool Google.Api.Ads.AdWords.v201809.ConversionTracker.attributionModelTypeSpecified
getset

true, if a value is specified for attributionModelType, false otherwise.

ConversionTrackerCategory Google.Api.Ads.AdWords.v201809.ConversionTracker.category
getset

The category of conversion that is being tracked. This field can be selected using the value "Category".This field can be filtered on.

bool Google.Api.Ads.AdWords.v201809.ConversionTracker.categorySpecified
getset

true, if a value is specified for category, false otherwise.

string Google.Api.Ads.AdWords.v201809.ConversionTracker.ConversionTrackerType
getset

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.

long Google.Api.Ads.AdWords.v201809.ConversionTracker.conversionTypeOwnerCustomerId
getset

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.

bool Google.Api.Ads.AdWords.v201809.ConversionTracker.conversionTypeOwnerCustomerIdSpecified
getset

true, if a value is specified for conversionTypeOwnerCustomerId, false otherwise.

ConversionDeduplicationMode Google.Api.Ads.AdWords.v201809.ConversionTracker.countingType
getset

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 This field can be selected using the value "CountingType".This field can be filtered on.

bool Google.Api.Ads.AdWords.v201809.ConversionTracker.countingTypeSpecified
getset

true, if a value is specified for countingType, false otherwise.

int Google.Api.Ads.AdWords.v201809.ConversionTracker.ctcLookbackWindow
getset

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.

bool Google.Api.Ads.AdWords.v201809.ConversionTracker.ctcLookbackWindowSpecified
getset

true, if a value is specified for ctcLookbackWindow, false otherwise.

DataDrivenModelStatus Google.Api.Ads.AdWords.v201809.ConversionTracker.dataDrivenModelStatus
getset

The status of the data-driven attribution model for the conversion type. 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.

bool Google.Api.Ads.AdWords.v201809.ConversionTracker.dataDrivenModelStatusSpecified
getset

true, if a value is specified for dataDrivenModelStatus, false otherwise.

string Google.Api.Ads.AdWords.v201809.ConversionTracker.defaultRevenueCurrencyCode
getset

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.

double Google.Api.Ads.AdWords.v201809.ConversionTracker.defaultRevenueValue
getset

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.

bool Google.Api.Ads.AdWords.v201809.ConversionTracker.defaultRevenueValueSpecified
getset

true, if a value is specified for defaultRevenueValue, false otherwise.

bool Google.Api.Ads.AdWords.v201809.ConversionTracker.excludeFromBidding
getset

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.

bool Google.Api.Ads.AdWords.v201809.ConversionTracker.excludeFromBiddingSpecified
getset

true, if a value is specified for excludeFromBidding, false otherwise.

string Google.Api.Ads.AdWords.v201809.ConversionTracker.googleEventSnippet
getset

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.

string Google.Api.Ads.AdWords.v201809.ConversionTracker.googleGlobalSiteTag
getset

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.

long Google.Api.Ads.AdWords.v201809.ConversionTracker.id
getset

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.

bool Google.Api.Ads.AdWords.v201809.ConversionTracker.idSpecified
getset

true, if a value is specified for id, false otherwise.

string Google.Api.Ads.AdWords.v201809.ConversionTracker.lastReceivedRequestTime
getset

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.

string Google.Api.Ads.AdWords.v201809.ConversionTracker.mostRecentConversionDate
getset

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.

string Google.Api.Ads.AdWords.v201809.ConversionTracker.name
getset

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.

long Google.Api.Ads.AdWords.v201809.ConversionTracker.originalConversionTypeId
getset

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.

bool Google.Api.Ads.AdWords.v201809.ConversionTracker.originalConversionTypeIdSpecified
getset

true, if a value is specified for originalConversionTypeId, false otherwise.

ConversionTrackerStatus Google.Api.Ads.AdWords.v201809.ConversionTracker.status
getset

Status of this conversion tracker. This field can be selected using the value "Status".This field can be filtered on.

bool Google.Api.Ads.AdWords.v201809.ConversionTracker.statusSpecified
getset

true, if a value is specified for status, false otherwise.

int Google.Api.Ads.AdWords.v201809.ConversionTracker.viewthroughLookbackWindow
getset

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.

bool Google.Api.Ads.AdWords.v201809.ConversionTracker.viewthroughLookbackWindowSpecified
getset

true, if a value is specified for viewthroughLookbackWindow, false otherwise.


The documentation for this class was generated from the following file: