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

type RequiredNumberError (v202508)

AI-generated Key Takeaways

RequiredNumberError is an error type used with required number validators in the Ad Manager API.
It lists several services where this error can occur, including AdRuleService, CompanyService, and CreativeService.
The error inherits from ApiError and includes fields like fieldPath, trigger, and errorString.
Specific to RequiredNumberError is a 'reason' field which uses an enumeration to describe the nature of the number validation error.
Possible reasons for a RequiredNumberError include the number being too large, too small, or required but missing.

Service

AdRuleService CompanyService ContentService CreativeService CreativeSetService CreativeTemplateService ForecastService InventoryService LineItemCreativeAssociationService LineItemService LineItemTemplateService LiveStreamEventService NetworkService OrderService ProposalLineItemService ProposalService PublisherQueryLanguageService YieldGroupService

Inheritance

ApiError

▼

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

A list of all errors to be used in conjunction with required number validators.

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.
`RequiredNumberError`
`reason`	`RequiredNumberError.Reason` Enumerations `REQUIRED` `TOO_LARGE` `TOO_SMALL` `TOO_LARGE_WITH_DETAILS` `TOO_SMALL_WITH_DETAILS` `UNKNOWN` The value returned if the actual value is not exposed by the requested API version.