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

type FrequencyCapError (v202505)

AI-generated Key Takeaways

FrequencyCapError lists errors related to frequency caps in services like ForecastService, InventoryService, LineItemService, LineItemTemplateService, OrderService, and ProposalLineItemService.
FrequencyCapError inherits from ApiError and includes fields such as fieldPath, fieldPathElements, trigger, and errorString.
The specific reason for a FrequencyCapError is provided by the 'reason' field, which is represented by an enum with values indicating issues like impression or range limits being exceeded, duplicate time ranges or units, or too many frequency caps.

Service

ForecastService InventoryService LineItemService LineItemTemplateService OrderService ProposalLineItemService

Inheritance

ApiError

▼

ApiVersionError AudienceSegmentError AuthenticationError BillingError CollectionSizeError CommonError CurrencyCodeError CustomFieldValueError CustomTargetingError DateTimeRangeTargetingError DayPartTargetingError DealError EntityChildrenLimitReachedE... EntityLimitReachedError ExchangeRateError FeatureError ForecastError FrequencyCapError GenericTargetingError GeoTargetingError GrpSettingsError InternalApiError InventoryTargetingError LabelEntityAssociationError LineItemError LineItemFlightDateError LineItemOperationError MobileApplicationTargetingE... NotNullError ParseError PermissionError PrecisionError PreferredDealError ProgrammaticError ProposalActionError ProposalError ProposalLineItemActionError ProposalLineItemError ProposalLineItemMakegoodError ProposalLineItemProgrammati... PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequestPlatformTargetingError RequiredCollectionError RequiredError RequiredNumberError ReservationDetailsError ServerError StatementError StringFormatError StringLengthError TeamError TechnologyTargetingError TimeZoneError 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.