type ProgrammaticError (v202411)

  • ProgrammaticError is a type of error associated with programmatic line items within the ProposalService.

  • It inherits properties from ApiError, including fieldPath, fieldPathElements, trigger, and errorString.

  • ProgrammaticError includes a reason field which is an enum detailing specific errors related to programmatic line items, such as unsupported features like audience extension, video, or certain creative rotations and cost types.

  • Several reasons indicate limitations on programmatic line items, including supported creative sizes, minimum cost per unit, and restrictions on updating approved items.
Service
ForecastService LineItemService LineItemTemplateService OrderService ProposalLineItemService ProposalService
Inheritance
ApiError
▼
ApiVersionError AudienceSegmentError AuthenticationError BillingError CollectionSizeError CommonError CurrencyCodeError CustomFieldValueError DealError EntityChildrenLimitReachedE... EntityLimitReachedError ExchangeRateError FeatureError ForecastError InternalApiError InvalidUrlError LabelEntityAssociationError LineItemOperationError NotNullError NullError ParseError PermissionError PrecisionError ProgrammaticError ProposalActionError ProposalError ProposalLineItemError ProposalLineItemMakegoodError ProposalLineItemProgrammati... PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequiredCollectionError RequiredError RequiredNumberError ServerError StatementError StringFormatError StringLengthError TeamError TimeZoneError TypeError UniqueError

Errors associated with programmatic line items.

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.

ProgrammaticError

reason

ProgrammaticError.Reason

The error reason represented by an enum.

Enumerations
AUDIENCE_EXTENSION_NOT_SUPPORTED
Audience extension is not supported by programmatic line items.
AUTO_EXTENSION_DAYS_NOT_SUPPORTED
Auto extension days is not supported by programmatic line items.
VIDEO_NOT_SUPPORTED
Video is currently not supported.
ROADBLOCKING_NOT_SUPPORTED
Roadblocking is not supported by programmatic line items.
INVALID_CREATIVE_ROTATION
Programmatic line items do not support CreativeRotationType.SEQUENTIAL.
INVALID_LINE_ITEM_TYPE
Programmatic line items only support LineItemType.STANDARD and LineItemType.SPONSORSHIP if the relevant feature is on.
INVALID_COST_TYPE
Programmatic line items only support CostType.CPM.
SIZE_NOT_SUPPORTED
Programmatic line items only support a creative size that is supported by AdX. The list of supported sizes is maintained based on the list published in the help docs: https://support.google.com/adxseller/answer/1100453
ZERO_COST_PER_UNIT_NOT_SUPPORTED
Zero cost per unit is not supported by programmatic line items.
CANNOT_UPDATE_FIELD_FOR_APPROVED_LINE_ITEMS
Some fields cannot be updated on approved line items.
CANNOT_CREATE_LINE_ITEM_FOR_APPROVED_ORDER
Creating a new line item in an approved order is not allowed.
CANNOT_UPDATE_BACKFILL_WEB_PROPERTY_FOR_APPROVED_LINE_ITEMS
Cannot change backfill web property for a programmatic line item whose order has been approved.
COST_PER_UNIT_TOO_LOW
Cost per unit is too low. It has to be at least 0.005 USD.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.