type CreativeAssetMacroError (v202411)

  • CreativeAssetMacroError indicates issues with creative asset macros, often due to invalid macro names.

  • Macro names must adhere to specific rules: start with a letter, contain only alphanumeric characters and underscores, and be 1-64 characters long.

  • This error is part of the CreativeService and inherits properties from ApiError for detailed debugging.

  • The reason field provides specific information about the error, such as INVALID_MACRO_NAME or UNKNOWN.

  • Developers can use the provided namespace and field details for integrating with the Ad Manager API and handling these errors.
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 creative asset macros.

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.

CreativeAssetMacroError

reason

CreativeAssetMacroError.Reason

The error reason represented by an enum.

Enumerations
INVALID_MACRO_NAME
Invalid macro name specified. Macro names must start with an alpha character and consist only of alpha-numeric characters and underscores and be between 1 and 64 characters.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.