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

type StringFormatError (v202505)

AI-generated Key Takeaways

StringFormatError indicates invalid content in input strings.
It includes inherited fields like fieldPath, fieldPathElements, trigger, and errorString from ApiError.
The reason field provides specific details about the string format error, such as ILLEGAL_CHARS or 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 AudienceSegmentError AuthenticationError CollectionSizeError CommonError CustomTargetingError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError InternalApiError NotNullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError TypeError

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.