type RequiredNumberError (v202411)
Stay organized with collections
Save and categorize content based on your preferences.
A list of all errors to be used in conjunction with required number
validators.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202411
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eThe RequiredNumberError is used to indicate errors related to numerical values not meeting specific requirements, such as being too large, too small, or simply missing.\u003c/p\u003e\n"],["\u003cp\u003eThis error extends the ApiError class, inheriting properties for identifying the error's location and cause.\u003c/p\u003e\n"],["\u003cp\u003eRequiredNumberError includes a \u003ccode\u003ereason\u003c/code\u003e field to specify the type of numerical requirement violation.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use this error to understand and handle scenarios where numerical inputs are invalid in the context of various Ad Manager services.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field uses the \u003ccode\u003eRequiredNumberError.Reason\u003c/code\u003e enum to provide detailed information about the specific numerical constraint that was violated.\u003c/p\u003e\n"]]],["The content details various services like AdRuleService, CompanyService, and CreativeService, alongside related errors. Key error types include ApiError, with subclasses like ApiVersionError and AuthenticationError. `RequiredNumberError` is a crucial component, used for validation, with reasons such as `REQUIRED`, `TOO_LARGE`, and `TOO_SMALL`, also include details of the error. Field details are given, and an enumerated list of value types are included.\n"],null,["# type RequiredNumberError (v202411)\n\n**Service** \n[AdRuleService](/ad-manager/api/reference/v202411/AdRuleService.RequiredNumberError) [CompanyService](/ad-manager/api/reference/v202411/CompanyService.RequiredNumberError) [ContentService](/ad-manager/api/reference/v202411/ContentService.RequiredNumberError) **CreativeService** [CreativeSetService](/ad-manager/api/reference/v202411/CreativeSetService.RequiredNumberError) [CreativeTemplateService](/ad-manager/api/reference/v202411/CreativeTemplateService.RequiredNumberError) [ForecastService](/ad-manager/api/reference/v202411/ForecastService.RequiredNumberError) [InventoryService](/ad-manager/api/reference/v202411/InventoryService.RequiredNumberError) [LineItemCreativeAssociationService](/ad-manager/api/reference/v202411/LineItemCreativeAssociationService.RequiredNumberError) [LineItemService](/ad-manager/api/reference/v202411/LineItemService.RequiredNumberError) [LineItemTemplateService](/ad-manager/api/reference/v202411/LineItemTemplateService.RequiredNumberError) [LiveStreamEventService](/ad-manager/api/reference/v202411/LiveStreamEventService.RequiredNumberError) [NetworkService](/ad-manager/api/reference/v202411/NetworkService.RequiredNumberError) [OrderService](/ad-manager/api/reference/v202411/OrderService.RequiredNumberError) [ProposalLineItemService](/ad-manager/api/reference/v202411/ProposalLineItemService.RequiredNumberError) [ProposalService](/ad-manager/api/reference/v202411/ProposalService.RequiredNumberError) [PublisherQueryLanguageService](/ad-manager/api/reference/v202411/PublisherQueryLanguageService.RequiredNumberError) [YieldGroupService](/ad-manager/api/reference/v202411/YieldGroupService.RequiredNumberError) **Inheritance** \n[ApiError](/ad-manager/api/reference/v202411/CreativeService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202411/CreativeService.ApiVersionError) [AssetError](/ad-manager/api/reference/v202411/CreativeService.AssetError) [AuthenticationError](/ad-manager/api/reference/v202411/CreativeService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/CreativeService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/CreativeService.CommonError) [CreativeAssetMacroError](/ad-manager/api/reference/v202411/CreativeService.CreativeAssetMacroError) [CreativeError](/ad-manager/api/reference/v202411/CreativeService.CreativeError) [CreativeSetError](/ad-manager/api/reference/v202411/CreativeService.CreativeSetError) [CreativeTemplateError](/ad-manager/api/reference/v202411/CreativeService.CreativeTemplateError) [CreativeTemplateOperationError](/ad-manager/api/reference/v202411/CreativeService.CreativeTemplateOperationError) [CustomCreativeError](/ad-manager/api/reference/v202411/CreativeService.CustomCreativeError) [CustomFieldValueError](/ad-manager/api/reference/v202411/CreativeService.CustomFieldValueError) [EntityLimitReachedError](/ad-manager/api/reference/v202411/CreativeService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202411/CreativeService.FeatureError) [FileError](/ad-manager/api/reference/v202411/CreativeService.FileError) [HtmlBundleProcessorError](/ad-manager/api/reference/v202411/CreativeService.HtmlBundleProcessorError) [ImageError](/ad-manager/api/reference/v202411/CreativeService.ImageError) [InternalApiError](/ad-manager/api/reference/v202411/CreativeService.InternalApiError) [InvalidPhoneNumberError](/ad-manager/api/reference/v202411/CreativeService.InvalidPhoneNumberError) [InvalidUrlError](/ad-manager/api/reference/v202411/CreativeService.InvalidUrlError) [LabelEntityAssociationError](/ad-manager/api/reference/v202411/CreativeService.LabelEntityAssociationError) [LineItemCreativeAssociation...](/ad-manager/api/reference/v202411/CreativeService.LineItemCreativeAssociationError \"LineItemCreativeAssociationError\") [NotNullError](/ad-manager/api/reference/v202411/CreativeService.NotNullError) [NullError](/ad-manager/api/reference/v202411/CreativeService.NullError) [ParseError](/ad-manager/api/reference/v202411/CreativeService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/CreativeService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/CreativeService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/CreativeService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/CreativeService.QuotaError) [RangeError](/ad-manager/api/reference/v202411/CreativeService.RangeError) [RequiredCollectionError](/ad-manager/api/reference/v202411/CreativeService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/CreativeService.RequiredError) **RequiredNumberError** [RequiredSizeError](/ad-manager/api/reference/v202411/CreativeService.RequiredSizeError) [RichMediaStudioCreativeError](/ad-manager/api/reference/v202411/CreativeService.RichMediaStudioCreativeError) [ServerError](/ad-manager/api/reference/v202411/CreativeService.ServerError) [SetTopBoxCreativeError](/ad-manager/api/reference/v202411/CreativeService.SetTopBoxCreativeError) [StatementError](/ad-manager/api/reference/v202411/CreativeService.StatementError) [StringFormatError](/ad-manager/api/reference/v202411/CreativeService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202411/CreativeService.StringLengthError) [SwiffyConversionError](/ad-manager/api/reference/v202411/CreativeService.SwiffyConversionError) [TemplateInstantiatedCreativ...](/ad-manager/api/reference/v202411/CreativeService.TemplateInstantiatedCreativeError \"TemplateInstantiatedCreativeError\") [TranscodingError](/ad-manager/api/reference/v202411/CreativeService.TranscodingError) [TypeError](/ad-manager/api/reference/v202411/CreativeService.TypeError) [UniqueError](/ad-manager/api/reference/v202411/CreativeService.UniqueError)\n\nA list of all errors to be used in conjunction with required number\nvalidators.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202411`\n\n| Field ----- ||\n|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **`ApiError` (inherited)** ||\n| ### `fieldPath` | ` `xsd:`string` The OGNL field path to identify cause of error. |\n| ### `fieldPathElements` | ` `[FieldPathElement](/ad-manager/api/reference/v202411/CreativeService.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)}. |\n| ### `trigger` | ` `xsd:`string` The data that caused the error. |\n| ### `errorString` | ` `xsd:`string` A simple string representation of the error and reason. |\n| **`RequiredNumberError`** ||\n| ### `reason` | ` `[RequiredNumberError.Reason](/ad-manager/api/reference/v202411/CreativeService.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. \u003cbr /\u003e |"]]
