GoogleApiAdsAdWords
[ class tree: GoogleApiAdsAdWords ] [ index: GoogleApiAdsAdWords ] [ all elements ]

Class: ApiError

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

Class Overview


The API error base class that provides details about an error that occurred while processing a service request.


Variables

Methods


Child classes:

AuthenticationError
Errors returned when Authentication failed.
AuthorizationError
Errors that are thrown due to an authorization problem.
BiddingError
Represents bidding errors.
BiddingTransitionError
Bidding transition errors.
BudgetError
A list of all the error codes being used by the common budget domain package.
BulkMutateJobError
Bulk mutate job handling errors.
CampaignAdExtensionError
CampaignAdExtension errors.
CampaignCriterionError
Base error class for Campaign Criterion Service.
CampaignError
Base error class for Campaign Service.
ClientTermsError
Encapsulates the errors thrown during client terms checks for adwords.
DatabaseError
Errors that are thrown due to a database access problem.
DateError
Errors associated with invalid dates and date ranges.
DistinctError
Errors related to distinct ids or content.
EntityAccessDenied
Reports permission problems trying to access an entity.
EntityCountLimitExceeded
Signals that an entity count limit was exceeded for some level.
EntityNotFound
An id did not correspond to an entity, or it referred to an entity which does not belong to the customer.
IdError
Errors associated with the ids.
ImageError
Error class for errors associated with parsing image data.
InternalApiError
Indicates that a server-side error has occured. {@code InternalApiError}s are generally not the result of an invalid request or message sent by the client.
JobError
Job handling errors.
MediaError
Error class for media related errors.
NewEntityCreationError
Error associated with creation of new entities using com.google.ads.api.services.common.id.TempIds.
NotEmptyError
A list of all errors associated with the @NotEmpty constraints.
NotWhitelistedError
Indicates that the customer is not whitelisted for accessing the API.
NullError
Errors associated with contents not null constraint.
OperationAccessDenied
Unauthorized access errors as determined by the invoked service's access policy.
OperatorError
A list of all errors associated with the @SupportedOperators constraints.
PagingError
Error codes for pagination.
PolicyViolationError
Represents violations of a single policy by some text in a field.
QuotaCheckError
Encapsulates the errors thrown during developer quota checks.
QuotaError
Errors that are thrown if a quota limit is exceeded.
RangeError
A list of all errors associated with the Range constraint.
RateExceededError
Signals that a call failed because a measured rate exceeded.
ReadOnlyError
A list of all errors associated with the @ReadOnly constraint.
RegionCodeError
A list of all errors associated with the @RegionCode constraints.
RejectedError
The error reason represented by an enum.
RequestError
Encapsulates the generic errors thrown when there's an error with user request.
RequiredError
Errors due to missing required field.
SizeLimitError
Indicates that the number of entries in the request or response exceeds the system limit.
StatsQueryError
Represents possible error codes when querying for stats.
StringLengthError
A list of all errors associated with the @ContentsString constraint.
TargetError
A list of all the error codes being used by the common targeting package.
AdError
Base error class for Ad Service.
AdExtensionError
AdExtension errors.
AdExtensionOverrideError
AdExtensionOverride errors.
AdGroupAdError
Error information for AdGroupAdService.
AdGroupCriterionError
Base error class for Ad Group Criterion Service.
AdGroupServiceError
Represents possible error codes in AdGroupService.

Class Details

[line 973]
The API error base class that provides details about an error that occurred while processing a service request.

The OGNL field path is provided for parsers to identify the request data element that may have caused the error.




[ Top ]


Class Variables

$ApiErrorType =

[line 996]



Tags:

access:  public

Type:   string


[ Top ]

$errorString =

[line 990]



Tags:

access:  public

Type:   string


[ Top ]

$fieldPath =

[line 978]



Tags:

access:  public

Type:   string


[ Top ]

$trigger =

[line 984]



Tags:

access:  public

Type:   string


[ Top ]



Class Methods


constructor __construct [line 1046]

ApiError __construct( [ $fieldPath = NULL], [ $trigger = NULL], [ $errorString = NULL], [ $ApiErrorType = NULL])



Tags:

access:  public


Overridden in child classes as:

