Looking for a REST API? The Ad Manager API (Beta) is now available.

type CommonError (v202502)

AI-generated Key Takeaways

CommonError represents errors that can be used across various Ad Manager API services.
CommonError inherits from ApiError and includes fields like fieldPath, fieldPathElements, trigger, and errorString.
The CommonError class specifically includes a reason field, which is an enumeration indicating the specific cause of the error.
Possible reasons for a CommonError include NOT_FOUND, ALREADY_EXISTS, CANNOT_UPDATE, UNSUPPORTED_OPERATION, and CONCURRENT_MODIFICATION, among others.

Service

AdRuleService AdjustmentService AdsTxtService AudienceSegmentService CdnConfigurationService CmsMetadataService CompanyService ContactService ContentBundleService ContentService CreativeService CreativeSetService CreativeTemplateService CreativeWrapperService CustomFieldService CustomTargetingService DaiAuthenticationKeyService DaiEncodingProfileService ForecastService InventoryService LabelService LineItemCreativeAssociationService LineItemService LineItemTemplateService LiveStreamEventService MobileApplicationService NativeStyleService NetworkService OrderService PlacementService ProposalLineItemService ProposalService PublisherQueryLanguageService ReportService SegmentPopulationService SiteService StreamActivityMonitorService SuggestedAdUnitService TargetingPresetService TeamService UserService UserTeamAssociationService YieldGroupService

Inheritance

ApiError

▼

ApiVersionError AuthenticationError CollectionSizeError CommonError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError InternalApiError NotNullError NullError ParseError PermissionError PlacementError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RegExError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError TypeError UniqueError

A place for common errors that can be used across services.

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.
`CommonError`
`reason`	`CommonError.Reason` Enumerations `NOT_FOUND` Indicates that an attempt was made to retrieve an entity that does not exist. `ALREADY_EXISTS` Indicates that an attempt was made to create an entity that already exists. `NOT_APPLICABLE` Indicates that a value is not applicable for given use case. `DUPLICATE_OBJECT` Indicates that two elements in the collection were identical. `CANNOT_UPDATE` Indicates that an attempt was made to change an immutable field. `UNSUPPORTED_OPERATION` Indicates that the requested operation is not supported. `CONCURRENT_MODIFICATION` Indicates that another request attempted to update the same data in the same network at about the same time. Please wait and try the request again. `UNKNOWN` The value returned if the actual value is not exposed by the requested API version.