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

Class ApiError

java.lang.Object

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

Direct Known Subclasses:

AdCampaignAdSubProductTypeError, AdCustomizerError, AdCustomizerFeedError, AdError, AdGroupAdError, AdGroupCriterionError, AdGroupFeedError, AdGroupServiceError, AdParamError, AdSharingError, AdxError, AppPostbackUrlError, AssetError, AssetLinkError, AudioError, AuthenticationError, AuthorizationError, BatchJobError, BatchJobProcessingError, BiddingErrors, BiddingStrategyError, BudgetError, BudgetOrderError, CampaignBidModifierError, CampaignCriterionError, CampaignError, CampaignFeedError, CampaignGroupError, CampaignGroupPerformanceTargetError, CampaignPreferenceError, CampaignSharedSetError, ClientTermsError, CollectionSizeError, ConversionTrackingError, CriterionError, CriterionError, CurrencyCodeError, CurrencyCodeError, CurrencyCodeError, CurrencyCodeError, CustomAffinityError, CustomerError, CustomerFeedError, CustomerNegativeCriterionError, CustomerOrderLineError, CustomerSyncError, DatabaseError, DataError, DateError, DateRangeError, DistinctError, DraftError, EntityAccessDenied, EntityCountLimitExceeded, EntityNotFound, ExtensionSettingError, FeedAttributeReferenceError, FeedError, FeedItemError, FeedItemTargetError, FeedMappingError, ForwardCompatibilityError, FunctionError, FunctionParsingError, IdError, ImageError, InternalApiError, LabelError, LabelServiceError, ListError, LocationCriterionServiceError, ManagedCustomerServiceError, MediaBundleError, MediaError, MediaUploadError, MultiplierError, MutateMembersError, NewEntityCreationError, NotEmptyError, NotWhitelistedError, NullError, OfflineCallConversionError, OfflineConversionAdjustmentError, OfflineConversionError, OfflineDataUploadError, OperationAccessDenied, OperatorError, PagingError, PerformanceTargetError, PolicyFindingError, PolicyViolationError, PolicyViolationError, QueryError, QuotaCheckError, RangeError, RateExceededError, ReadOnlyError, RegionCodeError, RejectedError, ReportDefinitionError, RequestError, RequiredError, SelectorError, SettingError, SharedCriterionError, SharedSetError, SizeLimitError, StatsQueryError, StringFormatError, StringLengthError, TargetingIdeaError, TaskExecutionError, TrafficEstimatorError, TrialError, UrlError, UserListError, VideoError, YouTubeAdVideoRegistrationError

public abstract class ApiError
extends Object

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.

Java class for ApiError complex type.

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

 <complexType name="ApiError">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="fieldPath" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="fieldPathElements" type="{https://adwords.google.com/api/adwords/cm/v201809}FieldPathElement" maxOccurs="unbounded" minOccurs="0"/>
         <element name="trigger" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="errorString" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ApiError.Type" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected String	apiErrorType
protected String	errorString
protected String	fieldPath
protected List<FieldPathElement>	fieldPathElements
protected String	trigger

Constructor Summary

Constructors

Constructor and Description
ApiError()

Method Summary

Modifier and Type	Method and Description
String	getApiErrorType() Gets the value of the apiErrorType property.
String	getErrorString() Gets the value of the errorString property.
String	getFieldPath() Gets the value of the fieldPath property.
List<FieldPathElement>	getFieldPathElements() Gets the value of the fieldPathElements property.
String	getTrigger() Gets the value of the trigger property.
void	setApiErrorType(String value) Sets the value of the apiErrorType property.
void	setErrorString(String value) Sets the value of the errorString property.
void	setFieldPath(String value) Sets the value of the fieldPath property.
void	setTrigger(String value) Sets the value of the trigger property.

Methods inherited from class java.lang.Object

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

Field Detail

fieldPath

protected String fieldPath

fieldPathElements

protected List<FieldPathElement> fieldPathElements

trigger

protected String trigger

errorString

protected String errorString

apiErrorType

protected String apiErrorType

Constructor Detail

ApiError

public ApiError()

Method Detail

getFieldPath

public String getFieldPath()

Gets the value of the fieldPath property.

Returns:

possible object is String

setFieldPath

public void setFieldPath(String value)

Sets the value of the fieldPath property.

Parameters:

value - allowed object is String

getFieldPathElements

public List<FieldPathElement> getFieldPathElements()

Gets the value of the fieldPathElements 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 fieldPathElements property.

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

    getFieldPathElements().add(newItem);
 

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

getTrigger

public String getTrigger()

Gets the value of the trigger property.

Returns:

possible object is String

setTrigger

public void setTrigger(String value)

Sets the value of the trigger property.

Parameters:

value - allowed object is String

getErrorString

public String getErrorString()

Gets the value of the errorString property.

Returns:

possible object is String

setErrorString

public void setErrorString(String value)

Sets the value of the errorString property.

Parameters:

value - allowed object is String

getApiErrorType

public String getApiErrorType()

Gets the value of the apiErrorType property.

Returns:

possible object is String

setApiErrorType

public void setApiErrorType(String value)

Sets the value of the apiErrorType property.

Parameters:

value - allowed object is String