type AdRuleFrequencyCapError (v202411)

  • The AdRuleFrequencyCapError object describes errors related to ad rule frequency caps.

  • This error occurs when there's a mismatch between enabling frequency caps and specifying actual frequency cap values.

  • NO_FREQUENCY_CAPS_SPECIFIED_WHEN_FREQUENCY_CAPS_TURNED_ON signals that frequency caps are enabled but not defined, while FREQUENCY_CAPS_SPECIFIED_WHEN_FREQUENCY_CAPS_TURNED_OFF indicates frequency caps are defined but disabled.

  • The reason field provides the specific error type, including a catch-all UNKNOWN for errors not exposed in the current API version.

  • The AdRuleFrequencyCapError inherits from ApiError, which provides general error information like field path, trigger, and error string.
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

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.

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.