type StringFormatError (v202411)
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/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.
|
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\u003eThis documentation details the \u003ccode\u003eContentBundleService.StringFormatError\u003c/code\u003e object in the Google Ad Manager API.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eContentBundleService.StringFormatError\u003c/code\u003e is used for reporting errors related to invalid formatting of input strings.\u003c/p\u003e\n"],["\u003cp\u003eThe error provides context by including a field path, parsed elements of the path, the triggering data, and an error string.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eStringFormatError.Reason\u003c/code\u003e enum further clarifies the reason for the error, whether due to unknown reasons, illegal characters, or invalid formatting.\u003c/p\u003e\n"]]],["The content outlines various services within an ad management API, including `AdRuleService`, `ContentService`, `ForecastService`, and `ReportService`. It also details the `StringFormatError`, used for reporting issues with input string validity. This error, inheriting from `ApiError`, pinpoints problems via `fieldPath`, `trigger`, and a `reason` enumeration. The `reason` field can specify issues like `ILLEGAL_CHARS` or `INVALID_FORMAT` to describe why a string is unacceptable.\n"],null,["# type StringFormatError (v202411)\n\n**Service** \n[AdRuleService](/ad-manager/api/reference/v202411/AdRuleService.StringFormatError) [AdjustmentService](/ad-manager/api/reference/v202411/AdjustmentService.StringFormatError) [AdsTxtService](/ad-manager/api/reference/v202411/AdsTxtService.StringFormatError) [AudienceSegmentService](/ad-manager/api/reference/v202411/AudienceSegmentService.StringFormatError) [CdnConfigurationService](/ad-manager/api/reference/v202411/CdnConfigurationService.StringFormatError) [CmsMetadataService](/ad-manager/api/reference/v202411/CmsMetadataService.StringFormatError) [CompanyService](/ad-manager/api/reference/v202411/CompanyService.StringFormatError) [ContactService](/ad-manager/api/reference/v202411/ContactService.StringFormatError) **ContentBundleService** [ContentService](/ad-manager/api/reference/v202411/ContentService.StringFormatError) [CreativeService](/ad-manager/api/reference/v202411/CreativeService.StringFormatError) [CreativeSetService](/ad-manager/api/reference/v202411/CreativeSetService.StringFormatError) [CreativeTemplateService](/ad-manager/api/reference/v202411/CreativeTemplateService.StringFormatError) [CreativeWrapperService](/ad-manager/api/reference/v202411/CreativeWrapperService.StringFormatError) [CustomFieldService](/ad-manager/api/reference/v202411/CustomFieldService.StringFormatError) [CustomTargetingService](/ad-manager/api/reference/v202411/CustomTargetingService.StringFormatError) [DaiAuthenticationKeyService](/ad-manager/api/reference/v202411/DaiAuthenticationKeyService.StringFormatError) [DaiEncodingProfileService](/ad-manager/api/reference/v202411/DaiEncodingProfileService.StringFormatError) [ForecastService](/ad-manager/api/reference/v202411/ForecastService.StringFormatError) [InventoryService](/ad-manager/api/reference/v202411/InventoryService.StringFormatError) [LabelService](/ad-manager/api/reference/v202411/LabelService.StringFormatError) [LineItemCreativeAssociationService](/ad-manager/api/reference/v202411/LineItemCreativeAssociationService.StringFormatError) [LineItemService](/ad-manager/api/reference/v202411/LineItemService.StringFormatError) [LineItemTemplateService](/ad-manager/api/reference/v202411/LineItemTemplateService.StringFormatError) [LiveStreamEventService](/ad-manager/api/reference/v202411/LiveStreamEventService.StringFormatError) [MobileApplicationService](/ad-manager/api/reference/v202411/MobileApplicationService.StringFormatError) [NativeStyleService](/ad-manager/api/reference/v202411/NativeStyleService.StringFormatError) [NetworkService](/ad-manager/api/reference/v202411/NetworkService.StringFormatError) [OrderService](/ad-manager/api/reference/v202411/OrderService.StringFormatError) [PlacementService](/ad-manager/api/reference/v202411/PlacementService.StringFormatError) [ProposalLineItemService](/ad-manager/api/reference/v202411/ProposalLineItemService.StringFormatError) [ProposalService](/ad-manager/api/reference/v202411/ProposalService.StringFormatError) [PublisherQueryLanguageService](/ad-manager/api/reference/v202411/PublisherQueryLanguageService.StringFormatError) [ReportService](/ad-manager/api/reference/v202411/ReportService.StringFormatError) [SegmentPopulationService](/ad-manager/api/reference/v202411/SegmentPopulationService.StringFormatError) [SiteService](/ad-manager/api/reference/v202411/SiteService.StringFormatError) [StreamActivityMonitorService](/ad-manager/api/reference/v202411/StreamActivityMonitorService.StringFormatError) [SuggestedAdUnitService](/ad-manager/api/reference/v202411/SuggestedAdUnitService.StringFormatError) [TargetingPresetService](/ad-manager/api/reference/v202411/TargetingPresetService.StringFormatError) [TeamService](/ad-manager/api/reference/v202411/TeamService.StringFormatError) [UserService](/ad-manager/api/reference/v202411/UserService.StringFormatError) [UserTeamAssociationService](/ad-manager/api/reference/v202411/UserTeamAssociationService.StringFormatError) [YieldGroupService](/ad-manager/api/reference/v202411/YieldGroupService.StringFormatError) **Inheritance** \n[ApiError](/ad-manager/api/reference/v202411/ContentBundleService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202411/ContentBundleService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202411/ContentBundleService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/ContentBundleService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/ContentBundleService.CommonError) [ContentFilterError](/ad-manager/api/reference/v202411/ContentBundleService.ContentFilterError) [FeatureError](/ad-manager/api/reference/v202411/ContentBundleService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202411/ContentBundleService.InternalApiError) [NotNullError](/ad-manager/api/reference/v202411/ContentBundleService.NotNullError) [ParseError](/ad-manager/api/reference/v202411/ContentBundleService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/ContentBundleService.PermissionError) [PlacementError](/ad-manager/api/reference/v202411/ContentBundleService.PlacementError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/ContentBundleService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/ContentBundleService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/ContentBundleService.QuotaError) [RequestError](/ad-manager/api/reference/v202411/ContentBundleService.RequestError) [RequiredCollectionError](/ad-manager/api/reference/v202411/ContentBundleService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/ContentBundleService.RequiredError) [ServerError](/ad-manager/api/reference/v202411/ContentBundleService.ServerError) [StatementError](/ad-manager/api/reference/v202411/ContentBundleService.StatementError) **StringFormatError** [StringLengthError](/ad-manager/api/reference/v202411/ContentBundleService.StringLengthError) [UniqueError](/ad-manager/api/reference/v202411/ContentBundleService.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/v202411`\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/v202411/ContentBundleService.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/v202411/ContentBundleService.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 |"]]