Looking for a REST API? The Ad Manager API (Beta) is now available.

type CustomFieldValueError (v202502)

AI-generated Key Takeaways

CustomFieldValueError is an error specific to editing custom field values.
This error can be caused by a custom field not being found, being inactive, or having an invalid associated entity type.
The error provides details like the field path, trigger data, and a simple string representation.
This error inherits from ApiError and has specific reasons defined by an enum.

Service

CompanyService CreativeService CreativeSetService ForecastService LineItemCreativeAssociationService LineItemService LineItemTemplateService OrderService ProposalLineItemService ProposalService UserService

Inheritance

ApiError

▼

AdUnitCodeError ApiVersionError AssetError AudienceExtensionError AudienceSegmentError AuthenticationError ClickTrackingLineItemError CollectionSizeError CommonError CompanyCreditStatusError CreativeError CrossSellError CurrencyCodeError CustomFieldValueError CustomTargetingError DateError DateTimeRangeTargetingError DayPartTargetingError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError ForecastError FrequencyCapError GenericTargetingError GeoTargetingError GrpSettingsError ImageError InternalApiError InvalidUrlError InventoryTargetingError InventoryUnitError LabelEntityAssociationError LineItemActivityAssociation... LineItemCreativeAssociation... LineItemError LineItemFlightDateError LineItemOperationError MobileApplicationTargetingE... NotNullError NullError OrderActionError OrderError ParseError PermissionError PrecisionError ProgrammaticError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RegExError RequestPlatformTargetingError RequiredCollectionError RequiredError RequiredNumberError RequiredSizeError ReservationDetailsError ServerError SetTopBoxLineItemError StatementError StringFormatError StringLengthError TeamError TechnologyTargetingError TimeZoneError TranscodingError TypeError UniqueError UserDomainTargetingError VideoPositionTargetingError

Errors specific to editing custom field values

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.