type StringFormatError (v202411)Stay organized with collectionsSave and categorize content based on your preferences.
Page Summary
StringFormatError is an error code used for reporting invalid content of input strings within the Ad Manager API.
This error can be caused by disallowed characters or an invalid format for the input string value.
The StringFormatError inherits from ApiError and includes fields like fieldPath, trigger, and errorString to help identify the cause and details of the error.
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 `CreativeService`, among others. It details error types, specifically the `StringFormatError`, which reports issues with input strings. Key fields for `ApiError` are provided, like `fieldPath` and `errorString`. The `StringFormatError` has a `reason` field that specifies whether illegal characters (`ILLEGAL_CHARS`) or an invalid format (`INVALID_FORMAT`) were found.\n"]]
