type AdRuleError (v202411)
Stay organized with collections
Save and categorize content based on your preferences.
Errors ad rule break template objects.
- 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.
|
AdRuleError
|
reason
|
AdRuleError.Reason
Enumerations
-
NAME_CONTAINS_INVALID_CHARACTERS
- The name contains unsupported or reserved characters.
-
BREAK_TEMPLATE_MUST_HAVE_EXACTLY_ONE_FLEXIBLE_AD_SPOT
- The break template must have exactly one flexible ad spot.
-
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\u003eAdRuleService manages ad rule break templates and their associated errors.\u003c/p\u003e\n"],["\u003cp\u003eAdRuleError objects provide details about specific errors encountered during ad rule operations.\u003c/p\u003e\n"],["\u003cp\u003eCommon error reasons include invalid characters in names and incorrect break template configuration.\u003c/p\u003e\n"],["\u003cp\u003eThe API provides detailed error information including field path, trigger, and error string.\u003c/p\u003e\n"],["\u003cp\u003eAdRuleService is part of the Google Ad Manager API and uses a specific namespace for interactions.\u003c/p\u003e\n"]]],["The `AdRuleService` defines various error types, all inheriting from `ApiError`. Specific errors include `AdRuleDateError`, `AdRuleFrequencyCapError`, `AdRulePriorityError`, and others related to targeting, formatting, and API versions. `ApiError` contains details like `fieldPath`, `fieldPathElements`, `trigger`, and `errorString`. `AdRuleError` has a `reason` field with enumerations like `NAME_CONTAINS_INVALID_CHARACTERS`, `BREAK_TEMPLATE_MUST_HAVE_EXACTLY_ONE_FLEXIBLE_AD_SPOT` and `UNKNOWN` to describe the error context.\n"],null,["# type AdRuleError (v202411)\n\n**Service** \n**AdRuleService** **Inheritance** \n[ApiError](/ad-manager/api/reference/v202411/AdRuleService.ApiError) \n▼\n[AdRuleDateError](/ad-manager/api/reference/v202411/AdRuleService.AdRuleDateError) **AdRuleError** [AdRuleFrequencyCapError](/ad-manager/api/reference/v202411/AdRuleService.AdRuleFrequencyCapError) [AdRulePriorityError](/ad-manager/api/reference/v202411/AdRuleService.AdRulePriorityError) [AdRuleSlotError](/ad-manager/api/reference/v202411/AdRuleService.AdRuleSlotError) [AdRuleTargetingError](/ad-manager/api/reference/v202411/AdRuleService.AdRuleTargetingError) [ApiVersionError](/ad-manager/api/reference/v202411/AdRuleService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202411/AdRuleService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/AdRuleService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/AdRuleService.CommonError) [CustomTargetingError](/ad-manager/api/reference/v202411/AdRuleService.CustomTargetingError) [FeatureError](/ad-manager/api/reference/v202411/AdRuleService.FeatureError) [GeoTargetingError](/ad-manager/api/reference/v202411/AdRuleService.GeoTargetingError) [InternalApiError](/ad-manager/api/reference/v202411/AdRuleService.InternalApiError) [InventoryTargetingError](/ad-manager/api/reference/v202411/AdRuleService.InventoryTargetingError) [NotNullError](/ad-manager/api/reference/v202411/AdRuleService.NotNullError) [ParseError](/ad-manager/api/reference/v202411/AdRuleService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/AdRuleService.PermissionError) [PoddingError](/ad-manager/api/reference/v202411/AdRuleService.PoddingError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/AdRuleService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/AdRuleService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/AdRuleService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202411/AdRuleService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/AdRuleService.RequiredError) [RequiredNumberError](/ad-manager/api/reference/v202411/AdRuleService.RequiredNumberError) [ServerError](/ad-manager/api/reference/v202411/AdRuleService.ServerError) [StatementError](/ad-manager/api/reference/v202411/AdRuleService.StatementError) [StringFormatError](/ad-manager/api/reference/v202411/AdRuleService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202411/AdRuleService.StringLengthError) [UniqueError](/ad-manager/api/reference/v202411/AdRuleService.UniqueError)\n\nErrors ad rule break template objects.\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/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| **`AdRuleError`** ||\n| ### `reason` | ` `[AdRuleError.Reason](/ad-manager/api/reference/v202411/AdRuleService.AdRuleError.Reason)` ` *** ** * ** *** **Enumerations** `NAME_CONTAINS_INVALID_CHARACTERS` : The name contains unsupported or reserved characters. `BREAK_TEMPLATE_MUST_HAVE_EXACTLY_ONE_FLEXIBLE_AD_SPOT` : The break template must have exactly one flexible ad spot. `UNKNOWN` : The value returned if the actual value is not exposed by the requested API version. \u003cbr /\u003e |"]]
