type CrossSellError (v202508)

  • CrossSellError lists errors related to cross selling across different services like CompanyService, ForecastService, InventoryService, LineItemCreativeAssociationService, LineItemService, and LineItemTemplateService, with a primary focus on OrderService.

  • This error type inherits from ApiError, including fields like fieldPath, fieldPathElements, trigger, and errorString to provide details about the error.

  • The CrossSellError specifically includes a 'reason' field with various enumerations detailing specific cross-selling issues, such as incorrect company type, invalid network settings, missing partner names, and rule violations by the distributor.

  • Specific error reasons cover scenarios like attempting to change a partner network, conflicts with ad unit names, and a content provider network being the same as the distributor network.

  • Cross-selling distributor rules violations can manifest as either errors, which block the operation, or warnings, which can potentially be suppressed by the content partner.
Service
CompanyService ForecastService InventoryService LineItemCreativeAssociationService LineItemService LineItemTemplateService OrderService
Inheritance
ApiError
▼
ApiVersionError AssetError AudienceExtensionError AudienceSegmentError AuthenticationError ClickTrackingLineItemError CollectionSizeError CommonError CompanyCreditStatusError CreativeError CrossSellError CurrencyCodeError CustomFieldValueError CustomTargetingError DateTimeRangeTargetingError DayPartTargetingError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError ForecastError FrequencyCapError GenericTargetingError GeoTargetingError GrpSettingsError ImageError InternalApiError InvalidEmailError InvalidUrlError InventoryTargetingError LabelEntityAssociationError LineItemActivityAssociation... LineItemCreativeAssociation... LineItemError LineItemFlightDateError LineItemOperationError MobileApplicationTargetingE... NotNullError NullError OrderActionError OrderError ParseError PermissionError PrecisionError ProgrammaticError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RegExError RequestPlatformTargetingError RequiredCollectionError RequiredError RequiredNumberError RequiredSizeError ReservationDetailsError ServerError SetTopBoxLineItemError StatementError StringFormatError StringLengthError TeamError TechnologyTargetingError TemplateInstantiatedCreativ... TimeZoneError TranscodingError TypeError UniqueError UserDomainTargetingError VideoPositionTargetingError

Lists all errors associated with cross selling.

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.

CrossSellError

reason

CrossSellError.Reason

The error reason represented by an enum.

Enumerations
COMPANY_IS_NOT_DISTRIBUTION_PARTNER
A company for cross-sell partner must be of type Company.Type.PARTNER.
CHANGING_PARTNER_NETWORK_IS_NOT_SUPPORTED
The network code of a cross-sell partner cannot be changed.
MISSING_DISTRIBUTOR_PARTNER_NAME
A cross-sell partner must have a partner name.
DISTRIBUTOR_NETWORK_MISSING_PUBLISHER_FEATURE
The cross-sell distributor publisher feature must be enabled.
CONTENT_PROVIDER_NETWORK_MISSING_PUBLISHER_FEATURE
The cross-sell publisher features must be enabled on the partner's network.
INVALID_DISTRIBUTOR_PARTNER_NAME
The cross-sell partner name conflicts with an ad unit name on the partner's network.
INVALID_CONTENT_PROVIDER_NETWORK
The network code of a cross-sell partner is invalid.
CONTENT_PROVIDER_NETWORK_CANNOT_BE_ACTIVE_NETWORK
The content provider network must be different than the distributor network.
CONTENT_PROVIDER_NETWORK_ALREADY_ENABLED_FOR_CROSS_SELLING
The same network code was already enabled for cross-sell in a different company.
DISTRIBUTOR_RULE_VIOLATION_ERROR
A rule defined by the cross selling distributor has been violated by a line item targeting a shared ad unit. Violating this rule is an error.
DISTRIBUTOR_RULE_VIOLATION_WARNING
A rule defined by the cross selling distributor has been violated by a line item targeting a shared ad unit. Violating this rule is a warning.

By setting LineItem.skipCrossSellingRuleWarningChecks, the content partner can suppress the warning (and create or save the line item).

This flag is available beginning in V201411.

UNKNOWN
The value returned if the actual value is not exposed by the requested API version.