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\u003eThe \u003ccode\u003eCustomTargetingService\u003c/code\u003e allows management of custom targeting keys and values.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods for creating, updating, and querying custom targeting objects.\u003c/p\u003e\n"],["\u003cp\u003eErrors, including \u003ccode\u003eStringFormatError\u003c/code\u003e, may occur if input data is invalid.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eStringFormatError\u003c/code\u003e arises when input strings have disallowed characters or an invalid format.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field in \u003ccode\u003eStringFormatError\u003c/code\u003e specifies the cause of the error, such as illegal characters or format issues.\u003c/p\u003e\n"]]],["The document outlines various services and error types within an ad management API, version 202408. It details services like `AdRuleService`, `AdjustmentService`, and `CustomTargetingService`. A core function described is `StringFormatError`, which reports issues with input string formats, specifying reasons such as `ILLEGAL_CHARS` or `INVALID_FORMAT`. Inheritance is used, `ApiError` is base class. Fields within `ApiError`, such as `fieldPath`, `trigger`, and `errorString` are detailed, helping identify error causes.\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** [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](/ad-manager/api/reference/v202408/ReportService.StringFormatError) [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/CustomTargetingService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202408/CustomTargetingService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/CustomTargetingService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/CustomTargetingService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/CustomTargetingService.CommonError) [CustomTargetingError](/ad-manager/api/reference/v202408/CustomTargetingService.CustomTargetingError) [EntityChildrenLimitReachedE...](/ad-manager/api/reference/v202408/CustomTargetingService.EntityChildrenLimitReachedError \"EntityChildrenLimitReachedError\") [EntityLimitReachedError](/ad-manager/api/reference/v202408/CustomTargetingService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202408/CustomTargetingService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/CustomTargetingService.InternalApiError) [NotNullError](/ad-manager/api/reference/v202408/CustomTargetingService.NotNullError) [NullError](/ad-manager/api/reference/v202408/CustomTargetingService.NullError) [ParseError](/ad-manager/api/reference/v202408/CustomTargetingService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/CustomTargetingService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/CustomTargetingService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/CustomTargetingService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/CustomTargetingService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202408/CustomTargetingService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/CustomTargetingService.RequiredError) [ServerError](/ad-manager/api/reference/v202408/CustomTargetingService.ServerError) [StatementError](/ad-manager/api/reference/v202408/CustomTargetingService.StatementError) **StringFormatError** [StringLengthError](/ad-manager/api/reference/v202408/CustomTargetingService.StringLengthError) [TypeError](/ad-manager/api/reference/v202408/CustomTargetingService.TypeError) [UniqueError](/ad-manager/api/reference/v202408/CustomTargetingService.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/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/CustomTargetingService.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/CustomTargetingService.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 |"]]