type MetadataMergeSpecError (v202411)

  • The CmsMetadataService includes various errors related to API interactions, authentication, collection sizes, common issues, features, internal problems, metadata merge specs, null values, parsing, permissions, PQL context and syntax, quotas, ranges, required collections or fields, server issues, statements, and string formats, lengths, or uniqueness.

  • MetadataMergeSpecError is a specific type of error associated with problems during metadata merge specifications.

  • Key fields for ApiError include fieldPath, fieldPathElements, trigger, and errorString, providing details about the error's cause, location, triggering data, and a simple description.

  • MetadataMergeSpecError has a reason field, an enum that indicates specific issues with merge rules, such as duplicate input IDs, invalid bound specifications, min exceeding max, conflicting value rules, value mismatches, inability to merge values with existing bucketing, or attempts to modify reserved keys.
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.