type CustomFieldError (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
Service
CustomFieldService
Errors specific to editing custom fields
- 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.
|
CustomFieldError
|
reason
|
CustomFieldError.Reason
The error reason represented by an enum.
Enumerations
-
INVALID_CUSTOM_FIELD_FOR_OPTION
- An attempt was made to create a CustomFieldOption for
a CustomField that does not have CustomFieldDataType.DROPDOWN.
-
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\u003eCustomFieldService\u003c/code\u003e allows management of custom fields and their associated errors within Google Ad Manager.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCustomFieldError\u003c/code\u003e is a key error type specific to custom field operations, often arising from mismatches between field types and options.\u003c/p\u003e\n"],["\u003cp\u003eErrors are categorized by reasons like \u003ccode\u003eINVALID_CUSTOM_FIELD_FOR_OPTION\u003c/code\u003e, signaling incorrect use of custom field options.\u003c/p\u003e\n"],["\u003cp\u003eEach error provides details like \u003ccode\u003efieldPath\u003c/code\u003e, \u003ccode\u003etrigger\u003c/code\u003e, and \u003ccode\u003eerrorString\u003c/code\u003e for debugging.\u003c/p\u003e\n"],["\u003cp\u003eThe documentation provides a detailed breakdown of error types and their potential causes within the \u003ccode\u003eCustomFieldService\u003c/code\u003e.\u003c/p\u003e\n"]]],["The `CustomFieldService` defines errors for managing custom fields. It inherits from `ApiError`, which includes properties like `fieldPath`, `fieldPathElements`, `trigger`, and `errorString`. `CustomFieldError`, a type of `ApiError`, specifies errors related to custom field editing, identified by a `reason` enum. This includes `INVALID_CUSTOM_FIELD_FOR_OPTION` when creating options for non-dropdown fields and `UNKNOWN` for unexposed values. The namespace is `https://www.google.com/apis/ads/publisher/v202408`.\n"],null,["# type CustomFieldError (v202408)\n\n**Service** \n**CustomFieldService** **Inheritance** \n[ApiError](/ad-manager/api/reference/v202408/CustomFieldService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202408/CustomFieldService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/CustomFieldService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/CustomFieldService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/CustomFieldService.CommonError) **CustomFieldError** [EntityLimitReachedError](/ad-manager/api/reference/v202408/CustomFieldService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202408/CustomFieldService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/CustomFieldService.InternalApiError) [NotNullError](/ad-manager/api/reference/v202408/CustomFieldService.NotNullError) [NullError](/ad-manager/api/reference/v202408/CustomFieldService.NullError) [ParseError](/ad-manager/api/reference/v202408/CustomFieldService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/CustomFieldService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/CustomFieldService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/CustomFieldService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/CustomFieldService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202408/CustomFieldService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/CustomFieldService.RequiredError) [ServerError](/ad-manager/api/reference/v202408/CustomFieldService.ServerError) [StatementError](/ad-manager/api/reference/v202408/CustomFieldService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/CustomFieldService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/CustomFieldService.StringLengthError) [TypeError](/ad-manager/api/reference/v202408/CustomFieldService.TypeError) [UniqueError](/ad-manager/api/reference/v202408/CustomFieldService.UniqueError)\n\nErrors specific to editing custom fields\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/CustomFieldService.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| **`CustomFieldError`** ||\n| ### `reason` | ` `[CustomFieldError.Reason](/ad-manager/api/reference/v202408/CustomFieldService.CustomFieldError.Reason)` ` The error reason represented by an enum. *** ** * ** *** **Enumerations** `INVALID_CUSTOM_FIELD_FOR_OPTION` : An attempt was made to create a [CustomFieldOption](/ad-manager/api/reference/v202408/CustomFieldService.CustomFieldOption) for a [CustomField](/ad-manager/api/reference/v202408/CustomFieldService.CustomField) that does not have [CustomFieldDataType.DROPDOWN](/ad-manager/api/reference/v202408/CustomFieldService.CustomFieldDataType#DROPDOWN). `UNKNOWN` : The value returned if the actual value is not exposed by the requested API version. \u003cbr /\u003e |"]]
