type ProgrammaticError (v202402)
Errors associated with programmatic line items.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202402
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.
|
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 2024-02-13 UTC.
[null,null,["Last updated 2024-02-13 UTC."],[[["`ProgrammaticError` objects represent errors specifically related to programmatic line items in Google Ad Manager."],["These errors often occur due to limitations and restrictions inherent to programmatic line items, such as unsupported features or invalid configurations."],["`ProgrammaticError` details include a reason code (e.g., `AUDIENCE_EXTENSION_NOT_SUPPORTED`, `INVALID_LINE_ITEM_TYPE`) and the standard `ApiError` fields for context."],["The `reason` field provides specific information about the programmatic error encountered, allowing developers to diagnose and address the issue."],["Refer to the provided documentation for a comprehensive list of `ProgrammaticError.Reason` values and their descriptions to understand the various error scenarios."]]],["The content outlines error handling for various services, with a focus on `ProgrammaticError`. Services listed include `ForecastService`, `LineItemService`, `OrderService`, and `ProposalService`. Errors inherit from `ApiError` and are categorized, with `ProgrammaticError` being used for errors associated with programmatic line items. This error specifies the reason, such as unsupported features like audience extension, video, roadblocking, and restrictions on creative rotation, cost types, line item types and sizes. It also includes errors related to updating approved line items and cost per unit values.\n"]]
