type LabelError (v202411)
Stay organized with collections
Save and categorize content based on your preferences.
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eCreativeWrapperService.LabelError\u003c/code\u003e object describes errors specific to labels in Google Ad Manager.\u003c/p\u003e\n"],["\u003cp\u003eThese errors often relate to invalid label prefixes, unsupported characters in label names, or general issues with label properties.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eLabelError\u003c/code\u003e inherits from \u003ccode\u003eApiError\u003c/code\u003e and provides additional context through the \u003ccode\u003ereason\u003c/code\u003e field which is represented by the \u003ccode\u003eLabelError.Reason\u003c/code\u003e enum.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field helps identify specific causes like invalid prefixes ("INVALID_PREFIX") or issues with label names ("NAME_INVALID_CHARS").\u003c/p\u003e\n"],["\u003cp\u003eFurther details on each error type can be found in the linked documentation for \u003ccode\u003eLabelError.Reason\u003c/code\u003e and other related objects.\u003c/p\u003e\n"]]],["The `CreativeWrapperService` utilizes `LabelService` and inherits from `ApiError`. It outlines various error types, including `ApiVersionError`, `AuthenticationError`, `LabelError`, and others. `LabelError` has an associated `LabelError.Reason` enumeration defining error reasons such as `INVALID_PREFIX`, `NAME_INVALID_CHARS`, and `UNKNOWN`. `ApiError` provides fields like `fieldPath`, `fieldPathElements`, `trigger`, and `errorString` to specify error details. The namespace is `https://www.google.com/apis/ads/publisher/v202411`.\n"],null,["# type LabelError (v202411)\n\n**Service** \n**CreativeWrapperService** [LabelService](/ad-manager/api/reference/v202411/LabelService.LabelError) **Inheritance** \n[ApiError](/ad-manager/api/reference/v202411/CreativeWrapperService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202411/CreativeWrapperService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202411/CreativeWrapperService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/CreativeWrapperService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/CreativeWrapperService.CommonError) [CreativeWrapperError](/ad-manager/api/reference/v202411/CreativeWrapperService.CreativeWrapperError) [FeatureError](/ad-manager/api/reference/v202411/CreativeWrapperService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202411/CreativeWrapperService.InternalApiError) **LabelError** [NotNullError](/ad-manager/api/reference/v202411/CreativeWrapperService.NotNullError) [NullError](/ad-manager/api/reference/v202411/CreativeWrapperService.NullError) [ParseError](/ad-manager/api/reference/v202411/CreativeWrapperService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/CreativeWrapperService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/CreativeWrapperService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/CreativeWrapperService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/CreativeWrapperService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202411/CreativeWrapperService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/CreativeWrapperService.RequiredError) [ServerError](/ad-manager/api/reference/v202411/CreativeWrapperService.ServerError) [StatementError](/ad-manager/api/reference/v202411/CreativeWrapperService.StatementError) [StringFormatError](/ad-manager/api/reference/v202411/CreativeWrapperService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202411/CreativeWrapperService.StringLengthError) [TypeError](/ad-manager/api/reference/v202411/CreativeWrapperService.TypeError) [UniqueError](/ad-manager/api/reference/v202411/CreativeWrapperService.UniqueError)\n\nErrors specific to labels.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202411`\n\n| Field ----- ||\n|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **`ApiError` (inherited)** ||\n| ### `fieldPath` | ` `xsd:`string` The OGNL field path to identify cause of error. |\n| ### `fieldPathElements` | ` `[FieldPathElement](/ad-manager/api/reference/v202411/CreativeWrapperService.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)}. |\n| ### `trigger` | ` `xsd:`string` The data that caused the error. |\n| ### `errorString` | ` `xsd:`string` A simple string representation of the error and reason. |\n| **`LabelError`** ||\n| ### `reason` | ` `[LabelError.Reason](/ad-manager/api/reference/v202411/CreativeWrapperService.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](/ad-manager/api/reference/v202411/LabelService.Label#name) contains unsupported or reserved characters. `UNKNOWN` : The value returned if the actual value is not exposed by the requested API version. \u003cbr /\u003e |"]]
