abstract type ApiError (v202502)

AI-generated Key Takeaways

• ApiError is the base class for errors that occur during service requests and provides details about the error.

• The ApiError class includes fields such as fieldPath, fieldPathElements, trigger, and errorString to help identify the cause of the error.

• ApiError has several inherited error types covering various scenarios like authentication, creative issues, and entity limits.

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

Dependencies

ApiException

▼

ApiError

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

The API error base class that provides details about an error that occurred while processing a service request.

The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

---

Namespace

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

Field
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.