type FrequencyCapError (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
Lists all errors associated with frequency caps.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202408
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003e\u003ccode\u003eFrequencyCapError\u003c/code\u003e objects detail errors encountered when working with frequency caps in Google Ad Manager.\u003c/p\u003e\n"],["\u003cp\u003eIt's a subclass of \u003ccode\u003eApiError\u003c/code\u003e and includes fields like \u003ccode\u003efieldPath\u003c/code\u003e, \u003ccode\u003etrigger\u003c/code\u003e, and \u003ccode\u003eerrorString\u003c/code\u003e for debugging.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field provides an enum value explaining the specific frequency cap error.\u003c/p\u003e\n"],["\u003cp\u003ePotential error reasons include exceeding impression limits, specifying too low impression values, duplicate time ranges, and exceeding the allowed number of frequency caps.\u003c/p\u003e\n"]]],["The core content outlines the structure and errors related to frequency caps within the ad management system. It details services like `ForecastService`, `InventoryService`, `LineItemService`, `LineItemTemplateService`, `OrderService`, and `ProposalLineItemService`. It also lists various error types that inherit from `ApiError`, including specific errors related to `FrequencyCapError`. `FrequencyCapError`'s reason enum defines error categories, such as exceeding limits, low values, or duplicate time ranges. It also describes fields and their type.\n"],null,["# type FrequencyCapError (v202408)\n\n**Service** \n[ForecastService](/ad-manager/api/reference/v202408/ForecastService.FrequencyCapError) **InventoryService** [LineItemService](/ad-manager/api/reference/v202408/LineItemService.FrequencyCapError) [LineItemTemplateService](/ad-manager/api/reference/v202408/LineItemTemplateService.FrequencyCapError) [OrderService](/ad-manager/api/reference/v202408/OrderService.FrequencyCapError) [ProposalLineItemService](/ad-manager/api/reference/v202408/ProposalLineItemService.FrequencyCapError) **Inheritance** \n[ApiError](/ad-manager/api/reference/v202408/InventoryService.ApiError) \n▼\n[AdSenseAccountError](/ad-manager/api/reference/v202408/InventoryService.AdSenseAccountError) [AdUnitCodeError](/ad-manager/api/reference/v202408/InventoryService.AdUnitCodeError) [AdUnitHierarchyError](/ad-manager/api/reference/v202408/InventoryService.AdUnitHierarchyError) [ApiVersionError](/ad-manager/api/reference/v202408/InventoryService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/InventoryService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/InventoryService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/InventoryService.CommonError) [CompanyError](/ad-manager/api/reference/v202408/InventoryService.CompanyError) [CreativeWrapperError](/ad-manager/api/reference/v202408/InventoryService.CreativeWrapperError) [CrossSellError](/ad-manager/api/reference/v202408/InventoryService.CrossSellError) [EntityChildrenLimitReachedE...](/ad-manager/api/reference/v202408/InventoryService.EntityChildrenLimitReachedError \"EntityChildrenLimitReachedError\") [EntityLimitReachedError](/ad-manager/api/reference/v202408/InventoryService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202408/InventoryService.FeatureError) **FrequencyCapError** [InternalApiError](/ad-manager/api/reference/v202408/InventoryService.InternalApiError) [InvalidColorError](/ad-manager/api/reference/v202408/InventoryService.InvalidColorError) [InvalidUrlError](/ad-manager/api/reference/v202408/InventoryService.InvalidUrlError) [InventoryUnitError](/ad-manager/api/reference/v202408/InventoryService.InventoryUnitError) [InventoryUnitRefreshRateError](/ad-manager/api/reference/v202408/InventoryService.InventoryUnitRefreshRateError) [InventoryUnitSizesError](/ad-manager/api/reference/v202408/InventoryService.InventoryUnitSizesError) [LabelEntityAssociationError](/ad-manager/api/reference/v202408/InventoryService.LabelEntityAssociationError) [NotNullError](/ad-manager/api/reference/v202408/InventoryService.NotNullError) [NullError](/ad-manager/api/reference/v202408/InventoryService.NullError) [ParseError](/ad-manager/api/reference/v202408/InventoryService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/InventoryService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/InventoryService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/InventoryService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/InventoryService.QuotaError) [RangeError](/ad-manager/api/reference/v202408/InventoryService.RangeError) [RegExError](/ad-manager/api/reference/v202408/InventoryService.RegExError) [RequiredCollectionError](/ad-manager/api/reference/v202408/InventoryService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/InventoryService.RequiredError) [RequiredNumberError](/ad-manager/api/reference/v202408/InventoryService.RequiredNumberError) [ServerError](/ad-manager/api/reference/v202408/InventoryService.ServerError) [StatementError](/ad-manager/api/reference/v202408/InventoryService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/InventoryService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/InventoryService.StringLengthError) [TeamError](/ad-manager/api/reference/v202408/InventoryService.TeamError) [TypeError](/ad-manager/api/reference/v202408/InventoryService.TypeError) [UniqueError](/ad-manager/api/reference/v202408/InventoryService.UniqueError)\n\nLists all errors associated with frequency caps.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202408`\n\n| Field ----- ||\n|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **`ApiError` (inherited)** ||\n| ### `fieldPath` | ` `xsd:`string` The OGNL field path to identify cause of error. |\n| ### `fieldPathElements` | ` `[FieldPathElement](/ad-manager/api/reference/v202408/InventoryService.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)}. |\n| ### `trigger` | ` `xsd:`string` The data that caused the error. |\n| ### `errorString` | ` `xsd:`string` A simple string representation of the error and reason. |\n| **`FrequencyCapError`** ||\n| ### `reason` | ` `[FrequencyCapError.Reason](/ad-manager/api/reference/v202408/InventoryService.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. \u003cbr /\u003e |"]]
