type CrossSellError (v202402)
Lists all errors associated with cross selling.
- 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.
|
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.
|
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."],[[["CrossSellError encompasses all errors related to the cross-selling functionality in Google Ad Manager."],["It highlights potential issues during cross-selling setup and operations, including company type mismatches, invalid network codes, and rule violations."],["This error aims to ensure smooth cross-selling processes by flagging configuration errors and potential conflicts."],["Errors can arise from distributor or content provider network settings, partner names, and line item targeting configurations."],["Developers should consult the `CrossSellError.Reason` enum for specific error details and implement appropriate handling logic."]]],["This document outlines error handling within an ad management API, focusing on cross-selling operations. It details the `CrossSellError` type, which inherits from `ApiError`, and specifies various error reasons. These include issues like an incorrect company type, attempts to change a partner's network code, missing partner names, disabled publisher features, invalid partner names or network codes, network conflicts, and violations of distributor rules. Also included are error fields including `fieldPath`, `fieldPathElements`, `trigger` and `errorString`.\n"]]
