type CreativeAssetMacroError (v202411)
Stay organized with collections
Save and categorize content based on your preferences.
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.
|
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 2025-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eCreativeAssetMacroError indicates issues with creative asset macros, often due to invalid macro names.\u003c/p\u003e\n"],["\u003cp\u003eMacro names must adhere to specific rules: start with a letter, contain only alphanumeric characters and underscores, and be 1-64 characters long.\u003c/p\u003e\n"],["\u003cp\u003eThis error is part of the CreativeService and inherits properties from ApiError for detailed debugging.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field provides specific information about the error, such as \u003ccode\u003eINVALID_MACRO_NAME\u003c/code\u003e or \u003ccode\u003eUNKNOWN\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use the provided namespace and field details for integrating with the Ad Manager API and handling these errors.\u003c/p\u003e\n"]]],["The core content outlines the `CreativeService` and its associated error types, detailing the inheritance of `ApiError`. Key actions involve understanding and handling errors during creative asset operations. Specifically, it lists various error types like `AssetError`, `CreativeError`, `and CreativeSetError`. `CreativeAssetMacroError` is identified with specific reasons, including `INVALID_MACRO_NAME` (macro naming violations) and `UNKNOWN` (unspecified errors). Field properties such as `fieldPath`, `trigger`, and `errorString` provide details for each `ApiError`.\n"],null,["# type CreativeAssetMacroError (v202411)\n\n**Service** \n**CreativeService** [CreativeSetService](/ad-manager/api/reference/v202411/CreativeSetService.CreativeAssetMacroError) [LineItemCreativeAssociationService](/ad-manager/api/reference/v202411/LineItemCreativeAssociationService.CreativeAssetMacroError) **Inheritance** \n[ApiError](/ad-manager/api/reference/v202411/CreativeService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202411/CreativeService.ApiVersionError) [AssetError](/ad-manager/api/reference/v202411/CreativeService.AssetError) [AuthenticationError](/ad-manager/api/reference/v202411/CreativeService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/CreativeService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/CreativeService.CommonError) **CreativeAssetMacroError** [CreativeError](/ad-manager/api/reference/v202411/CreativeService.CreativeError) [CreativeSetError](/ad-manager/api/reference/v202411/CreativeService.CreativeSetError) [CreativeTemplateError](/ad-manager/api/reference/v202411/CreativeService.CreativeTemplateError) [CreativeTemplateOperationError](/ad-manager/api/reference/v202411/CreativeService.CreativeTemplateOperationError) [CustomCreativeError](/ad-manager/api/reference/v202411/CreativeService.CustomCreativeError) [CustomFieldValueError](/ad-manager/api/reference/v202411/CreativeService.CustomFieldValueError) [EntityLimitReachedError](/ad-manager/api/reference/v202411/CreativeService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202411/CreativeService.FeatureError) [FileError](/ad-manager/api/reference/v202411/CreativeService.FileError) [HtmlBundleProcessorError](/ad-manager/api/reference/v202411/CreativeService.HtmlBundleProcessorError) [ImageError](/ad-manager/api/reference/v202411/CreativeService.ImageError) [InternalApiError](/ad-manager/api/reference/v202411/CreativeService.InternalApiError) [InvalidPhoneNumberError](/ad-manager/api/reference/v202411/CreativeService.InvalidPhoneNumberError) [InvalidUrlError](/ad-manager/api/reference/v202411/CreativeService.InvalidUrlError) [LabelEntityAssociationError](/ad-manager/api/reference/v202411/CreativeService.LabelEntityAssociationError) [LineItemCreativeAssociation...](/ad-manager/api/reference/v202411/CreativeService.LineItemCreativeAssociationError \"LineItemCreativeAssociationError\") [NotNullError](/ad-manager/api/reference/v202411/CreativeService.NotNullError) [NullError](/ad-manager/api/reference/v202411/CreativeService.NullError) [ParseError](/ad-manager/api/reference/v202411/CreativeService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/CreativeService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/CreativeService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/CreativeService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/CreativeService.QuotaError) [RangeError](/ad-manager/api/reference/v202411/CreativeService.RangeError) [RequiredCollectionError](/ad-manager/api/reference/v202411/CreativeService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/CreativeService.RequiredError) [RequiredNumberError](/ad-manager/api/reference/v202411/CreativeService.RequiredNumberError) [RequiredSizeError](/ad-manager/api/reference/v202411/CreativeService.RequiredSizeError) [RichMediaStudioCreativeError](/ad-manager/api/reference/v202411/CreativeService.RichMediaStudioCreativeError) [ServerError](/ad-manager/api/reference/v202411/CreativeService.ServerError) [SetTopBoxCreativeError](/ad-manager/api/reference/v202411/CreativeService.SetTopBoxCreativeError) [StatementError](/ad-manager/api/reference/v202411/CreativeService.StatementError) [StringFormatError](/ad-manager/api/reference/v202411/CreativeService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202411/CreativeService.StringLengthError) [SwiffyConversionError](/ad-manager/api/reference/v202411/CreativeService.SwiffyConversionError) [TemplateInstantiatedCreativ...](/ad-manager/api/reference/v202411/CreativeService.TemplateInstantiatedCreativeError \"TemplateInstantiatedCreativeError\") [TranscodingError](/ad-manager/api/reference/v202411/CreativeService.TranscodingError) [TypeError](/ad-manager/api/reference/v202411/CreativeService.TypeError) [UniqueError](/ad-manager/api/reference/v202411/CreativeService.UniqueError)\n\nLists all errors associated with creative asset macros.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202411`\n\n| Field ----- ||\n|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **`ApiError` (inherited)** ||\n| ### `fieldPath` | ` `xsd:`string` The OGNL field path to identify cause of error. |\n| ### `fieldPathElements` | ` `[FieldPathElement](/ad-manager/api/reference/v202411/CreativeService.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)}. |\n| ### `trigger` | ` `xsd:`string` The data that caused the error. |\n| ### `errorString` | ` `xsd:`string` A simple string representation of the error and reason. |\n| **`CreativeAssetMacroError`** ||\n| ### `reason` | ` `[CreativeAssetMacroError.Reason](/ad-manager/api/reference/v202411/CreativeService.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. \u003cbr /\u003e |"]]
