type LabelError (v202411)

  • LabelError objects represent errors specific to labels in the Google Ad Manager API.

  • These errors inherit properties like fieldPath, trigger, and errorString from the general ApiError type.

  • LabelError objects contain a specific 'reason' field, which is an enum indicating the nature of the label error.

  • Possible reasons for a LabelError include invalid prefixes, unsupported characters in the label name, or other unknown issues.

  • The LabelError structure helps developers to diagnose and address problems related to label creation and management within their Ad Manager integrations.
Service
CreativeWrapperService LabelService
Inheritance
ApiError
▼
ApiVersionError AuthenticationError CollectionSizeError CommonError CreativeWrapperError FeatureError InternalApiError LabelError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError TypeError UniqueError

Errors specific to labels.

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.

LabelError

reason

LabelError.Reason

The error reason represented by an enum.

Enumerations
INVALID_PREFIX
A user created label cannot begin with the Google internal system label prefix.
NAME_INVALID_CHARS
Label.name contains unsupported or reserved characters.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.