type CustomFieldValueError (v202411)

  • CustomFieldValueError occurs when there are issues related to editing custom field values in Google Ad Manager.

  • This error can arise due to various reasons such as referencing a non-existent or inactive custom field, using an invalid custom field option, or associating the custom field with an incorrect entity type.

  • CustomFieldValueError inherits from ApiError, which provides additional context about the error, including the field path, trigger, and error string.

  • The reason field in CustomFieldValueError provides a specific enum value indicating the cause of the error.

  • This error is commonly encountered when using services like CompanyService, CreativeService, and others that involve custom fields.
Service
CompanyService CreativeService CreativeSetService ForecastService LineItemCreativeAssociationService LineItemService LineItemTemplateService OrderService ProposalLineItemService ProposalService UserService
Inheritance
ApiError
▼
ApiVersionError AuthenticationError CollectionSizeError CommonError CustomFieldValueError EntityLimitReachedError FeatureError InternalApiError InvalidEmailError NotNullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError TeamError TimeZoneError TokenError TypeError UniqueError

Errors specific to editing custom field values

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.

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.