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 page provides information on the \u003ccode\u003eStringFormatError\u003c/code\u003e in Google Ad Manager's AudienceSegmentService.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eStringFormatError\u003c/code\u003e arises when input strings have invalid content, like disallowed characters or incorrect formatting.\u003c/p\u003e\n"],["\u003cp\u003eThis error is part of a broader hierarchy of errors within the Ad Manager API.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use the \u003ccode\u003ereason\u003c/code\u003e field to determine the specific cause of the \u003ccode\u003eStringFormatError\u003c/code\u003e, such as illegal characters or invalid format.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eStringFormatError\u003c/code\u003e includes details like \u003ccode\u003efieldPath\u003c/code\u003e, \u003ccode\u003etrigger\u003c/code\u003e, and \u003ccode\u003eerrorString\u003c/code\u003e for easier debugging.\u003c/p\u003e\n"]]],["The content details various services and errors within an ad management API (v202411). It outlines services like `AdRuleService`, `AudienceSegmentService`, and `ReportService`, alongside others. It specifies an inheritance structure with `ApiError` as the base, and then it focus on `StringFormatError`. `StringFormatError` contains a `reason` field with two enumerations: `ILLEGAL_CHARS` (disallowed characters) and `INVALID_FORMAT` (invalid input string).\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** [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](/ad-manager/api/reference/v202411/ContentBundleService.StringFormatError) [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/AudienceSegmentService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202411/AudienceSegmentService.ApiVersionError) [AudienceSegmentError](/ad-manager/api/reference/v202411/AudienceSegmentService.AudienceSegmentError) [AuthenticationError](/ad-manager/api/reference/v202411/AudienceSegmentService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/AudienceSegmentService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/AudienceSegmentService.CommonError) [CustomTargetingError](/ad-manager/api/reference/v202411/AudienceSegmentService.CustomTargetingError) [EntityChildrenLimitReachedE...](/ad-manager/api/reference/v202411/AudienceSegmentService.EntityChildrenLimitReachedError \"EntityChildrenLimitReachedError\") [EntityLimitReachedError](/ad-manager/api/reference/v202411/AudienceSegmentService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202411/AudienceSegmentService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202411/AudienceSegmentService.InternalApiError) [NotNullError](/ad-manager/api/reference/v202411/AudienceSegmentService.NotNullError) [ParseError](/ad-manager/api/reference/v202411/AudienceSegmentService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/AudienceSegmentService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/AudienceSegmentService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/AudienceSegmentService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/AudienceSegmentService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202411/AudienceSegmentService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/AudienceSegmentService.RequiredError) [ServerError](/ad-manager/api/reference/v202411/AudienceSegmentService.ServerError) [StatementError](/ad-manager/api/reference/v202411/AudienceSegmentService.StatementError) **StringFormatError** [StringLengthError](/ad-manager/api/reference/v202411/AudienceSegmentService.StringLengthError) [TypeError](/ad-manager/api/reference/v202411/AudienceSegmentService.TypeError)\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/AudienceSegmentService.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/AudienceSegmentService.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 |"]]
