type CustomFieldValueError (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
Errors specific to editing custom field values
- 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.
|
CustomFieldValueError
|
reason
|
CustomFieldValueError.Reason
The error reason represented by an enum.
Enumerations
-
CUSTOM_FIELD_NOT_FOUND
- An attempt was made to modify or create a CustomFieldValue for
a CustomField that does not exist.
-
CUSTOM_FIELD_INACTIVE
- An attempt was made to create a new value for a custom field
that is inactive.
-
CUSTOM_FIELD_OPTION_NOT_FOUND
- An attempt was made to modify or create a CustomFieldValue corresponding
to a CustomFieldOption that could not be found.
-
INVALID_ENTITY_TYPE
- An attempt was made to modify or create a CustomFieldValue with an
association to an entity of the wrong type for its field.
-
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\u003eLineItemTemplateService\u003c/code\u003e allows for management of line item templates within Google Ad Manager.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCustomFieldValueError\u003c/code\u003e occurs when there's an issue with custom field values, such as referencing a non-existent, inactive, or mismatched custom field or option.\u003c/p\u003e\n"],["\u003cp\u003eThis error can arise when creating or updating line item templates through the \u003ccode\u003eLineItemTemplateService\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCustomFieldValueError\u003c/code\u003e provides specific reasons for the error, like a missing custom field, inactive custom field, or invalid entity type, aiding in troubleshooting.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers should ensure custom field values are valid and correspond to active, existing custom fields to avoid encountering this error.\u003c/p\u003e\n"]]],["This document details error handling within ad management services, specifically focusing on `CustomFieldValueError`. It lists various services, including `CompanyService`, `CreativeService`, `LineItemService`, and `LineItemTemplateService`, that utilize these error types. The `CustomFieldValueError` contains a `reason` field, and uses an enum that includes errors like `CUSTOM_FIELD_NOT_FOUND`, `CUSTOM_FIELD_INACTIVE`, `CUSTOM_FIELD_OPTION_NOT_FOUND`, and `INVALID_ENTITY_TYPE`, all related to problems with custom field values or option modifications. It inherit from `ApiError` which contains details like `fieldPath`, `trigger`, and `errorString`.\n"],null,[]]
