type CustomFieldValueError (v202502)

  • CustomFieldValueError is an error specific to editing custom field values.

  • This error is used across various services including CompanyService, CreativeService, and ProposalService.

  • It inherits from ApiError and includes fields like fieldPath, trigger, and errorString.

  • Specific reasons for this error are provided, such as CUSTOM_FIELD_NOT_FOUND, CUSTOM_FIELD_INACTIVE, and INVALID_ENTITY_TYPE.

  • An UNKNOWN reason is returned if the actual value is not exposed by the requested API version.
Service
CompanyService CreativeService CreativeSetService ForecastService LineItemCreativeAssociationService LineItemService LineItemTemplateService OrderService ProposalLineItemService ProposalService UserService
Inheritance
ApiError
▼
ApiVersionError AudienceSegmentError AuthenticationError BillingError CollectionSizeError CommonError CurrencyCodeError CustomFieldValueError DealError EntityChildrenLimitReachedE... EntityLimitReachedError ExchangeRateError FeatureError ForecastError InternalApiError InvalidUrlError LabelEntityAssociationError LineItemOperationError NotNullError NullError ParseError PermissionError PrecisionError ProgrammaticError ProposalActionError ProposalError ProposalLineItemError ProposalLineItemMakegoodError ProposalLineItemProgrammati... PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequiredCollectionError RequiredError RequiredNumberError ServerError StatementError StringFormatError StringLengthError TeamError TimeZoneError TypeError UniqueError

Errors specific to editing custom field values

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

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.

CustomFieldValueError

reason

CustomFieldValueError.Reason

The error reason represented by an enum.

Enumerations
CUSTOM_FIELD_NOT_FOUND
An attempt was made to modify or create a CustomFieldValue for a CustomField that does not exist.
CUSTOM_FIELD_INACTIVE
An attempt was made to create a new value for a custom field that is inactive.
CUSTOM_FIELD_OPTION_NOT_FOUND
An attempt was made to modify or create a CustomFieldValue corresponding to a CustomFieldOption that could not be found.
INVALID_ENTITY_TYPE
An attempt was made to modify or create a CustomFieldValue with an association to an entity of the wrong type for its field.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.