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

type CustomCreativeError (v202411)

AI-generated Key Takeaways

CustomCreativeError lists all errors associated with custom creatives in the CreativeService.
This error type inherits from ApiError and includes fields like fieldPath, trigger, and errorString.
CustomCreativeError defines a reason field with specific error enumerations such as DUPLICATE_MACRO_NAME_FOR_CREATIVE, SNIPPET_REFERENCES_MISSING_MACRO, and UNRECOGNIZED_MACRO.

Service

CreativeService CreativeSetService LineItemCreativeAssociationService

Inheritance

ApiError

▼

ApiVersionError AssetError AuthenticationError CollectionSizeError CommonError CreativeAssetMacroError CreativeError CreativeSetError CreativeTemplateError CreativeTemplateOperationError CustomCreativeError CustomFieldValueError EntityLimitReachedError FeatureError FileError HtmlBundleProcessorError ImageError InternalApiError InvalidPhoneNumberError InvalidUrlError LabelEntityAssociationError LineItemCreativeAssociation... NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequiredCollectionError RequiredError RequiredNumberError RequiredSizeError RichMediaStudioCreativeError ServerError SetTopBoxCreativeError StatementError StringFormatError StringLengthError SwiffyConversionError TemplateInstantiatedCreativ... TranscodingError TypeError UniqueError

Lists all errors associated with custom creatives.

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.
`CustomCreativeError`
`reason`	`CustomCreativeError.Reason` The error reason represented by an enum. Enumerations `DUPLICATE_MACRO_NAME_FOR_CREATIVE` Macros associated with a single custom creative must have unique names. `SNIPPET_REFERENCES_MISSING_MACRO` The file macro referenced in the snippet does not exist. `UNRECOGNIZED_MACRO` The macro referenced in the snippet is not valid. `CUSTOM_CREATIVE_NOT_ALLOWED` Custom creatives are not allowed in this context. `MISSING_INTERSTITIAL_MACRO` The custom creative is an interstitial, but the snippet is missing an interstitial macro. `DUPLICATE_ASSET_IN_MACROS` Macros associated with the same custom creative cannot share the same asset. `UNKNOWN` The value returned if the actual value is not exposed by the requested API version.