type PlacementError (v202411)

  • PlacementError is a class used for defining validation errors that can occur when working with placements in Google Ad Manager.

  • This class inherits from ApiError, providing access to general error information like field path, trigger, and error string.

  • PlacementError includes a specific "reason" field to indicate the cause of the validation error, like using shared inventory with local inventory in the same placement.

  • Possible reasons for PlacementError are outlined in the PlacementError.Reason enumeration with detailed explanations.

  • This information is crucial for developers to understand and handle potential errors during placement management through the Ad Manager API.
Service
ContentBundleService PlacementService
Inheritance
ApiError
▼
ApiVersionError AuthenticationError CollectionSizeError CommonError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError InternalApiError NotNullError NullError ParseError PermissionError PlacementError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RegExError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError TypeError UniqueError

Class defining all validation errors for a placement.

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.

PlacementError

reason

PlacementError.Reason

Enumerations
INVALID_ENTITY_TYPE
Entity type is something other than inventory or content.
SHARED_INVENTORY_ASSIGNED
Shared inventory cannot be assigned to a placement.
PLACEMENTS_CANNOT_INCLUDE_INVENTORY_FROM_MULTIPLE_DISTRIBUTOR_NETWORKS
Shared inventory from one distributor network cannot be in the same placement with inventory from another distributor.
PLACEMENTS_CANNOT_INCLUDE_BOTH_LOCAL_AND_SHARED_INVENTORY
Shared inventory and local inventory cannot be in the same placement.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.