type FrequencyCapError (v202508)

  • The FrequencyCapError is associated with errors related to frequency caps and is available in several services, including ForecastService, InventoryService, LineItemService, LineItemTemplateService, OrderService, and ProposalLineItemService.

  • It inherits from ApiError and includes fields such as fieldPath, fieldPathElements, trigger, and errorString.

  • The FrequencyCapError specifically includes a 'reason' field which is an enum detailing various causes for frequency cap errors, such as exceeding impression or range limits, duplicate time ranges or units, and having too many frequency caps.

Lists all errors associated with frequency caps.


Namespace
https://www.google.com/apis/ads/publisher/v202508

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.