type CreativeSetError (v202411)

  • This documentation details the CreativeSetError object within the Google Ad Manager API.

  • CreativeSetError is a subclass of ApiError and is used to represent errors related to creative sets.

  • Several reasons for a CreativeSetError are listed, including video feature requirements, roadblocking limitations, and restrictions on master creatives.

  • The CreativeSetError object contains fields such as reason, fieldPath, fieldPathElements, trigger, and errorString to provide information about the error.

  • Developers should refer to this documentation to understand and handle potential CreativeSetError instances that may arise when working with creative sets in the Ad Manager API.
Service
CreativeService CreativeSetService LineItemCreativeAssociation...
Inheritance
ApiError
▼
AdSenseAccountError ApiVersionError AssetError AudienceExtensionError AuthenticationError CollectionSizeError CommonError CreativeAssetMacroError CreativeError CreativePreviewError CreativeSetError CreativeTemplateError CreativeTemplateOperationError CrossSellError CustomCreativeError CustomFieldValueError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError FileError HtmlBundleProcessorError ImageError InternalApiError InvalidPhoneNumberError InvalidUrlError LabelEntityAssociationError LineItemCreativeAssociation... LineItemCreativeAssociation... LineItemError NotNullError NullError OrderError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequiredCollectionError RequiredError RequiredNumberError RequiredSizeError RichMediaStudioCreativeError ServerError SetTopBoxCreativeError StatementError StringFormatError StringLengthError SwiffyConversionError TemplateInstantiatedCreativ... TranscodingError TypeError UniqueError

Errors relating to creative sets & subclasses.

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.

CreativeSetError

reason

CreativeSetError.Reason

The error reason represented by an enum.

Enumerations
VIDEO_FEATURE_REQUIRED
The 'video' feature is required but not enabled.
CANNOT_CREATE_OR_UPDATE_VIDEO_CREATIVES
Video creatives (including overlays, VAST redirects, etc..) cannot be created or updated through the API.
ROADBLOCK_FEATURE_REQUIRED
The 'roadblock' feature is required but not enabled.
MASTER_CREATIVE_CANNOT_BE_COMPANION
A master creative cannot be a companion creative in the same creative set.
INVALID_ADVERTISER
Creatives in a creative set must be for the same advertiser.
UPDATE_MASTER_CREATIVE_NOT_ALLOWED
Updating a master creative in a creative set is not allowed.
MASTER_CREATIVE_CANNOT_BELONG_TO_MULTIPLE_VIDEO_CREATIVE_SETS
A master creative must belong to only one video creative set.
SKIPPABLE_AD_TYPE_NOT_ALLOWED
The is not allowed.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.