type PreferredDealError (v202411)

  • PreferredDealError is a type of ApiError that is associated with preferred deal proposal line items.

  • This error type has a field called 'reason' which is an enum that represents the specific cause of the error.

  • Possible reasons for a PreferredDealError include invalid priority, invalid rate type (only CPM is supported), invalid frequency caps, invalid roadblocking type (only ONE_OR_MORE is supported), and invalid delivery rate type (only FRONTLOADED is supported).

  • The inherited fields from ApiError provide additional details about the error, such as the field path, trigger, and error string.
Service
ProposalLineItemService
Inheritance
ApiError
▼
ApiVersionError AudienceSegmentError AuthenticationError BillingError CollectionSizeError CommonError CurrencyCodeError CustomFieldValueError CustomTargetingError DateTimeRangeTargetingError DayPartTargetingError DealError EntityChildrenLimitReachedE... EntityLimitReachedError ExchangeRateError FeatureError ForecastError FrequencyCapError GenericTargetingError GeoTargetingError GrpSettingsError InternalApiError InventoryTargetingError LabelEntityAssociationError LineItemError LineItemFlightDateError LineItemOperationError MobileApplicationTargetingE... NotNullError ParseError PermissionError PrecisionError PreferredDealError ProgrammaticError ProposalActionError ProposalError ProposalLineItemActionError ProposalLineItemError ProposalLineItemMakegoodError ProposalLineItemProgrammati... PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequestPlatformTargetingError RequiredCollectionError RequiredError RequiredNumberError ReservationDetailsError ServerError StatementError StringFormatError StringLengthError TeamError TechnologyTargetingError TimeZoneError TypeError UniqueError UserDomainTargetingError VideoPositionTargetingError

Errors associated with preferred deal proposal 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.

PreferredDealError

reason

PreferredDealError.Reason

The error reason represented by an enum.

Enumerations
INVALID_PRIORITY
INVALID_RATE_TYPE
Preferred deal proposal line items only support RateType.CPM.
INVALID_FREQUENCY_CAPS
Preferred deal proposal line items do not support frequency caps.
INVALID_ROADBLOCKING_TYPE
Preferred deal proposal line items only support RoadblockingType.ONE_OR_MORE.
INVALID_DELIVERY_RATE_TYPE
Preferred deal proposal line items only support DeliveryRateType.FRONTLOADED.
UNKNOWN