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

type FrequencyCapError (v202411)

AI-generated Key Takeaways

The FrequencyCapError is a type of ApiError related to frequency caps in various services.
It provides fields like fieldPath, trigger, and errorString for identifying the cause of the error.
The error includes a reason field, an enum indicating specific issues like exceeding impression limits, range limits, or having duplicate time ranges or units.
This error can occur across different services such as InventoryService, LineItemService, and OrderService.

Service

ForecastService InventoryService LineItemService LineItemTemplateService OrderService ProposalLineItemService

Inheritance

ApiError

▼

AdUnitCodeError ApiVersionError AssetError AudienceExtensionError AudienceSegmentError AuthenticationError ClickTrackingLineItemError CollectionSizeError CommonError CompanyCreditStatusError CreativeError CrossSellError CurrencyCodeError CustomFieldValueError CustomTargetingError DateError DateTimeRangeTargetingError DayPartTargetingError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError ForecastError FrequencyCapError GenericTargetingError GeoTargetingError GrpSettingsError ImageError InternalApiError InvalidUrlError InventoryTargetingError InventoryUnitError 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 TimeZoneError TranscodingError TypeError UniqueError UserDomainTargetingError VideoPositionTargetingError

Lists all errors associated with frequency caps.

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.
`FrequencyCapError`
`reason`	`FrequencyCapError.Reason` The error reason represented by an enum. Enumerations `IMPRESSION_LIMIT_EXCEEDED` `IMPRESSIONS_TOO_LOW` `RANGE_LIMIT_EXCEEDED` `RANGE_TOO_LOW` `DUPLICATE_TIME_RANGE` `DUPLICATE_TIME_UNIT` `TOO_MANY_FREQUENCY_CAPS` `UNKNOWN` The value returned if the actual value is not exposed by the requested API version.