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

type RequiredNumberError (v202411)

AI-generated Key Takeaways

RequiredNumberError is a type of ApiError used with required number validators.
This error provides fields such as fieldPath, fieldPathElements, trigger, and errorString inherited from ApiError to identify the cause and details of the error.
It also includes a reason field specific to RequiredNumberError with possible values like REQUIRED, TOO_LARGE, TOO_SMALL, TOO_LARGE_WITH_DETAILS, TOO_SMALL_WITH_DETAILS, and UNKNOWN.

Service

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

Inheritance

ApiError

▼

AdUnitCodeError AdUnitHierarchyError ApiVersionError AudienceSegmentError AuthenticationError CollectionSizeError CommonError CreativeError DealError ExchangeRateError FeatureError FileError InternalApiError InvalidEmailError InvalidUrlError InventoryTargetingError InventoryUnitError LineItemFlightDateError LineItemOperationError NotNullError NullError OrderActionError OrderError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RegExError RequiredCollectionError RequiredError RequiredNumberError RequiredSizeError ReservationDetailsError ServerError StatementError StringFormatError StringLengthError 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.