type CommonError (v202508)

AI-generated Key Takeaways

• CommonError provides a centralized place for error types used across different services.

• It includes fields like fieldPath, trigger, and errorString for detailed error information, inherited from ApiError.

• The reason field, specific to CommonError, indicates the cause of the error through enumerated values like NOT_FOUND, ALREADY_EXISTS, and UNSUPPORTED_OPERATION.

• The Namespace for these errors is https://www.google.com/apis/ads/publisher/v202508.

Service

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

Inheritance

ApiError

▼

AdSenseAccountError ApiVersionError AssetError AudienceExtensionError AuthenticationError CollectionSizeError CommonError CreativeAssetMacroError CreativeError CreativePreviewError CreativeSetError CreativeTemplateError CreativeTemplateOperationError CrossSellError CustomCreativeError CustomFieldValueError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError FileError HtmlBundleProcessorError ImageError InternalApiError InvalidPhoneNumberError InvalidUrlError LabelEntityAssociationError LineItemCreativeAssociation... LineItemCreativeAssociation... LineItemError NotNullError NullError OrderError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequiredCollectionError RequiredError RequiredNumberError RequiredSizeError RichMediaStudioCreativeError ServerError SetTopBoxCreativeError StatementError StringFormatError StringLengthError SwiffyConversionError TemplateInstantiatedCreativ... TranscodingError TypeError UniqueError

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

---

Namespace

https://www.google.com/apis/ads/publisher/v202508

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. REQUEST_TOO_LARGE Indicates that the request is too large to be processed. This error is thrown when internal system limits are exceeded due to the number of affected entities implied by the input parameters. Clients should reduce the number of affected entities and try again. UNKNOWN The value returned if the actual value is not exposed by the requested API version.