type CreativeAssetMacroError (v202408)
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/v202408
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 lists all errors associated with creative asset macros.\u003c/p\u003e\n"],["\u003cp\u003eThis error is part of the CreativeService and inherits from ApiError.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field provides an enum value indicating the specific error (e.g., INVALID_MACRO_NAME).\u003c/p\u003e\n"],["\u003cp\u003eMacro names have specific requirements: starting with an alpha character, consisting of alpha-numeric characters and underscores, and having a length between 1 and 64 characters.\u003c/p\u003e\n"]]],["The content details errors associated with the `CreativeService`, particularly focusing on `CreativeAssetMacroError`. This service utilizes inheritance from `ApiError`, with a list of potential errors that may occur. Key actions involve identifying error causes through `fieldPath`, `fieldPathElements`, and `trigger`. The `CreativeAssetMacroError` enum specifies error `reasons`, like `INVALID_MACRO_NAME` (for naming violations) and `UNKNOWN` for unsupported API values. Core data is provided through namespaces and field-specific details.\n"],null,["# type CreativeAssetMacroError (v202408)\n\n**Service** \n**CreativeService** [CreativeSetService](/ad-manager/api/reference/v202408/CreativeSetService.CreativeAssetMacroError) [LineItemCreativeAssociationService](/ad-manager/api/reference/v202408/LineItemCreativeAssociationService.CreativeAssetMacroError) **Inheritance** \n[ApiError](/ad-manager/api/reference/v202408/CreativeService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202408/CreativeService.ApiVersionError) [AssetError](/ad-manager/api/reference/v202408/CreativeService.AssetError) [AuthenticationError](/ad-manager/api/reference/v202408/CreativeService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/CreativeService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/CreativeService.CommonError) **CreativeAssetMacroError** [CreativeError](/ad-manager/api/reference/v202408/CreativeService.CreativeError) [CreativeSetError](/ad-manager/api/reference/v202408/CreativeService.CreativeSetError) [CreativeTemplateError](/ad-manager/api/reference/v202408/CreativeService.CreativeTemplateError) [CreativeTemplateOperationError](/ad-manager/api/reference/v202408/CreativeService.CreativeTemplateOperationError) [CustomCreativeError](/ad-manager/api/reference/v202408/CreativeService.CustomCreativeError) [CustomFieldValueError](/ad-manager/api/reference/v202408/CreativeService.CustomFieldValueError) [EntityLimitReachedError](/ad-manager/api/reference/v202408/CreativeService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202408/CreativeService.FeatureError) [FileError](/ad-manager/api/reference/v202408/CreativeService.FileError) [HtmlBundleProcessorError](/ad-manager/api/reference/v202408/CreativeService.HtmlBundleProcessorError) [ImageError](/ad-manager/api/reference/v202408/CreativeService.ImageError) [InternalApiError](/ad-manager/api/reference/v202408/CreativeService.InternalApiError) [InvalidPhoneNumberError](/ad-manager/api/reference/v202408/CreativeService.InvalidPhoneNumberError) [InvalidUrlError](/ad-manager/api/reference/v202408/CreativeService.InvalidUrlError) [LabelEntityAssociationError](/ad-manager/api/reference/v202408/CreativeService.LabelEntityAssociationError) [LineItemCreativeAssociation...](/ad-manager/api/reference/v202408/CreativeService.LineItemCreativeAssociationError \"LineItemCreativeAssociationError\") [NotNullError](/ad-manager/api/reference/v202408/CreativeService.NotNullError) [NullError](/ad-manager/api/reference/v202408/CreativeService.NullError) [ParseError](/ad-manager/api/reference/v202408/CreativeService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/CreativeService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/CreativeService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/CreativeService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/CreativeService.QuotaError) [RangeError](/ad-manager/api/reference/v202408/CreativeService.RangeError) [RequiredCollectionError](/ad-manager/api/reference/v202408/CreativeService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/CreativeService.RequiredError) [RequiredNumberError](/ad-manager/api/reference/v202408/CreativeService.RequiredNumberError) [RequiredSizeError](/ad-manager/api/reference/v202408/CreativeService.RequiredSizeError) [RichMediaStudioCreativeError](/ad-manager/api/reference/v202408/CreativeService.RichMediaStudioCreativeError) [ServerError](/ad-manager/api/reference/v202408/CreativeService.ServerError) [SetTopBoxCreativeError](/ad-manager/api/reference/v202408/CreativeService.SetTopBoxCreativeError) [StatementError](/ad-manager/api/reference/v202408/CreativeService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/CreativeService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/CreativeService.StringLengthError) [SwiffyConversionError](/ad-manager/api/reference/v202408/CreativeService.SwiffyConversionError) [TemplateInstantiatedCreativ...](/ad-manager/api/reference/v202408/CreativeService.TemplateInstantiatedCreativeError \"TemplateInstantiatedCreativeError\") [TranscodingError](/ad-manager/api/reference/v202408/CreativeService.TranscodingError) [TypeError](/ad-manager/api/reference/v202408/CreativeService.TypeError) [UniqueError](/ad-manager/api/reference/v202408/CreativeService.UniqueError)\n\nLists all errors associated with creative asset macros.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202408`\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/v202408/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/v202408/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 |"]]
