type ImageError (v202505)

  • The content details errors associated with images within various Ad Manager API services.

  • Image errors can occur for multiple reasons, including invalid format or size, unexpected dimensions, animation issues, color format restrictions, and Flash-related problems.

  • The errors also encompass issues with file size, system errors, asset density, missing primary assets, and unsupported mime types.

  • Specific fields like fieldPath, fieldPathElements, trigger, and errorString provide details to identify the cause of the error.

  • The possible reasons for an ImageError are enumerated, offering specific codes and descriptions for different types of image-related issues.
Service
CreativeService CreativeSetService ForecastService LineItemCreativeAssociationService LineItemService LineItemTemplateService NativeStyleService OrderService
Inheritance
ApiError
▼
ApiVersionError AssetError AudienceExtensionError AudienceSegmentError AuthenticationError ClickTrackingLineItemError CollectionSizeError CommonError CompanyCreditStatusError CreativeError CrossSellError CurrencyCodeError CustomFieldValueError CustomTargetingError DateTimeRangeTargetingError DayPartTargetingError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError ForecastError FrequencyCapError GenericTargetingError GeoTargetingError GrpSettingsError ImageError InternalApiError InvalidEmailError InvalidUrlError InventoryTargetingError LabelEntityAssociationError LineItemActivityAssociation... LineItemCreativeAssociation... LineItemError LineItemFlightDateError LineItemOperationError MobileApplicationTargetingE... NotNullError NullError OrderActionError OrderError ParseError PermissionError PrecisionError ProgrammaticError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RegExError RequestPlatformTargetingError RequiredCollectionError RequiredError RequiredNumberError RequiredSizeError ReservationDetailsError ServerError SetTopBoxLineItemError StatementError StringFormatError StringLengthError TeamError TechnologyTargetingError TemplateInstantiatedCreativ... TimeZoneError TranscodingError TypeError UniqueError UserDomainTargetingError VideoPositionTargetingError

Lists all errors associated with images.

Namespace
https://www.google.com/apis/ads/publisher/v202505

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.

ImageError

reason

ImageError.Reason

The error reason represented by an enum.

Enumerations
INVALID_IMAGE
The file's format is invalid.
INVALID_SIZE
Size.width and Size.height cannot be negative.
UNEXPECTED_SIZE
The actual image size does not match the expected image size.
OVERLAY_SIZE_TOO_LARGE
The size of the asset is larger than that of the overlay creative.
ANIMATED_NOT_ALLOWED
Animated images are not allowed.
ANIMATION_TOO_LONG
Animation length exceeded the allowed policy limit.
CMYK_JPEG_NOT_ALLOWED
Images in CMYK color formats are not allowed.
FLASH_NOT_ALLOWED
Flash files are not allowed.
FLASH_WITHOUT_CLICKTAG
If FlashCreative.clickTagRequired is true, then the flash file is required to have a click tag embedded in it.
ANIMATED_VISUAL_EFFECT
Animated visual effect is not allowed.
FLASH_ERROR
An error was encountered in the flash file.
LAYOUT_PROBLEM
Incorrect image layout.
FLASH_HAS_NETWORK_OBJECTS
Flash files with network objects are not allowed.
FLASH_HAS_NETWORK_METHODS
Flash files with network methods are not allowed.
FLASH_HAS_URL
Flash files with hard-coded click thru URLs are not allowed.
FLASH_HAS_MOUSE_TRACKING
Flash files with mouse tracking are not allowed.
FLASH_HAS_RANDOM_NUM
Flash files that generate or use random numbers are not allowed.
FLASH_SELF_TARGETS
Flash files with self targets are not allowed.
FLASH_BAD_GETURL_TARGET
Flash file contains a bad geturl target.
FLASH_VERSION_NOT_SUPPORTED
Flash or ActionScript version in the submitted file is not supported.
FILE_TOO_LARGE
The uploaded file is too large.
SYSTEM_ERROR_IRS
A system error occurred, please try again.
SYSTEM_ERROR_SCS
A system error occurred, please try again.
UNEXPECTED_PRIMARY_ASSET_DENSITY
The image density for a primary asset was not one of the expected image densities.
DUPLICATE_ASSET_DENSITY
Two or more assets have the same image density.
MISSING_DEFAULT_ASSET
The creative does not contain a primary asset. (For high-density creatives, the primary asset must be a standard image file with 1x density.)
PREVERIFIED_MIMETYPE_NOT_ALLOWED
preverified_mime_type is not in the client spec's allowlist.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.