abstract type ApiError (v202502)

AI-generated Key Takeaways

• ApiError is the base class for errors that occur during service requests, providing details like field path and trigger data.

• The ApiError class is part of the https://www.google.com/apis/ads/publisher/v202502 namespace.

• Fields within ApiError include fieldPath, fieldPathElements, trigger, and errorString, offering insights into the error's origin and cause.

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

Dependencies

ApiException

▼

ApiError

Inheritance

ApiError

▼

ApiVersionError AudienceSegmentError AuthenticationError BillingError CollectionSizeError CommonError CurrencyCodeError CustomFieldValueError CustomTargetingError DateTimeRangeTargetingError DayPartTargetingError DealError EntityChildrenLimitReachedE... EntityLimitReachedError ExchangeRateError FeatureError ForecastError FrequencyCapError GenericTargetingError GeoTargetingError GrpSettingsError InternalApiError InventoryTargetingError LabelEntityAssociationError LineItemError LineItemFlightDateError LineItemOperationError MobileApplicationTargetingE... NotNullError ParseError PermissionError PrecisionError PreferredDealError ProgrammaticError ProposalActionError ProposalError ProposalLineItemActionError ProposalLineItemError ProposalLineItemMakegoodError ProposalLineItemProgrammati... PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RequestPlatformTargetingError RequiredCollectionError RequiredError RequiredNumberError ReservationDetailsError ServerError StatementError StringFormatError StringLengthError TeamError TechnologyTargetingError TimeZoneError TypeError UniqueError UserDomainTargetingError VideoPositionTargetingError

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.