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

type RequiredNumberError (v202411)

AI-generated Key Takeaways

RequiredNumberError is used with required number validators in conjunction with various services like AdRuleService, CompanyService, and CreativeService.
This error inherits from ApiError and includes fields such as fieldPath, trigger, and errorString.
The RequiredNumberError has a reason field with possible values indicating if a number is required, too large, too small, or unknown.
This error specifically deals with issues related to numerical values being outside of expected ranges or not being provided when required.

Service

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

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

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.