type MetadataMergeSpecError (v202411)

  • The CmsMetadataService handles metadata operations and may return specific errors relating to metadata merge specifications.

  • MetadataMergeSpecError details issues encountered during the merging of metadata, such as conflicting input IDs or improperly defined value ranges.

  • Errors are categorized by reasons like INPUT_ID_ALREADY_USED, BOUND_SPECIFIED_WITHOUT_VALUE, or VALUE_SPECIFIED_WITHOUT_BOUND, offering insight into the cause of the problem.

  • Detailed information on each error, including the field path and a descriptive error string, aids in troubleshooting and resolution.

  • Developers can utilize the provided namespace and field descriptions to interact with the CmsMetadataService and understand potential errors.
Service
CmsMetadataService
Inheritance
ApiError
▼
ApiVersionError AuthenticationError CollectionSizeError CommonError FeatureError InternalApiError MetadataMergeSpecError NotNullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError UniqueError

Errors associated with metadata merge specs.

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.

MetadataMergeSpecError

reason

MetadataMergeSpecError.Reason

The error reason represented by an enum.

Enumerations
INPUT_ID_ALREADY_USED
The merge rule has an input id that is already used by another merge rule.
BOUND_SPECIFIED_WITHOUT_VALUE
The merge rule has an bucket where a bound type was specified without a min/max.
VALUE_SPECIFIED_WITHOUT_BOUND
The merge rule has an bucket where a min/max was specified without a bound type.
MIN_EXCEEDS_MAX
The merge rule has an bucket range where the min exceeds the max.
MORE_THAN_ONE_INPUT_KEY_HAS_VALUE_RULES
Tried to merge two or more rules which have value rules.
VALUE_SPECIFIED_DOES_NOT_MATCH_OUTPUT_KEY
Tried to set a rule for a value that does not match rule output namespace.
CANNOT_MERGE_VALUES_WHERE_VALUE_BUCKET_EXISTS
Tried to merge values on an existing rule that has value bucketing.
CANNOT_MODIFY_RESERVED_KEY
Tried to create a rule that depends on a reserved key.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.