Docs For Class awPolicyViolationError

Description

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.

copyright: Mirchev Ideas Ltd. © 2011
link: http://code.google.com/apis/adwords/docs/reference/v201109/TargetingIdeaService.PolicyViolationError.html

Located in /classes/cm/PolicyViolationError.php

awComplexObject
   |
   --awApiError
      |
      --awPolicyViolationError

Direct descendents

Class	Description
awCriterionPolicyError	Contains the policy violations for a single BiddableAdGroupCriterion.
awAdParamPolicyError	Policy violation for an AdParam.

Variable Summary

string $externalPolicyDescription

string $externalPolicyName

string $externalPolicyUrl

bool $isExemptable

awPolicyViolationKey $key

awPolicyViolationError_Part[] $violatingParts

mixed $_checkFields

Method Summary

void getRow ()

Variables

string $externalPolicyDescription

Localized description of the violation.

string $externalPolicyName

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

string $externalPolicyUrl

Url with writeup about the policy.

bool $isExemptable

Whether user can file an exemption request for this violation.

awPolicyViolationKey $key

Unique identifier for the violation.

awPolicyViolationError_Part[] $violatingParts

Lists the parts that violate the policy.

mixed $_checkFields = array(
'key' => array(
'objName' => 'awPolicyViolationKey',
'type' => 'obj'
),'violatingParts'=>array('objName'=>'awPolicyViolationError_Part','type'=>'array'),)

access: public

Redefinition of:

awComplexObject::$_checkFields

Inherited Variables

Inherited from awApiError

awApiError::$errorString
awApiError::$fieldPath
awApiError::$trigger

Inherited from awComplexObject

awComplexObject::$_cachedCheckFields
awComplexObject::$_row

Methods

access: public

void getRow ()

Redefinition of:

awComplexObject::getRow()

Redefined in descendants as:

Inherited Methods

Inherited From awApiError

awApiError::factory()

Inherited From awComplexObject

awComplexObject::__construct()
awComplexObject::factory()
awComplexObject::get()
awComplexObject::getAsObj()
awComplexObject::getCheckFields()
awComplexObject::getRow()
awComplexObject::getSoapVars()
awComplexObject::getXml()
awComplexObject::isEmpty()
awComplexObject::remove()
awComplexObject::set()
awComplexObject::setRow()