abstract type ApiError (v202502)

  • ApiError is the base class for API errors in the Ad Manager API v202502.

  • It provides details about errors that occur during service requests.

  • The ApiError includes information like the field path that caused the error, the data that triggered the error, and a string representation of the error.

  • Several types of errors inherit from ApiError, including AuthenticationError, QuotaError, and ServerError.
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 FeatureError InternalApiError InvalidUrlError NotNullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError RequiredNumberError ServerError StatementError StringFormatError StringLengthError TypeError

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.