abstract type ApiError (v202411)

AI-generated Key Takeaways

• The ApiError object provides details about errors during service requests in Google Ad Manager.

• It includes the OGNL fieldPath, parsed fieldPathElements, error-causing trigger, and errorString for debugging.

• ApiError is the base class for various specific error types in the Ad Manager API, like NetworkError or QuotaError.

• Developers can use the information in ApiError to understand and address issues arising from API interactions.

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 ExchangeSignupApiError FeatureError InternalApiError InvalidEmailError InventoryClientApiError LiveStreamEventSlateError McmError NetworkError NotNullError ParseError PermissionError PrecisionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequestError RequiredCollectionError RequiredError RequiredNumberError ServerError SetTopBoxCreativeError StatementError StringFormatError StringLengthError TypeError UniqueError UrlError

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.