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\u003eThis documentation details the \u003ccode\u003eLabelError\u003c/code\u003e object within the Google Ad Manager API.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eLabelError\u003c/code\u003e objects are returned when an error occurs during operations related to labels.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field within a \u003ccode\u003eLabelError\u003c/code\u003e provides specific information about the cause of the error, such as an invalid label prefix or unsupported characters in the label name.\u003c/p\u003e\n"],["\u003cp\u003eThis error object inherits properties from the more general \u003ccode\u003eApiError\u003c/code\u003e object, offering details like the field path associated with the error.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use the information in \u003ccode\u003eLabelError\u003c/code\u003e objects to troubleshoot and resolve issues encountered while working with labels in their Ad Manager integrations.\u003c/p\u003e\n"]]],["The `LabelService` defines errors for label operations, inheriting from `ApiError`. It includes specific errors like `ApiVersionError`, `AuthenticationError`, and others. `LabelError` contains a `reason` field with possible values: `INVALID_PREFIX`, `NAME_INVALID_CHARS`, or `UNKNOWN`. `ApiError` includes fields like `fieldPath`, `fieldPathElements`, `trigger`, and `errorString` to detail error causes. These elements manage errors within the label API of the `CreativeWrapperService`.\n"],null,["# type LabelError (v202408)\n\n**Service** \n[CreativeWrapperService](/ad-manager/api/reference/v202408/CreativeWrapperService.LabelError) **LabelService** **Inheritance** \n[ApiError](/ad-manager/api/reference/v202408/LabelService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202408/LabelService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/LabelService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/LabelService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/LabelService.CommonError) [CreativeWrapperError](/ad-manager/api/reference/v202408/LabelService.CreativeWrapperError) [FeatureError](/ad-manager/api/reference/v202408/LabelService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/LabelService.InternalApiError) **LabelError** [NotNullError](/ad-manager/api/reference/v202408/LabelService.NotNullError) [NullError](/ad-manager/api/reference/v202408/LabelService.NullError) [ParseError](/ad-manager/api/reference/v202408/LabelService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/LabelService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/LabelService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/LabelService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/LabelService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202408/LabelService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/LabelService.RequiredError) [ServerError](/ad-manager/api/reference/v202408/LabelService.ServerError) [StatementError](/ad-manager/api/reference/v202408/LabelService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/LabelService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/LabelService.StringLengthError) [TypeError](/ad-manager/api/reference/v202408/LabelService.TypeError) [UniqueError](/ad-manager/api/reference/v202408/LabelService.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/LabelService.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/LabelService.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 |"]]
