type CustomFieldError (v202508)

  • CustomFieldService is associated with various types of API errors including authentication, size, common, and feature errors.

  • CustomFieldError is specifically related to errors encountered when editing custom fields.

  • The ApiError includes fields such as fieldPath, fieldPathElements, trigger, and errorString to help identify the cause of an error.

  • The CustomFieldError includes a reason field with specific enumerations like INVALID_CUSTOM_FIELD_FOR_OPTION and UNKNOWN explaining the error reason.
Service
CustomFieldService
Inheritance
ApiError
▼
ApiVersionError AuthenticationError CollectionSizeError CommonError CustomFieldError EntityLimitReachedError FeatureError InternalApiError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError TypeError UniqueError

Errors specific to editing custom fields

Namespace
https://www.google.com/apis/ads/publisher/v202508

Field
ApiError (inherited)

fieldPath

xsd:string

The OGNL field path to identify cause of error.

fieldPathElements

FieldPathElement[]

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)}.

trigger

xsd:string

The data that caused the error.

errorString

xsd:string

A simple string representation of the error and reason.

CustomFieldError

reason

CustomFieldError.Reason

The error reason represented by an enum.

Enumerations
INVALID_CUSTOM_FIELD_FOR_OPTION
An attempt was made to create a CustomFieldOption for a CustomField that does not have CustomFieldDataType.DROPDOWN.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.