AuthenticationError::__construct()
AuthorizationError::__construct()
BiddingError::__construct()
BiddingTransitionError::__construct()
BudgetError::__construct()
BulkMutateJobError::__construct()
CampaignAdExtensionError::__construct()
CampaignCriterionError::__construct()
CampaignError::__construct()
ClientTermsError::__construct()
DatabaseError::__construct()
DateError::__construct()
DistinctError::__construct()
EntityAccessDenied::__construct()
EntityCountLimitExceeded::__construct()
AdGroupAdCountLimitExceeded::__construct()
AdGroupCriterionLimitExceeded::__construct()
CampaignCriterionLimitExceeded::__construct()
EntityNotFound::__construct()
IdError::__construct()
ImageError::__construct()
InternalApiError::__construct()
JobError::__construct()
MediaError::__construct()
NewEntityCreationError::__construct()
NotEmptyError::__construct()
NotWhitelistedError::__construct()
NullError::__construct()
OperationAccessDenied::__construct()
OperatorError::__construct()
PagingError::__construct()
PolicyViolationError::__construct()
CriterionPolicyError::__construct()
QuotaCheckError::__construct()
QuotaError::__construct()
RangeError::__construct()
RateExceededError::__construct()
ReadOnlyError::__construct()
RegionCodeError::__construct()
RejectedError::__construct()
RequestError::__construct()
RequiredError::__construct()
SizeLimitError::__construct()
StatsQueryError::__construct()
StringLengthError::__construct()
TargetError::__construct()
AdError::__construct()
AdExtensionError::__construct()
AdExtensionOverrideError::__construct()
AdGroupAdError::__construct()
AdGroupCriterionError::__construct()
AdGroupServiceError::__construct()

Parameters:

   $fieldPath  
   $trigger  
   $errorString  
   $ApiErrorType  

[ Top ]

method getNamespace [line 1034]

the getNamespace( )

Gets the namesapce of this class



Tags:

return:  namespace of this class
access:  public


Overridden in child classes as:

AuthenticationError::getNamespace()
Gets the namesapce of this class
AuthorizationError::getNamespace()
Gets the namesapce of this class
BiddingError::getNamespace()
Gets the namesapce of this class
BiddingTransitionError::getNamespace()
Gets the namesapce of this class
BudgetError::getNamespace()
Gets the namesapce of this class
BulkMutateJobError::getNamespace()
Gets the namesapce of this class
CampaignAdExtensionError::getNamespace()
Gets the namesapce of this class
CampaignCriterionError::getNamespace()
Gets the namesapce of this class
CampaignError::getNamespace()
Gets the namesapce of this class
ClientTermsError::getNamespace()
Gets the namesapce of this class
DatabaseError::getNamespace()
Gets the namesapce of this class
DateError::getNamespace()
Gets the namesapce of this class
DistinctError::getNamespace()
Gets the namesapce of this class
EntityAccessDenied::getNamespace()
Gets the namesapce of this class
EntityCountLimitExceeded::getNamespace()
Gets the namesapce of this class
AdGroupAdCountLimitExceeded::getNamespace()
Gets the namesapce of this class
AdGroupCriterionLimitExceeded::getNamespace()
Gets the namesapce of this class
CampaignCriterionLimitExceeded::getNamespace()
Gets the namesapce of this class
EntityNotFound::getNamespace()
Gets the namesapce of this class
IdError::getNamespace()
Gets the namesapce of this class
ImageError::getNamespace()
Gets the namesapce of this class
InternalApiError::getNamespace()
Gets the namesapce of this class
JobError::getNamespace()
Gets the namesapce of this class
MediaError::getNamespace()
Gets the namesapce of this class
NewEntityCreationError::getNamespace()
Gets the namesapce of this class
NotEmptyError::getNamespace()
Gets the namesapce of this class
NotWhitelistedError::getNamespace()
Gets the namesapce of this class
NullError::getNamespace()
Gets the namesapce of this class
OperationAccessDenied::getNamespace()
Gets the namesapce of this class
OperatorError::getNamespace()
Gets the namesapce of this class
PagingError::getNamespace()
Gets the namesapce of this class
PolicyViolationError::getNamespace()
Gets the namesapce of this class
CriterionPolicyError::getNamespace()
Gets the namesapce of this class
QuotaCheckError::getNamespace()
Gets the namesapce of this class
QuotaError::getNamespace()
Gets the namesapce of this class
RangeError::getNamespace()
Gets the namesapce of this class
RateExceededError::getNamespace()
Gets the namesapce of this class
ReadOnlyError::getNamespace()
Gets the namesapce of this class
RegionCodeError::getNamespace()
Gets the namesapce of this class
RejectedError::getNamespace()
Gets the namesapce of this class
RequestError::getNamespace()
Gets the namesapce of this class
RequiredError::getNamespace()
Gets the namesapce of this class
SizeLimitError::getNamespace()
Gets the namesapce of this class
StatsQueryError::getNamespace()
Gets the namesapce of this class
StringLengthError::getNamespace()
Gets the namesapce of this class
TargetError::getNamespace()
Gets the namesapce of this class
AdError::getNamespace()
Gets the namesapce of this class
AdExtensionError::getNamespace()
Gets the namesapce of this class
AdExtensionOverrideError::getNamespace()
Gets the namesapce of this class
AdGroupAdError::getNamespace()
Gets the namesapce of this class
AdGroupCriterionError::getNamespace()
Gets the namesapce of this class
AdGroupServiceError::getNamespace()
Gets the namesapce of this class

[ Top ]

method getParameterMap [line 1026]

array getParameterMap( )

Provided for getting non-php-standard named variables



Tags:

return:  parameter map
access:  protected


[ Top ]

method getXsiTypeName [line 1042]

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:

AuthenticationError::getXsiTypeName()
Gets the xsi:type name of this class
AuthorizationError::getXsiTypeName()
Gets the xsi:type name of this class
BiddingError::getXsiTypeName()
Gets the xsi:type name of this class
BiddingTransitionError::getXsiTypeName()
Gets the xsi:type name of this class
BudgetError::getXsiTypeName()
Gets the xsi:type name of this class
BulkMutateJobError::getXsiTypeName()
Gets the xsi:type name of this class
CampaignAdExtensionError::getXsiTypeName()
Gets the xsi:type name of this class
CampaignCriterionError::getXsiTypeName()
Gets the xsi:type name of this class
CampaignError::getXsiTypeName()
Gets the xsi:type name of this class
ClientTermsError::getXsiTypeName()
Gets the xsi:type name of this class
DatabaseError::getXsiTypeName()
Gets the xsi:type name of this class
DateError::getXsiTypeName()
Gets the xsi:type name of this class
DistinctError::getXsiTypeName()
Gets the xsi:type name of this class
EntityAccessDenied::getXsiTypeName()
Gets the xsi:type name of this class
EntityCountLimitExceeded::getXsiTypeName()
Gets the xsi:type name of this class
AdGroupAdCountLimitExceeded::getXsiTypeName()
Gets the xsi:type name of this class
AdGroupCriterionLimitExceeded::getXsiTypeName()
Gets the xsi:type name of this class
CampaignCriterionLimitExceeded::getXsiTypeName()
Gets the xsi:type name of this class
EntityNotFound::getXsiTypeName()
Gets the xsi:type name of this class
IdError::getXsiTypeName()
Gets the xsi:type name of this class
ImageError::getXsiTypeName()
Gets the xsi:type name of this class
InternalApiError::getXsiTypeName()
Gets the xsi:type name of this class
JobError::getXsiTypeName()
Gets the xsi:type name of this class
MediaError::getXsiTypeName()
Gets the xsi:type name of this class
NewEntityCreationError::getXsiTypeName()
Gets the xsi:type name of this class
NotEmptyError::getXsiTypeName()
Gets the xsi:type name of this class
NotWhitelistedError::getXsiTypeName()
Gets the xsi:type name of this class
NullError::getXsiTypeName()
Gets the xsi:type name of this class
OperationAccessDenied::getXsiTypeName()
Gets the xsi:type name of this class
OperatorError::getXsiTypeName()
Gets the xsi:type name of this class
PagingError::getXsiTypeName()
Gets the xsi:type name of this class
PolicyViolationError::getXsiTypeName()
Gets the xsi:type name of this class
CriterionPolicyError::getXsiTypeName()
Gets the xsi:type name of this class
QuotaCheckError::getXsiTypeName()
Gets the xsi:type name of this class
QuotaError::getXsiTypeName()
Gets the xsi:type name of this class
RangeError::getXsiTypeName()
Gets the xsi:type name of this class
RateExceededError::getXsiTypeName()
Gets the xsi:type name of this class
ReadOnlyError::getXsiTypeName()
Gets the xsi:type name of this class
RegionCodeError::getXsiTypeName()
Gets the xsi:type name of this class
RejectedError::getXsiTypeName()
Gets the xsi:type name of this class
RequestError::getXsiTypeName()
Gets the xsi:type name of this class
RequiredError::getXsiTypeName()
Gets the xsi:type name of this class
SizeLimitError::getXsiTypeName()
Gets the xsi:type name of this class
StatsQueryError::getXsiTypeName()
Gets the xsi:type name of this class
StringLengthError::getXsiTypeName()
Gets the xsi:type name of this class
TargetError::getXsiTypeName()
Gets the xsi:type name of this class
AdError::getXsiTypeName()
Gets the xsi:type name of this class
AdExtensionError::getXsiTypeName()
Gets the xsi:type name of this class
AdExtensionOverrideError::getXsiTypeName()
Gets the xsi:type name of this class
AdGroupAdError::getXsiTypeName()
Gets the xsi:type name of this class
AdGroupCriterionError::getXsiTypeName()
Gets the xsi:type name of this class
AdGroupServiceError::getXsiTypeName()
Gets the xsi:type name of this class

[ Top ]

method __get [line 1014]

mixed __get( $var $var)

Provided for getting non-php-standard named variables



Tags:

return:  Variable value
access:  public


Parameters:

$var   $var   Variable name to get.

[ Top ]

method __set [line 1007]

void __set( $var $var, $value $value)

Provided for setting non-php-standard named variables



Tags:

access:  public


Parameters:

$var   $var   Variable name to set
$value   $value   Value to set

[ Top ]


Documentation generated by phpDocumentor 1.4.3