type StringFormatError (v202411)

  • This documentation details the StringFormatError in Google Ad Manager's ForecastService, indicating issues with input string content.

  • The error arises when strings have disallowed characters or don't match the expected format for their field.

  • Developers can use the provided reason field to understand the specific cause of the error, aiding in debugging and resolution.

  • The error is part of the ForecastService namespace, impacting operations related to forecasting ad performance.

  • The StringFormatError inherits from ApiError, offering additional context through fields like fieldPath, trigger, and errorString.

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.