type AdRuleFrequencyCapError (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
Errors related to ad rule 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.
|
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.
|
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\u003eThis documentation details the \u003ccode\u003eAdRuleFrequencyCapError\u003c/code\u003e within the AdRuleService, focusing on errors related to ad rule frequency caps.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eAdRuleFrequencyCapError\u003c/code\u003e is part of the Google Ad Manager API and falls under the namespace \u003ccode\u003ehttps://www.google.com/apis/ads/publisher/v202408\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe error arises due to discrepancies in frequency cap settings, such as specifying frequency caps when turned off or not specifying any when turned on.\u003c/p\u003e\n"],["\u003cp\u003eThis error object inherits from \u003ccode\u003eApiError\u003c/code\u003e and includes fields like \u003ccode\u003efieldPath\u003c/code\u003e, \u003ccode\u003efieldPathElements\u003c/code\u003e, \u003ccode\u003etrigger\u003c/code\u003e, and \u003ccode\u003eerrorString\u003c/code\u003e for detailed error information.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eAdRuleFrequencyCapError\u003c/code\u003e specifically provides a \u003ccode\u003ereason\u003c/code\u003e field with enumerated values like \u003ccode\u003eNO_FREQUENCY_CAPS_SPECIFIED_WHEN_FREQUENCY_CAPS_TURNED_ON\u003c/code\u003e, \u003ccode\u003eFREQUENCY_CAPS_SPECIFIED_WHEN_FREQUENCY_CAPS_TURNED_OFF\u003c/code\u003e, and \u003ccode\u003eUNKNOWN\u003c/code\u003e to pinpoint the cause of the error.\u003c/p\u003e\n"]]],["The `AdRuleService` uses `ApiError` inheritance to manage errors, including `AdRuleFrequencyCapError`, which specifically addresses issues with frequency caps. Key error types include date, priority, slot, and targeting errors, as well as common errors like authentication and internal API issues. `AdRuleFrequencyCapError` has a `reason` field with enumerations: `NO_FREQUENCY_CAPS_SPECIFIED_WHEN_FREQUENCY_CAPS_TURNED_ON` or `FREQUENCY_CAPS_SPECIFIED_WHEN_FREQUENCY_CAPS_TURNED_OFF`. It inherit properties like `fieldPath`, `trigger` and `errorString` from `ApiError`.\n"],null,["# type AdRuleFrequencyCapError (v202408)\n\n**Service** \n**AdRuleService** **Inheritance** \n[ApiError](/ad-manager/api/reference/v202408/AdRuleService.ApiError) \n▼\n[AdRuleDateError](/ad-manager/api/reference/v202408/AdRuleService.AdRuleDateError) [AdRuleError](/ad-manager/api/reference/v202408/AdRuleService.AdRuleError) **AdRuleFrequencyCapError** [AdRulePriorityError](/ad-manager/api/reference/v202408/AdRuleService.AdRulePriorityError) [AdRuleSlotError](/ad-manager/api/reference/v202408/AdRuleService.AdRuleSlotError) [AdRuleTargetingError](/ad-manager/api/reference/v202408/AdRuleService.AdRuleTargetingError) [ApiVersionError](/ad-manager/api/reference/v202408/AdRuleService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/AdRuleService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/AdRuleService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/AdRuleService.CommonError) [CustomTargetingError](/ad-manager/api/reference/v202408/AdRuleService.CustomTargetingError) [FeatureError](/ad-manager/api/reference/v202408/AdRuleService.FeatureError) [GeoTargetingError](/ad-manager/api/reference/v202408/AdRuleService.GeoTargetingError) [InternalApiError](/ad-manager/api/reference/v202408/AdRuleService.InternalApiError) [InventoryTargetingError](/ad-manager/api/reference/v202408/AdRuleService.InventoryTargetingError) [NotNullError](/ad-manager/api/reference/v202408/AdRuleService.NotNullError) [ParseError](/ad-manager/api/reference/v202408/AdRuleService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/AdRuleService.PermissionError) [PoddingError](/ad-manager/api/reference/v202408/AdRuleService.PoddingError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/AdRuleService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/AdRuleService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/AdRuleService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202408/AdRuleService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/AdRuleService.RequiredError) [RequiredNumberError](/ad-manager/api/reference/v202408/AdRuleService.RequiredNumberError) [ServerError](/ad-manager/api/reference/v202408/AdRuleService.ServerError) [StatementError](/ad-manager/api/reference/v202408/AdRuleService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/AdRuleService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/AdRuleService.StringLengthError) [UniqueError](/ad-manager/api/reference/v202408/AdRuleService.UniqueError)\n\nErrors related to ad rule 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/AdRuleService.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| **`AdRuleFrequencyCapError`** ||\n| ### `reason` | ` `[AdRuleFrequencyCapError.Reason](/ad-manager/api/reference/v202408/AdRuleService.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. \u003cbr /\u003e |"]]
