Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdWords.v201809.ApiError Class Reference

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

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

Classes

class  Fields
 List of all supported fields for the ApiError class. More...
 
class  FilterableFields
 List of all supported filterable fields for the ApiError class. More...
 
class  SelectableFields
 List of all supported selectable fields for the ApiError class. More...
 

Public Member Functions

int GetOperationIndex ()
 Gets the index of the operation. More...
 
int GetFieldPathIndex (string field)
 Gets the index of a field in a field path expression. More...
 
override string ToString ()
 Returns a System.String that represents this instance. More...
 

Properties

string fieldPath [get, set]
 The OGNL field path to identify cause of error. More...
 
FieldPathElement[] fieldPathElements [get, set]
 A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}. More...
 
string trigger [get, set]
 The data that caused the error. More...
 
string errorString [get, set]
 A simple string representation of the error and reason. More...
 
string ApiErrorType [get, set]
 Indicates that this instance is a subtype of ApiError. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead. More...
 

Detailed Description

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

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.

Member Function Documentation

int Google.Api.Ads.AdWords.v201809.ApiError.GetFieldPathIndex ( string  field)
inline

Gets the index of a field in a field path expression.

Parameters
fieldName of the field to search for.
Returns
Index of the field name in the field path, or -1 if the index cannot be determined.

References Google.Api.Ads.AdWords.v201809.FieldPathElement.field, and Google.Api.Ads.AdWords.v201809.FieldPathElement.indexSpecified.

int Google.Api.Ads.AdWords.v201809.ApiError.GetOperationIndex ( )
inline

Gets the index of the operation.

Returns
Index of the operation that caused this error, or -1 if the index cannot be determined.
override string Google.Api.Ads.AdWords.v201809.ApiError.ToString ( )
inline

Returns a System.String that represents this instance.

Returns
A System.String that represents this instance.

Property Documentation

string Google.Api.Ads.AdWords.v201809.ApiError.ApiErrorType
getset

Indicates that this instance is a subtype of ApiError. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead.

string Google.Api.Ads.AdWords.v201809.ApiError.errorString
getset

A simple string representation of the error and reason.

string Google.Api.Ads.AdWords.v201809.ApiError.fieldPath
getset

The OGNL field path to identify cause of error.

FieldPathElement [] Google.Api.Ads.AdWords.v201809.ApiError.fieldPathElements
getset

A parsed copy of the field path. For example, the field path "operations[1].operand" corresponds to this list: {FieldPathElement(field = "operations", index = 1), FieldPathElement(field = "operand", index = null)}.

string Google.Api.Ads.AdWords.v201809.ApiError.trigger
getset

The data that caused the error.


The documentation for this class was generated from the following files: