Looking for a REST API? The Ad Manager API (Beta) is now available.

type StringLengthError (v202505)

AI-generated Key Takeaways

The document describes the StringLengthError in the Ad Manager API, which occurs when strings do not meet length constraints.
StringLengthError inherits from ApiError and includes fields like fieldPath, trigger, and errorString.
The specific reason for the StringLengthError is indicated by the 'reason' field, which can be TOO_LONG, TOO_SHORT, or UNKNOWN.
This error is associated with various services within the Ad Manager API, such as AdRuleService, CreativeService, and many others.

Service

AdRuleService AdjustmentService AdsTxtService AudienceSegmentService CdnConfigurationService CmsMetadataService CompanyService ContactService ContentBundleService ContentService CreativeService CreativeSetService CreativeTemplateService CreativeWrapperService CustomFieldService CustomTargetingService DaiAuthenticationKeyService DaiEncodingProfileService ForecastService InventoryService LabelService LineItemCreativeAssociationService LineItemService LineItemTemplateService LiveStreamEventService MobileApplicationService NativeStyleService NetworkService OrderService PlacementService ProposalLineItemService ProposalService PublisherQueryLanguageService ReportService SegmentPopulationService SiteService StreamActivityMonitorService SuggestedAdUnitService TargetingPresetService TeamService UserService UserTeamAssociationService YieldGroupService

Inheritance

ApiError

▼

ApiVersionError AuthenticationError CollectionSizeError CommonError CreativeTemplateError CreativeTemplateOperationError FeatureError InternalApiError InvalidUrlError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequiredCollectionError RequiredError RequiredNumberError ServerError StatementError StringFormatError StringLengthError UniqueError

Errors for Strings which do not meet given length constraints.

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.
`StringLengthError`
`reason`	`StringLengthError.Reason` Enumerations `TOO_LONG` `TOO_SHORT` `UNKNOWN` The value returned if the actual value is not exposed by the requested API version.