abstract type ApiError (v202411)

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 numerous inherited error types for various specific issues like authentication, permission, and quota errors.

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 AuthenticationError CollectionSizeError CommonError CustomFieldValueError EntityLimitReachedError FeatureError InternalApiError InvalidEmailError NotNullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError TeamError TimeZoneError TokenError 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/v202411

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.