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

type RequiredNumberError (v202411)

AI-generated Key Takeaways

RequiredNumberError is an API error type used in conjunction with required number validators.
It inherits properties from the general ApiError type, such as fieldPath, fieldPathElements, trigger, and errorString.
The RequiredNumberError includes a specific reason field with enumerations like REQUIRED, TOO_LARGE, and TOO_SMALL to indicate the nature of the number validation failure.

Service

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

Inheritance

ApiError

▼

ApiVersionError AudienceSegmentError AuthenticationError BillingError CollectionSizeError CommonError CurrencyCodeError CustomFieldValueError CustomTargetingError DateTimeRangeTargetingError DayPartTargetingError DealError EntityChildrenLimitReachedE... EntityLimitReachedError ExchangeRateError FeatureError ForecastError FrequencyCapError GenericTargetingError GeoTargetingError GrpSettingsError InternalApiError InventoryTargetingError LabelEntityAssociationError LineItemError LineItemFlightDateError LineItemOperationError MobileApplicationTargetingE... NotNullError ParseError PermissionError PrecisionError PreferredDealError ProgrammaticError ProposalActionError ProposalError ProposalLineItemActionError ProposalLineItemError ProposalLineItemMakegoodError ProposalLineItemProgrammati... PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequestPlatformTargetingError RequiredCollectionError RequiredError RequiredNumberError ReservationDetailsError ServerError StatementError StringFormatError StringLengthError TeamError TechnologyTargetingError TimeZoneError 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.