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\u003eThis documentation details the \u003ccode\u003eStringFormatError\u003c/code\u003e within Google Ad Manager's ReportService, indicating issues with input string content.\u003c/p\u003e\n"],["\u003cp\u003eThe error arises when input strings contain disallowed characters or have an invalid format for the associated field.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use the provided error codes and messages to debug and resolve these errors in their integrations.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eStringFormatError\u003c/code\u003e inherits from \u003ccode\u003eApiError\u003c/code\u003e which offers further details on the error including field path, trigger and a simple error message string.\u003c/p\u003e\n"],["\u003cp\u003eThis error is part of the Google Ad Manager API version v202408 namespace \u003ccode\u003ehttps://www.google.com/apis/ads/publisher/v202408\u003c/code\u003e.\u003c/p\u003e\n"]]],["The document outlines various services and error types within an ad management API, version v202408. It details services like AdRule, Adjustment, AdsTxt, AudienceSegment, and ReportService, among others. It specifies an inheritance structure, where `ApiError` is a base type from which other errors like `ApiVersionError`, and `AuthenticationError` derive. `StringFormatError` reports invalid input strings, providing `fieldPath`, `trigger`, and specific reasons such as `ILLEGAL_CHARS` or `INVALID_FORMAT`.\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](/ad-manager/api/reference/v202408/CreativeWrapperService.StringFormatError) [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** [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/ReportService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202408/ReportService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/ReportService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/ReportService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/ReportService.CommonError) [CurrencyCodeError](/ad-manager/api/reference/v202408/ReportService.CurrencyCodeError) [FeatureError](/ad-manager/api/reference/v202408/ReportService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/ReportService.InternalApiError) [NotNullError](/ad-manager/api/reference/v202408/ReportService.NotNullError) [ParseError](/ad-manager/api/reference/v202408/ReportService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/ReportService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/ReportService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/ReportService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/ReportService.QuotaError) [ReportError](/ad-manager/api/reference/v202408/ReportService.ReportError) [RequiredCollectionError](/ad-manager/api/reference/v202408/ReportService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/ReportService.RequiredError) [ServerError](/ad-manager/api/reference/v202408/ReportService.ServerError) [StatementError](/ad-manager/api/reference/v202408/ReportService.StatementError) **StringFormatError** [StringLengthError](/ad-manager/api/reference/v202408/ReportService.StringLengthError)\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/ReportService.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/ReportService.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 |"]]
