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

type CustomFieldValueError (v202505)

AI-generated Key Takeaways

CustomFieldValueError is an error specific to editing custom field values within various services like CompanyService, CreativeService, and OrderService.
It inherits from ApiError and includes details such as the field path, the data that caused the error, and a simple string representation of the error.
The specific reason for a CustomFieldValueError is indicated by an enum, which can include causes like the custom field or option not being found, the custom field being inactive, or an invalid entity type association.

Service

CompanyService CreativeService CreativeSetService ForecastService LineItemCreativeAssociationService LineItemService LineItemTemplateService OrderService ProposalLineItemService ProposalService UserService

Inheritance

ApiError

▼

ApiVersionError AssetError AudienceExtensionError AudienceSegmentError AuthenticationError ClickTrackingLineItemError CollectionSizeError CommonError CompanyCreditStatusError CreativeError CrossSellError CurrencyCodeError CustomFieldValueError CustomTargetingError DateTimeRangeTargetingError DayPartTargetingError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError ForecastError FrequencyCapError GenericTargetingError GeoTargetingError GrpSettingsError ImageError InternalApiError InvalidEmailError InvalidUrlError InventoryTargetingError 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 TemplateInstantiatedCreativ... 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.