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

type CustomFieldValueError (v202411)

AI-generated Key Takeaways

CustomFieldValueError is an error specific to editing custom field values.
This error is part of the CreativeSetService and inherits from ApiError.
Reasons for this error include the custom field not being found, being inactive, or having an invalid entity type.
The error provides details such as the field path, trigger, and a simple error string.

Service

CompanyService CreativeService CreativeSetService ForecastService LineItemCreativeAssociationService LineItemService LineItemTemplateService OrderService ProposalLineItemService ProposalService UserService

Inheritance

ApiError

▼

ApiVersionError AssetError AuthenticationError CollectionSizeError CommonError CreativeAssetMacroError CreativeError CreativeSetError CreativeTemplateError CreativeTemplateOperationError CustomCreativeError CustomFieldValueError EntityLimitReachedError FeatureError FileError HtmlBundleProcessorError ImageError InternalApiError InvalidPhoneNumberError InvalidUrlError LabelEntityAssociationError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequiredCollectionError RequiredError RequiredNumberError RequiredSizeError RichMediaStudioCreativeError ServerError SetTopBoxCreativeError StatementError StringFormatError StringLengthError SwiffyConversionError TemplateInstantiatedCreativ... TranscodingError TypeError UniqueError

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.