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

type FrequencyCapError (v202505)

AI-generated Key Takeaways

FrequencyCapError lists all errors associated with frequency caps in the Ad Manager API.
This error type is used across several services including ForecastService, InventoryService, LineItemService, LineItemTemplateService, OrderService, and ProposalLineItemService.
FrequencyCapError inherits from ApiError, including fields like fieldPath, fieldPathElements, trigger, and errorString.
Specific to FrequencyCapError is the 'reason' field, an enum detailing the cause of the frequency cap error, such as IMPRESSION_LIMIT_EXCEEDED or TOO_MANY_FREQUENCY_CAPS.

Service

ForecastService InventoryService LineItemService LineItemTemplateService OrderService ProposalLineItemService

Inheritance

ApiError

▼

ApiVersionError AssetError AudienceExtensionError AudienceSegmentError AuthenticationError ClickTrackingLineItemError CollectionSizeError CommonError CompanyCreditStatusError CreativeError CrossSellError CurrencyCodeError CustomFieldValueError CustomTargetingError DateTimeRangeTargetingError DayPartTargetingError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError ForecastError FrequencyCapError GenericTargetingError GeoTargetingError GrpSettingsError ImageError InternalApiError InvalidEmailError InvalidUrlError InventoryTargetingError 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 TemplateInstantiatedCreativ... 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.