ConversionTrackerService (v201809)

Use this service to manage conversion trackers. A conversion tracker provides a snippet of code which records every time a user visits a page that contains it. The data this provides can be used to gauge the effectiveness of your ads and keywords.

---

Production WSDL

https://adwords.google.com/api/adwords/cm/v201809/ConversionTrackerService?wsdl

Namespace

https://adwords.google.com/api/adwords/cm/v201809

Operations

• get
• mutate
• query

Errors

• AppPostbackUrlError
• AuthenticationError
• AuthorizationError
• ClientTermsError
• ConversionTrackingError
• DatabaseError
• DateError
• DistinctError
• IdError
• InternalApiError
• NotEmptyError
• OperationAccessDenied
• OperatorError
• QueryError
• QuotaCheckError
• RangeError
• RateExceededError
• ReadOnlyError
• RejectedError
• RequestError
• RequiredError
• SelectorError
• SizeLimitError
• StringFormatError
• StringLengthError

get

Returns a list of the conversion trackers that match the selector. The actual objects contained in the page's list of entries will be specific subclasses of the abstract ConversionTracker class.

Parameters

Field	Type	Description
serviceSelector	Selector	The selector specifying the ConversionTrackers to return.

Response

Field	Type	Description
rval	ConversionTrackerPage	List of conversion trackers specified by the selector.

mutate

Applies the list of mutate operations such as adding or updating conversion trackers.

Note: ConversionTrackerOperation does not support the REMOVE operator. In order to 'disable' a conversion type, send a SET operation for the conversion tracker with the status property set to DISABLED

You can mutate any ConversionTracker that belongs to your account. You may not mutate a ConversionTracker that belongs to some other account. You may not directly mutate a system-defined ConversionTracker, but you can create a mutable copy of it in your account by sending a mutate request with an ADD operation specifying an originalConversionTypeId matching a system-defined conversion tracker's ID. That new ADDed ConversionTracker will inherit the statistics and properties of the system-defined type, but will be editable as usual.

Parameters

Field	Type	Description
operations	ConversionTrackerOperation[]	A list of mutate operations to perform.

Response

Field	Type	Description
rval	ConversionTrackerReturnValue	The list of the conversion trackers as they appear after mutation, in the same order as they appeared in the list of operations.

query

Returns a list of conversion trackers that match the query.

Parameters

Field	Type	Description
query	xsd:string	The SQL-like AWQL query string.

Response

Field	Type	Description
rval	ConversionTrackerPage	A list of conversion trackers.

Errors

