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:

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 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

field Name 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:

dist/github/src/AdWords/v201809/AdWordsApi.cs
dist/github/src/AdWords/v201809/ApiError.cs

Classes

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation