abstract type ApiError (v202411)

  • ApiError is the base class for errors encountered during service request processing, providing details like field path and trigger data to identify the cause.

  • The ApiError includes fields such as fieldPath, fieldPathElements, trigger, and errorString to help pinpoint the specific issue.

  • Various specific error types inherit from ApiError, covering authentication, targeting, inventory, and more.

  • The provided content lists numerous services and their associated ApiError types within the v202411 namespace.
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 CustomTargetingError DateError DateTimeRangeTargetingError DayPartTargetingError EntityLimitReachedError FeatureError ForecastAdjustmentError ForecastError GenericTargetingError GeoTargetingError InternalApiError InvalidUrlError InventoryTargetingError InventoryUnitError InventoryUnitSizesError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError TechnologyTargetingError TrafficForecastSegmentError TypeError UniqueError UserDomainTargetingError

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.