Looking for a REST API? The Ad Manager API (Beta) is now available.

type ExchangeSignupApiError (v202411)

AI-generated Key Takeaways

ExchangeSignupApiError objects are returned when exceptions occur within the ExchangeSignupService.
These errors inherit properties from the ApiError object, including fieldPath, fieldPathElements, trigger, and errorString, for detailed error information.
The reason field provides specific context about the Exchange signup error, with enumerated values like ADSENSE_ACCOUNT_CREATION_ERROR or FAILED_TO_ADD_WEBSITE_TO_PROPERTY.
Errors can be due to issues like AdSense account creation, website linking, product configuration, or account readiness.
The namespace for this error is https://www.google.com/apis/ads/publisher/v202411.

Service

CompanyService NetworkService

Inheritance

ApiError

▼

ApiVersionError AuthenticationError CollectionSizeError CommonError ExchangeSignupApiError FeatureError InternalApiError InvalidEmailError InventoryClientApiError LiveStreamEventSlateError McmError NetworkError NotNullError ParseError PermissionError PrecisionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequestError RequiredCollectionError RequiredError RequiredNumberError ServerError SetTopBoxCreativeError StatementError StringFormatError StringLengthError TypeError UniqueError UrlError

ApiError for exceptions thrown by ExchangeSignupService.

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.
`ExchangeSignupApiError`
`reason`	`ExchangeSignupApiError.Reason` Enumerations `ADSENSE_ACCOUNT_CREATION_ERROR` `ADSENSE_ACCOUNT_ALREADY_HAS_EXCHANGE` `FAILED_TO_ADD_WEBSITE_TO_PROPERTY` `FAILED_TO_CREATE_LINK_FOR_NEW_ACCOUNT` `CANNOT_CREATE_NEW_ACCOUNT_FOR_MAPPED_CUSTOMER` `FAILED_TO_CREATE_EXCHANGE_SETTINGS` `DUPLICATE_PRODUCT_TYPE` `INVALID_SIGNUP_PRODUCT` `UNKNOWN_PRODUCT` `BAD_SITE_VERIFICATION_UPDATE_REQUEST` `NO_EXCHANGE_ACCOUNT` `SINGLE_SYNDICATION_PRODUCT` `ACCOUNT_NOT_YET_READY` `MULTIPLE_ADSENSE_ACCOUNTS_NOT_ALLOWED` `MISSING_LEGAL_ENTITY_NAME` `MISSING_ACTIVE_BILLING_PROFILE` `UNKNOWN` The value returned if the actual value is not exposed by the requested API version.