type StringFormatError (v202411)Stay organized with collectionsSave and categorize content based on your preferences.
Page Summary
StringFormatError is a type of ApiError that reports invalid content in input strings.
It contains inherited fields such as fieldPath, fieldPathElements, trigger, and errorString from ApiError.
Specific to StringFormatError is thereasonfield, which provides details on why the string format is invalid, such as illegal characters or invalid format.
The reasons for a StringFormatError are listed as UNKNOWN, ILLEGAL_CHARS, and INVALID_FORMAT.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-06 UTC."],[],["This document outlines various services within an ad management API, including `AdRuleService`, `AdjustmentService`, and `ContactService`, among others. It details error types, notably `StringFormatError`, which reports issues with invalid input strings. `StringFormatError` has a `reason` field to describe the error, with possible values: `ILLEGAL_CHARS` for disallowed characters or `INVALID_FORMAT` for strings not matching the required format. `ApiError` have fields such as `fieldPath`, `trigger` and `errorString` to explain the context and the cause of error.\n"]]
