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

type AdRuleFrequencyCapError (v202505)

AI-generated Key Takeaways

AdRuleFrequencyCapError is a type of ApiError related to ad rule frequency caps.
This error includes fields like fieldPath, trigger, and errorString inherited from ApiError.
Specific to AdRuleFrequencyCapError is the 'reason' field, which indicates why the frequency cap error occurred.
Possible reasons for this error include frequency caps being turned on but not set, or turned off but still set.

Service

AdRuleService

Inheritance

ApiError

▼

AdRuleDateError AdRuleError AdRuleFrequencyCapError AdRulePriorityError AdRuleSlotError AdRuleTargetingError ApiVersionError AuthenticationError CollectionSizeError CommonError CustomTargetingError FeatureError GeoTargetingError InternalApiError InventoryTargetingError NotNullError ParseError PermissionError PoddingError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError RequiredNumberError ServerError StatementError StringFormatError StringLengthError UniqueError

Errors related to ad rule 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.
`AdRuleFrequencyCapError`
`reason`	`AdRuleFrequencyCapError.Reason` Enumerations `NO_FREQUENCY_CAPS_SPECIFIED_WHEN_FREQUENCY_CAPS_TURNED_ON` The ad rule specifies that frequency caps should be turned on, but then none of the frequency caps have actually been set. `FREQUENCY_CAPS_SPECIFIED_WHEN_FREQUENCY_CAPS_TURNED_OFF` The ad rule specifies that frequency caps should not be turned on, but then some frequency caps were actually set. `UNKNOWN` The value returned if the actual value is not exposed by the requested API version.