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\u003eStringFormatError\u003c/code\u003e for the Google Ad Manager API, specifically within the Placement Service.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eStringFormatError\u003c/code\u003e is used to indicate issues with the format or characters within input strings.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use the error's \u003ccode\u003ereason\u003c/code\u003e field to understand the specific problem, such as illegal characters or invalid format for a field.\u003c/p\u003e\n"],["\u003cp\u003eThe error object inherits from \u003ccode\u003eApiError\u003c/code\u003e, providing additional context like \u003ccode\u003efieldPath\u003c/code\u003e and \u003ccode\u003etrigger\u003c/code\u003e.\u003c/p\u003e\n"]]],["This document outlines various services within an ad management API, including `AdRuleService`, `AdjustmentService`, and `CreativeService`, among others. It details error types, specifically the `StringFormatError`, which reports issues with input strings. Key fields for `ApiError` are provided, like `fieldPath` and `errorString`. The `StringFormatError` has a `reason` field that specifies whether illegal characters (`ILLEGAL_CHARS`) or an invalid format (`INVALID_FORMAT`) were found.\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](/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** [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/PlacementService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202411/PlacementService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202411/PlacementService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/PlacementService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/PlacementService.CommonError) [EntityChildrenLimitReachedE...](/ad-manager/api/reference/v202411/PlacementService.EntityChildrenLimitReachedError \"EntityChildrenLimitReachedError\") [EntityLimitReachedError](/ad-manager/api/reference/v202411/PlacementService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202411/PlacementService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202411/PlacementService.InternalApiError) [NotNullError](/ad-manager/api/reference/v202411/PlacementService.NotNullError) [NullError](/ad-manager/api/reference/v202411/PlacementService.NullError) [ParseError](/ad-manager/api/reference/v202411/PlacementService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/PlacementService.PermissionError) [PlacementError](/ad-manager/api/reference/v202411/PlacementService.PlacementError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/PlacementService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/PlacementService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/PlacementService.QuotaError) [RangeError](/ad-manager/api/reference/v202411/PlacementService.RangeError) [RegExError](/ad-manager/api/reference/v202411/PlacementService.RegExError) [RequiredCollectionError](/ad-manager/api/reference/v202411/PlacementService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/PlacementService.RequiredError) [ServerError](/ad-manager/api/reference/v202411/PlacementService.ServerError) [StatementError](/ad-manager/api/reference/v202411/PlacementService.StatementError) **StringFormatError** [StringLengthError](/ad-manager/api/reference/v202411/PlacementService.StringLengthError) [TypeError](/ad-manager/api/reference/v202411/PlacementService.TypeError) [UniqueError](/ad-manager/api/reference/v202411/PlacementService.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/PlacementService.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/PlacementService.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 |"]]
