Class: PolicyViolationError

Source Location: /AdWords/v201008/cm/BulkMutateJobService.php

Class Overview

ApiError
   |
   --PolicyViolationError

Represents violations of a single policy by some text in a field.

Child classes:

CriterionPolicyError: Contains the policy violations for a single BiddableAdGroupCriterion.

Inherited Variables

Class: ApiError

ApiError::$ApiErrorType
ApiError::$errorString
ApiError::$fieldPath
ApiError::$trigger

Inherited Methods

Class: ApiError

ApiError::__construct()
ApiError::getNamespace(): Gets the namesapce of this class
ApiError::getParameterMap(): Provided for getting non-php-standard named variables
ApiError::getXsiTypeName(): Gets the xsi:type name of this class
ApiError::__get(): Provided for getting non-php-standard named variables
ApiError::__set(): Provided for setting non-php-standard named variables

Class Details

[line 6412]
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.

[ Top ]

Class Variables

$externalPolicyDescription =

[line 6435]

Tags:

access:

public

Type:

string

[ Top ]

$externalPolicyName =

[line 6423]

Tags:

access:

public

Type:

string

[ Top ]

$externalPolicyUrl =

[line 6429]

Tags:

access:

public

Type:

string

[ Top ]

$isExemptable =

[line 6441]

Tags:

access:

public

Type:

boolean

[ Top ]

$key =

[line 6417]

Tags:

access:

public

Type:

PolicyViolationKey

[ Top ]

$violatingParts =

[line 6447]

Tags:

access:

public

Type:

PolicyViolationErrorPart[]

[ Top ]

Class Methods

constructor __construct [line 6465]

PolicyViolationError __construct(
[
$key = NULL], [
$externalPolicyName = NULL], [
$externalPolicyUrl = NULL], [
$externalPolicyDescription = NULL], [
$isExemptable = NULL], [
$violatingParts = NULL], [
$fieldPath = NULL], [
$trigger = NULL], [
$errorString = NULL], [
$ApiErrorType = NULL])

Parameters:

	$key
	$externalPolicyName
	$externalPolicyUrl
	$externalPolicyDescription
	$isExemptable
	$violatingParts
	$fieldPath
	$trigger
	$errorString
	$ApiErrorType

[ Top ]

method getNamespace [line 6453]

the getNamespace(
)

Gets the namesapce of this class

Tags:

return:	namespace of this class
access:	public

Overridden in child classes as:

CriterionPolicyError::getNamespace(): Gets the namesapce of this class

Overrides ApiError::getNamespace() (Gets the namesapce of this class)

[ Top ]

method getXsiTypeName [line 6461]

the getXsiTypeName(
)

Gets the xsi:type name of this class

Tags:

return:	xsi:type name of this class
access:	public

Overridden in child classes as:

CriterionPolicyError::getXsiTypeName(): Gets the xsi:type name of this class

Overrides ApiError::getXsiTypeName() (Gets the xsi:type name of this class)

[ Top ]

Documentation generated by phpDocumentor 1.4.3