com.google.api.ads.adwords.v201109.cm
Class PolicyViolationError

java.lang.Object
  com.google.api.ads.adwords.v201109.cm.ApiError
      com.google.api.ads.adwords.v201109.cm.PolicyViolationError

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AdParamPolicyError, CriterionPolicyError

public class PolicyViolationError
extends ApiError
implements Serializable

Represents violations of a single policy by some text in a field. Violations of a single policy by the same string in multiple places within a field is reported in one instace of this class and only one exemption needs to be filed. Violations of a single policy by two different strings is reported as two separate instances of this class. e.g. If 'ACME' violates 'capitalization' and occurs twice in a text ad it would be represented by one instance. If the ad also contains 'INC' which also violates 'capitalization' it would be represented in a separate instance.

See Also:

Serialized Form

Constructor Summary

PolicyViolationError()

PolicyViolationError(String fieldPath, String trigger, String errorString, String apiErrorType, PolicyViolationKey key, String externalPolicyName, String externalPolicyUrl, String externalPolicyDescription, Boolean isExemptable, PolicyViolationErrorPart[] violatingParts)

Method Summary

boolean	equals(Object obj)
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
String	getExternalPolicyDescription() Gets the externalPolicyDescription value for this PolicyViolationError.
String	getExternalPolicyName() Gets the externalPolicyName value for this PolicyViolationError.
String	getExternalPolicyUrl() Gets the externalPolicyUrl value for this PolicyViolationError.
Boolean	getIsExemptable() Gets the isExemptable value for this PolicyViolationError.
PolicyViolationKey	getKey() Gets the key value for this PolicyViolationError.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
PolicyViolationErrorPart[]	getViolatingParts() Gets the violatingParts value for this PolicyViolationError.
PolicyViolationErrorPart	getViolatingParts(int i)
int	hashCode()
void	setExternalPolicyDescription(String externalPolicyDescription) Sets the externalPolicyDescription value for this PolicyViolationError.
void	setExternalPolicyName(String externalPolicyName) Sets the externalPolicyName value for this PolicyViolationError.
void	setExternalPolicyUrl(String externalPolicyUrl) Sets the externalPolicyUrl value for this PolicyViolationError.
void	setIsExemptable(Boolean isExemptable) Sets the isExemptable value for this PolicyViolationError.
void	setKey(PolicyViolationKey key) Sets the key value for this PolicyViolationError.
void	setViolatingParts(int i, PolicyViolationErrorPart _value)
void	setViolatingParts(PolicyViolationErrorPart[] violatingParts) Sets the violatingParts value for this PolicyViolationError.

Methods inherited from class com.google.api.ads.adwords.v201109.cm.ApiError

getApiErrorType, getErrorString, getFieldPath, getTrigger, setApiErrorType, setErrorString, setFieldPath, setTrigger

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PolicyViolationError

public PolicyViolationError()

PolicyViolationError

public PolicyViolationError(String fieldPath,
                            String trigger,
                            String errorString,
                            String apiErrorType,
                            PolicyViolationKey key,
                            String externalPolicyName,
                            String externalPolicyUrl,
                            String externalPolicyDescription,
                            Boolean isExemptable,
                            PolicyViolationErrorPart[] violatingParts)

Method Detail

getKey

public PolicyViolationKey getKey()

Gets the key value for this PolicyViolationError.

Returns:

key * Unique identifier for the violation.

setKey

public void setKey(PolicyViolationKey key)

Sets the key value for this PolicyViolationError.

Parameters:

key - * Unique identifier for the violation.

getExternalPolicyName

public String getExternalPolicyName()

Gets the externalPolicyName value for this PolicyViolationError.

Returns:

externalPolicyName * Name of policy suitable for display to users. In the user's preferred language.

setExternalPolicyName

public void setExternalPolicyName(String externalPolicyName)

Sets the externalPolicyName value for this PolicyViolationError.

Parameters:

externalPolicyName - * Name of policy suitable for display to users. In the user's preferred language.

getExternalPolicyUrl

public String getExternalPolicyUrl()

Gets the externalPolicyUrl value for this PolicyViolationError.

Returns:

externalPolicyUrl * Url with writeup about the policy.

setExternalPolicyUrl

public void setExternalPolicyUrl(String externalPolicyUrl)

Sets the externalPolicyUrl value for this PolicyViolationError.

Parameters:

externalPolicyUrl - * Url with writeup about the policy.

getExternalPolicyDescription

public String getExternalPolicyDescription()

Gets the externalPolicyDescription value for this PolicyViolationError.

Returns:

externalPolicyDescription * Localized description of the violation.

setExternalPolicyDescription

public void setExternalPolicyDescription(String externalPolicyDescription)

Sets the externalPolicyDescription value for this PolicyViolationError.

Parameters:

externalPolicyDescription - * Localized description of the violation.

getIsExemptable

public Boolean getIsExemptable()

Gets the isExemptable value for this PolicyViolationError.

Returns:

isExemptable * Whether user can file an exemption request for this violation.

setIsExemptable

public void setIsExemptable(Boolean isExemptable)

Sets the isExemptable value for this PolicyViolationError.

Parameters:

isExemptable - * Whether user can file an exemption request for this violation.

getViolatingParts

public PolicyViolationErrorPart[] getViolatingParts()

Gets the violatingParts value for this PolicyViolationError.

Returns:

violatingParts * Lists the parts that violate the policy.

setViolatingParts

public void setViolatingParts(PolicyViolationErrorPart[] violatingParts)

Sets the violatingParts value for this PolicyViolationError.

Parameters:

violatingParts - * Lists the parts that violate the policy.

getViolatingParts

public PolicyViolationErrorPart getViolatingParts(int i)

setViolatingParts

public void setViolatingParts(int i,
                              PolicyViolationErrorPart _value)

equals

public boolean equals(Object obj)

Overrides:

equals in class ApiError

hashCode

public int hashCode()

Overrides:

hashCode in class ApiError

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                                Class _javaType,
                                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                                    Class _javaType,
                                                                    QName _xmlType)

Get Custom Deserializer