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 UserService.
This error inherits from ApiError and includes fields such as fieldPath, trigger, and errorString to help identify the cause.
The reason field provides specific enumeration values explaining why the CustomFieldValueError occurred, such as a custom field or option not being found or an invalid entity type being used.

Service

CompanyService CreativeService CreativeSetService ForecastService LineItemCreativeAssociationService LineItemService LineItemTemplateService OrderService ProposalLineItemService ProposalService UserService

Inheritance

ApiError

▼

ApiVersionError AuthenticationError CollectionSizeError CommonError CustomFieldValueError EntityLimitReachedError FeatureError InternalApiError InvalidEmailError NotNullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError TeamError TimeZoneError TokenError 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.