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

type RequiredNumberError (v202502)

AI-generated Key Takeaways

RequiredNumberError is a type of ApiError used in conjunction with required number validators across various Ad Manager API services like AdRuleService, CompanyService, and CreativeService.
This error type includes inherited fields from ApiError such as fieldPath, fieldPathElements, trigger, and errorString, providing details about the error location and cause.
RequiredNumberError has a specific field named reason, which is an enumeration indicating why the number is invalid, with possible values including 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

▼

AdBreakMarkupError ApiVersionError AuthenticationError CollectionSizeError CommonError EntityLimitReachedError FeatureError InternalApiError InvalidUrlError LiveStreamEventActionError LiveStreamEventCdnSettingsE... LiveStreamEventConditioning... LiveStreamEventCustomAssetK... LiveStreamEventDateTimeError LiveStreamEventDvrWindowError LiveStreamEventPrerollSetti... LiveStreamEventSlateError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequiredCollectionError RequiredError RequiredNumberError ServerError StatementError StringFormatError StringLengthError UniqueError VideoAdTagError

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.