Error	Reasons
AppPostbackUrlError	Errors returned when App Postback Url is invalid. Enumerations INVALID_URL_FORMAT Invalid Url format. INVALID_DOMAIN Invalid domain. REQUIRED_MACRO_NOT_FOUND Some of the required macros were not found.
AuthenticationError	Errors returned when Authentication failed. Enumerations AUTHENTICATION_FAILED Authentication of the request failed. CLIENT_CUSTOMER_ID_IS_REQUIRED Client Customer Id is required if CustomerIdMode is set to CLIENT_EXTERNAL_CUSTOMER_ID. Starting version V201409 ClientCustomerId will be required for all requests except for CustomerService.get CLIENT_EMAIL_REQUIRED Client Email is required if CustomerIdMode is set to CLIENT_EXTERNAL_EMAIL_FIELD. CLIENT_CUSTOMER_ID_INVALID Client customer Id is not a number. CLIENT_EMAIL_INVALID Client customer Id is not a number. CLIENT_EMAIL_FAILED_TO_AUTHENTICATE Client email is not a valid customer email. CUSTOMER_NOT_FOUND No customer found for the customer id provided in the header. GOOGLE_ACCOUNT_DELETED Client's Google Account is deleted. GOOGLE_ACCOUNT_COOKIE_INVALID Google account login token in the cookie is invalid. FAILED_TO_AUTHENTICATE_GOOGLE_ACCOUNT problem occurred during Google account authentication. GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH The user in the google account login token does not match the UserId in the cookie. LOGIN_COOKIE_REQUIRED Login cookie is required for authentication. NOT_ADS_USER User in the cookie is not a valid Ads user. OAUTH_TOKEN_INVALID Oauth token in the header is not valid. OAUTH_TOKEN_EXPIRED Oauth token in the header has expired. OAUTH_TOKEN_DISABLED Oauth token in the header has been disabled. OAUTH_TOKEN_REVOKED Oauth token in the header has been revoked. OAUTH_TOKEN_HEADER_INVALID Oauth token HTTP header is malformed. LOGIN_COOKIE_INVALID Login cookie is not valid. FAILED_TO_RETRIEVE_LOGIN_COOKIE Failed to decrypt the login cookie. USER_ID_INVALID User Id in the header is not a valid id.
AuthorizationError	Errors encountered when trying to authorize a user. Enumerations UNABLE_TO_AUTHORIZE Could not complete authorization due to an internal problem. NO_ADWORDS_ACCOUNT_FOR_CUSTOMER Customer has no AdWords account. USER_PERMISSION_DENIED User doesn't have permission to access customer. EFFECTIVE_USER_PERMISSION_DENIED Effective user doesn't have permission to access this customer. CUSTOMER_NOT_ACTIVE Access denied since the customer is not active. USER_HAS_READONLY_PERMISSION User has read-only permission cannot mutate. NO_CUSTOMER_FOUND No customer found. SERVICE_ACCESS_DENIED Developer doesn't have permission to access service. TWO_STEP_VERIFICATION_NOT_ENROLLED The customer has a policy to enforce 2-Step Verification, but the user is not enrolled. ADVANCED_PROTECTION_NOT_ENROLLED The customer has a policy to enforce enrollment in the Advanced Protection Program, but the user is not enrolled.
ClientTermsError	Error due to user not accepting the AdWords terms of service. Enumerations INCOMPLETE_SIGNUP_CURRENT_ADWORDS_TNC_NOT_AGREED Customer has not agreed to the latest AdWords Terms & Conditions
ConversionTrackingError	An error that can occur during calls to the ConversionTypeService. Enumerations ALREADY_CREATED_CUSTOM_CONVERSION_TYPE An attempt to make a forked conversion type from a global conversion type was made, but there already exists a conversion type forked from this global conversion type. ANALYTICS_NOT_ALLOWED This user is not whitelisted for the import of Analytics goals and profiles, and yet requested to mutate an Analytics conversion type. CANNOT_ADD_CONVERSION_TYPE_SUBCLASS Cannot execute an ADD operation on this subclass of ConversionType (currently, only instances of AdWordsConversionType may be added). CANNOT_ADD_EXTERNALLY_ATTRIBUTED_SALESFORCE_CONVERSION Creating an upload conversion type with isExternallyAttributedConversion and isSalesforceConversion both set is not allowed. CANNOT_CHANGE_APP_CONVERSION_TYPE AppConversions cannot change app conversion types once it has been set. CANNOT_CHANGE_APP_PLATFORM AppConversions cannot change app platforms once it has been set. CANNNOT_CHANGE_CONVERSION_SUBCLASS Cannot change between subclasses of ConversionType CANNOT_SET_HIDDEN_STATUS If a conversion type's status is initially non-hidden, it may not be changed to Hidden; nor may hidden conversion types be created through the API. Hidden conversion types are typically created by backend processes. CATEGORY_IS_UNEDITABLE The user attempted to change the Category when it was uneditable. ATTRIBUTION_MODEL_IS_UNEDITABLE The attribution model of the conversion type is uneditable. ATTRIBUTION_MODEL_CANNOT_BE_UNKNOWN The attribution model of the conversion type cannot be unknown. DATA_DRIVEN_MODEL_WAS_NEVER_GENERATED The attribution model cannot be set to DATA_DRIVEN because a data-driven model has never been generated. DATA_DRIVEN_MODEL_IS_EXPIRED The attribution model cannot be set to DATA_DRIVEN because the data-driven model is expired. DATA_DRIVEN_MODEL_IS_STALE The attribution model cannot be set to DATA_DRIVEN because the data-driven model is stale. DATA_DRIVEN_MODEL_IS_UNKNOWN The attribution model cannot be set to DATA_DRIVEN because the data-driven model is unavailable or the conversion type was newly added. CONVERSION_TYPE_NOT_FOUND An attempt to access a conversion type failed because no conversion type with this ID exists for this account. CTC_LOOKBACK_WINDOW_IS_UNEDITABLE The user attempted to change the click-through conversion (ctc) lookback window when it is not editable. DOMAIN_EXCEPTION An exception occurred in the domain layer during an attempt to process a ConversionTypeOperation. INCONSISTENT_COUNTING_TYPE An attempt was made to set a counting type inconsistent with other properties. Currently, AppConversion with appConversionType = DOWNLOAD and appPlatform = ANDROID_MARKET cannot have a countingType of MANY_PER_CLICK DUPLICATE_APP_ID The user specified two identical app ids when attempting to create or modify a conversion type. TWO_CONVERSION_TYPES_BIDDING_ON_SAME_APP_DOWNLOAD The user is trying to enter a double bidding conflict. A double bidding conflict is when 2 conversion types both measure downloads for the same app ID. CONVERSION_TYPE_BIDDING_ON_SAME_APP_DOWNLOAD_AS_GLOBAL_TYPE The user is trying to enter a double bidding conflict with the global type. The conversion type being created/editied and the global type (or forked global download type) are both measuring downloads for the same app ID. DUPLICATE_NAME The user specified two identical names when attempting to create or rename multiple conversion types. EMAIL_FAILED An error occurred while the server was sending the email. EXCEEDED_CONVERSION_TYPE_LIMIT The maximum number of active conversion types for this account has been exceeded. ID_IS_NULL The user requested to modify an existing conversion type, but did not supply an ID. INVALID_APP_ID App ids must adhere to valid Java package naming requirements. CANNOT_SET_APP_ID App id can not be set to forked system-defined Android download conversion type. INVALID_CATEGORY The user attempted to set category which is not applicable to provided conversion type. INVALID_COLOR The user entered an invalid background color. The background color must be a valid HTML hex color code, such as "99ccff". INVALID_DATE_RANGE The date range specified in the stats selector is invalid. INVALID_EMAIL_ADDRESS The email address of the sender or the recipient of a snippet email was invalid. INVALID_ORIGINAL_CONVERSION_TYPE_ID Editing the settings for the system-wide default conversion trackers is not permitted in AdWords API. MUST_SET_APP_PLATFORM_AND_APP_CONVERSION_TYPE_TOGETHER The AppPlatform and AppConversionType must be set at the same time. It is an error to set just one or the other. NAME_ALREADY_EXISTS The user attempted to create a new conversion type, or to rename an existing conversion type, whose new name matches one of the other conversion types for his account. NO_RECIPIENTS The user asked to send a notification email, but specified no recipients. NO_SNIPPET The requested conversion type has no snippet, and thus its snippet email cannot be sent. TOO_MANY_WEBPAGES The requested date range contains too many webpages to be processed. UNKNOWN_SORTING_TYPE An unknown sorting type was specified in the selector. UNSUPPORTED_APP_CONVERSION_TYPE AppConversionType cannot be set to DOWNLOAD when AppPlatform is ITUNES.
DatabaseError	Errors that are thrown due to a database access problem. Enumerations CONCURRENT_MODIFICATION A concurrency problem occurred as two threads were attempting to modify same object. PERMISSION_DENIED The permission was denied to access an object. ACCESS_PROHIBITED The user's access to an object has been prohibited. CAMPAIGN_PRODUCT_NOT_SUPPORTED Requested campaign belongs to a product that is not supported by the api. DUPLICATE_KEY a duplicate key was detected upon insertion DATABASE_ERROR a database error has occurred UNKNOWN an unknown error has occurred
DateError	Errors associated with invalid dates and date ranges. Enumerations INVALID_FIELD_VALUES_IN_DATE Given field values do not correspond to a valid date. INVALID_FIELD_VALUES_IN_DATE_TIME Given field values do not correspond to a valid date time. INVALID_STRING_DATE The string date's format should be yyyymmdd. INVALID_STRING_DATE_RANGE The string date range's format should be yyyymmdd yyyymmdd. INVALID_STRING_DATE_TIME The string date time's format should be yyyymmdd hhmmss [tz]. EARLIER_THAN_MINIMUM_DATE Date is before allowed minimum. LATER_THAN_MAXIMUM_DATE Date is after allowed maximum. DATE_RANGE_MINIMUM_DATE_LATER_THAN_MAXIMUM_DATE Date range bounds are not in order. DATE_RANGE_MINIMUM_AND_MAXIMUM_DATES_BOTH_NULL Both dates in range are null.
DistinctError	Errors related to distinct ids or content. Enumerations DUPLICATE_ELEMENT DUPLICATE_TYPE
IdError	Errors associated with the ids. Enumerations NOT_FOUND Id not found
InternalApiError	Indicates that a server-side error has occured. InternalApiErrors are generally not the result of an invalid request or message sent by the client. Enumerations UNEXPECTED_INTERNAL_API_ERROR API encountered an unexpected internal error. TRANSIENT_ERROR A temporary error occurred during the request. Please retry. UNKNOWN The cause of the error is not known or only defined in newer versions. DOWNTIME The API is currently unavailable for a planned downtime. ERROR_GENERATING_RESPONSE Mutate succeeded but server was unable to build response. Client should not retry mutate.
NotEmptyError	Errors corresponding with violation of a NOT EMPTY check. Enumerations EMPTY_LIST
OperationAccessDenied	Operation not permitted due to the invoked service's access policy. Enumerations ACTION_NOT_PERMITTED Unauthorized invocation of a service's method (get, mutate, etc.) ADD_OPERATION_NOT_PERMITTED Unauthorized ADD operation in invoking a service's mutate method. REMOVE_OPERATION_NOT_PERMITTED Unauthorized REMOVE operation in invoking a service's mutate method. SET_OPERATION_NOT_PERMITTED Unauthorized SET operation in invoking a service's mutate method. MUTATE_ACTION_NOT_PERMITTED_FOR_CLIENT A mutate action is not allowed on this campaign, from this client. OPERATION_NOT_PERMITTED_FOR_CAMPAIGN_TYPE This operation is not permitted on this campaign type ADD_AS_REMOVED_NOT_PERMITTED An ADD operation may not set status to REMOVED. OPERATION_NOT_PERMITTED_FOR_REMOVED_ENTITY This operation is not allowed because the campaign or adgroup is removed. OPERATION_NOT_PERMITTED_FOR_AD_GROUP_TYPE This operation is not permitted on this ad group type. UNKNOWN The reason the invoked method or operation is prohibited is not known (the client may be of an older version than the server).
OperatorError	Errors due to the use of unsupported operations. Enumerations OPERATOR_NOT_SUPPORTED
QueryError	A QueryError represents possible errors for query parsing and execution. Enumerations PARSING_FAILED Exception that happens when trying to parse a query that doesn't match the AWQL grammar. MISSING_QUERY The provided query is an empty string. MISSING_SELECT_CLAUSE The query does not contain the required SELECT clause or it is not in the correct location. MISSING_FROM_CLAUSE The query does not contain the required FROM clause or it is not in the correct location. INVALID_SELECT_CLAUSE The SELECT clause could not be parsed. INVALID_FROM_CLAUSE The FROM clause could not be parsed. INVALID_WHERE_CLAUSE The WHERE clause could not be parsed. INVALID_ORDER_BY_CLAUSE The ORDER BY clause could not be parsed. INVALID_LIMIT_CLAUSE The LIMIT clause could not be parsed. INVALID_START_INDEX_IN_LIMIT_CLAUSE The startIndex in the LIMIT clause does not contain a valid integer. INVALID_PAGE_SIZE_IN_LIMIT_CLAUSE The pageSize in the LIMIT clause does not contain a valid integer. INVALID_DURING_CLAUSE The DURING clause could not be parsed. INVALID_MIN_DATE_IN_DURING_CLAUSE The minimum date in the DURING clause is not a valid date in YYYYMMDD format. INVALID_MAX_DATE_IN_DURING_CLAUSE The maximum date in the DURING clause is not a valid date in YYYYMMDD format. MAX_LESS_THAN_MIN_IN_DURING_CLAUSE The minimum date in the DURING is after the maximum date. VALIDATION_FAILED The query matched the grammar, but is invalid in some way such as using a service that isn't supported.
QuotaCheckError	Encapsulates the errors thrown during developer quota checks. Enumerations INVALID_TOKEN_HEADER Customer passed in an invalid token in the header. ACCOUNT_DELINQUENT Customer is marked delinquent. ACCOUNT_INACCESSIBLE Customer is a fraudulent. ACCOUNT_INACTIVE Inactive Account. INCOMPLETE_SIGNUP Signup not complete DEVELOPER_TOKEN_NOT_APPROVED Developer token is not approved for production access, and the customer is attempting to access a production account. TERMS_AND_CONDITIONS_NOT_SIGNED Terms and conditions are not signed. MONTHLY_BUDGET_REACHED Monthly budget quota reached. QUOTA_EXCEEDED Monthly budget quota exceeded.
RangeError	A list of all errors associated with the Range constraint. Enumerations TOO_LOW TOO_HIGH
RateExceededError	Signals that a call failed because a measured rate exceeded. Enumerations RATE_EXCEEDED Rate exceeded.
ReadOnlyError	Errors from attempting to write to read-only fields. Enumerations READ_ONLY
RejectedError	Indicates that a field was rejected due to compatibility issues. Enumerations UNKNOWN_VALUE Unknown value encountered
RequestError	Encapsulates the generic errors thrown when there's an error with user request. Enumerations UNKNOWN Error reason is unknown. INVALID_INPUT Invalid input. UNSUPPORTED_VERSION The api version in the request has been discontinued. Please update to the new AdWords API version.
RequiredError	Errors due to missing required field. Enumerations REQUIRED Missing required field.
SelectorError	Represents possible error codes for Selector. Enumerations INVALID_FIELD_NAME The field name is not valid. MISSING_FIELDS The list of fields is null or empty. MISSING_PREDICATES The list of predicates is null or empty. OPERATOR_DOES_NOT_SUPPORT_MULTIPLE_VALUES Predicate operator does not support multiple values. Multiple values are supported only for Predicate.Operator.IN and Predicate.Operator.NOT_IN. INVALID_PREDICATE_ENUM_VALUE The predicate enum value is not valid. MISSING_PREDICATE_OPERATOR The predicate operator is empty. MISSING_PREDICATE_VALUES The predicate values are empty. INVALID_PREDICATE_FIELD_NAME The predicate field name is not valid. INVALID_PREDICATE_OPERATOR The predicate operator is not valid. INVALID_FIELD_SELECTION Invalid selection of fields. INVALID_PREDICATE_VALUE The predicate value is not valid. INVALID_SORT_FIELD_NAME The sort field name is not valid or the field is not sortable. SELECTOR_ERROR Standard error. FILTER_BY_DATE_RANGE_NOT_SUPPORTED Filtering by date range is not supported. START_INDEX_IS_TOO_HIGH Selector paging start index is too high. TOO_MANY_PREDICATE_VALUES The values list in a predicate was too long. UNKNOWN_ERROR
SizeLimitError	Indicates that the number of entries in the request or response exceeds the system limit. Enumerations REQUEST_SIZE_LIMIT_EXCEEDED The number of entries in the request exceeds the system limit. RESPONSE_SIZE_LIMIT_EXCEEDED The number of entries in the response exceeds the system limit. INTERNAL_STORAGE_ERROR The account is too large to load. UNKNOWN
StringFormatError	A list of error code for reporting invalid content of input strings. Enumerations UNKNOWN ILLEGAL_CHARS The input string value contains disallowed characters. INVALID_FORMAT The input string value is invalid for the associated field.
StringLengthError	Errors associated with the length of the given string being out of bounds. Enumerations TOO_SHORT TOO_LONG