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 within the Google Ad Manager API, specifically for the CustomFieldService.\u003c/p\u003e\n"],["\u003cp\u003eIt outlines the structure and fields associated with this error, including inherited fields from \u003ccode\u003eApiError\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThis error is triggered when input string values 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 field information for troubleshooting and resolving string format issues in their Ad Manager integrations.\u003c/p\u003e\n"]]],["This document outlines various services within an ad management API, including AdRule, Adjustment, AdsTxt, AudienceSegment, and many others, totaling over 40 services. It also details the `CustomFieldService`, the errors it handles. The `StringFormatError` is a set of error codes related to invalid string inputs, specifying reasons such as `ILLEGAL_CHARS` and `INVALID_FORMAT`. It inherits from `ApiError`, adding a reason field specifying the exact issue with a 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](/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** [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/CustomFieldService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202411/CustomFieldService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202411/CustomFieldService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/CustomFieldService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/CustomFieldService.CommonError) [CustomFieldError](/ad-manager/api/reference/v202411/CustomFieldService.CustomFieldError) [EntityLimitReachedError](/ad-manager/api/reference/v202411/CustomFieldService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202411/CustomFieldService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202411/CustomFieldService.InternalApiError) [NotNullError](/ad-manager/api/reference/v202411/CustomFieldService.NotNullError) [NullError](/ad-manager/api/reference/v202411/CustomFieldService.NullError) [ParseError](/ad-manager/api/reference/v202411/CustomFieldService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/CustomFieldService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/CustomFieldService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/CustomFieldService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/CustomFieldService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202411/CustomFieldService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/CustomFieldService.RequiredError) [ServerError](/ad-manager/api/reference/v202411/CustomFieldService.ServerError) [StatementError](/ad-manager/api/reference/v202411/CustomFieldService.StatementError) **StringFormatError** [StringLengthError](/ad-manager/api/reference/v202411/CustomFieldService.StringLengthError) [TypeError](/ad-manager/api/reference/v202411/CustomFieldService.TypeError) [UniqueError](/ad-manager/api/reference/v202411/CustomFieldService.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/CustomFieldService.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/CustomFieldService.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 |"]]
