type FrequencyCapError (v202411)Stay organized with collectionsSave and categorize content based on your preferences.
AI-generated Key Takeaways
The FrequencyCapError is a type of ApiError related to frequency caps in various services.
It provides fields like fieldPath, trigger, and errorString for identifying the cause of the error.
The error includes a reason field, an enum indicating specific issues like exceeding impression limits, range limits, or having duplicate time ranges or units.
This error can occur across different services such as InventoryService, LineItemService, and OrderService.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-06 UTC."],[],["The `ForecastService` manages ad inventory forecasts and related operations, with the content listing various services such as `InventoryService`, `LineItemService`, and `OrderService`. It defines an inheritance hierarchy of errors, including `ApiError` and its many sub-types like `AuthenticationError`, `ForecastError`, and `QuotaError`. The document details `FrequencyCapError`, which specifies the reason for frequency capping issues, like `IMPRESSION_LIMIT_EXCEEDED`, or `DUPLICATE_TIME_UNIT`. The `ApiError` provides fields for detailed error information, such as `fieldPath`, `trigger`, and `errorString`.\n"]]
