type FrequencyCapError (v202411)
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/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.
|
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\u003eThe FrequencyCapError lists all errors associated with frequency caps in Google Ad Manager.\u003c/p\u003e\n"],["\u003cp\u003eIt's part of the InventoryService and inherits from the ApiError object.\u003c/p\u003e\n"],["\u003cp\u003eFrequencyCapError includes fields like 'reason' indicating the specific error and inherited fields like 'fieldPath' for debugging.\u003c/p\u003e\n"],["\u003cp\u003e'reason' can be one of several enums like IMPRESSION_LIMIT_EXCEEDED, IMPRESSIONS_TOO_LOW, etc., providing details about the frequency cap issue.\u003c/p\u003e\n"],["\u003cp\u003eThe error namespace is \u003ccode\u003ehttps://www.google.com/apis/ads/publisher/v202411\u003c/code\u003e.\u003c/p\u003e\n"]]],["The document outlines service-related errors, with a focus on `FrequencyCapError`. Key services include `ForecastService`, `InventoryService`, `LineItemService`, `LineItemTemplateService`, `OrderService`, and `ProposalLineItemService`. `FrequencyCapError` inherits from `ApiError` and includes properties like `fieldPath`, `fieldPathElements`, `trigger`, and `errorString`. `FrequencyCapError` has the `reason` and has possible error types such as `IMPRESSION_LIMIT_EXCEEDED`, `RANGE_LIMIT_EXCEEDED`, and `TOO_MANY_FREQUENCY_CAPS`, among others.\n"],null,["# type FrequencyCapError (v202411)\n\n**Service** \n[ForecastService](/ad-manager/api/reference/v202411/ForecastService.FrequencyCapError) **InventoryService** [LineItemService](/ad-manager/api/reference/v202411/LineItemService.FrequencyCapError) [LineItemTemplateService](/ad-manager/api/reference/v202411/LineItemTemplateService.FrequencyCapError) [OrderService](/ad-manager/api/reference/v202411/OrderService.FrequencyCapError) [ProposalLineItemService](/ad-manager/api/reference/v202411/ProposalLineItemService.FrequencyCapError) **Inheritance** \n[ApiError](/ad-manager/api/reference/v202411/InventoryService.ApiError) \n▼\n[AdSenseAccountError](/ad-manager/api/reference/v202411/InventoryService.AdSenseAccountError) [AdUnitCodeError](/ad-manager/api/reference/v202411/InventoryService.AdUnitCodeError) [AdUnitHierarchyError](/ad-manager/api/reference/v202411/InventoryService.AdUnitHierarchyError) [ApiVersionError](/ad-manager/api/reference/v202411/InventoryService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202411/InventoryService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/InventoryService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/InventoryService.CommonError) [CompanyError](/ad-manager/api/reference/v202411/InventoryService.CompanyError) [CreativeWrapperError](/ad-manager/api/reference/v202411/InventoryService.CreativeWrapperError) [CrossSellError](/ad-manager/api/reference/v202411/InventoryService.CrossSellError) [EntityChildrenLimitReachedE...](/ad-manager/api/reference/v202411/InventoryService.EntityChildrenLimitReachedError \"EntityChildrenLimitReachedError\") [EntityLimitReachedError](/ad-manager/api/reference/v202411/InventoryService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202411/InventoryService.FeatureError) **FrequencyCapError** [InternalApiError](/ad-manager/api/reference/v202411/InventoryService.InternalApiError) [InvalidColorError](/ad-manager/api/reference/v202411/InventoryService.InvalidColorError) [InvalidUrlError](/ad-manager/api/reference/v202411/InventoryService.InvalidUrlError) [InventoryUnitError](/ad-manager/api/reference/v202411/InventoryService.InventoryUnitError) [InventoryUnitRefreshRateError](/ad-manager/api/reference/v202411/InventoryService.InventoryUnitRefreshRateError) [InventoryUnitSizesError](/ad-manager/api/reference/v202411/InventoryService.InventoryUnitSizesError) [LabelEntityAssociationError](/ad-manager/api/reference/v202411/InventoryService.LabelEntityAssociationError) [NotNullError](/ad-manager/api/reference/v202411/InventoryService.NotNullError) [NullError](/ad-manager/api/reference/v202411/InventoryService.NullError) [ParseError](/ad-manager/api/reference/v202411/InventoryService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/InventoryService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/InventoryService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/InventoryService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/InventoryService.QuotaError) [RangeError](/ad-manager/api/reference/v202411/InventoryService.RangeError) [RegExError](/ad-manager/api/reference/v202411/InventoryService.RegExError) [RequiredCollectionError](/ad-manager/api/reference/v202411/InventoryService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/InventoryService.RequiredError) [RequiredNumberError](/ad-manager/api/reference/v202411/InventoryService.RequiredNumberError) [ServerError](/ad-manager/api/reference/v202411/InventoryService.ServerError) [StatementError](/ad-manager/api/reference/v202411/InventoryService.StatementError) [StringFormatError](/ad-manager/api/reference/v202411/InventoryService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202411/InventoryService.StringLengthError) [TeamError](/ad-manager/api/reference/v202411/InventoryService.TeamError) [TypeError](/ad-manager/api/reference/v202411/InventoryService.TypeError) [UniqueError](/ad-manager/api/reference/v202411/InventoryService.UniqueError)\n\nLists all errors associated with frequency caps.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202411`\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/v202411/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/v202411/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 |"]]
