com.google.api.ads.adwords.jaxws.v201809.cm

Class PolicyViolationError

java.lang.Object

com.google.api.ads.adwords.jaxws.v201809.cm.ApiError

com.google.api.ads.adwords.jaxws.v201809.cm.PolicyViolationError

Direct Known Subclasses:

AdParamPolicyError, CriterionPolicyError

public class PolicyViolationError
extends ApiError

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 instance 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.

Java class for PolicyViolationError complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="PolicyViolationError">
   <complexContent>
     <extension base="{https://adwords.google.com/api/adwords/cm/v201809}ApiError">
       <sequence>
         <element name="key" type="{https://adwords.google.com/api/adwords/cm/v201809}PolicyViolationKey" minOccurs="0"/>
         <element name="externalPolicyName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="externalPolicyUrl" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="externalPolicyDescription" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="isExemptable" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="violatingParts" type="{https://adwords.google.com/api/adwords/cm/v201809}PolicyViolationError.Part" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected String	externalPolicyDescription
protected String	externalPolicyName
protected String	externalPolicyUrl
protected Boolean	isExemptable
protected PolicyViolationKey	key
protected List<PolicyViolationErrorPart>	violatingParts

Fields inherited from class com.google.api.ads.adwords.jaxws.v201809.cm.ApiError

apiErrorType, errorString, fieldPath, fieldPathElements, trigger

Constructor Summary

Constructors

Constructor and Description
PolicyViolationError()

Method Summary

Modifier and Type	Method and Description
String	getExternalPolicyDescription() Gets the value of the externalPolicyDescription property.
String	getExternalPolicyName() Gets the value of the externalPolicyName property.
String	getExternalPolicyUrl() Gets the value of the externalPolicyUrl property.
PolicyViolationKey	getKey() Gets the value of the key property.
List<PolicyViolationErrorPart>	getViolatingParts() Gets the value of the violatingParts property.
Boolean	isIsExemptable() Gets the value of the isExemptable property.
void	setExternalPolicyDescription(String value) Sets the value of the externalPolicyDescription property.
void	setExternalPolicyName(String value) Sets the value of the externalPolicyName property.
void	setExternalPolicyUrl(String value) Sets the value of the externalPolicyUrl property.
void	setIsExemptable(Boolean value) Sets the value of the isExemptable property.
void	setKey(PolicyViolationKey value) Sets the value of the key property.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

key

protected PolicyViolationKey key

externalPolicyName

protected String externalPolicyName

externalPolicyUrl

protected String externalPolicyUrl

externalPolicyDescription

protected String externalPolicyDescription

isExemptable

protected Boolean isExemptable

violatingParts

protected List<PolicyViolationErrorPart> violatingParts

Constructor Detail

PolicyViolationError

public PolicyViolationError()

Method Detail

getKey

public PolicyViolationKey getKey()

Gets the value of the key property.

Returns:

possible object is PolicyViolationKey

setKey

public void setKey(PolicyViolationKey value)

Sets the value of the key property.

Parameters:

value - allowed object is PolicyViolationKey

getExternalPolicyName

public String getExternalPolicyName()

Gets the value of the externalPolicyName property.

Returns:

possible object is String

setExternalPolicyName

public void setExternalPolicyName(String value)

Sets the value of the externalPolicyName property.

Parameters:

value - allowed object is String

getExternalPolicyUrl

public String getExternalPolicyUrl()

Gets the value of the externalPolicyUrl property.

Returns:

possible object is String

setExternalPolicyUrl

public void setExternalPolicyUrl(String value)

Sets the value of the externalPolicyUrl property.

Parameters:

value - allowed object is String

getExternalPolicyDescription

public String getExternalPolicyDescription()

Gets the value of the externalPolicyDescription property.

Returns:

possible object is String

setExternalPolicyDescription

public void setExternalPolicyDescription(String value)

Sets the value of the externalPolicyDescription property.

Parameters:

value - allowed object is String

isIsExemptable

public Boolean isIsExemptable()

Gets the value of the isExemptable property.

Returns:

possible object is Boolean

setIsExemptable

public void setIsExemptable(Boolean value)

Sets the value of the isExemptable property.

Parameters:

value - allowed object is Boolean

getViolatingParts

public List<PolicyViolationErrorPart> getViolatingParts()

Gets the value of the violatingParts property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the violatingParts property.

For example, to add a new item, do as follows:

    getViolatingParts().add(newItem);
 

Objects of the following type(s) are allowed in the list PolicyViolationErrorPart