type AdUnitHierarchyError (v202411)

  • AdUnitHierarchyError occurs when creating an AdUnit with an invalid hierarchy in the Google Ad Manager API.

  • This error arises from issues such as exceeding the maximum allowed depth in the inventory hierarchy or specifying an invalid parent AdUnit.

  • It is part of the InventoryService and inherits from ApiError, providing details like field path, trigger, and error string.

  • AdUnitHierarchyError includes a reason field indicating the specific cause of the error, like INVALID_DEPTH or INVALID_PARENT.

  • Developers should refer to the AdUnitHierarchyError.Reason enumeration for the possible reasons and ensure their AdUnit hierarchy adheres to the defined rules.
Service
InventoryService PublisherQueryLanguageService
Inheritance
ApiError
▼
AdSenseAccountError AdUnitCodeError AdUnitHierarchyError ApiVersionError AuthenticationError CollectionSizeError CommonError CompanyError CreativeWrapperError CrossSellError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError FrequencyCapError InternalApiError InvalidColorError InvalidUrlError InventoryUnitError InventoryUnitRefreshRateError InventoryUnitSizesError LabelEntityAssociationError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RegExError RequiredCollectionError RequiredError RequiredNumberError ServerError StatementError StringFormatError StringLengthError TeamError TypeError UniqueError

Caused by creating an AdUnit object with an invalid hierarchy.

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.

AdUnitHierarchyError

reason

AdUnitHierarchyError.Reason

Enumerations
INVALID_DEPTH
The depth of the AdUnit in the inventory hierarchy is greater than is allowed. The maximum allowed depth is two below the effective root ad unit for Ad Manager 360 accounts and is one level below the effective root ad unit for Ad Manager accounts.
INVALID_PARENT
The only valid AdUnit.parentId for an Ad Manager account is the Network.effectiveRootAdUnitId, Ad Manager 360 accounts can specify an ad unit hierarchy with more than two levels.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.