type DealError (v202508)

  • DealError represents errors encountered when creating or updating programmatic proposals within the PublisherQueryLanguageService.

  • This error type inherits from ApiError and includes fields like fieldPath, fieldPathElements, trigger, and errorString to identify the cause of the error.

  • DealError also provides a 'reason' field, an enum indicating specific causes like inability to add or archive line items when a proposal is sold or missing required information.

  • Possible reasons for a DealError include missing proposal line items, a missing environment, or the inability to find the proposal in the Marketplace.

  • The error reason can also indicate issues with product existence, new versions from the buyer, or the proposal being out of sync with the Marketplace.
Service
ProposalLineItemService ProposalService PublisherQueryLanguageService
Inheritance
ApiError
▼
AdUnitCodeError AdUnitHierarchyError ApiVersionError AudienceSegmentError AuthenticationError CollectionSizeError CommonError CreativeError DealError ExchangeRateError FeatureError FileError InternalApiError InvalidEmailError InvalidUrlError InventoryTargetingError InventoryUnitError LineItemFlightDateError LineItemOperationError NotNullError NullError OrderActionError OrderError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RegExError RequiredCollectionError RequiredError RequiredNumberError RequiredSizeError ReservationDetailsError ServerError StatementError StringFormatError StringLengthError TypeError UniqueError

Errors associated with creating or updating programmatic proposals.

Namespace
https://www.google.com/apis/ads/publisher/v202508

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.

DealError

reason

DealError.Reason

The error reason represented by an enum.

Enumerations
CANNOT_ADD_LINE_ITEM_WHEN_SOLD
Cannot add new proposal line items to a Proposal when Proposal.isSold is true.
CANNOT_ARCHIVE_LINE_ITEM_WHEN_SOLD
Cannot archive proposal line items from a Proposal when Proposal.isSold is true.
CANNOT_ARCHIVE_PROPOSAL_WHEN_SOLD
Cannot archive a Proposal when Proposal.isSold is true.
CANNOT_CHANGE_FIELD_REQUIRING_BUYER_APPROVAL
Cannot change a field that requires buyer approval during the current operation.
CANNOT_GET_SELLER_ID
Cannot find seller ID for the Proposal.
CAN_ONLY_EXECUTE_IF_LOCAL_EDITS
Proposal must be marked as editable by EditProposalsForNegotiation before performing requested action.
MISSING_PROPOSAL_LINE_ITEMS
Proposal contains no proposal line items.
MISSING_ENVIRONMENT
No environment set for Proposal.
MISSING_AD_EXCHANGE_PROPERTY
The Ad Exchange property is not associated with the current network.
CANNOT_FIND_PROPOSAL_IN_MARKETPLACE
Cannot find Proposal in Marketplace.
CANNOT_GET_PRODUCT
No Product exists for buyer-initiated programmatic proposals.
NEW_VERSION_FROM_BUYER
A new version of the Proposal was sent from buyer, cannot execute the requested action before performing DiscardLocalVersionEdits.
PROPOSAL_OUT_OF_SYNC_WITH_MARKETPLACE
A new version of the Proposal exists in Marketplace, cannot execute the requested action before the proposal is synced to newest revision.
NO_PROPOSAL_CHANGES_FOUND
No Proposal changes were found.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.