type LabelError (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
Errors specific to labels.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202408
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 CreativeWrapperService LabelError object defines errors specific to labels in Google Ad Manager.\u003c/p\u003e\n"],["\u003cp\u003eLabelError inherits from ApiError and includes fields for identifying the error, such as fieldPath, fieldPathElements, trigger, and errorString.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field provides specific information about the label error, such as invalid prefixes or unsupported characters in the label name.\u003c/p\u003e\n"],["\u003cp\u003eThis error is related to the Label service and often arises when creating or updating labels through the CreativeWrapperService.\u003c/p\u003e\n"],["\u003cp\u003eErrors can include invalid prefixes, unsupported characters in the label name, and other label-specific issues.\u003c/p\u003e\n"]]],["The `CreativeWrapperService` includes error handling related to labels, inheriting from `ApiError` and `LabelService`. It defines various error types, such as `AuthenticationError`, `InternalApiError`, and `QuotaError`, among others. `LabelError` specifies errors specific to labels, with enumerated reasons like `INVALID_PREFIX` (for incorrect label prefixes) and `NAME_INVALID_CHARS` (for unsupported characters in label names). `ApiError` details include field paths, triggers, and error strings for debugging. The service operates within a specific namespace and API version.\n"],null,["# type LabelError (v202408)\n\n**Service** \n**CreativeWrapperService** [LabelService](/ad-manager/api/reference/v202408/LabelService.LabelError) **Inheritance** \n[ApiError](/ad-manager/api/reference/v202408/CreativeWrapperService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202408/CreativeWrapperService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/CreativeWrapperService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/CreativeWrapperService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/CreativeWrapperService.CommonError) [CreativeWrapperError](/ad-manager/api/reference/v202408/CreativeWrapperService.CreativeWrapperError) [FeatureError](/ad-manager/api/reference/v202408/CreativeWrapperService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/CreativeWrapperService.InternalApiError) **LabelError** [NotNullError](/ad-manager/api/reference/v202408/CreativeWrapperService.NotNullError) [NullError](/ad-manager/api/reference/v202408/CreativeWrapperService.NullError) [ParseError](/ad-manager/api/reference/v202408/CreativeWrapperService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/CreativeWrapperService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/CreativeWrapperService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/CreativeWrapperService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/CreativeWrapperService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202408/CreativeWrapperService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/CreativeWrapperService.RequiredError) [ServerError](/ad-manager/api/reference/v202408/CreativeWrapperService.ServerError) [StatementError](/ad-manager/api/reference/v202408/CreativeWrapperService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/CreativeWrapperService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/CreativeWrapperService.StringLengthError) [TypeError](/ad-manager/api/reference/v202408/CreativeWrapperService.TypeError) [UniqueError](/ad-manager/api/reference/v202408/CreativeWrapperService.UniqueError)\n\nErrors specific to labels.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202408`\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/v202408/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/v202408/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/v202408/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 |"]]
