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

type StringFormatError (v202502)

AI-generated Key Takeaways

StringFormatError is an error code for reporting invalid content of input strings within the Ad Manager API.
This error can be caused by illegal characters or an invalid format in the input string value.
The error provides details such as the field path, the data that triggered the error, and a simple string representation of the error reason.
StringFormatError inherits from ApiError, which includes additional fields like fieldPath, fieldPathElements, trigger, and errorString.
The specific reasons for a StringFormatError are UNKNOWN, ILLEGAL_CHARS, and INVALID_FORMAT.

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 EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError InternalApiError NotNullError NullError ParseError PermissionError PlacementError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RegExError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError TypeError UniqueError

A list of error code for reporting invalid content of input strings.

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.
`StringFormatError`
`reason`	`StringFormatError.Reason` Enumerations `UNKNOWN` `ILLEGAL_CHARS` The input string value contains disallowed characters. `INVALID_FORMAT` The input string value is invalid for the associated field.