type StringLengthError (v202411)

  • The StringLengthError object in Google Ad Manager's API signals issues with string values exceeding or falling short of specified length restrictions.

  • This error typically occurs when creating or updating entities and includes details like the problematic field (fieldPath) and the nature of the length violation (reason).

  • StringLengthError is part of the error hierarchy, inheriting from ApiError, providing standard fields for diagnosing errors, such as fieldPath, trigger, and errorString.

  • Developers should validate string lengths against defined constraints before interacting with the API to avoid encountering this error.

  • The reason field clarifies if the error is due to a string being too long (TOO_LONG) or too short (TOO_SHORT).

Errors for Strings which do not meet given length constraints.


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.

StringLengthError

reason

StringLengthError.Reason


Enumerations
TOO_LONG
TOO_SHORT
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.