type StringFormatError (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
A list of error code for reporting invalid content of input strings.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202408
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eThe CreativeWrapperService allows for management and execution of creative wrappers in Google Ad Manager.\u003c/p\u003e\n"],["\u003cp\u003eThis page details the \u003ccode\u003eStringFormatError\u003c/code\u003e within the CreativeWrapperService, which arises from issues with the format or characters of input strings.\u003c/p\u003e\n"],["\u003cp\u003eErrors are categorized by reasons such as \u003ccode\u003eILLEGAL_CHARS\u003c/code\u003e or \u003ccode\u003eINVALID_FORMAT\u003c/code\u003e to specify the nature of the string formatting issue.\u003c/p\u003e\n"],["\u003cp\u003eThis documentation provides information for developers to understand and troubleshoot errors related to string formatting when using the CreativeWrapperService.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use this information to identify and resolve errors to ensure the smooth operation of creative wrappers in their ad campaigns.\u003c/p\u003e\n"]]],["The document outlines various services within an ad management API, including AdRule, Adjustment, AdsTxt, AudienceSegment, and many others, totaling over 40. It also details the `CreativeWrapperService` and its error reporting, specifically `StringFormatError`. This error type signals issues with input string data, and can be due to illegal characters or an invalid format. The errors provide information such as field path, trigger, and a descriptive string to indicate the source and type of the problem.\n"],null,["# type StringFormatError (v202408)\n\n**Service** \n[AdRuleService](/ad-manager/api/reference/v202408/AdRuleService.StringFormatError) [AdjustmentService](/ad-manager/api/reference/v202408/AdjustmentService.StringFormatError) [AdsTxtService](/ad-manager/api/reference/v202408/AdsTxtService.StringFormatError) [AudienceSegmentService](/ad-manager/api/reference/v202408/AudienceSegmentService.StringFormatError) [CdnConfigurationService](/ad-manager/api/reference/v202408/CdnConfigurationService.StringFormatError) [CmsMetadataService](/ad-manager/api/reference/v202408/CmsMetadataService.StringFormatError) [CompanyService](/ad-manager/api/reference/v202408/CompanyService.StringFormatError) [ContactService](/ad-manager/api/reference/v202408/ContactService.StringFormatError) [ContentBundleService](/ad-manager/api/reference/v202408/ContentBundleService.StringFormatError) [ContentService](/ad-manager/api/reference/v202408/ContentService.StringFormatError) [CreativeService](/ad-manager/api/reference/v202408/CreativeService.StringFormatError) [CreativeSetService](/ad-manager/api/reference/v202408/CreativeSetService.StringFormatError) [CreativeTemplateService](/ad-manager/api/reference/v202408/CreativeTemplateService.StringFormatError) **CreativeWrapperService** [CustomFieldService](/ad-manager/api/reference/v202408/CustomFieldService.StringFormatError) [CustomTargetingService](/ad-manager/api/reference/v202408/CustomTargetingService.StringFormatError) [DaiAuthenticationKeyService](/ad-manager/api/reference/v202408/DaiAuthenticationKeyService.StringFormatError) [DaiEncodingProfileService](/ad-manager/api/reference/v202408/DaiEncodingProfileService.StringFormatError) [ForecastService](/ad-manager/api/reference/v202408/ForecastService.StringFormatError) [InventoryService](/ad-manager/api/reference/v202408/InventoryService.StringFormatError) [LabelService](/ad-manager/api/reference/v202408/LabelService.StringFormatError) [LineItemCreativeAssociationService](/ad-manager/api/reference/v202408/LineItemCreativeAssociationService.StringFormatError) [LineItemService](/ad-manager/api/reference/v202408/LineItemService.StringFormatError) [LineItemTemplateService](/ad-manager/api/reference/v202408/LineItemTemplateService.StringFormatError) [LiveStreamEventService](/ad-manager/api/reference/v202408/LiveStreamEventService.StringFormatError) [MobileApplicationService](/ad-manager/api/reference/v202408/MobileApplicationService.StringFormatError) [NativeStyleService](/ad-manager/api/reference/v202408/NativeStyleService.StringFormatError) [NetworkService](/ad-manager/api/reference/v202408/NetworkService.StringFormatError) [OrderService](/ad-manager/api/reference/v202408/OrderService.StringFormatError) [PlacementService](/ad-manager/api/reference/v202408/PlacementService.StringFormatError) [ProposalLineItemService](/ad-manager/api/reference/v202408/ProposalLineItemService.StringFormatError) [ProposalService](/ad-manager/api/reference/v202408/ProposalService.StringFormatError) [PublisherQueryLanguageService](/ad-manager/api/reference/v202408/PublisherQueryLanguageService.StringFormatError) [ReportService](/ad-manager/api/reference/v202408/ReportService.StringFormatError) [SegmentPopulationService](/ad-manager/api/reference/v202408/SegmentPopulationService.StringFormatError) [SiteService](/ad-manager/api/reference/v202408/SiteService.StringFormatError) [StreamActivityMonitorService](/ad-manager/api/reference/v202408/StreamActivityMonitorService.StringFormatError) [SuggestedAdUnitService](/ad-manager/api/reference/v202408/SuggestedAdUnitService.StringFormatError) [TargetingPresetService](/ad-manager/api/reference/v202408/TargetingPresetService.StringFormatError) [TeamService](/ad-manager/api/reference/v202408/TeamService.StringFormatError) [UserService](/ad-manager/api/reference/v202408/UserService.StringFormatError) [UserTeamAssociationService](/ad-manager/api/reference/v202408/UserTeamAssociationService.StringFormatError) [YieldGroupService](/ad-manager/api/reference/v202408/YieldGroupService.StringFormatError) **Inheritance** \n[ApiError](/ad-manager/api/reference/v202408/CreativeWrapperService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202408/CreativeWrapperService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/CreativeWrapperService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/CreativeWrapperService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/CreativeWrapperService.CommonError) [CreativeWrapperError](/ad-manager/api/reference/v202408/CreativeWrapperService.CreativeWrapperError) [FeatureError](/ad-manager/api/reference/v202408/CreativeWrapperService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/CreativeWrapperService.InternalApiError) [LabelError](/ad-manager/api/reference/v202408/CreativeWrapperService.LabelError) [NotNullError](/ad-manager/api/reference/v202408/CreativeWrapperService.NotNullError) [NullError](/ad-manager/api/reference/v202408/CreativeWrapperService.NullError) [ParseError](/ad-manager/api/reference/v202408/CreativeWrapperService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/CreativeWrapperService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/CreativeWrapperService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/CreativeWrapperService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/CreativeWrapperService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202408/CreativeWrapperService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/CreativeWrapperService.RequiredError) [ServerError](/ad-manager/api/reference/v202408/CreativeWrapperService.ServerError) [StatementError](/ad-manager/api/reference/v202408/CreativeWrapperService.StatementError) **StringFormatError** [StringLengthError](/ad-manager/api/reference/v202408/CreativeWrapperService.StringLengthError) [TypeError](/ad-manager/api/reference/v202408/CreativeWrapperService.TypeError) [UniqueError](/ad-manager/api/reference/v202408/CreativeWrapperService.UniqueError)\n\nA list of error code for reporting invalid content of input strings.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202408`\n\n| Field ----- ||\n|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **`ApiError` (inherited)** ||\n| ### `fieldPath` | ` `xsd:`string` The OGNL field path to identify cause of error. |\n| ### `fieldPathElements` | ` `[FieldPathElement](/ad-manager/api/reference/v202408/CreativeWrapperService.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)}. |\n| ### `trigger` | ` `xsd:`string` The data that caused the error. |\n| ### `errorString` | ` `xsd:`string` A simple string representation of the error and reason. |\n| **`StringFormatError`** ||\n| ### `reason` | ` `[StringFormatError.Reason](/ad-manager/api/reference/v202408/CreativeWrapperService.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. \u003cbr /\u003e |"]]