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.
| Field | Type | Description |
|---|---|---|
ApiError (inherited) |
||
| fieldPath |
xsd:string
|
The OGNL field path to identify cause of error. |
| trigger |
xsd:string
|
The data that caused the error. |
| ApiError.Type |
xsd:string
|
This field indicates the subtype of ApiError of this instance. It is ignored on input, and instead xsi:type should be specified. |
PolicyViolationError |
||
| key |
PolicyViolationKey
|
Unique identifier for the violation. |
| externalPolicyName |
xsd:string
|
Name of policy suitable for display to users. In the user's preferred language. |
| externalPolicyUrl |
xsd:string
|
Url with writeup about the policy. |
| externalPolicyDescription |
xsd:string
|
Localized description of the violation. |
| isExemptable |
xsd:boolean
|
Whether user can file an exemption request for this violation. |
| violatingParts |
PolicyViolationError.Part[]
|
Lists the parts that violate the policy. |
|
