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 page provides a detailed list of error codes specifically for invalid content within input strings in the CreativeTemplateService of the Google Ad Manager API.\u003c/p\u003e\n"],["\u003cp\u003eThese error codes help developers identify and resolve issues related to string formatting, illegal characters, and invalid values in their API requests.\u003c/p\u003e\n"],["\u003cp\u003eThe documentation lists specific error reasons like \u003ccode\u003eILLEGAL_CHARS\u003c/code\u003e and \u003ccode\u003eINVALID_FORMAT\u003c/code\u003e, along with detailed descriptions for easier debugging.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eStringFormatError\u003c/code\u003e object contains a \u003ccode\u003ereason\u003c/code\u003e field that provides the specific cause of the error.\u003c/p\u003e\n"],["\u003cp\u003eThis information is crucial for developers using the CreativeTemplateService to ensure their input data is valid and avoid errors.\u003c/p\u003e\n"]]],["This document outlines services and errors within an ad management API (v202408). It details numerous services like AdRuleService, AdjustmentService, and others, each represented by a corresponding class. The inheritance hierarchy is defined, with `ApiError` as the base. `StringFormatError` is identified as an error related to input string validation and defines two reasons: `ILLEGAL_CHARS` for disallowed characters and `INVALID_FORMAT` for format errors. The document also defines the field structure of the `ApiError`.\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** [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](/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/CreativeTemplateService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202408/CreativeTemplateService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/CreativeTemplateService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/CreativeTemplateService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/CreativeTemplateService.CommonError) [CreativeTemplateError](/ad-manager/api/reference/v202408/CreativeTemplateService.CreativeTemplateError) [CreativeTemplateOperationError](/ad-manager/api/reference/v202408/CreativeTemplateService.CreativeTemplateOperationError) [FeatureError](/ad-manager/api/reference/v202408/CreativeTemplateService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/CreativeTemplateService.InternalApiError) [InvalidUrlError](/ad-manager/api/reference/v202408/CreativeTemplateService.InvalidUrlError) [NotNullError](/ad-manager/api/reference/v202408/CreativeTemplateService.NotNullError) [NullError](/ad-manager/api/reference/v202408/CreativeTemplateService.NullError) [ParseError](/ad-manager/api/reference/v202408/CreativeTemplateService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/CreativeTemplateService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/CreativeTemplateService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/CreativeTemplateService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/CreativeTemplateService.QuotaError) [RangeError](/ad-manager/api/reference/v202408/CreativeTemplateService.RangeError) [RequiredCollectionError](/ad-manager/api/reference/v202408/CreativeTemplateService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/CreativeTemplateService.RequiredError) [RequiredNumberError](/ad-manager/api/reference/v202408/CreativeTemplateService.RequiredNumberError) [ServerError](/ad-manager/api/reference/v202408/CreativeTemplateService.ServerError) [StatementError](/ad-manager/api/reference/v202408/CreativeTemplateService.StatementError) **StringFormatError** [StringLengthError](/ad-manager/api/reference/v202408/CreativeTemplateService.StringLengthError) [UniqueError](/ad-manager/api/reference/v202408/CreativeTemplateService.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/CreativeTemplateService.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/CreativeTemplateService.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 |"]]